fastapi-voyager 0.7.5__py3-none-any.whl → 0.8.1__py3-none-any.whl

fastapi_voyager/render.py

@@ -104,7 +104,7 @@ class Renderer:
         inner_nodes = [
             f'''
             "{r.id}" [
-                label = "    {r.name}    "
+                label = "    {r.name}: {r.response_schema}    "
                 margin="0.5,0.1"
                 shape = "record"
             ];''' for r in mod.routes

fastapi_voyager/server.py

@@ -32,7 +32,8 @@ class Payload(BaseModel):
 	route_name: Optional[str] = None
 	show_fields: str = 'object'
 	show_meta: bool = False
-	brief: bool = False
+	brief: bool = False,
+	hide_primitive_route: bool = False,
 
 def create_route(
 	target_app: FastAPI,
@@ -73,6 +74,7 @@ def create_route(
 			module_color=module_color,
 			route_name=payload.route_name,
 			load_meta=False,
+			hide_primitive_route=payload.hide_primitive_route,
 		)
 		voyager.analysis(target_app)
 		if payload.brief:

fastapi_voyager/type.py

@@ -24,6 +24,8 @@ class Route(NodeBase):
     module: str
     source_code: str = ''
     vscode_link: str = ''  # optional vscode deep link
+    response_schema: str = ''
+    is_primitive: bool = True
 
 @dataclass
 class ModuleRoute:

fastapi_voyager/type_helper.py

@@ -276,6 +276,12 @@ def is_generic_container(cls):
         return (hasattr(cls, '__bases__') and Generic in cls.__bases__ and (hasattr(cls, '__parameters__') and bool(cls.__parameters__)))
     except (TypeError, AttributeError):
         return False
+    
+def is_non_pydantic_type(tp):
+    for schema in get_core_types(tp):
+        if schema and issubclass(schema, BaseModel):
+            return False
+    return True
 
 if __name__ == "__main__":
     from tests.demo_anno import PageSprint, PageOverall

fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.7.5"
+__version__ = "0.8.1"

fastapi_voyager/voyager.py

@@ -8,7 +8,9 @@ from fastapi_voyager.type_helper import (
     get_pydantic_fields,
     get_vscode_link,
     get_source,
-    update_forward_refs
+    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
@@ -26,6 +28,7 @@ class Voyager:
             include_tags: list[str] | None = None,
             module_color: dict[str, str] | None = None,
             route_name: str | None = None,
+            hide_primitive_route: bool = False,
             load_meta: bool = False
         ):
 
@@ -48,6 +51,7 @@ class Voyager:
         self.module_color = module_color or {}
         self.route_name = route_name
         self.load_meta = load_meta
+        self.hide_primitive_route = hide_primitive_route
     
 
     def _get_available_route(self, app: FastAPI):
@@ -88,29 +92,37 @@ class Voyager:
             # filter by route_name (route.id) if provided
             if self.route_name is not None and route_id != self.route_name:
                 continue
+            is_primitive_response = is_non_pydantic_type(route.response_model)
+            
+            # filter primitive route if needed
+            if self.hide_primitive_route and is_primitive_response:
+                continue
+
+            self.links.append(Link(
+                source=tag_id,
+                source_origin=tag_id,
+                target=route_id,
+                target_origin=route_id,
+                type='tag_route'
+            ))
 
             route_obj = Route(
                 id=route_id,
                 name=route_name,
                 module=route_module,
                 vscode_link=get_vscode_link(route.endpoint) if self.load_meta else '',
-                source_code=inspect.getsource(route.endpoint) if self.load_meta else ''
+                source_code=inspect.getsource(route.endpoint) if self.load_meta else '',
+                response_schema=get_type_name(route.response_model),
+                is_primitive=is_primitive_response
             )
-
             self.routes.append(route_obj)
             # add route into current tag
             self.tag_set[tag_id].routes.append(route_obj)
-            self.links.append(Link(
-                source=tag_id,
-                source_origin=tag_id,
-                target=route_id,
-                target_origin=route_id,
-                type='tag_route'
-            ))
 
             # add response_models and create links from route -> response_model
             for schema in get_core_types(route.response_model):
                 if schema and issubclass(schema, BaseModel):
+                    is_primitive_response = False
                     target_name = full_class_name(schema)
                     self.links.append(Link(
                         source=route_id,

fastapi_voyager/web/index.html

@@ -88,6 +88,9 @@
         "
       >
         <div class="row items-center q-col-gutter-md">
+          <div class="col-auto">
+            <div style="width: 282px; margin-left: 8px;" class="text-h6">FastAPI Voyager</div>
+          </div>
           <div class="col-auto">
             <div class="column">
               <q-option-group
@@ -101,9 +104,6 @@
             </div>
           </div>
 
-          <div class="col-auto">
-            <q-toggle v-model="state.brief" label="Brief" dense />
-          </div>
 
           <!-- <div class="col-auto">
             <q-btn-dropdown
@@ -126,6 +126,10 @@
           </div> -->
 
           <div class="col-auto q-ml-auto">
+            <q-toggle class="q-ml-md" v-model="state.brief" label="Brief Mode" title="config module_prefix to enable it" dense />
+            <q-toggle class="q-ml-md" v-model="state.hidePrimitiveRoute" label="Hide Primitive Routes" title="" dense />
+          </div>
+          <div class="col-auto">
             <q-btn outline @click="onReset" title="may be very slow" label="Show All" />
           </div>
           <div class="col-auto">
@@ -184,21 +188,20 @@
                 v-for="tag in state.rawTags"
                 :key="tag.name"
                 expand-separator
-                switch-toggle-side
                 :model-value="state.tag === tag.name"
                 @update:model-value="(val) => toggleTag(tag.name, val)"
-                :header-class="state.tag === tag.name ? 'bg-primary text-white text-weight-medium' : 'text-weight-medium'"
+                :header-class="state.tag === tag.name ? 'text-primary text-bold' : ''"
                 content-class="q-pa-none"
               >
                 <template #header>
-                  <div class="row items-center no-wrap" style="width: 100%">
-                    <div class="col text-body2">{{ tag.name }}</div>
+                  <div class="row items-center" style="width: 100%">
+                    <div class="">{{ tag.name }}</div>
                   </div>
                 </template>
 
                 <q-list separator>
                   <q-item
-                    v-for="route in (tag.routes || [])"
+                    v-for="route in (state.hidePrimitiveRoute ? tag.routes.filter(r => !r.is_primitive) :tag.routes || [])"
                     :key="route.id"
                     clickable
                     v-ripple
@@ -206,7 +209,9 @@
                     active-class=""
                     @click="selectRoute(route.id)"
                   >
-                    <q-item-section>{{ route.name }}</q-item-section>
+                    <q-item-section>
+                      <span class="q-ml-sm"> <span style="font-weight: bold;">⋅</span> &nbsp; {{ 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>

fastapi_voyager/web/vue-main.js

@@ -23,6 +23,7 @@ const app = createApp({
         { label: "All fields", value: "all" },
       ],
       brief: false,
+      hidePrimitiveRoute: false,
       generating: false,
       rawTags: [], // [{ name, routes: [{ id, name }] }]
       rawSchemas: [], // [{ name, fullname }]
@@ -51,20 +52,6 @@ const app = createApp({
       showDetail.value = false;
     }
 
-    const skipNextRouteGenerate = ref(false);
-
-    function applyRoutesForTag(tagName) {
-      const tag = state.rawTags.find((t) => t.name === tagName);
-      state.routeOptions = [];
-      if (tag && Array.isArray(tag.routes)) {
-        state.routeOptions.push(
-          ...tag.routes.map((r) => ({ label: r.name, value: r.id }))
-        );
-      }
-      skipNextRouteGenerate.value = true;
-      state.routeId = "";
-    }
-
     function onFilterTags(val, update) {
       const normalized = (val || "").toLowerCase();
       update(() => {
@@ -137,6 +124,7 @@ const app = createApp({
           route_name: state.routeId || null,
           show_fields: state.showFields,
           brief: state.brief,
+          hide_primitive_route: state.hidePrimitiveRoute
         };
 
         const res = await fetch("dot", {
@@ -257,44 +245,45 @@ const app = createApp({
     }
 
     function selectRoute(routeId) {
-      state.routeId = state.routeId === routeId ? "" : routeId;
+      if (state.routeId === routeId) {
+        state.routeId = ''
+      } else {
+        state.routeId = routeId
+      }
+      onGenerate()
     }
 
     // react to tag changes to rebuild routes
     watch(
       () => state.tag,
       (val) => {
-        applyRoutesForTag(val);
         if (!state.initializing) {
+          state.routeId = ''
           onGenerate();
         }
       }
     );
 
     watch(
-      () => state.routeId,
+      () => state.showFields,
       () => {
-        if (skipNextRouteGenerate.value) {
-          skipNextRouteGenerate.value = false;
-          return;
-        }
         if (!state.initializing) {
           onGenerate();
         }
       }
-    );
+    )
 
     watch(
-      () => state.showFields,
+      () => state.brief,
       () => {
         if (!state.initializing) {
           onGenerate();
         }
       }
-    )
+    );
 
     watch(
-      () => state.brief,
+      () => state.hidePrimitiveRoute,
       () => {
         if (!state.initializing) {
           onGenerate();

{fastapi_voyager-0.7.5.dist-info → fastapi_voyager-0.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.7.5
+Version: 0.8.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
@@ -44,6 +44,9 @@ pip install fastapi-voyager
 uv add fastapi-voyager
 ```
 
+```shell
+voyager -m path.to.your.app.module --server
+```
 
 ## Dependencies
 
@@ -98,6 +101,21 @@ click a node to highlight it's upperstream and downstream nodes. figure out the
 <img width="882" height="445" alt="image" src="https://github.com/user-attachments/assets/158560ef-63ca-4991-9b7d-587be4fa04e4" />
 
 
+## Mount to target project
+
+```python
+from fastapi import FastAPI
+from fastapi_voyager.server import create_app_with_fastapi
+from tests.demo import app
+
+app.mount('/voyager', create_app_with_fastapi(
+    app, 
+    module_color={"tests.service": "red"}, 
+    module_prefix="tests.service"))
+```
+
+more about [sub application](https://fastapi.tiangolo.com/advanced/sub-applications/?h=sub)
+
 
 ## Command Line Usage
 
@@ -170,9 +188,11 @@ features:
 - [ ] click field to highlight links
 - [ ] user can generate nodes/edges manually and connect to generated ones
     - [ ] add owner
+    - [ ] add extra info for schema
 - [ ] ui optimization
     - [ ] fixed left/right bar show field information
-- [ ] display standard ER diagram `difficult`
+    - [x] fixed left bar show tag/ route
+- [ ] display standard ER diagram `difference`
     - [ ] display potential invalid links
 - [ ] integration with pydantic-resolve
     - [ ] show difference between resolve, post fields
@@ -181,12 +201,14 @@ features:
 - [x] export voyager core data into json (for better debugging)
     - [x] add api to rebuild core data from json, and render it
 - [x] fix Generic case  `test_generic.py`
+- [ ] show tips for routes not return pydantic type.
+- [ ] add http method for route
 
 bugs & non feature:
 - [x] fix duplicated link from class and parent class, it also break clicking highlight
 - [ ] add tests
-- [ ] refactor
-    - [ ] abstract render module
+- [x] refactor
+    - [x] abstract render module
 
 ## Using with pydantic-resolve
 
@@ -203,6 +225,9 @@ TODO: ...
 
 ## Changelog
 
+- 0.8:
+    - 0.8.1
+        - add feature: hide primitive routes
 - 0.7:
     - 0.7.5
         - fix show all display issue

{fastapi_voyager-0.7.5.dist-info → fastapi_voyager-0.8.1.dist-info}/RECORD

@@ -2,19 +2,19 @@ fastapi_voyager/__init__.py,sha256=E5WTV_sYs2LK8I6jzA7AuvFU5a8_vjnDseC3DMha0iQ,1
 fastapi_voyager/cli.py,sha256=2eixX7mtPsZvukc4vrwQOt6XTPJgHUKIGLBy3IIC2jE,11127
 fastapi_voyager/filter.py,sha256=2Yt37o8mhqSqleafO4YRrumh_ExYUqzXFOxQRPuTbAc,8078
 fastapi_voyager/module.py,sha256=Z2QHNmiLk6ZAJlm2nSmO875Q33TweSg8UxZSzIpU9zY,3499
-fastapi_voyager/render.py,sha256=rOJEKqiIAPowa3kZheRIgZMnbNzHQz9QoJM5aWUfXXs,7744
-fastapi_voyager/server.py,sha256=UT-fHggdqicIo5m3uUX86-XFhAVDLXpXBsBQwd1HdIg,4001
-fastapi_voyager/type.py,sha256=nad4WNxTcZFi7Mskw6p2W7v2Gs4f0giVLNoFjZlKmbA,1778
-fastapi_voyager/type_helper.py,sha256=f2Gy5r3Zi6a2wTkbqU9W-AkvcetajEYCfroACzcIcVY,9064
-fastapi_voyager/version.py,sha256=6qBRnYL6PIB365jAxd_3kCArchSbLRDY1CXzkj2QbvA,48
-fastapi_voyager/voyager.py,sha256=uOQEzrs3o6UUUswvHGRKELNWYUH1ix0Z7SbzMHwm320,10709
+fastapi_voyager/render.py,sha256=qy3g1Rz1s8XkuR_6n1Q1YPwy_oMOjWjNswTHQjdz4N0,7765
+fastapi_voyager/server.py,sha256=t0Qby5No2XIVPPOn_wcJDOasJ05V7pQ4xtTDI8lgPSQ,4093
+fastapi_voyager/type.py,sha256=k62cDofqmy-2q5rInW5LydLaRuDpKLsdbapps8Osqys,1838
+fastapi_voyager/type_helper.py,sha256=hjBC4E0tgBpQDlYxGg74uK07SXjsrAgictEETJfIpYM,9231
+fastapi_voyager/version.py,sha256=_cyxd8_oDXTOvUSRCStr2n0IhvzG9mtX5ww-UZQFRbg,48
+fastapi_voyager/voyager.py,sha256=sy2chniANvZ5e4CjZzANTrA9RJcvr4aNoNygvusb5wc,11262
 fastapi_voyager/web/graph-ui.js,sha256=eEjDnJVMvk35LdRoxcqX_fZxLFS9_bUrGAZL6K2O5C0,4176
 fastapi_voyager/web/graphviz.svg.css,sha256=zDCjjpT0Idufu5YOiZI76PL70-avP3vTyzGPh9M85Do,1563
 fastapi_voyager/web/graphviz.svg.js,sha256=lvAdbjHc-lMSk4GQp-iqYA2PCFX4RKnW7dFaoe0LUHs,16005
-fastapi_voyager/web/index.html,sha256=oTGaZmYqqCdlaX2EtSm_nYzYstvvV5MD_YUxUcMm29s,12331
+fastapi_voyager/web/index.html,sha256=iv4Fd0RsX854ZWrfSnVn-369_ky9ubFlK36vLiAbd0w,12760
 fastapi_voyager/web/quasar.min.css,sha256=F5jQe7X2XT54VlvAaa2V3GsBFdVD-vxDZeaPLf6U9CU,203145
 fastapi_voyager/web/quasar.min.js,sha256=h0ftyPMW_CRiyzeVfQqiup0vrVt4_QWojpqmpnpn07E,502974
-fastapi_voyager/web/vue-main.js,sha256=nnl5OgGdua9jysqwWXknBIjGeZV2GF2ICxxL47kpsR0,9900
+fastapi_voyager/web/vue-main.js,sha256=f4re2Hys0FOli3R_AZ_byUd08YLScDZ01xf1hXeoHCA,9529
 fastapi_voyager/web/component/render-graph.js,sha256=e8Xgh2Kl-nYU0P1gstEmAepCgFnk2J6UdxW8TlMafGs,2322
 fastapi_voyager/web/component/route-code-display.js,sha256=NECC1OGcPCdDfbghtRJEnmFM6HmH5J3win2ibapWPeA,2649
 fastapi_voyager/web/component/schema-code-display.js,sha256=oOusgTvCaWGnoKb-NBwu0SXqJJf2PTUtp3lUczokTBM,5515
@@ -26,8 +26,8 @@ fastapi_voyager/web/icon/favicon-16x16.png,sha256=JC07jEzfIYxBIoQn_FHXvyHuxESdhW
 fastapi_voyager/web/icon/favicon-32x32.png,sha256=C7v1h58cfWOsiLp9yOIZtlx-dLasBcq3NqpHVGRmpt4,1859
 fastapi_voyager/web/icon/favicon.ico,sha256=tZolYIXkkBcFiYl1A8ksaXN2VjGamzcSdes838dLvNc,15406
 fastapi_voyager/web/icon/site.webmanifest,sha256=ep4Hzh9zhmiZF2At3Fp1dQrYQuYF_3ZPZxc1KcGBvwQ,263
-fastapi_voyager-0.7.5.dist-info/METADATA,sha256=mUQ-9OpixGnInICIvRV-1yQOsN8Qi3hQJI2xR0Tud2c,7372
-fastapi_voyager-0.7.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fastapi_voyager-0.7.5.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
-fastapi_voyager-0.7.5.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
-fastapi_voyager-0.7.5.dist-info/RECORD,,
+fastapi_voyager-0.8.1.dist-info/METADATA,sha256=1t2J9aFVGAkBjY9dB_mnHsK8BUQJ2dnL6kycUX_PDhI,8044
+fastapi_voyager-0.8.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fastapi_voyager-0.8.1.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
+fastapi_voyager-0.8.1.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
+fastapi_voyager-0.8.1.dist-info/RECORD,,