fastapi-voyager 0.5.2__py3-none-any.whl → 0.5.3__py3-none-any.whl

fastapi_voyager/module.py

@@ -1,64 +1,99 @@
-from fastapi_voyager.type import SchemaNode, ModuleNode
+from typing import Callable, Type, TypeVar, Any
+from fastapi_voyager.type import SchemaNode, ModuleNode, Route, ModuleRoute
 
-def build_module_tree(schema_nodes: list[SchemaNode]) -> list[ModuleNode]:
+
+N = TypeVar('N')  # Node type: ModuleNode or ModuleRoute
+I = TypeVar('I')  # Item type: SchemaNode or Route
+
+
+def _build_module_tree(
+    items: list[I],
+    *,
+    get_module_path: Callable[[I], str | None],
+    NodeClass: Type[N],
+    item_list_attr: str,
+) -> list[N]:
     """
-    1. the name of module_node comes from schema_node's module field
-    2. split the module_name with '.' to create a tree structure
-    3. group schema_nodes under the correct module_node
-    4. return the top-level module_node list
+    Generic builder that groups items by dotted module path into a tree of NodeClass.
+
+    NodeClass must accept kwargs: name, fullname, modules(list), and an item list via
+    item_list_attr (e.g., 'schema_nodes' or 'routes').
     """
-    # Map from top-level module name to ModuleNode
-    top_modules: dict[str, ModuleNode] = {}
-    # For nodes without module path, collect separately
-    root_level_nodes = []
+    # Map from top-level module name to node
+    top_modules: dict[str, N] = {}
+    # Items without module path
+    root_level_items: list[I] = []
 
-    def get_or_create(child_name: str, parent: ModuleNode) -> ModuleNode:
-        for m in parent.modules:
+    def make_node(name: str, fullname: str) -> N:
+        kwargs: dict[str, Any] = {
+            'name': name,
+            'fullname': fullname,
+            'modules': [],
+            item_list_attr: [],
+        }
+        return NodeClass(**kwargs)  # type: ignore[arg-type]
+
+    def get_or_create(child_name: str, parent: N) -> N:
+        for m in getattr(parent, 'modules'):
             if m.name == child_name:
                 return m
-        # derive fullname from parent
-        parent_full = parent.fullname
+        parent_full = getattr(parent, 'fullname')
         fullname = child_name if not parent_full or parent_full == "__root__" else f"{parent_full}.{child_name}"
-        new_node = ModuleNode(name=child_name, fullname=fullname, schema_nodes=[], modules=[])
-        parent.modules.append(new_node)
+        new_node = make_node(child_name, fullname)
+        getattr(parent, 'modules').append(new_node)
         return new_node
 
-    for sn in schema_nodes:
-        module_path = sn.module or ""
+    # Build the tree
+    for it in items:
+        module_path = get_module_path(it) or ""
         if not module_path:
-            root_level_nodes.append(sn)
+            root_level_items.append(it)
             continue
         parts = module_path.split('.')
         top_name = parts[0]
         if top_name not in top_modules:
-            top_modules[top_name] = ModuleNode(name=top_name, fullname=top_name, schema_nodes=[], modules=[])
+            top_modules[top_name] = make_node(top_name, top_name)
         current = top_modules[top_name]
         for part in parts[1:]:
             current = get_or_create(part, current)
-        current.schema_nodes.append(sn)
+        getattr(current, item_list_attr).append(it)
 
-    # If there are root-level nodes, add a pseudo-module named "__root__"
-    result = list(top_modules.values())
-    if root_level_nodes:
-        result.append(ModuleNode(name="__root__", fullname="__root__", schema_nodes=root_level_nodes, modules=[]))
+    result: list[N] = list(top_modules.values())
+    if root_level_items:
+        result.append(make_node("__root__", "__root__"))
+        setattr(result[-1], item_list_attr, root_level_items)
 
-    # Collapse pass: if a module has exactly one child module and no schema_nodes,
-    # merge it upward (A + B -> A.B). Repeat until fixed point.
-    def collapse(node: ModuleNode):
-        # Collapse chains at current node
-        while len(node.modules) == 1 and len(node.schema_nodes) == 0:
-            child = node.modules[0]
-            # Merge child's identity into current node
+    # Collapse linear chains: no items on node and exactly one child module
+    def collapse(node: N) -> None:
+        while len(getattr(node, 'modules')) == 1 and len(getattr(node, item_list_attr)) == 0:
+            child = getattr(node, 'modules')[0]
             node.name = f"{node.name}.{child.name}"
