drf-to-mkdoc 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

drf_to_mkdoc/management/commands/build_docs.py

@@ -35,22 +35,15 @@ class Command(BaseCommand):
             # Generate the model documentation JSON first
             self.stdout.write("Generating model documentation...")
 
-            try:
-                call_command(
-                    "generate_model_docs", "--pretty"
-                )
-                self.stdout.write(self.style.SUCCESS("Model documentation generated."))
-            except Exception as e:
-                self.stdout.write(self.style.WARNING(f"Failed to generate model docs: {e}"))
+            call_command(
+                "generate_model_docs", "--pretty"
+            )
+            self.stdout.write(self.style.SUCCESS("Model documentation generated."))
 
             # Generate the documentation content
             self.stdout.write("Generating documentation content...")
-            try:
-                call_command("generate_docs")
-                self.stdout.write(self.style.SUCCESS("Documentation content generated."))
-            except Exception as e:
-                self.stdout.write(self.style.ERROR(f"Failed to generate docs: {e}"))
-                raise
+            call_command("generate_docs")
+            self.stdout.write(self.style.SUCCESS("Documentation content generated."))
 
             # Build the MkDocs site
             self.stdout.write("Building MkDocs site...")
@@ -72,5 +65,3 @@ class Command(BaseCommand):
             raise CommandError(
                 "MkDocs not found. Please install it with: pip install mkdocs mkdocs-material"
             ) from e
-        except Exception as e:
-            raise CommandError(f"Error building documentation: {e!s}") from e

drf_to_mkdoc/utils/common.py

@@ -1,14 +1,16 @@
+from asyncio.log import logger
 import importlib
 import yaml
 import json
 import re
 from functools import lru_cache
 from pathlib import Path
-from typing import Any
+from typing import Any, Optional
 
 from django.apps import apps
 from django.core.exceptions import AppRegistryNotReady
 from django.urls import resolve
+from django.utils.module_loading import import_string
 from drf_spectacular.generators import SchemaGenerator
 from drf_to_mkdoc.conf.settings import drf_to_mkdoc_settings
 
@@ -24,13 +26,20 @@ class QueryParamTypeError(Exception):
     pass
 
 
-def substitute_path_params(path: str) -> str:
-    # Replace all path variables like <clinic_id> with dummy values
-    path = path.replace("{", "<").replace("}", ">")
-    return re.sub(r"<[^>]+>", "1", path)
+def substitute_path_params(path: str, parameters: list[dict[str, Any]]) -> str:
+    django_path = convert_to_django_path(path, parameters)
 
+    django_path = re.compile(r"\{[^}]+\}").sub("1", django_path)
+    django_path = re.sub(r"<int:[^>]+>", "1", django_path)
+    django_path = re.sub(r"<uuid:[^>]+>", "12345678-1234-5678-9abc-123456789012", django_path)
+    django_path = re.sub(r"<float:[^>]+>", "1.0", django_path)
+    django_path = re.sub(r"<(?:string|str):[^>]+>", "dummy", django_path)
+    django_path = re.sub(r"<path:[^>]+>", "dummy/path", django_path)
+    django_path = re.sub(r"<[^:>]+>", "dummy", django_path)  # Catch remaining simple params
 
-def load_schema() -> dict[str, Any] | None:
+    return django_path
+
+def load_schema() -> Optional[dict[str, Any]]:
     """Load the OpenAPI schema from doc-schema.yaml"""
     schema_file = Path(drf_to_mkdoc_settings.CONFIG_DIR) / "doc-schema.yaml"
     if not schema_file.exists():
@@ -40,7 +49,7 @@ def load_schema() -> dict[str, Any] | None:
         return yaml.safe_load(f)
 
 
-def load_model_json_data() -> dict[str, Any] | None:
+def load_model_json_data() -> Optional[dict[str, Any]]:
     """Load the JSON mapping data for model information"""
     json_file = Path(drf_to_mkdoc_settings.MODEL_DOCS_FILE)
     if not json_file.exists():
@@ -50,7 +59,7 @@ def load_model_json_data() -> dict[str, Any] | None:
         return json.load(f)
 
 
