marshmallow-sqlalchemy 0.20.0

SQLAlchemy integration with the marshmallow (de)serialization library

Homepage: https://marshmallow-sqlalchemy.readthedocs.io/

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")
author_schema = AuthorSchema()
book = Book(title="Fight Club", author=author)
session.add(author)
session.add(book)
session.commit()

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

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

Get it now

pip install -U marshmallow-sqlalchemy

Requires Python >= 3.6, marshmallow >= 2.15.2, and SQLAlchemy >= 1.2.0.

Documentation

Documentation is available at https://marshmallow-sqlalchemy.readthedocs.io/ .

Project Links

• Docs: https://marshmallow-sqlalchemy.readthedocs.io/

• Changelog: https://marshmallow-sqlalchemy.readthedocs.io/en/latest/changelog.html

• Contributing Guidelines: https://marshmallow-sqlalchemy.readthedocs.io/en/latest/contributing.html

• PyPI: https://pypi.python.org/pypi/marshmallow-sqlalchemy

• Issues: https://github.com/marshmallow-code/marshmallow-sqlalchemy/issues

License

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