ogd.core.schemas.configs package

Subpackages

class ogd.core.schemas.configs.ConfigSchema.ConfigSchema(name: str, all_elements: Dict[str, Any])[source]

Bases: Schema

Dumb struct containing properties for each standard OGD-core config item.

property AsMarkdown: str[source]: A Markdown-formatted stringification of the ConfigSchema. (presently just the schema name)

property BatchSize: int[source]: The number of sessions to process at once during an export.

property DataDirectory: Path[source]

The local directory where export files will be stored by default.

property DataSources: Dict[str, DataSourceSchema][source]: A collection of all configured sources of data that can be used for exports.

property DebugLevel: int[source]: The least-severe level of debug output that should be logged. Defaults to INFO if not specified.

property FailFast: bool[source]: Whether to fail the export on errors due to bad data, or ignore the bad data and continue processing.

property FileIndexConfig: FileIndexingSchema[source]

A collection of settings for indexing output files.

TODO : Need better documentation of this item.

property GameSourceMap: Dict[str, GameSourceSchema][source]: A mapping from game IDs to the data sources they use.

property UseLogFile: bool[source]: Whether to use a log file to store log output from exports.

property WithProfiling: bool[source]: Whether to track and include profiling data in the output or not.

class ogd.core.schemas.configs.LegacyConfigSchema.LegacyConfigSchema(name: str, all_elements: Dict[str, Any])[source]

Bases: Schema