Merge branch 'master' into hide-options

Author: sloria

.travis.yml

@@ -2,8 +2,6 @@ language: python
 cache: pip
 sudo: false
 env:
-- APISPEC_VERSION="==0.39.0"
-- APISPEC_VERSION=""
 - MARSHMALLOW_VERSION="==2.13.0"
 - MARSHMALLOW_VERSION=""
 python:
@@ -15,7 +13,6 @@ before_install:
 install:
 - travis_retry pip install -U .
 - travis_retry pip install -U -r dev-requirements.txt
-- travis_retry pip install -U --pre apispec"$APISPEC_VERSION"
 - travis_retry pip install -U --pre marshmallow"$MARSHMALLOW_VERSION"
 before_script:
 - flake8 flask_apispec
@@ -29,7 +26,7 @@ jobs:
     env: []
     # Override install, and script to no-ops
     before_install: true
-    install: 
+    install:
     - travis_retry pip install -U .
     - travis_retry pip install -r dev-requirements.txt
     before_script: true

CHANGELOG.rst

@@ -1,6 +1,84 @@
 Changelog
 ---------
 
+0.8.8 (2020-03-29)
+******************
+
+Bug fixes:
+
+* Fix behavior when view returns ``(obj, status_code, headers)``
+  (regression in 0.8.7) (:issue:`181`).
+  Thanks :user:`decaz` for reporting and thanks :user:`c-kruse`
+  for the PR.
+
+0.8.7 (2020-03-10)
+******************
+
+Bug fixes:
+
+* Fix serialisation problem with return codes when used with flask-restful  (:issue:`98`, :issue:`93`).
+  Thanks :user:`AdamLeyshon` for the PR.
+
+0.8.6 (2020-03-01)
+******************
+
+Bug fixes:
+
+* Restrict webargs version to <6.0 (:issue:`176`).
+  Thanks :user:`c-kruse` for reporting and thanks :user:`saydamir`
+  for the PR.
+
+0.8.5 (2020-01-05)
+******************
+
+Bug fixes:
+
+* Fix setting ``default_in`` for compatibility with newer versions of apispec (:pr:`173`).
+  Thanks :user:`AbdealiJK` for the PR.
+
+0.8.4 (2019-12-04)
+******************
+
+Bug fixes:
+
+* Fix passing ``default_in`` argument when generating parameters (:issue:`165`).
+  Thanks :user:`d42` for reporting and thanks :user:`zzz4zzz` for the fix.
+
+0.8.3 (2019-09-17)
+******************
+
+Bug fixes:
+
+* Fix compatibility with apispec>=3.0.0 (:issue:`163`).
+  Thanks :user:`decaz`.
+
+0.8.2 (2019-09-16)
+******************
+
+Bug fixes:
+
+* Handle multiple locations when using use_kwargs multiple times on the same view (:issue:`78`).
+  Thanks :user:`norbert-sebok` for the PR and thanks :user:`shrsubra` for updating it.
+
+0.8.1 (2019-06-22)
+******************
+
+Bug fixes:
+
+* Fix support for ``@post_load`` methods that return a non-dictionary object
+  (:issue:`103`). Thanks :user:`erezatiya` for reporting and thanks :user:`elatomo`
+  for the PR.
+* Restrict marshmallow version based on Python version (:pr:`150`).
+
+0.8.0 (2019-02-13)
+******************
+
+Features:
+
+* Supports apispec>=1.0.0 (:issue:`130`). Older apispec versions are no longer supported.
+  Thanks :user:`DStape` for the PR.
+* Upgrade swagger-ui to version 3.20.7.
+
 0.7.0 (2018-07-01)
 ++++++++++++++++++
 

README.rst

@@ -35,7 +35,8 @@ Quickstart
     from flask import Flask
     from flask_apispec import use_kwargs, marshal_with
 
-    from marshmallow import fields, Schema
+    from marshmallow import Schema
+    from webargs import fields
 
     from .models import Pet
 

flask_apispec/__init__.py

@@ -4,7 +4,7 @@
 from flask_apispec.extension import FlaskApiSpec
 from flask_apispec.utils import Ref
 