-            # Prefer child's fullname which already reflects full path
             node.fullname = child.fullname
-            node.schema_nodes = child.schema_nodes
-            node.modules = child.modules
-        # Recurse into children
-        for m in node.modules:
+            setattr(node, item_list_attr, getattr(child, item_list_attr))
+            setattr(node, 'modules', getattr(child, 'modules'))
+        for m in getattr(node, 'modules'):
             collapse(m)
 
     for top in result:
         collapse(top)
 
-    return result
+    return result
+
+def build_module_schema_tree(schema_nodes: list[SchemaNode]) -> list[ModuleNode]:
+    """Build a module tree for schema nodes, grouped by their module path."""
+    return _build_module_tree(
+        schema_nodes,
+        get_module_path=lambda sn: sn.module,
+        NodeClass=ModuleNode,
+        item_list_attr='schema_nodes',
+    )
+
+
+def build_module_route_tree(routes: list[Route]) -> list[ModuleRoute]:
+    """Build a module tree for routes, grouped by their module path."""
+    return _build_module_tree(
+        routes,
+        get_module_path=lambda r: r.module,
+        NodeClass=ModuleRoute,
+        item_list_attr='routes',
+    )

fastapi_voyager/render.py

@@ -1,5 +1,5 @@
-from fastapi_voyager.type import SchemaNode, ModuleNode, Link, Tag, Route, FieldType, PK
-from fastapi_voyager.module import build_module_tree
+from fastapi_voyager.type import SchemaNode, ModuleNode, Link, Tag, Route, FieldType, PK, ModuleRoute
+from fastapi_voyager.module import build_module_schema_tree, build_module_route_tree
 
 
 class Renderer:
@@ -51,7 +51,7 @@ class Renderer:
         if link.type == 'tag_route':
             return f"""{h(link.source)}:e -> {h(link.target)}:w [style = "solid", minlen=3];"""
         elif link.type == 'route_to_schema':
-            return f"""{h(link.source)}:e -> {h(link.target)}:{PK} [style = "solid", dir="back", arrowtail="odot", minlen=3];"""
+            return f"""{h(link.source)}:e -> {h(link.target)}:w [style = "solid", dir="back", arrowtail="odot", minlen=3];"""
         elif link.type == 'schema':
             return f"""{h(link.source)}:e -> {h(link.target)}:w [style = "solid", label = "", dir="back", minlen=3, arrowtail="odot"];"""
         elif link.type == 'parent':
@@ -61,7 +61,7 @@ class Renderer:
         else:
             raise ValueError(f'Unknown link type: {link.type}')
 
-    def render_module(self, mod: ModuleNode) -> str:
+    def render_module_schema(self, mod: ModuleNode) -> str:
         color = self.module_color.get(mod.fullname)
         inner_nodes = [
             f'''
@@ -72,7 +72,7 @@ class Renderer:
                 ];''' for node in mod.schema_nodes
         ]
         inner_nodes_str = '\n'.join(inner_nodes)
-        child_str = '\n'.join(self.render_module(m) for m in mod.modules)
+        child_str = '\n'.join(self.render_module_schema(m) for m in mod.modules)
         return f'''
             subgraph cluster_module_{mod.fullname.replace('.', '_')} {{
                 tooltip="{mod.fullname}"
@@ -85,9 +85,36 @@ class Renderer:
                 {inner_nodes_str}
                 {child_str}
             }}'''
+    
+    def render_module_route(self, mod: ModuleRoute) -> str:
+        color = self.module_color.get(mod.fullname)
+        # Inner route nodes, same style as flat route_str
+        inner_nodes = [
+            f'''
+            "{r.id}" [
+                label = "    {r.name}    "
+                margin="0.5,0.1"
+                shape = "record"
+            ];''' for r in mod.routes
+        ]
+        inner_nodes_str = '\n'.join(inner_nodes)
+        child_str = '\n'.join(self.render_module_route(m) for m in mod.modules)
+        return f'''
+            subgraph cluster_route_module_{mod.fullname.replace('.', '_')} {{
+                tooltip="{mod.fullname}"
+                color = "#666"
+                style="rounded"
+                label = "  {mod.name}"
+                labeljust = "l"
+                {(f'pencolor = "{color}"' if color else 'pencolor="#ccc"')}
+                {(f'penwidth = 3' if color else 'penwidth=""')}
+                {inner_nodes_str}
+                {child_str}
+            }}'''
 
     def render_dot(self, tags: list[Tag], routes: list[Route], nodes: list[SchemaNode], links: list[Link]) -> str:
