fastapi-voyager 0.15.0__py3-none-any.whl → 0.15.2__py3-none-any.whl

fastapi_voyager/er_diagram.py

@@ -15,138 +15,86 @@ from fastapi_voyager.type import (
     ModuleNode,
     SchemaNode,
 )
+from fastapi_voyager.render import Renderer
+from fastapi_voyager.render_style import RenderConfig
 from pydantic import BaseModel
 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:
+class DiagramRenderer(Renderer):
+    """
+    Renderer for Entity-Relationship diagrams.
+
+    Inherits from Renderer to reuse template system and styling.
+    ER diagrams have simpler structure (no tags/routes), so we only
+    need to customize the top-level DOT structure.
+    """
+
     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
-
+        # Initialize parent Renderer with shared config
+        super().__init__(
+            show_fields=show_fields,
+            show_module=show_module,
+            config=RenderConfig()  # Use unified style configuration
+        )
         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 = "{link.style}", label = "{link.label}", minlen=3];"""
+        """Override to increase link length by 40% for ER diagrams."""
+        source = self._handle_schema_anchor(link.source)
+        target = self._handle_schema_anchor(link.target)
+
+        # Build link attributes
+        if link.style is not None:
+            attrs = {'style': link.style}
+            if link.label:
+                attrs['label'] = link.label
+            # Increase minlen by 40% (3 * 1.4 = 4.2, round to 4)
+            attrs['minlen'] = 4
         else:
-            raise ValueError(f'Unknown link type: {link.type}')
+            attrs = self.style.get_link_attributes(link.type)
+            if link.label:
+                attrs['label'] = link.label
 
-    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)
+        return self.template_renderer.render_template(
+            'dot/link.j2',
+            source=source,
+            target=target,
+            attributes=self._format_link_attributes(attrs)
+        )
 
     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)
+        """
+        Render ER diagram as DOT format.
 
