format files

Author: katerinatiddy

ci/scripts/increment_version.py

@@ -1,28 +1,28 @@
 import os
 
 REPO_ROOT = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
-EXISTING_VERSION_DEF_LOCATION = os.path.join(REPO_ROOT, 'src/flask_openapi/__init__.py')
+EXISTING_VERSION_DEF_LOCATION = os.path.join(REPO_ROOT, "src/flask_openapi/__init__.py")
 
 
 def main() -> None:
-    read_file = ''
+    read_file = ""
 
-    with open(EXISTING_VERSION_DEF_LOCATION, 'r') as file:
+    with open(EXISTING_VERSION_DEF_LOCATION, "r") as file:
         for line in file.readlines():
-            if '__version__' in line:
+            if "__version__" in line:
                 read_file = line
 
     version = read_file.split("= '")[1]
-    parts = version.split('.')
+    parts = version.split(".")
 
     major = int(parts[0])
     minor = int(parts[1])
     patch = int(parts[2].split("'")[0])
 
     minor = minor + 1
 
-    print(f'{major}.{minor}.{patch}')
+    print(f"{major}.{minor}.{patch}")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

ci/tests/conftest.py

@@ -9,7 +9,7 @@
 from flask_openapi.utils import is_python_file, remove_suffix
 
 REPO_ROOT = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
-TEST_SUITE = os.path.join(REPO_ROOT, 'ci/tests/suite')
+TEST_SUITE = os.path.join(REPO_ROOT, "ci/tests/suite")
 
 
 def get_specs_data(mod):
@@ -21,31 +21,31 @@ def get_specs_data(mod):
     # init swag if not yet inititalized (no-routes example)
     specs_route = None
     specs_data = {}
-    if getattr(mod.app, 'swag', None) is None:
+    if getattr(mod.app, "swag", None) is None:
         _swag = Swagger()
-        _swag.config['endpoint'] = str(random.randint(1, 5000))
+        _swag.config["endpoint"] = str(random.randint(1, 5000))
         _swag.init_app(mod.app)
     # get all the specs defined for the example app
     else:
         try:
             flasgger_config = mod.swag.config
 
-            if flasgger_config.get('swagger_ui') is False:
+            if flasgger_config.get("swagger_ui") is False:
                 return specs_data
 
-            specs_route = flasgger_config.get('specs_route', '/apidocs/')
+            specs_route = flasgger_config.get("specs_route", "/apidocs/")
         except AttributeError:
             pass
 
     if specs_route is None:
-        specs_route = '/apidocs/'
+        specs_route = "/apidocs/"
 
-    apidocs = client.get('?'.join((specs_route, 'json=true')))
-    specs = json.loads(apidocs.data.decode("utf-8")).get('specs')
+    apidocs = client.get("?".join((specs_route, "json=true")))
+    specs = json.loads(apidocs.data.decode("utf-8")).get("specs")
 
     for spec in specs:
         # for each spec get the spec url
-        url = spec['url']
+        url = spec["url"]
         response = client.get(url)
         decoded = response.data.decode("utf-8")
         print(mod)
@@ -65,11 +65,8 @@ def get_examples(examples_dir=TEST_SUITE):  # pragma: no cover
     all_files = os.listdir(examples_dir)
     python_files = [f for f in all_files if is_python_file(f)]
     basenames = [remove_suffix(f) for f in python_files]
-    modules = [import_module(f'suite.{module}') for module in basenames]
-    return [
-        module for module in modules
-        if getattr(module, 'app', None) is not None
-    ]
+    modules = [import_module(f"suite.{module}") for module in basenames]
+    return [module for module in modules if getattr(module, "app", None) is not None]
 
 
 def get_test_metadata(mod):
@@ -82,10 +79,12 @@ def get_test_metadata(mod):
     Example: '_TEST_META_SKIP_FULL_VALIDATION' -> 'skip_full_validation'
     """
 
-    test_metadata_prefix = '_TEST_META_'
-    return {key[len(test_metadata_prefix):].lower(): getattr(mod, key)
-            for key in mod.__dict__
-            if key.startswith(test_metadata_prefix)}
+    test_metadata_prefix = "_TEST_META_"
+    return {
+        key[len(test_metadata_prefix) :].lower(): getattr(mod, key)
+        for key in mod.__dict__
+        if key.startswith(test_metadata_prefix)
+    }
 
 
 def pytest_generate_tests(metafunc):
@@ -94,18 +93,13 @@ def pytest_generate_tests(metafunc):
     to generate one test for each examples/
     """
 
