marshmallow-sqlalchemy

Bump version and update changelog

Bump version and update changelog

Bump version and update changelog

Bump version and update changelog

Bump version and update changelog

Bump version and update changelog

Bump version and update changelog

Features:

• Use Session.get() load instances to improve deserialization performance (548). Thanks zippolyte for the PR.

Other changes:

• Drop support for Python 3.7, which is EOL (540).

Features:

• Support SQLAlchemy 2.0 (494). Thanks dependabot for the PR.

• Enable (in tests) and fix SQLAlchemy 2.0 compatibility warnings (493).

Bug fixes:

• Use mapper .attrs rather than .get_property and .iterate_properties to ensure registry.configure is called (call removed in SQLAlchemy 2.0.2) (487). Thanks ddoyon92 for the PR.

Other changes:

• Drop support for SQLAlchemy 1.3, which is EOL (493).

Bug fixes:

• Use .scalar_subquery() for SQLAlchemy>1.4 to suppress a warning (459). Thanks indiVar0508 for the PR.

Other changes:

• Lock SQLAlchemy<2.0 in setup.py. SQLAlchemy 2.x is not supported (486).

• Test against Python 3.11 (486).

Bug fixes:

• Address DeprecationWarning re: usage of distutils (435). Thanks Tenzer for the PR.

Features:

• Add support for generating fields from column_property (97). Thanks mrname for the PR.

Other changes:

• Drop support for Python 3.6, which is EOL.

• Drop support for SQLAlchemy 1.2, which is EOL.

Features:

• Distribute type information per PEP 561 (420). Thanks bruceadams for the PR.

Other changes:

• Test against Python 3.10 (421).

Bug fixes:

• Fix generating fields for postgreql.ARRAY columns (392). Thanks mjpieters for the catch and patch.

Bug fixes:

• Unwrap proxied columns to handle models for subqueries (383). Thanks mjpieters for the catch and patch

• Fix setting transient on a per-instance basis when the transient Meta option is set (388). Thanks again mjpieters.

Other changes:

• Backwards-incompatible: Remove deprecated ModelSchema and TableSchema classes.

• Add load_instance as a parameter to SQLAlchemySchema and SQLAlchemyAutoSchema (380). Thanks mjpieters for the PR.

• Fix deprecation warnings from marshmallow 3.10 and SQLAlchemy 1.4 (369). Thanks peterschutt for the PR.

• auto_field supports association_proxy fields with local multiplicity (uselist=True) (364). Thanks Unix-Code for the catch and patch.

• auto_field works with association_proxy (338). Thanks AbdealiJK.

• Backwards-incompatible: Drop support for marshmallow 2.x, which is now EOL.

• Test against Python 3.9.

Bug fixes:

• Don't add no-op Length validator (315). Thanks taion for the PR.

Bug fixes:

• Fix data keys when using Related with a Column that is named differently from its attribute (299). Thanks peterschutt for the catch and patch.

• Fix bug that raised an exception when using the ordered = True option on a schema that has an auto_field (306). Thanks KwonL for reporting and thanks peterschutt for the PR.

Bug fixes:

• Fix DeprecationWarning getting raised even when user code does not use TableSchema or ModelSchema (289). Thanks 5uper5hoot for reporting.

Bug fixes:

• Avoid error when using SQLAlchemyAutoSchema, ModelSchema, or fields_for_model with a model that has a SynonymProperty (190). Thanks TrilceAC for reporting.

• auto_field and field_for work with SynonymProperty (280).

Other changes:

• Add hook in ModelConverter for changing field names based on SQLA columns and properties (276). Thanks davenquinn for the suggestion and the PR.

Bug fixes:

• Fix behavior when passing table to auto_field (277).

Features:

• Add SQLAlchemySchema and SQLAlchemyAutoSchema, which have an improved API for generating marshmallow fields and overriding their arguments via auto_field (240). Thanks taion for the idea and original implementation.

# Before
from marshmallow_sqlalchemy import ModelSchema, field_for

from . import models


class ArtistSchema(ModelSchema):
    class Meta:
        model = models.Artist

    id = field_for(models.Artist, "id", dump_only=True)
    created_at = field_for(models.Artist, "created_at", dump_only=True)


# After
from marshmallow_sqlalchemy import SQLAlchemySchema, auto_field

from . import models


