Skip to main content

SQLAlchemy integration with the marshmallow (de)serialization library

Project description

Latest version Travis-CI Documentation marshmallow 3 compatible code style: black

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).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 https://marshmallow-sqlalchemy.readthedocs.io/ .

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

Uploaded Source

Built Distribution

marshmallow_sqlalchemy-0.17.0-py2.py3-none-any.whl (13.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: marshmallow-sqlalchemy-0.17.0.tar.gz
  • Upload date:
  • Size: 45.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.7

File hashes

Hashes for marshmallow-sqlalchemy-0.17.0.tar.gz
Algorithm Hash digest
SHA256 d662fc8103a06b59aafbc33c8ab4f1318799d66aae4f660c1e7e278bc45ef69e
MD5 199259858e8c1a4679bff3e11ac97935
BLAKE2b-256 b2337d2bcbef9256efd7ff27ff6cf5fc036d2fbc5f6471997ea8cf5973965c80

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: marshmallow_sqlalchemy-0.17.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.7

File hashes

Hashes for marshmallow_sqlalchemy-0.17.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f69e740ea8d3b678fd712263e5dd739c94482cd8840e2f6cf4314919e6547cee
MD5 97909adcf015dbcd644c73a750144596
BLAKE2b-256 63b273d041a32d3e859c95d3c5ed3f5fca66b5877efaee247015679b9a146546

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