attrs-mate 0.0.2

Welcome to attrs_mate Documentation

Usage: more utility methods.

import attr
from attrs_mate import AttrsClass

@attr.s
class User(AttrsClass):
    id = attr.ib()
    name = attr.ib()

user = User(id=1, name="Alice")
user.keys() # ["id", "name"]
user.values() # [1, "Alice"]
user.items() # [("id", 1), ("name": "Alice")]
user.to_dict() # {"id": 1, "name": "Alice"}
user.to_OrderedDict() # OrderedDict([("id", 1), ("name": "Alice")])

Feature: allow attrs to load complex object from dict data.

import attr
from attrs_mate import AttrsClass


@attr.s
class Profile(AttrsClass):
    """
    firstname, lastname, ssn are generic data type field.
    """
    firstname = attr.ib(default=None)
    lastname = attr.ib(default=None)
    ssn = attr.ib(default=None)


@attr.s
class Degree(AttrsClass):
    name = attr.ib(default=None)
    year = attr.ib(default=None)


@attr.s
class People(AttrsClass):
    """
    - ``profile`` is nested field.
    - ``degrees`` is collection type field.
    """
    id = attr.ib(default=None)
    profile = attr.ib(
        convert=Profile.from_dict,
        factory=Profile,
    )
    degrees = attr.ib(
        convert=lambda degrees: [
            Degree.from_dict(degree) for degree in degrees],
        factory=list,
    )

people = People(
    id=1,
    profile=Profile(
        firstname="David",
        lastname="John",
        ssn="123-45-6789",
    ),
    degrees=[
        Degree(name="Bachelor", year=2004),
        Degree(name="Master", year=2006),
    ],
)
people_data = people.to_dict()

# {
#     'id': 1,
#     'profile': {
#         'lastname': 'John', 'ssn': '123-45-6789', 'firstname': 'David'
#     },
#     'degrees': [
#         {'name': 'Bachelor', 'year': 2004},
#         {'name': 'Master', 'year': 2006}
#     ]
# }
print(people_data)

people = People.from_dict(people_data)
# People(id=1, profile=Profile(firstname='David', lastname='John', ssn='123-45-6789'), degrees=[Degree(name='Bachelor', year=2004), Degree(name='Master', year=2006)])
print(people)

$ pip install attrs_mate

$ pip install --upgrade attrs_mate