casys.elements.schemas

Elements’ schemas.

Classes

BaseDiagnostic(name[, store_params])	Abstract class defining the common structure of a diagnostic: computation, results, storage and schema.
CyclePassFmt(value[, names, module, ...])
CyclePassFmtField(*[, load_default, ...])	Marshmallow CyclePassFmt field.
DataContainerType(value[, names, module, ...])	Different types of data.
DataContainerTypeField(*[, load_default, ...])	Marshmallow SectionOrderType field.
DataResolution(min, max, step[, computed, ftype])	Data slices resolution.
DataResolutionAuto([min, max, step, ...])	Data slices resolution.
DataResolutionSchema(*[, only, exclude, ...])	Marshmallow schema for the DataResolution class.
DiagnosticNameField(*[, load_default, ...])	Marshmallow field representing a diagnostic name.
DiagnosticType(value[, names, module, ...])	Different kind of data handled by this module.
DiagnosticTypeField(*[, load_default, ...])	Marshmallow DiagnosticType field.
FeatureType(value[, names, module, ...])	Different of features in a plot.
FeatureTypeField(*[, load_default, missing, ...])	Marshmallow FeatureType field.
Field(name[, source, source_aux, subfields, ...])	Field object representing parameters/variables in data sources.
FieldBase(name[, source, source_aux, ...])	Field object representing parameters/variables in data sources.
FieldBaseSchema(*[, only, exclude, many, ...])	Marshmallow schema for the Field class.
FieldSchema(*[, only, exclude, many, ...])	Marshmallow schema for the Field class.
FieldType(value[, names, module, qualname, ...])	Existing type of fields.
FieldTypeField(*[, load_default, missing, ...])	Marshmallow FieldType field.
FreqType(value[, names, module, qualname, ...])	Frequencies allowed by time statistics.
FreqTypeField(*[, load_default, missing, ...])	Marshmallow FreqType field.
FrequencyHandler([value, meta, number])	Utility class allowing to create grid and periods objects respecting frequency criteria.
FrequencyHandlerSchema(*[, only, exclude, ...])	Marshmallow schema for FrequencyHandler.
InterpolationOptions([mode, noise_level, ...])	Interpolation options.
InterpolationOptionsSchema(*[, only, ...])	Marshmallow schema for the InterpolationOptions class.
ProjectionsSchema(*[, only, exclude, many, ...])	Marshmallow schema for the cartopy crs classes.
SelectionType(value[, names, module, ...])	Different kind of selection allowed in computation.
SelectionTypeField(*[, load_default, ...])	Marshmallow SelectionType field.
StatType(value[, names, module, qualname, ...])	Different kind of statistics allowed in computation.
StatTypeField(*[, load_default, missing, ...])	Marshmallow StatType field.
StorageMode(value[, names, module, ...])	Storage modes.
StorageModeField(*[, load_default, missing, ...])	Marshmallow StorageMode field.

Exceptions

CasysError

Exception raised when a problem related Casys occurs.

class casys.elements.schemas.CyclePassFmtField(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)

Bases: BaseEnumField

Marshmallow CyclePassFmt field.

Parameters:

• load_default (Any)

• missing (Any)

• dump_default (Any)

• default (Any)

• data_key (str | None)

• attribute (str | None)

• validate (Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]], None])

• required (bool)

• allow_none (bool | None)

• load_only (bool)

• dump_only (bool)

• error_messages (dict[str, str] | None)

• metadata (Optional[Mapping[str, Any]])

property context: dict | None

The context dictionary for the parent Schema <marshmallow.Schema>.

property default

default_error_messages: dict[str, str] = {'null': 'Field may not be null.', 'required': 'Missing data for required field.', 'validator_failed': 'Invalid value.'}

Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make_error. The values are error messages passed to marshmallow.exceptions.ValidationError.

deserialize(value, attr=None, data=None, **kwargs)

Deserialize value.

Parameters:

• value (Any) – The value to deserialize.

• attr (str | None) – The attribute/key in data to deserialize.

• data (Optional[Mapping[str, Any]]) – The raw input data passed to Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – If an invalid value is passed or if a required value is missing.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

Deprecated since version 3.0.0: Use make_error <marshmallow.fields.Field.make_error> instead.

Parameters:

key (str)

get_value(obj, attr, accessor=None, default=<marshmallow.missing>)

Return the value for a given key from an object.

Parameters:

• obj (Any) – The object to get the value from.

• attr (str) – The attribute/key in obj to get the value from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

• default (Any)

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

Parameters:

key (str)

Return type:

ValidationError

property missing

serialize(attr, obj, accessor=None, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result.

Parameters:

• attr (str) – The attribute/key to get from the object.

• obj (Any) – The object to access the attribute/key from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – Function used to access values from obj.

• kwargs – Field-specific keyword arguments.

class casys.elements.schemas.DataContainerTypeField(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)

Bases: BaseEnumField

Marshmallow SectionOrderType field.

Parameters:

• load_default (Any)

• missing (Any)

• dump_default (Any)

• default (Any)

• data_key (str | None)

• attribute (str | None)

• validate (Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]], None])

• required (bool)

• allow_none (bool | None)

• load_only (bool)

• dump_only (bool)

• error_messages (dict[str, str] | None)

• metadata (Optional[Mapping[str, Any]])

property context: dict | None

The context dictionary for the parent Schema <marshmallow.Schema>.

property default

default_error_messages: dict[str, str] = {'null': 'Field may not be null.', 'required': 'Missing data for required field.', 'validator_failed': 'Invalid value.'}

Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make_error. The values are error messages passed to marshmallow.exceptions.ValidationError.

deserialize(value, attr=None, data=None, **kwargs)

Deserialize value.

Parameters:

• value (Any) – The value to deserialize.

• attr (str | None) – The attribute/key in data to deserialize.

• data (Optional[Mapping[str, Any]]) – The raw input data passed to Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – If an invalid value is passed or if a required value is missing.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

Deprecated since version 3.0.0: Use make_error <marshmallow.fields.Field.make_error> instead.

Parameters:

key (str)

get_value(obj, attr, accessor=None, default=<marshmallow.missing>)

Return the value for a given key from an object.

Parameters:

• obj (Any) – The object to get the value from.

• attr (str) – The attribute/key in obj to get the value from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

• default (Any)

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

Parameters:

key (str)

Return type:

ValidationError

property missing

