Skip to main content

SQLAlchemy integration with the marshmallow (de)serialization library

Project description

Latest version Build status Documentation marshmallow 3|4 compatible

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

SQLAlchemy integration with the marshmallow (de)serialization library.

Declare your models

import sqlalchemy as sa
from sqlalchemy.orm import (
    DeclarativeBase,
    backref,
    relationship,
    sessionmaker,
)

from marshmallow_sqlalchemy import SQLAlchemySchema, auto_field

engine = sa.create_engine("sqlite:///:memory:")
Session = sessionmaker(engine)


class Base(DeclarativeBase):
    pass


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

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


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 SQLAlchemySchema, auto_field


class AuthorSchema(SQLAlchemySchema):
    class Meta:
        model = Author
        load_instance = True  # Optional: deserialize to model instances

    id = auto_field()
    name = auto_field()
    books = auto_field()


class BookSchema(SQLAlchemySchema):
    class Meta:
        model = Book
        load_instance = True

    id = auto_field()
    title = auto_field()
    author_id = auto_field()

You can automatically generate fields for a model’s columns using SQLAlchemyAutoSchema. The following schema classes are equivalent to the above.

from marshmallow_sqlalchemy import SQLAlchemyAutoSchema


class AuthorSchema(SQLAlchemyAutoSchema):
    class Meta:
        model = Author
        include_relationships = True
        load_instance = True


class BookSchema(SQLAlchemyAutoSchema):
    class Meta:
        model = Book
        include_fk = True
        load_instance = True

Make sure to declare Models before instantiating Schemas. Otherwise sqlalchemy.orm.configure_mappers() will run too soon and fail.

(De)serialize your data

author = Author(name="Chuck Paluhniuk")
author_schema = AuthorSchema()
book = Book(title="Fight Club", author=author)

with Session() as session:
    session.add(author)
    session.add(book)
    session.commit()

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

with Session() as session:
    load_data = author_schema.load(dump_data, session=session)
    print(load_data)
    # <Author(name='Chuck Paluhniuk')>

Get it now

$ pip install -U marshmallow-sqlalchemy

Requires Python >= 3.9, marshmallow >= 3.18.0, and SQLAlchemy >= 1.4.40.

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

Uploaded Source

Built Distribution

marshmallow_sqlalchemy-1.4.2-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file marshmallow_sqlalchemy-1.4.2.tar.gz.

File metadata

  • Download URL: marshmallow_sqlalchemy-1.4.2.tar.gz
  • Upload date:
  • Size: 51.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for marshmallow_sqlalchemy-1.4.2.tar.gz
Algorithm Hash digest
SHA256 6410304bf98ec26ea35f3f9d3cee82e51fd093c434612add32a0bdcdb5668f7c
MD5 6bb2860c9acfd128b562f92f72d00e69
BLAKE2b-256 1d8c861ed468b99773866d59e315a73a02538f503c99167d24b3b3f1c8e0242c

See more details on using hashes here.

Provenance

The following attestation bundles were made for marshmallow_sqlalchemy-1.4.2.tar.gz:

Publisher: build-release.yml on marshmallow-code/marshmallow-sqlalchemy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file marshmallow_sqlalchemy-1.4.2-py3-none-any.whl.

File metadata

File hashes

Hashes for marshmallow_sqlalchemy-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 65aee301c4601e76a2fdb02764a65c18913afba2a3506a326c625d13ab405b40
MD5 f63f49a8f572ec24eca00b34561c8e19
BLAKE2b-256 26629d87301c861b9bded849082d5c5d306dcfd0c3c304b7ed70d2151caaa4da

See more details on using hashes here.

Provenance

The following attestation bundles were made for marshmallow_sqlalchemy-1.4.2-py3-none-any.whl:

Publisher: build-release.yml on marshmallow-code/marshmallow-sqlalchemy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page