fastapi-voyager 0.4.3__py3-none-any.whl → 0.4.5__py3-none-any.whl

fastapi_voyager/graph.py

@@ -12,7 +12,7 @@ from fastapi_voyager.type_helper import (
     update_forward_refs
 )
 from pydantic import BaseModel
-from fastapi_voyager.type import Route, SchemaNode, Link, Tag, ModuleNode
+from fastapi_voyager.type import Route, SchemaNode, Link, Tag, ModuleNode, LinkType
 from fastapi_voyager.module import build_module_tree
 from fastapi_voyager.filter import filter_graph
 
@@ -156,7 +156,8 @@ class Analytics:
             source_origin: str,
             target: str, 
             target_origin: str,
-            type: Literal['child', 'parent', 'subset']):
+            type: LinkType
+        ) -> bool:
         """
         1. add link to link_set
         2. if duplicated, do nothing, else insert
@@ -262,17 +263,22 @@ class Analytics:
 
     def generate_dot(self):
 
+        def generate_link(link: Link):
+            if link.type == 'internal':
+                return f'''{handle_entry(link.source)}:e -> {handle_entry(link.target)}:w [ {get_link_attributes(link)} ];'''
+            else:
+                return f'''{handle_entry(link.source)} -> {handle_entry(link.target)} [ {get_link_attributes(link)} ];'''
+
+
         def get_link_attributes(link: Link):
-            if link.type == 'child':
-                return 'style = "dashed", label = "", minlen=3'
-            elif link.type == 'parent':
-                return 'style = "solid", dir="back", minlen=3, taillabel = "< inherit >", color = "purple", tailport="n"'
+            if link.type == 'parent':
+                return 'style = "solid, dashed", dir="back", minlen=3, taillabel = "< inherit >", color = "purple", tailport="n"'
             elif link.type == 'entry':
-                return 'style = "solid", label = "", minlen=3'
+                return 'style = "solid", label = "", minlen=3, tailport="e", headport="w"'
             elif link.type == 'subset':
-                return 'style = "solid", dir="back", minlen=3, taillabel = "< subset >", color = "orange", tailport="n"'
+                return 'style = "solid, dashed", dir="back", minlen=3, taillabel = "< subset >", color = "orange", tailport="n"'
 
-            return 'style = "solid", arrowtail="odiamond", dir="back", minlen=3'
+            return 'style = "solid", arrowtail="odot", dir="back", minlen=3'
 
         def render_module(mod: ModuleNode):
             color = self.module_color.get(mod.fullname)
@@ -296,7 +302,7 @@ class Analytics:
                 style="rounded"
                 label = "  {mod.name}"
                 labeljust = "l"
-                {(f'pencolor = "{color}"' if color else 'pencolor=""')}
+                {(f'pencolor = "{color}"' if color else 'pencolor="#ccc"')}
                 {(f'penwidth = 3' if color else 'penwidth=""')}
                 {inner_nodes_str}
                 {child_str}
@@ -340,9 +346,7 @@ class Analytics:
 
         modules_str = '\n'.join(render_module(m) for m in _modules)
 
-        links = [
-            f'''{handle_entry(link.source)} -> {handle_entry(link.target)} [ {get_link_attributes(link)} ];''' for link in _links
-        ]
+        links = [ generate_link(link) for link in _links ]
         link_str = '\n'.join(links)
 
         template = f'''
@@ -376,7 +380,7 @@ class Analytics:
                 color = "#aaa"
                 margin=18
                 style="dashed"
-                label = "  Route apis"
+                label = "  Routes"
                 labeljust = "l"
                 fontsize = "20"
                 {route_str}

fastapi_voyager/module.py

@@ -41,4 +41,24 @@ def build_module_tree(schema_nodes: list[SchemaNode]) -> list[ModuleNode]:
     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

fastapi_voyager/type.py

@@ -1,6 +1,10 @@
 from dataclasses import dataclass, field
 from typing import Literal
 
+@dataclass
+class NodeBase:
+    id: str
+    name: str
 
 @dataclass
 class FieldInfo:
@@ -11,23 +15,17 @@ class FieldInfo:
     is_exclude: bool = False
 
 @dataclass
-class Tag:
-    id: str
-    name: str
+class Tag(NodeBase):
     routes: list['Route']  # route.id
 
 @dataclass
-class Route:
-    id: str
-    name: str
+class Route(NodeBase):
     source_code: str = ''
     vscode_link: str = ''  # optional vscode deep link
 
 @dataclass
-class SchemaNode:
-    id: str
+class SchemaNode(NodeBase):
     module: str
-    name: str
     source_code: str = ''  # optional for tests / backward compatibility
     vscode_link: str = ''  # optional vscode deep link
     fields: list[FieldInfo] = field(default_factory=list)
@@ -39,10 +37,21 @@ class ModuleNode:
     schema_nodes: list[SchemaNode]
     modules: list['ModuleNode']
 
+
+# type: 
+#    - entry: tag -> route, route -> response model
+#    - subset: schema -> schema (subset)
+#    - parent: schema -> schema (inheritance)
+#    - internal: schema -> schema (field reference)
+LinkType = Literal['internal', 'parent', 'entry', 'subset']
+
 @dataclass
 class Link:
+    # node + field level links
     source: str
-    source_origin: str  # internal relationship
     target: str
+
+    # node level links
+    source_origin: str
     target_origin: str
-    type: Literal['child', 'parent', 'entry', 'subset']
+    type: LinkType

fastapi_voyager/type_helper.py

@@ -15,24 +15,10 @@ except Exception:  # pragma: no cover
     TypeAliasType = _DummyTypeAliasType  # type: ignore
 
 
-def _is_optional(annotation):
-    origin = get_origin(annotation)
-    args = get_args(annotation)
-    if origin is Union and type(None) in args:
-        return True
-    return False
-
-
-def _is_list(annotation):
+def is_list(annotation):
     return getattr(annotation, "__origin__", None) == list
 
 
-def shelling_type(type):
-    while _is_optional(type) or _is_list(type):
-        type = type.__args__[0]
-    return type
-
-
 def full_class_name(cls):
     return f"{cls.__module__}.{cls.__qualname__}"
 
@@ -42,12 +28,9 @@ def get_core_types(tp):
     - get the core type
     - always return a tuple of core types
     """
