flask-marshmallow 1.2.0__py3-none-any.whl → 1.3.0__py3-none-any.whl

flask_marshmallow/__init__.py

@@ -1,14 +1,23 @@
 """
-    flask_marshmallow
-    ~~~~~~~~~~~~~~~~~
+flask_marshmallow
+~~~~~~~~~~~~~~~~~
 
-    Integrates the marshmallow serialization/deserialization library
-    with your Flask application.
+Integrates the marshmallow serialization/deserialization library
+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
@@ -40,8 +49,9 @@ __all__ = [
     "Schema",
     "fields",
     "exceptions",
-    "pprint",
 ]
+if _has_pprint:
+    __all__.append("pprint")
 
 EXTENSION_NAME = "flask-marshmallow"
 
@@ -74,15 +84,16 @@ 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({
-                'self': ma.URLFor('book_detail', values=dict(id='<id>')),
-                'collection': ma.URLFor('book_list')
-            })
+            links = ma.Hyperlinks(
+                {
+                    "self": ma.URLFor("book_detail", values=dict(id="<id>")),
+                    "collection": ma.URLFor("book_list"),
+                }
+            )
 
 
     In order to integrate with Flask-SQLAlchemy, this extension must be initialized

flask_marshmallow/fields.py

@@ -1,14 +1,18 @@
 """
-    flask_marshmallow.fields
-    ~~~~~~~~~~~~~~~~~~~~~~~~
+flask_marshmallow.fields
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-    Custom, Flask-specific fields.
+Custom, Flask-specific fields.
 
-    See the `marshmallow.fields` module for the list of all fields available from the
-    marshmallow library.
+See the `marshmallow.fields` module for the list of all fields available from the
+marshmallow library.
 """
+
+from __future__ import annotations
+
 import re
 import typing
+from collections.abc import Sequence
 
 from flask import current_app, url_for
 from marshmallow import fields, missing
@@ -27,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:
@@ -75,10 +79,10 @@ class URLFor(fields.Field):
 
     Usage: ::
 
-        url = URLFor('author_get', values=dict(id='<id>'))
+        url = URLFor("author_get", values=dict(id="<id>"))
         https_url = URLFor(
-            'author_get',
-            values=dict(id='<id>', _scheme='https', _external=True),
+            "author_get",
+            values=dict(id="<id>", _scheme="https", _external=True),
         )
 
     :param str endpoint: Flask endpoint name.
@@ -93,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
@@ -131,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:
@@ -144,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.
     """
@@ -175,19 +177,23 @@ class Hyperlinks(fields.Field):
 
     Example: ::
 
-        _links = Hyperlinks({
-            'self': URLFor('author', values=dict(id='<id>')),
-            'collection': URLFor('author_list'),
-        })
+        _links = Hyperlinks(
+            {
+                "self": URLFor("author", values=dict(id="<id>")),
+                "collection": URLFor("author_list"),
+            }
+        )
 
     `URLFor` objects can be nested within the dictionary. ::
 
-        _links = Hyperlinks({
-            'self': {
-                'href': URLFor('book', values=dict(id='<id>')),
-                'title': 'book detail'
+        _links = Hyperlinks(
+            {
+                "self": {
+                    "href": URLFor("book", values=dict(id="<id>")),
+                    "title": "book detail",
+                }
             }
-        })
+        )
 
     :param dict schema: A dict that maps names to
         :class:`~flask_marshmallow.fields.URLFor` fields.
@@ -195,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)
 
@@ -220,6 +226,17 @@ class File(fields.Field):
 
     default_error_messages = {"invalid": "Not a valid file."}
 
+    def deserialize(
+        self,
+        value: typing.Any,
+        attr: str | None = None,
+        data: typing.Mapping[str, typing.Any] | None = None,
+        **kwargs,
+    ):
+        if isinstance(value, Sequence) and len(value) == 0:
+            value = missing
+        return super().deserialize(value, attr, data, **kwargs)
+
     def _deserialize(self, value, attr, data, **kwargs):
         from werkzeug.datastructures import FileStorage
 
@@ -236,11 +253,12 @@ class Config(fields.Field):
         from flask import Flask
 
         app = Flask(__name__)
-        app.config['API_TITLE'] = 'Pet API'
+        app.config["API_TITLE"] = "Pet API"
+
 
         class FooSchema(Schema):
             user = String()
-            title = Config('API_TITLE')
+            title = Config("API_TITLE")
 
     This field should only be used in an output schema. A ``ValueError`` will
     be raised if the config key is not found in the app config.

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

@@ -1,12 +1,15 @@
 """
-    flask_marshmallow.sqla
-    ~~~~~~~~~~~~~~~~~~~~~~
+flask_marshmallow.sqla
+~~~~~~~~~~~~~~~~~~~~~~
 
-    Integration with Flask-SQLAlchemy and marshmallow-sqlalchemy. Provides
-    `SQLAlchemySchema <marshmallow_sqlalchemy.SQLAlchemySchema>` and
-    `SQLAlchemyAutoSchema <marshmallow_sqlalchemy.SQLAlchemyAutoSchema>` classes
-    that use the scoped session from Flask-SQLAlchemy.
+Integration with Flask-SQLAlchemy and marshmallow-sqlalchemy. Provides
+`SQLAlchemySchema <marshmallow_sqlalchemy.SQLAlchemySchema>` and
+`SQLAlchemyAutoSchema <marshmallow_sqlalchemy.SQLAlchemyAutoSchema>` classes
+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

@@ -1,12 +1,17 @@
 """