-def load_doc_config() -> dict[str, Any] | None:
+def load_doc_config() -> Optional[dict[str, Any]]:
     """Load the documentation configuration file"""
     config_file = Path(drf_to_mkdoc_settings.DOC_CONFIG_FILE)
     if not config_file.exists():
@@ -60,7 +69,7 @@ def load_doc_config() -> dict[str, Any] | None:
         return json.load(f)
 
 
-def get_model_docstring(class_name: str) -> str | None:
+def get_model_docstring(class_name: str) -> Optional[str]:
     """Extract docstring from Django model class"""
     try:
         # Check if Django is properly initialized
@@ -158,6 +167,51 @@ def get_custom_schema():
                     raise QueryParamTypeError("Invalid queryparam_type")
     return data
 
+def convert_to_django_path(path: str, parameters: list[dict[str, Any]]) -> str:
+    """
+    Convert a path with {param} to a Django-style path with <type:param>.
+    If DRF_TO_MKDOC_PATH_PARAM_SUBSTITUTOR is set, use that function instead.
+    """
+    function = None
+    func_path = getattr(drf_to_mkdoc_settings, "DRF_TO_MKDOC_PATH_PARAM_SUBSTITUTOR", None)
+
+    if func_path:
+        try:
+            function = import_string(func_path)
+        except ImportError:
+            logger.warning("DRF_TO_MKDOC_PATH_PARAM_SUBSTITUTOR is not a valid import path")
+
+    # If custom function exists and returns a valid value, use it
+    if callable(function):
+        try:
+            value = function(path, parameters)
+            if isinstance(value, str) and value.strip():
+                return value
+        except Exception as e:
+            logger.exception("Error in custom path substitutor: %s", e)
+
+    # Default Django path conversion
+    def replacement(match):
+        param_name = match.group(1)
+        param_info = next((p for p in parameters if p.get('name') == param_name), {})
+        param_type = param_info.get('schema', {}).get('type')
+        param_format = param_info.get('schema', {}).get('format')
+
+        if param_type == 'integer':
+            converter = 'int'
+        elif param_type == 'string' and param_format == 'uuid':
+            converter = 'uuid'
+        else:
+            converter = 'str'
+
+        return f'<{converter}:{param_name}>'
+
+    django_path = re.sub(r'{(\w+)}', replacement, path)
+
+    if not django_path.endswith('/'):
+        django_path += '/'
+
+    return django_path
 
 @lru_cache
 def get_schema():
@@ -209,7 +263,7 @@ def get_operation_id_path_map() -> dict[str, str]:
         for _http_method_name, action_data in actions.items():
             operation_id = action_data.get("operationId")
             if operation_id:
-                mapping[operation_id] = path
+                mapping[operation_id] = path, action_data.get("parameters", [])
 
     return mapping
 
@@ -217,13 +271,13 @@ def get_operation_id_path_map() -> dict[str, str]:
 def extract_viewset_from_operation_id(operation_id: str):
     """Extract the ViewSet class from an OpenAPI operation ID."""
     operation_map = get_operation_id_path_map()
-    django_path = operation_map.get(operation_id)
+    path, parameters = operation_map.get(operation_id)
 
-    if not django_path:
+    if not path:
         raise ValueError(f"Path not found for operation ID: {operation_id}")
 
     try:
-        resolved_path = substitute_path_params(django_path)
+        resolved_path = substitute_path_params(path, parameters)
         match = resolve(resolved_path)
         view_func = match.func
         if hasattr(view_func, "view_class"):