serialize(attr, obj, accessor=None, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result.

Parameters:

• attr (str) – The attribute/key to get from the object.

• obj (Any) – The object to access the attribute/key from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – Function used to access values from obj.

• kwargs – Field-specific keyword arguments.

class casys.elements.schemas.DataResolutionSchema(*, only=None, exclude=(), many=None, context=None, load_only=(), dump_only=(), partial=None, unknown=None)

Bases: Schema

Marshmallow schema for the DataResolution class.

Parameters:

• only (Union[Sequence[str], AbstractSet[str], None])

• exclude (Union[Sequence[str], AbstractSet[str]])

• many (bool | None)

• context (dict | None)

• load_only (Union[Sequence[str], AbstractSet[str]])

• dump_only (Union[Sequence[str], AbstractSet[str]])

• partial (Union[bool, Sequence[str], AbstractSet[str], None])

• unknown (str | None)

class Meta

Bases: object

Options object for a Schema.

Example usage:

from marshmallow import Schema


class MySchema(Schema):
    class Meta:
        fields = ("id", "email", "date_created")
        exclude = ("password", "secret_attribute")

A note on type checking

Type checkers will only check the attributes of the Meta <marshmallow.Schema.Meta> class if you explicitly subclass marshmallow.Schema.Meta.

from marshmallow import Schema


class MySchema(Schema):
    # Not checked by type checkers
    class Meta:
        additional = True


class MySchema2(Schema):
    # Type checkers will check attributes
    class Meta(Schema.Opts):
        additional = True  # Incompatible types in assignment

Removed in version 3.0.0b7: Remove strict.

Added in version 3.0.0b12: Add unknown.

Changed in version 3.0.0b17: Rename dateformat to datetimeformat.

Added in version 3.9.0: Add timeformat.

Changed in version 3.26.0: Deprecate ordered. Field order is preserved by default.

additional: ClassVar[tuple[str, ...] | list[str]]

Fields to include in addition to the explicitly declared fields. additional <marshmallow.Schema.Meta.additional> and fields <marshmallow.Schema.Meta.fields> are mutually-exclusive options.

dateformat: ClassVar[str]

Default format for Date <marshmallow.fields.Date> fields.

datetimeformat: ClassVar[str]

Default format for DateTime <marshmallow.fields.DateTime> fields.

dump_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

exclude: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude in the serialized result. Nested fields can be represented with dot delimiters.

fields: ClassVar[tuple[str, ...] | list[str]]

Fields to include in the (de)serialized result

include: ClassVar[dict[str, Field]]

Dictionary of additional fields to include in the schema. It is usually better to define fields as class variables, but you may need to use this option, e.g., if your fields are Python keywords.

index_errors: ClassVar[bool]

If True, errors dictionaries will include the index of invalid items in a collection.

load_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

many: ClassVar[bool]

Whether data should be (de)serialized as a collection by default.

ordered: ClassVar[bool]

If True, Schema.dump <marshmallow.Schema.dump> is a collections.OrderedDict.

register: ClassVar[bool]

Whether to register the Schema <marshmallow.Schema> with marshmallow’s internal class registry. Must be True if you intend to refer to this Schema <marshmallow.Schema> by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

render_module: Any

Module to use for loads <marshmallow.Schema.loads> and dumps <marshmallow.Schema.dumps>. Defaults to json from the standard library.

timeformat: ClassVar[str]

Default format for Time <marshmallow.fields.Time> fields.

unknown: ClassVar[str]

Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE.

OPTIONS_CLASS

alias of SchemaOpts

TYPE_MAPPING: dict[type, type[Field]] = {<class 'bool'>: <class 'marshmallow.fields.Boolean'>, <class 'bytes'>: <class 'marshmallow.fields.String'>, <class 'datetime.date'>: <class 'marshmallow.fields.Date'>, <class 'datetime.datetime'>: <class 'marshmallow.fields.DateTime'>, <class 'datetime.time'>: <class 'marshmallow.fields.Time'>, <class 'datetime.timedelta'>: <class 'marshmallow.fields.TimeDelta'>, <class 'decimal.Decimal'>: <class 'marshmallow.fields.Decimal'>, <class 'float'>: <class 'marshmallow.fields.Float'>, <class 'int'>: <class 'marshmallow.fields.Integer'>, <class 'list'>: <class 'marshmallow.fields.Raw'>, <class 'set'>: <class 'marshmallow.fields.Raw'>, <class 'str'>: <class 'marshmallow.fields.String'>, <class 'tuple'>: <class 'marshmallow.fields.Raw'>, <class 'uuid.UUID'>: <class 'marshmallow.fields.UUID'>}

property dict_class: type[dict]

dict type to return when serializing.

dump(obj, *, many=None)

Serialize an object to native Python data types according to this Schema’s fields.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

Changed in version 3.0.0rc9: Validation no longer occurs upon serialization.

dumps(obj, *args, many=None, **kwargs)

Same as dump(), except return a JSON-encoded string.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

error_messages: dict[str, str] = {}

Overrides for default schema-level error messages

fields: dict[str, Field]

Dictionary mapping field_names -> Field objects

classmethod from_dict(fields, *, name='GeneratedSchema')

Generate a Schema <marshmallow.Schema> class given a dictionary of fields.

from marshmallow import Schema, fields

PersonSchema = Schema.from_dict({"name": fields.Str()})
print(PersonSchema().load({"name": "David"}))  # => {'name': 'David'}

Generated schemas are not added to the class registry and therefore cannot be referred to by name in Nested fields.

Parameters:

• fields (dict[str, Field]) – Dictionary mapping field names to field instances.

• name (str) – Optional name for the class, which will appear in the repr for the class.

Return type:

type[Schema]

Added in version 3.0.0.

get_attribute(obj, attr, default)

Defines how to pull values from an object to serialize.

Changed in version 3.0.0a1: Changed position of obj and attr.

Parameters:

• obj (Any)

• attr (str)

• default (Any)

handle_error(error, data, *, many, **kwargs)

Custom error handler function for the schema.

Parameters:

• error (ValidationError) – The ValidationError raised during (de)serialization.

• data (Any) – The original input data.

• many (bool) – Value of many on dump or load.

• partial – Value of partial on load.

Changed in version 3.0.0rc9: Receives many and partial (on deserialization) as keyword arguments.

load(data, *, many=None, partial=None, unknown=None)

Deserialize a data structure to an object defined by this Schema’s fields.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to deserialize.

• many (bool | None) – Whether to deserialize data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

loads(json_data, *, many=None, partial=None, unknown=None, **kwargs)

Same as load(), except it uses marshmallow.Schema.Meta.render_module to deserialize the passed string before passing data to load().

Parameters:

• json_data (str | bytes | bytearray) – A string of the data to deserialize.

• many (bool | None) – Whether to deserialize obj as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

make_object(data, **_)

normalize_input(in_data, **_)

on_bind_field(field_name, field_obj)

Hook to modify a field when it is bound to the Schema <marshmallow.Schema>.

No-op by default.

Parameters:

• field_name (str)

• field_obj (Field)

Return type:

None

opts: typing.Any = <marshmallow.schema.SchemaOpts object>

post_dump_object(data, **_)

pre_dump_object(data, **_)

Parameters:

data (DataResolution)

set_class

alias of OrderedSet

validate(data, *, many=None, partial=None)

Validate data against the schema, returning a dictionary of validation errors.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to validate.

• many (bool | None) – Whether to validate data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

Return type:

dict[str, list[str]]

Returns:

A dictionary of validation errors.

Added in version 1.1.0.

class casys.elements.schemas.DiagnosticNameField(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)

Bases: Field

Marshmallow field representing a diagnostic name.

Parameters:

• load_default (Any)

• missing (Any)

• dump_default (Any)

• default (Any)

• data_key (str | None)

• attribute (str | None)

• validate (Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]], None])

• required (bool)

• allow_none (bool | None)

• load_only (bool)

• dump_only (bool)

• error_messages (dict[str, str] | None)

• metadata (Optional[Mapping[str, Any]])

property context: dict | None

The context dictionary for the parent Schema <marshmallow.Schema>.

property default

default_error_messages: dict[str, str] = {'null': 'Field may not be null.', 'required': 'Missing data for required field.', 'validator_failed': 'Invalid value.'}

Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make_error. The values are error messages passed to marshmallow.exceptions.ValidationError.

deserialize(value, attr=None, data=None, **kwargs)

Deserialize value.

Parameters:

• value (Any) – The value to deserialize.

• attr (str | None) – The attribute/key in data to deserialize.

• data (Optional[Mapping[str, Any]]) – The raw input data passed to Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – If an invalid value is passed or if a required value is missing.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

Deprecated since version 3.0.0: Use make_error <marshmallow.fields.Field.make_error> instead.

Parameters:

key (str)

get_value(obj, attr, accessor=None, default=<marshmallow.missing>)

Return the value for a given key from an object.

Parameters:

• obj (Any) – The object to get the value from.

• attr (str) – The attribute/key in obj to get the value from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

• default (Any)

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

Parameters:

key (str)

Return type:

ValidationError

property missing

serialize(attr, obj, accessor=None, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result.

Parameters:

• attr (str) – The attribute/key to get from the object.

• obj (Any) – The object to access the attribute/key from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – Function used to access values from obj.

• kwargs – Field-specific keyword arguments.

class casys.elements.schemas.DiagnosticTypeField(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)

Bases: BaseEnumField

Marshmallow DiagnosticType field.

Parameters:

• load_default (Any)

• missing (Any)

• dump_default (Any)

• default (Any)

• data_key (str | None)

• attribute (str | None)

• validate (Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]], None])

• required (bool)

• allow_none (bool | None)

• load_only (bool)

• dump_only (bool)

• error_messages (dict[str, str] | None)

• metadata (Optional[Mapping[str, Any]])

property context: dict | None

The context dictionary for the parent Schema <marshmallow.Schema>.

property default

default_error_messages: dict[str, str] = {'null': 'Field may not be null.', 'required': 'Missing data for required field.', 'validator_failed': 'Invalid value.'}

Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make_error. The values are error messages passed to marshmallow.exceptions.ValidationError.

deserialize(value, attr=None, data=None, **kwargs)

Deserialize value.

Parameters:

• value (Any) – The value to deserialize.

