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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.6.1
+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.6.1 → 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.6.1 → 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 safe_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]:
@@ -256,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.6.1 → fastapi_voyager-0.6.2}/src/fastapi_voyager/version.py

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

{fastapi_voyager-0.6.1 → 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/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