APIFlask 2.2.0__tar.gz → 2.3.0__tar.gz

{apiflask-2.2.0 → apiflask-2.3.0}/CHANGES.md

@@ -1,3 +1,22 @@
+## Version 2.3.0
+
+Released: 2024/11/25
+
+- Support skipping the validation for the request body with `@input(validation=False)` ([issue #573][issue_573]).
+- Enable CI test for Python 3.13.
+
+[issue_573]: https://github.com/apiflask/apiflask/issues/573
+
+
+## Version 2.2.1
+
+Released: 2024/9/8
+
+- Fix OpenAPI spec for multiple content types with `json_or_form` location ([issue #600][issue_600]).
+
+[issue_600]: https://github.com/apiflask/apiflask/issues/600
+
+
 ## Version 2.2.0
 
 Released: 2024/8/3

{apiflask-2.2.0 → apiflask-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: APIFlask
-Version: 2.2.0
+Version: 2.3.0
 Summary: A lightweight web API framework based on Flask and marshmallow-code projects.
 Author-email: Grey Li <withlihui@gmail.com>
 License: MIT

{apiflask-2.2.0 → apiflask-2.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ description = "A lightweight web API framework based on Flask and marshmallow-co
 readme = "README.md"
 license = { text = "MIT" }
 authors = [{ name = "Grey Li", email = "withlihui@gmail.com" }]
-version = "2.2.0"
+version = "2.3.0"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Environment :: Web Environment",

{apiflask-2.2.0 → apiflask-2.3.0}/requirements/dev.txt

@@ -9,11 +9,11 @@
 -r examples.txt
 -r tests.txt
 -r typing.txt
-build==1.2.1
+build==1.2.2
     # via
     #   -r requirements/dev.in
     #   pip-tools
-cachetools==5.4.0
+cachetools==5.5.0
     # via tox
 cfgv==3.4.0
     # via pre-commit
@@ -21,7 +21,7 @@ chardet==5.2.0
     # via tox
 distlib==0.3.8
     # via virtualenv
-filelock==3.15.4
+filelock==3.16.0
     # via
     #   tox
     #   virtualenv
@@ -43,13 +43,13 @@ pyproject-hooks==1.1.0
     #   pip-tools
 toposort==1.10
     # via pip-compile-multi
-tox==4.16.0
+tox==4.18.1
     # via -r requirements/dev.in
-virtualenv==20.26.3
+virtualenv==20.26.4
     # via
     #   pre-commit
     #   tox
-wheel==0.43.0
+wheel==0.44.0
     # via pip-tools
 
 # The following packages are considered to be unsafe in a requirements file:

{apiflask-2.2.0 → apiflask-2.3.0}/requirements/docs.txt

@@ -5,11 +5,9 @@
 #
 #    pip-compile-multi
 #
-babel==2.15.0
+babel==2.16.0
     # via mkdocs-material
-backports-strenum==1.3.1
-    # via griffe
-certifi==2024.7.4
+certifi==2024.8.30
     # via requests
 charset-normalizer==3.3.2
     # via requests
@@ -23,16 +21,16 @@ colorama==0.4.6
     #   mkdocs-material
 ghp-import==2.1.0
     # via mkdocs
-griffe==0.48.0
+griffe==1.2.0
     # via mkdocstrings-python
-idna==3.7
+idna==3.8
     # via requests
 jinja2==3.1.4
     # via
     #   mkdocs
     #   mkdocs-material
     #   mkdocstrings
-markdown==3.6
+markdown==3.7
     # via
     #   mkdocs
     #   mkdocs-autorefs
@@ -49,32 +47,34 @@ mergedeep==1.3.4
     # via
     #   mkdocs
     #   mkdocs-get-deps
-mkdocs==1.6.0
+mkdocs==1.6.1
     # via
     #   mkdocs-autorefs
     #   mkdocs-material
     #   mkdocstrings
-mkdocs-autorefs==1.0.1
-    # via mkdocstrings
+mkdocs-autorefs==1.2.0
+    # via
+    #   mkdocstrings
+    #   mkdocstrings-python
 mkdocs-get-deps==0.2.0
     # via mkdocs
-mkdocs-material==9.5.31
+mkdocs-material==9.5.34
     # via -r requirements/docs.in
 mkdocs-material-extensions==1.3.1
     # via mkdocs-material
-mkdocstrings==0.25.2
+mkdocstrings==0.26.1
     # via
     #   -r requirements/docs.in
     #   mkdocstrings-python
-mkdocstrings-python==1.10.7
+mkdocstrings-python==1.11.1
     # via -r requirements/docs.in
 packaging==24.1
     # via mkdocs
-paginate==0.5.6
+paginate==0.5.7
     # via mkdocs-material
 pathspec==0.12.1
     # via mkdocs
-platformdirs==4.2.2
+platformdirs==4.3.1
     # via
     #   mkdocs-get-deps
     #   mkdocstrings
@@ -86,7 +86,7 @@ pymdown-extensions==10.9
     #   mkdocstrings
 python-dateutil==2.9.0.post0
     # via ghp-import
-pyyaml==6.0.1
+pyyaml==6.0.2
     # via
     #   mkdocs
     #   mkdocs-get-deps
@@ -102,5 +102,5 @@ six==1.16.0
     # via python-dateutil
 urllib3==2.2.2
     # via requests
-watchdog==4.0.1
+watchdog==4.0.2
     # via mkdocs

{apiflask-2.2.0 → apiflask-2.3.0}/requirements/examples.txt

@@ -5,21 +5,21 @@
 #
 #    pip-compile-multi
 #
-authlib==1.3.1
+authlib==1.3.2
     # via -r requirements/examples.in
 blinker==1.8.2
     # via flask
-cffi==1.16.0
+cffi==1.17.1
     # via cryptography
 click==8.1.7
     # via flask
-cryptography==43.0.0
+cryptography==43.0.1
     # via authlib
 flask==3.0.3
     # via flask-sqlalchemy
 flask-sqlalchemy==3.1.1
     # via -r requirements/examples.in
-greenlet==3.0.3
+greenlet==3.1.0
     # via sqlalchemy
 itsdangerous==2.2.0
     # via flask
@@ -29,7 +29,7 @@ markupsafe==2.1.5
     # via
     #   jinja2
     #   werkzeug
-marshmallow==3.21.3
+marshmallow==3.22.0
     # via marshmallow-dataclass
 marshmallow-dataclass==8.7.0
     # via -r requirements/examples.in
@@ -39,7 +39,7 @@ packaging==24.1
     # via marshmallow
 pycparser==2.22
     # via cffi
-sqlalchemy==2.0.31
+sqlalchemy==2.0.34
     # via flask-sqlalchemy
 typeguard==4.0.1
     # via marshmallow-dataclass
@@ -51,5 +51,5 @@ typing-extensions==4.12.2
     #   typing-inspect
 typing-inspect==0.9.0
     # via marshmallow-dataclass
-werkzeug==3.0.3
+werkzeug==3.0.4
     # via flask

{apiflask-2.2.0 → apiflask-2.3.0}/requirements/min-versions.txt

@@ -9,11 +9,11 @@ apispec==6.0.0
     # via -r requirements/min-versions.in
 authlib==1.2.1
     # via -r requirements/min-versions.in
-cffi==1.16.0
+cffi==1.17.1
     # via cryptography
 click==8.1.7
     # via flask
-cryptography==43.0.0
+cryptography==43.0.1
     # via authlib
 flask==2.0.0
     # via
@@ -27,7 +27,7 @@ flask-marshmallow==1.0.0
     # via -r requirements/min-versions.in
 flask-sqlalchemy==2.5.1
     # via -r requirements/min-versions.in
-greenlet==3.0.3
+greenlet==3.1.0
     # via sqlalchemy
 itsdangerous==2.2.0
     # via flask
@@ -35,7 +35,7 @@ jinja2==3.1.4
     # via flask
 markupsafe==2.1.5
     # via jinja2
-marshmallow==3.21.3
+marshmallow==3.22.0
     # via
     #   flask-marshmallow
     #   marshmallow-dataclass

{apiflask-2.2.0 → apiflask-2.3.0}/requirements/tests.txt

@@ -7,19 +7,19 @@
 #
 asgiref==3.8.1
     # via -r requirements/tests.in
-attrs==23.2.0
+attrs==24.2.0
     # via
     #   jsonschema
     #   referencing
-certifi==2024.7.4
+certifi==2024.8.30
     # via requests
 charset-normalizer==3.3.2
     # via requests
-coverage[toml]==7.6.0
+coverage[toml]==7.6.1
     # via pytest-cov
 exceptiongroup==1.2.2
     # via pytest
-idna==3.7
+idna==3.8
     # via requests
 iniconfig==2.0.0
     # via pytest
@@ -51,7 +51,7 @@ pytest==8.3.2
     #   pytest-cov
 pytest-cov==5.0.0
     # via -r requirements/tests.in
-pyyaml==6.0.1
+pyyaml==6.0.2
     # via jsonschema-path
 referencing==0.35.1
     # via
@@ -62,7 +62,7 @@ requests==2.32.3
     # via jsonschema-path
 rfc3339-validator==0.1.4
     # via openapi-schema-validator
-rpds-py==0.19.1
+rpds-py==0.20.0
     # via
     #   jsonschema
     #   referencing

{apiflask-2.2.0 → apiflask-2.3.0}/requirements/typing.txt

@@ -5,7 +5,7 @@
 #
 #    pip-compile-multi
 #
-mypy==1.11.1
+mypy==1.11.2
     # via -r requirements/typing.in
 mypy-extensions==1.0.0
     # via mypy

{apiflask-2.2.0 → apiflask-2.3.0}/src/APIFlask.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: APIFlask
-Version: 2.2.0
+Version: 2.3.0
 Summary: A lightweight web API framework based on Flask and marshmallow-code projects.
 Author-email: Grey Li <withlihui@gmail.com>
 License: MIT

{apiflask-2.2.0 → apiflask-2.3.0}/src/apiflask/app.py

@@ -1093,20 +1093,20 @@ class APIFlask(APIScaffold, Flask):
 
                 # requestBody
                 if view_func._spec.get('body'):
-                    content_type = view_func._spec.get('content_type', 'application/json')
-                    operation['requestBody'] = {
-                        'content': {
-                            content_type: {
-                                'schema': view_func._spec['body'],
-                            }
+                    content_types = view_func._spec.get('content_type')
+                    if not isinstance(content_types, list):
+                        content_types = [content_types]
+                    operation['requestBody'] = {'content': {}}
+                    for content_type in content_types:
+                        operation['requestBody']['content'][content_type] = {
+                            'schema': view_func._spec['body'],
                         }
-                    }
-                    if view_func._spec.get('body_example'):
-                        example = view_func._spec.get('body_example')
-                        operation['requestBody']['content'][content_type]['example'] = example
-                    if view_func._spec.get('body_examples'):
-                        examples = view_func._spec.get('body_examples')
-                        operation['requestBody']['content'][content_type]['examples'] = examples
+                        if view_func._spec.get('body_example'):
+                            example = view_func._spec.get('body_example')
+                            operation['requestBody']['content'][content_type]['example'] = example
+                        if view_func._spec.get('body_examples'):
+                            examples = view_func._spec.get('body_examples')
+                            operation['requestBody']['content'][content_type]['examples'] = examples
 
                 # security
                 if custom_security:  # custom security

{apiflask-2.2.0 → apiflask-2.3.0}/src/apiflask/scaffold.py

@@ -6,6 +6,7 @@ from functools import wraps
 
 from flask import current_app
 from flask import jsonify
+from flask import request
 from flask import Response
 from marshmallow import ValidationError as MarshmallowValidationError
 from webargs.flaskparser import FlaskParser as BaseFlaskParser
@@ -100,6 +101,46 @@ def _generate_schema_from_mapping(schema: DictSchemaType, schema_name: str | Non
     return Schema.from_dict(schema, name=schema_name)()  # type: ignore
 
 
+def _load_raw_data(location: str = 'json') -> dict[t.Any, t.Any]:
+    """
+    Load raw data from the specified location in the request.
+
+    Arguments:
+        location (str): Specifies the source of the data to load, which can be one of the following:
+            - `json`: Load data from the request's JSON body.
+            - `form`: Load data from the request's form.
+            - `files` or `form_and_files`: Load data from both the request's form and files.
+            - `json_or_form`: Preferably load data from the request's JSON body or request's form.
+            - `query`: Load data from the request's query parameters.
+            - `path`: Load data from the request's view arguments.
+
+            `headers` and `cookies` are not supported by this function.
+
+    Returns:
+        dict: A dictionary containing the data loaded from the specified location.
+
+    Raises:
+        ValueError: If the provided location argument is not one of the expected values.
+    """
+    if location == 'json':
+        if request.is_json:
+            return request.get_json() or {}
+        return {}
+    if location == 'form':
+        return request.form.to_dict()
+    if location in ['files', 'form_and_files']:
+        return {**request.files.to_dict(), **request.form.to_dict()}
+    if location == 'json_or_form':
+        if request.is_json:
+            return request.get_json() or {}
+        return request.form.to_dict()
+    if location in ['query', 'querystring']:
+        return request.args.to_dict()
+    if location == 'path':
+        return request.view_args or {}
+    raise ValueError(f'Invalid location argument: {location}')
+
+
 class APIScaffold:
     """A base class for [`APIFlask`][apiflask.app.APIFlask] and
     [`APIBlueprint`][apiflask.blueprint.APIBlueprint].
@@ -209,6 +250,7 @@ class APIScaffold:
         schema_name: str | None = None,
         example: t.Any | None = None,
         examples: dict[str, t.Any] | None = None,
+        validation: bool = True,
         **kwargs: t.Any,
     ) -> t.Callable[[DecoratedType], DecoratedType]:
         """Add input settings for view functions.
@@ -262,6 +304,11 @@ class APIScaffold:
                     },
                 }
                 ```
+            validation: Flag to allow disabling of validation on input. Default to `True`.
+
+        *Version changed: 2.2.2
+
+        - Add parameter `validation` to allow disabling of validation on input.
 
         *Version changed: 2.0.0*
 
@@ -290,6 +337,17 @@ class APIScaffold:
 
         def decorator(f):
             f = _ensure_sync(f)
+
+            if not validation:
+
+                @wraps(f)
+                def wrapper(*args: t.Any, **kwargs: t.Any):
+                    raw_data = _load_raw_data(location)
+                    kwargs[f'{location}_data'] = raw_data
+                    return f(*args, **kwargs)
+
+                return wrapper
+
             is_body_location = location in BODY_LOCATIONS
             if is_body_location and hasattr(f, '_spec') and 'body' in f._spec:
                 raise RuntimeError(
@@ -298,7 +356,13 @@ class APIScaffold:
                     'and "json_or_form").'
                 )
             if location == 'json':
-                _annotate(f, body=schema, body_example=example, body_examples=examples)
+                _annotate(
+                    f,
+                    body=schema,
+                    body_example=example,
+                    body_examples=examples,
+                    content_type='application/json',
+                )
             elif location == 'form':
                 _annotate(
                     f,
@@ -315,6 +379,14 @@ class APIScaffold:
                     body_examples=examples,
                     content_type='multipart/form-data',
                 )
+            elif location == 'json_or_form':
+                _annotate(
+                    f,
+                    body=schema,
+                    body_example=example,
+                    body_examples=examples,
+                    content_type=['application/x-www-form-urlencoded', 'application/json'],
+                )
             else:
                 if not hasattr(f, '_spec') or f._spec.get('args') is None:
                     _annotate(f, args=[])
@@ -406,7 +478,7 @@ class APIScaffold:
                 See the [docs](https://apiflask.com/openapi/#response-links) for more details
                 about setting response links.
 
-            content_type: The content/media type of the response. It defautls to `application/json`.
+            content_type: The content/media type of the response. It defaults to `application/json`.
             headers: The schemas of the headers.
 
         *Version changed: 2.1.0*

{apiflask-2.2.0 → apiflask-2.3.0}/tests/test_decorator_input.py

@@ -11,7 +11,10 @@ from .schemas import Files
 from .schemas import Foo
 from .schemas import Form
 from .schemas import FormAndFiles
+from apiflask import Schema
 from apiflask.fields import String
+from apiflask.validators import Length
+from apiflask.validators import OneOf
 
 
 def test_input(app, client):
@@ -190,6 +193,43 @@ def test_input_with_form_and_files_location(app, client):
     assert rv.json == {'name': True, 'image': True}
 
 
+def test_input_with_json_or_form_location(app, client):
+    @app.post('/')
+    @app.input(Form, location='json_or_form')
+    def index(json_or_form_data):
+        return json_or_form_data
+
+    rv = client.get('/openapi.json')
+    assert rv.status_code == 200
+    osv.validate(rv.json)
+    assert (
+        'application/x-www-form-urlencoded'
+        in rv.json['paths']['/']['post']['requestBody']['content']
+    )
+    assert 'application/json' in rv.json['paths']['/']['post']['requestBody']['content']
+    assert (
+        rv.json['paths']['/']['post']['requestBody']['content']['application/json']['schema'][
+            '$ref'
+        ]
+        == '#/components/schemas/Form'
+    )
+    assert (
+        rv.json['paths']['/']['post']['requestBody']['content'][
+            'application/x-www-form-urlencoded'
+        ]['schema']['$ref']
+        == '#/components/schemas/Form'
+    )
+    assert 'Form' in rv.json['components']['schemas']
+
+    rv = client.post('/', data={'name': 'foo'})
+    assert rv.status_code == 200
+    assert rv.json == {'name': 'foo'}
+
+    rv = client.post('/', json={'name': 'foo'})
+    assert rv.status_code == 200
+    assert rv.json == {'name': 'foo'}
+
+
 def test_input_with_path_location(app, client):
     @app.get('/<image_type>')
     @app.input(EnumPathParameter, location='path')
@@ -376,3 +416,136 @@ def test_input_body_example(app, client):
         rv.json['paths']['/baz']['post']['requestBody']['content']['application/json']['examples']
         == examples
     )
+
+
+def test_skip_validation(app, client):
+    incorrect_json = {'name': 'Kitty', 'category': 'unknown'}
+
+    class PetIn(Schema):
+        name = String(required=True, validate=Length(0, 10))
+        category = String(required=True, validate=OneOf(['dog', 'cat']))
+
+    @app.patch('/pets_without_validation/<int:pet_id>')
+    @app.input(PetIn, validation=False)
+    def pets_without_validation(pet_id, json_data):
+        return {'pet_id': pet_id, 'json_data': json_data}
+
+    no_validated_rv = client.patch('/pets_without_validation/1', json=incorrect_json)
+    assert no_validated_rv.status_code == 200
+    assert no_validated_rv.json['json_data']['name'] == 'Kitty'
+    assert no_validated_rv.json['json_data']['category'] == 'unknown'
+
+
+def test_location_raw_data(app):
+    from apiflask.scaffold import _load_raw_data
+
+    # will raises ValueError
+    location = 'unknown'
+    with pytest.raises(ValueError, match=f'Invalid location argument: {location}'):
+        _load_raw_data('unknown')
+
+    # `json` location
+    with app.test_request_context('/load_raw_data', method='POST', json={'name': 'Kitty'}):
+        json_data = _load_raw_data()
+        assert json_data['name'] == 'Kitty'
+
+    with app.test_request_context('/load_raw_data', method='POST', data={'name': 'Kitty'}):
+        json_data = _load_raw_data()
+        assert json_data == {}
+
+    # `form` location
+    with app.test_request_context(
+        '/load_raw_data',
+        method='POST',
+        data={'username': 'Kitty', 'password': '<PASSWORD>'},
+        content_type='application/x-www-form-urlencoded',
+    ):
+        form_data = _load_raw_data('form')
+        assert form_data['username'] == 'Kitty'
+        assert form_data['password'] == '<PASSWORD>'
+
+    with app.test_request_context(
+        '/load_raw_data',
+        method='POST',
+        json={'username': 'Kitty', 'password': '<PASSWORD>'},
+    ):
+        form_data = _load_raw_data('form')
+        assert form_data == {}
+
+    # `files` or `form_and_files` location
+    with app.test_request_context(
+        '/load_raw_data',
+        method='POST',
+        data={'file': (io.BytesIO(b'Hello World!'), 'demo.txt')},
+        content_type='multipart/form-data',
+    ):
+        files_data = _load_raw_data('files')
+        assert files_data['file'].filename == 'demo.txt'
+        assert files_data['file'].stream.read() == b'Hello World!'
+
+    with app.test_request_context(
+        '/load_raw_data',
+        method='POST',
+        data={'name': 'Kitty', 'file': (io.BytesIO(b'Hello World2!'), 'demo2.txt')},
+        content_type='multipart/form-data',
+    ):
+        files_and_form_rv = _load_raw_data('form_and_files')
+        assert files_and_form_rv['file'].filename == 'demo2.txt'
+        assert files_and_form_rv['file'].stream.read() == b'Hello World2!'
+        assert files_and_form_rv['name'] == 'Kitty'
+
+    with app.test_request_context(
+        '/load_raw_data',
+        method='POST',
+        json={'username': 'Kitty', 'password': '<PASSWORD>'},
+    ):
+        form_and_files_data = _load_raw_data('form_and_files')
+        assert form_and_files_data == {}
+
+    # `query` location
+    with app.test_request_context(
+        '/load_raw_data?name=Kitty',
+        method='GET',
+    ):
+        query_data = _load_raw_data('query')
+        assert query_data == {'name': 'Kitty'}
+
+    with app.test_request_context(
+        '/load_raw_data',
+        method='POST',
+    ):
+        query_data = _load_raw_data('query')
+        assert query_data == {}
+
+    # `json_or_form`
+    with app.test_request_context(
+        '/load_raw_data',
+        data={'username': 'Kitty', 'password': '<PASSWORD>'},
+        content_type='application/x-www-form-urlencoded',
+    ):
+        json_or_form_rv = _load_raw_data('json_or_form')
+        assert json_or_form_rv['username'] == 'Kitty'
+        assert json_or_form_rv['password'] == '<PASSWORD>'
+
+    with app.test_request_context(
+        '/load_raw_data',
+        json={'currentId': '<current_id>'},
+    ):
+        json_or_form_data = _load_raw_data('json_or_form')
+        json_or_form_data['currentId'] = '<current_id>'
+
+    with app.test_request_context(
+        '/load_raw_data',
+        method='POST',
+    ):
+        json_or_form_data = _load_raw_data('json_or_form')
+        assert json_or_form_data == {}
+
+    # `path` location
+    @app.get('/load_raw_data/<int:pet_id>')
+    def load_raw_data(pet_id):
+        return _load_raw_data('path')
+
+    with app.test_request_context('/load_raw_data/1', method='GET'):
+        path_data = app.dispatch_request()
+        assert path_data == {'pet_id': 1}

{apiflask-2.2.0 → apiflask-2.3.0}/tox.ini

@@ -1,6 +1,6 @@
 [tox]
 envlist =
-    py3{12,11,10,9,8}
+    py3{13,12,11,10,9,8}
     pypy310
     minimal
     style