flexmeasures.data.schemas.reporting

Modules

flexmeasures.data.schemas.reporting.aggregation
flexmeasures.data.schemas.reporting.pandas_reporter
flexmeasures.data.schemas.reporting.profit

Classes

class flexmeasures.data.schemas.reporting.BeliefsSearchConfigSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)

This schema implements the required fields to perform a TimedBeliefs search using the method flexmeasures.data.models.time_series:Sensor.search_beliefs

class flexmeasures.data.schemas.reporting.ReporterConfigSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)

This schema is used to validate Reporter class configurations (config). Inherit from this class to extend this schema with your own parameters.

class flexmeasures.data.schemas.reporting.ReporterParametersSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)

This schema is used to validate the parameters to the method compute of

the Reporter class.

Inherit from this class to extend this schema with your own parameters.

class flexmeasures.data.schemas.reporting.StatusSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)