fastapi-voyager 0.4.1__tar.gz → 0.4.2__tar.gz

{fastapi_voyager-0.4.1 → fastapi_voyager-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.4.1
+Version: 0.4.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
@@ -28,7 +28,9 @@ Description-Content-Type: text/markdown
 [![pypi](https://img.shields.io/pypi/v/fastapi-voyager.svg)](https://pypi.python.org/pypi/fastapi-voyager)
 ![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-voyager)
 
-> This repo is still in early stage, currently it support pydantic v2 only, previous name: fastapi-router-viz
+<p align="center"><img src="./voyager.jpg" alt="" /></p>
+
+> This repo is still in early stage, currently it supports pydantic v2 only, previous name: fastapi-router-viz
 
 Inspect your API interactively
 
@@ -69,28 +71,32 @@ voyager -m tests.demo
            --module_color=tests.demo:tomato
 ```
 
-pick tag, rotue (optional) and click `generate`.
+### generate the graph
+after initialization, pick tag, rotue (optional) and click `generate`.
 
 <img width="1919" height="898" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/05e321d0-49f3-4af6-a7c7-f4c9c6b1dbfd" />
 
+### highlight
 click a node to highlight it's upperstream and downstream nodes. figure out the related models of one page, or homw many pages are related with one model.
 
 <img width="1485" height="616" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/70c4095f-86c7-45da-a6f0-fd41ac645813" />
 
-
-`shift` click a node to check related nodes.
-
-pick a field to narrow the result.
+### filter related nodes
+`shift` click a node to check related node, pick a field to narrow the result.
 
 <img width="1917" height="800" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/e770dc70-f293-49e1-bcd7-d8dffa15d9ea" />
 
+### view source code
 `alt` click a node to show source code or open file in vscode.
 
-<img width="497" height="402" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/ac81711a-d9c2-4fb1-8b3a-0f4bd1f02572" />
+<img width="1049" height="694" alt="image" src="https://github.com/user-attachments/assets/7839ac83-8d60-44ad-b1c9-9652a76339b1" />
+
+<img width="1042" height="675" alt="image" src="https://github.com/user-attachments/assets/38ae705f-5982-4a02-9c3f-038b1d00bcf6" />
+
+`alt` click a route to show source code or open file in vscode
 
-more in video:
+<img width="882" height="445" alt="image" src="https://github.com/user-attachments/assets/158560ef-63ca-4991-9b7d-587be4fa04e4" />
 
-[![IMAGE ALT TEXT](http://img.youtube.com/vi/msYsB9Cc3CA/0.jpg)](https://www.youtube.com/watch?v=msYsB9Cc3CA "Unity Snake Game")
 
 
 ## Command Line Usage

{fastapi_voyager-0.4.1 → fastapi_voyager-0.4.2}/README.md

@@ -1,7 +1,9 @@
 [![pypi](https://img.shields.io/pypi/v/fastapi-voyager.svg)](https://pypi.python.org/pypi/fastapi-voyager)
 ![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-voyager)
 
-> This repo is still in early stage, currently it support pydantic v2 only, previous name: fastapi-router-viz
+<p align="center"><img src="./voyager.jpg" alt="" /></p>
+
+> This repo is still in early stage, currently it supports pydantic v2 only, previous name: fastapi-router-viz
 
 Inspect your API interactively
 
@@ -42,28 +44,32 @@ voyager -m tests.demo
            --module_color=tests.demo:tomato
 ```
 
-pick tag, rotue (optional) and click `generate`.
+### generate the graph
+after initialization, pick tag, rotue (optional) and click `generate`.
 
 <img width="1919" height="898" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/05e321d0-49f3-4af6-a7c7-f4c9c6b1dbfd" />
 
+### highlight
 click a node to highlight it's upperstream and downstream nodes. figure out the related models of one page, or homw many pages are related with one model.
 
 <img width="1485" height="616" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/70c4095f-86c7-45da-a6f0-fd41ac645813" />
 
-
-`shift` click a node to check related nodes.
-
-pick a field to narrow the result.
+### filter related nodes
+`shift` click a node to check related node, pick a field to narrow the result.
 
 <img width="1917" height="800" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/e770dc70-f293-49e1-bcd7-d8dffa15d9ea" />
 
+### view source code
 `alt` click a node to show source code or open file in vscode.
 
-<img width="497" height="402" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/ac81711a-d9c2-4fb1-8b3a-0f4bd1f02572" />
+<img width="1049" height="694" alt="image" src="https://github.com/user-attachments/assets/7839ac83-8d60-44ad-b1c9-9652a76339b1" />
+
+<img width="1042" height="675" alt="image" src="https://github.com/user-attachments/assets/38ae705f-5982-4a02-9c3f-038b1d00bcf6" />
+
+`alt` click a route to show source code or open file in vscode
 
-more in video:
+<img width="882" height="445" alt="image" src="https://github.com/user-attachments/assets/158560ef-63ca-4991-9b7d-587be4fa04e4" />
 
-[![IMAGE ALT TEXT](http://img.youtube.com/vi/msYsB9Cc3CA/0.jpg)](https://www.youtube.com/watch?v=msYsB9Cc3CA "Unity Snake Game")
 
 
 ## Command Line Usage

{fastapi_voyager-0.4.1 → fastapi_voyager-0.4.2}/src/fastapi_voyager/graph.py

@@ -8,7 +8,8 @@ from fastapi_voyager.type_helper import (
     is_inheritance_of_pydantic_base,
     get_pydantic_fields,
     get_vscode_link,
-    get_source
+    get_source,
+    update_forward_refs
 )
 from pydantic import BaseModel
 from fastapi_voyager.type import Route, SchemaNode, Link, Tag, ModuleNode
@@ -111,6 +112,7 @@ class Analytics:
             # 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):
+                    update_forward_refs(schema)
                     target_name = full_class_name(schema)
                     self.links.append(Link(
                         source=route_id,

{fastapi_voyager-0.4.1 → fastapi_voyager-0.4.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
+from typing import get_origin, get_args, Union, Annotated, Any, Type
 from fastapi_voyager.type import FieldInfo
 from types import UnionType
 
@@ -229,4 +229,26 @@ def get_source(kls):
         source = inspect.getsource(kls)
         return source
     except Exception:
-        return "failed to get source"
+        return "failed to get source"
+
+
+def safe_issubclass(kls, classinfo):
+    try:
+        return issubclass(kls, classinfo)
+    except TypeError:
+        return False
+
+
+def update_forward_refs(kls):
+    def update_pydantic_forward_refs(kls: Type[BaseModel]):
+        """
+        recursively update refs.
+        """
+        kls.model_rebuild()
+        values = kls.model_fields.values()
+        for field in values:
+            update_forward_refs(field.annotation)
+
+    for shelled_types in get_core_types(kls):
+        if safe_issubclass(shelled_types, BaseModel):
+            update_pydantic_forward_refs(shelled_types)

{fastapi_voyager-0.4.1 → fastapi_voyager-0.4.2}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.4.1"
+__version__ = "0.4.2"

fastapi_voyager-0.4.2/src/fastapi_voyager/web/icon/site.webmanifest

@@ -0,0 +1 @@
+{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}

{fastapi_voyager-0.4.1 → fastapi_voyager-0.4.2}/src/fastapi_voyager/web/index.html

@@ -1,8 +1,15 @@
 <html>
   <head>
-    <title>FastAPI Router Viz</title>
+    <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" />
+    <!-- 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
       href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900|Material+Icons"
       rel="stylesheet"

fastapi_voyager-0.4.2/tests/demo_anno.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+from pydantic import BaseModel, Field
+from fastapi import FastAPI
+from typing import Optional
+from pydantic_resolve import ensure_subset, Resolver
+from tests.service.schema import Story, Task
+import tests.service.schema as serv
+
+app = FastAPI(title="Demo API", description="A demo FastAPI application for router visualization")
+
+@app.get("/sprints", tags=['for-restapi'], response_model=list[serv.Sprint])
+def get_sprint():
+    return []
+
+class PageMember(serv.Member):
+    fullname: str = ''
+    def post_fullname(self):
+        return self.first_name + ' ' + self.last_name
+
+class TaskA(Task):
+    task_type: str = 'A'
+
+class TaskB(Task):
+    task_type: str = 'B'
+
+
+type TaskUnion = TaskA | TaskB
+class PageTask(Task):
+    owner: Optional[PageMember]
+
+
+class PageOverall(BaseModel):
+    sprints: list[PageSprint]
+
+class PageSprint(serv.Sprint):
+    stories: list[PageStory]
+    owner: Optional[PageMember] = None
+
+
+@ensure_subset(Story)
+class PageStory(BaseModel):
+    id: int
+    sprint_id: int
+    title: str = Field(exclude=True)
+
+    desc: str = ''
+    def post_desc(self):
+        return self.title + ' (processed)'
+
+    tasks: list[PageTask] = []
+    owner: Optional[PageMember] = None
+    union_tasks: list[TaskUnion] = []
+
+@app.get("/page_overall", tags=['for-page'], response_model=PageOverall)
+async def get_page_info():
+    page_overall = PageOverall(sprints=[]) # focus on schema only
+    return await Resolver().resolve(page_overall)
+
+
+class PageStories(BaseModel):
+    stories: list[PageStory] 
+
+@app.get("/page_info/", tags=['for-page'], response_model=PageStories)
+def get_page_stories():
+    return {} # no implementation