flask-marshmallow 0.15.0__tar.gz → 1.0.0__tar.gz

{flask-marshmallow-0.15.0 → flask_marshmallow-1.0.0}/CHANGELOG.rst

@@ -1,12 +1,39 @@
 Changelog
 =========
 
+1.0.0 (2024-01-16)
+******************
+
+Features:
+
+* Add field ``fields.File``, ``validate.FileType``, and ``validate.FileSize`` 
+  for deserializing uploaded files (:issue:`280`, :pr:`282`).
+  Thanks :user:`uncle-lv` for the PR
+* Add field ``Config`` for serializing Flask configuration values (:issue:`280`, :pr:`281`).
+  Thanks :user:`greyli` for the PR.
+
+Support:
+
+* Support marshmallow-sqlalchemy>=0.29.0.
+* Test against Python 3.12.
+* Drop support for Python 3.7.
+
+Other changes:
+
+* *Backwards-incompatible*: Remove ```flask_marshmallow.__version__`` 
+  and ``flask_marshmallow.__version_info__`` attributes (:pr:`284`). 
+  Use feature detection or ``importlib.metadata.version("flask-marshmallow")`` instead.
+
 0.15.0 (2023-04-05)
 *******************
 
-* Only support Python>=3.6, marshmallow>=3.0.0, and
-  marshmallow-sqlalchemy>=0.28.2
-* Add support for python3.11
+* Changes to supported software versions.
+
+  * python3.6 or later and marshmallow>=3.0.0 are now required
+  * Add support for python3.11
+  * For ``sqlalchemy`` integration, marshmallow-sqlalchemy>=0.28.2 and
+    flask-sqlalchemy>=3.0.0 are now required
+
 * *Backwards-incompatible*: ``URLFor`` and ``AbsoluteURLFor`` now do not accept
   parameters for ``flask.url_for`` as top-level parameters. They must always be
   passed in the ``values`` dictionary, as explained in the v0.14.0 changelog.
@@ -20,8 +47,8 @@ Bug fixes:
 *******************
 
 * Add ``values`` argument to ``URLFor`` and ``AbsoluteURLFor`` for passing values to ``flask.url_for``.
- This prevents unrelated parameters from getting passed (:issue:`52`, :issue:`67`).
- Thanks :user:`AlrasheedA` for the PR.
+  This prevents unrelated parameters from getting passed (:issue:`52`, :issue:`67`).
+  Thanks :user:`AlrasheedA` for the PR.
 
 Deprecation:
 

{flask-marshmallow-0.15.0/src/flask_marshmallow.egg-info → flask_marshmallow-1.0.0}/PKG-INFO

@@ -1,38 +1,46 @@
 Metadata-Version: 2.1
 Name: flask-marshmallow
-Version: 0.15.0
+Version: 1.0.0
 Summary: Flask + marshmallow for beautiful APIs
-Home-page: https://github.com/marshmallow-code/flask-marshmallow
-Author: Steven Loria
-Author-email: sloria1@gmail.com
-License: MIT
-Project-URL: Issues, https://github.com/marshmallow-code/flask-marshmallow/issues
-Project-URL: Funding, https://opencollective.com/marshmallow
-Keywords: flask-marshmallow
-Classifier: Development Status :: 4 - Beta
+Maintainer-email: Steven Loria <sloria1@gmail.com>
+Requires-Python: >=3.8
+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.7
 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: Topic :: Internet :: WWW/HTTP :: Dynamic Content
-Requires-Python: >=3.7
-Provides-Extra: sqlalchemy
+Requires-Dist: Flask
+Requires-Dist: marshmallow>=3.0.0
+Requires-Dist: packaging>=17.0
+Requires-Dist: flask-marshmallow[tests] ; extra == "dev"
+Requires-Dist: tox ; extra == "dev"
+Requires-Dist: pre-commit~=3.5 ; extra == "dev"
+Requires-Dist: marshmallow-sqlalchemy>=0.19.0 ; extra == "docs"
+Requires-Dist: Sphinx==7.2.6 ; extra == "docs"
+Requires-Dist: sphinx-issues==3.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"
+Requires-Dist: pytest ; extra == "tests"
+Project-URL: Funding, https://opencollective.com/marshmallow
+Project-URL: Issues, https://github.com/marshmallow-code/flask-marshmallow/issues
+Provides-Extra: dev
 Provides-Extra: docs
+Provides-Extra: sqlalchemy
 Provides-Extra: tests
-Provides-Extra: dev
-License-File: LICENSE
 
 *****************
 Flask-Marshmallow
 *****************
 
-|pypi-package| |build-status| |docs| |marshmallow3| |black|
+|pypi-package| |build-status| |docs| |marshmallow3|
 
 Flask + marshmallow for beautiful APIs
 ======================================
@@ -133,7 +141,7 @@ Project Links
 
 - Docs: https://flask-marshmallow.readthedocs.io/
 - Changelog: http://flask-marshmallow.readthedocs.io/en/latest/changelog.html
-- PyPI: https://pypi.python.org/pypi/flask-marshmallow
+- PyPI: https://pypi.org/project/flask-marshmallow/
 - Issues: https://github.com/marshmallow-code/flask-marshmallow/issues
 
 License
@@ -149,8 +157,8 @@ MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/flas
     :target: https://pypi.org/project/flask-marshmallow/
     :alt: Latest version
 
-.. |build-status| image:: https://github.com/marshmallow-code/flask-marshmallow/workflows/build/badge.svg?event=push
-    :target: https://github.com/marshmallow-code/flask-marshmallow/actions?query=workflow%3Abuild
+.. |build-status| image:: https://github.com/marshmallow-code/flask-marshmallow/actions/workflows/build-release.yml/badge.svg
+    :target: https://github.com/marshmallow-code/flask-marshmallow/actions/workflows/build-release.yml
     :alt: Build status
 
 .. |docs| image:: https://readthedocs.org/projects/flask-marshmallow/badge/
@@ -161,6 +169,3 @@ MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/flas
     :target: https://marshmallow.readthedocs.io/en/latest/upgrading.html
     :alt: marshmallow 3 compatible
 
-.. |black| image:: https://badgen.net/badge/code%20style/black/000
-    :target: https://github.com/ambv/black
-    :alt: code style: black

{flask-marshmallow-0.15.0 → flask_marshmallow-1.0.0}/README.rst

@@ -2,7 +2,7 @@
 Flask-Marshmallow
 *****************
 
-|pypi-package| |build-status| |docs| |marshmallow3| |black|
+|pypi-package| |build-status| |docs| |marshmallow3|
 
 Flask + marshmallow for beautiful APIs
 ======================================
@@ -103,7 +103,7 @@ Project Links
 
 - Docs: https://flask-marshmallow.readthedocs.io/
 - Changelog: http://flask-marshmallow.readthedocs.io/en/latest/changelog.html
-- PyPI: https://pypi.python.org/pypi/flask-marshmallow
+- PyPI: https://pypi.org/project/flask-marshmallow/
 - Issues: https://github.com/marshmallow-code/flask-marshmallow/issues
 
 License
@@ -119,8 +119,8 @@ MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/flas
     :target: https://pypi.org/project/flask-marshmallow/
     :alt: Latest version
 
-.. |build-status| image:: https://github.com/marshmallow-code/flask-marshmallow/workflows/build/badge.svg?event=push
-    :target: https://github.com/marshmallow-code/flask-marshmallow/actions?query=workflow%3Abuild
+.. |build-status| image:: https://github.com/marshmallow-code/flask-marshmallow/actions/workflows/build-release.yml/badge.svg
+    :target: https://github.com/marshmallow-code/flask-marshmallow/actions/workflows/build-release.yml
     :alt: Build status
 
 .. |docs| image:: https://readthedocs.org/projects/flask-marshmallow/badge/
@@ -130,7 +130,3 @@ MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/flas
 .. |marshmallow3| image:: https://badgen.net/badge/marshmallow/3
     :target: https://marshmallow.readthedocs.io/en/latest/upgrading.html
     :alt: marshmallow 3 compatible
-
-.. |black| image:: https://badgen.net/badge/code%20style/black/000
-    :target: https://github.com/ambv/black
-    :alt: code style: black

{flask-marshmallow-0.15.0 → flask_marshmallow-1.0.0}/docs/_templates/side-primary.html

@@ -14,7 +14,7 @@ Flask + marshmallow for beautiful APIs
 
 <h3>Useful Links</h3>
 <ul>
-  <li><a href="http://pypi.python.org/pypi/flask-marshmallow">Flask-Marshmallow @ PyPI</a></li>
+  <li><a href="https://pypi.org/project/flask-marshmallow/">Flask-Marshmallow @ PyPI</a></li>
   <li><a href="http://github.com/marshmallow-code/flask-marshmallow">Flask-Marshmallow @ GitHub</a></li>
   <li><a href="http://github.com/marshmallow-code/flask-marshmallow/issues">Issue Tracker</a></li>
 </ul>

{flask-marshmallow-0.15.0 → flask_marshmallow-1.0.0}/docs/_templates/side-secondary.html

@@ -18,7 +18,7 @@ Flask + marshmallow for beautiful APIs
 
 <h3>Useful Links</h3>
 <ul>
-  <li><a href="http://pypi.python.org/pypi/flask-marshmallow">Flask-Marshmallow @ PyPI</a></li>
+  <li><a href="https://pypi.org/project/flask-marshmallow/">Flask-Marshmallow @ PyPI</a></li>
   <li><a href="http://github.com/marshmallow-code/flask-marshmallow">Flask-Marshmallow @ GitHub</a></li>
   <li><a href="http://github.com/marshmallow-code/flask-marshmallow/issues">Issue Tracker</a></li>
 </ul>

{flask-marshmallow-0.15.0 → flask_marshmallow-1.0.0}/docs/conf.py

@@ -1,9 +1,7 @@
 import datetime as dt
-import sys
+import importlib.metadata
 import os
-
-sys.path.insert(0, os.path.abspath(os.path.join("..", "src")))
-import flask_marshmallow  # noqa: E402
+import sys
 
 sys.path.append(os.path.abspath("_themes"))
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx_issues"]
@@ -39,7 +37,7 @@ copyright = "2014-{:%Y}".format(
 )
 
 
-version = release = flask_marshmallow.__version__
+version = release = importlib.metadata.version("flask-marshmallow")
 exclude_patterns = ["_build"]
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "flask_theme_support.FlaskyStyle"

{flask-marshmallow-0.15.0 → flask_marshmallow-1.0.0}/docs/index.rst

@@ -4,7 +4,7 @@ Flask-Marshmallow: Flask + marshmallow for beautiful APIs
 
 :ref:`changelog <changelog>` //
 `github <http://github.com/marshmallow-code/flask-marshmallow>`_ //