-        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"
-            ];
+        Reuses parent's render_module_schema_content and render_link methods.
+        Only customizes the top-level digraph structure.
+        """
+        # Reuse parent's module schema rendering
+        module_schemas_str = self.render_module_schema_content(nodes)
 
-            subgraph cluster_schema {{
-                color = "#aaa"
-                margin=18
-                style="dashed"
-                label="  ER Diagram"
-                labeljust="l"
-                fontsize="20"
-                    {module_schemas_str}
-            }}
+        # Reuse parent's link rendering
+        link_str = '\n'.join(self.render_link(link) for link in links)
 
-            {link_str}
-            }}
-        '''
-        return dot_str
+        # Render using ER diagram template
+        return self.template_renderer.render_template(
+            'dot/er_diagram.j2',
+            pad=self.style.pad,
+            nodesep=self.style.nodesep,
+            font=self.style.font,
+            node_fontsize=self.style.node_fontsize,
+            spline='line' if spline_line else None,
+            er_cluster=module_schemas_str,
+            links=link_str
+        )
 
 
 class VoyagerErDiagram:

fastapi_voyager/render.py

@@ -262,8 +262,18 @@ class Renderer:
         source = self._handle_schema_anchor(link.source)
         target = self._handle_schema_anchor(link.target)
 
-        # Get link style attributes
-        attrs = self.style.get_link_attributes(link.type)
+        # Build link attributes
+        # If link.style is explicitly set (e.g., 'solid, dashed' for ER diagrams), use it
+        # Otherwise, get default style from configuration based on link.type
+        if link.style is not None:
+            attrs = {'style': link.style}
+            if link.label:
+                attrs['label'] = link.label
+            # attrs['minlen'] = 3
+        else:
+            attrs = self.style.get_link_attributes(link.type)
+            if link.label:
+                attrs['label'] = link.label
 
         return self.template_renderer.render_template(
             'dot/link.j2',

fastapi_voyager/server.py

@@ -71,6 +71,7 @@ class SchemaSearchPayload(BaseModel):  # leave tag, route out
 	brief: bool = False
 	hide_primitive_route: bool = False
 	show_module: bool = True
+	show_pydantic_resolve_meta: bool = False
 
 
 # ---------- er diagram ----------

fastapi_voyager/templates/dot/er_diagram.j2

@@ -0,0 +1,29 @@
+digraph world {
+    pad="{{ pad }}"
+    nodesep={{ nodesep }}
+    {% if spline %}splines={{ spline }}{% endif %}
+    fontname="{{ font }}"
+    node [fontname="{{ font }}"]
+    edge [
+        fontname="{{ font }}"
+        color="gray"
+    ]
+    graph [
+        rankdir = "LR"
+    ];
+    node [
+        fontsize = {{ node_fontsize }}
+    ];
+
+    subgraph cluster_schema {
+        color = "#aaa"
+        margin=18
+        style="dashed"
+        label="  ER Diagram"
+        labeljust="l"
+        fontsize="20"
+        {{ er_cluster }}
+    }
+
+    {{ links }}
+}

fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.15.0"
+__version__ = "0.15.2"

fastapi_voyager/web/component/demo.js

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

fastapi_voyager/web/component/render-graph.js

@@ -1,71 +1,71 @@
-import { GraphUI } from "../graph-ui.js";
-const { defineComponent, ref, onMounted, nextTick } = window.Vue;
+import { GraphUI } from "../graph-ui.js"
+const { defineComponent, ref, onMounted, nextTick } = window.Vue
 
 export default defineComponent({
-	name: "RenderGraph",
-	props: {
-		coreData: { type: [Object, Array], required: false, default: null },
-	},
-	emits: ["close"],
-	setup(props, { emit }) {
-		const containerId = `graph-render-${Math.random().toString(36).slice(2, 9)}`;
-		const hasRendered = ref(false);
-		const loading = ref(false);
-		let graphInstance = null;
+  name: "RenderGraph",
+  props: {
+    coreData: { type: [Object, Array], required: false, default: null },
+  },
+  emits: ["close"],
+  setup(props, { emit }) {
+    const containerId = `graph-render-${Math.random().toString(36).slice(2, 9)}`
+    const hasRendered = ref(false)
+    const loading = ref(false)
+    let graphInstance = null
 
-		async function ensureGraph() {
-			await nextTick();
-			if (!graphInstance) {
-				graphInstance = new GraphUI(`#${containerId}`);
-			}
-		}
+    async function ensureGraph() {
+      await nextTick()
+      if (!graphInstance) {
+        graphInstance = new GraphUI(`#${containerId}`)
+      }
+    }
 
-		async function renderFromDot(dotText) {
-			if (!dotText) return;
-			await ensureGraph();
-			await graphInstance.render(dotText);
-			hasRendered.value = true;
-		}
+    async function renderFromDot(dotText) {
+      if (!dotText) return
+      await ensureGraph()
+      await graphInstance.render(dotText)
+      hasRendered.value = true
+    }
 
-		async function renderFromCoreData() {
-			if (!props.coreData) return;
-			loading.value = true;
-			try {
-				const res = await fetch("dot-render-core-data", {
-					method: "POST",
-					headers: { "Content-Type": "application/json" },
-					body: JSON.stringify(props.coreData),
-				});
-				const dotText = await res.text();
-				await renderFromDot(dotText);
-				if (window.Quasar?.Notify) {
-					window.Quasar.Notify.create({ type: "positive", message: "Rendered" });
-				}
-			} catch (e) {
-				console.error("Render from core data failed", e);
-				if (window.Quasar?.Notify) {
-					window.Quasar.Notify.create({ type: "negative", message: "Render failed" });
-				}
-			} finally {
-				loading.value = false;
-			}
-		}
+    async function renderFromCoreData() {
+      if (!props.coreData) return
+      loading.value = true
+      try {
+        const res = await fetch("dot-render-core-data", {
+          method: "POST",
+          headers: { "Content-Type": "application/json" },
+          body: JSON.stringify(props.coreData),
+        })
+        const dotText = await res.text()
+        await renderFromDot(dotText)
+        if (window.Quasar?.Notify) {
+          window.Quasar.Notify.create({ type: "positive", message: "Rendered" })
+        }
+      } catch (e) {
+        console.error("Render from core data failed", e)
+        if (window.Quasar?.Notify) {
+          window.Quasar.Notify.create({ type: "negative", message: "Render failed" })
+        }
+      } finally {
+        loading.value = false
+      }
+    }
 
-		async function reload() {
-			await renderFromCoreData();
-		}
+    async function reload() {
+      await renderFromCoreData()
+    }
 
-		onMounted(async () => {
-			await reload();
-		});
+    onMounted(async () => {
+      await reload()
+    })
 
-		function close() {
-			emit("close");
-		}
+    function close() {
+      emit("close")
+    }
 
-		return { containerId, close, hasRendered, reload, loading };
-	},
-	template: `
+    return { containerId, close, hasRendered, reload, loading }
+  },
+  template: `
 		<div style="height:100%; position:relative; background:#fff;">
 			<q-btn
 				flat dense round icon="close"
@@ -83,5 +83,4 @@ export default defineComponent({
 			<div :id="containerId" style="width:100%; height:100%; overflow:auto; background:#fafafa"></div>
 		</div>
 	`,
-});
-
+})

fastapi_voyager/web/component/route-code-display.js

@@ -1,4 +1,4 @@
-const { defineComponent, ref, watch, onMounted } = window.Vue;
+const { defineComponent, ref, watch, onMounted } = window.Vue
 
 // Component: RouteCodeDisplay
 // Props:
@@ -10,45 +10,43 @@ export default defineComponent({
   },
   emits: ["close"],
   setup(props, { emit }) {
-    const loading = ref(false);
-    const code = ref("");
-    const error = ref("");
-    const link = ref("");
+    const loading = ref(false)
+    const code = ref("")
+    const error = ref("")
+    const link = ref("")
 
     function close() {
-      emit("close");
+      emit("close")
     }
 
     function highlightLater() {
       requestAnimationFrame(() => {
         try {
           if (window.hljs) {
-            const block = document.querySelector(
-              ".frv-route-code-display pre code.language-python"
-            );
+            const block = document.querySelector(".frv-route-code-display pre code.language-python")
             if (block) {
-              window.hljs.highlightElement(block);
+              window.hljs.highlightElement(block)
             }
           }
         } catch (e) {
-          console.warn("highlight failed", e);
+          console.warn("highlight failed", e)
         }
-      });
+      })
     }
 
     async function load() {
       if (!props.routeId) {
-        code.value = "";
-        return;
+        code.value = ""
+        return
       }
 
-      loading.value = true;
-      error.value = null;
-      code.value = "";
-      link.value = "";
+      loading.value = true
+      error.value = null
+      code.value = ""
+      link.value = ""
 
       // try to fetch from server: POST /source with { schema_name: routeId }
-      const payload = { schema_name: props.routeId };
+      const payload = { schema_name: props.routeId }
       try {
         const resp = await fetch(`source`, {
           method: "POST",
@@ -57,18 +55,18 @@ export default defineComponent({
             "Content-Type": "application/json",
           },
           body: JSON.stringify(payload),
-        });
+        })
 
-        const data = await resp.json().catch(() => ({}));
+        const data = await resp.json().catch(() => ({}))
         if (resp.ok) {
-          code.value = data.source_code || "// no source code available";
+          code.value = data.source_code || "// no source code available"
         } else {
-          error.value = (data && data.error) || "Failed to load source";
+          error.value = (data && data.error) || "Failed to load source"
         }
       } catch (e) {
-        error.value = e && e.message ? e.message : "Failed to load source";
+        error.value = e && e.message ? e.message : "Failed to load source"
       } finally {
-        loading.value = false;
+        loading.value = false
       }
 
       try {
@@ -79,36 +77,36 @@ export default defineComponent({
             "Content-Type": "application/json",
           },
           body: JSON.stringify(payload),
-        });
+        })
 
-        const data = await resp.json().catch(() => ({}));
+        const data = await resp.json().catch(() => ({}))
         if (resp.ok) {
-          link.value = data.link || "// no source code available";
+          link.value = data.link || "// no source code available"
         } else {
-          error.value += (data && data.error) || "Failed to load vscode link";
+          error.value += (data && data.error) || "Failed to load vscode link"
         }
       } catch (e) {
       } finally {
-        loading.value = false;
+        loading.value = false
       }
 
       if (!error.value) {
-        highlightLater();
+        highlightLater()
       }
     }
 
     watch(
       () => props.routeId,
       () => {
-        load();
+        load()
       }
-    );
+    )
 
     onMounted(() => {
-      load();
-    });
+      load()
+    })
 
-    return { loading, code, error, close, link };
+    return { loading, code, error, close, link }
   },
   template: `
   <div class="frv-route-code-display" style="border:1px solid #ccc; position:relative; background:#fff;">
@@ -122,4 +120,4 @@ export default defineComponent({
       <pre v-else style="margin:0;"><code class="language-python">{{ code }}</code></pre>
     </div>
   </div>`,
-});
+})