flask-marshmallow 0.11.0__tar.gz → 1.1.0__tar.gz

{flask-marshmallow-0.11.0 → flask_marshmallow-1.1.0}/CHANGELOG.rst

@@ -1,6 +1,158 @@
 Changelog
 =========
 
+1.1.0 (2024-01-16)
+******************
+
+Features:
+
+* Add type coverage (:pr:`290`).
+
+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)
+*******************
+
+* 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.
+
+Bug fixes:
+
+* Address distutils deprecation warning in Python 3.10 (:pr:`242`).
+  Thanks :user:`GabrielLins64` for the PR.
+
+0.14.0 (2020-09-27)
+*******************
+
+* 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.
+
+Deprecation:
+
+* Passing params to ``flask.url_for`` via ``URLFor``'s and ``AbsoluteURLFor``'s constructor
+  params is deprecated. Pass ``values`` instead.
+
+.. code-block:: python
+
+    # flask-marshmallow<0.14.0
+
+
+    class UserSchema(ma.Schema):
+        _links = ma.Hyperlinks(
+            {
+                "self": ma.URLFor("user_detail", id="<id>"),
+            }
+        )
+
+
+    # flask-marshmallow>=0.14.0
+
+
+    class UserSchema(ma.Schema):
+        _links = ma.Hyperlinks(
+            {
+                "self": ma.URLFor("user_detail", values=dict(id="<id>")),
+            }
+        )
+
+0.13.0 (2020-06-07)
+*******************
+
+Bug fixes:
+
+* Fix compatibility with marshmallow-sqlalchemy<0.22.0 (:issue:`189`).
+  Thanks :user:`PatrickRic` for reporting.
+
+Other changes:
+
+* Remove unused ``flask_marshmallow.sqla.SchemaOpts``.
+
+0.12.0 (2020-04-26)
+*******************
+
+* *Breaking change*: ``ma.ModelSchema`` and ``ma.TableSchema`` are removed, since these are deprecated upstream.
+
+.. warning::
+  It is highly recommended that you use the newer ``ma.SQLAlchemySchema`` and ``ma.SQLAlchemyAutoSchema``  classes
+  instead of ``ModelSchema`` and ``TableSchema``. See the release notes for `marshmallow-sqlalchemy 0.22.0 <https://marshmallow-sqlalchemy.readthedocs.io/en/latest/changelog.html>`_
+  for instructions on how to migrate.
+
+If you need to use ``ModelSchema`` and ``TableSchema`` for the time being, you'll need to import these directly from ``marshmallow_sqlalchemy``.
+
+.. code-block:: python
+
+    from flask import Flask
+    from flask_sqlalchemy import SQLAlchemy
+    from flask_marshmallow import Marshmallow
+
+    app = Flask(__name__)
+    app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:////tmp/test.db"
+
+    db = SQLAlchemy(app)
+    ma = Marshmallow(app)
+
+    # flask-marshmallow<0.12.0
+
+
+    class AuthorSchema(ma.ModelSchema):
+        class Meta:
+            model = Author
+
+
+    # flask-marshmallow>=0.12.0 (recommended)
+
+
+    class AuthorSchema(ma.SQLAlchemyAutoSchema):
+        class Meta:
+            model = Author
+            load_instance = True
+
+
+    # flask-marshmallow>=0.12.0 (not recommended)
+
+    from marshmallow_sqlalchemy import ModelSchema
+
+
+    class AuthorSchema(ModelSchema):
+        class Meta:
+            model = Author
+            sql_session = db.session
+
+Bug fixes:
+
+* Fix binding Flask-SQLAlchemy's scoped session to ``ma.SQLAlchemySchema`` and ``ma.SQLAlchemyAutoSchema``.
+  (:issue:`180`). Thanks :user:`fnalonso` for reporting.
+
 0.11.0 (2020-02-09)
 *******************
 

{flask-marshmallow-0.11.0 → flask_marshmallow-1.1.0}/CONTRIBUTING.rst

@@ -108,14 +108,14 @@ To run syntax checks: ::
 
     $ tox -e lint
 
