fastapi-voyager 0.13.0__py3-none-any.whl → 0.13.1__py3-none-any.whl

fastapi_voyager/er_diagram.py

@@ -1,16 +1,153 @@
 from __future__ import annotations
 
-from fastapi_voyager.type import PK, FieldType, Link, LinkType, SchemaNode
 from fastapi_voyager.type_helper import (
     update_forward_refs,
     full_class_name,
     get_core_types,
     get_type_name
 )
-from fastapi_voyager.render import Renderer
-from fastapi_voyager.type import FieldInfo
+from fastapi_voyager.type import (
+    FieldInfo,
+    PK,
+    FieldType,
+    LinkType,
+    Link,
+    ModuleNode,
+    SchemaNode,
+)
 from pydantic import BaseModel
-from pydantic_resolve import ErDiagram, Entity
+from pydantic_resolve import ErDiagram, Entity, Relationship, MultipleRelationship
+from logging import getLogger
+from fastapi_voyager.module import build_module_schema_tree
+
+logger = getLogger(__name__)
+
+
+class DiagramRenderer:
+    def __init__(
+        self,
+        *,
+        show_fields: FieldType = 'single',
+        show_module: bool = True
+    ) -> None:
+        self.show_fields = show_fields if show_fields in ('single', 'object', 'all') else 'single'
+        self.show_module = show_module
+
+        logger.info(f'show_module: {self.show_module}')
+
+    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]
+
+        if self.show_fields == 'all':
+            _fields = fields
+        elif self.show_fields == 'object':
+            _fields = [f for f in fields if f.is_object is True]
+        else:  # 'single'
+            _fields = []
+
+        fields_parts: list[str] = []
+        if self.show_fields == 'all' and has_base_fields:
+            fields_parts.append('<tr><td align="left" cellpadding="8"><font color="#999">  Inherited Fields ... </font></td></tr>')
+
+        for field in _fields:
+            type_name = field.type_name[:25] + '..' if len(field.type_name) > 25 else field.type_name
+            display_xml = f'<s align="left">{field.name}: {type_name}</s>' if field.is_exclude else f'{field.name}: {type_name}'
+            field_str = f"""<tr><td align="left" port="f{field.name}" cellpadding="8"><font>  {display_xml}    </font></td></tr>"""
+            fields_parts.append(field_str)
+
+        header_color = '#009485' if color is None else color
+        header = f"""<tr><td cellpadding="6" bgcolor="{header_color}" align="center" colspan="1" port="{PK}"> <font color="white">    {node.name}    </font></td> </tr>"""
+        field_content = ''.join(fields_parts) if fields_parts else ''
+        return f"""<<table border="0" cellborder="1" cellpadding="0" cellspacing="0" bgcolor="white"> {header} {field_content}   </table>>"""
+
+    def _handle_schema_anchor(self, source: str) -> str:
+        if '::' in source:
+            a, b = source.split('::', 1)
+            return f'"{a}":{b}'
+        return f'"{source}"'
+
+    def render_link(self, link: Link) -> str:
+        h = self._handle_schema_anchor
+        if link.type == 'schema':
+            return f"""{h(link.source)}:e -> {h(link.target)}:w [style = "solid", label = "{link.label}", minlen=3];"""
+        else:
+            raise ValueError(f'Unknown link type: {link.type}')
+
+    def render_module_schema_content(self, nodes: list[SchemaNode]) -> str:
+        def render_node(node: SchemaNode, color: str | None=None) -> str:
+            return f'''
+                "{node.id}" [
+                    label = {self.render_schema_label(node, color)}
+                    shape = "plain"
+                    margin="0.5,0.1"
+                ];'''
+
+        def render_module_schema(mod: ModuleNode, show_cluster:bool=True) -> str:
+            inner_nodes = [ render_node(node) for node in mod.schema_nodes ]
+            inner_nodes_str = '\n'.join(inner_nodes)
+            child_str = '\n'.join(render_module_schema(mod=m, show_cluster=show_cluster) for m in mod.modules)
+
+            if show_cluster:
+                return f'''
+                    subgraph cluster_module_{mod.fullname.replace('.', '_')} {{
+                        tooltip="{mod.fullname}"
+                        color = "#666"
+                        style="rounded"
+                        label = "  {mod.name}"
+                        labeljust = "l"
+                        pencolor="#ccc"
+                        penwidth=""
+                        {inner_nodes_str}
+                        {child_str}
+                    }}'''
+            else:
+                return f'''
+                    {inner_nodes_str}
+                    {child_str}
+                '''
+
+        # if self.show_module:
+        module_schemas = build_module_schema_tree(nodes)
+        return '\n'.join(render_module_schema(mod=m, show_cluster=self.show_module) for m in module_schemas)
+
+    def render_dot(self, nodes: list[SchemaNode], links: list[Link], spline_line=False) -> str:
+        module_schemas_str = self.render_module_schema_content(nodes)
+        link_str = '\n'.join(self.render_link(link) for link in links)
+
+        dot_str = f'''
+        digraph world {{
+            pad="0.5"
+            nodesep=0.8
+            {'splines=line' if spline_line else ''}
+            fontname="Helvetica,Arial,sans-serif"
+            node [fontname="Helvetica,Arial,sans-serif"]
+            edge [
+                fontname="Helvetica,Arial,sans-serif"
+                color="gray"
+            ]
+            graph [
+                rankdir = "LR"
+            ];
+            node [
+                fontsize = "16"
+            ];
+
+            subgraph cluster_schema {{
+                color = "#aaa"
+                margin=18
+                style="dashed"
+                label="  ER Diagram"
+                labeljust="l"
+                fontsize="20"
+                    {module_schemas_str}
+            }}
+
+            {link_str}
+            }}
+        '''
+        return dot_str
+
 
 class VoyagerErDiagram:
     def __init__(self, 
@@ -42,12 +179,26 @@ class VoyagerErDiagram:
             for anno in annos:
                 self.add_to_node_set(anno, fk_set=self.fk_set.get(full_class_name(anno)))
                 source_name = f'{full_class_name(schema)}::f{relationship.field}'
-                self.add_to_link_set(
-                    source=source_name,
-                    source_origin=full_class_name(schema),
-                    target=self.generate_node_head(full_class_name(anno)),
-                    target_origin=full_class_name(anno),
-                    type='schema')
+                if isinstance(relationship, Relationship):
+                    self.add_to_link_set(
+                        source=source_name,
+                        source_origin=full_class_name(schema),
+                        target=self.generate_node_head(full_class_name(anno)),
+                        target_origin=full_class_name(anno),
+                        type='schema',
+                        label=get_type_name(relationship.target_kls))
+
+                elif isinstance(relationship, MultipleRelationship):
+                    for link in relationship.links:
+                        self.add_to_link_set(
+                            source=source_name,
+                            source_origin=full_class_name(schema),
+                            target=self.generate_node_head(full_class_name(anno)),
+                            target_origin=full_class_name(anno),
+                            type='schema',
+                            biz=link.biz,
+                            label=f'{get_type_name(relationship.target_kls)} / {link.biz} '
+                        )
 
     def add_to_node_set(self, schema, fk_set: set[str] | None = None) -> str:
         """
@@ -73,13 +224,15 @@ class VoyagerErDiagram:
             source_origin: str,
             target: str, 
             target_origin: str,
-            type: LinkType
+            type: LinkType,
+            label: str,
+            biz: str | None = None
         ) -> bool:
         """
         1. add link to link_set
         2. if duplicated, do nothing, else insert
         """
-        pair = (source, target)
+        pair = (source, target, biz)
         if result := pair not in self.link_set:
             self.link_set.add(pair)
             self.links.append(Link(
@@ -87,7 +240,8 @@ class VoyagerErDiagram:
                 source_origin=source_origin,
                 target=target,
                 target_origin=target_origin,
-                type=type
+                type=type,
+                label=label
             ))
         return result
 
@@ -100,8 +254,8 @@ class VoyagerErDiagram:
 
         for entity in self.er_diagram.configs:
             self.analysis_entity(entity)
-        renderer = Renderer(show_fields=self.show_field, show_module=self.show_module)
-        return renderer.render_dot([], [], list(self.node_set.values()), self.links)
+        renderer = DiagramRenderer(show_fields=self.show_field, show_module=self.show_module)
+        return renderer.render_dot(list(self.node_set.values()), self.links)
 
 
 def get_fields(schema: type[BaseModel], fk_set: set[str] | None = None) -> list[FieldInfo]:
@@ -116,4 +270,4 @@ def get_fields(schema: type[BaseModel], fk_set: set[str] | None = None) -> list[
             type_name=get_type_name(anno),
             is_exclude=bool(v.exclude)
         ))
-    return fields
+    return fields

fastapi_voyager/type.py

@@ -67,6 +67,7 @@ class Link:
     source_origin: str
     target_origin: str
     type: LinkType
+    label: str | None = None
 
 FieldType = Literal['single', 'object', 'all']
 PK = "PK"

fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.13.0"
+__version__ = "0.13.1"

{fastapi_voyager-0.13.0.dist-info → fastapi_voyager-0.13.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.13.0
+Version: 0.13.1
 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

{fastapi_voyager-0.13.0.dist-info → fastapi_voyager-0.13.1.dist-info}/RECORD

@@ -1,13 +1,13 @@
 fastapi_voyager/__init__.py,sha256=kqwzThE1YhmQ_7jPKGlnWvqRGC-hFrRqq_lKhKaleYU,229
 fastapi_voyager/cli.py,sha256=td3yIIigEomhSdDO-Xkh-CgpEwCafwlwnpvxnT9QsBo,10488
-fastapi_voyager/er_diagram.py,sha256=GoTuriRTBk0Th_-ireuLHdzncjbk3WbIns8FVzeJz28,4064
+fastapi_voyager/er_diagram.py,sha256=I-Fo03FMHu5INYeeycsdECN0oh7LroDHD88YlHwwUGA,10136
 fastapi_voyager/filter.py,sha256=AN_HIu8-DtKisIq5mFt7CnqRHtxKewedNGyyaI82hSY,11529
 fastapi_voyager/module.py,sha256=h9YR3BpS-CAcJW9WCdVkF4opqwY32w9T67g9GfdLytk,3425
 fastapi_voyager/render.py,sha256=O_HR8ypOrFhjejkBpKIH_8foB78DgzH0hvO-CWeYt0w,9976
 fastapi_voyager/server.py,sha256=UZi-VdsurjDnqDgf3l5LfgWfZ4OxzilC_A_Ju6x9jQc,8592
-fastapi_voyager/type.py,sha256=7EL1zaIwKVRGpLig7fqaOrZGN5k0Rm31C9COfck3CSs,1750
+fastapi_voyager/type.py,sha256=uniDpmNSf6r-5qoGVkOP6-k0kxxJyUvXsEBgW5sDFKg,1779
 fastapi_voyager/type_helper.py,sha256=UTCFWluFeGdGkJX3wiE_bZ2EgZsu4JkmqHjsJVdG81Q,9953
-fastapi_voyager/version.py,sha256=jHHU_F0-L0N4sHMgRz3qTQ0PPdki_7FNU9kR-UybYwM,49
+fastapi_voyager/version.py,sha256=XPQT-MiS5izc8d6XhjxYtP7l6JRWW4h0BgwR0e2ndGo,49
 fastapi_voyager/voyager.py,sha256=iWt-_QsoKavhb9ZawhU3W8gv3vTwn8PWTevg8BooyV8,13923
 fastapi_voyager/web/graph-ui.js,sha256=hTsZO1Ly1JuoRg0kZWQ62jeLiD2kbnzACfbSPd0F95U,6634
 fastapi_voyager/web/graphviz.svg.css,sha256=zDCjjpT0Idufu5YOiZI76PL70-avP3vTyzGPh9M85Do,1563
@@ -28,8 +28,8 @@ fastapi_voyager/web/icon/favicon-16x16.png,sha256=JC07jEzfIYxBIoQn_FHXvyHuxESdhW
 fastapi_voyager/web/icon/favicon-32x32.png,sha256=C7v1h58cfWOsiLp9yOIZtlx-dLasBcq3NqpHVGRmpt4,1859
 fastapi_voyager/web/icon/favicon.ico,sha256=tZolYIXkkBcFiYl1A8ksaXN2VjGamzcSdes838dLvNc,15406
 fastapi_voyager/web/icon/site.webmanifest,sha256=ep4Hzh9zhmiZF2At3Fp1dQrYQuYF_3ZPZxc1KcGBvwQ,263
-fastapi_voyager-0.13.0.dist-info/METADATA,sha256=uKfxGwFJQZC7LY3Es7RuWhccR5OBPm8s1m7kmrjtokI,6521
-fastapi_voyager-0.13.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-fastapi_voyager-0.13.0.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
-fastapi_voyager-0.13.0.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
-fastapi_voyager-0.13.0.dist-info/RECORD,,
+fastapi_voyager-0.13.1.dist-info/METADATA,sha256=9MgyRS-Az5198n87XhUnHLF6xgkghGxBeCM6TRmCitE,6521
+fastapi_voyager-0.13.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+fastapi_voyager-0.13.1.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
+fastapi_voyager-0.13.1.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
+fastapi_voyager-0.13.1.dist-info/RECORD,,