-__version__ = '0.7.0'
+__version__ = '0.8.8'
 __all__ = [
     'doc',
     'wrap_with',

flask_apispec/apidoc.py

@@ -4,6 +4,7 @@
 
 import six
 
+import apispec
 from apispec.core import VALID_METHODS
 from apispec.ext.marshmallow import MarshmallowPlugin
 
@@ -13,6 +14,10 @@
 from flask_apispec.paths import rule_to_path, rule_to_params
 from flask_apispec.utils import resolve_resource, resolve_annotations, merge_recursive
 
+APISPEC_VERSION_INFO = tuple(
+    [int(part) for part in apispec.__version__.split('.') if part.isdigit()]
+)
+
 class Converter(object):
 
     def __init__(self, app, spec, document_options=True):
@@ -40,6 +45,7 @@ def convert(self, target, endpoint=None, blueprint=None, **kwargs):
     def get_path(self, rule, target, **kwargs):
         operations = self.get_operations(rule, target)
         parent = self.get_parent(target, **kwargs)
+        valid_methods = VALID_METHODS[self.spec.openapi_version.major]
         excluded_methods = {'head'}
         if not self.document_options:
             excluded_methods.add('options')
@@ -49,7 +55,7 @@ def get_path(self, rule, target, **kwargs):
             'operations': {
                 method.lower(): self.get_operation(rule, view, parent=parent)
                 for method, view in six.iteritems(operations)
-                if method.lower() in (set(VALID_METHODS) - excluded_methods)
+                if method.lower() in (set(valid_methods) - excluded_methods)
             },
         }
 
@@ -70,28 +76,33 @@ def get_parent(self, view):
         return None
 
     def get_parameters(self, rule, view, docs, parent=None):
-        openapi = self.marshmallow_plugin.openapi
+        if APISPEC_VERSION_INFO[0] < 3:
+            openapi = self.marshmallow_plugin.openapi
+        else:
+            openapi = self.marshmallow_plugin.converter
         annotation = resolve_annotations(view, 'args', parent)
-        args = merge_recursive(annotation.options)
-        schema = args.get('args', {})
-        if is_instance_or_subclass(schema, Schema):
-            converter = openapi.schema2parameters
-        elif callable(schema):
-            schema = schema(request=None)
+        extra_params = []
+        for args in annotation.options:
+            schema = args.get('args', {})
             if is_instance_or_subclass(schema, Schema):
                 converter = openapi.schema2parameters
+            elif callable(schema):
+                schema = schema(request=None)
+                if is_instance_or_subclass(schema, Schema):
+                    converter = openapi.schema2parameters
+                else:
+                    converter = openapi.fields2parameters
             else:
                 converter = openapi.fields2parameters
-        else:
-            converter = openapi.fields2parameters
-        options = copy.copy(args.get('kwargs', {}))
-        locations = options.pop('locations', None)
-        if locations:
-            options['default_in'] = locations[0]
-        options['spec'] = self.app.config.get('APISPEC_SPEC', None)
+            options = copy.copy(args.get('kwargs', {}))
+            locations = options.pop('locations', None)
+            if locations:
+                options['default_in'] = locations[0]
+            elif 'default_in' not in options:
+                options['default_in'] = 'body'
+            extra_params += converter(schema, **options) if args else []
 
         rule_params = rule_to_params(rule, docs.get('params')) or []
-        extra_params = converter(schema, **options) if args else []
 
         return extra_params + rule_params
 

flask_apispec/extension.py

@@ -21,6 +21,7 @@ class FlaskApiSpec(object):
             'APISPEC_SPEC': APISpec(
                 title='pets',
                 version='v1',
+                openapi_version='2.0',
                 plugins=[MarshmallowPlugin()],
             ),
             'APISPEC_SWAGGER_URL': '/swagger/',
