Merge branch 'master' into remove-ossaudit

Author: ziirish

doc/conf.py

@@ -51,8 +51,8 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"Flask-RESTX"
-copyright = u"2020, python-restx Authors"
+project = "Flask-RESTX"
+copyright = "2020, python-restx Authors"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -124,7 +124,11 @@
     "show_related": True,
     "page_width": "1000px",
     "sidebar_width": "260px",
-    "favicons": {64: "favicon-64.png", 128: "favicon-128.png", 196: "favicon-196.png",},
+    "favicons": {
+        64: "favicon-64.png",
+        128: "favicon-128.png",
+        196: "favicon-196.png",
+    },
     "badges": [
         (
             # Gitter.im
@@ -262,8 +266,8 @@
     (
         "index",
         "Flask-RESTX.tex",
-        u"Flask-RESTX Documentation",
-        u"python-restx Authors",
+        "Flask-RESTX Documentation",
+        "python-restx Authors",
         "manual",
     ),
 ]
@@ -294,7 +298,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ("index", "flask-restx", u"Flask-RESTX Documentation", [u"python-restx Authors"], 1)
+    ("index", "flask-restx", "Flask-RESTX Documentation", ["python-restx Authors"], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -310,8 +314,8 @@
     (
         "index",
         "Flask-RESTX",
-        u"Flask-RESTX Documentation",
-        u"python-restx Authors",
+        "Flask-RESTX Documentation",
+        "python-restx Authors",
         "Flask-RESTX",
         "One line description of project.",
         "Miscellaneous",

examples/todo.py

@@ -4,7 +4,12 @@
 
 app = Flask(__name__)
 app.wsgi_app = ProxyFix(app.wsgi_app)
-api = Api(app, version="1.0", title="Todo API", description="A simple TODO API",)
+api = Api(
+    app,
+    version="1.0",
+    title="Todo API",
+    description="A simple TODO API",
+)
 
 ns = api.namespace("todos", description="TODO operations")
 

examples/todo_blueprint.py

@@ -3,7 +3,12 @@
 
 api_v1 = Blueprint("api", __name__, url_prefix="/api/1")
 
-api = Api(api_v1, version="1.0", title="Todo API", description="A simple TODO API",)
+api = Api(
+    api_v1,
+    version="1.0",
+    title="Todo API",
+    description="A simple TODO API",
+)
 
 ns = api.namespace("todos", description="TODO operations")
 

examples/todomvc.py

@@ -4,7 +4,12 @@
 
 app = Flask(__name__)
 app.wsgi_app = ProxyFix(app.wsgi_app)
-api = Api(app, version="1.0", title="TodoMVC API", description="A simple TodoMVC API",)
+api = Api(
+    app,
+    version="1.0",
+    title="TodoMVC API",
+    description="A simple TodoMVC API",
+)
 
 ns = api.namespace("todos", description="TODO operations")
 

examples/xml_representation.py

@@ -21,14 +21,14 @@ def output_xml(data, code, headers=None):
 @api.route("/<string:entry>")
 class Hello(Resource):
     """
-        # you need requests
-        >>> from requests import get
-        >>> get('http://localhost:5000/me').content # default_mediatype
-        '<?xml version="1.0" ?><response><hello>me</hello></response>'
-        >>> get('http://localhost:5000/me', headers={"accept":"application/json"}).content
-        '{"hello": "me"}'
-        >>> get('http://localhost:5000/me', headers={"accept":"application/xml"}).content
-        '<?xml version="1.0" ?><response><hello>me</hello></response>'
+    # you need requests
+    >>> from requests import get
+    >>> get('http://localhost:5000/me').content # default_mediatype
+    '<?xml version="1.0" ?><response><hello>me</hello></response>'
+    >>> get('http://localhost:5000/me', headers={"accept":"application/json"}).content
+    '{"hello": "me"}'
+    >>> get('http://localhost:5000/me', headers={"accept":"application/xml"}).content
+    '<?xml version="1.0" ?><response><hello>me</hello></response>'
     """
 
     @api.doc(model=hello_fields, params={"entry": "The entry to wrap"})

examples/zoo_app/zoo/__init__.py

@@ -3,7 +3,11 @@
 from .cat import api as cat_api
 from .dog import api as dog_api
 
-api = Api(title="Zoo API", version="1.0", description="A simple demo API",)
+api = Api(
+    title="Zoo API",
+    version="1.0",
+    description="A simple demo API",
+)
 
 api.add_namespace(cat_api)
 api.add_namespace(dog_api)

flask_restx/api.py

@@ -17,6 +17,7 @@
 
 from flask import url_for, request, current_app
 from flask import make_response as original_flask_make_response
+
 try:
     from flask.helpers import _endpoint_from_view_func
 except ImportError:
@@ -37,7 +38,7 @@
 
 from werkzeug import __version__ as werkzeug_version
 
-if werkzeug_version.split('.')[0] >= '2':
+if werkzeug_version.split(".")[0] >= "2":
     from werkzeug.wrappers import Response as BaseResponse
 else:
     from werkzeug.wrappers import BaseResponse
@@ -159,10 +160,12 @@ def __init__(
         self._default_error_handler = None
         self.tags = tags or []
 
-        self.error_handlers = OrderedDict({
-            ParseError: mask_parse_error_handler,
-            MaskError: mask_error_handler,
-        })
+        self.error_handlers = OrderedDict(
+            {
+                ParseError: mask_parse_error_handler,
+                MaskError: mask_error_handler,
+            }
+        )
         self._schema = None
         self.models = {}
         self._refresolver = None
@@ -273,11 +276,11 @@ def _init_app(self, app):
 
         # check for deprecated config variable names
         if "ERROR_404_HELP" in app.config:
-            app.config['RESTX_ERROR_404_HELP'] = app.config['ERROR_404_HELP']
+            app.config["RESTX_ERROR_404_HELP"] = app.config["ERROR_404_HELP"]
             warnings.warn(
                 "'ERROR_404_HELP' config setting is deprecated and will be "
                 "removed in the future. Use 'RESTX_ERROR_404_HELP' instead.",
-                DeprecationWarning
+                DeprecationWarning,
             )
 
     def __getattr__(self, name):
@@ -425,7 +428,8 @@ def make_response(self, data, *args, **kwargs):
             kwargs.pop("fallback_mediatype", None) or self.default_mediatype
         )
         mediatype = request.accept_mimetypes.best_match(
-            self.representations, default=default_mediatype,
+            self.representations,
+            default=default_mediatype,
         )
         if mediatype is None:
             raise NotAcceptable()

flask_restx/inputs.py

@@ -523,9 +523,16 @@ def boolean(value):
     elif not value:
         return False
     value = str(value).lower()
-    if value in ("true", "1", "on",):
+    if value in (
+        "true",
+        "1",
+        "on",
+    ):
         return True
-    if value in ("false", "0",):
+    if value in (
+        "false",
+        "0",
+    ):
         return False
     raise ValueError("Invalid literal for boolean(): {0}".format(value))
 

flask_restx/model.py

@@ -171,7 +171,7 @@ def _schema(self):
         }
 
         if self.__strict__:
-            definition['additionalProperties'] = False
+            definition["additionalProperties"] = False
 
         return not_none(definition)
 

flask_restx/resource.py

@@ -5,7 +5,7 @@
 from flask.views import MethodView
 from werkzeug import __version__ as werkzeug_version
 
-if werkzeug_version.split('.')[0] >= '2':
+if werkzeug_version.split(".")[0] >= "2":
     from werkzeug.wrappers import Response as BaseResponse
 else:
     from werkzeug.wrappers import BaseResponse

setup.py

@@ -85,7 +85,11 @@ def pip(filename):
     install_requires=install_requires,
     tests_require=tests_require,
     dev_require=dev_require,
-    extras_require={"test": tests_require, "doc": doc_require, "dev": dev_require,},
+    extras_require={
+        "test": tests_require,
+        "doc": doc_require,
+        "dev": dev_require,
+    },
     license="BSD-3-Clause",
     zip_safe=False,
     keywords="flask restx rest api swagger openapi",

tasks.py

@@ -103,7 +103,10 @@ def demo(ctx):
 def test(ctx, profile=False):
     """Run tests suite"""
     header(test.__doc__)
-    kwargs = build_args("--benchmark-skip", "--profile" if profile else None,)
+    kwargs = build_args(
+        "--benchmark-skip",
+        "--profile" if profile else None,
+    )
     with ctx.cd(ROOT):
         ctx.run("pytest {0}".format(kwargs), pty=True)
 

tests/test_errors.py

@@ -456,7 +456,7 @@ def record(sender, exception):
 
         @api.errorhandler(BadRequest)
         def handle_bad_request(error):
-          return {"message": str(error), "value": "test"}, 400
+            return {"message": str(error), "value": "test"}, 400
 
         got_request_exception.connect(record, app)
         try:
@@ -680,7 +680,7 @@ def test_namespace_errorhandler_with_propagate_true(self, app, client):
         returned to client, even if PROPAGATE_EXCEPTIONS is set."""
         app.config["PROPAGATE_EXCEPTIONS"] = True
         api = restx.Api(app)
-        namespace = restx.Namespace('test_namespace')
+        namespace = restx.Namespace("test_namespace")
         api.add_namespace(namespace)
 
         @namespace.route("/test/", endpoint="test")