-        modules = build_module_tree(nodes)
+        module_schemas = build_module_schema_tree(nodes)
+        module_routes = build_module_route_tree(routes)
 
         tag_str = '\n'.join([
             f'''
@@ -98,16 +125,9 @@ class Renderer:
             ];''' for t in tags
         ])
 
-        route_str = '\n'.join([
-            f'''
-            "{r.id}" [
-                label = "    {r.name}    "
-                margin="0.5,0.1"
-                shape = "record"
-            ];''' for r in routes
-        ])
 
-        modules_str = '\n'.join(self.render_module(m) for m in modules)
+        module_schemas_str = '\n'.join(self.render_module_schema(m) for m in module_schemas)
+        module_routes_str = '\n'.join(self.render_module_route(m) for m in module_routes)
         link_str = '\n'.join(self.render_link(link) for link in links)
 
         dot_str = f'''
@@ -144,7 +164,7 @@ class Renderer:
                 label = "  Routes"
                 labeljust = "l"
                 fontsize = "20"
-                {route_str}
+                {module_routes_str}
             }}
 
             subgraph cluster_schema {{
@@ -154,7 +174,7 @@ class Renderer:
                 label="  Schema"
                 labeljust="l"
                 fontsize="20"
-                    {modules_str}
+                    {module_schemas_str}
             }}
 
             {link_str}

fastapi_voyager/type.py

@@ -21,9 +21,17 @@ class Tag(NodeBase):
 
 @dataclass
 class Route(NodeBase):
+    module: str
     source_code: str = ''
     vscode_link: str = ''  # optional vscode deep link
 
+@dataclass
+class ModuleRoute:
+    name: str
+    fullname: str
+    routes: list[Route]
+    modules: list['ModuleRoute']
+
 @dataclass
 class SchemaNode(NodeBase):
     module: str

fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.5.2"
+__version__ = "0.5.3"

fastapi_voyager/voyager.py

@@ -83,6 +83,7 @@ class Voyager:
             # add route and create links
             route_id = f'{route.endpoint.__name__}_{route.path.replace("/", "_")}'
             route_name = route.endpoint.__name__
+            route_module = route.endpoint.__module__
 
             # filter by route_name (route.id) if provided
             if self.route_name is not None and route_id != self.route_name:
@@ -91,6 +92,7 @@ class Voyager:
             route_obj = Route(
                 id=route_id,
                 name=route_name,
+                module=route_module,
                 vscode_link=get_vscode_link(route.endpoint) if self.load_meta else '',
                 source_code=inspect.getsource(route.endpoint) if self.load_meta else ''
             )

{fastapi_voyager-0.5.2.dist-info → fastapi_voyager-0.5.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.5.2
+Version: 0.5.3
 Summary: Visualize FastAPI application's routing tree and dependencies
 Project-URL: Homepage, https://github.com/allmonday/fastapi-voyager
 Project-URL: Source, https://github.com/allmonday/fastapi-voyager
@@ -183,6 +183,13 @@ features
     - [ ] abstract render module
 - [ ] export voyager core data into json (for better debugging)
     - [ ] add api to rebuild core data from json, and render it
+- [ ] fix Generic case
+
+```python
+    class Paged(BaseModel, Generic[T]):
+    total: int
+    items: List[T]
+```
 
 bugs:
 - [ ] fix duplicated link from class and parent class, it also break clicking highlight

{fastapi_voyager-0.5.2.dist-info → fastapi_voyager-0.5.3.dist-info}/RECORD

@@ -1,13 +1,13 @@
 fastapi_voyager/__init__.py,sha256=E5WTV_sYs2LK8I6jzA7AuvFU5a8_vjnDseC3DMha0iQ,149
 fastapi_voyager/cli.py,sha256=scBD2ojOq0_sJ8Usu79MoGUvkEc_zlnBO6xK0grz7dI,10478
 fastapi_voyager/filter.py,sha256=uZrVVMhHG5E7j1wdsiB02RAyoDdF1q8A4J04oCboYAU,4644
-fastapi_voyager/module.py,sha256=NyhSpjevhYtIJdlJxpksGAzfbOV5bHZ7PWbVT4x8LIU,2664
-fastapi_voyager/render.py,sha256=gK0ur8CAqI3jNt2H3mr-JSpC0sD1JxzLRlFcuykBkxQ,6366
+fastapi_voyager/module.py,sha256=Z2QHNmiLk6ZAJlm2nSmO875Q33TweSg8UxZSzIpU9zY,3499
+fastapi_voyager/render.py,sha256=ctwad-KNbFajhgnA8OI8412s6s67UbV-dvZFXBt_Ssg,7410
 fastapi_voyager/server.py,sha256=Eer6GdD9-EG9QGHlYmClF3MeVxw68amjK4iW_YZ5ShI,3751
-fastapi_voyager/type.py,sha256=Tef61aKaQdTinM8N_lpmrse8elXV8DAgY3ULySc8TEE,1642
+fastapi_voyager/type.py,sha256=nad4WNxTcZFi7Mskw6p2W7v2Gs4f0giVLNoFjZlKmbA,1778
 fastapi_voyager/type_helper.py,sha256=j7AiFXsfl4kaxshYtofbsqo08dIXiHvJ190soIzUdLk,8380
-fastapi_voyager/version.py,sha256=m_MOw_nkKIsJaKLUdJmlCrDGyTqN5GYwGMjdFF2hZmo,48
-fastapi_voyager/voyager.py,sha256=InAAc_Sf1blM8X-KjF_x-CdS4OEpN-z0doMiBgnl0-A,10103
+fastapi_voyager/version.py,sha256=Hb2z9BH1asz5RSe-xgzQIT7VN25qyDUyXYTS-6rOm5g,48
+fastapi_voyager/voyager.py,sha256=qMXZrQsmUiBljhOFOUtXV--a5i7THz9l00UNoxDu_0w,10193
 fastapi_voyager/web/graph-ui.js,sha256=eEjDnJVMvk35LdRoxcqX_fZxLFS9_bUrGAZL6K2O5C0,4176
 fastapi_voyager/web/graphviz.svg.css,sha256=zDCjjpT0Idufu5YOiZI76PL70-avP3vTyzGPh9M85Do,1563
 fastapi_voyager/web/graphviz.svg.js,sha256=lvAdbjHc-lMSk4GQp-iqYA2PCFX4RKnW7dFaoe0LUHs,16005
@@ -26,8 +26,8 @@ fastapi_voyager/web/icon/favicon-16x16.png,sha256=JC07jEzfIYxBIoQn_FHXvyHuxESdhW
 fastapi_voyager/web/icon/favicon-32x32.png,sha256=C7v1h58cfWOsiLp9yOIZtlx-dLasBcq3NqpHVGRmpt4,1859
 fastapi_voyager/web/icon/favicon.ico,sha256=tZolYIXkkBcFiYl1A8ksaXN2VjGamzcSdes838dLvNc,15406
 fastapi_voyager/web/icon/site.webmanifest,sha256=ep4Hzh9zhmiZF2At3Fp1dQrYQuYF_3ZPZxc1KcGBvwQ,263
-fastapi_voyager-0.5.2.dist-info/METADATA,sha256=emxagsUfAuI44P9Q0D3SMj3tkdZFNPD8UD_Ok3jscXA,6766
-fastapi_voyager-0.5.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fastapi_voyager-0.5.2.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
-fastapi_voyager-0.5.2.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
-fastapi_voyager-0.5.2.dist-info/RECORD,,
+fastapi_voyager-0.5.3.dist-info/METADATA,sha256=TFMnB94SxSoEblutrjAYkSqopvPgeY5zMsMJhH86_KI,6878
+fastapi_voyager-0.5.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fastapi_voyager-0.5.3.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
+fastapi_voyager-0.5.3.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
+fastapi_voyager-0.5.3.dist-info/RECORD,,