fastapi-voyager 0.11.8__tar.gz → 0.11.10__tar.gz

{fastapi_voyager-0.11.8 → fastapi_voyager-0.11.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.11.8
+Version: 0.11.10
 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
@@ -34,14 +34,7 @@ Description-Content-Type: text/markdown
 
 > This repo is still in early stage, it supports pydantic v2 only
 
-FastAPI can help you:
-
-- design your API
-- inspect your API
-- refactor your API
-
-interactively !!
-
+Visualize your FastAPI endpoints, and explore them interactively.
 
 [visit online demo](https://www.newsyeah.fun/voyager/) of project: [composition oriented development pattern](https://github.com/allmonday/composition-oriented-development-pattern)
 
@@ -59,6 +52,9 @@ uv add fastapi-voyager
 voyager -m path.to.your.app.module --server
 ```
 
+> *sub_app* is not supported yet.
+
+
 ## Mount into project
 
 ```python
@@ -177,6 +173,7 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [ ] add route/tag list
 - [ ] type alias should not be kept as node instead of compiling to original type
 - [ ] how to correctly handle the generic type ?
+- [ ] support Google analysis config
 
 ### in analysis
 - [ ] click field to highlight links
@@ -278,6 +275,10 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [x] fix swagger link
 - 0.11.8
     - [x] fix swagger link in another way
+- 0.11.9
+    - [x] replace issubclass with safe_issubclass to prevent exception.
+- 0.11.10
+    - [x] fix bug during updating forward refs
 
 #### 0.12
 - [ ] add tests
@@ -289,12 +290,13 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] config release pipeline
 
 
-## Using with pydantic-resolve
+## About pydantic-resolve
 
-WIP: ...
+pydantic-resolve's `@ensure_subset` decorator helps safely pick fields from the 'source class' while indicating the reference from the current class to the base class.
 
-pydantic-resolve's @ensure_subset decorator is helpful to pick fields from `source class` in safe.
+pydantic-resolve is a lightweight tool designed to build complex, nested data in a simple, declarative way. In version 2, it will introduce an important feature: ER model definition, and fastapi-voyager will support and visualize these diagrams.
 
+Developers can use fastapi-voyager without needing to know about pydantic-resolve.
 
 
 ## Credits
@@ -309,3 +311,26 @@ pydantic-resolve's @ensure_subset decorator is helpful to pick fields from `sour
 - [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
 - Quasar
 
+
+## How to develop & contribute?
+
+fork, clone.
+
+install uv.
+
+```shell
+uv venv
+source .venv/bin/activate
+uv pip install ".[dev]"
+uvicorn tests.programatic:app  --reload
+```
+
+open `localhost:8000/voyager`
+
+
+frontend: `src/web/vue-main.js`
+backend: `voyager.py`, `render.py`, `server.py`
+
+## Branch and Release flow
+
+TODO

{fastapi_voyager-0.11.8 → fastapi_voyager-0.11.10}/README.md

@@ -5,14 +5,7 @@
 
 > This repo is still in early stage, it supports pydantic v2 only
 
-FastAPI can help you:
-
-- design your API
-- inspect your API
-- refactor your API
-
-interactively !!
-
+Visualize your FastAPI endpoints, and explore them interactively.
 
 [visit online demo](https://www.newsyeah.fun/voyager/) of project: [composition oriented development pattern](https://github.com/allmonday/composition-oriented-development-pattern)
 
@@ -30,6 +23,9 @@ uv add fastapi-voyager
 voyager -m path.to.your.app.module --server
 ```
 
+> *sub_app* is not supported yet.
+
+
 ## Mount into project
 
 ```python
@@ -148,6 +144,7 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [ ] add route/tag list
 - [ ] type alias should not be kept as node instead of compiling to original type
 - [ ] how to correctly handle the generic type ?
+- [ ] support Google analysis config
 
 ### in analysis
 - [ ] click field to highlight links
@@ -249,6 +246,10 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [x] fix swagger link
 - 0.11.8
     - [x] fix swagger link in another way
+- 0.11.9
+    - [x] replace issubclass with safe_issubclass to prevent exception.
+- 0.11.10
+    - [x] fix bug during updating forward refs
 
 #### 0.12
 - [ ] add tests
@@ -260,12 +261,13 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] config release pipeline
 
 
-## Using with pydantic-resolve
+## About pydantic-resolve
 
-WIP: ...
+pydantic-resolve's `@ensure_subset` decorator helps safely pick fields from the 'source class' while indicating the reference from the current class to the base class.
 
-pydantic-resolve's @ensure_subset decorator is helpful to pick fields from `source class` in safe.
+pydantic-resolve is a lightweight tool designed to build complex, nested data in a simple, declarative way. In version 2, it will introduce an important feature: ER model definition, and fastapi-voyager will support and visualize these diagrams.
 
+Developers can use fastapi-voyager without needing to know about pydantic-resolve.
 
 
 ## Credits
@@ -280,3 +282,26 @@ pydantic-resolve's @ensure_subset decorator is helpful to pick fields from `sour
 - [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
 - Quasar
 
+
+## How to develop & contribute?
+
+fork, clone.
+
+install uv.
+
+```shell
+uv venv
+source .venv/bin/activate
+uv pip install ".[dev]"
+uvicorn tests.programatic:app  --reload
+```
+
+open `localhost:8000/voyager`
+
+
+frontend: `src/web/vue-main.js`
+backend: `voyager.py`, `render.py`, `server.py`
+
+## Branch and Release flow
+
+TODO

{fastapi_voyager-0.11.8 → fastapi_voyager-0.11.10}/src/fastapi_voyager/server.py

@@ -38,18 +38,15 @@ class Payload(BaseModel):
 	show_module: bool = True
 
 
-def create_route(
+def create_voyager(
 	target_app: FastAPI,
 	module_color: dict[str, str] | None = None,
-	swagger_url: Optional[str] = None,
+	gzip_minimum_size: int | None = 500,
 	module_prefix: Optional[str] = None,
+	swagger_url: Optional[str] = None,
 	online_repo_url: Optional[str] = None,
 	initial_page_policy: INITIAL_PAGE_POLICY = 'first',
-):
-	"""
-	module_color: dict mapping module name to color string, e.g. {'models': 'lightblue'}
-	module_prefix: prefix string to define schemas show in brief mode
-	"""
+) -> FastAPI:
 	router = APIRouter(tags=['fastapi-voyager'])
 
 	@router.get("/dot", response_model=OptionParam)
@@ -207,27 +204,6 @@ def create_route(
 				content={"error": f"Internal error: {str(e)}"}
 			)
         
-	return router
-
-
-def create_voyager(
-	target_app: FastAPI,
-	module_color: dict[str, str] | None = None,
-	gzip_minimum_size: int | None = 500,
-	module_prefix: Optional[str] = None,
-	swagger_url: Optional[str] = None,
-	online_repo_url: Optional[str] = None,
-	initial_page_policy: INITIAL_PAGE_POLICY = 'first',
-) -> FastAPI:
-	router = create_route(
-		target_app, 
-		module_color=module_color, 
-		module_prefix=module_prefix, 
-		swagger_url=swagger_url,
-		online_repo_url=online_repo_url,
-		initial_page_policy=initial_page_policy,
-		)
-
 	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)

{fastapi_voyager-0.11.8 → fastapi_voyager-0.11.10}/src/fastapi_voyager/type_helper.py

@@ -232,27 +232,24 @@ def safe_issubclass(kls, classinfo):
     try:
         return issubclass(kls, classinfo)
     except TypeError:
-        print(kls.__name__, 'is not a class')
+        # may raise error for corner case such as ForwardRef
+        print(str(kls), 'is not a target class')  
         return False
 
 
 def update_forward_refs(kls):
     # TODO: refactor
-    def update_pydantic_forward_refs(kls2: Type[BaseModel]):
+    def update_pydantic_forward_refs(pydantic_kls: Type[BaseModel]):
         """
         recursively update refs.
         """
 
-        kls2.model_rebuild()
-        setattr(kls2, const.PYDANTIC_FORWARD_REF_UPDATED, True)
+        pydantic_kls.model_rebuild()
+        setattr(pydantic_kls, const.PYDANTIC_FORWARD_REF_UPDATED, True)
 
-        values = kls2.model_fields.values()
+        values = pydantic_kls.model_fields.values()
         for field in values:
             update_forward_refs(field.annotation)
-
-    if safe_issubclass(kls, BaseModel):
-        kls.model_rebuild()
-        setattr(kls, const.PYDANTIC_FORWARD_REF_UPDATED, True)
         
     for shelled_type in get_core_types(kls):
         if getattr(shelled_type, const.PYDANTIC_FORWARD_REF_UPDATED, False):
@@ -283,7 +280,7 @@ def is_generic_container(cls):
     
 def is_non_pydantic_type(tp):
     for schema in get_core_types(tp):
-        if schema and issubclass(schema, BaseModel):
+        if schema and safe_issubclass(schema, BaseModel):
             return False
     return True
 

{fastapi_voyager-0.11.8 → fastapi_voyager-0.11.10}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.11.8"
+__version__ = "0.11.10"

{fastapi_voyager-0.11.8 → fastapi_voyager-0.11.10}/tests/demo.py

@@ -4,6 +4,7 @@ from typing import Optional, Generic, TypeVar
 from pydantic_resolve import ensure_subset, Resolver
 from tests.service.schema import Story, Task, A
 import tests.service.schema as serv
+from dataclasses import dataclass
 
 app = FastAPI(title="Demo API", description="A demo FastAPI application for router visualization")
 
@@ -15,6 +16,11 @@ class PageMember(serv.Member):
     fullname: str = ''
     def post_fullname(self):
         return self.first_name + ' ' + self.last_name
+    sh: 'Something'  # forward reference
+
+@dataclass
+class Something:
+    id: int
 
 class TaskA(Task):
     task_type: str = 'A'

{fastapi_voyager-0.11.8 → fastapi_voyager-0.11.10}/tests/programatic.py

@@ -5,7 +5,7 @@ app.mount(
     '/voyager', 
     create_voyager(
         app, 
-        module_color={"tests.service": "red"}, 
+        module_color={"tests.service": "purple"}, 
         module_prefix="tests.service", 
         swagger_url="/docs",
         initial_page_policy='first',