• attr (str | None) – The attribute/key in data to deserialize.

• data (Optional[Mapping[str, Any]]) – The raw input data passed to Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – If an invalid value is passed or if a required value is missing.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

Deprecated since version 3.0.0: Use make_error <marshmallow.fields.Field.make_error> instead.

Parameters:

key (str)

get_value(obj, attr, accessor=None, default=<marshmallow.missing>)

Return the value for a given key from an object.

Parameters:

• obj (Any) – The object to get the value from.

• attr (str) – The attribute/key in obj to get the value from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

• default (Any)

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

Parameters:

key (str)

Return type:

ValidationError

property missing

serialize(attr, obj, accessor=None, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result.

Parameters:

• attr (str) – The attribute/key to get from the object.

• obj (Any) – The object to access the attribute/key from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – Function used to access values from obj.

• kwargs – Field-specific keyword arguments.

class casys.elements.schemas.FeatureTypeField(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)

Bases: BaseEnumField

Marshmallow FeatureType field.

Parameters:

• load_default (Any)

• missing (Any)

• dump_default (Any)

• default (Any)

• data_key (str | None)

• attribute (str | None)

• validate (Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]], None])

• required (bool)

• allow_none (bool | None)

• load_only (bool)

• dump_only (bool)

• error_messages (dict[str, str] | None)

• metadata (Optional[Mapping[str, Any]])

property context: dict | None

The context dictionary for the parent Schema <marshmallow.Schema>.

property default

default_error_messages: dict[str, str] = {'null': 'Field may not be null.', 'required': 'Missing data for required field.', 'validator_failed': 'Invalid value.'}

Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make_error. The values are error messages passed to marshmallow.exceptions.ValidationError.

deserialize(value, attr=None, data=None, **kwargs)

Deserialize value.

Parameters:

• value (Any) – The value to deserialize.

• attr (str | None) – The attribute/key in data to deserialize.

• data (Optional[Mapping[str, Any]]) – The raw input data passed to Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – If an invalid value is passed or if a required value is missing.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

Deprecated since version 3.0.0: Use make_error <marshmallow.fields.Field.make_error> instead.

Parameters:

key (str)

get_value(obj, attr, accessor=None, default=<marshmallow.missing>)

Return the value for a given key from an object.

Parameters:

• obj (Any) – The object to get the value from.

• attr (str) – The attribute/key in obj to get the value from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

• default (Any)

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

Parameters:

key (str)

Return type:

ValidationError

property missing

