Marshmallow-sqlalchemy

++++++++++++++++++

Bug fixes:

* Fix handling of arrays of enums and multidimensional arrays (:issue:`653`).
Thanks :user:`carterjc` for reporting and investigating the fix.
* Fix handling of `sqlalchemy.PickleType` columns (:issue:`394`)
Thanks :user:`Eyon42` for reporting.

Other changes:

* Passing arbitrary keyword arguments to `auto_field <marshmallow_sqlalchemy.auto_field>`
is no longer supported (:pr:`647`). Use the ``metadata`` argument to pass metadata
to the generated field instead.

.. code-block:: python

Before
auto_field(description="The name of the artist")
On marshmallow 3, this raises a warning: "RemovedInMarshmallow4Warning: Passing field metadata as keyword arguments is deprecated."
On marshmallow 4, this raises an error: "TypeError: Field.__init__() got an unexpected keyword argument 'description'"

After
auto_field(metadata=dict(description="The name of the artist"))

++++++++++++++++++

Features:

* Typing: Add type annotations to `fields <marshmallow_sqlalchemy.fields>`.

Bug fixes:

* Fix auto-generation of `marshmallow.fields.Enum` field from `sqlalchemy.Enum` columns (:issue:`615`).
Thanks :user:`joaquimvl` for reporting.
* Fix behavior of ``include_fk = False`` in options when parent
schema sets ``include_fk = True`` (:issue:`440`).
Thanks :user:`uhnomoli` for reporting.
* Fields generated from non-nullable `sqlalchemy.orm.relationship`
correctly set ``required=True`` and ``allow_none=False`` (:issue:`336`, :issue:`163`).
Thanks :user:`AbdealiLoKo` for reporting.

Other changes:

* Docs: Add more documentation for `marshmallow_sqlalchemy.fields.Related` (:issue:`162`).
Thanks :user:`GabrielC101` for the suggestion.
* Docs: Document methods of `SQLAlchemySchema <marshmallow_sqalalchemy.SQLAlchemySchema>`
and `SQLAlchemyAutoSchema <marshmallow_sqalchemy.SQLAlchemyAutoSchema>` (:issue:`619`).
* Docs: Various documentation improvements (:pr:`635`, :pr:`636`, :pr:`639`, :pr:`641`, :pr:`642`).

++++++++++++++++++

Features:

* Typing: Improve type coverage (:pr:`631`, :pr:`632`, :pr:`634`).

Other changes:

* Drop support for Python 3.8, which is EOL. Support Python 3.9-3.13.

++++++++++++++++++

Bug fixes:

* Fix compatibility with marshmallow 3.24.0 and 4.0.0 (:pr:`628`).

Other changes:

* Test against Python 3.13 (:issue:`629`).

++++++++++++++++++

Features:

* ``sqlalchemy.Enum`` fields generate a corresponding ``marshmallow.fields.Enum`` field (:issue:`485`, :issue:`112`).
Thanks :user:`panda-byte` for the PR.

Support:

* Drop support for marshmallow<3.18.0.

+++++++++++++++++++

* Remove ``__version__`` attribute. Use feature detection or
``importlib.metadata.version("marshmallow-sqlalchemy")`` instead (:pr:`568`).
* Support marshmallow>=3.10.0 (:pr:`566`).
* Passing `info={"marshmallow": ...}` to SQLAlchemy columns is removed, as it is redundant with
the ``auto_field`` functionality (:pr:`567`).
* Remove ``packaging`` as a dependency (:pr:`566`).
* Support Python 3.12.