fastapi-voyager 0.10.5__tar.gz → 0.11.1__tar.gz

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.10.5
+Version: 0.11.1
 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
@@ -244,6 +244,7 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [x] fix focus in brief-mode
     - [x] ui: adjust focus position
     - [x] refactor naming
+    - [x] fix layout issue when rendering huge graph
 - 0.10.4
     - [x] fix: when focus is on, should ensure changes from other params not broken.
 - 0.10.5
@@ -251,19 +252,20 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     
 
 #### 0.11
-- [ ] enable/disable module cluster  (to save space)
-- [ ] fix layout issue when rendering huge graph
-- [ ] logging information
-- [ ] support opening route in swagger
-    - config docs path
-- [ ] add tests
-- [ ] fix: focus should reset zoom
-- [ ] sort field name
-- [ ] set max limit for fields
-- [ ] add info icon alone with schema node
-- [ ] add loading for field detail panel
+- 0.11.1
+    - [x] support opening route in swagger
+        - [x] config docs path
+    - [x] provide option to hide routes in brief mode (auto hide in full graph mode)
+- 0.11.2
+    - [ ] enable/disable module cluster  (to save space)
+    - [ ] logging information
+    - [ ] sort field name
+    - [ ] set max limit for fields
+    - [ ] add info icon alone with schema node
+    - [ ] add loading for field detail panel
 
 #### 0.12
+- [ ] add tests
 - [ ] integration with pydantic-resolve
     - [ ] show hint for resolve, post fields
     - [ ] display loader as edges

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/README.md

@@ -217,6 +217,7 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [x] fix focus in brief-mode
     - [x] ui: adjust focus position
     - [x] refactor naming
+    - [x] fix layout issue when rendering huge graph
 - 0.10.4
     - [x] fix: when focus is on, should ensure changes from other params not broken.
 - 0.10.5
@@ -224,19 +225,20 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     
 
 #### 0.11
-- [ ] enable/disable module cluster  (to save space)
-- [ ] fix layout issue when rendering huge graph
-- [ ] logging information
-- [ ] support opening route in swagger
-    - config docs path
-- [ ] add tests
-- [ ] fix: focus should reset zoom
-- [ ] sort field name
-- [ ] set max limit for fields
-- [ ] add info icon alone with schema node
-- [ ] add loading for field detail panel
+- 0.11.1
+    - [x] support opening route in swagger
+        - [x] config docs path
+    - [x] provide option to hide routes in brief mode (auto hide in full graph mode)
+- 0.11.2
+    - [ ] enable/disable module cluster  (to save space)
+    - [ ] logging information
+    - [ ] sort field name
+    - [ ] set max limit for fields
+    - [ ] add info icon alone with schema node
+    - [ ] add loading for field detail panel
 
 #### 0.12
+- [ ] add tests
 - [ ] integration with pydantic-resolve
     - [ ] show hint for resolve, post fields
     - [ ] display loader as edges

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/src/fastapi_voyager/filter.py