serialize(attr, obj, accessor=None, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result.

Parameters:

• attr (str) – The attribute/key to get from the object.

• obj (Any) – The object to access the attribute/key from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – Function used to access values from obj.

• kwargs – Field-specific keyword arguments.

class casys.elements.schemas.FieldBaseSchema(*, only=None, exclude=(), many=None, context=None, load_only=(), dump_only=(), partial=None, unknown=None)

Bases: BaseSchema

Marshmallow schema for the Field class.

Parameters:

• only (Union[Sequence[str], AbstractSet[str], None])

• exclude (Union[Sequence[str], AbstractSet[str]])

• many (bool | None)

• context (dict | None)

• load_only (Union[Sequence[str], AbstractSet[str]])

• dump_only (Union[Sequence[str], AbstractSet[str]])

• partial (Union[bool, Sequence[str], AbstractSet[str], None])

• unknown (str | None)

class Meta

Bases: object

Options object for a Schema.

Example usage:

from marshmallow import Schema


class MySchema(Schema):
    class Meta:
        fields = ("id", "email", "date_created")
        exclude = ("password", "secret_attribute")

A note on type checking

Type checkers will only check the attributes of the Meta <marshmallow.Schema.Meta> class if you explicitly subclass marshmallow.Schema.Meta.

from marshmallow import Schema


class MySchema(Schema):
    # Not checked by type checkers
    class Meta:
        additional = True


class MySchema2(Schema):
    # Type checkers will check attributes
    class Meta(Schema.Opts):
        additional = True  # Incompatible types in assignment

Removed in version 3.0.0b7: Remove strict.

Added in version 3.0.0b12: Add unknown.

Changed in version 3.0.0b17: Rename dateformat to datetimeformat.

Added in version 3.9.0: Add timeformat.

Changed in version 3.26.0: Deprecate ordered. Field order is preserved by default.

additional: ClassVar[tuple[str, ...] | list[str]]

Fields to include in addition to the explicitly declared fields. additional <marshmallow.Schema.Meta.additional> and fields <marshmallow.Schema.Meta.fields> are mutually-exclusive options.

dateformat: ClassVar[str]

Default format for Date <marshmallow.fields.Date> fields.

datetimeformat: ClassVar[str]

Default format for DateTime <marshmallow.fields.DateTime> fields.

dump_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

exclude: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude in the serialized result. Nested fields can be represented with dot delimiters.

fields: ClassVar[tuple[str, ...] | list[str]]

Fields to include in the (de)serialized result

include: ClassVar[dict[str, Field]]

Dictionary of additional fields to include in the schema. It is usually better to define fields as class variables, but you may need to use this option, e.g., if your fields are Python keywords.

index_errors: ClassVar[bool]

If True, errors dictionaries will include the index of invalid items in a collection.

load_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

many: ClassVar[bool]

Whether data should be (de)serialized as a collection by default.

ordered: ClassVar[bool]

If True, Schema.dump <marshmallow.Schema.dump> is a collections.OrderedDict.

register: ClassVar[bool]

Whether to register the Schema <marshmallow.Schema> with marshmallow’s internal class registry. Must be True if you intend to refer to this Schema <marshmallow.Schema> by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

render_module: Any

Module to use for loads <marshmallow.Schema.loads> and dumps <marshmallow.Schema.dumps>. Defaults to json from the standard library.

timeformat: ClassVar[str]

Default format for Time <marshmallow.fields.Time> fields.

unknown: ClassVar[str]

Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE.

OPTIONS_CLASS

alias of SchemaOpts

TYPE_MAPPING: dict[type, type[Field]] = {<class 'bool'>: <class 'marshmallow.fields.Boolean'>, <class 'bytes'>: <class 'marshmallow.fields.String'>, <class 'datetime.date'>: <class 'marshmallow.fields.Date'>, <class 'datetime.datetime'>: <class 'marshmallow.fields.DateTime'>, <class 'datetime.time'>: <class 'marshmallow.fields.Time'>, <class 'datetime.timedelta'>: <class 'marshmallow.fields.TimeDelta'>, <class 'decimal.Decimal'>: <class 'marshmallow.fields.Decimal'>, <class 'float'>: <class 'marshmallow.fields.Float'>, <class 'int'>: <class 'marshmallow.fields.Integer'>, <class 'list'>: <class 'marshmallow.fields.Raw'>, <class 'set'>: <class 'marshmallow.fields.Raw'>, <class 'str'>: <class 'marshmallow.fields.String'>, <class 'tuple'>: <class 'marshmallow.fields.Raw'>, <class 'uuid.UUID'>: <class 'marshmallow.fields.UUID'>}

property dict_class: type[dict]

dict type to return when serializing.

dump(obj, *, many=None)

Serialize an object to native Python data types according to this Schema’s fields.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

Changed in version 3.0.0rc9: Validation no longer occurs upon serialization.

dumps(obj, *args, many=None, **kwargs)

Same as dump(), except return a JSON-encoded string.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

error_messages: dict[str, str] = {}

Overrides for default schema-level error messages

fields: dict[str, Field]

Dictionary mapping field_names -> Field objects

classmethod from_dict(fields, *, name='GeneratedSchema')

Generate a Schema <marshmallow.Schema> class given a dictionary of fields.

from marshmallow import Schema, fields

PersonSchema = Schema.from_dict({"name": fields.Str()})
print(PersonSchema().load({"name": "David"}))  # => {'name': 'David'}

Generated schemas are not added to the class registry and therefore cannot be referred to by name in Nested fields.

Parameters:

• fields (dict[str, Field]) – Dictionary mapping field names to field instances.

• name (str) – Optional name for the class, which will appear in the repr for the class.

Return type:

type[Schema]

Added in version 3.0.0.

get_attribute(obj, attr, default)

Defines how to pull values from an object to serialize.

Changed in version 3.0.0a1: Changed position of obj and attr.

Parameters:

• obj (Any)

• attr (str)

• default (Any)

classmethod get_model()

Return the model associated to this schema.

Return type:

type[TypeVar(T)] | None

Returns:

Model associated to this schema.

handle_error(error, data, *, many, **kwargs)

Custom error handler function for the schema.

Parameters:

• error (ValidationError) – The ValidationError raised during (de)serialization.

• data (Any) – The original input data.

• many (bool) – Value of many on dump or load.

• partial – Value of partial on load.

Changed in version 3.0.0rc9: Receives many and partial (on deserialization) as keyword arguments.

load(data, *, many=None, partial=None, unknown=None)

Deserialize a data structure to an object defined by this Schema’s fields.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to deserialize.

• many (bool | None) – Whether to deserialize data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

loads(json_data, *, many=None, partial=None, unknown=None, **kwargs)

Same as load(), except it uses marshmallow.Schema.Meta.render_module to deserialize the passed string before passing data to load().

Parameters:

• json_data (str | bytes | bytearray) – A string of the data to deserialize.

• many (bool | None) – Whether to deserialize obj as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

make_object(data, **_)

on_bind_field(field_name, field_obj)

Hook to modify a field when it is bound to the Schema <marshmallow.Schema>.

No-op by default.

Parameters:

• field_name (str)

• field_obj (Field)

Return type:

None

opts: typing.Any = <marshmallow.schema.SchemaOpts object>

post_dump(data, original_data, **_)

pre_dump(data, **_)

pre_load(data, **_)

set_class

alias of OrderedSet

validate(data, *, many=None, partial=None)

Validate data against the schema, returning a dictionary of validation errors.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to validate.

• many (bool | None) – Whether to validate data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

Return type:

dict[str, list[str]]

Returns:

A dictionary of validation errors.

Added in version 1.1.0.

class casys.elements.schemas.FieldSchema(*, only=None, exclude=(), many=None, context=None, load_only=(), dump_only=(), partial=None, unknown=None)

Bases: FieldBaseSchema

Marshmallow schema for the Field class.

Parameters:

• only (Union[Sequence[str], AbstractSet[str], None])

• exclude (Union[Sequence[str], AbstractSet[str]])

• many (bool | None)

• context (dict | None)

• load_only (Union[Sequence[str], AbstractSet[str]])

• dump_only (Union[Sequence[str], AbstractSet[str]])

• partial (Union[bool, Sequence[str], AbstractSet[str], None])

• unknown (str | None)

class Meta

Bases: object

Options object for a Schema.

Example usage:

from marshmallow import Schema


class MySchema(Schema):
    class Meta:
        fields = ("id", "email", "date_created")
        exclude = ("password", "secret_attribute")

A note on type checking

Type checkers will only check the attributes of the Meta <marshmallow.Schema.Meta> class if you explicitly subclass marshmallow.Schema.Meta.

from marshmallow import Schema


class MySchema(Schema):
    # Not checked by type checkers
    class Meta:
        additional = True


class MySchema2(Schema):
    # Type checkers will check attributes
    class Meta(Schema.Opts):
        additional = True  # Incompatible types in assignment

Removed in version 3.0.0b7: Remove strict.

Added in version 3.0.0b12: Add unknown.

Changed in version 3.0.0b17: Rename dateformat to datetimeformat.

Added in version 3.9.0: Add timeformat.

Changed in version 3.26.0: Deprecate ordered. Field order is preserved by default.

additional: ClassVar[tuple[str, ...] | list[str]]

Fields to include in addition to the explicitly declared fields. additional <marshmallow.Schema.Meta.additional> and fields <marshmallow.Schema.Meta.fields> are mutually-exclusive options.

dateformat: ClassVar[str]

Default format for Date <marshmallow.fields.Date> fields.

datetimeformat: ClassVar[str]

Default format for DateTime <marshmallow.fields.DateTime> fields.

dump_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

exclude: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude in the serialized result. Nested fields can be represented with dot delimiters.

fields: ClassVar[tuple[str, ...] | list[str]]

Fields to include in the (de)serialized result

include: ClassVar[dict[str, Field]]

Dictionary of additional fields to include in the schema. It is usually better to define fields as class variables, but you may need to use this option, e.g., if your fields are Python keywords.

index_errors: ClassVar[bool]

If True, errors dictionaries will include the index of invalid items in a collection.

load_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

many: ClassVar[bool]

Whether data should be (de)serialized as a collection by default.

ordered: ClassVar[bool]

If True, Schema.dump <marshmallow.Schema.dump> is a collections.OrderedDict.

register: ClassVar[bool]

Whether to register the Schema <marshmallow.Schema> with marshmallow’s internal class registry. Must be True if you intend to refer to this Schema <marshmallow.Schema> by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

render_module: Any

Module to use for loads <marshmallow.Schema.loads> and dumps <marshmallow.Schema.dumps>. Defaults to json from the standard library.

timeformat: ClassVar[str]

Default format for Time <marshmallow.fields.Time> fields.

unknown: ClassVar[str]

Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE.

OPTIONS_CLASS

alias of SchemaOpts

TYPE_MAPPING: dict[type, type[Field]] = {<class 'bool'>: <class 'marshmallow.fields.Boolean'>, <class 'bytes'>: <class 'marshmallow.fields.String'>, <class 'datetime.date'>: <class 'marshmallow.fields.Date'>, <class 'datetime.datetime'>: <class 'marshmallow.fields.DateTime'>, <class 'datetime.time'>: <class 'marshmallow.fields.Time'>, <class 'datetime.timedelta'>: <class 'marshmallow.fields.TimeDelta'>, <class 'decimal.Decimal'>: <class 'marshmallow.fields.Decimal'>, <class 'float'>: <class 'marshmallow.fields.Float'>, <class 'int'>: <class 'marshmallow.fields.Integer'>, <class 'list'>: <class 'marshmallow.fields.Raw'>, <class 'set'>: <class 'marshmallow.fields.Raw'>, <class 'str'>: <class 'marshmallow.fields.String'>, <class 'tuple'>: <class 'marshmallow.fields.Raw'>, <class 'uuid.UUID'>: <class 'marshmallow.fields.UUID'>}

property dict_class: type[dict]

dict type to return when serializing.

dump(obj, *, many=None)

Serialize an object to native Python data types according to this Schema’s fields.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

Changed in version 3.0.0rc9: Validation no longer occurs upon serialization.

dump_fields: dict[str, Field]

dumps(obj, *args, many=None, **kwargs)

Same as dump(), except return a JSON-encoded string.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

error_messages: dict[str, str] = {}

Overrides for default schema-level error messages

exclude: set[typing.Any] | typing.MutableSet[typing.Any]

fields: dict[str, Field]

Dictionary mapping field_names -> Field objects

classmethod from_dict(fields, *, name='GeneratedSchema')

Generate a Schema <marshmallow.Schema> class given a dictionary of fields.

from marshmallow import Schema, fields

PersonSchema = Schema.from_dict({"name": fields.Str()})
print(PersonSchema().load({"name": "David"}))  # => {'name': 'David'}

Generated schemas are not added to the class registry and therefore cannot be referred to by name in Nested fields.

Parameters:

• fields (dict[str, Field]) – Dictionary mapping field names to field instances.

• name (str) – Optional name for the class, which will appear in the repr for the class.

Return type:

type[Schema]

Added in version 3.0.0.

get_attribute(obj, attr, default)

Defines how to pull values from an object to serialize.

Changed in version 3.0.0a1: Changed position of obj and attr.

Parameters:

• obj (Any)

• attr (str)

• default (Any)

classmethod get_model()

Return the model associated to this schema.

Return type:

type[TypeVar(T)] | None

Returns:

Model associated to this schema.

handle_error(error, data, *, many, **kwargs)

Custom error handler function for the schema.

Parameters:

• error (ValidationError) – The ValidationError raised during (de)serialization.

• data (Any) – The original input data.

• many (bool) – Value of many on dump or load.

• partial – Value of partial on load.

Changed in version 3.0.0rc9: Receives many and partial (on deserialization) as keyword arguments.

load(data, *, many=None, partial=None, unknown=None)

Deserialize a data structure to an object defined by this Schema’s fields.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to deserialize.

• many (bool | None) – Whether to deserialize data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

load_fields: dict[str, Field]

loads(json_data, *, many=None, partial=None, unknown=None, **kwargs)

Same as load(), except it uses marshmallow.Schema.Meta.render_module to deserialize the passed string before passing data to load().

Parameters:

• json_data (str | bytes | bytearray) – A string of the data to deserialize.

• many (bool | None) – Whether to deserialize obj as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

make_object(data, **_)

on_bind_field(field_name, field_obj)

Hook to modify a field when it is bound to the Schema <marshmallow.Schema>.

No-op by default.

Parameters:

• field_name (str)

• field_obj (Field)

Return type:

None

opts: typing.Any = <marshmallow.schema.SchemaOpts object>

post_dump(data, original_data, **_)

pre_dump(data, **_)

pre_load(data, **_)

set_class

alias of OrderedSet

validate(data, *, many=None, partial=None)

Validate data against the schema, returning a dictionary of validation errors.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to validate.

• many (bool | None) – Whether to validate data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

Return type:

dict[str, list[str]]

Returns:

A dictionary of validation errors.

Added in version 1.1.0.

class casys.elements.schemas.FieldTypeField(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)

Bases: BaseEnumField

Marshmallow FieldType field.

Parameters:

• load_default (Any)

• missing (Any)

• dump_default (Any)

• default (Any)

• data_key (str | None)

• attribute (str | None)

• validate (Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]], None])

