fastapi-voyager 0.10.1__tar.gz → 0.10.3__tar.gz

{fastapi_voyager-0.10.1 → fastapi_voyager-0.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.10.1
+Version: 0.10.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
@@ -226,12 +226,20 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [x] route list should have a max height 
 
 #### 0.10
-- [x] refactor voyager.py tag -> route structure
-- [x] fix missing route (tag has only one route which return primitive value)
-- [x] make right panel resizable by dragging
-- [x] allow closing tag expansion item
-- [x] hide brief mode if not configured
-- [x] add focus button to only show related nodes under current route/tag graph in dialog
+- 0.10.1
+    - [x] refactor voyager.py tag -> route structure
+    - [x] fix missing route (tag has only one route which return primitive value)
+    - [x] make right panel resizable by dragging
+    - [x] allow closing tag expansion item
+    - [x] hide brief mode if not configured
+    - [x] add focus button to only show related nodes under current route/tag graph in dialog
+- 0.10.2
+    - [x] fix graph height
+    - [x] show version in title
+- 0.10.3
+    - [x] fix focus in brief-mode
+    - [x] ui: adjust focus position
+    - [x] refactor naming
 
 #### 0.11
 - [ ] enable/disable module cluster  (to save space)

{fastapi_voyager-0.10.1 → fastapi_voyager-0.10.3}/README.md

@@ -199,12 +199,20 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [x] route list should have a max height 
 
 #### 0.10
-- [x] refactor voyager.py tag -> route structure
-- [x] fix missing route (tag has only one route which return primitive value)
-- [x] make right panel resizable by dragging
-- [x] allow closing tag expansion item
-- [x] hide brief mode if not configured
-- [x] add focus button to only show related nodes under current route/tag graph in dialog
+- 0.10.1
+    - [x] refactor voyager.py tag -> route structure
+    - [x] fix missing route (tag has only one route which return primitive value)
+    - [x] make right panel resizable by dragging
+    - [x] allow closing tag expansion item
+    - [x] hide brief mode if not configured
+    - [x] add focus button to only show related nodes under current route/tag graph in dialog
+- 0.10.2
+    - [x] fix graph height
+    - [x] show version in title
+- 0.10.3
+    - [x] fix focus in brief-mode
+    - [x] ui: adjust focus position
+    - [x] refactor naming
 
 #### 0.11
 - [ ] enable/disable module cluster  (to save space)

{fastapi_voyager-0.10.1 → fastapi_voyager-0.10.3}/src/fastapi_voyager/filter.py

@@ -106,7 +106,7 @@ def filter_graph(
     return _tags, _routes, _nodes, _links
 
 
-def filter_subgraph(
+def filter_subgraph_by_module_prefix(
     *,
     tags: list[Tag],
     routes: list[Route],

{fastapi_voyager-0.10.1 → fastapi_voyager-0.10.3}/src/fastapi_voyager/server.py

@@ -9,6 +9,7 @@ from fastapi_voyager.voyager import Voyager
 from fastapi_voyager.type import Tag, FieldInfo, CoreData, SchemaNode
 from fastapi_voyager.render import Renderer
 from fastapi_voyager.type_helper import get_source, get_vscode_link
+from fastapi_voyager.version import __version__
 
 
 WEB_DIR = Path(__file__).parent / "web"
@@ -20,6 +21,7 @@ class OptionParam(BaseModel):
 	schemas: list[SchemaNode]
 	dot: str
 	enable_brief_mode: bool
+	version: str
 
 class Payload(BaseModel):
 	tags: Optional[list[str]] = None
@@ -54,7 +56,7 @@ 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))
+		return OptionParam(tags=tags, schemas=schemas, dot=dot, enable_brief_mode=bool(module_prefix), version=__version__)
 
 	@router.post("/dot", response_class=PlainTextResponse)
 	def get_filtered_dot(payload: Payload) -> str:

{fastapi_voyager-0.10.1 → fastapi_voyager-0.10.3}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.10.1"
+__version__ = "0.10.3"

{fastapi_voyager-0.10.1 → fastapi_voyager-0.10.3}/src/fastapi_voyager/voyager.py

@@ -14,7 +14,7 @@ from fastapi_voyager.type_helper import (
 )
 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
+from fastapi_voyager.filter import filter_graph, filter_subgraph_by_module_prefix
 from fastapi_voyager.render import Renderer
 import pydantic_resolve.constant as const
 
@@ -308,14 +308,25 @@ class Voyager:
         return renderer.render_dot(_tags, _routes, _nodes, _links)
     
     def render_brief_dot(self, module_prefix: str | None = None):
-        _tags, _routes, _nodes, _links = filter_subgraph(
-            module_prefix=module_prefix,
+        _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_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=None)
+
+        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.1 → fastapi_voyager-0.10.3}/src/fastapi_voyager/web/index.html

@@ -57,7 +57,7 @@
     }
 
     .adjust-fit {
-      height: calc(100% - 54px);
+      height: calc(100vh - 54px);
     }
   </style>
   <body>
