fastapi-voyager 0.9.3__tar.gz → 0.9.5__tar.gz

{fastapi_voyager-0.9.3 → fastapi_voyager-0.9.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.9.3
+Version: 0.9.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
@@ -163,7 +163,7 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 
 ### backlog
 - [ ] user can generate nodes/edges manually and connect to generated ones
-    - [ ] add owner
+    - [ ] eg: add owner
     - [ ] add extra info for schema
 - [ ] display standard ER diagram `hard`
     - [ ] display potential invalid links
@@ -212,11 +212,21 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [x] improve initialization time cost
     - [x] query route / schema info through realtime api
     - [x] adjust fe
-- [x] adjust layout (0.9.3)
-    - [x] show field detail in right panel
-    - [x] show route info in bottom
+- 0.9.3
+    - [x] adjust layout 
+        - [x] show field detail in right panel
+        - [x] show route info in bottom
+- 0.9.4
+    - [x] close schema sidebar when switch tag/route
+    - [x] schema detail panel show fields by default
+    - [x] adjust schema panel's height
+    - [x] show from base information in subset case
+- 0.9.5
+    - [x] route list should have a max height 
 
 #### 0.10
+- [ ] perfomance: cache the origin data, refactor voyager.py
+- [ ] better edge for brief mode
 - [ ] support opening route in swagger
     - config docs path
 - [ ] add http method for route
@@ -224,15 +234,14 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] logging information
 - [ ] add tests
 - [ ] hide brief mode if not configured
-- [ ] optimize static resource
+- [ ] optimize static resource (allow manually config url)
 - [ ] show route count in tag expansion item
-- [ ] route list show have a max height to trigger scrollable
+- [ ] route list should have a max height to trigger scrollable
 - [ ] fix layout issue when rendering huge graph
+- [ ] fix missing route (tag has only one route which return primitive value)
 
 #### 0.11
-- [ ] improve user experience
-    - double click to show detail
-    - improve search dialog
+- [ ] improve search dialog
 
 #### 0.12
 - [ ] integration with pydantic-resolve
@@ -241,7 +250,6 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 
 #### 0.13
 - [ ] config release pipeline
-- [ ]
 
 ## Using with pydantic-resolve
 
@@ -263,37 +271,3 @@ pydantic-resolve's @ensure_subset decorator is helpful to pick fields from `sour
 - [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
 - Quasar
 
-
-## Changelog
-
-- 0.9:
-    - 0.9.3:
-        - enhancement: better UI 
-    - 0.9.2:
-        - fix: missing fields in schema detail panel
-        - optimization: clean up fe codes.
-    - 0.9.1:
-        - api change: from `create_app_with_fastapi` to `create_voyager`, and expose as `from fastapi_voyager import create_voyager`
-        - optimization: lazy load vscode link and source code, speed up the initialization.
-- 0.8:
-    - 0.8.3
-        - upgrade theme
-    - 0.8.2
-        - fix silly typo.
-    - 0.8.1
-        - add feature: hide primitive routes
-- 0.7:
-    - 0.7.5
-        - fix show all display issue
-    - 0.7.4
-        - optimize tag/route, move to left. 
-        - fresh on change, no need to click generate any more.
-    - 0.7.3
-        - fix `module_color` failure
-    - 0.7.2
-        - keep links inside filtered nodes.
-    - 0.7.1
-        - support brief mode, you can use `--module_prefix tests.service` to show links between routes and filtered schemas, to make the graph less complicated.
-- 0.6: 
-    - 0.6.2: 
-        - fix generic related issue

{fastapi_voyager-0.9.3 → fastapi_voyager-0.9.5}/README.md

@@ -136,7 +136,7 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 
 ### backlog
 - [ ] user can generate nodes/edges manually and connect to generated ones
-    - [ ] add owner
+    - [ ] eg: add owner
     - [ ] add extra info for schema
 - [ ] display standard ER diagram `hard`
     - [ ] display potential invalid links
@@ -185,11 +185,21 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [x] improve initialization time cost
     - [x] query route / schema info through realtime api
     - [x] adjust fe
-- [x] adjust layout (0.9.3)
-    - [x] show field detail in right panel
-    - [x] show route info in bottom
+- 0.9.3
+    - [x] adjust layout 
+        - [x] show field detail in right panel
+        - [x] show route info in bottom
+- 0.9.4
+    - [x] close schema sidebar when switch tag/route
+    - [x] schema detail panel show fields by default
+    - [x] adjust schema panel's height
+    - [x] show from base information in subset case
+- 0.9.5
+    - [x] route list should have a max height 
 
 #### 0.10
+- [ ] perfomance: cache the origin data, refactor voyager.py
+- [ ] better edge for brief mode
 - [ ] support opening route in swagger
     - config docs path
 - [ ] add http method for route
@@ -197,15 +207,14 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] logging information
 - [ ] add tests
 - [ ] hide brief mode if not configured
