style(): Follow PEP8 with consistent formatting (#6)

Author: CuriousLearner

src/create_mock_endpoints.py

@@ -4,49 +4,51 @@
 
 
 def slugify(value):
-    value = unicodedata.normalize('NFKD', value).encode('ascii', 'ignore').decode('ascii')
-    value = re.sub(r'[^\w\s-]', '', value).strip().lower()
-    return re.sub(r'[-\s]+', '_', value)
+    value = (
+        unicodedata.normalize("NFKD", value).encode("ascii", "ignore").decode("ascii")
+    )
+    value = re.sub(r"[^\w\s-]", "", value).strip().lower()
+    return re.sub(r"[-\s]+", "_", value)
 
 
 def generate_code_for_single_mock_api_route(endpoint_data):
-    if not endpoint_data['endpoint'] or not endpoint_data['method']:
-        return ''
-    output_data = "@app.route('" + endpoint_data['endpoint'] + "'"
-    output_data += ", methods=['" + endpoint_data['method'] + "'])\n"
-    output_data += "def " + slugify(endpoint_data['description']) + "():\n"
-    output_data += "    return Response(json.dumps(" + str(
-        json.dumps(endpoint_data['response_body'], sort_keys=True)) + "), "
+    if not endpoint_data["endpoint"] or not endpoint_data["method"]:
+        return ""
+    output_data = "@app.route('" + endpoint_data["endpoint"] + "'"
+    output_data += ", methods=['" + endpoint_data["method"] + "'])\n"
+    output_data += "def " + slugify(endpoint_data["description"]) + "():\n"
+    output_data += (
+        "    return Response(json.dumps("
+        + str(json.dumps(endpoint_data["response_body"], sort_keys=True))
+        + "), "
+    )
     output_data += "mimetype='application/json; charset=utf-8')\n"
     output_data += "\n\n"
     return output_data
 
 
-def create_mock_api_endpoints(json_filename='endpoints_data.json', filename='app.py'):
+def create_mock_api_endpoints(json_filename="endpoints_data.json", filename="app.py"):
     data = None
-    with open(json_filename, 'r') as json_file:
+    with open(json_filename, "r") as json_file:
         data = json.load(json_file)
     generated_code_list = [
-        'import json\n',
-        '\n',
-        'from flask import Flask, Response\n',
-        '\n',
-        'app = Flask(__name__)\n',
-        '\n\n'
+        "import json\n",
+        "\n",
+        "from flask import Flask, Response\n",
+        "\n",
+        "app = Flask(__name__)\n",
+        "\n\n",
     ]
     for endpoint_data in data:
         generated_code_list.append(
             generate_code_for_single_mock_api_route(endpoint_data)
         )
 
-    generated_code_list.extend([
-        'if __name__ == "__main__":\n',
-        '    app.run()'
-    ])
-    with open(filename, 'w') as outfile:
-        outfile.write(''.join(generated_code_list))
+    generated_code_list.extend(['if __name__ == "__main__":\n', "    app.run()"])
+    with open(filename, "w") as outfile:
+        outfile.write("".join(generated_code_list))
         print("Run `python app.py` to host your app")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     create_mock_api_endpoints()

src/serialize_data.py

@@ -1,7 +1,7 @@
 import json
 import click
 
-HTTP_VERBS = ('GET', 'POST', 'HEAD', 'OPTIONS', 'PUT', 'PATCH', 'DELETE')
+HTTP_VERBS = ("GET", "POST", "HEAD", "OPTIONS", "PUT", "PATCH", "DELETE")
 
 
 def get_single_endpoint_detail(lines):
@@ -10,38 +10,42 @@ def get_single_endpoint_detail(lines):
         "method": str(),
         "description": str(),
         "request_body": str(),
-        "response_body": str()
+        "response_body": str(),
     }
     lines_iterator = iter(lines)
     for line in lines_iterator:
-        if not line or line == '```':
+        if not line or line == "```":
             continue
-        if line.startswith('##'):
-            endpoint_details["description"] = line.split('## ')[1]
+        if line.startswith("##"):
+            endpoint_details["description"] = line.split("## ")[1]
             continue
         if line.startswith(HTTP_VERBS):
-            method, endpoint = line.split(' ')[:2]
+            method, endpoint = line.split(" ")[:2]
             endpoint_details["endpoint"] = endpoint
             endpoint_details["method"] = method
             continue
-        if line.startswith('__Example__'):
+        if line.startswith("__Example__"):
             json_data = parse_and_get_json_from_subsequent_lines(lines_iterator)
             try:
                 endpoint_details["request_body"] = json.loads(json_data)
             except ValueError as e:
