testplan.testing.multitest.entries.schemas package

Submodules

testplan.testing.multitest.entries.schemas.assertions module

Schema definitions for serializing Assertion objects. This will be a one-way conversion, meaning that the reports and exports will be using the serialized data directly.

The reason being some assertion classes may have attributes that cannot be deserialized (processes, exception objects etc).

class testplan.testing.multitest.entries.schemas.assertions.ApproximateEqualitySchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.AssertionSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.base.BaseSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.BooleanSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.ColumnContainSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.DictCheckSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.DictMatchAllSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.DictMatchSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.EqualSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.FuncAssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.EqualSlicesSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.ExceptionRaisedSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.FailSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.FuncAssertionSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.LineDiffSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.MembershipSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.ProcessExitStatusSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.RawAssertionSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.RegexFindIterSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.RegexSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.RegexMatchLineSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.RegexSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.RegexSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.TableMatchSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.assertions.XMLCheckSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.assertions.AssertionSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

testplan.testing.multitest.entries.schemas.base module

Base classes / logic for marshalling go here.

class testplan.testing.multitest.entries.schemas.base.AssertionSchemaRegistry

Bases: testplan.common.serialization.schemas.SchemaRegistry

bind(*classes)

Decorator for binding one or more classes to another.

Parameters:classes – One or more classes that will be bound to the decorated class.

bind_default(category=None)

Decorator for binding a class as category based or absolute default.

Parameters:category – (optional) If provided, the decorated class will be the default for the given category, otherwise it will be the absolute default.

default

get_category(obj)

Override this to define logic for generating the category key from the object instance.

get_lookup_key(obj)

This method is used for generating the key when do a lookup from the registry. Object class is used by default.

get_record_key(obj)

This method is used for generating the key when we bind an object (possibly a class) via the registry.

logger

logger object

serialize(obj)

class testplan.testing.multitest.entries.schemas.base.AttachmentSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.base.BaseSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.base.BaseSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: marshmallow.schema.Schema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.base.CodeLogSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.base.BaseSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.base.DictLogSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.base.BaseSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.base.DirectorySchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.base.BaseSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.base.GenericEntryList(*, load_default: typing.Any = <marshmallow.missing>, missing: typing.Any = <marshmallow.missing>, dump_default: typing.Any = <marshmallow.missing>, default: typing.Any = <marshmallow.missing>, data_key: str | None = None, attribute: str | None = None, validate: None | (typing.Callable[[typing.Any], typing.Any] | typing.Iterable[typing.Callable[[typing.Any], typing.Any]]) = None, required: bool = False, allow_none: bool | None = None, load_only: bool = False, dump_only: bool = False, error_messages: dict[str, str] | None = None, metadata: typing.Mapping[str, typing.Any] | None = None, **additional_metadata)

Bases: marshmallow.fields.Field

context

The context dictionary for the parent Schema.

default

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

deserialize(value: typing.Any, attr: str | None = None, data: typing.Mapping[str, typing.Any] | None = None, **kwargs)

Deserialize value.

Parameters:

• value – The value to deserialize.
• attr – The attribute/key in data to deserialize.
• data – The raw input data passed to Schema.load.
• kwargs – Field-specific keyword arguments.

Raises:

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

