ul-api-utils 7.8.7__py3-none-any.whl → 7.9.0__py3-none-any.whl

ul_api_utils/commands/cmd_generate_api_docs.py

@@ -1,12 +1,12 @@
 import argparse
 import ast
+import csv
 import importlib
 import inspect
 import os
 import logging
 from datetime import datetime
-from typing import Dict, Callable, Any, List, TextIO
-
+from typing import Dict, Callable, Any, List, TextIO, Set
 from flask import url_for, Flask
 from ul_py_tool.commands.cmd import Cmd
 
@@ -20,11 +20,13 @@ class CmdGenApiFunctionDocumentation(Cmd):
     db_dir: str
     include_api_utils_doc: bool
     include_db_utils_doc: bool
+    app_host: str
 
     @staticmethod
     def add_parser_args(parser: argparse.ArgumentParser) -> None:
         parser.add_argument('--api-dir', dest='api_dir', type=str, required=True)
         parser.add_argument('--db-dir', dest='db_dir', type=str, required=True)
+        parser.add_argument('--app-host', dest='app_host', type=str, required=False, default="{baseUrl}")
         parser.add_argument('--include-utils-api', dest='include_api_utils_doc', type=bool, required=False, default=False)
         parser.add_argument('--include-utils-db', dest='include_db_utils_doc', type=bool, required=False, default=False)
 
@@ -45,27 +47,41 @@ class CmdGenApiFunctionDocumentation(Cmd):
         db_helper_functions = self.load_functions(f'{self.db_dir}/models_manager')
         db_utils_functions = self.load_functions(f"{self.db_dir}/utils")
         with current_app.app_context():
-            current_app.config['SERVER_NAME'] = '{base_url}'
-        with current_app.app_context(), open(f'.tmp/api_doc_{datetime.now().isoformat()}.md', 'w') as file:
-            for api_route_id, flask_api_rule in enumerate(current_app.url_map.iter_rules()):
-                options = {}
-                for arg in flask_api_rule.arguments:
-                    options[arg] = "[{0}]".format(arg)
-                api_route_methods = ','.join([method for method in flask_api_rule.methods if method not in ('HEAD', 'OPTIONS')])  # type: ignore
-                api_route_path = url_for(flask_api_rule.endpoint, **options).replace('%5B', '[').replace('%5D', ']')
-                func_object = current_app.view_functions[flask_api_rule.endpoint]
-                if not func_object.__module__.startswith(self.api_module):
-                    continue
-                self.generate_documentation(
-                    func_object,
-                    file,
-                    api_route_id=api_route_id,
-                    api_route_path=api_route_path,
-                    api_route_methods=api_route_methods,
-                    loaded_db_helper_functions=db_helper_functions,
-                    loaded_api_utils_functions=api_utils_functions,
-                    loaded_db_utils_functions=db_utils_functions,
-                )
+            current_app.config['SERVER_NAME'] = self.app_host
+        csv_data: List[Dict[str, str]] = []
+        with current_app.app_context():
+            now = datetime.now().isoformat()
+            filename = f'.tmp/{now}-doc.md'
+            with open(filename, 'w') as file:
+                for api_route_id, flask_api_rule in enumerate(current_app.url_map.iter_rules()):
+                    options = {}
+                    for arg in flask_api_rule.arguments:
+                        options[arg] = "[{0}]".format(arg)
+                    api_route_methods = ','.join([method for method in flask_api_rule.methods if method not in ('HEAD', 'OPTIONS')])  # type: ignore
+                    api_route_path = url_for(flask_api_rule.endpoint, **options).replace('%5B', '[').replace('%5D', ']')
+                    func_object = current_app.view_functions[flask_api_rule.endpoint]
+                    if not func_object.__module__.startswith(self.api_module):
+                        continue
+                    csv_data.append({
+                        "api_path": api_route_path,
+                        "api_methods": api_route_methods,
+                        "api_function_name": func_object.__name__,
+                    })
+                    self.generate_documentation(
+                        func_object,
+                        file,
+                        api_route_id=api_route_id,
+                        api_route_path=api_route_path,
+                        api_route_methods=api_route_methods,
+                        loaded_db_helper_functions=db_helper_functions,
+                        loaded_api_utils_functions=api_utils_functions,
+                        loaded_db_utils_functions=db_utils_functions,
+                    )
+        with open(f'.tmp/{now}-doc.csv', 'w') as csvfile:
+            fields = ['api_path', 'api_methods', 'api_function_name']
+            writer = csv.DictWriter(csvfile, fieldnames=fields)
+            writer.writeheader()
+            writer.writerows(csv_data)
 
     @staticmethod
     def load_functions(directory: str) -> Dict[str, Callable[..., Any]]:

