fastapi-voyager 0.5.3__tar.gz → 0.6.2__tar.gz

{fastapi_voyager-0.5.3 → fastapi_voyager-0.6.2}/PKG-INFO

@@ -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 → fastapi_voyager-0.6.2}/README.md

@@ -156,13 +156,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
@@ -178,3 +172,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 → fastapi_voyager-0.6.2}/src/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-0.5.3 → fastapi_voyager-0.6.2}/src/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-0.5.3 → fastapi_voyager-0.6.2}/src/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-0.5.3 → fastapi_voyager-0.6.2}/src/fastapi_voyager/version.py

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

{fastapi_voyager-0.5.3 → fastapi_voyager-0.6.2}/src/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-0.5.3 → fastapi_voyager-0.6.2}/src/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-0.5.3 → fastapi_voyager-0.6.2}/src/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-0.5.3 → fastapi_voyager-0.6.2}/src/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 → fastapi_voyager-0.6.2}/tests/demo.py

@@ -69,6 +69,8 @@ class DataModel(BaseModel, Generic[T]):
     data: T
     id: int
 
-@app.get("/page_test_1/", tags=['for-page'], response_model=DataModel[PageStory])
+type DataModelPageStory = DataModel[PageStory]
+
+@app.get("/page_test_1/", tags=['for-page'], response_model=DataModelPageStory)
 def get_page_test_1():
     return {} # no implementation

fastapi_voyager-0.6.2/tests/programatic.py

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

fastapi_voyager-0.6.2/tests/test_generic.py

@@ -0,0 +1,20 @@
+from pydantic import BaseModel
+from typing import Generic, TypeVar
+from fastapi_voyager.type_helper import is_generic_container
+
+class PageStory(BaseModel):
+    id: int
+    title: str
+
+T = TypeVar('T')
+class DataModel(BaseModel, Generic[T]):
+    data: T
+    id: int
+
+type DataModelPageStory = DataModel[PageStory]
+
+def test_is_generic_container():
+    print(DataModelPageStory.__value__.__bases__)
+    print(DataModelPageStory.__value__.model_fields.items())
+    assert is_generic_container(DataModel) is True
+    assert is_generic_container(DataModelPageStory) is False