Skip to main content

Dataclasses married with yaml.

Project description


Python's 3.7 dataclasses got maried with pyyaml.


pip install yamliz

Usage example:

import dataclasses
import yamliz
from yamliz import fields

class Some(yamliz.Able):
    id: int = fields.Integer()
    mac: str = fields.MacAddress()
    ip: str = fields.IPv4()
    version: int = fields.Integer(default=411)

Now the Some object can be created as a pure python object (thanks to dataclass) it is equipped with __init__, __repr__, __eq__ and some other methods.

>>> obj = Some(123, 'aa:bb:cc:11:22:33', '')
>>> obj
Some(id=123, mac='aa:bb:cc:11:22:33', ip='', version=411)

>>> print(obj)
id: 123
mac: aa:bb:cc:11:22:33
version: 411

It's attributes are regular python attributes:


>>> obj.mac

>>> obj.ip

>>> obj.version = 0  # can be assigned
>>> print(repr(obj))
Ints(id=123, mac='aa:bb:cc:11:22:33', ip='', version=0)

It can be also deserialized from yaml directly to the custom object:

>>> yaml_string = """
id: 22001
mac: aa:bb:cc:11:22:33
version: 0

>>> import yaml
>>> obj2 = yaml.load(yaml_string, Loader=yaml.Loader)
>>> repr(obj2)
Some(id=22001, mac='aa:bb:cc:11:22:33', ip='', version=0)

To be further documented...

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yamliz-0.1.2.tar.gz (5.7 kB view hashes)

Uploaded source

Built Distribution

yamliz-0.1.2-py2.py3-none-any.whl (13.2 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page