fail(key: str, **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.

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

Return the value for a given key from an object.

Parameters:

• obj (object) – The object to get the value from.
• attr (str) – The attribute/key in obj to get the value from.
• accessor (callable) – A callable used to retrieve the value of attr from the object obj. Defaults to marshmallow.utils.get_value.

make_error(key: str, **kwargs) → marshmallow.exceptions.ValidationError

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

missing

name = None

parent = None

root = None

serialize(attr: str, obj: typing.Any, accessor: typing.Callable[[typing.Any, str, typing.Any], typing.Any] | None = None, **kwargs)

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

Parameters:

• attr – The attribute/key to get from the object.
• obj – The object to access the attribute/key from.
• accessor – Function used to access values from obj.
• kwargs – Field-specific keyword arguments.

class testplan.testing.multitest.entries.schemas.base.GraphSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.base.BaseSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.base.GroupSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: marshmallow.schema.Schema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.base.LogSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.base.BaseSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.base.MarkdownSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.base.BaseSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.base.PlotlySchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.base.AttachmentSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

class testplan.testing.multitest.entries.schemas.base.TableLogSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: testplan.testing.multitest.entries.schemas.base.BaseSchema

class Meta

Bases: object

Options object for a Schema.

Example usage:

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

Available options:

• fields: Tuple or list of fields to include in the serialized result.

• additional: Tuple or list of fields to include in addition to the

  explicitly declared fields. additional and fields are mutually-exclusive options.

• include: 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. May be an OrderedDict.

• exclude: Tuple or list of fields to exclude in the serialized result.

  Nested fields can be represented with dot delimiters.

• dateformat: Default format for Date <fields.Date> fields.
• datetimeformat: Default format for DateTime <fields.DateTime> fields.
• timeformat: Default format for Time <fields.Time> fields.

• render_module: Module to use for loads <Schema.loads> and dumps <Schema.dumps>.

  Defaults to json from the standard library.

• ordered: If True, order serialization output according to the

  order in which fields were declared. Output of Schema.dump will be a collections.OrderedDict.

• index_errors: If True, errors dictionaries will include the index

  of invalid items in a collection.

• load_only: Tuple or list of fields to exclude from serialized results.
• dump_only: Tuple or list of fields to exclude from deserialization

• unknown: Whether to exclude, include, or raise an error for unknown

  fields in the data. Use EXCLUDE, INCLUDE or RAISE.

• register: Whether to register the Schema with marshmallow’s internal

  class registry. Must be True if you intend to refer to this Schema by class name in Nested fields. Only set this to False when memory usage is critical. Defaults to True.

OPTIONS_CLASS

alias of marshmallow.schema.SchemaOpts

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

dict_class

dump(obj: typing.Any, *, many: bool | None = None)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

Serialized data

New 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: typing.Any, *args, many: bool | None = None, **kwargs)

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

Parameters:

• obj – The object to serialize.
• many – Whether to serialize obj as a collection. If None, the value for self.many is used.

Returns:

A json string

New 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 = {}

classmethod from_dict(fields: dict[str, ma_fields.Field | type], *, name: str = 'GeneratedSchema') → type

Generate a 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) – Dictionary mapping field names to field instances.
• name (str) – Optional name for the class, which will appear in the repr for the class.

New in version 3.0.0.

get_attribute(obj: Any, attr: str, default: Any)

Defines how to pull values from an object to serialize.

New in version 2.0.0.

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

handle_error(error: marshmallow.exceptions.ValidationError, data: Any, *, many: bool, **kwargs)

Custom error handler function for the schema.

Parameters:

• error – The ValidationError raised during (de)serialization.
• data – The original input data.
• many – Value of many on dump or load.
• partial – Value of partial on load.

New in version 2.0.0.

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

load(*args, **kwargs)

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

Parameters:

• data – The data to deserialize.
• many – Whether to deserialize data as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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: str, *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None, **kwargs)

Same as load(), except it takes a JSON string as input.

Parameters:

• json_data – A JSON string of the data to deserialize.
• many – Whether to deserialize obj as a collection. If None, the value for self.many is used.
• partial – 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 – 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

New 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.

on_bind_field(field_name: str, field_obj: marshmallow.fields.Field) → None

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

No-op by default.

opts = <marshmallow.schema.SchemaOpts object>

set_class

validate(data: typing.Mapping[str, typing.Any] | typing.Iterable[typing.Mapping[str, typing.Any]], *, many: bool | None = None, partial: bool | types.StrSequenceOrSet | None = None) → dict[str, list[str]]

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

Parameters:

• data – The data to validate.
• many – Whether to validate data as a collection. If None, the value for self.many is used.
• partial – 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.

Returns:

A dictionary of validation errors.

New in version 1.1.0.

Module contents

Entry point for schema serialization bindings.