class ArtistSchema(SQLAlchemyAutoSchema):
    class Meta:
        model = models.Artist

    id = auto_field(dump_only=True)
    created_at = auto_field(dump_only=True)

• Add load_instance option to configure deserialization to model instances (193, 270).

• Add include_relationships option to configure generation of marshmallow fields for relationship properties (98). Thanks dusktreader for the suggestion.

Deprecations:

• ModelSchema and TableSchema are deprecated, since SQLAlchemyAutoSchema has equivalent functionality.

# Before
from marshmallow_sqlalchemy import ModelSchema, TableSchema

from . import models


class ArtistSchema(ModelSchema):
    class Meta:
        model = models.Artist


class AlbumSchema(TableSchema):
    class Meta:
        table = models.Album.__table__


# After
from marshmallow_sqlalchemy import SQLAlchemyAutoSchema

from . import models


class ArtistSchema(SQLAlchemyAutoSchema):
    class Meta:
        model = models.Artist
        include_relationships = True
        load_instance = True


class AlbumSchema(SQLAlchemyAutoSchema):
    class Meta:
        table = models.Album.__table__

• Passing info={"marshmallow": ...} to SQLAlchemy columns is deprecated, as it is redundant with the auto_field functionality.

Other changes:

• Backwards-incompatible: fields_for_model does not include relationships by default. Use fields_for_model(..., include_relationships=True) to preserve the old behavior.

• Add support for postgresql.OID type (262). Thanks petrus-v for the PR.

• Remove imprecise Python 3 classifier from PyPI metadata (255). Thanks ecederstrand.

• Add support for mysql.DATETIME and mysql.INTEGER type (204).

• Add support for postgresql.CIDR type (183).

• Add support for postgresql.DATE and postgresql.TIME type.

Thanks evelyn9191 for the PR.

• Drop support for Python 2.7 and 3.5 (241).

• Drop support for marshmallow<2.15.2.

• Only support sqlalchemy>=1.2.0.

Features:

• marshmallow_sqlalchemy.fields.Nested propagates the value of transient on the call to load (177, 206). Thanks leonidumanskiy for reporting.

Note: This is the last release to support Python 2.7 and 3.5.

Bug fixes:

• Fix error handling when passing an invalid type to Related (223). Thanks heckad for reporting.

• Address DeprecationWarning raised when using Related with marshmallow 3 (243).

Bug fixes:

• Add marshmallow_sqlalchemy.fields.Nested field that inherits its session from its schema. This fixes a bug where an exception was raised when using Nested within a ModelSchema (67). Thanks nickw444 for reporting and thanks samueljsb for the PR.

User code should be updated to use marshmallow-sqlalchemy's Nested instead of marshmallow.fields.Nested.

# Before
from marshmallow import fields
from marshmallow_sqlalchemy import ModelSchema


class ArtistSchema(ModelSchema):
    class Meta:
        model = models.Artist


class AlbumSchema(ModelSchema):
    class Meta:
        model = models.Album

    artist = fields.Nested(ArtistSchema)


# After
from marshmallow import fields
from marshmallow_sqlalchemy import ModelSchema
from marshmallow_sqlalchemy.fields import Nested


class ArtistSchema(ModelSchema):
    class Meta:
        model = models.Artist


class AlbumSchema(ModelSchema):
    class Meta:
        model = models.Album

    artist = Nested(ArtistSchema)

Features:

• Add support for postgresql.MONEY type (218). Thanks heckad for the PR.

Bug fixes:

• Compatibility with marshmallow 3.0.0rc7. Thanks heckad for the catch and patch.

Bug fixes:

• Compatibility with marshmallow 3.0.0rc6.

Bug fixes:

• Prevent ValueError when using the exclude class Meta option with TableSchema (202).

Bug fixes:

• Fix compatibility with SQLAlchemy 1.3 (185).

Features:

• Add support for deserializing transient objects (62). Thanks jacksmith15 for the PR.

Features:

• Add ModelConverter._should_exclude_field hook (139). Thanks jeanphix for the PR.

• Allow field kwargs to be overriden by passing info['marshmallow'] to column properties (21). Thanks dpwrussell for the suggestion and PR. Thanks jeanphix for the final implementation.

Bug fixes:

• Fix behavior of Related field (150). Thanks zezic for reporting and thanks AbdealiJK for the PR.

• Related now works with AssociationProxy fields (151). Thanks AbdealiJK for the catch and patch.

Other changes:

• Test against Python 3.7.

