fastapi-voyager 0.12.2__tar.gz → 0.12.4__tar.gz

fastapi_voyager-0.12.4/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

fastapi_voyager-0.12.4/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

fastapi_voyager-0.12.4/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# 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`: main js
+
+backend: 
+- `voyager.py`: main entry
+- `render.py`: generate dot file
+- `server.py`: serve mode

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.12.2
+Version: 0.12.4
 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
@@ -12,7 +12,6 @@ Classifier: Framework :: FastAPI
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -32,14 +31,31 @@ Description-Content-Type: text/markdown
 [![PyPI Downloads](https://static.pepy.tech/badge/fastapi-voyager/month)](https://pepy.tech/projects/fastapi-voyager)
 
 
-> This repo is still in early stage, it supports pydantic v2 only
 
 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)
+> This repo is still in early stage, it supports pydantic v2 only
+
+[live demo](https://www.newsyeah.fun/voyager/) of project: [composition oriented development pattern](https://github.com/allmonday/composition-oriented-development-pattern)
 
 <img width="1600" height="986" alt="image" src="https://github.com/user-attachments/assets/8829cda0-f42d-4c84-be2f-b019bb5fe7e1" />
 
+with configuration:
+
+```python
+app.mount('/voyager', 
+          create_voyager(
+            app, 
+            module_color={'src.services': 'tomato'}, 
+            module_prefix='src.services', 
+            swagger_url="/docs",
+            ga_id="G-R64S7Q49VL",
+            initial_page_policy='first',
+            online_repo_url='https://github.com/allmonday/composition-oriented-development-pattern/blob/master'))
+```
+
+https://github.com/allmonday/composition-oriented-development-pattern/blob/master/src/main.py#L48
+
 ## Plan & Raodmap
 - [ideas](./docs/idea.md)
 - [changelog & roadmap](./docs/changelog.md)

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/README.md

@@ -3,14 +3,31 @@
 [![PyPI Downloads](https://static.pepy.tech/badge/fastapi-voyager/month)](https://pepy.tech/projects/fastapi-voyager)
 
 
-> This repo is still in early stage, it supports pydantic v2 only
 
 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)
+> This repo is still in early stage, it supports pydantic v2 only
+
+[live demo](https://www.newsyeah.fun/voyager/) of project: [composition oriented development pattern](https://github.com/allmonday/composition-oriented-development-pattern)
 
 <img width="1600" height="986" alt="image" src="https://github.com/user-attachments/assets/8829cda0-f42d-4c84-be2f-b019bb5fe7e1" />
 
+with configuration:
+
+```python
+app.mount('/voyager', 
+          create_voyager(
+            app, 
+            module_color={'src.services': 'tomato'}, 
+            module_prefix='src.services', 
+            swagger_url="/docs",
+            ga_id="G-R64S7Q49VL",
+            initial_page_policy='first',
+            online_repo_url='https://github.com/allmonday/composition-oriented-development-pattern/blob/master'))
+```
+
+https://github.com/allmonday/composition-oriented-development-pattern/blob/master/src/main.py#L48
+
 ## Plan & Raodmap
 - [ideas](./docs/idea.md)
 - [changelog & roadmap](./docs/changelog.md)

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/docs/changelog.md

@@ -1,4 +1,4 @@
-# Changelog & roadmap
+# Changelog & plan
 
 ## <0.9:
 - [x] group schemas by module hierarchy
@@ -108,17 +108,22 @@
 - 0.12.2
     - [x] add google analytics
 - 0.12.3
-    - [ ] search tag/ route
+    - [x] fix bug in `update_forward_refs`, class should not be skipped if it's parent class has been visited.
+- 0.12.4
+    - [x] fix logger exception 
+- 0.12.5
+    - [x] fix nested cluster with same color
     - [ ] refactor render.py
-    - [ ] reorg: move variable into reactive in vue-main.js
+    - [ ] refactor fe with store based on reactive (demo.js)
+    - [ ] remove search component, integrated into main page
 
 ## 0.13
-- 0.12.0
+- 0.13.2
+    - [ ] if er diagram is provided, show it first.
+- 0.13.1
     - [ ] integration with pydantic-resolve
         - [ ] show hint for resolve, post fields
         - [ ] display loader as edges
     - [ ] add tests
 
-## 0.13
-todo
 

fastapi_voyager-0.12.4/docs/idea.md

@@ -0,0 +1,27 @@
+# Idea
+
+## backlog
+- [ ] user can generate nodes/edges manually and connect to generated ones
+    - [ ] eg: add owner
+    - [ ] add extra info for schema
+- [ ] optimize static resource (allow manually config url)
+- [ ] improve search dialog
+    - [ ] 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 ?
+    - for example `Page[Student]` of `Page[T]` will be marked in `Page[T]`'s module
+- [ ] sort field name in nodes (only table inside right panel)
+- [ ] set max limit for fields in nodes (? need further thinking)
+- [ ] minimap (good to have)
+    - ref: https://observablehq.com/@rabelais/d3-js-zoom-minimap
+- [ ] debug mode
+    - [ ] export dot content, load dot content
+
+
+## in analysis
+- [ ] upgrade network algorithm (optional, for example networkx)
+- [ ] click field to highlight links or click link to highlight related nodes
+- [ ] animation effect for edges
+- [ ] display standard ER diagram spec. `hard but important`
+    - [ ] display potential invalid links
+    - [ ] highlight relationship belongs to ER diagram

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/pyproject.toml

@@ -13,7 +13,6 @@ dependencies = [
 ]
 classifiers = [
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/__init__.py

@@ -2,8 +2,7 @@
 
 Utilities to introspect a FastAPI application and visualize its routing tree.
 """
-from .version import __version__  # noqa: F401
-
 from .server import create_voyager
+from .version import __version__  # noqa: F401
 
 __all__ = ["__version__", "create_voyager"]

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/cli.py

@@ -5,9 +5,9 @@ import importlib.util
 import logging
 import os
 import sys
-from typing import Optional
 
 from fastapi import FastAPI
+
 from fastapi_voyager import server as viz_server
 from fastapi_voyager.version import __version__
 from fastapi_voyager.voyager import Voyager
@@ -15,7 +15,7 @@ from fastapi_voyager.voyager import Voyager
 logger = logging.getLogger(__name__)
 
 
-def load_fastapi_app_from_file(module_path: str, app_name: str = "app") -> Optional[FastAPI]:
+def load_fastapi_app_from_file(module_path: str, app_name: str = "app") -> FastAPI | None:
     """Load FastAPI app from a Python module file."""
     try:
         # Convert relative path to absolute path
@@ -47,7 +47,7 @@ def load_fastapi_app_from_file(module_path: str, app_name: str = "app") -> Optio
         return None
 
 
-def load_fastapi_app_from_module(module_name: str, app_name: str = "app") -> Optional[FastAPI]:
+def load_fastapi_app_from_module(module_name: str, app_name: str = "app") -> FastAPI | None:
     """Load FastAPI app from a Python module name."""
     try:
         # Temporarily add the current working directory to sys.path

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/filter.py

@@ -1,7 +1,8 @@
 from __future__ import annotations
+
 from collections import deque
-from typing import Tuple
-from fastapi_voyager.type import Tag, Route, SchemaNode, Link, PK
+
+from fastapi_voyager.type import PK, Link, Route, SchemaNode, Tag
 
 
 def filter_graph(
@@ -13,7 +14,7 @@ def filter_graph(
     nodes: list[SchemaNode],
     links: list[Link],
     node_set: dict[str, SchemaNode],
-) -> Tuple[list[Tag], list[Route], list[SchemaNode], list[Link]]:
+) -> tuple[list[Tag], list[Route], list[SchemaNode], list[Link]]:
     """Filter tags, routes, schema nodes and links based on a target schema and optional field.
 
     Behaviour summary (mirrors previous Analytics.filter_nodes_and_schemas_based_on_schemas):
@@ -113,7 +114,7 @@ def filter_subgraph_by_module_prefix(
     links: list[Link],
     nodes: list[SchemaNode],
     module_prefix: str
-) -> Tuple[list[Tag], list[Route], list[SchemaNode], list[Link]]:
+) -> tuple[list[Tag], list[Route], list[SchemaNode], list[Link]]:
     """Collapse schema graph so routes link directly to nodes whose module matches ``module_prefix``.
 
     The routine keeps tag→route links untouched, prunes schema nodes whose module does not start
@@ -202,7 +203,7 @@ def filter_subgraph_from_tag_to_schema_by_module_prefix(
     links: list[Link],
     nodes: list[SchemaNode],
     module_prefix: str
-) -> Tuple[list[Tag], list[Route], list[SchemaNode], list[Link]]:
+) -> tuple[list[Tag], list[Route], list[SchemaNode], list[Link]]:
     """Collapse schema graph so routes link directly to nodes whose module matches ``module_prefix``.
 
     The routine keeps tag→route links untouched, prunes schema nodes whose module does not start

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/module.py

@@ -1,6 +1,7 @@
-from typing import Callable, Type, TypeVar, Any
-from fastapi_voyager.type import SchemaNode, ModuleNode, Route, ModuleRoute
+from collections.abc import Callable
+from typing import Any, TypeVar
 
+from fastapi_voyager.type import ModuleNode, ModuleRoute, Route, SchemaNode
 
 N = TypeVar('N')  # Node type: ModuleNode or ModuleRoute
 I = TypeVar('I')  # Item type: SchemaNode or Route
@@ -10,7 +11,7 @@ def _build_module_tree(
     items: list[I],
     *,
     get_module_path: Callable[[I], str | None],
-    NodeClass: Type[N],
+    NodeClass: type[N],
     item_list_attr: str,
 ) -> list[N]:
     """
@@ -34,13 +35,13 @@ def _build_module_tree(
         return NodeClass(**kwargs)  # type: ignore[arg-type]
 
     def get_or_create(child_name: str, parent: N) -> N:
-        for m in getattr(parent, 'modules'):
+        for m in parent.modules:
             if m.name == child_name:
                 return m
-        parent_full = getattr(parent, 'fullname')
+        parent_full = parent.fullname
         fullname = child_name if not parent_full or parent_full == "__root__" else f"{parent_full}.{child_name}"
         new_node = make_node(child_name, fullname)
-        getattr(parent, 'modules').append(new_node)
+        parent.modules.append(new_node)
         return new_node
 
     # Build the tree
@@ -65,13 +66,13 @@ def _build_module_tree(
 
     # Collapse linear chains: no items on node and exactly one child module
     def collapse(node: N) -> None:
-        while len(getattr(node, 'modules')) == 1 and len(getattr(node, item_list_attr)) == 0:
-            child = getattr(node, 'modules')[0]
+        while len(node.modules) == 1 and len(getattr(node, item_list_attr)) == 0:
+            child = node.modules[0]
             node.name = f"{node.name}.{child.name}"
             node.fullname = child.fullname
             setattr(node, item_list_attr, getattr(child, item_list_attr))
-            setattr(node, 'modules', getattr(child, 'modules'))
-        for m in getattr(node, 'modules'):
+            node.modules = child.modules
+        for m in node.modules:
             collapse(m)
 
     for top in result:

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/render.py

@@ -1,8 +1,17 @@
-from typing import Optional
-from fastapi_voyager.type import SchemaNode, ModuleNode, Link, Tag, Route, FieldType, PK, ModuleRoute
-from fastapi_voyager.module import build_module_schema_tree, build_module_route_tree
 from logging import getLogger
 
+from fastapi_voyager.module import build_module_route_tree, build_module_schema_tree
+from fastapi_voyager.type import (
+    PK,
+    FieldType,
+    Link,
+    ModuleNode,
+    ModuleRoute,
+    Route,
+    SchemaNode,
+    Tag,
+)
+
 logger = getLogger(__name__)
 
 
@@ -23,7 +32,7 @@ class Renderer:
         logger.info(f'show_module: {self.show_module}')
         logger.info(f'module_color: {self.module_color}')
 
-    def render_schema_label(self, node: SchemaNode, color: Optional[str]=None) -> str:
+    def render_schema_label(self, node: SchemaNode, color: str | None=None) -> str:
         has_base_fields = any(f.from_base for f in node.fields)
         fields = [n for n in node.fields if n.from_base is False]
 
@@ -74,7 +83,7 @@ class Renderer:
             raise ValueError(f'Unknown link type: {link.type}')
 
     def render_module_schema_content(self, nodes: list[SchemaNode]) -> str:
-        def render_node(node: SchemaNode, color: Optional[str]=None) -> str:
+        def render_node(node: SchemaNode, color: str | None=None) -> str:
             return f'''
                 "{node.id}" [
                     label = {self.render_schema_label(node, color)}
@@ -82,8 +91,10 @@ class Renderer:
                     margin="0.5,0.1"
                 ];'''
 
-        def render_module_schema(mod: ModuleNode, inherit_color: Optional[str]=None, show_cluster:bool=True) -> str:
-            color: Optional[str] = inherit_color
+        def render_module_schema(mod: ModuleNode, inherit_color: str | None=None, show_cluster:bool=True) -> str:
+            color: str | None = inherit_color
+            cluster_color: str | None = None
+
 
             # recursively vist module from short to long:  'a', 'a.b', 'a.b.c'
             # color_flag: {'a', 'a.b.c'}
@@ -94,6 +105,7 @@ class Renderer:
                 if mod.fullname.startswith(k):  
                     module_color_flag.remove(k)
                     color = self.module_color[k]
+                    cluster_color = color if color != inherit_color else None
                     break
 
             inner_nodes = [ render_node(node, color) for node in mod.schema_nodes ]
@@ -108,8 +120,8 @@ class Renderer:
                         style="rounded"
                         label = "  {mod.name}"
                         labeljust = "l"
-                        {(f'pencolor = "{color}"' if color else 'pencolor="#ccc"')}
-                        {(f'penwidth = 3' if color else 'penwidth=""')}
+                        {(f'pencolor = "{cluster_color}"' if cluster_color else 'pencolor="#ccc"')}
+                        {('penwidth = 3' if color else 'penwidth=""')}
                         {inner_nodes_str}
                         {child_str}
                     }}'''

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/server.py

@@ -1,23 +1,24 @@
 from pathlib import Path
-from typing import Optional, Literal
-from fastapi import FastAPI, APIRouter
-from starlette.middleware.gzip import GZipMiddleware
-from pydantic import BaseModel
-from fastapi.responses import HTMLResponse, PlainTextResponse, JSONResponse
+from typing import Literal
+
+from fastapi import APIRouter, FastAPI
+from fastapi.responses import HTMLResponse, JSONResponse, PlainTextResponse
 from fastapi.staticfiles import StaticFiles
-from fastapi_voyager.voyager import Voyager
-from fastapi_voyager.type import Tag, CoreData, SchemaNode
+from pydantic import BaseModel
+from starlette.middleware.gzip import GZipMiddleware
+
 from fastapi_voyager.render import Renderer
+from fastapi_voyager.type import CoreData, SchemaNode, Tag
 from fastapi_voyager.type_helper import get_source, get_vscode_link
 from fastapi_voyager.version import __version__
-
+from fastapi_voyager.voyager import Voyager
 
 WEB_DIR = Path(__file__).parent / "web"
 WEB_DIR.mkdir(exist_ok=True)
 
 GA_PLACEHOLDER = "<!-- GA_SNIPPET -->"
 
-def _build_ga_snippet(ga_id: Optional[str]) -> str:
+def _build_ga_snippet(ga_id: str | None) -> str:
 	if not ga_id:
 		return ""
 
@@ -40,13 +41,13 @@ class OptionParam(BaseModel):
 	enable_brief_mode: bool
 	version: str
 	initial_page_policy: INITIAL_PAGE_POLICY
-	swagger_url: Optional[str] = None
+	swagger_url: str | None = None
 
 class Payload(BaseModel):
-	tags: Optional[list[str]] = None
-	schema_name: Optional[str] = None
-	schema_field: Optional[str] = None
-	route_name: Optional[str] = None
+	tags: list[str] | None = None
+	schema_name: str | None = None
+	schema_field: str | None = None
+	route_name: str | None = None
 	show_fields: str = 'object'
 	show_meta: bool = False
 	brief: bool = False
@@ -58,11 +59,11 @@ 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,
+	module_prefix: str | None = None,
+	swagger_url: str | None = None,
+	online_repo_url: str | None = None,
 	initial_page_policy: INITIAL_PAGE_POLICY = 'first',
-	ga_id: Optional[str] = None,
+	ga_id: str | None = None,
 ) -> FastAPI:
 	router = APIRouter(tags=['fastapi-voyager'])
 

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/type.py

@@ -1,6 +1,8 @@
 from dataclasses import field
+from typing import Literal
+
 from pydantic.dataclasses import dataclass
-from typing import Literal, Optional
+
 
 @dataclass
 class NodeBase:
@@ -76,5 +78,5 @@ class CoreData:
     nodes: list[SchemaNode]
     links: list[Link]
     show_fields: FieldType
-    module_color: Optional[dict[str, str]] = None
-    schema: Optional[str] = None
+    module_color: dict[str, str] | None = None
+    schema: str | None = None

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/type_helper.py

@@ -1,11 +1,13 @@
 import inspect
 import logging
 import os
-from pydantic import BaseModel
-from typing import get_origin, get_args, Union, Annotated, Any, Type, Generic, Optional
-from fastapi_voyager.type import FieldInfo
 from types import UnionType
+from typing import Annotated, Any, Generic, Union, get_args, get_origin
+
 import pydantic_resolve.constant as const
+from pydantic import BaseModel
+
+from fastapi_voyager.type import FieldInfo
 
 logger = logging.getLogger(__name__)
 
@@ -185,7 +187,7 @@ def get_pydantic_fields(schema: type[BaseModel], bases_fields: set[str]) -> list
     return fields
 
 
-def get_vscode_link(kls, online_repo_url: Optional[str] = None) -> str:
+def get_vscode_link(kls, online_repo_url: str | None = None) -> str:
     """Build a VSCode deep link to the class definition.
 
     Priority:
@@ -241,7 +243,7 @@ def safe_issubclass(kls, target_kls):
 
 def update_forward_refs(kls):
     # TODO: refactor
-    def update_pydantic_forward_refs(pydantic_kls: Type[BaseModel]):
+    def update_pydantic_forward_refs(pydantic_kls: type[BaseModel]):
         """
         recursively update refs.
         """
@@ -254,7 +256,11 @@ def update_forward_refs(kls):
             update_forward_refs(field.annotation)
         
     for shelled_type in get_core_types(kls):
-        if getattr(shelled_type, const.PYDANTIC_FORWARD_REF_UPDATED, False):
+        # Only treat as updated if the flag is set on the class itself, not via inheritance
+
+        local_attrs = getattr(shelled_type, '__dict__', {})
+        if local_attrs.get(const.PYDANTIC_FORWARD_REF_UPDATED, False):
+            logger.debug("%s visited", shelled_type.__qualname__)
             continue
         if safe_issubclass(shelled_type, BaseModel):
             update_pydantic_forward_refs(shelled_type)
@@ -287,7 +293,7 @@ def is_non_pydantic_type(tp):
     return True
 
 if __name__ == "__main__":
-    from tests.demo_anno import PageSprint, PageOverall
+    from tests.demo_anno import PageOverall, PageSprint
 
     update_forward_refs(PageOverall)
     update_forward_refs(PageSprint)

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.12.2"
+__version__ = "0.12.4"

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/voyager.py

@@ -1,21 +1,25 @@
-from pydantic import BaseModel
+
+import pydantic_resolve.constant as const
 from fastapi import FastAPI, routing
-from typing import Callable
+from pydantic import BaseModel
+
+from fastapi_voyager.filter import (
+    filter_graph,
+    filter_subgraph_by_module_prefix,
+    filter_subgraph_from_tag_to_schema_by_module_prefix,
+)
+from fastapi_voyager.render import Renderer
+from fastapi_voyager.type import PK, CoreData, FieldType, Link, LinkType, Route, SchemaNode, Tag
 from fastapi_voyager.type_helper import (
-    get_core_types,
     full_class_name,
     get_bases_fields,
-    is_inheritance_of_pydantic_base,
+    get_core_types,
     get_pydantic_fields,
     get_type_name,
+    is_inheritance_of_pydantic_base,
+    is_non_pydantic_type,
     update_forward_refs,
-    is_non_pydantic_type
 )
-from pydantic import BaseModel
-from fastapi_voyager.type import Route, SchemaNode, Link, Tag, LinkType, FieldType, PK, CoreData
-from fastapi_voyager.filter import filter_graph, filter_subgraph_from_tag_to_schema_by_module_prefix, filter_subgraph_by_module_prefix
-from fastapi_voyager.render import Renderer
-import pydantic_resolve.constant as const
 
 
 class Voyager:

fastapi_voyager-0.12.4/src/fastapi_voyager/web/component/demo.js

@@ -0,0 +1,17 @@
+const { defineComponent, computed } = window.Vue;
+
+import { store } from '../store.js'
+
+export default defineComponent({
+  name: "Demo",
+  emits: ["close"],
+  setup() {
+    return { store };
+  },
+  template: `
+    <div>
+      <p>Count: {{ store.state.count }}</p>
+      <button @click="store.mutations.increment()">Add</button>
+    </div>
+  `
+});

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/web/graph-ui.js

@@ -132,7 +132,6 @@ export class GraphUI {
         });
 
         // svg 背景点击高亮清空
-
         $(document)
           .off("click.graphui")
           .on("click.graphui", function (evt) {

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/web/index.html

@@ -298,7 +298,7 @@
             <template #after>
               <div style="position: relative; width: 100%; height: 100%;">
                 <div id="graph" class="adjust-fit"></div>
-                <div style="position: absolute; left: 8px; bottom: 8px; z-index: 10; background: rgba(255,255,255,0.85); border-radius: 4px; padding: 2px 8px;">
+                <div style="position: absolute; left: 8px; top: 8px; z-index: 10; background: rgba(255,255,255,0.85); border-radius: 4px; padding: 2px 8px;">
                   <div class="q-mt-sm">
                     <q-toggle
                       v-model="state.focus"
@@ -337,21 +337,25 @@
                       title="show module cluster"
                     />
                   </div>
+                  <div class="q-mt-sm">
+                    <q-toggle
+                      v-model="state.focus"
+                      v-show="schemaCodeName"
+                      @update:model-value="val => onFocusChange(val)"
+                      label="Focus"
+                      dense
+                      title="pick a schema and toggle focus on to display related nodes only"
+                    />
+                  </div>
+                  <!-- <div class="q-mt-sm">
+                  <demo-component></demo-component>
+                  </div> -->
                 </div>
               </div>
             </template>
           </q-splitter>
         </q-page-container>
       </q-layout>
-      <!-- Detail Dialog -->
-      <q-dialog v-model="showDetail" :persistent="true" :maximized="true">
-        <detail-dialog
-          :schema-name="schemaName"
-          :show-fields="state.showFields"
-          :model-value="showDetail"
-          @close="closeDetail"
-        />
-      </q-dialog>
 
       <!-- Schema Field Filter Dialog -->
       <q-dialog

fastapi_voyager-0.12.4/src/fastapi_voyager/web/store.js

@@ -0,0 +1,17 @@
+const { reactive, watch, ref } = window.Vue;
+
+const state = reactive({
+    count: 0
+})
+
+const mutations = {
+    increment() {
+        state.count += 1
+    }
+}
+
+
+export const store = {
+    state,
+    mutations
+}

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/src/fastapi_voyager/web/vue-main.js

@@ -1,6 +1,7 @@
 import SchemaFieldFilter from "./component/schema-field-filter.js";
 import SchemaCodeDisplay from "./component/schema-code-display.js";
 import RouteCodeDisplay from "./component/route-code-display.js";
+import Demo from './component/demo.js'
 import RenderGraph from "./component/render-graph.js";
 import { GraphUI } from "./graph-ui.js";
 const { createApp, reactive, onMounted, watch, ref } = window.Vue;
@@ -39,17 +40,22 @@ const app = createApp({
 
     const showDetail = ref(false);
     const showSchemaFieldFilter = ref(false);
+
     const showDumpDialog = ref(false);
     const dumpJson = ref("");
     const showImportDialog = ref(false);
     const importJsonText = ref("");
+
     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("");
     const routeCodeId = ref("");
     const showRouteDetail = ref(false);
+
     let graphUI = null;
 
     function openDetail() {
@@ -435,13 +441,18 @@ const app = createApp({
     };
   },
 });
+
 app.use(window.Quasar);
+
 // Set Quasar primary theme color to green
 if (window.Quasar && typeof window.Quasar.setCssVar === "function") {
   window.Quasar.setCssVar("primary", "#009485");
 }
-app.component("schema-field-filter", SchemaFieldFilter);
-app.component("schema-code-display", SchemaCodeDisplay);
-app.component("route-code-display", RouteCodeDisplay);
-app.component("render-graph", RenderGraph);
+
+app.component("schema-field-filter", SchemaFieldFilter);  // shift click and see relationships
+app.component("schema-code-display", SchemaCodeDisplay);  // double click to see node details
+app.component("route-code-display", RouteCodeDisplay);  // double click to see route details
+app.component("render-graph", RenderGraph);   // for debug, render pasted dot content
+app.component('demo-component', Demo)
+
 app.mount("#q-app");

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/tests/demo.py

@@ -1,18 +1,20 @@
-from pydantic import BaseModel, Field
-from fastapi import FastAPI
-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
+from typing import Generic, TypeVar
+
+from fastapi import FastAPI
+from pydantic import BaseModel, Field
+from pydantic_resolve import Resolver, ensure_subset
+
+from tests.service.schema.schema import Member, Sprint, Story, Task
+from tests.service.schema.extra import A, B 
 
 app = FastAPI(title="Demo API", description="A demo FastAPI application for router visualization")
 
-@app.get("/sprints", tags=['for-restapi', 'group_a'], response_model=list[serv.Sprint])
+@app.get("/sprints", tags=['for-restapi', 'group_a'], response_model=list[Sprint])
 def get_sprint():
     return []
 
-class PageMember(serv.Member):
+class PageMember(Member):
     fullname: str = ''
     def post_fullname(self):
         return self.first_name + ' ' + self.last_name
@@ -31,7 +33,7 @@ class TaskB(Task):
 
 type TaskUnion = TaskA | TaskB
 class PageTask(Task):
-    owner: Optional[PageMember]
+    owner: PageMember | None
 
 @ensure_subset(Story)
 class PageStory(BaseModel):
@@ -44,12 +46,12 @@ class PageStory(BaseModel):
         return self.title + ' (processed ........................)'
 
     tasks: list[PageTask] = []
-    owner: Optional[PageMember] = None
+    owner: PageMember | None = None
     union_tasks: list[TaskUnion] = []
 
-class PageSprint(serv.Sprint):
+class PageSprint(Sprint):
     stories: list[PageStory]
-    owner: Optional[PageMember] = None
+    owner: PageMember | None = None
 
 class PageOverall(BaseModel):
     sprints: list[PageSprint]
@@ -109,7 +111,7 @@ def get_page_test_3_no_response_model():
     return True
 
 @app.get("/page_test_5/", tags=['long_long_long_tag_name', 'group_b'])
-def get_page_test_3_no_response_model():
+def get_page_test_3_no_response_model_long_long_long_name():
     return True
 
 

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/tests/demo_anno.py

@@ -1,23 +1,20 @@
 from __future__ import annotations
-from pydantic import BaseModel, Field
+
+from typing import Annotated
 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
+from pydantic import BaseModel, Field
+from pydantic_resolve import Resolver, ensure_subset
+
+from tests.service.schema.schema import Member, Sprint, Story, Task
+from tests.service.schema.extra import A, B 
 
 app = FastAPI(title="Demo API", description="A demo FastAPI application for router visualization")
 
-@app.get("/sprints", tags=['for-restapi'], response_model=list[serv.Sprint])
+@app.get("/sprints", tags=['for-restapi'], response_model=list[Sprint])
 def get_sprint():
     return []
 
-class Tree(BaseModel):
-    id: int
-    name: str
-    children: list[Tree] = []
-
-class PageMember(serv.Member):
+class PageMember(Member):
     fullname: str = ''
     def post_fullname(self):
         return self.first_name + ' ' + self.last_name
@@ -31,15 +28,15 @@ class TaskB(Task):
 
 type TaskUnion = TaskA | TaskB
 class PageTask(Task):
-    owner: Optional[PageMember]
+    owner: PageMember | None
 
 
 class PageOverall(BaseModel):
-    sprints: list[PageSprint]
+    sprints: Annotated[list[PageSprint], Field(description="List of sprints")]
 
-class PageSprint(serv.Sprint):
-    stories: list[PageStory]
-    owner: Optional[PageMember] = None
+class PageSprint(Sprint):
+    stories: Annotated[list[PageStory], Field(description="List of stories")]
+    owner: Annotated[PageMember | None, Field(description="Owner of the sprint")] = None
 
 
 @ensure_subset(Story)
@@ -53,7 +50,7 @@ class PageStory(BaseModel):
         return self.title + ' (processed)'
 
     tasks: list[PageTask] = []
-    owner: Optional[PageMember] = None
+    owner: PageMember | None = None
     union_tasks: list[TaskUnion] = []
 
 @app.get("/page_overall", tags=['for-page'], response_model=PageOverall)
@@ -62,13 +59,9 @@ async def get_page_info():
     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
+# class PageStories(BaseModel):
+#     stories: list[PageStory] 
 
-@app.get("/rest-tree/", tags=['for-restapi'], response_model=Tree)
-def get_tree():
-    return {} # no implementation
+# @app.get("/page_info/", tags=['for-page'], response_model=PageStories)
+# def get_page_stories():
+#     return {} # no implementation

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/tests/programatic.py

@@ -1,11 +1,12 @@
 from fastapi_voyager import create_voyager
+# from tests.demo_anno import app
 from tests.demo import app
 
 app.mount(
     '/voyager', 
     create_voyager(
         app, 
-        module_color={"tests.service": "purple", "tests.demo": "#ccaa00", "tests": "green"}, 
+        module_color={"tests.service": "purple", "tests.demo": "#00b1cc", "tests": "green"}, 
         module_prefix="tests.service", 
         swagger_url="/docs",
         initial_page_policy='first',

fastapi_voyager-0.12.4/tests/service/schema/extra.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+
+class B(BaseModel):
+    id: int
+
+class A(BaseModel):
+    id: int
+    b: B

{fastapi_voyager-0.12.2/tests/service → fastapi_voyager-0.12.4/tests/service/schema}/schema.py

@@ -1,5 +1,7 @@
+from typing import Literal
+
 from pydantic import BaseModel
-from typing import Literal, Dict
+
 
 class Sprint(BaseModel):
     id: int
@@ -8,7 +10,7 @@ class Sprint(BaseModel):
 class Story(BaseModel):
     id: int
     type: Literal['feature', 'bugfix']
-    dct: Dict
+    dct: dict
     sprint_id: int
     title: str
     description: str
@@ -24,10 +26,3 @@ class Member(BaseModel):
     first_name: str
     last_name: str
 
-
-class B(BaseModel):
-    id: int
-
-class A(BaseModel):
-    id: int
-    b: B

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/tests/test_analysis.py

@@ -1,7 +1,8 @@
-from fastapi_voyager.voyager import Voyager
-from pydantic import BaseModel
+
 from fastapi import FastAPI
-from typing import Optional
+from pydantic import BaseModel
+
+from fastapi_voyager.voyager import Voyager
 
 
 def test_analysis():
@@ -22,11 +23,11 @@ def test_analysis():
 
     app = FastAPI()
 
-    @app.get("/test", response_model=Optional[A])
+    @app.get("/test", response_model=A | None)
     def home():
         return None
 
-    @app.get("/test2", response_model=Optional[C])
+    @app.get("/test2", response_model=C | None)
     def home2():
         return None
 

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/tests/test_filter.py

@@ -1,5 +1,5 @@
 from fastapi_voyager.filter import filter_subgraph_by_module_prefix
-from fastapi_voyager.type import Tag, Route, SchemaNode, Link, PK
+from fastapi_voyager.type import PK, Link, Route, SchemaNode, Tag
 
 
 def _make_tag_route_link(tag: Tag, route: Route) -> Link:
@@ -52,7 +52,9 @@ def test_filter_subgraph_filters_nodes_and_links():
 
     assert filtered_nodes == [node_b]
     assert any(
-        lk.type == "route_to_schema" and lk.source_origin == route.id and lk.target_origin == node_b.id
+        lk.type == "route_to_schema" and \
+        lk.source_origin == route.id and \
+        lk.target_origin == node_b.id
         for lk in filtered_links
     )
     assert len(filtered_links) == 2  # tag -> route and merged route -> filtered node

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/tests/test_generic.py

@@ -1,7 +1,11 @@
-from pydantic import BaseModel
+import sys
 from typing import Generic, TypeVar
+
+from pydantic import BaseModel
+
 from fastapi_voyager.type_helper import is_generic_container
 
+
 class PageStory(BaseModel):
     id: int
     title: str
@@ -11,7 +15,11 @@ class DataModel(BaseModel, Generic[T]):
     data: T
     id: int
 
-type DataModelPageStory = DataModel[PageStory]
+DataModelPageStory: object  # Stub declaration for static analysis
+if sys.version_info >= (3, 12):
+    exec("type DataModelPageStory = DataModel[PageStory]")
+else:
+    DataModelPageStory = DataModel[PageStory]
 
 def test_is_generic_container():
     print(DataModelPageStory.__value__.__bases__)

{fastapi_voyager-0.12.2 → fastapi_voyager-0.12.4}/tests/test_type_helper.py

@@ -1,15 +1,14 @@
 import sys
-import typing
 import pytest
-
 from fastapi_voyager.type_helper import get_core_types
+from typing import Annotated
 
 
 def test_optional_and_list_core_types():
     class T: ...
 
     # Optional[T] -> (T,)
-    opt = typing.Optional[T]
+    opt = T | None
     core = get_core_types(opt)
     assert core == (T,)
 
@@ -23,7 +22,7 @@ def test_typing_union_core_types():
     class A: ...
     class B: ...
 
-    u = typing.Union[A, B]
+    u = A | B
     core = get_core_types(u)
     # order preserved
     assert core == (A, B)
@@ -43,7 +42,7 @@ def test_mixed_optional_list():
     class T: ...
 
     # Optional[list[T]] -> (T,) (list unwrapped after removing None)
-    anno = typing.Optional[list[T]]
+    anno = list[T] | None
     core = get_core_types(anno)
     assert core == (T,)
 
@@ -53,7 +52,7 @@ def test_nested_union_flattening():
     class B: ...
     class C: ...
 
-    anno = typing.Union[A, typing.Union[B, C]]
+    anno = A | (B | C)
     core = get_core_types(anno)
     # typing normalizes nested unions -> (A, B, C)
     assert core == (A, B, C)
@@ -72,12 +71,11 @@ def test_uniontype_with_list_member():
     assert core2 == (A, B)
 
 
-
-
 # Only Python 3.12+ supports the PEP 695 `type` statement producing TypeAliasType
 @pytest.mark.skipif(sys.version_info < (3, 12), reason="PEP 695 type aliases require Python 3.12+")
 def test_union_type_alias_and_list():
-    # Dynamically exec a type alias using the new syntax so test file stays valid on <3.12 (even though skipped)
+    # Dynamically exec a type alias using the new syntax 
+    # so test file stays valid on <3.12 (even though skipped)
     ns: dict = {}
     code = """
 class A: ...
@@ -97,3 +95,11 @@ type MyAlias = A | B
     # Direct alias should also work
     core2 = get_core_types(MyAlias)
     assert set(core2) == {A, B}
+
+
+def test_annotated():
+    class A: ...
+
+    core = get_core_types(Annotated[A, 'hello'])
+    assert set(core) == {A}
+

fastapi_voyager-0.12.2/docs/idea.md

@@ -1,22 +0,0 @@
-# Idea
-
-## backlog
-- [ ] user can generate nodes/edges manually and connect to generated ones
-    - [ ] eg: add owner
-    - [ ] add extra info for schema
-- [ ] optimize static resource (allow manually config url)
-- [ ] improve search dialog
-    - [ ] 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
-- [ ] sort field name in nodes (only table inside right panel), pending
-- [ ] set max limit for fields in nodes
-
-## in analysis
-- [ ] upgrade network algorithm (optional)
-- [ ] click field to highlight links
-- [ ] animation effect for edges
-- [ ] display standard ER diagram spec. `hard but important`
-    - [ ] display potential invalid links
-    - [ ] highlight relationship belongs to ER diagram