Skip to main content

cattrs

Documentation Status Supported Python versions


cattrs is an open source Python library for structuring and unstructuring data. cattrs works best with attrs classes, dataclasses and the usual Python collections, but other kinds of classes are supported by manually registering converters.

Python has a rich set of powerful, easy to use, built-in data types like dictionaries, lists and tuples. These data types are also the lingua franca of most data serialization libraries, for formats like json, msgpack, cbor, yaml or toml.

Data types like this, and mappings like dict s in particular, represent unstructured data. Your data is, in all likelihood, structured: not all combinations of field names or values are valid inputs to your programs. In Python, structured data is better represented with classes and enumerations. attrs is an excellent library for declaratively describing the structure of your data, and validating it.

When you're handed unstructured data (by your network, file system, database...), cattrs helps to convert this data into structured data. When you have to convert your structured data into data types other libraries can handle, cattrs turns your classes and enumerations into dictionaries, integers and strings.

Here's a simple taste. The list containing a float, an int and a string gets converted into a tuple of three ints.

>>> import cattrs

>>> cattrs.structure([1.0, 2, "3"], tuple[int, int, int])
(1, 2, 3)

cattrs works well with attrs classes out of the box.

>>> from attrs import frozen
>>> import cattrs

>>> @frozen  # It works with non-frozen classes too.
... class C:
...     a: int
...     b: str

>>> instance = C(1, 'a')
>>> cattrs.unstructure(instance)
{'a': 1, 'b': 'a'}
>>> cattrs.structure({'a': 1, 'b': 'a'}, C)
C(a=1, b='a')

Here's a much more complex example, involving attrs classes with type metadata.

>>> from enum import unique, Enum
>>> from typing import Optional, Sequence, Union
>>> from cattrs import structure, unstructure
>>> from attrs import define, field

>>> @unique
... class CatBreed(Enum):
...     SIAMESE = "siamese"
...     MAINE_COON = "maine_coon"
...     SACRED_BIRMAN = "birman"

>>> @define
... class Cat:
...     breed: CatBreed
...     names: Sequence[str]

>>> @define
... class DogMicrochip:
...     chip_id = field()  # Type annotations are optional, but recommended
...     time_chipped: float = field()

>>> @define
... class Dog:
...     cuteness: int
...     chip: Optional[DogMicrochip] = None

>>> p = unstructure([Dog(cuteness=1, chip=DogMicrochip(chip_id=1, time_chipped=10.0)),
...                  Cat(breed=CatBreed.MAINE_COON, names=('Fluffly', 'Fluffer'))])

>>> print(p)
[{'cuteness': 1, 'chip': {'chip_id': 1, 'time_chipped': 10.0}}, {'breed': 'maine_coon', 'names': ('Fluffly', 'Fluffer')}]
>>> print(structure(p, list[Union[Dog, Cat]]))
[Dog(cuteness=1, chip=DogMicrochip(chip_id=1, time_chipped=10.0)), Cat(breed=<CatBreed.MAINE_COON: 'maine_coon'>, names=['Fluffly', 'Fluffer'])]

Consider unstructured data a low-level representation that needs to be converted to structured data to be handled, and use structure. When you're done, unstructure the data to its unstructured form and pass it along to another library or module. Use attrs type metadata to add type metadata to attributes, so cattrs will know how to structure and destructure them.

  • Free software: MIT license
  • Documentation: https://catt.rs
  • Python versions supported: 3.8 and up. (Older Python versions are supported by older versions; see the changelog.)

Features

  • Converts structured data into unstructured data, recursively:

    • attrs classes and dataclasses are converted into dictionaries in a way similar to attrs.asdict, or into tuples in a way similar to attrs.astuple.
    • Enumeration instances are converted to their values.
    • Other types are let through without conversion. This includes types such as integers, dictionaries, lists and instances of non-attrs classes.
    • Custom converters for any type can be registered using register_unstructure_hook.
  • Converts unstructured data into structured data, recursively, according to your specification given as a type. The following types are supported:

    • typing.Optional[T].

    • typing.List[T], typing.MutableSequence[T], typing.Sequence[T] (converts to a list).

    • typing.Tuple (both variants, Tuple[T, ...] and Tuple[X, Y, Z]).

    • typing.MutableSet[T], typing.Set[T] (converts to a set).

    • typing.FrozenSet[T] (converts to a frozenset).

    • typing.Dict[K, V], typing.MutableMapping[K, V], typing.Mapping[K, V] (converts to a dict).

    • typing.TypedDict.

    • attrs classes with simple attributes and the usual __init__.

      • Simple attributes are attributes that can be assigned unstructured data, like numbers, strings, and collections of unstructured data.
    • All attrs classes and dataclasses with the usual __init__, if their complex attributes have type metadata.

    • typing.Union s of supported attrs classes, given that all of the classes have a unique field.

    • typing.Union s of anything, given that you provide a disambiguation function for it.

    • Custom converters for any type can be registered using register_structure_hook.

cattrs comes with preconfigured converters for a number of serialization libraries, including json, msgpack, cbor2, bson, yaml and toml. For details, see the cattrs.preconf package.

Design Decisions

cattrs is based on a few fundamental design decisions.

  • Un/structuring rules are separate from the models. This allows models to have a one-to-many relationship with un/structuring rules, and to create un/structuring rules for models which you do not own and you cannot change. (cattrs can be configured to use un/structuring rules from models using the use_class_methods strategy.)
  • Invent as little as possible; reuse existing ordinary Python instead. For example, cattrs did not have a custom exception type to group exceptions until the sanctioned Python exceptiongroups. A side-effect of this design decision is that, in a lot of cases, when you're solving cattrs problems you're actually learning Python instead of learning cattrs.
  • Refuse the temptation to guess. If there are two ways of solving a problem, cattrs should refuse to guess and let the user configure it themselves.

A foolish consistency is the hobgoblin of little minds so these decisions can and are sometimes broken, but they have proven to be a good foundation.

Additional documentation and talks

Credits

Major credits to Hynek Schlawack for creating attrs and its predecessor, characteristic.

cattrs is tested with Hypothesis, by David R. MacIver.

cattrs is benchmarked using perf and pytest-benchmark.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Metadata

Release files for cattrs 23.2.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cattrs 23.2.3
File Size Uploaded Provenance Actions
cattrs-23.2.3.tar.gz 610.2 kB Without provenance Details for cattrs-23.2.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cattrs 23.2.3
File Interpreter ABI Platform Actions
cattrs-23.2.3-py3-none-any.whl Python 3 none any Details for cattrs-23.2.3-py3-none-any.whl

Total release size: 667.7 kB

Release files / cattrs-23.2.3.tar.gz

Download URL cattrs-23.2.3.tar.gz
Size 610.2 kB
Tags Source
SHA-256 checksum
How to use checksums
a934090d95abaa9e911dac357e3a8699e0b4b14f8529bcc7d2b1ad9d51672b9f
BLAKE2b-256 checksum
How to use checksums
1e57c6ccd22658c4bcb3beb3f1c262e1f170cf136e913b122763d0ddd328d284
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.2 CPython/3.11.6

Release files / cattrs-23.2.3-py3-none-any.whl

Download URL cattrs-23.2.3-py3-none-any.whl
Size 57.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0341994d94971052e9ee70662542699a3162ea1e0c62f7ce1b4a57f563685108
BLAKE2b-256 checksum
How to use checksums
b30dcd4a4071c7f38385dc5ba91286723b4d1090b87815db48216212c6c6c30e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.2 CPython/3.11.6

Security for cattrs 23.2.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

23.2.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page