• Bring development environment in line with marshmallow.

Bug fixes:

• Fix behavior of exclude with marshmallow 3.0 (131). Thanks yaheath for reporting and thanks deckar01 for the fix.

Features:

• Make ModelSchema.session a property, which allows session to be retrieved from context (129). Thanks gtxm.

Other changes:

• Drop official support for Python 3.4. Python>=3.5 and Python 2.7 are supported.

Bug fixes:

• Unset instance attribute when an error occurs during a load call (114). Thanks vgavro for the catch and patch.

Bug fixes:

• Prevent unnecessary queries when using the fields.Related (106). Thanks xarg for reporting and thanks jmuhlich for the PR.

Features:

• Invalid inputs for compound primary keys raise a ValidationError when deserializing a scalar value (103). Thanks YuriHeupa for the PR.

Bug fixes:

• Fix compatibility with marshmallow>=3.x.

Bug fixes:

• Reset ModelSchema.instance after each load call, allowing schema instances to be reused (78). Thanks georgexsh for reporting.

Other changes:

• Test against Python 3.6.

Features:

• Add support for TypeDecorator-based types (83). Thanks frol.

Bug fixes:

• Fix bug that caused a validation errors for custom column types that have the python_type of uuid.UUID (54). Thanks wkevina and thanks kelvinhammond for the fix.

Other changes:

• Drop official support for Python 3.3. Python>=3.4 and Python 2.7 are supported.

Features:

• Allow overriding field class returned by field_for by adding the field_class param (81). Thanks cancan101.

Features:

• Support for SQLAlchemy JSON type (in SQLAlchemy>=1.1) (74). Thanks ewittle for the PR.

Features:

• Enable deserialization of many-to-one nested objects that do not exist in the database (69). Thanks seanharr11 for the PR.

Bug fixes:

• Depend on SQLAlchemy>=0.9.7, since marshmallow-sqlalchemy uses sqlalchemy.dialects.postgresql.JSONB (65). Thanks alejom99 for reporting.

Bug fixes:

• ModelSchema and TableSchema respect field order if the ordered=True class Meta option is set (52). Thanks jeffwidman for reporting and jmcarp for the patch.

• Declared fields are not introspected in order to support, e.g. column_property (57). Thanks jmcarp.

Features:

• ModelSchema and TableSchema will respect the TYPE_MAPPING class variable of Schema subclasses when converting Columns to Fields (42). Thanks dwieeb for the suggestion.

Bug fixes:

• Don't make marshmallow fields required for non-nullable columns if a column has a default value or autoincrements (47). Thanks jmcarp for the fix. Thanks AdrielVelazquez for reporting.

Features:

• Add include_fk class Meta option (36). Thanks jmcarp.

• Non-nullable columns will generated required marshmallow Fields (40). Thanks jmcarp.

• Improve support for MySQL BIT field (41). Thanks rudaporto.

• Backwards-incompatible: Remove fields.get_primary_columns in favor of fields.get_primary_keys.

• Backwards-incompatible: Remove Related.related_columns in favor of fields.related_keys.

Bug fixes:

• Fix serializing relationships when using non-default column names (44). Thanks jmcarp for the fix. Thanks repole for the bug report.

Features:

• Support for compound primary keys. Thanks jmcarp.

Other changes:

• Supports marshmallow>=2.0.0.

• Add instance argument to ModelSchema constructor and ModelSchema.load which allows for updating existing DB rows (26). Thanks sssilver for reporting and jmcarp for the patch.

• Don't autogenerate fields that are in Meta.exclude (27). Thanks jmcarp.

• Raise ModelConversionError if converting properties whose column don't define a python_type. Thanks jmcarp.

• Backwards-incompatible: ModelSchema.make_object is removed in favor of decorated make_instance method for compatibility with marshmallow>=2.0.0rc2.

Bug fixes:

• Now compatible with marshmallow>=2.0.0rc1.

• Correctly pass keyword arguments from field_for to generated List fields (25). Thanks sssilver for reporting.

Features:

• Add TableSchema for generating Schemas from tables (4). Thanks jmcarp.

Bug fixes:

• Allow session to be passed to ModelSchema.validate, since it requires it. Thanks dpwrussell.

• When serializing, don't skip overriden fields that are part of a polymorphic hierarchy (18). Thanks again dpwrussell.

Support:

• Docs: Add new recipe for automatic generation of schemas. Thanks dpwrussell.