fastapi-voyager 0.11.1__py3-none-any.whl → 0.11.3__py3-none-any.whl

fastapi_voyager/render.py

@@ -10,10 +10,12 @@ class Renderer:
         show_fields: FieldType = 'single',
         module_color: dict[str, str] | None = None,
         schema: str | None = None,
+        show_module: bool = True
     ) -> None:
         self.show_fields = show_fields if show_fields in ('single', 'object', 'all') else 'single'
         self.module_color = module_color or {}
         self.schema = schema
+        self.show_module = show_module
 
     def render_schema_label(self, node: SchemaNode) -> str:
         has_base_fields = any(f.from_base for f in node.fields)
@@ -60,13 +62,18 @@ class Renderer:
         elif link.type == 'subset':
             return f"""{h(link.source)}:e -> {h(link.target)}:w [style = "solid, dashed", dir="back", minlen=3, taillabel = "< subset >", color = "orange", tailport="n"];"""
         elif link.type == 'tag_to_schema':
-            return f"""{h(link.source)}:e -> {h(link.target)}:w [style = "solid", dir="back", arrowtail="odot", minlen=3];"""
+            return f"""{h(link.source)}:e -> {h(link.target)}:w [style = "solid", minlen=3];"""
         else:
             raise ValueError(f'Unknown link type: {link.type}')
 
-    def render_module_schema_content(self, mods: list[ModuleNode]) -> str:
-        module_color_flag = set(self.module_color.keys())
-
+    def render_module_schema_content(self, nodes: list[SchemaNode]) -> str:
+        def render_node(node: SchemaNode) -> str:
+            return f'''
+                "{node.id}" [
+                    label = {self.render_schema_label(node)}
+                    shape = "plain"
+                    margin="0.5,0.1"
+                ];'''
         def render_module_schema(mod: ModuleNode) -> str:
             color: Optional[str] = None
 
@@ -76,14 +83,7 @@ class Renderer:
                     color = self.module_color[k]
                     break
 
-            inner_nodes = [
-                f'''
-                    "{node.id}" [
-                        label = {self.render_schema_label(node)}
-                        shape = "plain"
-                        margin="0.5,0.1"
-                    ];''' for node in mod.schema_nodes
-            ]
+            inner_nodes = [ render_node(node) for node in mod.schema_nodes ]
             inner_nodes_str = '\n'.join(inner_nodes)
             child_str = '\n'.join(render_module_schema(m) for m in mod.modules)
             return f'''
@@ -98,34 +98,49 @@ class Renderer:
                     {inner_nodes_str}
                     {child_str}
                 }}'''
-        return '\n'.join(render_module_schema(m) for m in mods)
+        if self.show_module:
+            module_schemas = build_module_schema_tree(nodes)
+            module_color_flag = set(self.module_color.keys())
+            return '\n'.join(render_module_schema(m) for m in module_schemas)
+        else:
+            return '\n'.join(render_node(n) for n in nodes)
     
