add pre-commit to verify commit before create PR (#1066)

.github/workflows/pre-commit.yml

@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/action@v3.0.1

.isort.cfg

@@ -0,0 +1,5 @@
+[settings]
+line_length = 120
+multi_line_output = 3
+include_trailing_comma = True
+known_third_party = graphviz,jinja2

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+
+-   repo: https://github.com/asottile/seed-isort-config
+    rev: v2.2.0
+    hooks:
+    -   id: seed-isort-config
+
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.10.1
+    hooks:
+    -   id: isort
+
+-   repo: https://github.com/hhatto/autopep8
+    rev: v2.3.1
+    hooks:
+    -   id: autopep8
+        args: [--in-place, --aggressive, --aggressive, --max-line-length=120]

CHANGELOG.md

@@ -407,4 +407,4 @@ The following import changes:
 | Old import path                                                    | New import path                                               |
 | -------------------------------------------------------------------| --------------------------------------------------------------|
 | `from diagrams.oci.connectivity import CustomerPremiseWhite`       | `from diagrams.oci.connectivity import CustomerPremisesWhite` |
-| `from diagrams.oci.connectivity import CustomerPremises`           | `from diagrams.oci.connectivity import CustomerPremises`      |
+| `from diagrams.oci.connectivity import CustomerPremises`           | `from diagrams.oci.connectivity import CustomerPremises`      |

DEVELOPMENT.md

@@ -75,4 +75,4 @@ To be able to develop and run diagrams locally on you Mac device, you should hav
     ./autogen.sh
     ```
 
-7. If the unit tests and the bash script `autogen.sh` is working correctly, then your system is now ready for development.
+7. If the unit tests and the bash script `autogen.sh` is working correctly, then your system is now ready for development.

diagrams/__init__.py

@@ -139,7 +139,8 @@ class Diagram:
         if isinstance(outformat, list):
             for one_format in outformat:
                 if not self._validate_outformat(one_format):
-                    raise ValueError(f'"{one_format}" is not a valid output format')
+                    raise ValueError(
+                        f'"{one_format}" is not a valid output format')
         else:
             if not self._validate_outformat(outformat):
                 raise ValueError(f'"{outformat}" is not a valid output format')
@@ -478,7 +479,8 @@ class Edge:
 
         if label:
             # Graphviz complaining about using label for edges, so replace it with xlabel.
-            # Update: xlabel option causes the misaligned label position: https://github.com/mingrammer/diagrams/issues/83
+            # Update: xlabel option causes the misaligned label position:
+            # https://github.com/mingrammer/diagrams/issues/83
             self._attrs["label"] = label
         if color:
             self._attrs["color"] = color
@@ -490,7 +492,8 @@ class Edge:
         """Implement Self - Node or Edge and Self - [Nodes]"""
         return self.connect(other)
 
-    def __rsub__(self, other: Union[List["Node"], List["Edge"]]) -> List["Edge"]:
+    def __rsub__(self, other: Union[List["Node"],
+                 List["Edge"]]) -> List["Edge"]:
         """Called for [Nodes] or [Edges] - Self because list don't have __sub__ operators."""
         return self.append(other)
 
@@ -504,15 +507,23 @@ class Edge:
         self.reverse = True
         return self.connect(other)
 
-    def __rrshift__(self, other: Union[List["Node"], List["Edge"]]) -> List["Edge"]:
+    def __rrshift__(self,
+                    other: Union[List["Node"],
+                                 List["Edge"]]) -> List["Edge"]:
         """Called for [Nodes] or [Edges] >> Self because list of Edges don't have __rshift__ operators."""
         return self.append(other, forward=True)
 
-    def __rlshift__(self, other: Union[List["Node"], List["Edge"]]) -> List["Edge"]:
+    def __rlshift__(self,
+                    other: Union[List["Node"],
+                                 List["Edge"]]) -> List["Edge"]:
         """Called for [Nodes] or [Edges] << Self because list of Edges don't have __lshift__ operators."""
         return self.append(other, reverse=True)
 
-    def append(self, other: Union[List["Node"], List["Edge"]], forward=None, reverse=None) -> List["Edge"]:
+    def append(self,
+               other: Union[List["Node"],
+                            List["Edge"]],
+               forward=None,
+               reverse=None) -> List["Edge"]:
         result = []
         for o in other:
             if isinstance(o, Edge):
@@ -521,7 +532,12 @@ class Edge:
                 self._attrs = o.attrs.copy()
                 result.append(o)
             else:
-                result.append(Edge(o, forward=forward, reverse=reverse, **self._attrs))
+                result.append(
+                    Edge(
+                        o,
+                        forward=forward,
+                        reverse=reverse,
+                        **self._attrs))
         return result
 
     def connect(self, other: Union["Node", "Edge", List["Node"]]):

diagrams/c4/__init__.py

@@ -4,7 +4,8 @@ A set of nodes and edges to visualize software architecture using the C4 model.
 
 import html
 import textwrap
-from diagrams import Cluster, Node, Edge
+
+from diagrams import Cluster, Edge, Node
 
 
 def _format_node_label(name, key, description):
@@ -26,7 +27,8 @@ def _format_description(description):
     """
     wrapper = textwrap.TextWrapper(width=40, max_lines=3)
     lines = [html.escape(line) for line in wrapper.wrap(description)]
-    lines += [""] * (3 - len(lines))  # fill up with empty lines so it is always three
+    # fill up with empty lines so it is always three
+    lines += [""] * (3 - len(lines))
     return "<br/>".join(lines)
 
 

diagrams/programming/framework.py

@@ -53,7 +53,7 @@ class Hibernate(_Framework):
 
 
 class Jhipster(_Framework):
-   _icon = "jhipster.png"
+    _icon = "jhipster.png"
 
 
 class Laravel(_Framework):
@@ -62,15 +62,15 @@ class Laravel(_Framework):
 
 class Micronaut(_Framework):
     _icon = "micronaut.png"
-    
+
 
 class Nextjs(_Framework):
     _icon = "nextjs.png"
-    
+
 
 class Phoenix(_Framework):
     _icon = "phoenix.png"
-    
+
 
 class Quarkus(_Framework):
     _icon = "quarkus.png"

docker/dev/Dockerfile

@@ -25,4 +25,4 @@ WORKDIR /usr/src/diagrams
 COPY . .
 
 # install python requirements.
-RUN pip install black graphviz jinja2
+RUN pip install black graphviz jinja2

pyproject.toml

@@ -17,6 +17,7 @@ python = "^3.9"
 graphviz = ">=0.13.2,<0.21.0"
 jinja2 = ">=2.10,<4.0"
 typed-ast = {version="^1.5.5", markers="python_version<'3.8'"}
+pre-commit = "^4.0.1"
 
 [tool.poetry.dev-dependencies]
 pytest = "^8.2"

scripts/generate.py

@@ -5,7 +5,8 @@ from typing import Iterable
 from jinja2 import Environment, FileSystemLoader, Template, exceptions
 
 import config as cfg
-from . import app_root_dir, doc_root_dir, resource_dir, template_dir, base_dir
+
+from . import app_root_dir, base_dir, doc_root_dir, resource_dir, template_dir
 
 _usage = "Usage: generate.py <provider>"
 
@@ -42,11 +43,11 @@ def gen_classes(pvd: str, typ: str, paths: Iterable[str]) -> str:
 
 def gen_apidoc(pvd: str, typ_paths: dict) -> str:
     try:
-      default_tmp = cfg.TMPL_APIDOC.split('.')
-      tmpl_file = f"{default_tmp[0]}_{pvd}.{default_tmp[1]}"
-      tmpl = load_tmpl(tmpl_file)
+        default_tmp = cfg.TMPL_APIDOC.split(".")
+        tmpl_file = f"{default_tmp[0]}_{pvd}.{default_tmp[1]}"
+        tmpl = load_tmpl(tmpl_file)
     except exceptions.TemplateNotFound:
-      tmpl = load_tmpl(cfg.TMPL_APIDOC)
+        tmpl = load_tmpl(cfg.TMPL_APIDOC)
 
     # TODO: remove
     def _gen_class_name(path: str) -> str:
@@ -61,7 +62,8 @@ def gen_apidoc(pvd: str, typ_paths: dict) -> str:
             name = _gen_class_name(path)
             resource_path = os.path.join(resource_root, path)
             alias = cfg.ALIASES[pvd].get(typ, {}).get(name)
-            typ_classes[typ].append({"name": name, "alias": alias, "resource_path": resource_path})
+            typ_classes[typ].append(
+                {"name": name, "alias": alias, "resource_path": resource_path})
     return tmpl.render(pvd=pvd, typ_classes=typ_classes)
 
 

scripts/resource.py

@@ -11,6 +11,7 @@ import subprocess
 import sys
 
 import config as cfg
+
 from . import resource_dir
 
 _usage = "Usage: resource.py <cmd> <pvd>"
@@ -30,7 +31,7 @@ def cleaner_aws(f):
     f = f.replace("-light-bg", "")
     for p in cfg.FILE_PREFIXES["aws"]:
         if f.startswith(p):
-            f = f[len(p) :]
+            f = f[len(p):]
             break
     return f.lower()
 
@@ -41,7 +42,7 @@ def cleaner_azure(f):
     f = "-".join(f.split())
     for p in cfg.FILE_PREFIXES["azure"]:
         if f.startswith(p):
-            f = f[len(p) :]
+            f = f[len(p):]
             break
     return f.lower()
 
@@ -51,7 +52,7 @@ def cleaner_gcp(f):
     f = "-".join(f.split())
     for p in cfg.FILE_PREFIXES["gcp"]:
         if f.startswith(p):
-            f = f[len(p) :]
+            f = f[len(p):]
             break
     return f.lower()
 
@@ -61,7 +62,7 @@ def cleaner_ibm(f):
     f = "-".join(f.split())
     for p in cfg.FILE_PREFIXES["ibm"]:
         if f.startswith(p):
-            f = f[len(p) :]
+            f = f[len(p):]
             break
     return f.lower()
 
@@ -71,7 +72,7 @@ def cleaner_firebase(f):
     f = "-".join(f.split())
     for p in cfg.FILE_PREFIXES["firebase"]:
         if f.startswith(p):
-            f = f[len(p) :]
+            f = f[len(p):]
             break
     return f.lower()
 
@@ -80,15 +81,16 @@ def cleaner_k8s(f):
     f = f.replace("-256", "")
     for p in cfg.FILE_PREFIXES["k8s"]:
         if f.startswith(p):
-            f = f[len(p) :]
+            f = f[len(p):]
             break
     return f.lower()
 
+
 def cleaner_digitalocean(f):
     f = f.replace("-32", "")
     for p in cfg.FILE_PREFIXES["digitalocean"]:
         if f.startswith(p):
-            f = f[len(p) :]
+            f = f[len(p):]
             break
     return f.lower()
 
@@ -96,7 +98,7 @@ def cleaner_digitalocean(f):
 def cleaner_alibabacloud(f):
     for p in cfg.FILE_PREFIXES["alibabacloud"]:
         if f.startswith(p):
-            f = f[len(p) :]
+            f = f[len(p):]
             break
     return f.lower()
 
@@ -106,7 +108,7 @@ def cleaner_oci(f):
     f = f.replace("_", "-")
     for p in cfg.FILE_PREFIXES["oci"]:
         if f.startswith(p):
-            f = f[len(p) :]
+            f = f[len(p):]
             break
     return f.lower()
 
@@ -201,7 +203,8 @@ def svg2png2(pvd: str) -> None:
     def _convert(base: str, path: str):
         path_src = os.path.join(base, path)
         path_dest = path_src.replace(".svg", ".png")
-        subprocess.run([cfg.CMD_SVG2PNG_IM, *cfg.CMD_SVG2PNG_IM_OPTS, path_src, path_dest])
+        subprocess.run([cfg.CMD_SVG2PNG_IM, *
+                        cfg.CMD_SVG2PNG_IM_OPTS, path_src, path_dest])
         subprocess.run(["rm", path_src])
 
     for root, _, files in os.walk(resource_dir(pvd)):

tests/test_c4.py

@@ -3,14 +3,14 @@ import random
 import string
 import unittest
 
-from diagrams import Diagram
-from diagrams import setcluster, setdiagram
-from diagrams.c4 import Person, Container, Database, System, SystemBoundary, Relationship
+from diagrams import Diagram, setcluster, setdiagram
+from diagrams.c4 import Container, Database, Person, Relationship, System, SystemBoundary
 
 
 class C4Test(unittest.TestCase):
     def setUp(self):
-        self.name = "diagram-" + "".join([random.choice(string.hexdigits) for n in range(7)]).lower()
+        self.name = "diagram-" + \
+            "".join([random.choice(string.hexdigits) for n in range(7)]).lower()
 
     def tearDown(self):
         setdiagram(None)
@@ -23,8 +23,14 @@ class C4Test(unittest.TestCase):
     def test_nodes(self):
         with Diagram(name=self.name, show=False):
             person = Person("person", "A person.")
-            container = Container("container", "Java application", "The application.")
-            database = Database("database", "Oracle database", "Stores information.")
+            container = Container(
+                "container",
+                "Java application",
+                "The application.")
+            database = Database(
+                "database",
+                "Oracle database",
+                "Stores information.")
 
     def test_external_nodes(self):
         with Diagram(name=self.name, show=False):

tests/test_diagram.py

@@ -1,10 +1,9 @@
 import os
+import pathlib
 import shutil
 import unittest
-import pathlib
 
-from diagrams import Cluster, Diagram, Edge, Node
-from diagrams import getcluster, getdiagram, setcluster, setdiagram
+from diagrams import Cluster, Diagram, Edge, Node, getcluster, getdiagram, setcluster, setdiagram
 
 
 class DiagramTest(unittest.TestCase):
@@ -103,20 +102,19 @@ class DiagramTest(unittest.TestCase):
 
     def test_empty_name(self):
         """Check that providing an empty name don't crash, but save in a diagrams_image.xxx file."""
-        self.name = 'diagrams_image'
+        self.name = "diagrams_image"
         with Diagram(show=False):
             Node("node1")
         self.assertTrue(os.path.exists(f"{self.name}.png"))
-    
+
     def test_autolabel(self):
         with Diagram(name=os.path.join(self.name, "nodes_to_node"), show=False):
             node1 = Node("node1")
-            self.assertTrue(node1.label,"Node\nnode1")
-
+            self.assertTrue(node1.label, "Node\nnode1")
 
     def test_outformat_list(self):
         """Check that outformat render all the files from the list."""
-        self.name = 'diagrams_image'
+        self.name = "diagrams_image"
         with Diagram(show=False, outformat=["dot", "png"]):
             Node("node1")
         # both files must exist
@@ -240,56 +238,122 @@ class EdgeTest(unittest.TestCase):
             with Cluster():
                 node1 = Node("node1")
                 nodes = [Node("node2"), Node("node3")]
-                self.assertEqual(nodes - Edge(color="red") - Edge(color="green") - node1, node1)
+                self.assertEqual(
+                    nodes -
+                    Edge(
+                        color="red") -
+                    Edge(
+                        color="green") -
+                    node1,
+                    node1)
 
     def test_node_to_node_with_attributes(self):
         with Diagram(name=os.path.join(self.name, "node_to_node_with_attributes"), show=False):
             with Cluster():
                 node1 = Node("node1")
                 node2 = Node("node2")
-                self.assertEqual(node1 << Edge(color="red", label="1.1") << node2, node2)
-                self.assertEqual(node1 >> Edge(color="green", label="1.2") >> node2, node2)
-                self.assertEqual(node1 << Edge(color="blue", label="1.3") >> node2, node2)
+                self.assertEqual(
+                    node1 << Edge(
+                        color="red",
+                        label="1.1") << node2,
+                    node2)
+                self.assertEqual(
+                    node1 >> Edge(
+                        color="green",
+                        label="1.2") >> node2,
+                    node2)
+                self.assertEqual(
+                    node1 << Edge(
+                        color="blue",
+                        label="1.3") >> node2,
+                    node2)
 
     def test_node_to_node_with_additional_attributes(self):
         with Diagram(name=os.path.join(self.name, "node_to_node_with_additional_attributes"), show=False):
             with Cluster():
                 node1 = Node("node1")
                 node2 = Node("node2")
-                self.assertEqual(node1 << Edge(color="red", label="2.1") << Edge(color="blue") << node2, node2)
-                self.assertEqual(node1 >> Edge(color="green", label="2.2") >> Edge(color="red") >> node2, node2)
-                self.assertEqual(node1 << Edge(color="blue", label="2.3") >> Edge(color="black") >> node2, node2)
+                self.assertEqual(
+                    node1 << Edge(
+                        color="red",
+                        label="2.1") << Edge(
+                        color="blue") << node2,
+                    node2)
+                self.assertEqual(
+                    node1 >> Edge(
+                        color="green",
+                        label="2.2") >> Edge(
+                        color="red") >> node2,
+                    node2)
+                self.assertEqual(
+                    node1 << Edge(
+                        color="blue",
+                        label="2.3") >> Edge(
+                        color="black") >> node2,
+                    node2)
 
     def test_nodes_to_node_with_attributes_loop(self):
         with Diagram(name=os.path.join(self.name, "nodes_to_node_with_attributes_loop"), show=False):
             with Cluster():
                 node = Node("node")
-                self.assertEqual(node >> Edge(color="red", label="3.1") >> node, node)
-                self.assertEqual(node << Edge(color="green", label="3.2") << node, node)
-                self.assertEqual(node >> Edge(color="blue", label="3.3") << node, node)
-                self.assertEqual(node << Edge(color="pink", label="3.4") >> node, node)
+                self.assertEqual(
+                    node >> Edge(
+                        color="red",
+                        label="3.1") >> node,
+                    node)
+                self.assertEqual(
+                    node << Edge(
+                        color="green",
+                        label="3.2") << node,
+                    node)
+                self.assertEqual(
+                    node >> Edge(
+                        color="blue",
+                        label="3.3") << node,
+                    node)
+                self.assertEqual(
+                    node << Edge(
+                        color="pink",
+                        label="3.4") >> node,
+                    node)
 
     def test_nodes_to_node_with_attributes_bothdirectional(self):
         with Diagram(name=os.path.join(self.name, "nodes_to_node_with_attributes_bothdirectional"), show=False):
             with Cluster():
                 node1 = Node("node1")
                 nodes = [Node("node2"), Node("node3")]
-                self.assertEqual(nodes << Edge(color="green", label="4") >> node1, node1)
+                self.assertEqual(
+                    nodes << Edge(
+                        color="green",
+                        label="4") >> node1,
+                    node1)
 
     def test_nodes_to_node_with_attributes_bidirectional(self):
         with Diagram(name=os.path.join(self.name, "nodes_to_node_with_attributes_bidirectional"), show=False):
             with Cluster():
                 node1 = Node("node1")
                 nodes = [Node("node2"), Node("node3")]
-                self.assertEqual(nodes << Edge(color="blue", label="5") >> node1, node1)
+                self.assertEqual(
+                    nodes << Edge(
+                        color="blue",
+                        label="5") >> node1,
+                    node1)
 
     def test_nodes_to_node_with_attributes_onedirectional(self):
         with Diagram(name=os.path.join(self.name, "nodes_to_node_with_attributes_onedirectional"), show=False):
             with Cluster():
                 node1 = Node("node1")
                 nodes = [Node("node2"), Node("node3")]
-                self.assertEqual(nodes >> Edge(color="red", label="6.1") >> node1, node1)
-                self.assertEqual(nodes << Edge(color="green", label="6.2") << node1, node1)
+                self.assertEqual(
+                    nodes >> Edge(
+                        color="red",
+                        label="6.1") >> node1,
+                    node1)
+                self.assertEqual(
+                    nodes << Edge(
+                        color="green",
+                        label="6.2") << node1,
+                    node1)
 
     def test_nodes_to_node_with_additional_attributes_directional(self):
         with Diagram(name=os.path.join(self.name, "nodes_to_node_with_additional_attributes_directional"), show=False):
@@ -297,11 +361,19 @@ class EdgeTest(unittest.TestCase):
                 node1 = Node("node1")
                 nodes = [Node("node2"), Node("node3")]
                 self.assertEqual(
-                    nodes >> Edge(color="red", label="6.1") >> Edge(color="blue", label="6.2") >> node1, node1
-                )
+                    nodes >> Edge(
+                        color="red",
+                        label="6.1") >> Edge(
+                        color="blue",
+                        label="6.2") >> node1,
+                    node1)
                 self.assertEqual(
-                    nodes << Edge(color="green", label="6.3") << Edge(color="pink", label="6.4") << node1, node1
-                )
+                    nodes << Edge(
+                        color="green",
+                        label="6.3") << Edge(
+                        color="pink",
+                        label="6.4") << node1,
+                    node1)
 
 
 class ResourcesTest(unittest.TestCase):
@@ -311,7 +383,13 @@ class ResourcesTest(unittest.TestCase):
         i.e. resources/<provider>/<type>/<image>, so check that this depth isn't
         exceeded.
         """
-        resources_dir = pathlib.Path(__file__).parent.parent / 'resources'
-        max_depth = max(os.path.relpath(d, resources_dir).count(os.sep) + 1
-                        for d, _, _ in os.walk(resources_dir))
+        resources_dir = pathlib.Path(__file__).parent.parent / "resources"
+        max_depth = max(
+            os.path.relpath(
+                d,
+                resources_dir).count(
+                os.sep) +
+            1 for d,
+            _,
+            _ in os.walk(resources_dir))
         self.assertLessEqual(max_depth, 2)

website/sidebars.json

@@ -31,4 +31,4 @@
       "nodes/custom"
     ]
   }
-}
+}

website/static/css/custom.css

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
- 
+
 /* your custom css */
 
 @media only screen and (min-device-width: 360px) and (max-device-width: 736px) {
@@ -24,4 +24,4 @@
 
 #buymeacoffee {
     height: 50px;
-}
+}