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 = TrueMake 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.7, marshmallow >= 3.0.0, and SQLAlchemy >= 1.3.0.
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.
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
File details
Details for the file marshmallow-sqlalchemy-0.28.2.tar.gz.
File metadata
- Download URL: marshmallow-sqlalchemy-0.28.2.tar.gz
- Upload date:
- Size: 52.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2ab0f1280c793e5aec81deab3e63ec23688ddfe05e5f38ac960368a1079520a1 |
|
| MD5 | 56b111a98c38c8cae9ac9752b6f8d11c |
|
| BLAKE2b-256 | 07849cced63c2e1bbd4f243f5aed0a4eaf018ef97475e4eecf388bed4d5033b8 |
Provenance
File details
Details for the file marshmallow_sqlalchemy-0.28.2-py2.py3-none-any.whl.
File metadata
- Download URL: marshmallow_sqlalchemy-0.28.2-py2.py3-none-any.whl
- Upload date:
- Size: 16.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c31b3bdf794de1d78c53e1c495502cbb3eeb06ed216869980c71d6159e7e9e66 |
|
| MD5 | a665f3b77ece9c76ca9fb59d88f4c75f |
|
| BLAKE2b-256 | c2150c63bbbd7c21e44065ce7e198c0e515a98d2e37e5f5694d69595285dd67f |