-    if 'test_data' in metafunc.fixturenames:
+    if "test_data" in metafunc.fixturenames:
         test_data = [
-            (mod, mod.app.test_client(),
-             get_specs_data(mod), get_test_metadata(mod))
+            (mod, mod.app.test_client(), get_specs_data(mod), get_test_metadata(mod))
             for mod in get_examples()
         ]
 
-        metafunc.parametrize(
-            'test_data',
-            test_data,
-            ids=lambda x: x[0].__name__
-        )
+        metafunc.parametrize("test_data", test_data, ids=lambda x: x[0].__name__)
 
 
 @pytest.fixture(scope="function")

ci/tests/suite/test_base_model_view.py

@@ -16,7 +16,6 @@ class ModelAPIView(BaseAPIView):
 
 
 class PostAPIView(ModelAPIView):
-
     def get(self, team_id):
         """
         Get a list of users
@@ -57,7 +56,7 @@ def get(self, team_id):
             "users": [
                 {"name": "Steven Wilson", "team": team_id},
                 {"name": "Mikael Akerfeldt", "team": team_id},
-                {"name": "Daniel Gildenlow", "team": team_id}
+                {"name": "Daniel Gildenlow", "team": team_id},
             ]
         }
         return jsonify(data)
@@ -67,9 +66,7 @@ def get(self, team_id):
 swag = Swagger(app)
 
 app.add_url_rule(
-    '/user/<team_id>',
-    view_func=PostAPIView.as_view('user'),
-    methods=['GET']
+    "/user/<team_id>", view_func=PostAPIView.as_view("user"), methods=["GET"]
 )
 
 if __name__ == "__main__":

ci/tests/suite/test_basic_auth.py

@@ -15,6 +15,7 @@
 
 from flask_openapi import Swagger
 
+
 def requires_basic_auth(f):
     """Decorator to require HTTP Basic Auth for your endpoint."""
 
@@ -23,7 +24,8 @@ def check_auth(username, password):
 
     def authenticate():
         return Response(
-            "Authentication required.", 401,
+            "Authentication required.",
+            401,
             {"WWW-Authenticate": "Basic realm='Login Required'"},
         )
 
@@ -44,13 +46,15 @@ def decorated(*args, **kwargs):
 
     return decorated
 
+
 app = Flask(__name__)
 app.config["SWAGGER"] = {
     "title": "Swagger Basic Auth App",
     "uiversion": 2,
 }
-swag = Swagger(app,
-    decorators=[ requires_basic_auth ],
+swag = Swagger(
+    app,
+    decorators=[requires_basic_auth],
     template={
         "swagger": "2.0",
         "info": {
@@ -66,6 +70,7 @@ def decorated(*args, **kwargs):
     },
 )
 
+
 @app.route("/echo/<name>", methods=["GET", "POST"])
 def echo(name):
     """
@@ -110,9 +115,11 @@ def echo(name):
     }
     return jsonify(data)
 
+
 @app.route("/")
 def index():
     return redirect("/apidocs")
 
+
 if __name__ == "__main__":
     app.run(debug=True)

ci/tests/suite/test_callbacks.py

@@ -7,14 +7,11 @@
 from flask_openapi import Swagger
 
 app = Flask(__name__)
-app.config['SWAGGER'] = {
-    'title': 'OA3 Callbacks',
-    'openapi': '3.0.2'
-}
+app.config["SWAGGER"] = {"title": "OA3 Callbacks", "openapi": "3.0.2"}
 Swagger(app)
 
 
-@app.route('/run_callback/',  methods=['POST'])
+@app.route("/run_callback/", methods=["POST"])
 def run_callback():
     """Example endpoint that specifies OA3 callbacks
     This is using docstring for specifications
@@ -46,7 +43,7 @@ def run_callback():
                           type: string
     """
 
-    return jsonify({'result': 'ok'})
+    return jsonify({"result": "ok"})
 
 
 def test_swag(client, specs_data):
