editorial changes

Author: denirz

diagrams_dscr/pyproject.toml

@@ -87,3 +87,6 @@ exclude_lines = [
   "if __name__ == .__main__.:",
   "if TYPE_CHECKING:",
 ]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"src/diagrams_dscr/__init__.py" = ["TID252"]

diagrams_dscr/src/diagrams_dscr/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2025-present denirz <denirz@gmail.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.0.1a0"
+__version__ = "0.0.1a1"

diagrams_dscr/src/diagrams_dscr/__init__.py

@@ -1,4 +1,6 @@
 # SPDX-FileCopyrightText: 2025-present denirz <denirz@gmail.com>
 #
 # SPDX-License-Identifier: MIT
-from .dot_describe import DescribeDiagram as DescribeDiagram
+from .dot_describe import DescribeDiagram
+
+__all__ = ["DescribeDiagram"]

diagrams_dscr/src/diagrams_dscr/dot_describe.py

@@ -16,16 +16,17 @@
     edges (list): A list of edges in the diagram.
 
 """
-from diagrams import Diagram
-import pydot
 import logging
+
 import pandas as pd
+import pydot
+from diagrams import Diagram
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.INFO)
 
 
-class DescribeDiagram(object):
+class DescribeDiagram:
     """
     This class is used to describe a diagram by extracting its nodes and edges.
     It uses the Use Case pattern to represent the diagram as a set of nodes and edges.
@@ -60,7 +61,9 @@ def get_subgraphs(self, subgraph=None):
         """
         if subgraph is None:
             diagdata = pydot.graph_from_dot_data(str(self.dot))
-            assert len(diagdata) == 1
+            if len(diagdata) != 1:
+                logger.error("More than one diagram detected")
+                raise ValueError("More than one diagram detected")
             diagitem = diagdata[0]
         else:
             diagitem = subgraph

diagrams_dscr/tests/AS17_1prom.py

@@ -12,32 +12,26 @@
 https://graphviz.org/docs/attrs/decorate/
 """
 
-from diagrams import Diagram, Cluster, Edge, Node
+from diagrams import Cluster, Diagram, Edge
+
+# from diagrams.onprem.groupware import Nextcloud as Confluence
+from diagrams.alibabacloud.compute import FunctionCompute as Confluence
 
 # AC Hosts
-from diagrams.aws.compute import EC2
-from diagrams.aws.compute import EC2Instance  # Other AC hosts
+from diagrams.aws.compute import (
+    EC2,
+    EC2Instance,  # Other AC hosts
+)
 from diagrams.aws.database import DocumentdbMongodbCompatibility as VectorStore
-from diagrams.oci.compute import BMWhite
-from diagrams.programming.language import Python
-
-# from diagrams.aws.network import NetworkFirewall as SOWA
-from diagrams.aws.network import APIGateway as SOWA
 
 # GigaChat:
 # from diagrams.saas.chat import RocketChat
 from diagrams.aws.ml import AugmentedAi as Giga
-from diagrams.programming.flowchart import Preparation
-from diagrams.onprem.client import User
-from diagrams.saas.analytics import Snowflake  # CodeChat
 
-# from diagrams.onprem.groupware import Nextcloud as Confluence
-from diagrams.alibabacloud.compute import FunctionCompute as Confluence
-
-
-from diagrams.generic.network import Firewall
-from diagrams.aws.database import RDS
-from diagrams.aws.network import ELB
+# from diagrams.aws.network import NetworkFirewall as SOWA
+from diagrams.aws.network import APIGateway as SOWA
+from diagrams.onprem.client import User
+from diagrams.programming.language import Python
 
 # https://www.graphviz.org/doc/info/attrs.html
 graph_attr = {
@@ -145,7 +139,7 @@
 
     user = User("User")
 
-    # todo await  Основная интеграция с ITSM  https://itsm.infra.sbt/sd/operator/#uuid:serviceCall$31088491:serviceCall$request
+    # TODO await  Основная интеграция с ITSM  https://itsm.infra.sbt/sd/operator/#uuid:serviceCall$31088491:serviceCall$request
     (
         api
         >> Edge(
@@ -300,7 +294,7 @@
         >> vdb
     )
 
-    ##todo await for   в теории работает - вот заявкка на проверку:  https://itsm.infra.sbt/sd/operator/#uuid:serviceCall$31150971:serviceCall$request
+    ##TODO await for   в теории работает - вот заявкка на проверку:  https://itsm.infra.sbt/sd/operator/#uuid:serviceCall$31150971:serviceCall$request
     (
         api
         << Edge(
@@ -414,4 +408,4 @@
 # Example  how to use
 if __name__ == '__main__':
     from diagrams_dscr import DescribeDiagram
-    DescribeDiagram(diag).outputEdges()
+    DescribeDiagram(diag).outputEdges()

diagrams_dscr/tests/test_diagrams.py

@@ -1,5 +1,5 @@
 import pytest
-from diagrams import Diagram, Cluster, Edge, Node
+from diagrams import Cluster, Diagram, Edge, Node
 from diagrams.aws.ml import MachineLearning
 from diagrams.saas.logging import NewRelic
 
@@ -21,7 +21,6 @@ def diagram_init():
                 >> Edge(label="Поток логов", description="some test EDGE decritpions ",headlabel="HEAD", color="red", style="dashed", fontcolor="red", fontname="Verdana")
                 >> d
             )
-        pass
 
         return diag
 

diagrams_dscr/tests/test_dot_describe.py

@@ -2,7 +2,6 @@
 
 from diagrams_dscr.dot_describe import DescribeDiagram
 
-
 from .AS17_1prom import diag
 
 
@@ -11,7 +10,6 @@ def diagram_true():
     return diag
 
 
-from .test_diagrams import diagram_init
 
 
 def test_describe_digaram(capsys, diagram_true):
@@ -65,6 +63,7 @@ def test_outputEdges_fieldlist(capsys, diagram_true):
             Fields=["source_name", "dest_name", "headlabel", "label", "description"]
         )
 
+from .test_diagrams import diagram_init
 
 def test_outputEdges_fieldlist(capsys, diagram_init):
     with capsys.disabled():

diagrams_dscr/tests/test_pydot.py

@@ -1,8 +1,9 @@
-import pytest
 import pydot
-
+import pytest
 
 from .AS17_1prom import diag
+
+
 @pytest.fixture
 def diagram_true():
     return diag
@@ -34,4 +35,4 @@ def test_rea(capsys,diagram_true):
         # print(graphs[0].get_nodes())
         # for i,node  in enumerate(graphs[0].get_node_list()):
         #     print(i)
-        #     print(node.get_name())
+        #     print(node.get_name())