fastapi-voyager 0.5.3__py3-none-any.whl → 0.6.2__py3-none-any.whl

fastapi_voyager/cli.py

@@ -169,6 +169,12 @@ Examples:
         default=8000,
         help="Port for the preview server when --server is used (default: 8000)"
     )
+    parser.add_argument(
+        "--host",
+        type=str,
+        default="127.0.0.1",
+        help="Host/IP for the preview server when --server is used (default: 127.0.0.1). Use 0.0.0.0 to listen on all interfaces."
+    )
     
     parser.add_argument(
         "--version", "-v",
@@ -267,8 +273,8 @@ Examples:
                 print("Error: uvicorn is required to run the server. Install via 'pip install uvicorn' or 'uv add uvicorn'.")
                 sys.exit(1)
             app_server = viz_server.create_app_with_fastapi(app, module_color=module_color)
-            print(f"Starting preview server at http://127.0.0.1:{args.port} ... (Ctrl+C to stop)")
-            uvicorn.run(app_server, host="127.0.0.1", port=args.port)
+            print(f"Starting preview server at http://{args.host}:{args.port} ... (Ctrl+C to stop)")
+            uvicorn.run(app_server, host=args.host, port=args.port)
         else:
             # Generate and write dot file locally
             generate_visualization(

fastapi_voyager/server.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 from typing import Optional
-from fastapi import FastAPI
+from fastapi import FastAPI, APIRouter
 from starlette.middleware.gzip import GZipMiddleware
 from pydantic import BaseModel
 from fastapi.responses import HTMLResponse, PlainTextResponse, JSONResponse
@@ -33,23 +33,13 @@ class Payload(BaseModel):
 	show_fields: str = 'object'
 	show_meta: bool = False
 
-def create_app_with_fastapi(
+def create_route(
 	target_app: FastAPI,
 	module_color: dict[str, str] | None = None,
-	gzip_minimum_size: int | None = 500,
-) -> FastAPI:
-	"""Create a FastAPI server that serves DOT computed via Analytics.
-
-	This avoids module-level globals by keeping state in closures.
-	"""
-
-	app = FastAPI(title="fastapi-voyager demo server")
+):
+	router = APIRouter(tags=['fastapi-voyager'])
 
-	# Enable gzip compression for larger responses (e.g. DOT / schemas payload)
-	if gzip_minimum_size is not None and gzip_minimum_size >= 0:
-		app.add_middleware(GZipMiddleware, minimum_size=gzip_minimum_size)
-
-	@app.get("/dot", response_model=OptionParam)
+	@router.get("/dot", response_model=OptionParam)
 	def get_dot() -> str:
 		voyager = Voyager(module_color=module_color, load_meta=True)
 		voyager.analysis(target_app)
@@ -71,7 +61,7 @@ def create_app_with_fastapi(
 
 		return OptionParam(tags=tags, schemas=schemas, dot=dot)
 
-	@app.post("/dot", response_class=PlainTextResponse)
+	@router.post("/dot", response_class=PlainTextResponse)
 	def get_filtered_dot(payload: Payload) -> str:
 		voyager = Voyager(
 			include_tags=payload.tags,
@@ -85,7 +75,7 @@ def create_app_with_fastapi(
 		voyager.analysis(target_app)
 		return voyager.render_dot()
 
-	@app.post("/dot-core-data", response_model=CoreData)
+	@router.post("/dot-core-data", response_model=CoreData)
 	def get_filtered_dot_core_data(payload: Payload) -> str:
 		voyager = Voyager(
 			include_tags=payload.tags,
@@ -98,13 +88,13 @@ def create_app_with_fastapi(
 		)
 		voyager.analysis(target_app)
 		return voyager.dump_core_data()
-	
-	@app.post('/dot-render-core-data', response_class=PlainTextResponse)
+
+	@router.post('/dot-render-core-data', response_class=PlainTextResponse)
 	def render_dot_from_core_data(core_data: CoreData) -> str:
 		renderer = Renderer(show_fields=core_data.show_fields, module_color=core_data.module_color, schema=core_data.schema)
 		return renderer.render_dot(core_data.tags, core_data.routes, core_data.nodes, core_data.links)
 
-	@app.get("/", response_class=HTMLResponse)
+	@router.get("/", response_class=HTMLResponse)
 	def index():
 		index_file = WEB_DIR / "index.html"
 		if index_file.exists():
@@ -120,8 +110,22 @@ def create_app_with_fastapi(
 		</html>
 		"""
 
-	# Serve static files under /static
-	app.mount("/static", StaticFiles(directory=str(WEB_DIR)), name="static")
+	return router
+
+
+def create_app_with_fastapi(
+	target_app: FastAPI,
+	module_color: dict[str, str] | None = None,
+	gzip_minimum_size: int | None = 500,
+) -> FastAPI:
+	router = create_route(target_app, module_color=module_color)
+
+	app = FastAPI(title="fastapi-voyager demo server")
+	if gzip_minimum_size is not None and gzip_minimum_size >= 0:
+		app.add_middleware(GZipMiddleware, minimum_size=gzip_minimum_size)
+
+	app.mount("/fastapi-voyager-static", StaticFiles(directory=str(WEB_DIR)), name="static")
+	app.include_router(router)
 
 	return app
 

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
+from typing import get_origin, get_args, Union, Annotated, Any, Type, Generic
 from fastapi_voyager.type import FieldInfo
 from types import UnionType
 import pydantic_resolve.constant as const
@@ -142,7 +142,7 @@ def get_type_name(anno):
 
 
 def is_inheritance_of_pydantic_base(cls):
-    return issubclass(cls, BaseModel) and cls is not BaseModel
+    return safe_issubclass(cls, BaseModel) and cls is not BaseModel and not is_generic_container(cls)
 
 
 def get_bases_fields(schemas: list[type[BaseModel]]) -> set[str]:
@@ -228,6 +228,7 @@ def safe_issubclass(kls, classinfo):
     try:
         return issubclass(kls, classinfo)
     except TypeError:
+        print(kls.__name__, 'is not a class')
         return False
 
 
@@ -255,6 +256,27 @@ def update_forward_refs(kls):
         if safe_issubclass(shelled_type, BaseModel):
             update_pydantic_forward_refs(shelled_type)
 
+
+def is_generic_container(cls):
+    """
+    T = TypeVar('T')
+    class DataModel(BaseModel, Generic[T]):
+        data: T
+        id: int
+
+    type DataModelPageStory = DataModel[PageStory]
+
+    is_generic_container(DataModel) -> True
+    is_generic_container(DataModel[PageStory]) -> False
+
+    DataModel.__parameters__ == (T,)
+    DataModelPageStory.__parameters__ == (,)
+    """
+    try:
+        return (hasattr(cls, '__bases__') and Generic in cls.__bases__ and (hasattr(cls, '__parameters__') and bool(cls.__parameters__)))
+    except (TypeError, AttributeError):
+        return False
+
 if __name__ == "__main__":
     from tests.demo_anno import PageSprint, PageOverall
 

fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.5.3"
+__version__ = "0.6.2"

fastapi_voyager/web/component/render-graph.js

@@ -31,7 +31,7 @@ export default defineComponent({
 			if (!props.coreData) return;
 			loading.value = true;
 			try {
-				const res = await fetch("/dot-render-core-data", {
+				const res = await fetch("dot-render-core-data", {
 					method: "POST",
 					headers: { "Content-Type": "application/json" },
 					body: JSON.stringify(props.coreData),

fastapi_voyager/web/component/schema-field-filter.js

@@ -81,7 +81,7 @@ export default defineComponent({
           schema_field: state.fieldName || null,
           show_fields: state.showFields,
         };
-        const res = await fetch("/dot", {
+        const res = await fetch("dot", {
           method: "POST",
           headers: { "Content-Type": "application/json" },
           body: JSON.stringify(payload),

fastapi_voyager/web/index.html

@@ -2,14 +2,14 @@
   <head>
     <title>FastAPI Voyager</title>
     <meta name="theme-color" content="#ffffff" />
-    <link rel="stylesheet" href="/static/graphviz.svg.css" />
-    <link rel="stylesheet" href="/static/quasar.min.css" />
+    <link rel="stylesheet" href="fastapi-voyager-static/graphviz.svg.css" />
+    <link rel="stylesheet" href="fastapi-voyager-static/quasar.min.css" />
     <!-- App Icons / Favicons -->
-    <link rel="apple-touch-icon" sizes="180x180" href="/static/icon/apple-touch-icon.png" />
-    <link rel="icon" type="image/png" sizes="32x32" href="/static/icon/favicon-32x32.png" />
-    <link rel="icon" type="image/png" sizes="16x16" href="/static/icon/favicon-16x16.png" />
-    <link rel="icon" href="/static/icon/favicon.ico" sizes="any" />
-    <link rel="manifest" href="/static/icon/site.webmanifest" />
+    <link rel="apple-touch-icon" sizes="180x180" href="fastapi-voyager-static/icon/apple-touch-icon.png" />
+    <link rel="icon" type="image/png" sizes="32x32" href="fastapi-voyager-static/icon/favicon-32x32.png" />
+    <link rel="icon" type="image/png" sizes="16x16" href="fastapi-voyager-static/icon/favicon-16x16.png" />
+    <link rel="icon" href="fastapi-voyager-static/icon/favicon.ico" sizes="any" />
+    <link rel="manifest" href="fastapi-voyager-static/icon/site.webmanifest" />
     <link
       href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900|Material+Icons"
       rel="stylesheet"
@@ -265,8 +265,8 @@
 
     <!-- Add the following at the end of your body tag -->
     <script src="https://cdnjs.cloudflare.com/ajax/libs/vue/3.5.22/vue.global.prod.min.js" integrity="sha512-Y9sKU0AwzWRxKSLd2i35LuDpUdHY/E9tJrKG0mxw0qYQ75VVgGYazIUQPwKhFK9vGO3jIgAtxLiSq8GQ7PDfUg==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
-    <script src="/static/quasar.min.js"></script>
-    <script src="/static/graphviz.svg.js"></script>
+    <script src="fastapi-voyager-static/quasar.min.js"></script>
+    <script src="fastapi-voyager-static/graphviz.svg.js"></script>
     <!-- highlight.js minimal ES module load (python only) -->
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github.min.css" />
     <script type="module">
@@ -275,6 +275,6 @@
       hljs.registerLanguage('python', python);
       window.hljs = hljs;
     </script>
-    <script type="module" src="/static/vue-main.js"></script>
+    <script type="module" src="fastapi-voyager-static/vue-main.js"></script>
   </body>
 </html>

fastapi_voyager/web/vue-main.js

@@ -37,8 +37,8 @@ const app = createApp({
     const dumpJson = ref("");
     const showImportDialog = ref(false);
     const importJsonText = ref("");
-  const showRenderGraph = ref(false);
-  const renderCoreData = ref(null);
+    const showRenderGraph = ref(false);
+    const renderCoreData = ref(null);
     const schemaName = ref(""); // used by detail dialog
     const schemaFieldFilterSchema = ref(null); // external schemaName for schema-field-filter
     const schemaCodeName = ref("");
@@ -94,7 +94,7 @@ const app = createApp({
     async function loadInitial() {
       state.initializing = true;
       try {
-        const res = await fetch("/dot");
+        const res = await fetch("dot");
         const data = await res.json();
         state.rawTags = Array.isArray(data.tags) ? data.tags : [];
         state.rawSchemasFull = Array.isArray(data.schemas) ? data.schemas : [];
@@ -134,7 +134,7 @@ const app = createApp({
           show_fields: state.showFields,
         };
 
-        const res = await fetch("/dot", {
+        const res = await fetch("dot", {
           method: "POST",
           headers: { "Content-Type": "application/json" },
           body: JSON.stringify(payload),
@@ -180,7 +180,7 @@ const app = createApp({
           route_name: state.routeId || null,
           show_fields: state.showFields,
         };
-        const res = await fetch("/dot-core-data", {
+        const res = await fetch("dot-core-data", {
           method: "POST",
           headers: { "Content-Type": "application/json" },
           body: JSON.stringify(payload),

{fastapi_voyager-0.5.3.dist-info → fastapi_voyager-0.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.5.3
+Version: 0.6.2
 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
@@ -183,13 +183,7 @@ features
     - [ ] abstract render module
 - [ ] export voyager core data into json (for better debugging)
     - [ ] add api to rebuild core data from json, and render it
-- [ ] fix Generic case
-
-```python
-    class Paged(BaseModel, Generic[T]):
-    total: int
-    items: List[T]
-```
+- [x] fix Generic case  `test_generic.py`
 
 bugs:
 - [ ] fix duplicated link from class and parent class, it also break clicking highlight
@@ -205,3 +199,9 @@ TODO: ...
 
 - https://apis.guru/graphql-voyager/, for inspiration.
 - https://github.com/tintinweb/vscode-interactive-graphviz, for web visualization.
+
+
+## Changelog
+
+- 0.6.2: 
+    - fix generic related issue

{fastapi_voyager-0.5.3.dist-info → fastapi_voyager-0.6.2.dist-info}/RECORD

@@ -1,24 +1,24 @@
 fastapi_voyager/__init__.py,sha256=E5WTV_sYs2LK8I6jzA7AuvFU5a8_vjnDseC3DMha0iQ,149
-fastapi_voyager/cli.py,sha256=scBD2ojOq0_sJ8Usu79MoGUvkEc_zlnBO6xK0grz7dI,10478
+fastapi_voyager/cli.py,sha256=wWI0YEB7DaCfK6PkkEMOh3VxXGPV92NN8x-bB354Njs,10705
 fastapi_voyager/filter.py,sha256=uZrVVMhHG5E7j1wdsiB02RAyoDdF1q8A4J04oCboYAU,4644
 fastapi_voyager/module.py,sha256=Z2QHNmiLk6ZAJlm2nSmO875Q33TweSg8UxZSzIpU9zY,3499
 fastapi_voyager/render.py,sha256=ctwad-KNbFajhgnA8OI8412s6s67UbV-dvZFXBt_Ssg,7410
-fastapi_voyager/server.py,sha256=Eer6GdD9-EG9QGHlYmClF3MeVxw68amjK4iW_YZ5ShI,3751
+fastapi_voyager/server.py,sha256=6pDFrVd4AZP3KaqukJS7xq_f7ar4gLkb6XhSO5zoW_A,3782
 fastapi_voyager/type.py,sha256=nad4WNxTcZFi7Mskw6p2W7v2Gs4f0giVLNoFjZlKmbA,1778
-fastapi_voyager/type_helper.py,sha256=j7AiFXsfl4kaxshYtofbsqo08dIXiHvJ190soIzUdLk,8380
-fastapi_voyager/version.py,sha256=Hb2z9BH1asz5RSe-xgzQIT7VN25qyDUyXYTS-6rOm5g,48
+fastapi_voyager/type_helper.py,sha256=f2Gy5r3Zi6a2wTkbqU9W-AkvcetajEYCfroACzcIcVY,9064
+fastapi_voyager/version.py,sha256=esNfySzRU9jKScInt96qMV6-yrFqc5OFPWfMqNLhEWE,48
 fastapi_voyager/voyager.py,sha256=qMXZrQsmUiBljhOFOUtXV--a5i7THz9l00UNoxDu_0w,10193
 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=vndU6K9BN5f75OMPPPzREF7xACmf31wTVyGuOYksiys,10461
+fastapi_voyager/web/index.html,sha256=hRbsdraGUZYB1dP_FIifyhp6ZqT0VyoNE-U3S4lCRaQ,10611
 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=tW0jRSSABMmnAqLDaIXMeXQBm0WWOKycsYesgg8ArZw,8798
-fastapi_voyager/web/component/render-graph.js,sha256=8jfN-ik7Ckn5Frx01umjlYqP6i0HELDCcWQMp5zbIhI,2323
+fastapi_voyager/web/vue-main.js,sha256=twafDl_vDIRjlY0Oltslg2_UAO4L1fezKxuKszvnbjU,8799
+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
-fastapi_voyager/web/component/schema-field-filter.js,sha256=9WBjO6JJl2yf6OiiXoddMgvL32qTDu0PM-RxkkJ7t5M,6267
+fastapi_voyager/web/component/schema-field-filter.js,sha256=5lK2mdgp7_UWcwURi9djRCkIwih-3f4EmDbhKFuLBDc,6266
 fastapi_voyager/web/icon/android-chrome-192x192.png,sha256=35sBy6jmUFJCcquStaafHH1qClZIbd-X3PIKSeLkrNo,37285
 fastapi_voyager/web/icon/android-chrome-512x512.png,sha256=eb2eDjCwIruc05029_0L9hcrkVkv8KceLn1DJMYU0zY,210789
 fastapi_voyager/web/icon/apple-touch-icon.png,sha256=gnWK46tPnvSw1-oYZjgI02wpoO4OrIzsVzGHC5oKWO0,33187
@@ -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.5.3.dist-info/METADATA,sha256=TFMnB94SxSoEblutrjAYkSqopvPgeY5zMsMJhH86_KI,6878
-fastapi_voyager-0.5.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fastapi_voyager-0.5.3.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
-fastapi_voyager-0.5.3.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
-fastapi_voyager-0.5.3.dist-info/RECORD,,
+fastapi_voyager-0.6.2.dist-info/METADATA,sha256=LGxHZaMAoK5qMgAJiWZTM4ukoDrrndj4R3NUKsygzko,6866
+fastapi_voyager-0.6.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fastapi_voyager-0.6.2.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
+fastapi_voyager-0.6.2.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
+fastapi_voyager-0.6.2.dist-info/RECORD,,