@@ -192,4 +192,94 @@ def filter_subgraph_by_module_prefix(
 
     filtered_links = tag_route_links + merged_links + module_prefix_links
 
-    return tags, routes, filtered_nodes, filtered_links
+    return tags, routes, filtered_nodes, filtered_links
+
+
+def filter_subgraph_from_tag_to_schema_by_module_prefix(
+    *,
+    tags: list[Tag],
+    routes: list[Route],
+    links: list[Link],
+    nodes: list[SchemaNode],
+    module_prefix: str
+) -> Tuple[list[Tag], list[Route], list[SchemaNode], list[Link]]:
+    """Collapse schema graph so routes link directly to nodes whose module matches ``module_prefix``.
+
+    The routine keeps tag→route links untouched, prunes schema nodes whose module does not start
+    with ``module_prefix``, and merges the remaining schema relationships so each route connects
+    directly to the surviving schema nodes. Traversal stops once a qualifying node is reached and
+    guards against cycles in the schema graph.
+    """
+
+    if not module_prefix:
+        # empty prefix keeps existing graph structure, so simply reuse incoming data
+        return tags, routes, nodes, [lk for lk in links if lk.type in ("tag_route", "route_to_schema")]
+
+    route_links = [lk for lk in links if lk.type == "route_to_schema"]
+    schema_links = [lk for lk in links if lk.type in {"schema", "parent", "subset"}]
+    tag_route_links = [lk for lk in links if lk.type == "tag_route"]
+
+    node_lookup: dict[str, SchemaNode] = {node.id: node for node in (nodes + routes)}
+
+    filtered_nodes = [node for node in nodes if node_lookup[node.id].module.startswith(module_prefix)]
+    filtered_node_ids = {node.id for node in filtered_nodes}
+
+    adjacency: dict[str, list[str]] = {}
+    for link in (schema_links + route_links):
+        if link.source_origin not in node_lookup or link.target_origin not in node_lookup:
+            continue
+        adjacency.setdefault(link.source_origin, [])
+        if link.target_origin not in adjacency[link.source_origin]:
+            adjacency[link.source_origin].append(link.target_origin)
+
+    merged_links: list[Link] = []
+    seen_pairs: set[tuple[str, str]] = set()
+
+    for link in tag_route_links:
+        # print(link)
+        tag_id = link.source_origin
+        start_node_id = link.target_origin
+        if tag_id is None or start_node_id is None:
+            continue
+        if start_node_id not in node_lookup:
+            continue
+
+        visited: set[str] = set()
+        queue: deque[str] = deque([start_node_id])
+
+        while queue:
+            current = queue.popleft()
+            if current in visited:
+                continue
+            visited.add(current)
+
+            if current in filtered_node_ids:
+                key = (tag_id, current)
+                if key not in seen_pairs:
+                    seen_pairs.add(key)
+                    merged_links.append(
+                        Link(
+                            source=link.source,
+                            source_origin=tag_id,
+                            target=f"{current}::{PK}",
+                            target_origin=current,
+                            type="tag_to_schema",
+                        )
+                    )
+                # stop traversing past a qualifying node
+                continue
+
+            for next_node in adjacency.get(current, () ):
+                if next_node not in visited:
+                    queue.append(next_node)
+
+    module_prefix_links = [
+        lk
+        for lk in links
+        if (lk.source_origin or "").startswith(module_prefix)
+        and (lk.target_origin or "").startswith(module_prefix)
+    ]
+
+    filtered_links =  merged_links + module_prefix_links
+
+    return tags, [], filtered_nodes, filtered_links  # route is skipped

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/src/fastapi_voyager/render.py

@@ -59,6 +59,8 @@ class Renderer:
             return f"""{h(link.source)}:e -> {h(link.target)}:w [style = "solid, dashed", dir="back", minlen=3, taillabel = "< inherit >", color = "purple", tailport="n"];"""
         elif link.type == 'subset':
             return f"""{h(link.source)}:e -> {h(link.target)}:w [style = "solid, dashed", dir="back", minlen=3, taillabel = "< subset >", color = "orange", tailport="n"];"""
+        elif link.type == 'tag_to_schema':
+            return f"""{h(link.source)}:e -> {h(link.target)}:w [style = "solid", dir="back", arrowtail="odot", minlen=3];"""
         else:
             raise ValueError(f'Unknown link type: {link.type}')
 

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/src/fastapi_voyager/server.py

@@ -22,6 +22,7 @@ class OptionParam(BaseModel):
 	dot: str
 	enable_brief_mode: bool
 	version: str
+	swagger_url: Optional[str] = None
 
 class Payload(BaseModel):
 	tags: Optional[list[str]] = None
@@ -33,9 +34,11 @@ class Payload(BaseModel):
 	brief: bool = False
 	hide_primitive_route: bool = False
 
+
 def create_route(
 	target_app: FastAPI,
 	module_color: dict[str, str] | None = None,
+	swagger_url: Optional[str] = None,
 	module_prefix: Optional[str] = None,
 ):
 	"""
@@ -56,7 +59,13 @@ def create_route(
 		schemas = voyager.nodes[:]
 		schemas.sort(key=lambda s: s.name)
 
-		return OptionParam(tags=tags, schemas=schemas, dot=dot, enable_brief_mode=bool(module_prefix), version=__version__)
+		return OptionParam(
+			tags=tags, 
+			schemas=schemas,
+			dot=dot,
+			enable_brief_mode=bool(module_prefix),
+			version=__version__,
+			swagger_url=swagger_url)
 
 	@router.post("/dot", response_class=PlainTextResponse)
 	def get_filtered_dot(payload: Payload) -> str:
@@ -71,7 +80,10 @@ def create_route(
 		)
 		voyager.analysis(target_app)
 		if payload.brief:
-			return voyager.render_brief_dot(module_prefix=module_prefix)
+			if payload.tags:
+				return voyager.render_tag_level_brief_dot(module_prefix=module_prefix)
+			else:
+				return voyager.render_overall_brief_dot(module_prefix=module_prefix)
 		else:
 			return voyager.render_dot()
 
@@ -196,8 +208,9 @@ def create_voyager(
 	module_color: dict[str, str] | None = None,
 	gzip_minimum_size: int | None = 500,
 	module_prefix: Optional[str] = None,
+	swagger_url: Optional[str] = None,
 ) -> FastAPI:
-	router = create_route(target_app, module_color=module_color, module_prefix=module_prefix)
+	router = create_route(target_app, module_color=module_color, module_prefix=module_prefix, swagger_url=swagger_url)
 
 	app = FastAPI(title="fastapi-voyager demo server")
 	if gzip_minimum_size is not None and gzip_minimum_size >= 0:

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/src/fastapi_voyager/type.py

@@ -22,6 +22,7 @@ class Tag(NodeBase):
 @dataclass
 class Route(NodeBase):
     module: str
+    unique_id: str = ''
     response_schema: str = ''
     is_primitive: bool = True
 
@@ -51,7 +52,8 @@ class ModuleNode:
 #    - subset: schema -> schema (subset)
 #    - parent: schema -> schema (inheritance)
 #    - schema: schema -> schema (field reference)
-LinkType = Literal['schema', 'parent', 'tag_route', 'subset', 'route_to_schema']
+#    - tag_to_schema: tag -> schema (only happens in module prefix filtering, aka brief mode)
+LinkType = Literal['schema', 'parent', 'tag_route', 'subset', 'route_to_schema', 'tag_to_schema']
 
 @dataclass
 class Link:

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.10.5"
+__version__ = "0.11.1"

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/src/fastapi_voyager/voyager.py

@@ -6,15 +6,13 @@ from fastapi_voyager.type_helper import (
     get_bases_fields,
     is_inheritance_of_pydantic_base,
     get_pydantic_fields,
-    get_vscode_link,
-    get_source,
     get_type_name,
     update_forward_refs,
     is_non_pydantic_type
 )
 from pydantic import BaseModel
 from fastapi_voyager.type import Route, SchemaNode, Link, Tag, LinkType, FieldType, PK, CoreData
-from fastapi_voyager.filter import filter_graph, filter_subgraph_by_module_prefix
+from fastapi_voyager.filter import filter_graph, filter_subgraph_from_tag_to_schema_by_module_prefix, filter_subgraph_by_module_prefix
 from fastapi_voyager.render import Renderer
 import pydantic_resolve.constant as const
 
@@ -123,6 +121,7 @@ class Voyager:
                     id=route_id,
                     name=route_name,
                     module=route_module,
+                    unique_id=route.unique_id,
                     response_schema=get_type_name(route.response_model),
                     is_primitive=is_primitive_response
                 )
@@ -307,7 +306,8 @@ class Voyager:
         _tags, _routes, _links = self.handle_hide(_tags, _routes, _links)
         return renderer.render_dot(_tags, _routes, _nodes, _links)
     
-    def render_brief_dot(self, module_prefix: str | None = None):
+
+    def render_tag_level_brief_dot(self, module_prefix: str | None = None):
         _tags, _routes, _nodes, _links = filter_graph(
             schema=self.schema,
             schema_field=self.schema_field,
@@ -328,5 +328,29 @@ class Voyager:
 
         renderer = Renderer(show_fields=self.show_fields, module_color=self.module_color, schema=self.schema)
 
+        _tags, _routes, _links = self.handle_hide(_tags, _routes, _links)
+        return renderer.render_dot(_tags, _routes, _nodes, _links, True)
+
+    def render_overall_brief_dot(self, module_prefix: str | None = None):
+        _tags, _routes, _nodes, _links = filter_graph(
+            schema=self.schema,
+            schema_field=self.schema_field,
+            tags=self.tags,
+            routes=self.routes,
+            nodes=self.nodes,
+            links=self.links,
+            node_set=self.node_set,
+        )
+
+        _tags, _routes, _nodes, _links = filter_subgraph_from_tag_to_schema_by_module_prefix(
+            module_prefix=module_prefix,
+            tags=_tags,
+            routes=_routes,
+            nodes=_nodes,
+            links=_links,
+        )
+
+        renderer = Renderer(show_fields=self.show_fields, module_color=self.module_color, schema=self.schema)
+
         _tags, _routes, _links = self.handle_hide(_tags, _routes, _links)
         return renderer.render_dot(_tags, _routes, _nodes, _links, True)

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/src/fastapi_voyager/web/index.html

@@ -218,6 +218,9 @@
                               :name="state.tag == tag.name ? 'folder' : 'folder_open'"
                             ></q-icon>
                             <span>{{ tag.name }} <q-chip style="position:relative; top: -1px;" class="q-ml-sm" dense>{{ tag.routes.length }}</q-chip></span>
+                            <a target="_blank" class="q-ml-sm" v-if="state.swaggerUrl" :href="state.swaggerUrl + '#/' + tag.name">
+                              <q-icon size="small" name="link"></q-icon>
+                            </a>
                         </div>
                       </template>
                         <q-list separator style="overflow: auto; max-height: 60vh;">
@@ -237,6 +240,9 @@
                                   name="data_object"
                                 ></q-icon>
                                 {{ route.name }}
+                                <a target="_blank" class="q-ml-sm" v-if="state.swaggerUrl" :href="state.swaggerUrl + '#/' + tag.name + '/' + route.unique_id">
+                                  <q-icon size="small" name="link"></q-icon>
+                                </a>
                               </span>
                             </q-item-section>
                           </q-item>

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/src/fastapi_voyager/web/vue-main.js

@@ -24,6 +24,7 @@ const app = createApp({
       focus: false,
       hidePrimitiveRoute: false,
       generating: false,
+      swaggerUrl: null,
       rawTags: [], // [{ name, routes: [{ id, name }] }]
       rawSchemas: new Set(), // [{ name, id }]
       rawSchemasFull: {}, // full schemas dict: { [schema.id]: schema }
@@ -78,6 +79,7 @@ const app = createApp({
           }, {});
         state.enableBriefMode = data.enable_brief_mode || false;
         state.version = data.version || "";
+        state.swaggerUrl = data.swagger_url || null
 
         // default route options placeholder
       } catch (e) {
@@ -225,7 +227,6 @@ const app = createApp({
       state.routeId = "";
       state.schemaId = null;
       // state.showFields = "object";
-      state.brief = false;
       state.focus = false;
       schemaCodeName.value = "";
       onGenerate();

{fastapi_voyager-0.10.5 → fastapi_voyager-0.11.1}/tests/programatic.py

@@ -1,5 +1,5 @@
 from fastapi_voyager import create_voyager
 from tests.demo import app
 
-app.mount('/voyager', create_voyager(app, module_color={"tests.service": "red"}, module_prefix="tests.service"))
+app.mount('/voyager', create_voyager(app, module_color={"tests.service": "red"}, module_prefix="tests.service", swagger_url='/docs'))
 # app.mount('/voyager', create_voyager(app, module_color={"tests.service": "red"}))