-(Optional) To run tests on Python 2.7, 3.5, 3.6, and 3.7 virtual environments (must have each interpreter installed): ::
+(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): ::
 
     $ tox
 
 Documentation
 *************
 
-Contributions to the documentation are welcome. Documentation is written in `reStructured Text`_ (rST). A quick rST reference can be found `here <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_. Builds are powered by Sphinx_.
+Contributions to the documentation are welcome. Documentation is written in `reStructuredText`_ (rST). A quick rST reference can be found `here <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_. Builds are powered by Sphinx_.
 
 To build the docs in "watch" mode: ::
 
@@ -130,5 +130,5 @@ Have a usage example you'd like to share? Feel free to add it to the `examples <
 
 
 .. _Sphinx: http://sphinx.pocoo.org/
-.. _`reStructured Text`: http://docutils.sourceforge.net/rst.html
+.. _`reStructuredText`: https://docutils.sourceforge.io/rst.html
 .. _flask-marshmallow: https://github.com/marshmallow-code/flask-marshmallow

{flask-marshmallow-0.11.0 → flask_marshmallow-1.1.0}/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014-2020 Steven Loria and contributors
+Copyright 2014-2024 Steven Loria and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

flask_marshmallow-1.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.1
+Name: flask-marshmallow
+Version: 1.1.0
+Summary: Flask + marshmallow for beautiful APIs
+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.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-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: 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
+
+*****************
+Flask-Marshmallow
+*****************
+
+|pypi-package| |build-status| |docs| |marshmallow3|
+
+Flask + marshmallow for beautiful APIs
+======================================
+
+Flask-Marshmallow is a thin integration layer for `Flask`_ (a Python web framework) and `marshmallow`_ (an object serialization/deserialization library) that adds additional features to marshmallow, including URL and Hyperlinks fields for HATEOAS-ready APIs. It also (optionally) integrates with `Flask-SQLAlchemy <http://flask-sqlalchemy.pocoo.org/>`_.
+
+Get it now
+----------
+::
+
+    pip install flask-marshmallow
+
+
+Create your app.
+
+.. code-block:: python
+
+    from flask import Flask
+    from flask_marshmallow import Marshmallow
+
+    app = Flask(__name__)
+    ma = Marshmallow(app)
+
+Write your models.
+
+.. code-block:: python
+
+    from your_orm import Model, Column, Integer, String, DateTime
+
+
+    class User(Model):
+        email = Column(String)
+        password = Column(String)
+        date_created = Column(DateTime, auto_now_add=True)
+
+
+Define your output format with marshmallow.
+
+.. code-block:: python
+
+
+    class UserSchema(ma.Schema):
+        class Meta:
+            # Fields to expose
+            fields = ("email", "date_created", "_links")
+
+        # Smart hyperlinking
+        _links = ma.Hyperlinks(
+            {
+                "self": ma.URLFor("user_detail", values=dict(id="<id>")),
+                "collection": ma.URLFor("users"),
+            }
+        )
+
+
+    user_schema = UserSchema()
+    users_schema = UserSchema(many=True)
+
+
+Output the data in your views.
+
+.. code-block:: python
+
+    @app.route("/api/users/")
+    def users():
+        all_users = User.all()
+        return users_schema.dump(all_users)
+
+
+    @app.route("/api/users/<id>")
+    def user_detail(id):
+        user = User.get(id)
+        return user_schema.dump(user)
+
+
+    # {
+    #     "email": "fred@queen.com",
+    #     "date_created": "Fri, 25 Apr 2014 06:02:56 -0000",
+    #     "_links": {
+    #         "self": "/api/users/42",
+    #         "collection": "/api/users/"
+    #     }
+    # }
+
+
+http://flask-marshmallow.readthedocs.io/
+========================================
+
+Learn More
+==========
+
+To learn more about marshmallow, check out its `docs <http://marshmallow.readthedocs.io/en/latest/>`_.
+
+
+
+Project Links
+=============
+
+- Docs: https://flask-marshmallow.readthedocs.io/
+- Changelog: http://flask-marshmallow.readthedocs.io/en/latest/changelog.html
+- PyPI: https://pypi.org/project/flask-marshmallow/
+- Issues: https://github.com/marshmallow-code/flask-marshmallow/issues
+
+License
+=======
+
+MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/flask-marshmallow/blob/master/LICENSE>`_ file for more details.
+
+
+.. _Flask: http://flask.pocoo.org
+.. _marshmallow: http://marshmallow.readthedocs.io
+
+.. |pypi-package| image:: https://badgen.net/pypi/v/flask-marshmallow
+    :target: https://pypi.org/project/flask-marshmallow/
+    :alt: Latest version
+
+.. |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/
+   :target: https://flask-marshmallow.readthedocs.io/
+   :alt: Documentation
+
+.. |marshmallow3| image:: https://badgen.net/badge/marshmallow/3
+    :target: https://marshmallow.readthedocs.io/en/latest/upgrading.html
+    :alt: marshmallow 3 compatible
+

{flask-marshmallow-0.11.0 → flask_marshmallow-1.1.0}/README.rst

@@ -2,7 +2,7 @@
 Flask-Marshmallow
 *****************
 
-|pypi-package| |build-status| |docs| |marshmallow23| |black|
+|pypi-package| |build-status| |docs| |marshmallow3|
 
 Flask + marshmallow for beautiful APIs
 ======================================
@@ -51,7 +51,10 @@ Define your output format with marshmallow.
 
         # Smart hyperlinking
         _links = ma.Hyperlinks(
-            {"self": ma.URLFor("user_detail", id="<id>"), "collection": ma.URLFor("users")}
+            {
+                "self": ma.URLFor("user_detail", values=dict(id="<id>")),
+                "collection": ma.URLFor("users"),
+            }
         )
 
 
@@ -100,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
@@ -115,15 +118,15 @@ MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/flas
 .. |pypi-package| image:: https://badgen.net/pypi/v/flask-marshmallow
     :target: https://pypi.org/project/flask-marshmallow/
     :alt: Latest version
-.. |build-status| image:: https://dev.azure.com/sloria/sloria/_apis/build/status/marshmallow-code.flask-marshmallow?branchName=dev
-    :target: https://dev.azure.com/sloria/sloria/_build/latest?definitionId=14&branchName=dev
+
+.. |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/
    :target: https://flask-marshmallow.readthedocs.io/
    :alt: Documentation
-.. |marshmallow23| image:: https://badgen.net/badge/marshmallow/2,3?list=1
+
+.. |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.11.0 → flask_marshmallow-1.1.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.11.0 → flask_marshmallow-1.1.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.11.0 → flask_marshmallow-1.1.0}/docs/conf.py

@@ -1,10 +1,7 @@
-# -*- coding: utf-8 -*-
 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"]
@@ -34,13 +31,13 @@ source_suffix = ".rst"
 master_doc = "index"
 
 # General information about the project.
-project = u"Flask-Marshmallow"
-copyright = u"2014-{:%Y}".format(
+project = "Flask-Marshmallow"
+copyright = "2014-{:%Y}".format(
     dt.datetime.utcfromtimestamp(os.path.getmtime("../CHANGELOG.rst"))
 )
 
 
-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.11.0 → flask_marshmallow-1.1.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>`_
 
 
@@ -55,7 +55,10 @@ Define your output format with marshmallow.
 
         # Smart hyperlinking
         _links = ma.Hyperlinks(
-            {"self": ma.URLFor("user_detail", id="<id>"), "collection": ma.URLFor("users")}
+            {
+                "self": ma.URLFor("user_detail", values=dict(id="<id>")),
+                "collection": ma.URLFor("users"),
+            }
         )
 
 
@@ -175,8 +178,9 @@ 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 cachability of the results.
+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.
 
 You can also use `ma.HyperlinkRelated <flask_marshmallow.sqla.HyperlinkRelated>` fields if you want relationships to be represented by hyperlinks rather than primary keys.
 
@@ -225,6 +229,9 @@ API
 .. automodule:: flask_marshmallow.fields
     :members:
 
+.. automodule:: flask_marshmallow.validate
+    :members:
+
 .. automodule:: flask_marshmallow.sqla
     :members:
 

flask_marshmallow-1.1.0/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "flask-marshmallow"
+version = "1.1.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>=2.2", "marshmallow>=3.0.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",
+]