Support Python 3.9-3.13 and marshmallow 4 (#347)

* Drop Python 3.8 and support 3.13

* Support marshmallow 4.0

* Update tox config

* Update annotations

* Attempt to fix test on GHA

* Update changelog

* Update doc

.github/workflows/build-release.yml

@@ -13,10 +13,10 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - { name: "3.8", python: "3.8", tox: py38 }
-          - { name: "3.12", python: "3.12", tox: py312 }
-          - { name: "lowest", python: "3.8", tox: py38-lowest }
-          - { name: "dev", python: "3.12", tox: py312-marshmallowdev }
+          - { name: "3.9", python: "3.9", tox: py39 }
+          - { name: "3.13", python: "3.13", tox: py313 }
+          - { name: "lowest", python: "3.9", tox: py39-lowest }
+          - { name: "dev", python: "3.13", tox: py313-marshmallowdev }
     steps:
       - uses: actions/[email protected]
       - uses: actions/setup-python@v5
@@ -31,7 +31,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
+          python-version: "3.13"
       - name: Install pypa/build
         run: python -m pip install build
       - name: Build a binary wheel and a source tarball
@@ -54,7 +54,7 @@ jobs:
       - uses: actions/[email protected]
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
+          python-version: "3.13"
       - run: python -m pip install tox
       - run: python -m tox -elint
   publish-to-pypi:

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
   rev: 1.19.1
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==23.12.1]
+    additional_dependencies: [black==24.10.0]
 - repo: https://github.com/pre-commit/mirrors-mypy
   rev: v1.13.0
   hooks:

.readthedocs.yml

@@ -6,7 +6,7 @@ formats:
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.13"
 python:
   install:
     - method: pip

CHANGELOG.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+1.3.0 (unreleased)
+******************
+
+Support:
+
+* Support Python 3.9-3.13 (:pr:`347`).
+* Support marshmallow 4.0.0 (:pr:`347`).
+
 1.2.1 (2024-03-18)
 ******************
 

README.rst

@@ -2,7 +2,7 @@
 Flask-Marshmallow
 *****************
 
-|pypi-package| |build-status| |docs| |marshmallow3|
+|pypi-package| |build-status| |docs| |marshmallow-support|
 
 Flask + marshmallow for beautiful APIs
 ======================================
@@ -45,9 +45,8 @@ Define your output format with marshmallow.
 
 
     class UserSchema(ma.Schema):