-    flask_marshmallow.validate
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~
+flask_marshmallow.validate
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    Custom validation classes for various types of data.
+Custom validation classes for various types of data.
 """
+
+from __future__ import annotations
+
+import io
 import os
 import re
 import typing
+from tempfile import SpooledTemporaryFile
 
 from marshmallow.exceptions import ValidationError
 from marshmallow.validate import Validator as Validator
@@ -15,7 +20,15 @@ from werkzeug.datastructures import FileStorage
 
 def _get_filestorage_size(file: FileStorage) -> int:
     """Return the size of the FileStorage object in bytes."""
-    size: int = file.stream.getbuffer().nbytes  # type: ignore
+    stream = file.stream
+    if isinstance(stream, io.BytesIO):
+        return stream.getbuffer().nbytes
+
+    if isinstance(stream, SpooledTemporaryFile):
+        return os.stat(stream.fileno()).st_size
+
+    size = len(file.read())
+    file.stream.seek(0)
     return size
 
 
@@ -57,7 +70,7 @@ class FileSize(Validator):
     Example: ::
 
         class ImageSchema(Schema):
-            image = File(required=True, validate=FileSize(min='1 MiB', max='2 MiB'))
+            image = File(required=True, validate=FileSize(min="1 MiB", max="2 MiB"))
 
     :param min: The minimum size (lower bound). If not provided, minimum
         size will not be checked.
@@ -80,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
@@ -106,8 +119,10 @@ class FileSize(Validator):
         )
 
     def _repr_args(self):
-        return "min={!r}, max={!r}, min_inclusive={!r}, max_inclusive={!r}".format(
-            self.min, self.max, self.min_inclusive, self.max_inclusive
+        return (
+            f"min={self.min!r}, max={self.max!r}, "
+            f"min_inclusive={self.min_inclusive!r}, "
+            f"max_inclusive={self.max_inclusive!r}"
         )
 
     def _format_error(self, value, message):
@@ -141,11 +156,12 @@ class FileSize(Validator):
 
 class FileType(Validator):
     """Validator which succeeds if the uploaded file is allowed by a given list
-        of extensions.
+    of extensions.
 
     Example: ::
+
         class ImageSchema(Schema):
-            image = File(required=True, validate=FileType(['.png']))
+            image = File(required=True, validate=FileType([".png"]))
 
     :param accept: A sequence of allowed extensions.
     :param error: Error message to raise in case of a validation error.
@@ -157,7 +173,7 @@ 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

{flask_marshmallow-1.2.0.dist-info → flask_marshmallow-1.3.0.dist-info}/METADATA

@@ -1,29 +1,29 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: flask-marshmallow
-Version: 1.2.0
+Version: 1.3.0
 Summary: Flask + marshmallow for beautiful APIs
 Maintainer-email: Steven Loria <sloria1@gmail.com>, Stephen Rosen <sirosen0@gmail.com>
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 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: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 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>=3.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==8.1.3 ; extra == "docs"
+Requires-Dist: sphinx-issues==5.0.0 ; 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 +39,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 +82,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 +163,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.3.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+flask_marshmallow/__init__.py,sha256=koKpA3E3MtgQ8SomgVv0pVHoYkgPDqVoFbEby4Dswd0,3871
+flask_marshmallow/fields.py,sha256=gKFJuIpo6jYCBe3WpeDrvhP1EUozakx3WXYisQGubf0,7869
+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=MNFcCBHwSEkfZGadr7WvwG6dF4aQ1s6yWYhxIk2JmWc,6812
+flask_marshmallow-1.3.0.dist-info/LICENSE,sha256=kGtdkFHkJhRMsXOtkRZnuOvQWpxYTCwmwTWzKj7RIAE,1064
+flask_marshmallow-1.3.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+flask_marshmallow-1.3.0.dist-info/METADATA,sha256=R-Z0GAkzvbVQyAeS105faz5qmyYt1F_3CotHUwEdR6k,5177
+flask_marshmallow-1.3.0.dist-info/RECORD,,

{flask_marshmallow-1.2.0.dist-info → flask_marshmallow-1.3.0.dist-info}/WHEEL

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

flask_marshmallow-1.2.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-flask_marshmallow/__init__.py,sha256=2s46vkrP0wX1wXBT0OF9oTUNIaoX5-uu_AogfhGXupg,3650
-flask_marshmallow/fields.py,sha256=0_mk3dKpyDKT66Tp4KoDZ0uNCxmvGVH3Rk4OAwjR8f4,7486
-flask_marshmallow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-flask_marshmallow/schema.py,sha256=Z6uJVkqi-gq1QfdPbPuy5Fw3UnXGE9vKiD6IJkPOMR4,1412
-flask_marshmallow/sqla.py,sha256=QKEpKDfrBJ5m1KpnRuEB5Txfxql-aN_pyHznYxzNd6Y,3971
-flask_marshmallow/validate.py,sha256=cJDooGyaEqhTmnIBEpOKAR8Y-WzPcNdvtDcAZUCI030,6565
-flask_marshmallow-1.2.0.dist-info/LICENSE,sha256=kGtdkFHkJhRMsXOtkRZnuOvQWpxYTCwmwTWzKj7RIAE,1064
-flask_marshmallow-1.2.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-flask_marshmallow-1.2.0.dist-info/METADATA,sha256=SnUTf1VP6m6L83PHJK6QZ6tbsQwuCP4yAAvLwqPdMf0,5190
-flask_marshmallow-1.2.0.dist-info/RECORD,,