cattr.preconf package

Submodules

cattr.preconf.bson module

cattr.preconf.json module

Preconfigured converters for the stdlib json.

class cattr.preconf.json.JsonConverter(dict_factory=<class 'dict'>, unstruct_strat=UnstructureStrategy.AS_DICT, omit_if_default=False, forbid_extra_keys=False, type_overrides={}, unstruct_collection_overrides={}, prefer_attrib_converters=False, detailed_validation=True)[source]

Bases: cattrs.converters.Converter

Parameters

  • dict_factory (Callable[[], Any]) –

  • unstruct_strat (cattrs.converters.UnstructureStrategy) –

  • omit_if_default (bool) –

  • forbid_extra_keys (bool) –

  • type_overrides (collections.abc.Mapping[Type, cattrs.gen.AttributeOverride]) –

  • unstruct_collection_overrides (collections.abc.Mapping[Type, Callable]) –

  • prefer_attrib_converters (bool) –

  • detailed_validation (bool) –

dumps(obj, unstructure_as=None, **kwargs)[source]
Parameters

obj (Any) –

Return type

str

forbid_extra_keys
loads(data, cl, **kwargs)[source]
Parameters

  • data (Union[bytes, str]) –

  • cl (Type[cattrs.preconf.json.T]) –

Return type

cattrs.preconf.json.T

omit_if_default
type_overrides
cattr.preconf.json.configure_converter(converter)[source]

Configure the converter for use with the stdlib json module.

  • bytes are serialized as base64 strings

  • datetimes are serialized as ISO 8601

  • counters are serialized as dicts

  • sets are serialized as lists

Parameters

converter (cattrs.converters.BaseConverter) –

cattr.preconf.json.make_converter(*args, **kwargs)[source]
Return type

cattrs.preconf.json.JsonConverter

cattr.preconf.msgpack module

Preconfigured converters for msgpack.

class cattr.preconf.msgpack.MsgpackConverter(dict_factory=<class 'dict'>, unstruct_strat=UnstructureStrategy.AS_DICT, omit_if_default=False, forbid_extra_keys=False, type_overrides={}, unstruct_collection_overrides={}, prefer_attrib_converters=False, detailed_validation=True)[source]

Bases: cattrs.converters.Converter

Parameters

  • dict_factory (Callable[[], Any]) –

  • unstruct_strat (cattrs.converters.UnstructureStrategy) –

  • omit_if_default (bool) –

  • forbid_extra_keys (bool) –

  • type_overrides (collections.abc.Mapping[Type, cattrs.gen.AttributeOverride]) –

  • unstruct_collection_overrides (collections.abc.Mapping[Type, Callable]) –

  • prefer_attrib_converters (bool) –

  • detailed_validation (bool) –

dumps(obj, unstructure_as=None, **kwargs)[source]
Parameters

obj (Any) –

Return type

bytes

forbid_extra_keys
loads(data, cl, **kwargs)[source]
Parameters

  • data (bytes) –

  • cl (Type[cattrs.preconf.msgpack.T]) –

Return type

cattrs.preconf.msgpack.T

omit_if_default
type_overrides
cattr.preconf.msgpack.configure_converter(converter)[source]

Configure the converter for use with the msgpack library.

  • datetimes are serialized as timestamp floats

  • sets are serialized as lists

Parameters

converter (cattrs.converters.BaseConverter) –

cattr.preconf.msgpack.make_converter(*args, **kwargs)[source]
Return type

cattrs.preconf.msgpack.MsgpackConverter

cattr.preconf.orjson module

cattr.preconf.pyyaml module

cattr.preconf.tomlkit module

Preconfigured converters for tomlkit.

class cattr.preconf.tomlkit.TomlkitConverter(dict_factory=<class 'dict'>, unstruct_strat=UnstructureStrategy.AS_DICT, omit_if_default=False, forbid_extra_keys=False, type_overrides={}, unstruct_collection_overrides={}, prefer_attrib_converters=False, detailed_validation=True)[source]

Bases: cattrs.converters.Converter

Parameters

  • dict_factory (Callable[[], Any]) –

  • unstruct_strat (cattrs.converters.UnstructureStrategy) –

  • omit_if_default (bool) –

  • forbid_extra_keys (bool) –

  • type_overrides (collections.abc.Mapping[Type, cattrs.gen.AttributeOverride]) –

  • unstruct_collection_overrides (collections.abc.Mapping[Type, Callable]) –

  • prefer_attrib_converters (bool) –

  • detailed_validation (bool) –

dumps(obj, unstructure_as=None, **kwargs)[source]
Parameters

obj (Any) –

Return type

str

forbid_extra_keys
loads(data, cl)[source]
Parameters

  • data (str) –

  • cl (Type[cattrs.preconf.tomlkit.T]) –

Return type

cattrs.preconf.tomlkit.T

omit_if_default
type_overrides
cattr.preconf.tomlkit.configure_converter(converter)[source]

Configure the converter for use with the tomlkit library.

  • bytes are serialized as base85 strings

  • sets are serialized as lists

  • tuples are serializas as lists

  • mapping keys are coerced into strings when unstructuring

Parameters

converter (cattrs.converters.BaseConverter) –

cattr.preconf.tomlkit.make_converter(*args, **kwargs)[source]
Return type

cattrs.preconf.tomlkit.TomlkitConverter

cattr.preconf.ujson module

Module contents

cattr.preconf.validate_datetime(v, _)[source]