feat: Add flask-restx support (#48)

michaelbukachi · web-flow · commit 44bb4c207d50 · 2020-02-12T14:07:34.000+01:00
diff --git a/.travis.yml b/.travis.yml
@@ -13,7 +13,7 @@ matrix:
 install:
   # werkzeug 1.0 breaks some parts of Flask ecosystem (see https://github.com/pallets/flask/pull/3488),
   # so let's use older versions at least for now.
-  - pip install coveralls flake8 nose flask flask_restful flask_restplus injector flask_sqlalchemy eventlet typing "werkzeug<1.0"
+  - pip install coveralls flake8 nose flask flask_restful flask_restplus flask_restx injector flask_sqlalchemy eventlet typing "werkzeug<1.0"
   # mypy can't be installed on pypy
   - if [[ "${TRAVIS_PYTHON_VERSION}" != "pypy"* ]] ; then pip install mypy typed_ast ; fi
   - if [[ "${TRAVIS_PYTHON_VERSION}" != "pypy"* && "${TRAVIS_PYTHON_VERSION}" != "3.5"* ]] ; then pip install black ; fi
diff --git a/README.rst b/README.rst
@@ -40,6 +40,7 @@ Flask-Injector lets you inject dependencies into:
 * Jinja environment globals (functions in `app.jinja_env.globals`)
 * Flask-RESTFul Resource constructors
 * Flask-RestPlus Resource constructors
+* Flask-RESTX Resource constructors
 
 Flask-Injector supports defining types using function annotations (Python 3),
 see below.
diff --git a/flask_injector/__init__.py b/flask_injector/__init__.py
@@ -24,6 +24,12 @@
     from flask_restplus.utils import unpack as flask_response_unpack  # noqa
 except ImportError:
     flask_restplus = None
+#
+try:
+    import flask_restx
+    from flask_restx.utils import unpack as flask_response_unpack  # noqa
+except ImportError:
+    flask_restx = None
 
 from injector import Binder, Injector, inject
 from flask import Config, Request
@@ -113,7 +119,11 @@ def wrap_class_based_view(fun: Callable, injector: Injector) -> Callable:
         class_args = fun_closure.get('class_args')
         assert not class_args, 'Class args are not supported, use kwargs instead'
 
-    if flask_restful_api and flask_restplus and isinstance(flask_restful_api, flask_restplus.Api):
+    if (
+        flask_restful_api
+        and (flask_restplus and isinstance(flask_restful_api, flask_restplus.Api))
+        or (flask_restx and isinstance(flask_restful_api, flask_restx.Api))
+    ):
         # This is flask_restplus' add_resource implementation:
         #
         #     def add_resource(self, resource, *urls, **kwargs):
diff --git a/flask_injector/tests.py b/flask_injector/tests.py
@@ -6,6 +6,7 @@
 
 import flask_restful
 import flask_restplus
+import flask_restx
 from eventlet import greenthread
 from injector import __version__ as injector_version, CallableProvider, inject, Scope
 from flask import Blueprint, Flask
@@ -335,6 +336,30 @@ def get(self):
     eq_(data, {'int': 0})
 
 
+def test_flask_restx_integration_works():
+    app = Flask(__name__)
+    api = flask_restx.Api(app)
+
+    class HelloWorld(flask_restx.Resource):
+        @inject
+        def __init__(self, *args, int: int, **kwargs):
+            self._int = int
+            super().__init__(*args, **kwargs)
+
+        @api.doc()
+        def get(self):
+            return {'int': self._int}
+
+    api.add_resource(HelloWorld, '/hello')
+
+    FlaskInjector(app=app)
+
+    client = app.test_client()
+    response = client.get('/hello')
+    data = json.loads(response.data.decode('utf-8'))
+    eq_(data, {'int': 0})
+
+
 def test_request_scope_not_started_before_any_request_made_regression():
     # Version 0.6.1 (patch cacaef6 specifially) broke backwards compatibility in
     # a relatively subtle way. The code used to support RequestScope even in
