ogd.core.requests package

Submodules

ogd.core.requests.Request module

class ogd.core.requests.Request.ExporterRange(date_min: datetime | None, date_max: datetime | None, ids: List[str] | None, id_mode: IDMode = IDMode.SESSION, versions: List[int] | None = None)[source]

Bases: object

Simple class to define a range of data for export.

property DateRange: Dict[str, datetime | None][source]
static FromDateRange(source: EventInterface, date_min: datetime, date_max: datetime, versions: List[int] | None = None)[source]
static FromIDs(source: EventInterface, ids: List[str], id_mode: IDMode = IDMode.SESSION, versions: List[int] | None = None)[source]
property IDMode[source]
property IDs: List[str] | None[source]
class ogd.core.requests.Request.Request(range: ExporterRange, exporter_modes: Set[ExportMode], interface: EventInterface, outerfaces: Set[DataOuterface], feature_overrides: List[str] | None = None)[source]

Bases: ABC

property ExportPlayers: bool[source]
property ExportPopulation: bool[source]
property ExportProcessedEvents: bool[source]
property ExportRawEvents: bool[source]
property ExportSessions: bool[source]
property GameID[source]
property Interface: EventInterface[source]
property Outerfaces: Set[DataOuterface][source]
property Range: ExporterRange[source]
RemoveExportMode(mode: ExportMode)[source]
RetrieveIDs() → List[str] | None[source]

ogd.core.requests.RequestResult module

class ogd.core.requests.RequestResult.ExportResult(columns: List[str] = [], values: List[List[Any]] = [])[source]

Bases: object

AppendRow(new_values: List[Any])[source]
property Columns: List[str][source]
ConcatRows(new_values: List[List[Any]])[source]
ToDict() → Dict[str, List[str] | List[List[Any]]][source]
property Values: List[List[Any]][source]
class ogd.core.requests.RequestResult.RequestResult(msg: str = '', status: ResultStatus = ResultStatus.NONE, sess_ct: int = 0, duration: timedelta = datetime.timedelta(0))[source]

Bases: object

property Duration: timedelta[source]
property Message: str[source]
RequestErrored(msg: str)[source]
RequestSucceeded(msg: str)[source]
property SessionCount[source]
property Status: ResultStatus[source]
class ogd.core.requests.RequestResult.ResultStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntEnum

FAILURE = 3[source]
NONE = 1[source]
SUCCESS = 2[source]

Module contents