Bump to webargs 6.0+; drop python 2 and marshmallow 2 compatibility (jmcarp#195)

* Compatibility fix to bump webargs requirement to 6.0+
Breaking change: in use_kwargs replaced locations:tuple with location:str

* Dropped compatibility with python 2

* Bug fix

* Restored tests on multiple schemas
Inputs converted from dict to schemas with Meta.unknown=EXCLUDE

* Bump marshmallow minimum version from 2.0.0 to 3.0.0

* Added a comment to explain the introduction of schemas in unknown = EXCLUDE used during tests

* Run pyupgrade

Co-authored-by: Steven Loria <[email protected]>

Author: 2 people

.travis.yml

@@ -2,10 +2,9 @@ language: python
 cache: pip
 sudo: false
 env:
-- MARSHMALLOW_VERSION="==2.13.0"
+- MARSHMALLOW_VERSION="==3.0.0"
 - MARSHMALLOW_VERSION=""
 python:
-- '2.7'
 - '3.5'
 - '3.6'
 before_install:

docs/conf.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 import datetime as dt
 import os
 import sys
@@ -29,7 +26,7 @@
 source_suffix = '.rst'
 master_doc = 'index'
 project = 'flask-apispec'
-copyright = 'Joshua Carp and contributors {0:%Y}'.format(dt.datetime.utcnow())
+copyright = 'Joshua Carp and contributors {:%Y}'.format(dt.datetime.utcnow())
 
 version = release = flask_apispec.__version__
 

docs/requirements.txt

@@ -2,7 +2,6 @@ sphinx
 sphinx-issues
 sphinx-rtd-theme
 
-six
 flask
 apispec
 webargs

examples/petstore.py

@@ -1,20 +1,20 @@
-# -*- coding: utf-8 -*-
-
-import six
 import marshmallow as ma
 
 from flask_apispec import ResourceMeta, Ref, doc, marshal_with, use_kwargs
 
+
 class Pet:
     def __init__(self, name, type):
         self.name = name
         self.type = type
 
+
 class PetSchema(ma.Schema):
     name = ma.fields.Str()
     type = ma.fields.Str()
 
-class PetResource(six.with_metaclass(ResourceMeta)):
+
+class PetResource(metaclass=ResourceMeta):
     @use_kwargs({
         'category': ma.fields.Str(),
         'name': ma.fields.Str(),
@@ -23,6 +23,7 @@ class PetResource(six.with_metaclass(ResourceMeta)):
     def get(self):
         return Pet('calici', 'cat')
 
+
 class CatResource(PetResource):
     @use_kwargs({'category': ma.fields.Int()})
     @marshal_with(PetSchema(), code=201)
@@ -31,7 +32,7 @@ def get(self):
 
 ###
 
-class CrudResource(six.with_metaclass(ResourceMeta)):
+class CrudResource(metaclass=ResourceMeta):
 
     schema = None
 
@@ -52,6 +53,7 @@ def put(self, id):
     def delete(self, id):
         pass
 
+
 class PetResource(CrudResource):
     schema = PetSchema
 
@@ -77,7 +79,7 @@ def get_pet(pet_id):
 class MethodResourceMeta(ResourceMeta, flask.views.MethodViewType):
     pass
 
-class MethodResource(six.with_metaclass(MethodResourceMeta, flask.views.MethodView)):
+class MethodResource(flask.views.MethodView, metaclass=MethodResourceMeta):
     methods = None
 
 @doc(

flask_apispec/__init__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from flask_apispec.views import ResourceMeta, MethodResource
 from flask_apispec.annotations import doc, wrap_with, use_kwargs, marshal_with
 from flask_apispec.extension import FlaskApiSpec

flask_apispec/annotations.py

@@ -1,11 +1,10 @@
-# -*- coding: utf-8 -*-
-
 import functools
 
 from flask_apispec import utils
 from flask_apispec.wrapper import Wrapper
 
-def use_kwargs(args, locations=None, inherit=None, apply=None, **kwargs):
+
+def use_kwargs(args, location=None, inherit=None, apply=None, **kwargs):
     """Inject keyword arguments from the specified webargs arguments into the
     decorated view function.
 
@@ -22,11 +21,12 @@ def get_pets(**kwargs):
     :param args: Mapping of argument names to :class:`Field <marshmallow.fields.Field>`
         objects, :class:`Schema <marshmallow.Schema>`, or a callable which accepts a
         request and returns a :class:`Schema <marshmallow.Schema>`
-    :param locations: Default request locations to parse
+    :param location: Default request location to parse
     :param inherit: Inherit args from parent classes
     :param apply: Parse request with specified args
     """
-    kwargs.update({'locations': locations})
+
+    kwargs.update({'location': location})
 
     def wrapper(func):
         options = {
@@ -73,6 +73,7 @@ def wrapper(func):
         return activate(func)
     return wrapper
 
+
 def doc(inherit=None, **kwargs):
     """Annotate the decorated view function or class with the specified Swagger
     attributes.
@@ -92,6 +93,7 @@ def wrapper(func):
         return activate(func)
     return wrapper
 
+
 def wrap_with(wrapper_cls):
     """Use a custom `Wrapper` to apply annotations to the decorated function.
 
@@ -102,11 +104,13 @@ def wrapper(func):
         return activate(func)
     return wrapper
 
+
 def annotate(func, key, options, **kwargs):
     annotation = utils.Annotation(options, **kwargs)
     func.__apispec__ = func.__dict__.get('__apispec__', {})
     func.__apispec__.setdefault(key, []).insert(0, annotation)
 
+
 def activate(func):
     if isinstance(func, type) or getattr(func, '__apispec__', {}).get('wrapped'):
         return func

flask_apispec/apidoc.py

@@ -1,9 +1,5 @@
-# -*- coding: utf-8 -*-
-
 import copy
 
-import six
-
 import apispec
 from apispec.core import VALID_METHODS
 from apispec.ext.marshmallow import MarshmallowPlugin
@@ -18,7 +14,7 @@
     [int(part) for part in apispec.__version__.split('.') if part.isdigit()]
 )
 
-class Converter(object):
+class Converter:
 
     def __init__(self, app, spec, document_options=True):
         self.app = app
@@ -54,7 +50,7 @@ def get_path(self, rule, target, **kwargs):
             'path': rule_to_path(rule),
             'operations': {
                 method.lower(): self.get_operation(rule, view, parent=parent)
-                for method, view in six.iteritems(operations)
+                for method, view in operations.items()
                 if method.lower() in (set(valid_methods) - excluded_methods)
             },
         }
@@ -95,9 +91,9 @@ def get_parameters(self, rule, view, docs, parent=None):
             else:
                 converter = openapi.fields2parameters
             options = copy.copy(args.get('kwargs', {}))
-            locations = options.pop('locations', None)
-            if locations:
-                options['default_in'] = locations[0]
+            location = options.pop('location', None)
+            if location:
+                options['default_in'] = location
             elif 'default_in' not in options:
                 options['default_in'] = 'body'
             extra_params += converter(schema, **options) if args else []

flask_apispec/extension.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 import flask
 import functools
 import types
@@ -9,7 +8,7 @@
 from flask_apispec.apidoc import ViewConverter, ResourceConverter
 
 
-class FlaskApiSpec(object):
+class FlaskApiSpec:
     """Flask-apispec extension.
 
     Usage:

flask_apispec/paths.py

@@ -1,11 +1,10 @@
-# -*- coding: utf-8 -*-
-
 import re
 
 import werkzeug.routing
 
 PATH_RE = re.compile(r'<(?:[^:<>]+:)?([^<>]+)>')
 
+
 def rule_to_path(rule):
     return PATH_RE.sub(r'{\1}', rule.rule)
 
@@ -18,6 +17,7 @@ def rule_to_path(rule):
 
 DEFAULT_TYPE = ('string', None)
 
+
 def rule_to_params(rule, overrides=None):
     overrides = (overrides or {})
     result = [

flask_apispec/utils.py

@@ -1,45 +1,45 @@
-# -*- coding: utf-8 -*-
-
 import functools
 
-import six
 import marshmallow as ma
 
+
 def resolve_resource(resource, **kwargs):
     resource_class_args = kwargs.get('resource_class_args') or ()
     resource_class_kwargs = kwargs.get('resource_class_kwargs') or {}
     if isinstance(resource, type):
         return resource(*resource_class_args, **resource_class_kwargs)
     return resource
 
+
 def resolve_schema(schema, request=None):
     if isinstance(schema, type) and issubclass(schema, ma.Schema):
         schema = schema()
     elif callable(schema):
         schema = schema(request)
     return schema
 
-class Ref(object):
+class Ref:
 
     def __init__(self, key):
         self.key = key
 
     def resolve(self, obj):
         return getattr(obj, self.key, None)
 
+
 def resolve_refs(obj, attr):
     if isinstance(attr, dict):
         return {
             key: resolve_refs(obj, value)
-            for key, value in six.iteritems(attr)
+            for key, value in attr.items()
         }
     if isinstance(attr, list):
         return [resolve_refs(obj, value) for value in attr]
     if isinstance(attr, Ref):
         return attr.resolve(obj)
     return attr
 
-class Annotation(object):
+class Annotation:
 
     def __init__(self, options=None, inherit=None, apply=None):
         self.options = options or []