feature: new params for graphviz + solves Technologicat#70

cf. maciejczyzewski@ac1bd55

Author: aurelg

.gitignore

@@ -162,3 +162,8 @@ htmlcov
 .idea/
 .history/
 .vscode/
+
+# our vis. of architecture
+architecture.dot
+architecture.html
+architecture.svg

README.md

@@ -48,19 +48,19 @@ See `pyan3 --help`.
 
 Example:
 
-`pyan *.py --uses --no-defines --colored --grouped --annotated --dot >myuses.dot`
+`pyan3 *.py --uses --no-defines --colored --grouped --annotated --dot >myuses.dot`
 
 Then render using your favorite GraphViz filter, mainly `dot` or `fdp`:
 
 `dot -Tsvg myuses.dot >myuses.svg`
 
 Or use directly
 
-`pyan *.py --uses --no-defines --colored --grouped --annotated --svg >myuses.svg`
+`pyan3 *.py --uses --no-defines --colored --grouped --annotated --svg >myuses.svg`
 
 You can also export as an interactive HTML
 
-`pyan *.py --uses --no-defines --colored --grouped --annotated --html > myuses.html`
+`pyan3 *.py --uses --no-defines --colored --grouped --annotated --html > myuses.html`
 
 Alternatively, you can call `pyan` from a script
 

pyan/main.py

@@ -141,6 +141,31 @@ def main(cli_args=None):
         ),
     )
 
+    parser.add_argument(
+        "--dot-ranksep",
+        default="0.5",
+        dest="ranksep",
+        help=(
+            "specifies the dot graph 'ranksep' property for "
+            "controlling desired rank separation, in inches. "
+            "Allowed values: [0.02 .. 1000.0]. "
+            "[dot only]"
+        ),
+    )
+
+    parser.add_argument(
+        "--graphviz-layout",
+        default="dot",
+        dest="layout",
+        help=(
+            "specifies the graphviz 'layout' property for "
+            "the name of the layout algorithm to use. "
+            "Allowed values: ['dot', 'neato', 'fdp', 'sfdp', 'twopi', 'circo']. "
+            "Recommended values: ['dot', 'fdp']. "
+            "[graphviz only]"
+        ),
+    )
+
     parser.add_argument(
         "-a",
         "--annotated",
@@ -159,9 +184,15 @@ def main(cli_args=None):
 
     known_args, unknown_args = parser.parse_known_args(cli_args)
 
-    filenames = [fn2 for fn in unknown_args for fn2 in glob(fn, recursive=True)]
+    filenames = []
+
+    for fn in unknown_args:
+        for fn2 in glob(fn, recursive=True):
+            abs_fn2 = os.path.abspath(fn2)
+            filenames.append(abs_fn2)
 
     # determine root
+
     if known_args.root is not None:
         root = os.path.abspath(known_args.root)
     else:
@@ -203,7 +234,12 @@ def main(cli_args=None):
         handler = logging.FileHandler(known_args.logname)
         logger.addHandler(handler)
 
-    v = CallGraphVisitor(filenames, logger=logger, root=root)
+    logger.debug(f"[files] {unknown_args}")
+
+    if root:
+        root = os.path.abspath(root)
+
+    v = CallGraphVisitor(filenames, logger=logger, root=root)  # type: ignore
 
     if known_args.function or known_args.namespace:
 
@@ -222,13 +258,40 @@ def main(cli_args=None):
     writer = None
 
     if known_args.dot:
-        writer = DotWriter(graph, options=["rankdir=" + known_args.rankdir], output=known_args.filename, logger=logger)
+        writer = DotWriter(
+            graph,
+            options=[
+                "rankdir=" + known_args.rankdir,
+                "ranksep=" + known_args.ranksep,
+                "layout=" + known_args.layout,
+            ],
+            output=known_args.filename,
+            logger=logger,
+        )
 
     if known_args.html:
-        writer = HTMLWriter(graph, options=["rankdir=" + known_args.rankdir], output=known_args.filename, logger=logger)
+        writer = HTMLWriter(
+            graph,
+            options=[
+                "rankdir=" + known_args.rankdir,
+                "ranksep=" + known_args.ranksep,
+                "layout=" + known_args.layout,
+            ],
+            output=known_args.filename,
+            logger=logger,
+        )
 
     if known_args.svg:
-        writer = SVGWriter(graph, options=["rankdir=" + known_args.rankdir], output=known_args.filename, logger=logger)
+        writer = SVGWriter(
+            graph,
+            options=[
+                "rankdir=" + known_args.rankdir,
+                "ranksep=" + known_args.ranksep,
+                "layout=" + known_args.layout,
+            ],
+            output=known_args.filename,
+            logger=logger,
+        )
 
     if known_args.tgf:
         writer = TgfWriter(graph, output=known_args.filename, logger=logger)

visualize_pyan_architecture.sh

@@ -1,4 +1,16 @@
-#!/bin/bash
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
 echo -ne "Pyan architecture: generating architecture.{dot,svg}\n"
-python3 -m pyan pyan/*.py --no-defines --uses --colored --annotate --dot -V >architecture.dot 2>architecture.log
+python3 \
+  -m pyan pyan/*.py \
+  --no-defines --uses --colored --annotate --dot -V \
+  >architecture.dot \
+  2>architecture.log
 dot -Tsvg architecture.dot >architecture.svg
+
+python3 -m pyan pyan/*.py --no-defines --uses \
+  --grouped --nested-groups \
+  --graphviz-layout fdp \
+  --colored --html >architecture.html