-`pypi <http://pypi.python.org/pypi/flask-marshmallow>`_ //
+`pypi <https://pypi.org/project/flask-marshmallow/>`_ //
 `issues <http://github.com/marshmallow-code/flask-marshmallow/issues>`_
 
 
@@ -178,6 +178,7 @@ You can now use your schema to dump and load your ORM objects.
 
 - By default, `~flask_marshmallow.sqla.SQLAlchemySchema` uses the scoped session created by Flask-SQLAlchemy.
 - `~flask_marshmallow.sqla.SQLAlchemySchema` subclasses `flask_marshmallow.Schema`, so it includes the `~flask_marshmallow.Schema.jsonify` method.
+
 Note: By default, Flask's `jsonify` method sorts the list of keys and returns consistent results to ensure that external HTTP caches aren't trashed. As a side effect, this will override `ordered=True <https://marshmallow.readthedocs.io/en/latest/quickstart.html#ordering-output>`_ 
 in the SQLAlchemySchema's `class Meta` (if you set it). To disable this, set `JSON_SORT_KEYS=False` in your Flask app config. In production it's recommended to let `jsonify` sort the keys and not set `ordered=True` in your `~flask_marshmallow.sqla.SQLAlchemySchema` in order to minimize generation time and maximize cacheability of the results.
 
