Graphinate 0.9.0__tar.gz → 0.10.0__tar.gz

{graphinate-0.9.0 → graphinate-0.10.0}/.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
-        run: uv sync
+        run: uv sync --only-group dev
       - name: Run Ruff Linter
         run: uvx ruff check .
       - name: Check Ruff Formatting

{graphinate-0.9.0 → graphinate-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Graphinate
-Version: 0.9.0
+Version: 0.10.0
 Summary: Graphinate. Data to Graphs.
 Project-URL: Homepage, https://erivlis.github.io/graphinate
 Project-URL: Documentation, https://erivlis.github.io/graphinate
@@ -34,8 +34,8 @@ Requires-Dist: loguru
 Requires-Dist: mappingtools
 Requires-Dist: matplotlib
 Requires-Dist: networkx
-Requires-Dist: networkx-mermaid>=0.3.0
-Requires-Dist: networkx-query>=2.1.3
+Requires-Dist: networkx-mermaid
+Requires-Dist: networkx-query
 Requires-Dist: strawberry-graphql[asgi,opentelemetry]
 Provides-Extra: plot
 Requires-Dist: scipy; extra == 'plot'

{graphinate-0.9.0 → graphinate-0.10.0}/examples/code/python_ast.py

@@ -55,7 +55,7 @@ def ast_graph_model():
 
     graph_model = graphinate.model(name=f'AST Graph - {code_object.__qualname__}',)
 
-    root_ast_node = ast.parse(inspect.getsource(graphinate.builders.D3Builder))
+    root_ast_node = ast.parse(inspect.getsource(code_object))
 
     def node_type(ast_node):
         return ast_node.__class__.__name__

{graphinate-0.9.0 → graphinate-0.10.0}/examples/system/files.py

@@ -1,13 +1,14 @@
 import fnmatch
 import operator
 import pathlib
+from collections.abc import Iterable
 
 from magika import Magika
 
 import graphinate
 
 
-def load_ignore_patterns(ignore_files):
+def load_ignore_patterns(ignore_files: Iterable[str]) -> set[str]:
     patterns = set()
     for ignore_file in ignore_files:
         if pathlib.Path(ignore_file).exists():
@@ -19,17 +20,20 @@ def load_ignore_patterns(ignore_files):
     return patterns
 
 
-def is_ignored(path, patterns):
+def is_ignored(path: pathlib.Path, patterns: Iterable[str]) -> bool:
     return any(fnmatch.fnmatch(path.as_posix(), pattern) for pattern in patterns)
 
 
-def create_filesystem_graph_model(input_folder='.', ignore_files=['.ignore', '.gitignore', '.dockerignore']):
+def create_filesystem_graph_model(
+        input_folder: str = '.',
+        ignore_files: Iterable[str] = ('.ignore', '.gitignore', '.dockerignore')
+):
     """
     Create a graph model of the file system structure.
 
     Args:
         input_folder (str): The folder to start the traversal from. Defaults to the current folder.
-        ignore_files (list): A list of files containing ignore patterns.
+        ignore_files (Iterable): A list of files containing ignore patterns.
                              Defaults to ['.ignore', '.gitignore', '.dockerignore'].
 
     Returns:

{graphinate-0.9.0 → graphinate-0.10.0}/examples/system/processes.py

@@ -1,3 +1,9 @@
+"""
+Example: Processes Graph
+This example demonstrates how to create a graph model representing
+processes and their parent-child relationships using the `psutil` library.
+"""
+
 import operator
 from collections.abc import Iterable
 
@@ -61,4 +67,4 @@ if __name__ == '__main__':
 
     # Or
     # 3. Option B - Output as a plot
-    graphinate.materializers.plot(graph)
+    graphinate.renderers.matplotlib.plot(graph)

graphinate-0.10.0/playground/social/requirements.txt

@@ -0,0 +1 @@
+lxml

{graphinate-0.9.0 → graphinate-0.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Graphinate"
-version = "0.9.0"
+version = "0.10.0"
 description = "Graphinate. Data to Graphs."
 authors = [
     { name = "Eran Rivlis", email = "eran@rivlis.info" },
@@ -35,8 +35,8 @@ dependencies = [
     "mappingtools",
     "matplotlib",
     "networkx",
-    "networkx-mermaid>=0.3.0",
-    "networkx-query>=2.1.3",
+    "networkx-mermaid",
+    "networkx-query",
     "strawberry-graphql[asgi,opentelemetry]",
 ]
 
@@ -56,6 +56,10 @@ server = [
 "Source" = "https://github.com/erivlis/graphinate"
 
 
+[project.scripts]
+graphinate = "graphinate.cli:cli"
+
+
 [dependency-groups]
 dev = [
     "ruff",

{graphinate-0.9.0 → graphinate-0.10.0}/src/graphinate/builders.py

@@ -438,6 +438,10 @@ class GraphQLBuilder(NetworkxBuilder):
         created: datetime | None
         updated: datetime | None
 
+    @strawberry.enum
+    class GraphNodeType(Enum):
+        ...  # pragma: no cover
+
     @strawberry.interface(description="Represents a Graph Node")
     class GraphNode(GraphElement):
         node_id: strawberry.ID
@@ -445,7 +449,9 @@ class GraphQLBuilder(NetworkxBuilder):
         lineage: str
 
         @strawberry.field()
-        def neighbors(self, children: bool = False) -> list[Optional['GraphQLBuilder.GraphNode']]:
+        def neighbors(self,
+                      type: 'GraphQLBuilder.GraphNodeType | None' = None,
+                      children: bool = False) -> list[Optional['GraphQLBuilder.GraphNode']]:
             ...  # pragma: no cover
 
         @strawberry.field()
@@ -628,30 +634,63 @@ class GraphQLBuilder(NetworkxBuilder):
             description=f"Represents a {capitalized_name} Graph Node"
         )
 
+    @staticmethod
+    def _graphql_enum(name: str, values: list[str]) -> type[Enum]:
+        return strawberry.enum(
+            Enum(name, {v: v for v in values}),
+            name=name,
+            description=f"{name} Enumeration"
+        )
+
     @classmethod
     @functools.lru_cache
     def _children_types(cls, model: GraphModel, node_type: str):
         return model.node_children_types(node_type).get(node_type, [])
 
+    def _populate_graph_node_type_enum(self, node_types: list[str]):
+        from strawberry.types.enum import EnumValue
+
+        for v in node_types:
+            self.GraphNodeType._member_names_.append(v)
+            self.GraphNodeType._member_map_[v] = v
+            self.GraphNodeType._value2member_map_[v] = v
+
+            self.GraphNodeType._enum_definition.values.append(
+                EnumValue(
+                    name=v,
+                    value=v,
+                    description=f"Graph Node Type: {v}"
+                )
+            )
+
     @property
     @functools.lru_cache
     def _graphql_types(self) -> dict[str, type['GraphQLBuilder.GraphNode']]:
         node_types = list(self._graph.graph['node_types'].keys())
 
+        self._populate_graph_node_type_enum(node_types)
+
         def neighbors_resolver():
             graph = self._graph
 
             children_types = set(self._children_types(self.model, node_type))
 
-            def node_neighbors(self, children: bool = False) -> list[GraphQLBuilder.GraphNode | None]:
+            def node_neighbors(self,
+                               type: 'GraphQLBuilder.GraphNodeType | None' = None,
+                               children: bool = False) -> list['GraphQLBuilder.GraphNode']:
                 node = decode_id(self.id)
-                items = (GraphQLBuilder._graph_node(graphql_types[d['type']], n, d) for n, d in graph.nodes(data=True)
+                items = (GraphQLBuilder._graph_node(graphql_types[d['type']], n, d)
+                         for n, d in graph.nodes(data=True)
                          if n in graph.neighbors(node))
 
+                if type is not None:
+                    items = (item for item in items if item.type == type)
+
                 if children and children_types:
-                    return [item for item in items if item.type in children_types]
+                    items = (item for item in items if item.type in children_types)
 
-                return list(items)
+                items = list(items)
+                return items
 
             return node_neighbors
 

{graphinate-0.9.0 → graphinate-0.10.0}/src/graphinate/cli.py

@@ -1,5 +1,6 @@
 import importlib
 import json
+from pathlib import Path
 from typing import Any
 
 import click
@@ -9,7 +10,7 @@ from graphinate.renderers.graphql import DEFAULT_PORT
 
 
 def _get_kwargs(ctx) -> dict:
-    return dict([item.strip('--').split('=') for item in ctx.args if item.startswith("--")])
+    return dict([item.strip('--').split('=') for item in ctx.args if item.startswith("--")])  # NOSONAR
 
 
 def import_from_string(import_str: Any) -> Any:
@@ -72,15 +73,26 @@ model_option = click.option('-m', '--model',
 @click.group()
 @click.pass_context
 def cli(ctx):
-    pass
+    ctx.ensure_object(dict)
 
 
 @cli.command()
 @model_option
 @click.pass_context
-def save(ctx, model):
+def save(ctx, model: GraphModel):
+    file_path = Path(f"{model.name}.d3_graph.json")
+
+    if file_path.is_absolute():
+        raise click.ClickException("Please provide a relative file path for saving the graph.")
+
+    if file_path.parent != Path('.'):
+        raise click.ClickException("Saving to subdirectories is not supported. Please provide a file name only.")
+
+    if file_path.exists():
+        click.confirm(f"The file '{file_path}' already exists. Do you want to overwrite it?", abort=True)
+
     kwargs = _get_kwargs(ctx)
-    with open(f"{model.name}.d3_graph.json", mode='w') as fp:
+    with open(file_path, mode='w') as fp:
         graph = builders.D3Builder(model, **kwargs).build()
         json.dump(graph, fp=fp, default=str, **kwargs)
 
@@ -100,4 +112,4 @@ def server(ctx, model: GraphModel, port: int, browse: bool):
      ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝     ╚═╝  ╚═╝╚═╝╚═╝  ╚═══╝╚═╝  ╚═╝   ╚═╝   ╚══════╝"""
     click.echo(message)
     schema = builders.GraphQLBuilder(model).build()
-    graphql(schema, port=port, browse=browse, **_get_kwargs(ctx))
+    graphql.server(schema, port=port, browse=browse, **_get_kwargs(ctx))

{graphinate-0.9.0 → graphinate-0.10.0}/src/graphinate/color.py

@@ -61,7 +61,8 @@ def color_hex(color: Union[str, Sequence[Union[float, int]]]) -> Union[str, Sequ
             msg = "Input values should either be a float between 0 and 1 or an int between 0 and 255"
             raise ValueError(msg)
 
-        return '#{:02x}{:02x}{:02x}'.format(*rgb)
+        r, g, b = rgb
+        return f'#{r:02x}{g:02x}{b:02x}'
 
     else:
         return color

{graphinate-0.9.0 → graphinate-0.10.0}/src/graphinate/renderers/graphql.py

@@ -28,7 +28,7 @@ def _openapi_schema(request: Request) -> ASGIApp:
     """
     schema_data = {
         'openapi': '3.0.0',
-        'info': {'title': 'Graphinate API', 'version': '0.9.0'},
+        'info': {'title': 'Graphinate API', 'version': '0.10.0'},
         'paths': {
             '/graphql': {'get': {'responses': {200: {'description': 'GraphQL'}}}},
             '/graphiql': {'get': {'responses': {200: {'description': 'GraphiQL UI.'}}}},
@@ -80,7 +80,7 @@ def _starlette_app(graphql_app: strawberry.asgi.GraphQL | None = None, port: int
         app.add_route("/schema", route=_openapi_schema, include_in_schema=False)
         app.add_route("/openapi.json", route=_openapi_schema, include_in_schema=False)
 
-    async def redirect_to_viewer(request):
+    def redirect_to_viewer(request):
         return RedirectResponse(url='/viewer')
 
     app.add_route('/', redirect_to_viewer)

{graphinate-0.9.0 → graphinate-0.10.0}/src/graphinate/server/starlette/views.py

@@ -1,13 +1,15 @@
+import functools
+
 from starlette.responses import FileResponse
 from starlette.routing import Route
 
 from ..web import get_static_path
 
 
-async def favicon(request):
+def favicon(request):
     path = get_static_path('images/logo-128.png').absolute().as_posix()
     return FileResponse(path)
 
-
+@functools.cache
 def favicon_route() -> Route:
     return Route('/favicon.ico', endpoint=favicon, include_in_schema=False)

{graphinate-0.9.0 → graphinate-0.10.0}/src/graphinate/server/web/viewer/index.html

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="">
+<html lang="en">
 <head>
     <title>Graphinate Viewer</title>
     <link rel="modulepreload"
@@ -16,8 +16,8 @@
         import * as TweakpaneEssentialsPlugin
             from 'https://cdn.jsdelivr.net/npm/@tweakpane/plugin-essentials@0.2.1/dist/tweakpane-plugin-essentials.min.js';
         // Export it as a global variable
-        window.Tweakpane = Tweakpane;
-        window.TweakpaneEssentialsPlugin = TweakpaneEssentialsPlugin;
+        globalThis.Tweakpane = Tweakpane;
+        globalThis.TweakpaneEssentialsPlugin = TweakpaneEssentialsPlugin;
     </script>
     <script src="https://cdn.jsdelivr.net/npm/3d-force-graph@1.76.2/dist/3d-force-graph.min.js"
             integrity="sha384-zSKZ615fogcuRjUjE+0YstAo3N/t7PzUvtQu5KGA1iqkmHXsTRst7zP+6573D+hK"
@@ -96,12 +96,12 @@
 
         function lowerZIndexForHigherPanels(panel) {
             const panels = document.querySelectorAll('.floating-panel');
-            panels.forEach(p => {
-                const zIndex = parseInt(window.getComputedStyle(p).zIndex, 10);
-                if (zIndex > parseInt(panel.style.zIndex, 10)) {
+            for (const p of panels) {
+                const zIndex = Number.parseInt(globalThis.getComputedStyle(p).zIndex, 10);
+                if (zIndex > Number.parseInt(panel.style.zIndex, 10)) {
                     p.style.zIndex = zIndex - 1;
                 }
-            });
+            }
         }
 
         // Function to bring the panel to the front
@@ -170,7 +170,7 @@
         closeButton.addEventListener('click', () => {
             lowerZIndexForHigherPanels(panel);
             highestZIndex--;
-            document.body.removeChild(panel);
+            panel.remove();
         });
 
         // Create the maximize toggle button
@@ -335,7 +335,7 @@
         .linkDirectionalArrowLength(link => graphParams.linkDirectionalArrowLength)
         .linkDirectionalArrowRelPos(link => graphParams.linkDirectionalArrowRelPos)
         .linkDirectionalParticles(link => graphParams.linkDirectionalParticles)
-        .linkDirectionalParticleSpeed(link => graphParams.linkDirectionalParticleSpeed / 10000.0)
+        .linkDirectionalParticleSpeed(link => graphParams.linkDirectionalParticleSpeed / 10000)
         .linkDirectionalParticleWidth(link => graphParams.linkDirectionalParticleWidth)
         .linkDirectionalParticleColor(link => graphParams.linkDirectionalParticleColor)
         .cooldownTicks(100);
@@ -377,9 +377,9 @@
                 const linePos = line.geometry.getAttribute('position');
 
                 // calculate coordinate on the node's surface instead of center
-                linePos.set([startR / lineLen, 1 - endR / lineLen].map(t =>
+                linePos.set([startR / lineLen, 1 - endR / lineLen].flatMap(t =>
                     ['x', 'y', 'z'].map(dim => start[dim] + (end[dim] - start[dim]) * t)
-                ).flat());
+                ));
                 linePos.needsUpdate = true;
                 return true;
             });
@@ -392,33 +392,34 @@
 
     function getVisible(gData) {
         const visibleNodes = []
-        gData.nodes.forEach((node) => {
+        for (const node of gData.nodes) {
             if (node.type in nodeTypeVisibility && nodeTypeVisibility[node.type]) {
                 visibleNodes.push(node);
             }
-        });
+        }
+
         const visibleLinks = [];
-        gData.links.forEach((link) => {
-            if (visibleNodes.find((node) => node.id === link.source.id) && visibleNodes.find((node) => node.id === link.target.id)) {
+        for (const link of gData.links) {
+           if (visibleNodes.find((node) => node.id === link.source.id) && visibleNodes.find((node) => node.id === link.target.id)) {
                 visibleLinks.push(link);
             }
-        });
+        }
 
         return {nodes: visibleNodes, links: visibleLinks};
     }
 
     function setAllNodeTypeVisibility(value) {
-        Object.keys(nodeTypeVisibility).forEach(key => {
+        for (const key of Object.keys(nodeTypeVisibility)) {
             nodeTypeVisibility[key] = value;
-        });
+        }
     }
 
     function updateNodeTypeColorMapping(nodes) {
-        nodes.forEach(node => {
+        for (const node of nodes) {
             if (!nodeTypeColor[node.type]) {
                 nodeTypeColor[node.type] = node.color;
             }
-        });
+        }
     }
 
     function refreshGraph(gData) {
@@ -451,17 +452,19 @@
             label: 'Visibility',
         }).on('click', (ev) => {
             switch (ev.cell.title) {
-                case 'All On':
+                case 'All On': {
                     setAllNodeTypeVisibility(true);
                     updateGraph(gData);
                     pane.refresh();
                     break;
-                case 'All Off':
+                }
+                case 'All Off': {
                     setAllNodeTypeVisibility(false);
                     const visibleGData = getVisible(gData);
                     updateGraph(visibleGData);
                     pane.refresh();
                     break;
+                }
                 default:
                     console.log('Unknown action');
             }
@@ -491,7 +494,7 @@
         // Legend tab
         const legendTab = tab.pages[0];
 
-        graph.nodeTypes.forEach(nodeType => {
+        for (const nodeType of graph.nodeTypes) {
             let info = `V: ${nodeType.count}`
             const edgeType = graph.edgeTypes.find((t) => t.name === nodeType.name);
             if (edgeType) {
@@ -502,11 +505,11 @@
 
             nodeTypeFolder.addBinding(nodeTypeColor, nodeType.name, {label: 'Color'})
                 .on('change', (ev) => {
-                    gData.nodes.forEach(node => {
+                    for (const node of gData.nodes) {
                         if (node.type === nodeType.name) {
                             node.color = ev.value;
                         }
-                    });
+                    }
                     refreshGraph(gData);
                 });
 
@@ -515,8 +518,7 @@
                 .on('change', (ev) => {
                     refreshGraph(gData);
                 });
-        });
-
+        }
 
         // Advanced tab
 

{graphinate-0.9.0 → graphinate-0.10.0}/tests/graphinate/test_builders.py

@@ -490,8 +490,9 @@ def test_populate_nodes_empty_generator(builder_with_graph):
     node_type_absolute_id = ('parent', 'child')
 
     def generator(**kwargs):
-        return
-        yield
+        """Dummy generator that yields nothing"""
+        return  # NOSONAR
+        yield  # NOSONAR
 
     node_model = DummyNodeModel(generator=generator)
     builder_with_graph.model._node_models = {node_type_absolute_id: [node_model]}

{graphinate-0.9.0 → graphinate-0.10.0}/tests/graphinate/test_server.py

@@ -13,7 +13,7 @@ def test_get_static_path():
 
 @pytest.mark.asyncio
 async def test_favicon():
-    actual = await graphinate.server.starlette.views.favicon(None)
+    actual = graphinate.server.starlette.views.favicon(None)
 
     assert isinstance(actual, FileResponse)
     assert actual.media_type == 'image/png'