• required (bool)

• allow_none (bool | None)

• load_only (bool)

• dump_only (bool)

• error_messages (dict[str, str] | None)

• metadata (Optional[Mapping[str, Any]])

property context: dict | None

The context dictionary for the parent Schema <marshmallow.Schema>.

property default

default_error_messages: dict[str, str] = {'null': 'Field may not be null.', 'required': 'Missing data for required field.', 'validator_failed': 'Invalid value.'}

Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make_error. The values are error messages passed to marshmallow.exceptions.ValidationError.

deserialize(value, attr=None, data=None, **kwargs)

Deserialize value.

Parameters:

• value (Any) – The value to deserialize.

• attr (str | None) – The attribute/key in data to deserialize.

• data (Optional[Mapping[str, Any]]) – The raw input data passed to Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – If an invalid value is passed or if a required value is missing.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

Deprecated since version 3.0.0: Use make_error <marshmallow.fields.Field.make_error> instead.

Parameters:

key (str)

get_value(obj, attr, accessor=None, default=<marshmallow.missing>)

Return the value for a given key from an object.

Parameters:

• obj (Any) – The object to get the value from.

• attr (str) – The attribute/key in obj to get the value from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

• default (Any)

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

Parameters:

key (str)

Return type:

ValidationError

property missing

serialize(attr, obj, accessor=None, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result.

Parameters:

• attr (str) – The attribute/key to get from the object.

• obj (Any) – The object to access the attribute/key from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – Function used to access values from obj.

• kwargs – Field-specific keyword arguments.

class casys.elements.schemas.FreqTypeField(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)

Bases: BaseEnumField

Marshmallow FreqType field.

Parameters:

• load_default (Any)

• missing (Any)

• dump_default (Any)

• default (Any)

• data_key (str | None)

• attribute (str | None)

• validate (Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]], None])

• required (bool)

• allow_none (bool | None)

• load_only (bool)

• dump_only (bool)

• error_messages (dict[str, str] | None)

• metadata (Optional[Mapping[str, Any]])

property context: dict | None

The context dictionary for the parent Schema <marshmallow.Schema>.

property default

default_error_messages: dict[str, str] = {'null': 'Field may not be null.', 'required': 'Missing data for required field.', 'validator_failed': 'Invalid value.'}

Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make_error. The values are error messages passed to marshmallow.exceptions.ValidationError.

deserialize(value, attr=None, data=None, **kwargs)

Deserialize value.

Parameters:

• value (Any) – The value to deserialize.

• attr (str | None) – The attribute/key in data to deserialize.

• data (Optional[Mapping[str, Any]]) – The raw input data passed to Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – If an invalid value is passed or if a required value is missing.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

Deprecated since version 3.0.0: Use make_error <marshmallow.fields.Field.make_error> instead.

Parameters:

key (str)

get_value(obj, attr, accessor=None, default=<marshmallow.missing>)

Return the value for a given key from an object.

Parameters:

• obj (Any) – The object to get the value from.

• attr (str) – The attribute/key in obj to get the value from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

• default (Any)

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

Parameters:

key (str)

Return type:

ValidationError

property missing