-    if tp is type(None):
-        return tuple()
-
-    # Unwrap PEP 695 type aliases (they wrap the actual annotation in __value__)
-    # Repeat in case of nested aliasing.
+    # Helpers
     def _unwrap_alias(t):
+        """Unwrap PEP 695 type aliases by following __value__ repeatedly."""
         while isinstance(t, TypeAliasType) or (
             t.__class__.__name__ == 'TypeAliasType' and hasattr(t, '__value__')
         ):
@@ -57,47 +40,54 @@ def get_core_types(tp):
                 break
         return t
 
-    tp = _unwrap_alias(tp)
+    def _enqueue(items, q):
+        for it in items:
+            if it is not type(None):  # skip None in unions
+                q.append(it)
 
-    # 1. Unwrap list layers
-    def _shell_list(_tp):
-        while _is_list(_tp):
-            args = getattr(_tp, "__args__", ())
-            if args:
-                _tp = args[0]
-            else:
-                break
-        return _tp
-    
-    tp = _shell_list(tp)
+    # Queue-based shelling to reach concrete core types
+    queue: list[object] = [tp]
+    result: list[object] = []
 
-    # Alias could wrap a list element, unwrap again
-    tp = _unwrap_alias(tp)
+    while queue:
+        cur = queue.pop(0)
+        if cur is type(None):
+            continue
 
-    if tp is type(None): # check again
-        return tuple()
+        cur = _unwrap_alias(cur)
 
-    while True:
-        orig = get_origin(tp)
+        # Handle Annotated[T, ...] as a shell
+        if get_origin(cur) is Annotated:
+            args = get_args(cur)
+            if args:
+                queue.append(args[0])
+            continue
 
+        # Handle Union / Optional / PEP 604 UnionType
+        orig = get_origin(cur)
         if orig in (Union, UnionType):
-            args = list(get_args(tp))
-            non_none = [a for a in args if a is not type(None)]  # noqa: E721
-            has_none = len(non_none) != len(args)
-            # Optional[T] case -> keep unwrapping (exactly one real type + None)
-            if has_none and len(non_none) == 1:
-                tp = non_none[0]
-                tp = _unwrap_alias(tp)
-                tp = _shell_list(tp)
-                continue
-            # General union: return all non-None members (order preserved)
-            if non_none:
-                return tuple(non_none)
-            return tuple()
-        break
-
-    # single concrete type
-    return (tp,)
+            args = get_args(cur)
+            # push all non-None members back for further shelling
+            _enqueue(args, queue)
+            continue
+
+        # Handle list shells
+        if is_list(cur):
+            args = getattr(cur, "__args__", ())
+            if args:
+                queue.append(args[0])
+            continue
+
+        # If still an alias-like wrapper, unwrap again and re-process
+        _cur2 = _unwrap_alias(cur)
+        if _cur2 is not cur:
+            queue.append(_cur2)
+            continue
+
+        # Otherwise treat as a concrete core type (could be a class, typing.Final, etc.)
+        result.append(cur)
+
+    return tuple(result)
 
 
 def get_type_name(anno):
@@ -242,6 +232,7 @@ def safe_issubclass(kls, classinfo):
 
 
 def update_forward_refs(kls):
