flask-marshmallow 1.2.1__py3-none-any.whl → 1.4.0__py3-none-any.whl

flask_marshmallow/__init__.py

@@ -9,7 +9,15 @@ with your Flask application.
 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 @@ __all__ = [
     "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(
@@ -126,6 +134,12 @@ class Marshmallow:
         # If using Flask-SQLAlchemy, attach db.session to SQLAlchemySchema
         if has_sqla and "sqlalchemy" in app.extensions:
             db = app.extensions["sqlalchemy"]
-            self.SQLAlchemySchema.OPTIONS_CLASS.session = db.session
-            self.SQLAlchemyAutoSchema.OPTIONS_CLASS.session = db.session
+            SQLAlchemySchemaOpts = typing.cast(
+                sqla.SQLAlchemySchemaOpts, self.SQLAlchemySchema.OPTIONS_CLASS
+            )
+            SQLAlchemySchemaOpts.session = db.session
+            SQLAlchemyAutoSchemaOpts = typing.cast(
+                sqla.SQLAlchemyAutoSchemaOpts, self.SQLAlchemySchema.OPTIONS_CLASS
+            )
+            SQLAlchemyAutoSchemaOpts.session = db.session
         app.extensions[EXTENSION_NAME] = self

flask_marshmallow/fields.py

@@ -8,6 +8,8 @@ See the `marshmallow.fields` module for the list of all fields available from th
 marshmallow library.
 """
 
+from __future__ import annotations
+
 import re
 import typing
 from collections.abc import Sequence
@@ -29,7 +31,7 @@ __all__ = [
 _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
@@ -117,7 +119,7 @@ class URLFor(fields.Field):
                     param_values[name] = attribute_value
                 else:
                     raise AttributeError(
-                        f"{attr_name!r} is not a valid " f"attribute of {obj!r}"
+                        f"{attr_name!r} is not a valid attribute of {obj!r}"
                     )
             else:
                 param_values[name] = attr_tpl
@@ -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 @@ class AbsoluteURLFor(URLFor):
 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 @@ class File(fields.Field):
     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:

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.
 
 

flask_marshmallow/sqla.py

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

flask_marshmallow/validate.py

@@ -5,6 +5,8 @@ flask_marshmallow.validate
 Custom validation classes for various types of data.
 """
 
+from __future__ import annotations
+
 import io
 import os
 import re
@@ -91,11 +93,11 @@ class FileSize(Validator):
 
     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,14 +173,14 @@ class FileType(Validator):
     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
 
     def _format_error(self, value):
         return (self.error or self.default_message).format(
-            input=value, extensions="".join(self.allowed_types)
+            input=value, extensions=",".join(self.allowed_types)
         )
 
     def __call__(self, value):

{flask_marshmallow-1.2.1.dist-info → flask_marshmallow-1.4.0.dist-info}/METADATA

@@ -1,29 +1,30 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: flask-marshmallow
-Version: 1.2.1
+Version: 1.4.0
 Summary: Flask + marshmallow for beautiful APIs
-Maintainer-email: Steven Loria <sloria1@gmail.com>, Stephen Rosen <sirosen0@gmail.com>
-Requires-Python: >=3.8
+Maintainer-email: Steven Loria <oss@stevenloria.com>, Stephen Rosen <sirosen0@gmail.com>
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+License-File: LICENSE
 Requires-Dist: Flask>=2.2
 Requires-Dist: marshmallow>=3.0.0
 Requires-Dist: flask-marshmallow[tests] ; extra == "dev"
 Requires-Dist: tox ; extra == "dev"
-Requires-Dist: pre-commit~=3.5 ; extra == "dev"
+Requires-Dist: pre-commit>=4.5,<5.0 ; extra == "dev"
 Requires-Dist: marshmallow-sqlalchemy>=0.19.0 ; extra == "docs"
-Requires-Dist: Sphinx==7.2.6 ; extra == "docs"
-Requires-Dist: sphinx-issues==4.0.0 ; extra == "docs"
+Requires-Dist: Sphinx==9.1.0 ; extra == "docs"
+Requires-Dist: sphinx-issues==5.0.1 ; extra == "docs"
 Requires-Dist: flask-sqlalchemy>=3.0.0 ; extra == "sqlalchemy"
 Requires-Dist: marshmallow-sqlalchemy>=0.29.0 ; extra == "sqlalchemy"
 Requires-Dist: flask-marshmallow[sqlalchemy] ; extra == "tests"
@@ -39,7 +40,7 @@ Provides-Extra: tests
 Flask-Marshmallow
 *****************
 
-|pypi-package| |build-status| |docs| |marshmallow3|
+|pypi-package| |build-status| |docs| |marshmallow-support|
 
 Flask + marshmallow for beautiful APIs
 ======================================
@@ -82,9 +83,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(
@@ -164,7 +164,7 @@ 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
 

flask_marshmallow-1.4.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+flask_marshmallow/__init__.py,sha256=z1T-yR1vgxKgU_QtdJmJgkJEFgKInIn1piaaOfb9ndw,4131
+flask_marshmallow/fields.py,sha256=_aDs2dWM5CV2xigge_b4Qoz7LGam5gJoTLPlG0frD50,7865
+flask_marshmallow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flask_marshmallow/schema.py,sha256=qC6jF_peb8WvQAJpe14MQaLmqRahAReoP7GKcC4nNfI,1436
+flask_marshmallow/sqla.py,sha256=RXiV5EZwg8g3XWN5ZsqOK3xrhmZ5FlgeVmzwDExC1LU,3984
+flask_marshmallow/validate.py,sha256=cUsavS9Hsdb9yQ_WKvswbVjEMfD92GGDVm7yfmU-4W4,6813
+flask_marshmallow-1.4.0.dist-info/licenses/LICENSE,sha256=kGtdkFHkJhRMsXOtkRZnuOvQWpxYTCwmwTWzKj7RIAE,1064
+flask_marshmallow-1.4.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+flask_marshmallow-1.4.0.dist-info/METADATA,sha256=92zlOeitEYTujBPEvK1HxRMYXMsqEYDmsdOS1CDLdzE,5203
+flask_marshmallow-1.4.0.dist-info/RECORD,,

{flask_marshmallow-1.2.1.dist-info → flask_marshmallow-1.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: flit 3.9.0
+Generator: flit 3.12.0
 Root-Is-Purelib: true
 Tag: py3-none-any

flask_marshmallow-1.2.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-flask_marshmallow/__init__.py,sha256=IsYMbL7JZL1yc1P0EKVfpxokIMlnKKVNMcSwhHfu29w,3678
-flask_marshmallow/fields.py,sha256=Z-v60FhOe-HlupA_tGhZMtS4p4b9i4LFbTbCgDCQ5-4,7936
-flask_marshmallow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-flask_marshmallow/schema.py,sha256=Z6uJVkqi-gq1QfdPbPuy5Fw3UnXGE9vKiD6IJkPOMR4,1412
-flask_marshmallow/sqla.py,sha256=VN4aH5pm1HvyepeV6AHtipTAK_Mz_zLA-0IulsObhCk,3948
-flask_marshmallow/validate.py,sha256=KRJus6GpPC7MZGFjDidhnNjI3tc6_y9PPQ-Pcmik18I,6816
-flask_marshmallow-1.2.1.dist-info/LICENSE,sha256=kGtdkFHkJhRMsXOtkRZnuOvQWpxYTCwmwTWzKj7RIAE,1064
-flask_marshmallow-1.2.1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-flask_marshmallow-1.2.1.dist-info/METADATA,sha256=E5EDVQ1awnti6hs2oQPuBu1B5xAV19cfvW6kiUqbXH8,5190
-flask_marshmallow-1.2.1.dist-info/RECORD,,