serialize(attr, obj, accessor=None, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result.

Parameters:

• attr (str) – The attribute/key to get from the object.

• obj (Any) – The object to access the attribute/key from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – Function used to access values from obj.

• kwargs – Field-specific keyword arguments.

class casys.elements.schemas.FrequencyHandlerSchema(*, only=None, exclude=(), many=None, context=None, load_only=(), dump_only=(), partial=None, unknown=None)

Bases: BaseSchema

Marshmallow schema for FrequencyHandler.

Parameters:

• only (Union[Sequence[str], AbstractSet[str], None])

• exclude (Union[Sequence[str], AbstractSet[str]])

• many (bool | None)

• context (dict | None)

• load_only (Union[Sequence[str], AbstractSet[str]])

• dump_only (Union[Sequence[str], AbstractSet[str]])

• partial (Union[bool, Sequence[str], AbstractSet[str], None])

• unknown (str | None)

class Meta

Bases: object

Options object for a Schema.

Example usage:

from marshmallow import Schema


class MySchema(Schema):
    class Meta:
        fields = ("id", "email", "date_created")
        exclude = ("password", "secret_attribute")

A note on type checking

Type checkers will only check the attributes of the Meta <marshmallow.Schema.Meta> class if you explicitly subclass marshmallow.Schema.Meta.

from marshmallow import Schema


class MySchema(Schema):
    # Not checked by type checkers
    class Meta:
        additional = True


class MySchema2(Schema):
    # Type checkers will check attributes
    class Meta(Schema.Opts):
        additional = True  # Incompatible types in assignment

Removed in version 3.0.0b7: Remove strict.

Added in version 3.0.0b12: Add unknown.

Changed in version 3.0.0b17: Rename dateformat to datetimeformat.

Added in version 3.9.0: Add timeformat.

Changed in version 3.26.0: Deprecate ordered. Field order is preserved by default.

additional: ClassVar[tuple[str, ...] | list[str]]

Fields to include in addition to the explicitly declared fields. additional <marshmallow.Schema.Meta.additional> and fields <marshmallow.Schema.Meta.fields> are mutually-exclusive options.

dateformat: ClassVar[str]

Default format for Date <marshmallow.fields.Date> fields.

datetimeformat: ClassVar[str]

Default format for DateTime <marshmallow.fields.DateTime> fields.

dump_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

exclude: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude in the serialized result. Nested fields can be represented with dot delimiters.

fields: ClassVar[tuple[str, ...] | list[str]]

Fields to include in the (de)serialized result

include: ClassVar[dict[str, Field]]

Dictionary of additional fields to include in the schema. It is usually better to define fields as class variables, but you may need to use this option, e.g., if your fields are Python keywords.

index_errors: ClassVar[bool]

If True, errors dictionaries will include the index of invalid items in a collection.

load_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

many: ClassVar[bool]

Whether data should be (de)serialized as a collection by default.

ordered: ClassVar[bool]

If True, Schema.dump <marshmallow.Schema.dump> is a collections.OrderedDict.

register: ClassVar[bool]

Whether to register the Schema <marshmallow.Schema> with marshmallow’s internal class registry. Must be True if you intend to refer to this Schema <marshmallow.Schema> by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

render_module: Any

Module to use for loads <marshmallow.Schema.loads> and dumps <marshmallow.Schema.dumps>. Defaults to json from the standard library.

timeformat: ClassVar[str]

Default format for Time <marshmallow.fields.Time> fields.

unknown: ClassVar[str]

Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE.

OPTIONS_CLASS

alias of SchemaOpts

TYPE_MAPPING: dict[type, type[Field]] = {<class 'bool'>: <class 'marshmallow.fields.Boolean'>, <class 'bytes'>: <class 'marshmallow.fields.String'>, <class 'datetime.date'>: <class 'marshmallow.fields.Date'>, <class 'datetime.datetime'>: <class 'marshmallow.fields.DateTime'>, <class 'datetime.time'>: <class 'marshmallow.fields.Time'>, <class 'datetime.timedelta'>: <class 'marshmallow.fields.TimeDelta'>, <class 'decimal.Decimal'>: <class 'marshmallow.fields.Decimal'>, <class 'float'>: <class 'marshmallow.fields.Float'>, <class 'int'>: <class 'marshmallow.fields.Integer'>, <class 'list'>: <class 'marshmallow.fields.Raw'>, <class 'set'>: <class 'marshmallow.fields.Raw'>, <class 'str'>: <class 'marshmallow.fields.String'>, <class 'tuple'>: <class 'marshmallow.fields.Raw'>, <class 'uuid.UUID'>: <class 'marshmallow.fields.UUID'>}

property dict_class: type[dict]

dict type to return when serializing.

dump(obj, *, many=None)

Serialize an object to native Python data types according to this Schema’s fields.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

Changed in version 3.0.0rc9: Validation no longer occurs upon serialization.

dumps(obj, *args, many=None, **kwargs)

Same as dump(), except return a JSON-encoded string.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

error_messages: dict[str, str] = {}

Overrides for default schema-level error messages

fields: dict[str, Field]

Dictionary mapping field_names -> Field objects

classmethod from_dict(fields, *, name='GeneratedSchema')

Generate a Schema <marshmallow.Schema> class given a dictionary of fields.

from marshmallow import Schema, fields

PersonSchema = Schema.from_dict({"name": fields.Str()})
print(PersonSchema().load({"name": "David"}))  # => {'name': 'David'}

Generated schemas are not added to the class registry and therefore cannot be referred to by name in Nested fields.

Parameters:

• fields (dict[str, Field]) – Dictionary mapping field names to field instances.

• name (str) – Optional name for the class, which will appear in the repr for the class.

Return type:

type[Schema]

Added in version 3.0.0.

get_attribute(obj, attr, default)

Defines how to pull values from an object to serialize.

Changed in version 3.0.0a1: Changed position of obj and attr.

Parameters:

• obj (Any)

• attr (str)

• default (Any)

classmethod get_model()

Return the model associated to this schema.

Return type:

type[TypeVar(T)] | None

Returns:

Model associated to this schema.

handle_error(error, data, *, many, **kwargs)

Custom error handler function for the schema.

Parameters:

• error (ValidationError) – The ValidationError raised during (de)serialization.

• data (Any) – The original input data.

• many (bool) – Value of many on dump or load.

• partial – Value of partial on load.

Changed in version 3.0.0rc9: Receives many and partial (on deserialization) as keyword arguments.

load(data, *, many=None, partial=None, unknown=None)

Deserialize a data structure to an object defined by this Schema’s fields.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to deserialize.

• many (bool | None) – Whether to deserialize data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

loads(json_data, *, many=None, partial=None, unknown=None, **kwargs)

Same as load(), except it uses marshmallow.Schema.Meta.render_module to deserialize the passed string before passing data to load().

Parameters:

• json_data (str | bytes | bytearray) – A string of the data to deserialize.

• many (bool | None) – Whether to deserialize obj as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

make_object(data, **_)

on_bind_field(field_name, field_obj)

Hook to modify a field when it is bound to the Schema <marshmallow.Schema>.

No-op by default.

Parameters:

• field_name (str)

• field_obj (Field)

Return type:

None

opts: typing.Any = <marshmallow.schema.SchemaOpts object>

post_dump(data, original_data, **_)

pre_dump(data, **_)

pre_load(data, **_)

set_class

alias of OrderedSet

validate(data, *, many=None, partial=None)

Validate data against the schema, returning a dictionary of validation errors.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to validate.

• many (bool | None) – Whether to validate data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

Return type:

dict[str, list[str]]

Returns:

A dictionary of validation errors.

Added in version 1.1.0.

class casys.elements.schemas.InterpolationOptionsSchema(*, only=None, exclude=(), many=None, context=None, load_only=(), dump_only=(), partial=None, unknown=None)

Bases: BaseSchema

Marshmallow schema for the InterpolationOptions class.

Parameters:

• only (Union[Sequence[str], AbstractSet[str], None])

• exclude (Union[Sequence[str], AbstractSet[str]])

• many (bool | None)

• context (dict | None)

• load_only (Union[Sequence[str], AbstractSet[str]])

• dump_only (Union[Sequence[str], AbstractSet[str]])

• partial (Union[bool, Sequence[str], AbstractSet[str], None])

• unknown (str | None)

class Meta

Bases: object

Options object for a Schema.

Example usage:

from marshmallow import Schema


class MySchema(Schema):
    class Meta:
        fields = ("id", "email", "date_created")
        exclude = ("password", "secret_attribute")

A note on type checking

Type checkers will only check the attributes of the Meta <marshmallow.Schema.Meta> class if you explicitly subclass marshmallow.Schema.Meta.

from marshmallow import Schema


class MySchema(Schema):
    # Not checked by type checkers
    class Meta:
        additional = True


class MySchema2(Schema):
    # Type checkers will check attributes
    class Meta(Schema.Opts):
        additional = True  # Incompatible types in assignment

Removed in version 3.0.0b7: Remove strict.

Added in version 3.0.0b12: Add unknown.

Changed in version 3.0.0b17: Rename dateformat to datetimeformat.

Added in version 3.9.0: Add timeformat.

Changed in version 3.26.0: Deprecate ordered. Field order is preserved by default.

additional: ClassVar[tuple[str, ...] | list[str]]

Fields to include in addition to the explicitly declared fields. additional <marshmallow.Schema.Meta.additional> and fields <marshmallow.Schema.Meta.fields> are mutually-exclusive options.

dateformat: ClassVar[str]

Default format for Date <marshmallow.fields.Date> fields.

datetimeformat: ClassVar[str]

Default format for DateTime <marshmallow.fields.DateTime> fields.

dump_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

exclude: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude in the serialized result. Nested fields can be represented with dot delimiters.

fields: ClassVar[tuple[str, ...] | list[str]]

Fields to include in the (de)serialized result

include: ClassVar[dict[str, Field]]

Dictionary of additional fields to include in the schema. It is usually better to define fields as class variables, but you may need to use this option, e.g., if your fields are Python keywords.

index_errors: ClassVar[bool]

If True, errors dictionaries will include the index of invalid items in a collection.

load_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

many: ClassVar[bool]

Whether data should be (de)serialized as a collection by default.

ordered: ClassVar[bool]

If True, Schema.dump <marshmallow.Schema.dump> is a collections.OrderedDict.

register: ClassVar[bool]

Whether to register the Schema <marshmallow.Schema> with marshmallow’s internal class registry. Must be True if you intend to refer to this Schema <marshmallow.Schema> by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

render_module: Any

Module to use for loads <marshmallow.Schema.loads> and dumps <marshmallow.Schema.dumps>. Defaults to json from the standard library.

timeformat: ClassVar[str]

Default format for Time <marshmallow.fields.Time> fields.

unknown: ClassVar[str]

Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE.

OPTIONS_CLASS

alias of SchemaOpts

TYPE_MAPPING: dict[type, type[Field]] = {<class 'bool'>: <class 'marshmallow.fields.Boolean'>, <class 'bytes'>: <class 'marshmallow.fields.String'>, <class 'datetime.date'>: <class 'marshmallow.fields.Date'>, <class 'datetime.datetime'>: <class 'marshmallow.fields.DateTime'>, <class 'datetime.time'>: <class 'marshmallow.fields.Time'>, <class 'datetime.timedelta'>: <class 'marshmallow.fields.TimeDelta'>, <class 'decimal.Decimal'>: <class 'marshmallow.fields.Decimal'>, <class 'float'>: <class 'marshmallow.fields.Float'>, <class 'int'>: <class 'marshmallow.fields.Integer'>, <class 'list'>: <class 'marshmallow.fields.Raw'>, <class 'set'>: <class 'marshmallow.fields.Raw'>, <class 'str'>: <class 'marshmallow.fields.String'>, <class 'tuple'>: <class 'marshmallow.fields.Raw'>, <class 'uuid.UUID'>: <class 'marshmallow.fields.UUID'>}

property dict_class: type[dict]

dict type to return when serializing.

dump(obj, *, many=None)

Serialize an object to native Python data types according to this Schema’s fields.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

Changed in version 3.0.0rc9: Validation no longer occurs upon serialization.

dumps(obj, *args, many=None, **kwargs)

Same as dump(), except return a JSON-encoded string.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

error_messages: dict[str, str] = {}

Overrides for default schema-level error messages

fields: dict[str, Field]

Dictionary mapping field_names -> Field objects

classmethod from_dict(fields, *, name='GeneratedSchema')

Generate a Schema <marshmallow.Schema> class given a dictionary of fields.

from marshmallow import Schema, fields

PersonSchema = Schema.from_dict({"name": fields.Str()})
print(PersonSchema().load({"name": "David"}))  # => {'name': 'David'}

Generated schemas are not added to the class registry and therefore cannot be referred to by name in Nested fields.

Parameters:

• fields (dict[str, Field]) – Dictionary mapping field names to field instances.

• name (str) – Optional name for the class, which will appear in the repr for the class.

Return type:

type[Schema]

Added in version 3.0.0.

get_attribute(obj, attr, default)

Defines how to pull values from an object to serialize.

Changed in version 3.0.0a1: Changed position of obj and attr.

Parameters:

• obj (Any)

• attr (str)

• default (Any)

classmethod get_model()

Return the model associated to this schema.

Return type:

type[TypeVar(T)] | None

Returns:

Model associated to this schema.

handle_error(error, data, *, many, **kwargs)

Custom error handler function for the schema.

Parameters:

• error (ValidationError) – The ValidationError raised during (de)serialization.

• data (Any) – The original input data.

• many (bool) – Value of many on dump or load.

• partial – Value of partial on load.

Changed in version 3.0.0rc9: Receives many and partial (on deserialization) as keyword arguments.

load(data, *, many=None, partial=None, unknown=None)

Deserialize a data structure to an object defined by this Schema’s fields.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to deserialize.

• many (bool | None) – Whether to deserialize data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

loads(json_data, *, many=None, partial=None, unknown=None, **kwargs)

Same as load(), except it uses marshmallow.Schema.Meta.render_module to deserialize the passed string before passing data to load().

Parameters:

• json_data (str | bytes | bytearray) – A string of the data to deserialize.

• many (bool | None) – Whether to deserialize obj as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

make_object(data, **_)

on_bind_field(field_name, field_obj)

Hook to modify a field when it is bound to the Schema <marshmallow.Schema>.

No-op by default.

Parameters:

• field_name (str)

• field_obj (Field)

Return type:

None

opts: typing.Any = <marshmallow.schema.SchemaOpts object>

post_dump(data, original_data, **_)

pre_dump(data, **_)

pre_load(data, **_)

set_class

alias of OrderedSet

validate(data, *, many=None, partial=None)

Validate data against the schema, returning a dictionary of validation errors.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to validate.

• many (bool | None) – Whether to validate data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

Return type:

dict[str, list[str]]

Returns:

A dictionary of validation errors.

Added in version 1.1.0.

class casys.elements.schemas.ProjectionsSchema(*, only=None, exclude=(), many=None, context=None, load_only=(), dump_only=(), partial=None, unknown=None)

Bases: BaseSchema

Marshmallow schema for the cartopy crs classes.

Parameters:

• only (Union[Sequence[str], AbstractSet[str], None])

• exclude (Union[Sequence[str], AbstractSet[str]])

• many (bool | None)

• context (dict | None)

• load_only (Union[Sequence[str], AbstractSet[str]])

• dump_only (Union[Sequence[str], AbstractSet[str]])

• partial (Union[bool, Sequence[str], AbstractSet[str], None])

• unknown (str | None)

class Meta

Bases: object

Options object for a Schema.

Example usage:

from marshmallow import Schema


class MySchema(Schema):
    class Meta:
        fields = ("id", "email", "date_created")
        exclude = ("password", "secret_attribute")

A note on type checking

Type checkers will only check the attributes of the Meta <marshmallow.Schema.Meta> class if you explicitly subclass marshmallow.Schema.Meta.

from marshmallow import Schema


class MySchema(Schema):
    # Not checked by type checkers
    class Meta:
        additional = True


class MySchema2(Schema):
    # Type checkers will check attributes
    class Meta(Schema.Opts):
        additional = True  # Incompatible types in assignment

Removed in version 3.0.0b7: Remove strict.

Added in version 3.0.0b12: Add unknown.

Changed in version 3.0.0b17: Rename dateformat to datetimeformat.

Added in version 3.9.0: Add timeformat.

Changed in version 3.26.0: Deprecate ordered. Field order is preserved by default.

additional: ClassVar[tuple[str, ...] | list[str]]

Fields to include in addition to the explicitly declared fields. additional <marshmallow.Schema.Meta.additional> and fields <marshmallow.Schema.Meta.fields> are mutually-exclusive options.

dateformat: ClassVar[str]

Default format for Date <marshmallow.fields.Date> fields.

datetimeformat: ClassVar[str]

Default format for DateTime <marshmallow.fields.DateTime> fields.

dump_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

exclude: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude in the serialized result. Nested fields can be represented with dot delimiters.

fields: ClassVar[tuple[str, ...] | list[str]]

Fields to include in the (de)serialized result

include: ClassVar[dict[str, Field]]

Dictionary of additional fields to include in the schema. It is usually better to define fields as class variables, but you may need to use this option, e.g., if your fields are Python keywords.

index_errors: ClassVar[bool]

If True, errors dictionaries will include the index of invalid items in a collection.

load_only: ClassVar[tuple[str, ...] | list[str]]

Fields to exclude from serialized results

many: ClassVar[bool]

Whether data should be (de)serialized as a collection by default.

ordered: ClassVar[bool]

If True, Schema.dump <marshmallow.Schema.dump> is a collections.OrderedDict.

register: ClassVar[bool]

Whether to register the Schema <marshmallow.Schema> with marshmallow’s internal class registry. Must be True if you intend to refer to this Schema <marshmallow.Schema> by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

render_module: Any

Module to use for loads <marshmallow.Schema.loads> and dumps <marshmallow.Schema.dumps>. Defaults to json from the standard library.

timeformat: ClassVar[str]

Default format for Time <marshmallow.fields.Time> fields.

unknown: ClassVar[str]

Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE.

OPTIONS_CLASS

alias of SchemaOpts

TYPE_MAPPING: dict[type, type[Field]] = {<class 'bool'>: <class 'marshmallow.fields.Boolean'>, <class 'bytes'>: <class 'marshmallow.fields.String'>, <class 'datetime.date'>: <class 'marshmallow.fields.Date'>, <class 'datetime.datetime'>: <class 'marshmallow.fields.DateTime'>, <class 'datetime.time'>: <class 'marshmallow.fields.Time'>, <class 'datetime.timedelta'>: <class 'marshmallow.fields.TimeDelta'>, <class 'decimal.Decimal'>: <class 'marshmallow.fields.Decimal'>, <class 'float'>: <class 'marshmallow.fields.Float'>, <class 'int'>: <class 'marshmallow.fields.Integer'>, <class 'list'>: <class 'marshmallow.fields.Raw'>, <class 'set'>: <class 'marshmallow.fields.Raw'>, <class 'str'>: <class 'marshmallow.fields.String'>, <class 'tuple'>: <class 'marshmallow.fields.Raw'>, <class 'uuid.UUID'>: <class 'marshmallow.fields.UUID'>}

property dict_class: type[dict]

dict type to return when serializing.

dump(obj, *, many=None)

Serialize an object to native Python data types according to this Schema’s fields.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

Changed in version 3.0.0rc9: Validation no longer occurs upon serialization.

dumps(obj, *args, many=None, **kwargs)

Same as dump(), except return a JSON-encoded string.

Parameters:

• obj (Any) – The object to serialize.

• many (bool | None) – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the serialized data rather than a (data, errors) duple. A ValidationError is raised if obj is invalid.

error_messages: dict[str, str] = {}

Overrides for default schema-level error messages

fields: dict[str, Field]

Dictionary mapping field_names -> Field objects

classmethod from_dict(fields, *, name='GeneratedSchema')

Generate a Schema <marshmallow.Schema> class given a dictionary of fields.

from marshmallow import Schema, fields

PersonSchema = Schema.from_dict({"name": fields.Str()})
print(PersonSchema().load({"name": "David"}))  # => {'name': 'David'}

Generated schemas are not added to the class registry and therefore cannot be referred to by name in Nested fields.

Parameters:

• fields (dict[str, Field]) – Dictionary mapping field names to field instances.

• name (str) – Optional name for the class, which will appear in the repr for the class.

Return type:

type[Schema]

Added in version 3.0.0.

get_attribute(obj, attr, default)

Defines how to pull values from an object to serialize.

Changed in version 3.0.0a1: Changed position of obj and attr.

Parameters:

• obj (Any)

• attr (str)

• default (Any)

classmethod get_model()

Return the model associated to this schema.

Return type:

type[TypeVar(T)] | None

Returns:

Model associated to this schema.

handle_error(error, data, *, many, **kwargs)

Custom error handler function for the schema.

Parameters:

• error (ValidationError) – The ValidationError raised during (de)serialization.

• data (Any) – The original input data.

• many (bool) – Value of many on dump or load.

• partial – Value of partial on load.

Changed in version 3.0.0rc9: Receives many and partial (on deserialization) as keyword arguments.

load(data, *, many=None, partial=None, unknown=None)

Deserialize a data structure to an object defined by this Schema’s fields.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to deserialize.

• many (bool | None) – Whether to deserialize data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

loads(json_data, *, many=None, partial=None, unknown=None, **kwargs)

Same as load(), except it uses marshmallow.Schema.Meta.render_module to deserialize the passed string before passing data to load().

Parameters:

• json_data (str | bytes | bytearray) – A string of the data to deserialize.

• many (bool | None) – Whether to deserialize obj as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown (str | None) – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE. If None, the value for self.unknown is used.

Returns:

Deserialized data

Added in version 1.0.0.

Changed in version 3.0.0b7: This method returns the deserialized data rather than a (data, errors) duple. A ValidationError is raised if invalid data are passed.

make_object(data, **_)

on_bind_field(field_name, field_obj)

Hook to modify a field when it is bound to the Schema <marshmallow.Schema>.

No-op by default.

Parameters:

• field_name (str)

• field_obj (Field)

Return type:

None

opts: typing.Any = <marshmallow.schema.SchemaOpts object>

post_dump(data, original_data, **_)

pre_dump(data, **_)

pre_load(data, **_)

set_class

alias of OrderedSet

validate(data, *, many=None, partial=None)

Validate data against the schema, returning a dictionary of validation errors.

Parameters:

• data (Union[Mapping[str, Any], Iterable[Mapping[str, Any]]]) – The data to validate.

• many (bool | None) – Whether to validate data as a collection. If None, the value for self.many is used.

• partial (Union[bool, Sequence[str], AbstractSet[str], None]) – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

Return type:

dict[str, list[str]]

Returns:

A dictionary of validation errors.

Added in version 1.1.0.

class casys.elements.schemas.SelectionTypeField(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)

Bases: BaseEnumField

Marshmallow SelectionType field.

Parameters:

• load_default (Any)

• missing (Any)

• dump_default (Any)

• default (Any)

• data_key (str | None)

• attribute (str | None)

• validate (Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]], None])