-- [ ] optimize static resource
+- [ ] optimize static resource (allow manually config url)
 - [ ] show route count in tag expansion item
-- [ ] route list show have a max height to trigger scrollable
+- [ ] route list should have a max height to trigger scrollable
 - [ ] fix layout issue when rendering huge graph
+- [ ] fix missing route (tag has only one route which return primitive value)
 
 #### 0.11
-- [ ] improve user experience
-    - double click to show detail
-    - improve search dialog
+- [ ] improve search dialog
 
 #### 0.12
 - [ ] integration with pydantic-resolve
@@ -214,7 +223,6 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 
 #### 0.13
 - [ ] config release pipeline
-- [ ]
 
 ## Using with pydantic-resolve
 
@@ -236,37 +244,3 @@ pydantic-resolve's @ensure_subset decorator is helpful to pick fields from `sour
 - [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
 - Quasar
 
-
-## Changelog
-
-- 0.9:
-    - 0.9.3:
-        - enhancement: better UI 
-    - 0.9.2:
-        - fix: missing fields in schema detail panel
-        - optimization: clean up fe codes.
-    - 0.9.1:
-        - api change: from `create_app_with_fastapi` to `create_voyager`, and expose as `from fastapi_voyager import create_voyager`
-        - optimization: lazy load vscode link and source code, speed up the initialization.
-- 0.8:
-    - 0.8.3
-        - upgrade theme
-    - 0.8.2
-        - fix silly typo.
-    - 0.8.1
-        - add feature: hide primitive routes
-- 0.7:
-    - 0.7.5
-        - fix show all display issue
-    - 0.7.4
-        - optimize tag/route, move to left. 
-        - fresh on change, no need to click generate any more.
-    - 0.7.3
-        - fix `module_color` failure
-    - 0.7.2
-        - keep links inside filtered nodes.
-    - 0.7.1
-        - support brief mode, you can use `--module_prefix tests.service` to show links between routes and filtered schemas, to make the graph less complicated.
-- 0.6: 
-    - 0.6.2: 
-        - fix generic related issue

{fastapi_voyager-0.9.3 → fastapi_voyager-0.9.5}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.9.3"
+__version__ = "0.9.5"

{fastapi_voyager-0.9.3 → fastapi_voyager-0.9.5}/src/fastapi_voyager/voyager.py

@@ -144,6 +144,11 @@ class Voyager:
         """
         full_name = full_class_name(schema)
         bases_fields = get_bases_fields([s for s in schema.__bases__ if is_inheritance_of_pydantic_base(s)])
+        
+        subset_reference = getattr(schema, const.ENSURE_SUBSET_REFERENCE, None)
+        if subset_reference and is_inheritance_of_pydantic_base(subset_reference):
+            bases_fields.update(get_bases_fields([subset_reference]))
+
         if full_name not in self.node_set:
             # skip meta info for normal queries
             self.node_set[full_name] = SchemaNode(

{fastapi_voyager-0.9.3 → fastapi_voyager-0.9.5}/src/fastapi_voyager/web/component/schema-code-display.js

@@ -20,7 +20,7 @@ export default defineComponent({
     const link = ref("");
     const error = ref("");
     const fields = ref([]); // schema fields list
-    const tab = ref("source");
+    const tab = ref("fields");
 
 
     async function highlightLater() {
@@ -138,24 +138,21 @@ export default defineComponent({
 
       <div style="padding:8px 12px 0 12px; box-sizing:border-box;">
         <q-tabs v-model="tab" align="left" dense active-color="primary" indicator-color="primary" class="text-grey-8">
-          <q-tab name="source" label="Source Code" />
           <q-tab name="fields" label="Fields" />
+          <q-tab name="source" label="Source Code" />
         </q-tabs>
       </div>
       <q-separator />
-      <div style="padding:8px 16px 16px 16px; height:75%; box-sizing:border-box; overflow:auto;">
+      <div style="padding:8px 16px 16px 16px; box-sizing:border-box; overflow:auto;">
         <div v-if="error" style="color:#c10015; font-family:Menlo, monospace; font-size:12px;">{{ error }}</div>
         <template v-else>
-          <div v-show="tab === 'source'">
-            <pre style="margin:0;"><code class="language-python">{{ code }}</code></pre>
-          </div>
           <div v-show="tab === 'fields'">
             <table style="border-collapse:collapse; width:100%; font-size:12px; font-family:Menlo, monospace;">
               <thead>
                 <tr>
                   <th style="text-align:left; border-bottom:1px solid #ddd; padding:4px 6px;">Field</th>
                   <th style="text-align:left; border-bottom:1px solid #ddd; padding:4px 6px;">Type</th>
-                  <th style="text-align:left; border-bottom:1px solid #ddd; padding:4px 6px;">From Base</th>
+                  <th style="text-align:left; border-bottom:1px solid #ddd; padding:4px 6px;">Inherited</th>
                 </tr>
               </thead>
               <tbody>
@@ -170,6 +167,9 @@ export default defineComponent({
               </tbody>
             </table>
           </div>
+          <div v-show="tab === 'source'">
+            <pre style="margin:0;"><code class="language-python">{{ code }}</code></pre>
+          </div>
         </template>
       </div>
 	</div>

{fastapi_voyager-0.9.3 → fastapi_voyager-0.9.5}/src/fastapi_voyager/web/graph-ui.js

@@ -105,6 +105,31 @@ export class GraphUI {
           self._highlight();
         });
 
+        // svg 背景点击高亮清空
+
+        $(document).off('click.graphui').on('click.graphui', function (evt) {
+          // 如果点击目标不在 graph 容器内，直接退出
+          const graphContainer = $(self.selector)[0];
+          if (!graphContainer || !evt.target || !graphContainer.contains(evt.target)) {
+            return;
+          }
+
+          let isNode = false;
+          const $nodes = self.gv.nodes();
+          const node = evt.target.parentNode;
+          $nodes.each(function () {
+            if (this === node) {
+              isNode = true;
+            }
+          });
+          if (!isNode && self.gv) {
+            self.gv.highlight();
+            if (self.options.resetCb) {
+              self.options.resetCb();
+            }
+          }
+        });
+
         $(document).on("keydown.graphui", function (evt) {
           if (evt.keyCode === 27 && self.gv) {
             self.gv.highlight();

{fastapi_voyager-0.9.3 → fastapi_voyager-0.9.5}/src/fastapi_voyager/web/index.html

@@ -163,7 +163,7 @@
 
         <q-drawer
           v-model="state.detailDrawer"
-          width="400"
+          width="500"
           side="right"
           overlay
           bordered
@@ -178,7 +178,6 @@
               icon="chevron_right"
             />
           </div>
-          <!-- move to bottom -->
           <schema-code-display
             :schema-name="schemaCodeName"
             :schemas="state.rawSchemasFull"
@@ -221,43 +220,42 @@
                               class="q-mr-sm"
                               :name="state.tag == tag.name ? 'folder' : 'folder_open'"
                             ></q-icon>
-                            <span>{{ tag.name }}</span>
+                            <span>{{ tag.name }} <q-chip class="q-ml-sm" dense>{{ tag.routes.length }}</q-chip></span>
                           </div>
                         </div>
                       </template>
-
-                      <q-list separator>
-                        <q-item
-                          v-for="route in (state.hidePrimitiveRoute ? tag.routes.filter(r => !r.is_primitive) :tag.routes || [])"
-                          :key="route.id"
-                          clickable
-                          v-ripple
-                          :active="state.routeId === route.id"
-                          active-class=""
-                          @click="selectRoute(route.id)"
-                        >
-                          <q-item-section>
-                            <span class="q-ml-lg" style="white-space: nowrap">
-                              <q-icon
-                                class="q-mr-sm"
-                                name="data_object"
-                              ></q-icon>
-                              {{ route.name }}
-                            </span>
-                          </q-item-section>
-                        </q-item>
-                        <q-item
-                          v-if="!tag.routes || tag.routes.length === 0"
-                          dense
-                        >
-                          <q-item-section class="text-grey-6"
-                            >No routes</q-item-section
+                        <q-list separator style="overflow: auto; max-height: 60vh;">
+                          <q-item
+                            v-for="route in (state.hidePrimitiveRoute ? tag.routes.filter(r => !r.is_primitive) :tag.routes || [])"
+                            :key="route.id"
+                            clickable
+                            v-ripple
+                            :active="state.routeId === route.id"
+                            active-class=""
+                            @click="selectRoute(route.id)"
+                          >
+                            <q-item-section>
+                              <span class="q-ml-lg" style="white-space: nowrap">
+                                <q-icon
+                                  class="q-mr-sm"
+                                  name="data_object"
+                                ></q-icon>
+                                {{ route.name }}
+                              </span>
+                            </q-item-section>
+                          </q-item>
+                          <q-item
+                            v-if="!tag.routes || tag.routes.length === 0"
+                            dense
                           >
-                        </q-item>
-                      </q-list>
+                            <q-item-section class="text-grey-6"
+                              >No routes</q-item-section
+                            >
+                          </q-item>
+                        </q-list>
+                      </q-scroll-area>
                     </q-expansion-item>
                   </q-list>
-                </q-scroll-area>
               </div>
             </template>
 
@@ -290,9 +288,12 @@
         />
       </q-dialog>
 
-      <q-dialog v-model="showRouteDetail" position="bottom">
-        <q-card style="width: 1100px; max-width: 1100px">
-          <route-code-display :route-id="routeCodeId" @close="showRouteDetail=false" />
+      <q-dialog v-model="showRouteDetail" seamless position="bottom">
+        <q-card style="width: 1100px; max-width: 1100px; max-height: 40vh">
+          <route-code-display
+            :route-id="routeCodeId"
+            @close="showRouteDetail=false"
+          />
         </q-card>
       </q-dialog>
 

{fastapi_voyager-0.9.3 → fastapi_voyager-0.9.5}/src/fastapi_voyager/web/vue-main.js

@@ -27,7 +27,7 @@ const app = createApp({
       initializing: true,
       // Splitter size (left panel width in px)
       splitter: 300,
-      detailDrawer: false
+      detailDrawer: false,
     });
 
     const showDetail = ref(false);
@@ -42,7 +42,7 @@ const app = createApp({
     const schemaFieldFilterSchema = ref(null); // external schemaName for schema-field-filter
     const schemaCodeName = ref("");
     const routeCodeId = ref("");
-    const showRouteDetail = ref(false)
+    const showRouteDetail = ref(false);
 
     function openDetail() {
       showDetail.value = true;
@@ -109,13 +109,17 @@ const app = createApp({
           onSchemaClick: (id) => {
             if (state.rawSchemas.has(id)) {
               schemaCodeName.value = id;
-              state.detailDrawer = true
+              state.detailDrawer = true;
             }
             if (id in state.routeItems) {
               routeCodeId.value = id;
-              showRouteDetail.value = true
+              showRouteDetail.value = true;
             }
           },
+          resetCb: () => {
+            state.detailDrawer = false;
+            showRouteDetail.value = false;
+          }
         });
 
         await graphUI.render(dotText, resetZoom);
@@ -202,8 +206,9 @@ const app = createApp({
         state.tag = tagName;
         state.routeId = "";
         onGenerate();
-        return;
       }
+      state.detailDrawer = false;
+      showRouteDetail.value = false;
     }
 
     function selectRoute(routeId) {
@@ -212,6 +217,8 @@ const app = createApp({
       } else {
         state.routeId = routeId;
       }
+      state.detailDrawer = false;
+      showRouteDetail.value = false;
       onGenerate();
     }