fastapi-voyager 0.9.2__tar.gz → 0.9.4__tar.gz

{fastapi_voyager-0.9.2 → fastapi_voyager-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.9.2
+Version: 0.9.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
@@ -27,6 +27,8 @@ Description-Content-Type: text/markdown
 
 [![pypi](https://img.shields.io/pypi/v/fastapi-voyager.svg)](https://pypi.python.org/pypi/fastapi-voyager)
 ![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-voyager)
+[![PyPI Downloads](https://static.pepy.tech/badge/fastapi-voyager/month)](https://pepy.tech/projects/fastapi-voyager)
+
 
 > This repo is still in early stage, it supports pydantic v2 only
 
@@ -163,7 +165,6 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] user can generate nodes/edges manually and connect to generated ones
     - [ ] add owner
     - [ ] add extra info for schema
-- [ ] fixed left/right bar show field information
 - [ ] display standard ER diagram `hard`
     - [ ] display potential invalid links
 - [ ] support dataclass (pending)
@@ -211,6 +212,15 @@ 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
+- 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.10
 - [ ] support opening route in swagger
@@ -235,6 +245,9 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [ ] show hint for resolve, post fields
     - [ ] display loader as edges
 
+#### 0.13
+- [ ] config release pipeline
+- [ ]
 
 ## Using with pydantic-resolve
 
@@ -256,35 +269,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.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.2 → fastapi_voyager-0.9.4}/README.md

@@ -1,5 +1,7 @@
 [![pypi](https://img.shields.io/pypi/v/fastapi-voyager.svg)](https://pypi.python.org/pypi/fastapi-voyager)
 ![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-voyager)
+[![PyPI Downloads](https://static.pepy.tech/badge/fastapi-voyager/month)](https://pepy.tech/projects/fastapi-voyager)
+
 
 > This repo is still in early stage, it supports pydantic v2 only
 
@@ -136,7 +138,6 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] user can generate nodes/edges manually and connect to generated ones
     - [ ] add owner
     - [ ] add extra info for schema
-- [ ] fixed left/right bar show field information
 - [ ] display standard ER diagram `hard`
     - [ ] display potential invalid links
 - [ ] support dataclass (pending)
@@ -184,6 +185,15 @@ 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
+- 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.10
 - [ ] support opening route in swagger
@@ -208,6 +218,9 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [ ] show hint for resolve, post fields
     - [ ] display loader as edges
 
+#### 0.13
+- [ ] config release pipeline
+- [ ]
 
 ## Using with pydantic-resolve
 
@@ -229,35 +242,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.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.2 → fastapi_voyager-0.9.4}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.9.2"
+__version__ = "0.9.4"

{fastapi_voyager-0.9.2 → fastapi_voyager-0.9.4}/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.2 → fastapi_voyager-0.9.4}/src/fastapi_voyager/web/component/route-code-display.js

@@ -3,12 +3,10 @@ const { defineComponent, ref, watch, onMounted } = window.Vue;
 // Component: RouteCodeDisplay
 // Props:
 //   routeId: route id key in routeItems
-//   modelValue: dialog visibility
 export default defineComponent({
   name: "RouteCodeDisplay",
   props: {
     routeId: { type: String, required: true },
-    modelValue: { type: Boolean, default: false },
   },
   emits: ["close"],
   setup(props, { emit }) {
@@ -99,32 +97,26 @@ export default defineComponent({
       }
     }
 
-    watch(
-      () => props.modelValue,
-      (v) => {
-        if (v) load();
-      }
-    );
     watch(
       () => props.routeId,
       () => {
-        if (props.modelValue) load();
+        load();
       }
     );
 
     onMounted(() => {
-      if (props.modelValue) load();
+      load();
     });
 
     return { loading, code, error, close, link };
   },
   template: `
-  <div class="frv-route-code-display" style="border:1px solid #ccc; position:relative; width:50vw; max-width:50vw; height:100%; background:#fff;">
+  <div class="frv-route-code-display" style="border:1px solid #ccc; position:relative; background:#fff;">
     <q-btn dense flat round icon="close" @click="close" aria-label="Close" style="position:absolute; top:6px; right:6px; z-index:10; background:rgba(255,255,255,0.85)" />
     <div v-if="link" class="q-ml-md q-mt-md" style="padding-top:4px;">
       <a :href="link" target="_blank" rel="noopener" style="font-size:12px; color:#3b82f6;">Open in VSCode</a>
     </div>
-    <div style="padding:40px 16px 16px 16px; height:100%; box-sizing:border-box; overflow:auto;">
+    <div style="padding:40px 16px 16px 16px; box-sizing:border-box; overflow:auto;">
       <div v-if="loading" style="font-family:Menlo, monospace; font-size:12px;">Loading source...</div>
       <div v-else-if="error" style="color:#c10015; font-family:Menlo, monospace; font-size:12px;">{{ error }}</div>
       <pre v-else style="margin:0;"><code class="language-python">{{ code }}</code></pre>

{fastapi_voyager-0.9.2 → fastapi_voyager-0.9.4}/src/fastapi_voyager/web/component/schema-code-display.js

@@ -13,23 +13,17 @@ export default defineComponent({
   name: "SchemaCodeDisplay",
   props: {
     schemaName: { type: String, required: true },
-    modelValue: { type: Boolean, default: false },
     schemas: { type: Object, default: () => ({}) },
   },
-  emits: ["close"],
   setup(props, { emit }) {
-    const loading = ref(false);
     const code = ref("");
     const link = ref("");
     const error = ref("");
     const fields = ref([]); // schema fields list
-    const tab = ref("source");
+    const tab = ref("fields");
 
-    function close() {
-      emit("close");
-    }
 
-    function highlightLater() {
+    async function highlightLater() {
       // wait a tick for DOM update
       requestAnimationFrame(() => {
         try {
@@ -38,6 +32,10 @@ export default defineComponent({
               ".frv-code-display pre code.language-python"
             );
             if (block) {
+              // If already highlighted by highlight.js, remove the flag so it can be highlighted again
+              if (block.dataset && block.dataset.highlighted) {
+                block.removeAttribute("data-highlighted");
+              }
               window.hljs.highlightElement(block);
             }
           }
@@ -50,7 +48,6 @@ export default defineComponent({
     async function loadSource() {
       if (!props.schemaName) return;
 
-      loading.value = true;
       error.value = null;
       code.value = "";
       link.value = "";
@@ -77,7 +74,6 @@ export default defineComponent({
       } catch (e) {
         error.value = "Failed to load source";
       } finally {
-        loading.value = false;
       }
 
       try {
@@ -99,12 +95,12 @@ export default defineComponent({
       } catch (e) {
         error.value = "Failed to load source";
       } finally {
-        loading.value = false;
       }
 
-      fields.value = props.schemas[props.schemaName].fields || []
+      const schema = props.schemas && props.schemas[props.schemaName];
+      fields.value = Array.isArray(schema?.fields) ? schema.fields : [];
 
-      if (!error.value && tab.value === "source") {
+      if (tab.value === "source") {
         highlightLater();
       }
     }
@@ -120,25 +116,21 @@ export default defineComponent({
     );
 
     watch(
-      () => props.modelValue,
-      (val) => {
-        if (val) {
-          loadSource();
-        }
-      }
+      () => props.schemaName,
+      () => {
+        loadSource();
+      },
     );
 
     onMounted(() => {
-      if (props.modelValue) loadSource();
+      loadSource();
     });
 
-    return { loading, link, code, error, close, fields, tab };
+    return { link, code, error, fields, tab };
   },
   template: `
-  <div class="frv-code-display" style="border: 1px solid #ccc; border-left: none; position:relative; width:40vw; max-width:40vw; height:100%; background:#fff;">
-			<q-btn dense flat round icon="close" @click="close" aria-label="Close"
-				style="position:absolute; top:6px; right:6px; z-index:10; background:rgba(255,255,255,0.85)" />
-      <div v-if="link" class="q-ml-md q-mt-md">
+  <div class="frv-code-display" style="border: 1px solid #ccc; border-left: none; position:relative; height:100%; background:#fff;">
+      <div class="q-ml-lg q-mt-md">
         <a :href="link" target="_blank" rel="noopener" style="font-size:12px; color:#3b82f6;">
           Open in VSCode
         </a>
@@ -146,25 +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 v-if="loading" style="font-family:Menlo, monospace; font-size:12px;">Loading source...</div>
-        <div v-else-if="error" style="color:#c10015; font-family:Menlo, monospace; font-size:12px;">{{ error }}</div>
+      <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>
@@ -179,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.2 → fastapi_voyager-0.9.4}/src/fastapi_voyager/web/graph-ui.js

@@ -69,23 +69,27 @@ export class GraphUI {
           const set = $();
           set.push(this);
           const obj = { set, direction: "bidirectional" };
-          // Shift+Click to trigger schema detail callback (if provided)
+
+          const schemaName = event.currentTarget.dataset.name;
           if (event.shiftKey && self.options.onSchemaClick) {
             // try data-name or title text
-            const schemaName = event.currentTarget.dataset.name;
             if (schemaName) {
               try {
-                self.options.onSchemaClick(schemaName);
+                self.options.onSchemaShiftClick(schemaName);
               } catch (e) {
-                console.warn("onSchemaClick callback failed", e);
+                console.warn("onSchemaShiftClick callback failed", e);
               }
             }
-          } else if (event.altKey && self.options.onSchemaAltClick) {
-            const schemaName = event.currentTarget.dataset.name;
-            self.options.onSchemaAltClick(schemaName);
           } else {
             self.currentSelection = [obj];
             self._highlight();
+            if (schemaName) {
+              try {
+                self.options.onSchemaClick(schemaName);
+              } catch (e) {
+                console.warn("onSchemaClick callback failed", e);
+              }
+            }
           }
         });
 
@@ -101,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();