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.4.0.tar.gz (33.7 kB view details)

Uploaded Source

Built Distribution

marshmallow_sqlalchemy-0.4.0-py2.py3-none-any.whl (11.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for marshmallow-sqlalchemy-0.4.0.tar.gz
Algorithm Hash digest
SHA256 e108f05e92f17e13c3dfe3df0310880ad28b6bb94f535fa30228e5b344754e8b
MD5 b0c37aa98a33de1031c1c43661801182
BLAKE2b-256 26075cc8b1e2fd0e7e7f7617c20e3a209c0cb0fd35f54d5c94571a05c7d29ad0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for marshmallow_sqlalchemy-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 066c23a6ac6080dc7f02c782eb28312d02d15cc75be5ec97eb165b2505f1f217
MD5 925116797ef557afaa8bca2e2f098be4
BLAKE2b-256 5c462dd1e1cfa5c46d197dcc167f186f59238011f7a8367e09aa4c3263c8e4ab

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