Skip to main content

SQLAlchemy integration with the marshmallow (de)serialization library

Project description

Latest version Travis-CI

Homepage: http://marshmallow-sqlalchemy.rtfd.org/

SQLAlchemy integration with the marshmallow (de)serialization library.

Declare your models

import sqlalchemy as sa
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import scoped_session, sessionmaker, relationship, backref

engine = sa.create_engine('sqlite:///:memory:')
session = scoped_session(sessionmaker(bind=engine))
Base = declarative_base()

class Author(Base):
    __tablename__ = 'authors'
    id = sa.Column(sa.Integer, primary_key=True)
    name = sa.Column(sa.String)

    def __repr__(self):
        return '<Author(name={self.name!r})>'.format(self=self)

class Book(Base):
    __tablename__ = 'books'
    id = sa.Column(sa.Integer, primary_key=True)
    title = sa.Column(sa.String)
    author_id = sa.Column(sa.Integer, sa.ForeignKey('authors.id'))
    author = relationship("Author", backref=backref('books'))

Base.metadata.create_all(engine)

Generate marshmallow schemas

from marshmallow_sqlalchemy import ModelSchema

class AuthorSchema(ModelSchema):
    class Meta:
        model = Author

class BookSchema(ModelSchema):
    class Meta:
        model = Book
        # optionally attach a Session
        # to use for deserialization
        sqla_session = session

author_schema = AuthorSchema()

(De)serialize your data

author = Author(name='Chuck Paluhniuk')
book = Book(title='Fight Club', author=author)
session.add(author)
session.add(book)
session.commit()

author_schema.dump(author).data
# {'books': [123], 'id': 321, 'name': 'Chuck Paluhniuk'}

author_schema.load(dump_data, session=session).data
# <Author(name='Chuck Paluhniuk')>

Get it now

pip install -U marshmallow-sqlalchemy

Documentation

Documentation is available at http://marshmallow-sqlalchemy.readthedocs.org/ .

License

MIT licensed. See the bundled LICENSE file for more details.

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

marshmallow-sqlalchemy-0.3.0.tar.gz (32.2 kB view details)

Uploaded Source

Built Distribution

marshmallow_sqlalchemy-0.3.0-py2.py3-none-any.whl (10.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file marshmallow-sqlalchemy-0.3.0.tar.gz.

File metadata

File hashes

Hashes for marshmallow-sqlalchemy-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f248dffe19a64ef11adbee778aa32d29d62bc864b4144cd08f502770d07db9ca
MD5 f481ecacb1d7554b1a32009f1fe20597
BLAKE2b-256 5eadac74a078d2c86fdecdf110ccfedaaa96810a85fa26ecf23447a9aa7df7de

See more details on using hashes here.

Provenance

File details

Details for the file marshmallow_sqlalchemy-0.3.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for marshmallow_sqlalchemy-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a0c2aed9525be724adb04da06a3d60a188f89cad352834cfffe1c94c007cf4bc
MD5 c5518b2530a30de367296eb08eb72010
BLAKE2b-256 fc7265770d4a9d9087028128aee20ad4387a82f35935066b6ee40d8766960856

See more details on using hashes here.

Provenance

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