fastapi-voyager 0.7.6__tar.gz → 0.8.1__tar.gz

{fastapi_voyager-0.7.6 → fastapi_voyager-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.7.6
+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
@@ -108,7 +108,10 @@ 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))
+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)
@@ -198,6 +201,8 @@ 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
@@ -220,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.6 → fastapi_voyager-0.8.1}/README.md

@@ -81,7 +81,10 @@ 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))
+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)
@@ -171,6 +174,8 @@ 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
@@ -193,6 +198,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.6 → fastapi_voyager-0.8.1}/src/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-0.7.6 → fastapi_voyager-0.8.1}/src/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-0.7.6 → fastapi_voyager-0.8.1}/src/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-0.7.6 → fastapi_voyager-0.8.1}/src/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-0.7.6 → fastapi_voyager-0.8.1}/src/fastapi_voyager/version.py

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

{fastapi_voyager-0.7.6 → fastapi_voyager-0.8.1}/src/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-0.7.6 → fastapi_voyager-0.8.1}/src/fastapi_voyager/web/index.html

@@ -104,9 +104,6 @@
             </div>
           </div>
 
-          <div class="col-auto">
-            <q-toggle class="q-ml-md" v-model="state.brief" label="Brief Mode" title="config module_prefix to enable it" dense />
-          </div>
 
           <!-- <div class="col-auto">
             <q-btn-dropdown
@@ -129,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">
@@ -200,7 +201,7 @@
 
                 <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
@@ -209,8 +210,8 @@
                     @click="selectRoute(route.id)"
                   >
                     <q-item-section>
-                      <span class="q-ml-sm"> {{ route.name }} </span>
-                      </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-0.7.6 → fastapi_voyager-0.8.1}/src/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 }]
@@ -123,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", {
@@ -243,7 +245,11 @@ const app = createApp({
     }
 
     function selectRoute(routeId) {
-      state.routeId = routeId
+      if (state.routeId === routeId) {
+        state.routeId = ''
+      } else {
+        state.routeId = routeId
+      }
       onGenerate()
     }
 
@@ -276,6 +282,15 @@ const app = createApp({
       }
     );
 
+    watch(
+      () => state.hidePrimitiveRoute,
+      () => {
+        if (!state.initializing) {
+          onGenerate();
+        }
+      }
+    );
+
     onMounted(async () => {
       await loadInitial();
     });

{fastapi_voyager-0.7.6 → fastapi_voyager-0.8.1}/tests/demo.py

@@ -77,4 +77,8 @@ def get_page_test_1():
 
 @app.get("/page_test_2/", tags=['for-page'], response_model=A)
 def get_page_test_2():
-    return {}
+    return {}
+
+@app.get("/page_test_3/", tags=['for-page'], response_model=bool)
+def get_page_test_3():
+    return True

fastapi_voyager-0.8.1/tests/programatic.py

@@ -0,0 +1,4 @@
+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"))

fastapi_voyager-0.7.6/tests/programatic.py

@@ -1,8 +0,0 @@
-from fastapi import FastAPI
-from fastapi_voyager.server import create_app_with_fastapi
-from tests.demo import app as demo_app
-
-subapp = create_app_with_fastapi(demo_app)
-
-app = FastAPI()
-app.mount("/xxx", subapp)