.. image:: https://img.shields.io/github/workflow/status/zeburek/convclasses/Test%20package/master :target: https://github.com/zeburek/convclasses/actions
.. image:: https://badge.fury.io/py/convclasses.svg :target: https://badge.fury.io/py/convclasses
.. image:: https://img.shields.io/pypi/dm/convclasses.svg :target: https://pypi.python.org/pypi/convclasses/
.. image:: https://img.shields.io/pypi/l/convclasses.svg :target: https://pypi.python.org/pypi/convclasses/
.. image:: https://img.shields.io/pypi/pyversions/convclasses.svg :target: https://pypi.python.org/pypi/convclasses/
.. image:: https://readthedocs.org/projects/convclasses/badge/?version=stable :target: https://convclasses.readthedocs.io/en/stable/
convclasses is an open source Python library for structuring and unstructuring
data. convclasses works best with dataclasses classes 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 are values are valid inputs to your programs. In
Python, structured data is better represented with classes and enumerations.
dataclasses 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...),
convclasses helps to convert this data into structured data. When you have to
convert your structured data into data types other libraries can handle,
convclasses 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:: python
>>> import convclasses
>>> from typing import Tuple
>>>
>>> convclasses.structure([1.0, 2, "3"], Tuple[int, int, int])
(1, 2, 3)
convclasses works well with dataclasses classes out of the box.
.. code-block:: python
>>> import convclasses
>>> from dataclasses import dataclass
>>> from typing import Any
>>> @dataclass(frozen=True) # It works with normal classes too.
... class C:
... a: Any
... b: Any
...
>>> instance = C(1, 'a')
>>> convclasses.unstructure(instance)
{'a': 1, 'b': 'a'}
>>> convclasses.structure({'a': 1, 'b': 'a'}, C)
C(a=1, b='a')
Here's a much more complex example, involving dataclasses classes with type
metadata.
.. code-block:: python
>>> from enum import unique, Enum
>>> from typing import Any, List, Optional, Sequence, Union
>>> from convclasses import structure, unstructure
>>> from dataclasses import dataclass
>>>
>>> @unique
... class CatBreed(Enum):
... SIAMESE = "siamese"
... MAINE_COON = "maine_coon"
... SACRED_BIRMAN = "birman"
...
>>> @dataclass
... class Cat:
... breed: CatBreed
... names: Sequence[str]
...
>>> @dataclass
... class DogMicrochip:
... chip_id: Any
... time_chipped: float
...
>>> @dataclass
... class Dog:
... cuteness: int
... chip: Optional[DogMicrochip]
...
>>> 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 dataclasses type metadata <https://docs.python.org/3/library/dataclasses.html>_
to add type metadata to attributes, so convclasses will know how to structure and
destructure them.
Converts structured data into unstructured data, recursively:
dataclasses classes are converted into dictionaries in a way similar to dataclasses.asdict,
or into tuples in a way similar to dataclasses.astuple.dataclasses classes.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).
dataclasses classes with simple attributes and the usual __init__.
All dataclasses classes with the usual __init__, if their complex attributes
have type metadata.
typing.Union s of supported dataclasses 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.
Major credits and best wishes for the original creator of this concept - Tinche_, he developed cattrs_ which this project is fork of.
Major credits to Hynek Schlawack for creating attrs_ and its predecessor, characteristic_.
convclasses is tested with Hypothesis_, by David R. MacIver.
convclasses is benchmarked using perf_, by Victor Stinner.
.. _attrs: https://github.com/hynek/attrs .. _characteristic: https://github.com/hynek/characteristic .. _Hypothesis: http://hypothesis.readthedocs.io/en/latest/ .. _perf: https://github.com/haypo/perf .. _cattrs: https://github.com/Tinche/cattrs .. _Tinche: https://github.com/Tinche
cattrs into conclassesattrs usage onto dataclassespendulum in docs onto arrowattrs classes and NoneType.Converter.unstruct_strat property setter.Converter.structure_attrs instance field.
As an alternative, create a new Converter:.. code-block:: python
>>> converter = cattr.Converter(unstruct_strat=cattr.UnstructureStrategy.AS_TUPLE)
structure(unstructure(obj)) roundtrip
is now up to 2 times faster.#17 <https://github.com/Tinche/cattrs/pull/17>_)Converter.register_structure_hook_func, to register a function instead of a class for determining handler func.Converter.register_unstructure_hook_func, to register a function instead of a class for determining handler func.#15 <https://github.com/Tinche/cattrs/pull/15>_)Optional attributes can no longer be structured if they are missing in the input.In other words, this no longer works:
.. code-block:: python
@attr.s
class A:
a: Optional[int] = attr.ib()
>>> cattr.structure({}, A)
cattr.typed removed since the functionality is now present in attrs itself.
Replace instances of cattr.typed(type) with attr.ib(type=type).Converter.loads is now Converter.structure, and Converter.dumps is now Converter.unstructure.cattr.typing to cattr.vendor.typing to support different vendored versions of typing.py for Python 2 and Python 3.attrs classes using cattr.typed.Python 3.4 is no longer supported.
Introduced cattr.typing for use with Python versions 3.5.2 and 3.6.0.
Minor changes to work with newer versions of typing.
Optional[Any]).Attempting to load unrecognized classes will result in a ValueError, and a helpful message to register a loads hook.
Loading attrs classes is now documented.
The global converter is now documented.
cattr.loads_attrs_fromtuple and cattr.loads_attrs_fromdict are now exposed.
FAQs
Complex custom class converters for dataclasses
We found that convclasses demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.