ogd.core.generators.extractors.builtin package

Submodules

ogd.core.generators.extractors.builtin.BuiltinExtractor module

class ogd.core.generators.extractors.builtin.BuiltinExtractor.BuiltinExtractor(params: GeneratorParameters, schema_args: Dict[str, Any])[source]: Bases: Extractor

ogd.core.generators.extractors.builtin.CountEvent module

class ogd.core.generators.extractors.builtin.CountEvent.CountEvent(params: GeneratorParameters, schema_args: Dict[str, Any])[source]

Bases: BuiltinExtractor

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.core.generators.extractors.builtin.Timespan module

class ogd.core.generators.extractors.builtin.Timespan.Timespan(params: GeneratorParameters, schema_args: Dict[str, Any])[source]

Bases: BuiltinExtractor

Universal feature for finding the span of time between the first occurrence of a “start” event, and last occurrence of an “end” event.

static MaxVersion() → str | None[source]

Base function to get the maximum log version the feature can handle.: A value of None will set no maximum, so all levels are accepted (unless a min is set). Typically default to None, unless the feature is not compatible with new data and is only kept for legacy purposes. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:: [description]
Return type:: Optional[str]

static MinVersion() → str | None[source]

Base function to get the minimum log version the feature can handle.: A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:: [description]
Return type:: Optional[str]