-                print("Error in parsing request_body of {}: {}".format(
-                    endpoint_details['endpoint'], e)
+                print(
+                    "Error in parsing request_body of {}: {}".format(
+                        endpoint_details["endpoint"], e
+                    )
                 )
                 print("Invalid JSON: {}".format(json_data))
                 return None
             continue
-        if line.startswith('__Response__'):
+        if line.startswith("__Response__"):
             json_data = parse_and_get_json_from_subsequent_lines(lines_iterator)
             try:
                 endpoint_details["response_body"] = json.loads(json_data)
             except ValueError as e:
-                print("Error in parsing response_body of {}: {}".format(
-                    endpoint_details['endpoint'], e)
+                print(
+                    "Error in parsing response_body of {}: {}".format(
+                        endpoint_details["endpoint"], e
+                    )
                 )
                 print("Invalid JSON: {}".format(json_data))
                 return None
@@ -53,31 +57,31 @@ def parse_and_get_json_from_subsequent_lines(lines_iterator):
     try:
         next_line = next(lines_iterator)
     except StopIteration:
-        return ''
-    while next_line != '```json':
+        return ""
+    while next_line != "```json":
         try:
             next_line = next(lines_iterator)
         except StopIteration:
-            return ''
+            return ""
     # Skip the row having starting json tag
     next_line = next(lines_iterator)
     array_of_json_statements = list()
-    while next_line != '```':
+    while next_line != "```":
         array_of_json_statements.append(next_line)
         try:
             next_line = next(lines_iterator)
         except StopIteration:
             pass
 
-    json_statements = ''.join(array_of_json_statements)
+    json_statements = "".join(array_of_json_statements)
     json_statements = json_statements.replace("...", "")
     return json_statements
 
 
 def get_json_from_endpoints(lines):
-    all_lines = lines.split('\n')
+    all_lines = lines.split("\n")
     next_endpoint_starting_location = [
-        i for i, line in enumerate(all_lines) if line.startswith('##')
+        i for i, line in enumerate(all_lines) if line.startswith("##")
     ]
     endpoint_json_list = list()
     for x in range(len(next_endpoint_starting_location)):
@@ -95,16 +99,20 @@ def get_json_from_endpoints(lines):
 
 
 @click.command()
-@click.option('--file-path', default='proposed_endpoints.md', help='Path for the proposed endpoints docs')
+@click.option(
+    "--file-path",
+    default="proposed_endpoints.md",
+    help="Path for the proposed endpoints docs",
+)
 def generate_json_from_docs_file(file_path):
     lines = None
-    with open(file_path, 'r') as endpoint_file:
+    with open(file_path, "r") as endpoint_file:
         lines = endpoint_file.read()
     json_data = get_json_from_endpoints(lines)
 
-    with open('endpoints_data.json', 'w') as json_file:
+    with open("endpoints_data.json", "w") as json_file:
         json.dump(json_data, json_file, indent=4)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     generate_json_from_docs_file()

tests/test_data_serialization.py

@@ -6,32 +6,30 @@
 from src.serialize_data import get_json_from_endpoints
 
 
-@pytest.mark.datafiles(
-    os.path.join(FIXTURE_DIR, 'proposed_endpoints.md'),
-)
+@pytest.mark.datafiles(os.path.join(FIXTURE_DIR, "proposed_endpoints.md"))
 def test_data_serialization(datafiles):
     lines = datafiles.listdir()[0].read()
 
     json_data = json.dumps(get_json_from_endpoints(lines), sort_keys=True)
 
-    expected_json = json.dumps([
-        {
-            "description": "Login to the app",
-            "request_body": {
-                "email": "[email protected]",
-                "password": "123456"
-            },
-            "response_body": {
-                "email": "[email protected]",
-                "last_name": "Doe",
-                "first_name": "John",
-                "auth_token": "qduvpuMvqZUx4Emcpevp.RaGnPgoGZKvGBUHDuivwkvFQowYcwFq.FUGArGvzzfeGe",
-                "phone_number": "+123423423423",
-                "id": "e59d2c4f-ef3f-4455-aa41-c70af8c4e2df"
-            },
-            "endpoint": "/api/users/login",
-            "method": "POST"
-        }
-    ], sort_keys=True)
+    expected_json = json.dumps(
+        [
+            {
+                "description": "Login to the app",
+                "request_body": {"email": "[email protected]", "password": "123456"},
+                "response_body": {
+                    "email": "[email protected]",
+                    "last_name": "Doe",
+                    "first_name": "John",
+                    "auth_token": "qduvpuMvqZUx4Emcpevp.RaGnPgoGZKvGBUHDuivwkvFQowYcwFq.FUGArGvzzfeGe",
+                    "phone_number": "+123423423423",
+                    "id": "e59d2c4f-ef3f-4455-aa41-c70af8c4e2df",
+                },
+                "endpoint": "/api/users/login",
+                "method": "POST",
+            }
+        ],
+        sort_keys=True,
+    )
 
     assert json_data == expected_json

tests/test_mock_endpoint_creation.py

@@ -6,25 +6,21 @@
 from src.create_mock_endpoints import generate_code_for_single_mock_api_route
 
 
-@pytest.mark.datafiles(
-    os.path.join(FIXTURE_DIR, 'endpoints_data.json'),
-)
+@pytest.mark.datafiles(os.path.join(FIXTURE_DIR, "endpoints_data.json"))
 def test_generated_code_from_serialization(datafiles):
     data = datafiles.listdir()[0].read()
 
     json_data = json.loads(data)
     for each_endpoint in json_data:
-        generated_code = generate_code_for_single_mock_api_route(
-            each_endpoint
-        )
+        generated_code = generate_code_for_single_mock_api_route(each_endpoint)
         expected_response = str(
-            u'@app.route(\'/api/users/login\', methods=[\'POST\'])'
-            '\ndef login_to_the_app():\n    return Response('
+            u"@app.route('/api/users/login', methods=['POST'])"
+            "\ndef login_to_the_app():\n    return Response("
             'json.dumps({"auth_token": "qduvpuMvqZUx4Emcpevp.RaGnPgoGZKvGBUHDuiv'
             'wkvFQowYcwFq.FUGArGvzzfeGe", "email": "[email protected]", '
             '"first_name": "John", "id": "e59d2c4f-ef3f-4455-aa41-c70af8c4e2df"'
             ', "last_name": "Doe", "phone_number": "+123423423423"}), '
-            'mimetype=\'application/json; charset=utf-8\')\n\n\n'
+            "mimetype='application/json; charset=utf-8')\n\n\n"
         )
 
         assert generated_code == expected_response

tests/utils.py

@@ -1,7 +1,4 @@
 import os
 
 
-FIXTURE_DIR = os.path.join(
-    os.path.dirname(os.path.realpath(__file__)),
-    'test_files',
-)
+FIXTURE_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)), "test_files")