fastapi-voyager 0.14.1__py3-none-any.whl → 0.15.1__py3-none-any.whl

fastapi_voyager/render_style.py

@@ -0,0 +1,105 @@
+"""
+Style constants and configuration for rendering DOT graphs and HTML tables.
+"""
+from dataclasses import dataclass, field
+from typing import Literal
+
+
+@dataclass
+class ColorScheme:
+    """Color scheme for graph visualization."""
+
+    # Node colors
+    primary: str = '#009485'
+    highlight: str = 'tomato'
+
+    # Pydantic-resolve metadata colors
+    resolve: str = '#47a80f'
+    post: str = '#427fa4'
+    expose_as: str = '#895cb9'
+    send_to: str = '#ca6d6d'
+    collector: str = '#777'
+
+    # Link colors
+    inherit: str = 'purple'
+    subset: str = 'orange'
+
+    # Border colors
+    border: str = '#666'
+    cluster_border: str = '#ccc'
+
+    # Text colors
+    text_gray: str = '#999'
+
+
+@dataclass
+class GraphvizStyle:
+    """Graphviz DOT style configuration."""
+
+    # Font settings
+    font: str = 'Helvetica,Arial,sans-serif'
+    node_fontsize: str = '16'
+    cluster_fontsize: str = '20'
+
+    # Layout settings
+    nodesep: str = '0.8'
+    pad: str = '0.5'
+    node_margin: str = '0.5,0.1'
+    cluster_margin: str = '18'
+
+    # Link styles configuration
+    LINK_STYLES: dict[str, dict] = field(default_factory=lambda: {
+        'tag_route': {
+            'style': 'solid',
+            'minlen': 3,
+        },
+        'route_to_schema': {
+            'style': 'solid',
+            'dir': 'back',
+            'arrowtail': 'odot',
+            'minlen': 3,
+        },
+        'schema': {
+            'style': 'solid',
+            'label': '',
+            'dir': 'back',
+            'minlen': 3,
+            'arrowtail': 'odot',
+        },
+        'parent': {
+            'style': 'solid,dashed',
+            'dir': 'back',
+            'minlen': 3,
+            'taillabel': '< inherit >',
+            'color': 'purple',
+            'tailport': 'n',
+        },
+        'subset': {
+            'style': 'solid,dashed',
+            'dir': 'back',
+            'minlen': 3,
+            'taillabel': '< subset >',
+            'color': 'orange',
+            'tailport': 'n',
+        },
+        'tag_to_schema': {
+            'style': 'solid',
+            'minlen': 3,
+        },
+    })
+
+    def get_link_attributes(self, link_type: str) -> dict:
+        """Get link style attributes for a given link type."""
+        return self.LINK_STYLES.get(link_type, {})
+
+
+@dataclass
+class RenderConfig:
+    """Complete rendering configuration."""
+
+    colors: ColorScheme = field(default_factory=ColorScheme)
+    style: GraphvizStyle = field(default_factory=GraphvizStyle)
+
+    # Field display settings
+    max_type_length: int = 25
+    type_suffix: str = '..'

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/cluster.j2

@@ -0,0 +1,10 @@
+subgraph cluster_{{ cluster_id }} {
+    tooltip="{{ tooltip }}"
+    color = "{{ border_color }}"
+    style="rounded"
+    label = "  {{ label }}"
+    labeljust = "l"
+    {% if pen_color %}pencolor = "{{ pen_color }}"{% endif %}
+    {% if pen_width %}penwidth = {{ pen_width }}{% endif %}
+    {{ content }}
+}

fastapi_voyager/templates/dot/cluster_container.j2

@@ -0,0 +1,9 @@
+subgraph cluster_{{ name }} {
+    color = "{{ border_color }}"
+    margin={{ margin }}
+    style="dashed"
+    label = "  {{ label }}"
+    labeljust = "l"
+    fontsize = {{ fontsize }}
+    {{ content }}
+}

fastapi_voyager/templates/dot/digraph.j2

@@ -0,0 +1,25 @@
+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 }}
+    ];
+
+    {{ tags_cluster }}
+
+    {{ routes_cluster }}
+
+    {{ schemas_cluster }}
+
+    {{ links }}
+}

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/templates/dot/link.j2

@@ -0,0 +1 @@
+{{ source }}:e -> {{ target }}:w [{{ attributes }}];

fastapi_voyager/templates/dot/route_node.j2

@@ -0,0 +1,5 @@
+"{{ id }}" [
+    label = "    {{ name }} | {{ response_schema }}    "
+    margin="{{ margin }}"
+    shape = "record"
+];

fastapi_voyager/templates/dot/schema_node.j2

@@ -0,0 +1,5 @@
+"{{ id }}" [
+    label = {{ label }}
+    shape = "plain"
+    margin="{{ margin }}"
+];

fastapi_voyager/templates/dot/tag_node.j2

@@ -0,0 +1,5 @@
+"{{ id }}" [
+    label = "    {{ name }}    "
+    shape = "record"
+    margin="{{ margin }}"
+];

fastapi_voyager/templates/html/colored_text.j2

@@ -0,0 +1 @@
+<font color="{{ color }}">{% if strikethrough %}<s>{{ text }}</s>{% else %}{{ text }}{% endif %}</font>

fastapi_voyager/templates/html/pydantic_meta.j2

@@ -0,0 +1 @@
+{% if meta_parts %}<br align="left"/><br align="left"/>{{ meta_parts | join('<br align="left"/>') }}<br align="left"/>{% endif %}

fastapi_voyager/templates/html/schema_field_row.j2

@@ -0,0 +1 @@
+<tr><td align="{{ align }}" {% if port %}port="f{{ port }}"{% endif %} cellpadding="8">{{ content }}</td></tr>

fastapi_voyager/templates/html/schema_header.j2

@@ -0,0 +1,2 @@
+<tr><td cellpadding="6" bgcolor="{{ bg_color }}" align="center" colspan="1" {% if port %}port="{{ port }}"{% endif %}>
+    <font color="white">    {{ text }}    </font></td></tr>

fastapi_voyager/templates/html/schema_table.j2

@@ -0,0 +1,4 @@
+<<table border="0" cellborder="1" cellpadding="0" cellspacing="0" bgcolor="white">
+{{ header }}
+{{ rows }}
+</table>>

fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.14.1"
+__version__ = "0.15.1"

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>`,
-});
+})