flexmeasures.data.schemas.reporting.profit

Classes

class flexmeasures.data.schemas.reporting.profit.ProfitOrLossReporterConfigSchema(*, 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)

Schema for the ProfitOrLossReporter configuration

Example:

{
    "production-price-sensor" : 1,
    "consumption-price-sensor" : 2,
    "loss_is_positive" : true
}

fields: dict[str, Field]

Dictionary mapping field_names -> Field objects

validate_price_sensors(data, **kwargs)

check that at least one of the price sensors is given

class flexmeasures.data.schemas.reporting.profit.ProfitOrLossReporterParametersSchema(*, 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)

Schema for the ProfitOrLossReporter parameters

Example:

{
    "input": [
        {
            "sensor": 1
        }
    ],
    "output": [
        {
            "sensor": 2
        }
    ],
    "start" : "2023-01-01T00:00:00+00:00",
    "end" : "2023-01-03T00:00:00+00:00"
}

fields: dict[str, Field]

Dictionary mapping field_names -> Field objects