• required (bool)

• allow_none (bool | None)

• load_only (bool)

• dump_only (bool)

• error_messages (dict[str, str] | None)

• metadata (Optional[Mapping[str, Any]])

property context: dict | None

The context dictionary for the parent Schema <marshmallow.Schema>.

property default

default_error_messages: dict[str, str] = {'null': 'Field may not be null.', 'required': 'Missing data for required field.', 'validator_failed': 'Invalid value.'}

Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make_error. The values are error messages passed to marshmallow.exceptions.ValidationError.

deserialize(value, attr=None, data=None, **kwargs)

Deserialize value.

Parameters:

• value (Any) – The value to deserialize.

• attr (str | None) – The attribute/key in data to deserialize.

• data (Optional[Mapping[str, Any]]) – The raw input data passed to Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – If an invalid value is passed or if a required value is missing.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

Deprecated since version 3.0.0: Use make_error <marshmallow.fields.Field.make_error> instead.

Parameters:

key (str)

get_value(obj, attr, accessor=None, default=<marshmallow.missing>)

Return the value for a given key from an object.

Parameters:

• obj (Any) – The object to get the value from.

• attr (str) – The attribute/key in obj to get the value from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

• default (Any)

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

Parameters:

key (str)

Return type:

ValidationError

property missing

serialize(attr, obj, accessor=None, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result.

Parameters:

• attr (str) – The attribute/key to get from the object.

• obj (Any) – The object to access the attribute/key from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – Function used to access values from obj.

• kwargs – Field-specific keyword arguments.

class casys.elements.schemas.StatTypeField(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)

Bases: BaseEnumField

Marshmallow StatType field.

Parameters:

• load_default (Any)

• missing (Any)

• dump_default (Any)

• default (Any)

• data_key (str | None)

• attribute (str | None)

• validate (Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]], None])

