| single |
======
cattrs
======
:alt: Documentation Status
:alt: 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, 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.
.. code-block:: pycon
>>> 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.
.. code-block:: pycon
>>> 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.
.. code-block:: pycon
>>> 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'))])
|