-    def render_module_route(self, mod: ModuleRoute) -> str:
-        # Inner route nodes, same style as flat route_str
-        inner_nodes = [
-            f'''
-            "{r.id}" [
-                label = "    {r.name} | {r.response_schema}    "
-                margin="0.5,0.1"
-                shape = "record"
-            ];''' for r in mod.routes
-        ]
-        inner_nodes_str = '\n'.join(inner_nodes)
-        child_str = '\n'.join(self.render_module_route(m) for m in mod.modules)
-        return f'''
-            subgraph cluster_route_module_{mod.fullname.replace('.', '_')} {{
-                tooltip="{mod.fullname}"
-                color = "#666"
-                style="rounded"
-                label = "  {mod.name}"
-                labeljust = "l"
-                {inner_nodes_str}
-                {child_str}
-            }}'''
+    def render_module_route_content(self, routes: list[Route]) -> str:
+        def render_route(route: Route) -> str:
+            response_schema = route.response_schema[:25] + '..' if len(route.response_schema) > 25 else route.response_schema
+            return f'''
+                "{route.id}" [
+                    label = "    {route.name} | {response_schema}    "
+                    margin="0.5,0.1"
+                    shape = "record"
+                ];'''
+
+        def render_module_route(mod: ModuleRoute) -> str:
+            # Inner route nodes, same style as flat route_str
+            inner_nodes = [
+                render_route(r) for r in mod.routes
+            ]
+            inner_nodes_str = '\n'.join(inner_nodes)
+            child_str = '\n'.join(render_module_route(m) for m in mod.modules)
+            return f'''
+                subgraph cluster_route_module_{mod.fullname.replace('.', '_')} {{
+                    tooltip="{mod.fullname}"
+                    color = "#666"
+                    style="rounded"
+                    label = "  {mod.name}"
+                    labeljust = "l"
+                    {inner_nodes_str}
+                    {child_str}
+                }}'''
+        if self.show_module:
+            module_routes = build_module_route_tree(routes)
+            module_routes_str = '\n'.join(render_module_route(m) for m in module_routes)
+            return module_routes_str
+        else:
+            return '\n'.join(render_route(r) for r in routes)
+
 
     def render_dot(self, tags: list[Tag], routes: list[Route], nodes: list[SchemaNode], links: list[Link], spline_line=False) -> str:
-        module_schemas = build_module_schema_tree(nodes)
-        module_routes = build_module_route_tree(routes)
 
         tag_str = '\n'.join([
             f'''
@@ -136,9 +151,8 @@ class Renderer:
             ];''' for t in tags
         ])
 
