APIFlask 2.3.0__tar.gz → 2.3.2__tar.gz

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

@@ -1,3 +1,23 @@
+## Version 2.3.2
+
+Released: 2024/12/15
+
+- Fix response headers to be compliant with the OpenAPI specification for versions 3.0.0+ ([issue #631][issue_631]).
+- Fix input data loading implementation when input validation is skipped ([issue #629][issue_629]).
+
+[issue_629]: https://github.com/apiflask/apiflask/issues/629
+[issue_631]: https://github.com/apiflask/apiflask/issues/631
+
+
+## Version 2.3.1
+
+Released: 2024/12/7
+
+- Include input documentation in API spec when specifying `validation=False` on `@input` decorator  ([issue #626][issue_626]).
+
+[issue_626]: https://github.com/apiflask/apiflask/issues/626
+
+
 ## Version 2.3.0
 
 Released: 2024/11/25
@@ -70,7 +90,7 @@ Released: 2023/12/16
 - Allow adding multiple media types for a response ([issue #494][issue_494]).
 - Support adding headers to the response schema ([issue #507][issue_507]).
 - Add support for adding decorators to the OpenAPI spec and documentation UI endpoints ([issue #483][issue_483]).
-- Fix the base repsonse schema inconsistency issue.
+- Fix the base response schema inconsistency issue.
 
 [issue_494]: https://github.com/apiflask/apiflask/issues/494
 [issue_507]: https://github.com/apiflask/apiflask/issues/507

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: APIFlask
-Version: 2.3.0
+Version: 2.3.2
 Summary: A lightweight web API framework based on Flask and marshmallow-code projects.
 Author-email: Grey Li <withlihui@gmail.com>
 License: MIT
@@ -19,6 +19,7 @@ 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: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content

{apiflask-2.3.0 → apiflask-2.3.2}/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.3.0"
+version = "2.3.2"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Environment :: Web Environment",
@@ -16,6 +16,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Topic :: Internet :: WWW/HTTP :: Dynamic Content",

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: APIFlask
-Version: 2.3.0
+Version: 2.3.2
 Summary: A lightweight web API framework based on Flask and marshmallow-code projects.
 Author-email: Grey Li <withlihui@gmail.com>
 License: MIT
@@ -19,6 +19,7 @@ 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: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content

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

@@ -1253,12 +1253,14 @@ class APIFlask(APIScaffold, Flask):
         if links is not None:
             operation['responses'][status_code]['links'] = links
         if headers_schema is not None:
-            headers = self._ma_plugin.converter.schema2parameters(  # type: ignore
+            header_params = self._ma_plugin.converter.schema2parameters(  # type: ignore
                 headers_schema, location='headers'
             )
-            operation['responses'][status_code]['headers'] = {
-                header['name']: header for header in headers
-            }
+            headers = {header['name']: header for header in header_params}
+            for header in headers.values():
+                header.pop('in', None)
+                header.pop('name', None)
+            operation['responses'][status_code]['headers'] = headers
 
     def _add_response_with_schema(
         self,

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

@@ -6,7 +6,7 @@ from functools import wraps
 
 from flask import current_app
 from flask import jsonify
-from flask import request
+from flask import request as flask_request
 from flask import Response
 from marshmallow import ValidationError as MarshmallowValidationError
 from webargs.flaskparser import FlaskParser as BaseFlaskParser
@@ -55,9 +55,14 @@ class FlaskParser(BaseFlaskParser):
             error_headers,
         )
 
+    def load_location_data(self, schema: Schema, location: str) -> t.Any:
+        """
+        Expose the internal `_load_location_data` method to support loading data without validation
+        """
+        return self._load_location_data(schema=schema, req=flask_request, location=location)
+
 
 parser: FlaskParser = FlaskParser()
-use_args: t.Callable = parser.use_args
 
 
 def _get_files_and_form(request, schema):
@@ -101,46 +106,6 @@ 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].
@@ -338,16 +303,6 @@ 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(
@@ -394,9 +349,20 @@ class APIScaffold:
                     _annotate(f, omit_default_path_parameters=True)
                 # TODO: Support set example for request parameters
                 f._spec['args'].append((schema, location))
-            return use_args(
-                schema, location=location, arg_name=arg_name or f'{location}_data', **kwargs
-            )(f)
+
+            arg_name_val = arg_name or f'{location}_data'
+
+            if not validation:
+
+                @wraps(f)
+                def wrapper(*args: t.Any, **kwargs: t.Any):
+                    location_data = parser.load_location_data(schema=schema, location=location)
+                    kwargs[arg_name_val] = location_data
+                    return f(*args, **kwargs)
+
+                return wrapper
+
+            return parser.use_args(schema, location=location, arg_name=arg_name_val, **kwargs)(f)
 
         return decorator
 

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

@@ -435,117 +435,50 @@ def test_skip_validation(app, client):
     assert no_validated_rv.json['json_data']['name'] == 'Kitty'
     assert no_validated_rv.json['json_data']['category'] == 'unknown'
 
+    rv = client.get('/openapi.json')
+    assert rv.status_code == 200
+    assert (
+        rv.json['paths']['/pets_without_validation/{pet_id}']['patch']['requestBody']['content'][
+            'application/json'
+        ]['schema']['$ref']
+        == '#/components/schemas/PetIn'
+    )
+    assert 'PetIn' in rv.json['components']['schemas']
 
-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}
+
+@pytest.mark.parametrize('validation', [True, False])
+@pytest.mark.parametrize('payload', [[], [{'bar': 'baz'}], [{'qux': 'baz'}]])
+def test_skip_validation_list_input(app, client, validation, payload):
+    class FooIn(Schema):
+        bar = String(required=True)
+
+    @app.put('/foo/bulk')
+    @app.input(FooIn(many=True), validation=validation)
+    def bulk_put_foo(json_data):
+        return json_data
+
+    rv = client.put('/foo/bulk', json=payload)
+    if validation and payload and 'bar' not in payload[0]:
+        assert rv.status_code == 422
+    else:
+        assert rv.status_code == 200
+        assert rv.json == payload
+
+
+@pytest.mark.parametrize('validation', [True, False])
+@pytest.mark.parametrize('payload', [{}, {'bar': 'qux'}])
+def test_skip_validation_arg_name(app, client, validation, payload):
+    class FooIn(Schema):
+        bar = String(required=True)
+
+    @app.post('/foo')
+    @app.input(FooIn, arg_name='baz', validation=validation)
+    def post_foo(baz):
+        return baz
+
+    rv = client.post('/foo', json=payload)
+    if validation and not payload:
+        assert rv.status_code == 422
+    else:
+        assert rv.status_code == 200
+        assert rv.json == payload

{apiflask-2.3.0 → apiflask-2.3.2}/tests/test_openapi_headers.py

@@ -1,3 +1,6 @@
+import openapi_spec_validator as osv
+import pytest
+
 from .schemas import Foo
 from .schemas import ResponseHeader
 from apiflask.fields import Boolean
@@ -25,36 +28,26 @@ def test_spec_with_dict_headers(app, client):
     rv = client.get('/openapi.json')
     assert rv.json['paths']['/foo']['get']['responses']['200']['headers'] == {
         'X-boolean': {
-            'name': 'X-boolean',
-            'in': 'header',
             'description': 'A boolean header',
             'required': False,
             'schema': {'type': 'boolean'},
         },
         'X-integer': {
-            'name': 'X-integer',
-            'in': 'header',
             'description': 'An integer header',
             'required': False,
             'schema': {'type': 'integer'},
         },
         'X-number': {
-            'name': 'X-number',
-            'in': 'header',
             'description': 'A number header',
             'required': False,
             'schema': {'type': 'number'},
         },
         'X-string': {
-            'name': 'X-string',
-            'in': 'header',
             'description': 'A string header',
             'required': False,
             'schema': {'type': 'string'},
         },
         'X-array': {
-            'name': 'X-array',
-            'in': 'header',
             'description': 'An array header',
             'required': False,
             'schema': {'items': {'type': 'string'}, 'type': 'array'},
@@ -83,10 +76,22 @@ def test_spec_with_schema_headers(app, client):
     rv = client.get('/openapi.json')
     assert rv.json['paths']['/foo']['get']['responses']['200']['headers'] == {
         'X-Token': {
-            'name': 'X-Token',
-            'in': 'header',
             'description': 'A custom token header',
             'required': True,
             'schema': {'type': 'string'},
         },
     }
+
+
+@pytest.mark.parametrize('openapi_version', ['3.0.0', '3.1.0'])
+def test_spec_validity_with_headers(app, client, openapi_version):
+    app.config['OPENAPI_VERSION'] = openapi_version
+
+    @app.route('/foo')
+    @app.output(Foo, headers=ResponseHeader)
+    def foo():
+        pass
+
+    rv = client.get('/openapi.json')
+    assert rv.status_code == 200
+    osv.validate(rv.json)