fastapi-voyager 0.10.2__tar.gz → 0.10.4__tar.gz

{fastapi_voyager-0.10.2 → fastapi_voyager-0.10.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.10.2
+Version: 0.10.4
 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
@@ -32,7 +32,9 @@ Description-Content-Type: text/markdown
 
 > This repo is still in early stage, it supports pydantic v2 only
 
-Inspect your API interactively!
+Inspect your API interactively!  
+
+[visit online demo](https://www.newsyeah.fun/voyager/) of project: [composition oriented development pattern](https://github.com/allmonday/composition-oriented-development-pattern)
 
 <p align="center"><img src="./voyager.jpg" alt="" /></p>
 <p align="center"><a target="_blank" rel="" href="https://www.youtube.com/watch?v=PGlbQq1M-n8"><img src="http://img.youtube.com/vi/PGlbQq1M-n8/0.jpg" alt="" style="max-width: 100%;"></a></p>
@@ -170,6 +172,8 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] optimize static resource (allow manually config url)
 - [ ] improve search dialog
     - [ ] add route/tag list
+- [ ] type alias should not be kept as node instead of compiling to original type
+- [ ] how to correctly handle the generic type ?
 
 ### in analysis
 - [ ] click field to highlight links
@@ -236,6 +240,13 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - 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.10.4
+    - [x] fix: when focus is on, should ensure changes from other params not broken.
+    
 
 #### 0.11
 - [ ] enable/disable module cluster  (to save space)
@@ -244,6 +255,7 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] support opening route in swagger
     - config docs path
 - [ ] add tests
+- [ ] fix: focus should reset zoom
 
 #### 0.12
 - [ ] integration with pydantic-resolve

{fastapi_voyager-0.10.2 → fastapi_voyager-0.10.4}/README.md

@@ -5,7 +5,9 @@
 
 > This repo is still in early stage, it supports pydantic v2 only
 
-Inspect your API interactively!
+Inspect your API interactively!  
+
+[visit online demo](https://www.newsyeah.fun/voyager/) of project: [composition oriented development pattern](https://github.com/allmonday/composition-oriented-development-pattern)
 
 <p align="center"><img src="./voyager.jpg" alt="" /></p>
 <p align="center"><a target="_blank" rel="" href="https://www.youtube.com/watch?v=PGlbQq1M-n8"><img src="http://img.youtube.com/vi/PGlbQq1M-n8/0.jpg" alt="" style="max-width: 100%;"></a></p>
@@ -143,6 +145,8 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] optimize static resource (allow manually config url)
 - [ ] improve search dialog
     - [ ] add route/tag list
+- [ ] type alias should not be kept as node instead of compiling to original type
+- [ ] how to correctly handle the generic type ?
 
 ### in analysis
 - [ ] click field to highlight links
@@ -209,6 +213,13 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - 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.10.4
+    - [x] fix: when focus is on, should ensure changes from other params not broken.
+    
 
 #### 0.11
 - [ ] enable/disable module cluster  (to save space)
@@ -217,6 +228,7 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] support opening route in swagger
     - config docs path
 - [ ] add tests
+- [ ] fix: focus should reset zoom
 
 #### 0.12
 - [ ] integration with pydantic-resolve

{fastapi_voyager-0.10.2 → fastapi_voyager-0.10.4}/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.2 → fastapi_voyager-0.10.4}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.10.2"
+__version__ = "0.10.4"

{fastapi_voyager-0.10.2 → fastapi_voyager-0.10.4}/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.2 → fastapi_voyager-0.10.4}/src/fastapi_voyager/web/index.html

@@ -64,7 +64,7 @@
     <div id="q-app">
       <q-layout view="hHh lpR fff">
         <q-header bordered class="bg-primary text-white">
-          <q-toolbar class="row text-grey-9 bg-white" style="width: 100%">
+          <q-toolbar class="row text-grey-9 bg-white" style="width: 100%; border-bottom: 2px solid #009485;">
             <div
               class="col-auto text-primary"
               style="font-size: 18px; font-weight: bold; display: flex; align-items: baseline;"
@@ -86,39 +86,21 @@
               />
             </div>
             <div class="col-auto q-ml-auto">
-              <q-toggle
-                v-if="state.enableBriefMode"
-                class="q-mr-md"
-                v-model="state.brief"
-                label="Brief Mode"
-                @update:model-value="(val) => toggleBrief(val)"
-                title="skip middle classes, config module_prefix to enable it"
-                dense
-              />
-            </div>
-            <div class="col-auto">
-              <q-toggle
-                v-model="state.hidePrimitiveRoute"
-                @update:model-value="(val) => toggleHidePrimitiveRoute(val)"
-                label="Hide Primitive"
-                title="hide routes return primitive"
-                class="q-mr-md"
-                dense
-              />
-            </div>
-            <div class="col-auto">
               <q-btn
                 outline
                 @click="onReset"
                 title="may be very slow"
-                class="q-mr-md"
-                label="Show All"
+                icon="border_all"
+                flat
+                class="q-mr-sm"
+                label="Full Graph"
               />
             </div>
             <div class="col-auto">
               <q-btn
                 outline
                 icon="search"