@@ -55,12 +52,11 @@ def test_swag(client, specs_data):
     :param specs_data: {'url': {swag_specs}} for every spec in app
     """
     for url, spec in specs_data.items():
-        assert 'openapi' in spec
-        assert spec['openapi'] == '3.0.2'
+        assert "openapi" in spec
+        assert spec["openapi"] == "3.0.2"
 
-        assert 'callbacks' in spec['paths']['/run_callback/']['post']
-        assert 'onSomeEvent' in \
-               spec['paths']['/run_callback/']['post']['callbacks']
+        assert "callbacks" in spec["paths"]["/run_callback/"]["post"]
+        assert "onSomeEvent" in spec["paths"]["/run_callback/"]["post"]["callbacks"]
 
 
 if __name__ == "__main__":

ci/tests/suite/test_colors.py

@@ -7,13 +7,11 @@
 from flask_openapi import Swagger
 
 app = Flask(__name__)
-app.config['SWAGGER'] = {
-    'title': 'Colors API'
-}
+app.config["SWAGGER"] = {"title": "Colors API"}
 Swagger(app)
 
 
-@app.route('/colors/<palette>/')
+@app.route("/colors/<palette>/")
 def colors(palette):
     """Example endpoint return a list of colors by palette
     This is using docstring for specifications
@@ -61,10 +59,10 @@ def colors(palette):
           rgb: ['red', 'green', 'blue']
     """
     all_colors = {
-        'cmyk': ['cyan', 'magenta', 'yellow', 'black'],
-        'rgb': ['red', 'green', 'blue']
+        "cmyk": ["cyan", "magenta", "yellow", "black"],
+        "rgb": ["red", "green", "blue"],
     }
-    if palette == 'all':
+    if palette == "all":
         result = all_colors
     else:
         result = {palette: all_colors.get(palette)}
@@ -78,9 +76,9 @@ def test_swag(client, specs_data):
     :param specs_data: {'url': {swag_specs}} for every spec in app
     """
     for url, spec in specs_data.items():
-        assert 'Palette' in spec['definitions']
-        assert 'Color' in spec['definitions']
-        assert 'colors' in spec['paths']['/colors/{palette}/']['get']['tags']
+        assert "Palette" in spec["definitions"]
+        assert "Color" in spec["definitions"]
+        assert "colors" in spec["paths"]["/colors/{palette}/"]["get"]["tags"]
 
 
 if __name__ == "__main__":

ci/tests/suite/test_colors_external_js.py

@@ -7,17 +7,20 @@
 from flask_openapi import Swagger
 
 app = Flask(__name__)
-app.config['SWAGGER'] = {
-    'title': 'Colors API'
-}
+app.config["SWAGGER"] = {"title": "Colors API"}
 swagger_config = Swagger.DEFAULT_CONFIG
-swagger_config['swagger_ui_bundle_js'] = '//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js'
-swagger_config['swagger_ui_standalone_preset_js'] = '//unpkg.com/swagger-ui-dist@3/swagger-ui-standalone-preset.js'
-swagger_config['jquery_js'] = '//unpkg.com/[email protected]/dist/jquery.min.js'
-swagger_config['swagger_ui_css'] = '//unpkg.com/swagger-ui-dist@3/swagger-ui.css'
+swagger_config[
+    "swagger_ui_bundle_js"
+] = "//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js"
+swagger_config[
+    "swagger_ui_standalone_preset_js"
+] = "//unpkg.com/swagger-ui-dist@3/swagger-ui-standalone-preset.js"
+swagger_config["jquery_js"] = "//unpkg.com/[email protected]/dist/jquery.min.js"
+swagger_config["swagger_ui_css"] = "//unpkg.com/swagger-ui-dist@3/swagger-ui.css"
 Swagger(app, config=swagger_config)
 
-@app.route('/colors/<palette>/')
+
+@app.route("/colors/<palette>/")
 def colors(palette):
     """Example endpoint return a list of colors by palette
     This is using docstring for specifications
@@ -65,10 +68,10 @@ def colors(palette):
           rgb: ['red', 'green', 'blue']
     """
     all_colors = {
-        'cmyk': ['cyan', 'magenta', 'yellow', 'black'],
-        'rgb': ['red', 'green', 'blue']
+        "cmyk": ["cyan", "magenta", "yellow", "black"],
+        "rgb": ["red", "green", "blue"],
     }
-    if palette == 'all':
+    if palette == "all":
         result = all_colors
     else:
         result = {palette: all_colors.get(palette)}
@@ -82,9 +85,9 @@ def test_swag(client, specs_data):
     :param specs_data: {'url': {swag_specs}} for every spec in app
     """
     for url, spec in specs_data.items():
-        assert 'Palette' in spec['definitions']
-        assert 'Color' in spec['definitions']
-        assert 'colors' in spec['paths']['/colors/{palette}/']['get']['tags']
+        assert "Palette" in spec["definitions"]
+        assert "Color" in spec["definitions"]
+        assert "colors" in spec["paths"]["/colors/{palette}/"]["get"]["tags"]
 
 
 if __name__ == "__main__":