• required (bool)

• allow_none (bool | None)

• load_only (bool)

• dump_only (bool)

• error_messages (dict[str, str] | None)

• metadata (Optional[Mapping[str, Any]])

property context: dict | None

The context dictionary for the parent Schema <marshmallow.Schema>.

property default

default_error_messages: dict[str, str] = {'null': 'Field may not be null.', 'required': 'Missing data for required field.', 'validator_failed': 'Invalid value.'}

Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make_error. The values are error messages passed to marshmallow.exceptions.ValidationError.

deserialize(value, attr=None, data=None, **kwargs)

Deserialize value.

Parameters:

• value (Any) – The value to deserialize.

• attr (str | None) – The attribute/key in data to deserialize.

• data (Optional[Mapping[str, Any]]) – The raw input data passed to Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – If an invalid value is passed or if a required value is missing.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

Deprecated since version 3.0.0: Use make_error <marshmallow.fields.Field.make_error> instead.

Parameters:

key (str)

get_value(obj, attr, accessor=None, default=<marshmallow.missing>)

Return the value for a given key from an object.

Parameters:

• obj (Any) – The object to get the value from.

• attr (str) – The attribute/key in obj to get the value from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

• default (Any)

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

Parameters:

key (str)

Return type:

ValidationError

property missing

serialize(attr, obj, accessor=None, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result.

Parameters:

• attr (str) – The attribute/key to get from the object.

• obj (Any) – The object to access the attribute/key from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – Function used to access values from obj.

• kwargs – Field-specific keyword arguments.

class casys.elements.schemas.StorageModeField(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)

Bases: BaseEnumField

Marshmallow StorageMode field.

Parameters:

• load_default (Any)

• missing (Any)

• dump_default (Any)

• default (Any)

• data_key (str | None)

• attribute (str | None)

• validate (Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]], None])

• required (bool)

• allow_none (bool | None)

• load_only (bool)

• dump_only (bool)

• error_messages (dict[str, str] | None)

• metadata (Optional[Mapping[str, Any]])

property context: dict | None

The context dictionary for the parent Schema <marshmallow.Schema>.

property default

default_error_messages: dict[str, str] = {'null': 'Field may not be null.', 'required': 'Missing data for required field.', 'validator_failed': 'Invalid value.'}

Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make_error. The values are error messages passed to marshmallow.exceptions.ValidationError.

deserialize(value, attr=None, data=None, **kwargs)

Deserialize value.

Parameters:

• value (Any) – The value to deserialize.

• attr (str | None) – The attribute/key in data to deserialize.

• data (Optional[Mapping[str, Any]]) – The raw input data passed to Schema.load <marshmallow.Schema.load>.

• kwargs – Field-specific keyword arguments.

Raises:

ValidationError – If an invalid value is passed or if a required value is missing.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

Deprecated since version 3.0.0: Use make_error <marshmallow.fields.Field.make_error> instead.

Parameters:

key (str)

get_value(obj, attr, accessor=None, default=<marshmallow.missing>)

Return the value for a given key from an object.

Parameters:

• obj (Any) – The object to get the value from.

• attr (str) – The attribute/key in obj to get the value from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

• default (Any)

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

Parameters:

key (str)

Return type:

ValidationError

property missing

serialize(attr, obj, accessor=None, **kwargs)

Pulls the value for the given key from the object, applies the field’s formatting and returns the result.

Parameters:

• attr (str) – The attribute/key to get from the object.

• obj (Any) – The object to access the attribute/key from.

• accessor (Optional[Callable[[Any, str, Any], Any]]) – Function used to access values from obj.

• kwargs – Field-specific keyword arguments.