+    # TODO: refactor
     def update_pydantic_forward_refs(kls2: Type[BaseModel]):
         """
         recursively update refs.

fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.4.3"
+__version__ = "0.4.5"

{fastapi_voyager-0.4.3.dist-info → fastapi_voyager-0.4.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.4.3
+Version: 0.4.5
 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
@@ -144,9 +144,9 @@ dot -Tpng router_viz.dot -o router_viz.png
 or you can open router_viz.dot with vscode extension `graphviz interactive preview`
 
 
-## Plan
+## Plan before v1.0
 
-features:
+features 
 - [x] group schemas by module hierarchy
 - [x] module-based coloring via Analytics(module_color={...})
 - [x] view in web browser
@@ -162,18 +162,30 @@ features:
 - [x] alt+click to show field details
 - [x] display source code of routes (including response_model)
 - [x] handle excluded field 
-- [ ] user can generate nodes/edges manually and connect to generated ones
-- [ ] support dataclass
 - [ ] group routes by module hierarchy
+- [ ] support dataclass
+- [ ] user can generate nodes/edges manually and connect to generated ones
+- [ ] refactor
+    - [ ] abstract render module
+- [ ] ui optimization
+    - [ ] fixed left/right bar show field information
+- [ ] display standard ER diagram
+    - [ ] display potential invalid links
 - [ ] integration with pydantic-resolve
     - [ ] show difference between resolve, post fields
     - [x] strikethrough for excluded fields
     - [ ] display loader as edges
-- [ ] test cases
+- [ ] add tests
 
 bugs:
 - [ ] fix duplicated link from class and parent class, it also break clicking highlight
 
+## Using with pydantic-resolve
+
+pydantic-resolve's @ensure_subset decorator is helpful to pick fields from `source class` in safe.
+
+TODO: ...
+
 
 ## Credits
 

{fastapi_voyager-0.4.3.dist-info → fastapi_voyager-0.4.5.dist-info}/RECORD

@@ -1,12 +1,12 @@
 fastapi_voyager/__init__.py,sha256=E5WTV_sYs2LK8I6jzA7AuvFU5a8_vjnDseC3DMha0iQ,149
 fastapi_voyager/cli.py,sha256=FuXllJtlsm33FX6VmDdAFWzzQ5TIraUizBDgvBj3vmY,10489
 fastapi_voyager/filter.py,sha256=uZrVVMhHG5E7j1wdsiB02RAyoDdF1q8A4J04oCboYAU,4644
-fastapi_voyager/graph.py,sha256=sh483yiNUyK-nQVd1iY7HMZe7HrXHTcSWOJRuYitI8g,14550
-fastapi_voyager/module.py,sha256=ppiJ46rdyA4yQnQA5IQqsMOHGgWdz5orJ0bEQydHsEk,1885
+fastapi_voyager/graph.py,sha256=0lTU2XiIer35IPXoQBuh2KajvXUGeea3-vuHyPnketA,14734
+fastapi_voyager/module.py,sha256=NyhSpjevhYtIJdlJxpksGAzfbOV5bHZ7PWbVT4x8LIU,2664
 fastapi_voyager/server.py,sha256=UFj6c0Yx4Rmy56eFXv65n1VdmJeiBX43KsDm6D65U28,2943
-fastapi_voyager/type.py,sha256=k8V45obOzS6HQD8RqaBh4xKBQRUsV-mA_UdMZu51KR0,1005
-fastapi_voyager/type_helper.py,sha256=qmkOVjIH-Ou16xt0b1ShLjEn7RH_T7RnBDQK4CkQB3E,8546
-fastapi_voyager/version.py,sha256=lQMrpT_VNBvYYY2_24iy2Iu8JL-GqGHRIQGplK9hn0U,48
+fastapi_voyager/type.py,sha256=xkvfUL5vmfaerkaoowdSlTRsD11NP5NG1rMOXYPBJO0,1265
+fastapi_voyager/type_helper.py,sha256=j7AiFXsfl4kaxshYtofbsqo08dIXiHvJ190soIzUdLk,8380
+fastapi_voyager/version.py,sha256=LLMiqcKNNqxWTkirwEvOSRsPX9JD6wKMiTXX3MN-uCA,48
 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
@@ -24,8 +24,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.4.3.dist-info/METADATA,sha256=Q_HRTdA7aeM-ErLqLElMVaefGa0VCg6qOTSjJzO75Jk,6154
-fastapi_voyager-0.4.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fastapi_voyager-0.4.3.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
-fastapi_voyager-0.4.3.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
-fastapi_voyager-0.4.3.dist-info/RECORD,,
+fastapi_voyager-0.4.5.dist-info/METADATA,sha256=aSM2jqwKxrbrr05LTzBLMGQ5wpSQC5EqyDxJFKKygZA,6508
+fastapi_voyager-0.4.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fastapi_voyager-0.4.5.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
+fastapi_voyager-0.4.5.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
+fastapi_voyager-0.4.5.dist-info/RECORD,,