@@ -67,10 +67,11 @@
           <q-toolbar class="row text-grey-9 bg-white" style="width: 100%">
             <div
               class="col-auto text-primary"
-              style="font-size: 16px; font-weight: bold"
+              style="font-size: 18px; font-weight: bold; display: flex; align-items: baseline;"
             >
               <q-icon class="q-mr-sm" name="satellite_alt"></q-icon>
               <span> FastAPI Voyager </span>
+              <span v-if="state.version" style="font-size: 12px; margin-left: 8px; font-weight: normal;">{{ state.version }}</span>
             </div>
             <div class="col-auto" style="font-size: 16px">
               <q-option-group
@@ -151,7 +152,6 @@
                         shift + click to see schema's dependencies without
                         unrelated nodes
                       </li>
-                      <li>alt + click to see schema details</li>
                     </ul>
                   </div>
                 </q-tooltip>
@@ -279,13 +279,14 @@
 
             <template #after>
               <div style="position: relative; width: 100%; height: 100%;">
-                <div id="graph" class="fit"></div>
+                <div id="graph" class="adjust-fit"></div>
                 <q-toggle
                   v-model="state.focus"
                   v-show="schemaCodeName"
                   @update:model-value="val => onFocusChange(val)"
                   label="Focus"
-                  style="position: absolute; left: 8px; top: 8px; z-index: 10; background: rgba(255,255,255,0.85); border-radius: 4px; padding: 2px 8px;"
+                  title="pick a schema and toggle focus on to display related nodes only"
+                  style="position: absolute; left: 8px; bottom: 8px; z-index: 10; background: rgba(255,255,255,0.85); border-radius: 4px; padding: 2px 8px;"
                   size="sm"
                 />
               </div>

{fastapi_voyager-0.10.1 → fastapi_voyager-0.10.3}/src/fastapi_voyager/web/vue-main.js

@@ -31,7 +31,8 @@ const app = createApp({
       // Splitter size (left panel width in px)
       splitter: 300,
       detailDrawer: false,
-      drawerWidth: 500, // drawer 宽度
+      drawerWidth: 300, // drawer 宽度
+      version: "", // version from backend
     });
 
     const showDetail = ref(false);
@@ -75,6 +76,7 @@ const app = createApp({
             return acc;
           }, {});
         state.enableBriefMode = data.enable_brief_mode || false;
+        state.version = data.version || "";
 
         // default route options placeholder
       } catch (e) {
@@ -91,7 +93,6 @@ const app = createApp({
         await onGenerate(false, null)
         setTimeout(() => {
           const ele = $(`[data-name='${schemaCodeName.value}'] polygon`)
-          debugger
           ele.click()
         }, 1)
       }
@@ -119,11 +120,13 @@ const app = createApp({
         const graphUI = new GraphUI("#graph", {
           onSchemaShiftClick: (id) => {
             if (state.rawSchemas.has(id)) {
+              resetDetailPanels()
               schemaFieldFilterSchema.value = id;
               showSchemaFieldFilter.value = true;
             }
           },
           onSchemaClick: (id) => {
+            resetDetailPanels()
             if (state.rawSchemas.has(id)) {
               schemaCodeName.value = id;
               state.detailDrawer = true;
@@ -134,9 +137,7 @@ const app = createApp({
             }
           },
           resetCb: () => {
-            state.detailDrawer = false;
-            showRouteDetail.value = false;
-            schemaCodeName.value = ''
+            resetDetailPanels()
           }
         });
 
@@ -210,6 +211,12 @@ const app = createApp({
       showSchemaFieldFilter.value = true;
     }
 
+    function resetDetailPanels() {
+      state.detailDrawer = false
+      showRouteDetail.value = false;
+      schemaCodeName.value = ''
+    }
+
     async function onReset() {
       state.tag = null;
       state.routeId = "";

{fastapi_voyager-0.10.1 → fastapi_voyager-0.10.3}/tests/test_filter.py

@@ -1,4 +1,4 @@
-from fastapi_voyager.filter import filter_subgraph
+from fastapi_voyager.filter import filter_subgraph_by_module_prefix
 from fastapi_voyager.type import Tag, Route, SchemaNode, Link, PK
 
 
@@ -42,7 +42,7 @@ def test_filter_subgraph_filters_nodes_and_links():
     routes = [route]
     nodes = [node_a, node_b]
 
-    _, _, filtered_nodes, filtered_links = filter_subgraph(
+    _, _, filtered_nodes, filtered_links = filter_subgraph_by_module_prefix(
         tags=tags,
         routes=routes,
         links=links,
@@ -110,7 +110,7 @@ def test_filter_subgraph_handles_cycles_and_multiple_matches():
 
     nodes = [node_root, node_mid, node_target1, node_target2]
 
-    _, _, filtered_nodes, filtered_links = filter_subgraph(
+    _, _, filtered_nodes, filtered_links = filter_subgraph_by_module_prefix(
         tags=[tag],
         routes=[route],
         links=links,