-
-        module_schemas_str = self.render_module_schema_content(module_schemas)
-        module_routes_str = '\n'.join(self.render_module_route(m) for m in module_routes)
+        module_routes_str = self.render_module_route_content(routes)
+        module_schemas_str = self.render_module_schema_content(nodes)
         link_str = '\n'.join(self.render_link(link) for link in links)
 
         dot_str = f'''

fastapi_voyager/server.py

@@ -33,6 +33,7 @@ class Payload(BaseModel):
 	show_meta: bool = False
 	brief: bool = False
 	hide_primitive_route: bool = False
+	show_module: bool = True
 
 
 def create_route(
@@ -40,6 +41,7 @@ def create_route(
 	module_color: dict[str, str] | None = None,
 	swagger_url: Optional[str] = None,
 	module_prefix: Optional[str] = None,
+	online_repo_url: Optional[str] = None,
 ):
 	"""
 	module_color: dict mapping module name to color string, e.g. {'models': 'lightblue'}
@@ -77,6 +79,7 @@ def create_route(
 			module_color=module_color,
 			route_name=payload.route_name,
 			hide_primitive_route=payload.hide_primitive_route,
+			show_module=payload.show_module,
 		)
 		voyager.analysis(target_app)
 		if payload.brief:
@@ -181,7 +184,7 @@ def create_route(
 			
 			mod = __import__(module_name, fromlist=[class_name])
 			obj = getattr(mod, class_name)
-			link = get_vscode_link(obj)
+			link = get_vscode_link(obj, online_repo_url=online_repo_url)
 			
 			return JSONResponse(content={"link": link})
 		except ImportError as e:
@@ -209,8 +212,14 @@ def create_voyager(
 	gzip_minimum_size: int | None = 500,
 	module_prefix: Optional[str] = None,
 	swagger_url: Optional[str] = None,
+	online_repo_url: Optional[str] = None,
 ) -> FastAPI:
-	router = create_route(target_app, module_color=module_color, module_prefix=module_prefix, swagger_url=swagger_url)
+	router = create_route(
+		target_app, 
+		module_color=module_color, 
+		module_prefix=module_prefix, 
+		swagger_url=swagger_url,
+		online_repo_url=online_repo_url)
 
 	app = FastAPI(title="fastapi-voyager demo server")
 	if gzip_minimum_size is not None and gzip_minimum_size >= 0:

fastapi_voyager/type_helper.py

@@ -1,7 +1,7 @@
 import inspect
 import os
 from pydantic import BaseModel
-from typing import get_origin, get_args, Union, Annotated, Any, Type, Generic
+from typing import get_origin, get_args, Union, Annotated, Any, Type, Generic, Optional
 from fastapi_voyager.type import FieldInfo
 from types import UnionType
 import pydantic_resolve.constant as const
@@ -182,7 +182,7 @@ def get_pydantic_fields(schema: type[BaseModel], bases_fields: set[str]) -> list
     return fields
 
 
-def get_vscode_link(kls):
+def get_vscode_link(kls, online_repo_url: Optional[str] = None) -> str:
     """Build a VSCode deep link to the class definition.
 
     Priority:
@@ -197,6 +197,10 @@ def get_vscode_link(kls):
         _lines, start_line = inspect.getsourcelines(kls)
 
         distro = os.environ.get("WSL_DISTRO_NAME")
+        if online_repo_url:
+            cwd = os.getcwd()
+            relative_path = os.path.relpath(source_file, cwd)
+            return f"{online_repo_url}/{relative_path}#L{start_line}"
         if distro:
             # Ensure absolute path (it should already be under /) and build remote link
             return f"vscode://vscode-remote/wsl+{distro}{source_file}:{start_line}"

fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.11.1"
+__version__ = "0.11.3"

fastapi_voyager/voyager.py

@@ -27,6 +27,7 @@ class Voyager:
             module_color: dict[str, str] | None = None,
             route_name: str | None = None,
             hide_primitive_route: bool = False,
+            show_module: bool = True
         ):
 
         self.routes: list[Route] = []
@@ -48,6 +49,7 @@ class Voyager:
         self.module_color = module_color or {}
         self.route_name = route_name
         self.hide_primitive_route = hide_primitive_route
+        self.show_module = show_module
     
 
     def _get_available_route(self, app: FastAPI):
@@ -301,7 +303,7 @@ class Voyager:
             node_set=self.node_set,
         )
 
-        renderer = Renderer(show_fields=self.show_fields, module_color=self.module_color, schema=self.schema)
+        renderer = Renderer(show_fields=self.show_fields, module_color=self.module_color, schema=self.schema, show_module=self.show_module)
 
         _tags, _routes, _links = self.handle_hide(_tags, _routes, _links)
         return renderer.render_dot(_tags, _routes, _nodes, _links)
@@ -326,7 +328,7 @@ class Voyager:
             links=_links,
         )
 
-        renderer = Renderer(show_fields=self.show_fields, module_color=self.module_color, schema=self.schema)
+        renderer = Renderer(show_fields=self.show_fields, module_color=self.module_color, schema=self.schema, show_module=self.show_module)
 
         _tags, _routes, _links = self.handle_hide(_tags, _routes, _links)
         return renderer.render_dot(_tags, _routes, _nodes, _links, True)
@@ -350,7 +352,7 @@ class Voyager:
             links=_links,
         )
 
-        renderer = Renderer(show_fields=self.show_fields, module_color=self.module_color, schema=self.schema)
+        renderer = Renderer(show_fields=self.show_fields, module_color=self.module_color, schema=self.schema, show_module=self.show_module)
 
         _tags, _routes, _links = self.handle_hide(_tags, _routes, _links)
         return renderer.render_dot(_tags, _routes, _nodes, _links, True)

fastapi_voyager/web/index.html

@@ -148,6 +148,7 @@
           side="right"
           style="border-left: 1px solid #888;"
           bordered
+          overlay
         >
           <!-- 可拖拽的调整栏 -->
           <div 
@@ -265,32 +266,44 @@
               <div style="position: relative; width: 100%; height: 100%;">
                 <div id="graph" class="adjust-fit"></div>
                 <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>
+                  <div class="q-mt-sm">
                     <q-toggle
                       v-model="state.focus"
                       v-show="schemaCodeName"
                       @update:model-value="val => onFocusChange(val)"
                       label="Focus"
+                      dense
                       title="pick a schema and toggle focus on to display related nodes only"
                     />
                   </div>
-                  <div>
+                  <div class="q-mt-sm">
                     <q-toggle
                       v-if="state.enableBriefMode"
+                      dense
                       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>
+                  <div class="q-mt-sm">
                     <q-toggle
                       v-model="state.hidePrimitiveRoute"
                       @update:model-value="(val) => toggleHidePrimitiveRoute(val)"
                       label="Hide Primitive"
+                      dense
                       title="hide routes return primitive"
                     />
                   </div>
+                  <div class="q-mt-sm">
+                    <q-toggle
+                      v-model="state.showModule"
+                      @update:model-value="(val) => toggleShowModule(val)"
+                      label="Show Module Cluster"
+                      dense
+                      title="show module cluster"
+                    />
+                  </div>
                 </div>
               </div>
             </template>

fastapi_voyager/web/vue-main.js

@@ -34,6 +34,7 @@ const app = createApp({
       detailDrawer: false,
       drawerWidth: 300, // drawer 宽度
       version: "", // version from backend
+      showModule: true
     });
 
     const showDetail = ref(false);
@@ -112,6 +113,7 @@ const app = createApp({
           show_fields: state.showFields,
           brief: state.brief,
           hide_primitive_route: state.hidePrimitiveRoute,
+          show_module: state.showModule,
         };
         const res = await fetch("dot", {
           method: "POST",
@@ -261,6 +263,11 @@ const app = createApp({
       onGenerate();
     }
 
+    function toggleShowModule(val) {
+      state.showModule = val;
+      onGenerate()
+    }
+
     function toggleShowField(field) {
       state.showFields = field;
       onGenerate(false);
@@ -337,6 +344,7 @@ const app = createApp({
       toggleShowField,
       startDragDrawer,
       onFocusChange,
+      toggleShowModule
     };
   },
 });

{fastapi_voyager-0.11.1.dist-info → fastapi_voyager-0.11.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.11.1
+Version: 0.11.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
@@ -16,6 +16,8 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.10
 Requires-Dist: fastapi>=0.110
 Requires-Dist: pydantic-resolve>=1.13.2
@@ -32,7 +34,14 @@ Description-Content-Type: text/markdown
 
 > This repo is still in early stage, it supports pydantic v2 only
 
-Inspect your API interactively!  
+FastAPI can help you:
+
+- design your API
+- inspect your API
+- refactor 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)
 
@@ -51,6 +60,22 @@ uv add fastapi-voyager
 voyager -m path.to.your.app.module --server
 ```
 
+## Mount into project
+
+```python
+from fastapi import FastAPI
+from fastapi_voyager import create_voyager
+from tests.demo import app
+
+app.mount('/voyager', create_voyager(
+    app, 
+    module_color={"tests.service": "red"}, 
+    module_prefix="tests.service"),
+    swagger_url="/docs")
+```
+
+more about [sub application](https://fastapi.tiangolo.com/advanced/sub-applications/?h=sub)
+
 
 ## Feature
 
@@ -99,20 +124,6 @@ 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 import create_voyager
-from tests.demo import app
-
-app.mount('/voyager', create_voyager(
-    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
@@ -257,12 +268,14 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
         - [x] config docs path
     - [x] provide option to hide routes in brief mode (auto hide in full graph mode)
 - 0.11.2
-    - [ ] enable/disable module cluster  (to save space)
+    - [x] enable/disable module cluster  (to save space)
+- 0.11.3
+    - [x] support online repo url
+- 0.11.4
+    - [ ] add loading for field detail panel
     - [ ] logging information
     - [ ] sort field name
     - [ ] set max limit for fields
-    - [ ] add info icon alone with schema node
-    - [ ] add loading for field detail panel
 
 #### 0.12
 - [ ] add tests

{fastapi_voyager-0.11.1.dist-info → fastapi_voyager-0.11.3.dist-info}/RECORD

@@ -2,19 +2,19 @@ fastapi_voyager/__init__.py,sha256=tZy0Nkj8kTaMgbvHy-mGxVcFGVX0Km-36dnzsAIG2uk,2
 fastapi_voyager/cli.py,sha256=kQb4g6JEGZR99e5r8LyFFEeb_-uT-n_gp_sDoYG3R7k,11118
 fastapi_voyager/filter.py,sha256=GY2J9Vfsf_wbFwC-0t74-Lf-OlO77PnhEXD_rmgkfSw,11574
 fastapi_voyager/module.py,sha256=Z2QHNmiLk6ZAJlm2nSmO875Q33TweSg8UxZSzIpU9zY,3499
-fastapi_voyager/render.py,sha256=EtSkQWb3k3g6T6pnDW2GF9BM-NkDkbDjhlsnF0u-IG0,7970
-fastapi_voyager/server.py,sha256=UkTeMFduq4Ebt6eNisfPVUiy04XzHmOaZkBuwEk5mus,6617
+fastapi_voyager/render.py,sha256=vdwqIync2wsP8gMPY0v_XjRhdPBtbKyRT8yTBa_Ep3Y,8744
+fastapi_voyager/server.py,sha256=cRTUQik4rvrdZgfkFabCs6LBZnC1FVU4z3lwd1r8GNk,6839
 fastapi_voyager/type.py,sha256=VmcTB1G-LOT70EWCzi4LU_FUkSGWUIBJX15T_J5HnOo,1764
-fastapi_voyager/type_helper.py,sha256=hjBC4E0tgBpQDlYxGg74uK07SXjsrAgictEETJfIpYM,9231
-fastapi_voyager/version.py,sha256=mqCYzIn6okf6Z1_ZJPQL0K0ySha6En_onGIReGtmFxM,49
-fastapi_voyager/voyager.py,sha256=etSIrqJJQXArxYLp_45wa0kKdqSebYy9TBYbuyK0iC4,13332
+fastapi_voyager/type_helper.py,sha256=QqP4c642vEkoWTZAtl_Vvt-kys3MkVDp4BNkLrw5mHQ,9477
+fastapi_voyager/version.py,sha256=lbhVTyfJZpsKCnUAXtQjVxbGBg1jjoqiyaCQRf2W6hk,49
+fastapi_voyager/voyager.py,sha256=hNal25S5Hi_ZRe-gnmdUKt8tnRd-BRCrzaybAEJ_1HI,13498
 fastapi_voyager/web/graph-ui.js,sha256=DTedkpZNbtufexONVkJ8mOwF_-VnvxoReYHtox6IKR4,5842
 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=1WkNQ_xuS-oy4WkRChk53b9mZjATC5XZbIhPZ_pVBJQ,17317
+fastapi_voyager/web/index.html,sha256=9zp6id31DB_cWdAoCkO5NkeHCMTnNaz2VOdJO24__eM,17837
 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=ZM1BmFcA9hz6FmP5W-J1xxNE8mE_Rsj-5-dlh43zfcQ,10483
+fastapi_voyager/web/vue-main.js,sha256=sUjLmn06jYy1guwxAcouHwkcjxGD2UgZgkiiIEDbk04,10663
 fastapi_voyager/web/component/render-graph.js,sha256=e8Xgh2Kl-nYU0P1gstEmAepCgFnk2J6UdxW8TlMafGs,2322
 fastapi_voyager/web/component/route-code-display.js,sha256=8NJPPjNRUC21gjpY8XYEQs4RBbhX1pCiqEhJp39ku6k,3678
 fastapi_voyager/web/component/schema-code-display.js,sha256=UgFotzvqSuhnPXNOr6w_r1fV2_savRiCdokEvferutE,6244
@@ -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.11.1.dist-info/METADATA,sha256=K47oTptR1SQCs7hgvlhJSX9FeDO0knh-QFtgjjfe8mY,9767
-fastapi_voyager-0.11.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fastapi_voyager-0.11.1.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
-fastapi_voyager-0.11.1.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
-fastapi_voyager-0.11.1.dist-info/RECORD,,
+fastapi_voyager-0.11.3.dist-info/METADATA,sha256=2yD09_89vwgOEDQuiGN48d98XWowh8wTr4rnNNu7mVU,9960
+fastapi_voyager-0.11.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fastapi_voyager-0.11.3.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
+fastapi_voyager-0.11.3.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
+fastapi_voyager-0.11.3.dist-info/RECORD,,