{drf_to_mkdoc-0.1.3.dist-info → drf_to_mkdoc-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drf-to-mkdoc
-Version: 0.1.3
+Version: 0.1.5
 Summary: Generate Markdown API docs from Django/DRF OpenAPI schema for MkDocs
 Author-email: Hossein Shayesteh <shayestehhs1@gmail.com>
 Maintainer-email: Hossein Shayesteh <shayestehhs1@gmail.com>

{drf_to_mkdoc-0.1.3.dist-info → drf_to_mkdoc-0.1.5.dist-info}/RECORD

@@ -5,21 +5,21 @@ drf_to_mkdoc/conf/defaults.py,sha256=9OK65SeP4aLZbuRJBAE_QeC-OhXkh0cACBqax6wYXnM
 drf_to_mkdoc/conf/settings.py,sha256=OgB3MCn4Z5F4xqWP34kwzMs50kRn3qF0gE1zS2SHS2M,1550
 drf_to_mkdoc/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 drf_to_mkdoc/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-drf_to_mkdoc/management/commands/build_docs.py,sha256=nt4Rv6lJ3MojCVOAmrLboIoZK06dMiq6RtHVW0Het84,2928
+drf_to_mkdoc/management/commands/build_docs.py,sha256=p--TajkpYU-hmthXp5eVmVtJnXLxZrfQWQmuzwOgl0c,2491
 drf_to_mkdoc/management/commands/generate_doc_json.py,sha256=mWdYgMbSeLP4iQZeUm2DxwYQmdGy8w05XTEfbT_nOJo,19833
 drf_to_mkdoc/management/commands/generate_docs.py,sha256=YGdejd-b1Wn_e5ru9orwp1b9H5PZwVWkuWxAY1JyG88,4897
 drf_to_mkdoc/management/commands/generate_model_docs.py,sha256=tdT9Z0qjZ9KgGAbFfYWBo-FtDI8wTQ2zRA_OvKKnyaA,12195
 drf_to_mkdoc/management/commands/update_doc_schema.py,sha256=TtHVQxnVpB_VELRkVcdsDXDU5zXdguFleB1mXCDMAbg,2009
 drf_to_mkdoc/utils/__init__.py,sha256=6dFTb07S6yIf-INMy0Mlgf5purNir687ZU9WZtITh4k,68
-drf_to_mkdoc/utils/common.py,sha256=4zh2cZkHDutanz18RS-Fud45TH0p8x2H06XrpKs2a0w,9576
+drf_to_mkdoc/utils/common.py,sha256=BIzN9iDOphIHPGkRGj8iVhY8lAUdvBAyNazP3wDmz9c,11814
 drf_to_mkdoc/utils/endpoint_generator.py,sha256=oGHQXJB5VFlGOq6W8a3q96CwF3conjBe_tkYj6m2mlg,35849
 drf_to_mkdoc/utils/model_generator.py,sha256=O1ibaw7KmL_fQ1OTebuk6Tt2yTjyElpyF7bN8gk5LBE,9588
 drf_to_mkdoc/utils/extractors/__init__.py,sha256=BvC8gKOPVI9gU1Piw0jRhKQ2ER5s1moAxgq7ZYkJWNI,86
 drf_to_mkdoc/utils/extractors/query_parameter_extractors.py,sha256=e7WW0MeLUfBAfksEKFxowDjz9uUvit_EDxYASfnbdc4,8400
 drf_to_mkdoc/utils/md_generators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 drf_to_mkdoc/utils/md_generators/query_parameters_generators.py,sha256=N-XqZ_FUODSR5V4xM9oEA3aaIiNGNmNwpvrWbQTx6RI,2566
-drf_to_mkdoc-0.1.3.dist-info/licenses/LICENSE,sha256=3n9_ckIREsH8ogCxWW6dFsw_WfGcluG2mHcgl9i_UU0,1068
-drf_to_mkdoc-0.1.3.dist-info/METADATA,sha256=nJp66j2aDd35LeEJ6gjhdDgIYmfW02ywgrYpNKp4Rk4,7304
-drf_to_mkdoc-0.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-drf_to_mkdoc-0.1.3.dist-info/top_level.txt,sha256=ZzJecR6j_tvLZiubUBEgawHflozC4DQy9ooNf1yDJ3Q,13
-drf_to_mkdoc-0.1.3.dist-info/RECORD,,
+drf_to_mkdoc-0.1.5.dist-info/licenses/LICENSE,sha256=3n9_ckIREsH8ogCxWW6dFsw_WfGcluG2mHcgl9i_UU0,1068
+drf_to_mkdoc-0.1.5.dist-info/METADATA,sha256=qFgbvjEKTuW_DP6VlK3YsJZGIg1NYY1b35j5TdQ4YZU,7304
+drf_to_mkdoc-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+drf_to_mkdoc-0.1.5.dist-info/top_level.txt,sha256=ZzJecR6j_tvLZiubUBEgawHflozC4DQy9ooNf1yDJ3Q,13
+drf_to_mkdoc-0.1.5.dist-info/RECORD,,