flexmeasures.data.schemas.attributes

Functions

flexmeasures.data.schemas.attributes.validate_special_attributes(key: str, value: Any)

Validate attributes with a special meaning in FlexMeasures.

Classes

class flexmeasures.data.schemas.attributes.JSON(*, load_default: typing.Any = <marshmallow.missing>, missing: typing.Any = <marshmallow.missing>, dump_default: typing.Any = <marshmallow.missing>, default: typing.Any = <marshmallow.missing>, data_key: str | None = None, attribute: str | None = None, validate: types.Validator | typing.Iterable[types.Validator] | None = None, required: bool = False, allow_none: bool | None = None, load_only: bool = False, dump_only: bool = False, error_messages: dict[str, str] | None = None, metadata: typing.Mapping[str, typing.Any] | None = None, **additional_metadata)

_deserialize(value, attr, data, **kwargs) → dict

Deserialize value. Concrete Field classes should implement this method.

Parameters:

• value – The value to be deserialized.

• attr – The attribute/key in data to be deserialized.

• data – The raw input data passed to the Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – In case of formatting or validation failure.

Returns:

The deserialized value.

Changed in version 3.0.0: Added **kwargs to signature.

_serialize(value, attr, obj, **kwargs) → str

Serializes value to a basic Python datatype. Noop by default. Concrete Field classes should implement this method.

Example:

class TitleCase(Field):
    def _serialize(self, value, attr, obj, **kwargs):
        if not value:
            return ""
        return str(value).title()

Parameters:

• value – The value to be serialized.

• attr – The attribute or key on the object to be serialized.

• obj – The object the value was pulled from.

• kwargs – Field-specific keyword arguments.

Returns:

The serialized value