@@ -54,7 +55,8 @@ def init_app(self, app):
         self.app = app
         self.spec = self.app.config.get('APISPEC_SPEC') or \
                     make_apispec(self.app.config.get('APISPEC_TITLE', 'flask-apispec'),
-                                 self.app.config.get('APISPEC_VERSION', 'v1'))
+                                 self.app.config.get('APISPEC_VERSION', 'v1'),
+                                 self.app.config.get('APISPEC_OAS_VERSION', '2.0'))
         self.add_swagger_routes()
         self.resource_converter = ResourceConverter(self.app,
                                                     self.spec,
@@ -148,12 +150,13 @@ def _register(self, target, endpoint=None, blueprint=None,
         else:
             raise TypeError()
         for path in paths:
-            self.spec.add_path(**path)
+            self.spec.path(**path)
 
 
-def make_apispec(title='flask-apispec', version='v1'):
+def make_apispec(title='flask-apispec', version='v1', openapi_version='2.0'):
     return APISpec(
         title=title,
         version=version,
+        openapi_version=openapi_version,
         plugins=[MarshmallowPlugin()],
     )

flask_apispec/wrapper.py

@@ -1,26 +1,30 @@
 # -*- coding: utf-8 -*-
+from flask import Response
 
-from six.moves import http_client as http
+try:
+    from collections.abc import Mapping
+except ImportError:  # Python 2
+    from collections import Mapping
 
 import flask
-
+import marshmallow as ma
 import werkzeug
 from webargs import flaskparser
 
 from flask_apispec import utils
 
-import marshmallow as ma
-
 MARSHMALLOW_VERSION_INFO = tuple(
     [int(part) for part in ma.__version__.split('.') if part.isdigit()]
 )
 
+
 class Wrapper(object):
     """Apply annotations to a view function.
 
     :param func: View function to wrap
     :param instance: Optional instance or parent
     """
+
     def __init__(self, func, instance=None):
         self.func = func
         self.instance = instance
@@ -29,9 +33,10 @@ def __call__(self, *args, **kwargs):
         response = self.call_view(*args, **kwargs)
         if isinstance(response, werkzeug.Response):
             return response
-        unpacked = unpack(response)
-        status_code = unpacked[1] or http.OK
-        return self.marshal_result(unpacked, status_code)
+        rv, status_code, headers = unpack(response)
+        mv = self.marshal_result(rv, status_code)
+        response = packed(mv, status_code, headers)
+        return flask.current_app.make_response(response)
 
     def call_view(self, *args, **kwargs):
         config = flask.current_app.config
@@ -43,32 +48,55 @@ def call_view(self, *args, **kwargs):
                 parsed = parser.parse(schema, locations=option['kwargs']['locations'])
                 if getattr(schema, 'many', False):
                     args += tuple(parsed)
-                else:
+                elif isinstance(parsed, Mapping):
                     kwargs.update(parsed)
+                else:
+                    args += (parsed,)
+
         return self.func(*args, **kwargs)
 
-    def marshal_result(self, unpacked, status_code):
+    def marshal_result(self, result, status_code):
         config = flask.current_app.config
         format_response = config.get('APISPEC_FORMAT_RESPONSE', flask.jsonify) or identity
         annotation = utils.resolve_annotations(self.func, 'schemas', self.instance)
         schemas = utils.merge_recursive(annotation.options)
         schema = schemas.get(status_code, schemas.get('default'))
         if schema and annotation.apply is not False:
             schema = utils.resolve_schema(schema['schema'], request=flask.request)
-            dumped = schema.dump(unpacked[0])
+            dumped = schema.dump(result)
             output = dumped.data if MARSHMALLOW_VERSION_INFO[0] < 3 else dumped
         else:
-            output = unpacked[0]
-        return format_output((format_response(output), ) + unpacked[1:])
+            output = result
+
+        return format_response(output)  # type: Response
+
 
 def identity(value):
     return value
 
+
 def unpack(resp):
-    resp = resp if isinstance(resp, tuple) else (resp, )
-    return resp + (None, ) * (3 - len(resp))
+    data = headers = None
+    status_code = 200
+    if isinstance(resp, tuple):
+        data = resp[0]
+        len_resp = len(resp)
+        if len_resp == 3:
+            status_code, headers = resp[1:]
+        elif len_resp == 2:
+            if isinstance(resp[1], (werkzeug.datastructures.Headers, dict, tuple, list)):
+                headers = resp[1]
+            else:
+                status_code = resp[1]
+    else:
+        data = resp
+    return data, status_code, headers
+
 
-def format_output(values):
-    while values[-1] is None:
-        values = values[:-1]
-    return values if len(values) > 1 else values[0]
+def packed(data, status_code, headers):
+    resp = (data, )
+    if status_code:
+        resp += (status_code, )
+    if headers:
+        resp += (headers, )
+    return resp

package-lock.json

@@ -2,7 +2,7 @@
   "name": "flask-apispec",
   "version": "0.7.0",
   "dependencies": {
-    "swagger-ui-dist": "3.17.2"
+    "swagger-ui-dist": "3.20.7"
   },
   "repository": {
     "type": "git",

package.json

@@ -10,5 +10,5 @@ universal=1
 # E301: expected 1 blank line, found 1
 # E302: expected 2 blank lines, found 0
 [flake8]
-ignore = E127,E128,E265,E301,E302
+ignore = E127,E128,E265,E301,E302,W504
 max-line-length = 90