Skip to main content

Integration of attrs and marshmallow.

Project description

https://travis-ci.org/MacHu-GWU/attrsmallow-project.svg?branch=master https://codecov.io/gh/MacHu-GWU/attrsmallow-project/branch/master/graph/badge.svg https://img.shields.io/pypi/v/attrsmallow.svg https://img.shields.io/pypi/l/attrsmallow.svg https://img.shields.io/pypi/pyversions/attrsmallow.svg https://img.shields.io/badge/Star_Me_on_GitHub!--None.svg?style=social

Welcome to attrsmallow Documentation

attrs is a powerful library helps you to write concise and correct classes. And marshmallow is a powerful framework to write serializer/deserializer and data validator for complex object.

attrsmallow is a glue layer to taking advantage from them.

Usage

A blog example:

import attr
import marshmallow
from attrsmallow import BaseModel, BaseSchema

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


class UserSchema(BaseSchema):
    id = fields.Integer(required=True)
    name = fields.String(required=True)

    Model = User


User.Schema = UserSchema


@attr.s
class Post(BaseModel):
    id = attr.ib()
    title = attr.ib()
    user = attr.ib()


class PostSchema(BaseSchema):
    id = fields.Integer()
    title = fields.String()
    user = fields.Nested(UserSchema)

    Model = Post


Post.Schema = PostSchema

post_data = dict(id=1, title="Hello World!", user=dict(id=1, name="Alice"))
post = Post.load(post_data)

Install

attrsmallow is released on PyPI, so all you need is:

$ pip install attrsmallow

To upgrade to latest version:

$ pip install --upgrade attrsmallow

Project details


Download files

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

Files for attrsmallow, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size attrsmallow-0.0.1-py2-none-any.whl (15.1 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size attrsmallow-0.0.1.tar.gz (9.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page