SQLAlchemy integration with the marshmallow (de)serialization library
Project description
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, nullable=False)
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 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)
session.add(author)
session.add(book)
session.commit()
dump_data = author_schema.dump(author)
print(dump_data)
# {'id': 1, 'name': 'Chuck Paluhniuk', 'books': [1]}
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.8, marshmallow >= 3.0.0, and SQLAlchemy >= 1.4.40.
Documentation
Documentation is available at https://marshmallow-sqlalchemy.readthedocs.io/ .
Project Links
Changelog: https://marshmallow-sqlalchemy.readthedocs.io/en/latest/changelog.html
Contributing Guidelines: https://marshmallow-sqlalchemy.readthedocs.io/en/latest/contributing.html
PyPI: https://pypi-hypernode.com/pypi/marshmallow-sqlalchemy
Issues: https://github.com/marshmallow-code/marshmallow-sqlalchemy/issues
License
MIT licensed. See the bundled LICENSE file for more details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for marshmallow-sqlalchemy-0.30.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29ad0a4fd1b4a1e52dcb07f9673d284a6b0795141916cc2169d4ee9a5d007347 |
|
MD5 | 61e46e0ad5fabd0e9e11f895e1243bc3 |
|
BLAKE2b-256 | 5d3f21aa202f3df31d2d20d4ae8dfe9c7f1ce0a1eecba7003915a986a7599778 |
Hashes for marshmallow_sqlalchemy-0.30.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 808c1e95bf72f4491ad2f3498e73116b33074d7dcef79f0e6997d0d37d648ac7 |
|
MD5 | 350d51f2449038e6c1737f3b7d94c5c1 |
|
BLAKE2b-256 | 438383a5364ddee0ba461e1f2d2ebb4d58ee1a38533a8dbb028f0914ac2bb880 |