@@ -228,6 +229,9 @@ API
 .. automodule:: flask_marshmallow.fields
     :members:
 
+.. automodule:: flask_marshmallow.validate
+    :members:
+
 .. automodule:: flask_marshmallow.sqla
     :members:
 

flask_marshmallow-1.0.0/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "flask-marshmallow"
+version = "1.0.0"
+description = "Flask + marshmallow for beautiful APIs"
+readme = "README.rst"
+license = { file = "LICENSE" }
+maintainers = [{ name = "Steven Loria", email = "sloria1@gmail.com" }]
+classifiers = [
+  "Environment :: Web Environment",
+  "Intended Audience :: Developers",
+  "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",
+  "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+requires-python = ">=3.8"
+dependencies = ["Flask", "marshmallow>=3.0.0", "packaging>=17.0"]
+
+[project.urls]
+Issues = "https://github.com/marshmallow-code/flask-marshmallow/issues"
+Funding = "https://opencollective.com/marshmallow"
+
+[project.optional-dependencies]
+docs = [
+  "marshmallow-sqlalchemy>=0.19.0",
+  "Sphinx==7.2.6",
+  "sphinx-issues==3.0.1",
+]
+tests = ["flask-marshmallow[sqlalchemy]", "pytest"]
+dev = ["flask-marshmallow[tests]", "tox", "pre-commit~=3.5"]
+sqlalchemy = ["flask-sqlalchemy>=3.0.0", "marshmallow-sqlalchemy>=0.29.0"]
+
+[build-system]
+requires = ["flit_core<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.flit.sdist]
+include = ["docs/", "tests/", "CHANGELOG.rst", "CONTRIBUTING.rst", "tox.ini"]
+exclude = ["docs/_build/"]
+
+[tool.ruff]
+src = ["src"]
+fix = true
+show-fixes = true
+show-source = true
+
+[tool.ruff.lint]
+select = [
+  "B",  # flake8-bugbear
+  "E",  # pycodestyle error
+  "F",  # pyflakes
+  "I",  # isort
+  "UP", # pyupgrade
+  "W",  # pycodestyle warning
+]
+
+[tool.pytest.ini_options]
+filterwarnings = [
+  "error",
+  "ignore:distutils Version classes are deprecated\\. Use packaging.version instead\\.:DeprecationWarning:marshmallow",
+]

{flask-marshmallow-0.15.0 → flask_marshmallow-1.0.0}/src/flask_marshmallow/__init__.py

@@ -6,9 +6,9 @@
     with your Flask application.
 """
 import warnings
-from packaging.version import Version
 
-from marshmallow import fields as base_fields, exceptions, pprint
+from marshmallow import exceptions, pprint
+from marshmallow import fields as base_fields
 
 from . import fields
 from .schema import Schema
@@ -24,14 +24,20 @@ else:
     except ImportError:
         warnings.warn(
             "Flask-SQLAlchemy integration requires "
-            "marshmallow-sqlalchemy to be installed."
+            "marshmallow-sqlalchemy to be installed.",
+            stacklevel=2,
         )
     else:
         has_sqla = True
 
-__version__ = "0.15.0"
-__version_info__ = Version(__version__).release
-__all__ = ["EXTENSION_NAME", "Marshmallow", "Schema", "fields", "exceptions", "pprint"]
+__all__ = [
+    "EXTENSION_NAME",
+    "Marshmallow",
+    "Schema",
+    "fields",
+    "exceptions",
+    "pprint",
+]
 
 EXTENSION_NAME = "flask-marshmallow"
 
@@ -75,14 +81,15 @@ class Marshmallow:
             })
 
 
-    In order to integrate with Flask-SQLAlchemy, this extension must be initialized *after*
-    `flask_sqlalchemy.SQLAlchemy`. ::
+    In order to integrate with Flask-SQLAlchemy, this extension must be initialized
+    *after* `flask_sqlalchemy.SQLAlchemy`. ::
 
             db = SQLAlchemy(app)
             ma = Marshmallow(app)
 
-    This gives you access to `ma.SQLAlchemySchema` and `ma.SQLAlchemyAutoSchema`, which generate
-    marshmallow `~marshmallow.Schema` classes based on the passed in model or table. ::
+    This gives you access to `ma.SQLAlchemySchema` and `ma.SQLAlchemyAutoSchema`, which
+    generate marshmallow `~marshmallow.Schema` classes
+    based on the passed in model or table. ::
 
         class AuthorSchema(ma.SQLAlchemyAutoSchema):
             class Meta:

{flask-marshmallow-0.15.0 → flask_marshmallow-1.0.0}/src/flask_marshmallow/fields.py

@@ -9,12 +9,18 @@
 """
 import re
 
-from flask import url_for
-from marshmallow import fields
-from marshmallow import missing
+from flask import current_app, url_for
+from marshmallow import fields, missing
 
-
-__all__ = ["URLFor", "UrlFor", "AbsoluteURLFor", "AbsoluteUrlFor", "Hyperlinks"]
+__all__ = [
+    "URLFor",
+    "UrlFor",
+    "AbsoluteURLFor",
+    "AbsoluteUrlFor",
+    "Hyperlinks",
+    "File",
+    "Config",
+]
 
 
 _tpl_pattern = re.compile(r"\s*<\s*(\S*)\s*>\s*")
@@ -69,7 +75,10 @@ class URLFor(fields.Field):
     Usage: ::
 
         url = URLFor('author_get', values=dict(id='<id>'))
-        https_url = URLFor('author_get', values=dict(id='<id>', _scheme='https', _external=True))
+        https_url = URLFor(
+            'author_get',
+            values=dict(id='<id>', _scheme='https', _external=True),
+        )
 
     :param str endpoint: Flask endpoint name.
     :param dict values: Same keyword arguments as Flask's url_for, except string
@@ -100,8 +109,7 @@ class URLFor(fields.Field):
                     param_values[name] = attribute_value
                 else:
                     raise AttributeError(
-                        "{attr_name!r} is not a valid "
-                        "attribute of {obj!r}".format(attr_name=attr_name, obj=obj)
+                        f"{attr_name!r} is not a valid " f"attribute of {obj!r}"
                     )
             else:
                 param_values[name] = attr_tpl
@@ -126,7 +134,9 @@ AbsoluteUrlFor = AbsoluteURLFor
 
 
 def _rapply(d, func, *args, **kwargs):
-    """Apply a function to all values in a dictionary or list of dictionaries, recursively."""
+    """Apply a function to all values in a dictionary or
+    list of dictionaries, recursively.
+    """
     if isinstance(d, (tuple, list)):
         return [_rapply(each, func, *args, **kwargs) for each in d]
     if isinstance(d, dict):
@@ -178,3 +188,60 @@ class Hyperlinks(fields.Field):
 
     def _serialize(self, value, attr, obj):
         return _rapply(self.schema, _url_val, key=attr, obj=obj)
+
+
+class File(fields.Field):
+    """A binary file field for uploaded files.
+
+    Examples: ::
+
+        class ImageSchema(Schema):
+            image = File(required=True)
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # Metadata used by apispec
+        self.metadata["type"] = "string"
+        self.metadata["format"] = "binary"
+
+    default_error_messages = {"invalid": "Not a valid file."}
+
+    def _deserialize(self, value, attr, data, **kwargs):
+        from werkzeug.datastructures import FileStorage
+
+        if not isinstance(value, FileStorage):
+            raise self.make_error("invalid")
+        return value
+
+
+class Config(fields.Field):
+    """A field for Flask configuration values.
+
+    Examples: ::
+
+        from flask import Flask
+
+        app = Flask(__name__)
+        app.config['API_TITLE'] = 'Pet API'
+
+        class FooSchema(Schema):
+            user = String()
+            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.
+
+    :param str key: The key of the configuration value.
+    """
+
+    _CHECK_ATTRIBUTE = False
+
+    def __init__(self, key: str, **kwargs):
+        fields.Field.__init__(self, **kwargs)
+        self.key = key
+
+    def _serialize(self, value, attr, obj, **kwargs):
+        if self.key not in current_app.config:
+            raise ValueError(f"The key {self.key!r} is not found in the app config.")
+        return current_app.config[self.key]

{flask-marshmallow-0.15.0 → flask_marshmallow-1.0.0}/src/flask_marshmallow/schema.py

@@ -1,7 +1,6 @@
 import flask
 import marshmallow as ma
 
-
 sentinel = object()
 
 

{flask-marshmallow-0.15.0 → flask_marshmallow-1.0.0}/src/flask_marshmallow/sqla.py

@@ -7,9 +7,10 @@
     `SQLAlchemyAutoSchema <marshmallow_sqlalchemy.SQLAlchemyAutoSchema>` classes
     that use the scoped session from Flask-SQLAlchemy.
 """
-from flask import url_for, current_app
 from urllib import parse
+
 import marshmallow_sqlalchemy as msqla
+from flask import current_app, url_for
 from marshmallow.exceptions import ValidationError
 
 from .schema import Schema