{ul_api_utils-7.8.7.dist-info → ul_api_utils-7.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-api-utils
-Version: 7.8.7
+Version: 7.9.0
 Summary: Python api utils
 Author: Unic-lab
 Author-email: 

{ul_api_utils-7.8.7.dist-info → ul_api_utils-7.9.0.dist-info}/RECORD

@@ -33,7 +33,7 @@ ul_api_utils/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 ul_api_utils/commands/cmd_enc_keys.py,sha256=-Tblh6lI7G6M5YVwbVQqZmXhBMiIpB3a7b0Lv1MFufk,8453
 ul_api_utils/commands/cmd_gen_api_user_token.py,sha256=Vg7oEYHvof7DSLat9yJ_k5AYL9ZOC4Jvd38DBn5U-R0,2730
 ul_api_utils/commands/cmd_gen_new_api_user.py,sha256=ICZbKqz2D6DRvjwtNM08rNjIlWN3qClcUQw5L8FxRBY,4549
-ul_api_utils/commands/cmd_generate_api_docs.py,sha256=t4wIVN6cdQLN7FX7_RWxGy0D8tUSe4bs2_HNVdLrwKk,8788
+ul_api_utils/commands/cmd_generate_api_docs.py,sha256=cEBUOkn8iQIir78yXzHK_gy_hna2cP58x8N5DzCeZEA,9617
 ul_api_utils/commands/cmd_start.py,sha256=aMz6o6HBzLxWrNpV2_rayQ7Nb-VX3-DHgzOUk39R7NA,3623
 ul_api_utils/commands/cmd_worker_start.py,sha256=1tt4_mL8T8_q7i1bqnfjPSkSYlRNNNp8eJ-5rTYj36w,2593
 ul_api_utils/commands/start/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -135,9 +135,9 @@ ul_api_utils/validators/validate_empty_object.py,sha256=3Ck_iwyJE_M5e7l6s1i88aqb
 ul_api_utils/validators/validate_uuid.py,sha256=EfvlRirv2EW0Z6w3s8E8rUa9GaI8qXZkBWhnPs8NFrA,257
 ul_api_utils/validators/__tests__/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ul_api_utils/validators/__tests__/test_custom_fields.py,sha256=QLZ7DFta01Z7DOK9Z5Iq4uf_CmvDkVReis-GAl_QN48,1447
-ul_api_utils-7.8.7.dist-info/LICENSE,sha256=6Qo8OdcqI8aGrswJKJYhST-bYqxVQBQ3ujKdTSdq-80,1062
-ul_api_utils-7.8.7.dist-info/METADATA,sha256=FQg9L90kCARNwhkLhbOoByS6PZZfI4uGpK8ItUG3R4Q,14671
-ul_api_utils-7.8.7.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-ul_api_utils-7.8.7.dist-info/entry_points.txt,sha256=8tL3ySHWTyJMuV1hx1fHfN8zumDVOCOm63w3StphkXg,53
-ul_api_utils-7.8.7.dist-info/top_level.txt,sha256=1XsW8iOSFaH4LOzDcnNyxHpHrbKU3fSn-aIAxe04jmw,21
-ul_api_utils-7.8.7.dist-info/RECORD,,
+ul_api_utils-7.9.0.dist-info/LICENSE,sha256=6Qo8OdcqI8aGrswJKJYhST-bYqxVQBQ3ujKdTSdq-80,1062
+ul_api_utils-7.9.0.dist-info/METADATA,sha256=eC9Hz_VF7dWCNKiXCMuO8VHqEs31pOTrADzM3UK90lQ,14671
+ul_api_utils-7.9.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+ul_api_utils-7.9.0.dist-info/entry_points.txt,sha256=8tL3ySHWTyJMuV1hx1fHfN8zumDVOCOm63w3StphkXg,53
+ul_api_utils-7.9.0.dist-info/top_level.txt,sha256=1XsW8iOSFaH4LOzDcnNyxHpHrbKU3fSn-aIAxe04jmw,21
+ul_api_utils-7.9.0.dist-info/RECORD,,