partis.schema.prim.map_prim module

class MapPrimDeclared(name=None, module=None, module_set=None, doc=None, **kwargs)

Bases: SchemaPrimDeclared

class MapPrim(name=None, module=None, module_set=None, doc=None, **kwargs)

Bases: SchemaPrim

Primitive for dictionary/mapping values

Parameters:

• item (SchemaPrim | SchemaPrim) – The schema for the value of each item in the mapping

• **kwargs (arguments passed to SchemaPrim) –

property hints

Definition hints.

Type:

list[ SchemaHint ]

validate(val, loc=None, bias=None)

Validates value against schema definition

Parameters:

• val (object) –

• loc (None | Loc) –

• bias (None | Bias) –

Returns:

• val (object)

• bias (Bias)

Raises:

SchemaValidationError – If the value is not valid

encode(val=None, loc=None, no_defaults=None)

Encodes value to basic Python types, performing validation

Parameters:

• val (None | object) – Source data used to initialize values

• loc (None | Loc) – Location information of source data (E.G. file, line/column number)

• no_defaults (bool) – Values that are equivalent to the ‘default_val’ are removed.

Returns:

val (object)

Raises:

SchemaValidationError – If the value is not valid

decode(val=None, loc=None, bias=None)

Decodes value to schema values, performing validation

Parameters:

• val (None | object) – Source data used to initialize values

• loc (None | Loc) – Location information of source data (E.G. file, line/column number)

• bias (None | Bias) –

Returns:

val (Valued)

Raises:

SchemaValidationError – If the value is not valid