+                flat
                 label="Search"
                 class="q-mr-md"
                 @click="showDialog()"
@@ -131,7 +113,7 @@
                 flat
                 icon="help_outline"
                 aria-label="Help"
-                class="q-mr-sm"
+                style="margin-right: 40px"
               >
                 <q-tooltip
                   anchor="bottom middle"
@@ -152,12 +134,11 @@
                         shift + click to see schema's dependencies without
                         unrelated nodes
                       </li>
-                      <li>alt + click to see schema details</li>
                     </ul>
                   </div>
                 </q-tooltip>
               </q-btn>
-            </div>
+            <a href="https://github.com/allmonday/fastapi-voyager" target="_blank" class="github-corner" aria-label="View source on GitHub"><svg width="52" height="52" viewBox="0 0 250 250" style="fill:#009485; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"/><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"/><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"/></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style></div>
             <!-- <q-toolbar-title class="text-primary row">
             </q-toolbar-title> -->
           </q-toolbar>
@@ -233,14 +214,13 @@
                       content-class="q-pa-none"
                     >
                       <template #header>
-                        <div class="row items-center" style="width: 100%">
-                          <div class="row items-center">
+                        <div class="" style="white-space: nowrap; width: 100%">
                             <q-icon
+                              style="vertical-align: top;"
                               class="q-mr-sm"
                               :name="state.tag == tag.name ? 'folder' : 'folder_open'"
                             ></q-icon>
-                            <span>{{ tag.name }} <q-chip class="q-ml-sm" dense>{{ tag.routes.length }}</q-chip></span>
-                          </div>
+                            <span>{{ tag.name }} <q-chip style="position:relative; top: -1px;" class="q-ml-sm" dense>{{ tag.routes.length }}</q-chip></span>
                         </div>
                       </template>
                         <q-list separator style="overflow: auto; max-height: 60vh;">
@@ -281,14 +261,34 @@
             <template #after>
               <div style="position: relative; width: 100%; height: 100%;">
                 <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;"
-                  size="sm"
-                />
+                <div style="position: absolute; left: 8px; bottom: 8px; z-index: 10; background: rgba(255,255,255,0.85); border-radius: 4px; padding: 2px 8px;">
+                  <div>
+                    <q-toggle
+                      v-model="state.focus"
+                      v-show="schemaCodeName"
+                      @update:model-value="val => onFocusChange(val)"
+                      label="Focus"
+                      title="pick a schema and toggle focus on to display related nodes only"
+                    />
+                  </div>
+                  <div>
+                    <q-toggle
+                      v-if="state.enableBriefMode"
+                      v-model="state.brief"
+                      label="Brief Mode"
+                      @update:model-value="(val) => toggleBrief(val)"
+                      title="skip middle classes, config module_prefix to enable it"
+                    />
+                  </div>
+                  <div>
+                    <q-toggle
+                      v-model="state.hidePrimitiveRoute"
+                      @update:model-value="(val) => toggleHidePrimitiveRoute(val)"
+                      label="Hide Primitive"
+                      title="hide routes return primitive"
+                    />
+                  </div>
+                </div>
               </div>
             </template>
           </q-splitter>

{fastapi_voyager-0.10.2 → fastapi_voyager-0.10.4}/src/fastapi_voyager/web/vue-main.js

@@ -88,18 +88,18 @@ const app = createApp({
 
     async function onFocusChange(val) {
       if (val) {
-        await onGenerate(false, schemaCodeName.value)
+        await onGenerate(false)
       } else {
-        await onGenerate(false, null)
+        await onGenerate(false)
         setTimeout(() => {
           const ele = $(`[data-name='${schemaCodeName.value}'] polygon`)
-          debugger
           ele.click()
         }, 1)
       }
     }
 
-    async function onGenerate(resetZoom = true, schema_name = null) {
+    async function onGenerate(resetZoom = true) {
+      const schema_name = state.focus ? schemaCodeName.value : null;
       state.generating = true;
       try {
         const payload = {
@@ -121,11 +121,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;
@@ -136,9 +138,7 @@ const app = createApp({
             }
           },
           resetCb: () => {
-            state.detailDrawer = false;
-            showRouteDetail.value = false;
-            schemaCodeName.value = ''
+            resetDetailPanels()
           }
         });
 
@@ -212,6 +212,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.2 → fastapi_voyager-0.10.4}/tests/demo.py

@@ -98,6 +98,10 @@ def get_page_test_2():
 def get_page_test_3_long_long_long_name():
     return True
 
-@app.get("/page_test_4/", tags=['for-page', 'group_b'])
+@app.get("/page_test_4/", tags=['for-page'])
+def get_page_test_3_no_response_model():
+    return True
+
+@app.get("/page_test_5/", tags=['long_long_long_tag_name', 'group_b'])
 def get_page_test_3_no_response_model():
     return True

{fastapi_voyager-0.10.2 → fastapi_voyager-0.10.4}/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,