-        class Meta:
-            # Fields to expose
-            fields = ("email", "date_created", "_links")
+        email = ma.Email()
+        date_created = ma.DateTime()
 
         # Smart hyperlinking
         _links = ma.Hyperlinks(
@@ -127,6 +126,6 @@ MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/flas
    :target: https://flask-marshmallow.readthedocs.io/
    :alt: Documentation
 
-.. |marshmallow3| image:: https://badgen.net/badge/marshmallow/3
+.. |marshmallow-support| image:: https://badgen.net/badge/marshmallow/3,4?list=1
     :target: https://marshmallow.readthedocs.io/en/latest/upgrading.html
-    :alt: marshmallow 3 compatible
+    :alt: marshmallow 3|4 compatible

docs/index.rst

@@ -49,9 +49,8 @@ Define your output format with marshmallow.
 
 
     class UserSchema(ma.Schema):
-        class Meta:
-            # Fields to expose
-            fields = ("email", "date_created", "_links")
+        email = ma.Email()
+        date_created = ma.DateTime()
 
         # Smart hyperlinking
         _links = ma.Hyperlinks(

pyproject.toml

@@ -14,14 +14,14 @@ classifiers = [
   "License :: OSI Approved :: MIT License",
   "Natural Language :: English",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 dependencies = ["Flask>=2.2", "marshmallow>=3.0.0"]
 
 [project.urls]

src/flask_marshmallow/__init__.py

@@ -9,7 +9,15 @@
 import typing
 import warnings
 
-from marshmallow import exceptions, pprint
+from marshmallow import exceptions
+
+try:
+    # Available in marshmallow 3 only
+    from marshmallow import pprint  # noqa: F401
+except ImportError:
+    _has_pprint = False
+else:
+    _has_pprint = True
 from marshmallow import fields as base_fields
 
 from . import fields
@@ -41,8 +49,9 @@
     "Schema",
     "fields",
     "exceptions",
-    "pprint",
 ]
+if _has_pprint:
+    __all__.append("pprint")
 
 EXTENSION_NAME = "flask-marshmallow"
 
@@ -75,9 +84,8 @@ class Marshmallow:
     You can declare schema like so::
 
         class BookSchema(ma.Schema):
-            class Meta:
-                fields = ("id", "title", "author", "links")
-
+            id = ma.Integer(dump_only=True)
+            title = ma.String(required=True)
             author = ma.Nested(AuthorSchema)
 
             links = ma.Hyperlinks(

src/flask_marshmallow/fields.py

@@ -8,6 +8,8 @@
 marshmallow library.
 """
 
+from __future__ import annotations
+
 import re
 import typing
 from collections.abc import Sequence
@@ -29,7 +31,7 @@
 _tpl_pattern = re.compile(r"\s*<\s*(\S*)\s*>\s*")
 
 
-def _tpl(val: str) -> typing.Optional[str]:
+def _tpl(val: str) -> str | None:
     """Return value within ``< >`` if possible, else return ``None``."""
     match = _tpl_pattern.match(val)
     if match:
@@ -95,7 +97,7 @@ class URLFor(fields.Field):
     def __init__(
         self,
         endpoint: str,
-        values: typing.Optional[typing.Dict[str, typing.Any]] = None,
+        values: dict[str, typing.Any] | None = None,
         **kwargs,
     ):
         self.endpoint = endpoint
@@ -133,7 +135,7 @@ class AbsoluteURLFor(URLFor):
     def __init__(
         self,
         endpoint: str,
-        values: typing.Optional[typing.Dict[str, typing.Any]] = None,
+        values: dict[str, typing.Any] | None = None,
         **kwargs,
     ):
         if values:
@@ -146,9 +148,7 @@ def __init__(
 AbsoluteUrlFor = AbsoluteURLFor
 
 
-def _rapply(
-    d: typing.Union[dict, typing.Iterable], func: typing.Callable, *args, **kwargs
-):
+def _rapply(d: dict | typing.Iterable, func: typing.Callable, *args, **kwargs):
     """Apply a function to all values in a dictionary or
     list of dictionaries, recursively.
     """
@@ -201,7 +201,7 @@ class Hyperlinks(fields.Field):
 
     _CHECK_ATTRIBUTE = False
 
-    def __init__(self, schema: typing.Dict[str, typing.Union[URLFor, str]], **kwargs):
+    def __init__(self, schema: dict[str, URLFor | str], **kwargs):
         self.schema = schema
         fields.Field.__init__(self, **kwargs)
 
@@ -229,8 +229,8 @@ def __init__(self, *args, **kwargs):
     def deserialize(
         self,
         value: typing.Any,
-        attr: typing.Optional[str] = None,
-        data: typing.Optional[typing.Mapping[str, typing.Any]] = None,
+        attr: str | None = None,
+        data: typing.Mapping[str, typing.Any] | None = None,
         **kwargs,
     ):
         if isinstance(value, Sequence) and len(value) == 0:

src/flask_marshmallow/schema.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import typing
 
 import flask
@@ -14,8 +16,8 @@ class Schema(ma.Schema):
     """
 
     def jsonify(
-        self, obj: typing.Any, many: typing.Optional[bool] = None, *args, **kwargs
-    ) -> "Response":
+        self, obj: typing.Any, many: bool | None = None, *args, **kwargs
+    ) -> Response:
         """Return a JSON response containing the serialized data.
 
 

src/flask_marshmallow/sqla.py

@@ -8,6 +8,8 @@
 that use the scoped session from Flask-SQLAlchemy.
 """
 
+from __future__ import annotations
+
 from urllib import parse
 
 import marshmallow_sqlalchemy as msqla

src/flask_marshmallow/validate.py

@@ -5,6 +5,8 @@
 Custom validation classes for various types of data.
 """
 
+from __future__ import annotations
+
 import io
 import os
 import re
@@ -91,11 +93,11 @@ class ImageSchema(Schema):
 
     def __init__(
         self,
-        min: typing.Optional[str] = None,
-        max: typing.Optional[str] = None,
+        min: str | None = None,
+        max: str | None = None,
         min_inclusive: bool = True,
         max_inclusive: bool = True,
-        error: typing.Optional[str] = None,
+        error: str | None = None,
     ):
         self.min = min
         self.max = max
@@ -171,7 +173,7 @@ class ImageSchema(Schema):
     def __init__(
         self,
         accept: typing.Iterable[str],
-        error: typing.Optional[str] = None,
+        error: str | None = None,
     ):
         self.allowed_types = {ext.lower() for ext in accept}
         self.error = error or self.default_message

tests/conftest.py

@@ -84,9 +84,8 @@ def ma(app):
 @pytest.fixture
 def schemas(ma):
     class AuthorSchema(ma.Schema):
-        class Meta:
-            fields = ("id", "name", "absolute_url", "links")
-
+        id = ma.Integer()
+        name = ma.String()
         absolute_url = ma.AbsoluteURLFor("author", values={"id": "<id>"})
 
         links = ma.Hyperlinks(
@@ -97,9 +96,8 @@ class Meta:
         )
 
     class BookSchema(ma.Schema):
-        class Meta:
-            fields = ("id", "title", "author", "links")
-
+        id = ma.Integer()
+        title = ma.String()
         author = ma.Nested(AuthorSchema)
 
         links = ma.Hyperlinks(

tests/test_sqla.py

@@ -48,7 +48,10 @@ def book(id):
 
     @pytest.fixture
     def db(self, extapp):
-        return extapp.extensions["sqlalchemy"]
+        db = extapp.extensions["sqlalchemy"]
+        yield db
+        db.session.close()
+        db.engine.dispose()
 
     @pytest.fixture
     def extma(self, extapp):

tox.ini

@@ -1,9 +1,9 @@
 [tox]
 envlist=
     lint
-    py{38,39,310,311,312}
-    py312-marshmallowdev
-    py38-lowest
+    py{39,310,311,312,313}
+    py313-marshmallowdev
+    py39-lowest
     docs
 
 [testenv]