fastapi-voyager 0.5.2__tar.gz → 0.5.3__tar.gz

{fastapi_voyager-0.5.2 → fastapi_voyager-0.5.3}/PKG-INFO

@@ -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 → fastapi_voyager-0.5.3}/README.md

@@ -156,6 +156,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.3/src/fastapi_voyager/module.py

@@ -0,0 +1,99 @@
+from typing import Callable, Type, TypeVar, Any
+from fastapi_voyager.type import SchemaNode, ModuleNode, Route, ModuleRoute
+
+
+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]:
+    """
+    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 node
+    top_modules: dict[str, N] = {}
+    # Items without module path
+    root_level_items: list[I] = []
+
+    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
+        parent_full = getattr(parent, 'fullname')
+        fullname = child_name if not parent_full or parent_full == "__root__" else f"{parent_full}.{child_name}"
+        new_node = make_node(child_name, fullname)
+        getattr(parent, 'modules').append(new_node)
+        return new_node
+
+    # Build the tree
+    for it in items:
+        module_path = get_module_path(it) or ""
+        if not module_path:
+            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] = make_node(top_name, top_name)
+        current = top_modules[top_name]
+        for part in parts[1:]:
+            current = get_or_create(part, current)
+        getattr(current, item_list_attr).append(it)
+
+    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 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}"
+            node.fullname = child.fullname
+            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
+
+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-0.5.2 → fastapi_voyager-0.5.3}/src/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-0.5.2 → fastapi_voyager-0.5.3}/src/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-0.5.2 → fastapi_voyager-0.5.3}/src/fastapi_voyager/version.py

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

{fastapi_voyager-0.5.2 → fastapi_voyager-0.5.3}/src/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 → fastapi_voyager-0.5.3}/tests/demo.py

@@ -1,6 +1,6 @@
 from pydantic import BaseModel, Field
 from fastapi import FastAPI
-from typing import Optional
+from typing import Optional, Generic, TypeVar
 from pydantic_resolve import ensure_subset, Resolver
 from tests.service.schema import Story, Task
 import tests.service.schema as serv
@@ -56,10 +56,19 @@ async def get_page_info():
     page_overall = PageOverallWrap(content="Page Overall Content", sprints=[]) # focus on schema only
     return await Resolver().resolve(page_overall)
 
-
 class PageStories(BaseModel):
     stories: list[PageStory] 
 
 @app.get("/page_info/", tags=['for-page'], response_model=PageStories)
 def get_page_stories():
+    return {} # no implementation
+
+
+T = TypeVar('T')
+class DataModel(BaseModel, Generic[T]):
+    data: T
+    id: int
+
+@app.get("/page_test_1/", tags=['for-page'], response_model=DataModel[PageStory])
+def get_page_test_1():
     return {} # no implementation

{fastapi_voyager-0.5.2 → fastapi_voyager-0.5.3}/tests/test_module.py

@@ -1,4 +1,4 @@
-from fastapi_voyager.module import build_module_tree
+from fastapi_voyager.module import build_module_schema_tree
 from fastapi_voyager.type import SchemaNode
 
 
@@ -24,7 +24,7 @@ def test_build_module_tree_basic():
     ]
 
     # Act
-    top_modules = build_module_tree(schema_nodes)
+    top_modules = build_module_schema_tree(schema_nodes)
     from pprint import pprint
     pprint(top_modules)
 
@@ -58,7 +58,7 @@ def test_build_module_tree_basic():
 
 
 def test_build_module_tree_empty_input():
-    top_modules = build_module_tree([])
+    top_modules = build_module_schema_tree([])
     assert top_modules == []
 
 
@@ -70,7 +70,7 @@ def test_build_module_tree_root_level_nodes():
         _sn("PkgA", "pkg", "PkgA"),
     ]
 
-    top_modules = build_module_tree(schema_nodes)
+    top_modules = build_module_schema_tree(schema_nodes)
     names = sorted(m.name for m in top_modules)
     assert names == ["__root__", "pkg"]
     root = _find_top(top_modules, "__root__")
@@ -86,7 +86,7 @@ def test_collapse_single_child_empty_modules():
         _sn("Deep", "a.b.c.d", "Deep"),
         _sn("Peer", "a.b.x", "Peer"),
     ]
-    top_modules = build_module_tree(schema_nodes)
+    top_modules = build_module_schema_tree(schema_nodes)
     print(top_modules)
     # 'a' should have one child path 'b', but due to branching at x, only a.b collapses into a.b
     # and below it, 'c.d' should collapse to 'c.d'. Final structure:

fastapi_voyager-0.5.2/src/fastapi_voyager/module.py

@@ -1,64 +0,0 @@
-from fastapi_voyager.type import SchemaNode, ModuleNode
-
-def build_module_tree(schema_nodes: list[SchemaNode]) -> list[ModuleNode]:
-    """
-    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
-    """
-    # Map from top-level module name to ModuleNode
-    top_modules: dict[str, ModuleNode] = {}
-    # For nodes without module path, collect separately
-    root_level_nodes = []
-
-    def get_or_create(child_name: str, parent: ModuleNode) -> ModuleNode:
-        for m in parent.modules:
-            if m.name == child_name:
-                return m
-        # derive fullname from parent
-        parent_full = 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)
-        return new_node
-
-    for sn in schema_nodes:
-        module_path = sn.module or ""
-        if not module_path:
-            root_level_nodes.append(sn)
-            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=[])
-        current = top_modules[top_name]
-        for part in parts[1:]:
-            current = get_or_create(part, current)
-        current.schema_nodes.append(sn)
-
-    # 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=[]))
-
-    # 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
-            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:
-            collapse(m)
-
-    for top in result:
-        collapse(top)
-
-    return result