Finish adding type annotations (#85)

* Finish adding type annotations

* exclude tests

* clarify errors

Author: hbmartin

graphviz2drawio/models/Arguments.py

@@ -2,7 +2,7 @@
 
 
 class Arguments(ArgumentParser):
-    def __init__(self, version) -> None:
+    def __init__(self, version: str) -> None:
         super().__init__(prog="graphviz2drawio")
         self.add_argument("to_convert", metavar="file.dot", help="graphviz file")
         output = self.add_mutually_exclusive_group()

graphviz2drawio/models/Errors.py

@@ -1,3 +1,6 @@
+from xml.etree.ElementTree import Element
+
+
 class GdValueError(ValueError):
     """Base class for exceptions raised during conversion."""
 
@@ -8,22 +11,32 @@ def __init__(self, message: str) -> None:
 class MissingTitleError(GdValueError):
     """Title missing from SVG element."""
 
-    def __init__(self, g) -> None:
-        super().__init__("Title missing from SVG element.")
-        self.g = g
+    def __init__(self, g: Element) -> None:
+        super().__init__(
+            f"Title missing from SVG element: {g.tag} with attributes {g.attrib}.",
+        )
+
+
+class MissingTextError(GdValueError):
+    """Title missing from SVG element."""
+
+    def __init__(self, g: Element) -> None:
+        super().__init__(
+            f"Text missing from SVG element: {g.tag} with attributes {g.attrib}.",
+        )
 
 
 class InvalidBezierParameterError(GdValueError):
     """Invalid Bezier parameter, must be 0 <= t <= 1."""
 
-    def __init__(self, t) -> None:
+    def __init__(self, t: float) -> None:
         super().__init__(f"Invalid Bezier parameter (t={t}), must be 0 <= t <= 1.")
 
 
 class MissingIdentifiersError(GdValueError):
     """Missing identifiers for a geometry."""
 
-    def __init__(self, sid, gid) -> None:
+    def __init__(self, sid: str | None, gid: str | None) -> None:
         super().__init__(
             f"Missing identifiers for a geometry: sid(id): {sid}, gid(title): {gid}.",
         )

graphviz2drawio/models/Rect.py

@@ -38,7 +38,7 @@ def to_dict_str(self) -> dict[str, str]:
             "height": str(self.height),
         }
 
-    def closest_point_along_perimeter(self, x: float, y: float):
+    def closest_point_along_perimeter(self, x: float, y: float) -> tuple[float, float]:
         x = clamp(x, self.x, self.right)
         y = clamp(y, self.y, self.bottom)
 
@@ -62,5 +62,5 @@ def relative_location_along_perimeter(self, point: complex) -> tuple[float, floa
         return self.x_ratio(p[0]), self.y_ratio(p[1])
 
 
-def clamp(value, min_v, max_v):
+def clamp(value: float, min_v: float, max_v: float) -> float:
     return max(min(value, max_v), min_v)

graphviz2drawio/models/SVG.py

@@ -3,7 +3,7 @@
 NS_SVG = "{http://www.w3.org/2000/svg}"
 
 
-def svg_tag(tag):
+def svg_tag(tag: str) -> str:
     return f"{NS_SVG}{tag}"
 
 
@@ -27,5 +27,5 @@ def get_text(g: Element) -> str | None:
     return None
 
 
-def is_tag(g, tag):
+def is_tag(g: Element, tag: str) -> bool:
     return g.tag == svg_tag(tag)

graphviz2drawio/mx/Curve.py

@@ -67,7 +67,7 @@ def y(x: float) -> float:
     return y
 
 
-def _rotate_bezier(cb):
+def _rotate_bezier(cb: CubicBezier) -> CubicBezier:
     """Reverse imaginary and real parts for all components."""
     return CubicBezier(
         complex(cb.start.imag, cb.start.real),

graphviz2drawio/mx/CurveFactory.py

@@ -1,4 +1,5 @@
 import cmath
+from typing import Any
 
 from svg.path import CubicBezier, Path, QuadraticBezier, parse_path
 
@@ -54,5 +55,5 @@ def from_svg(self, svg_path: str) -> Curve:
         return Curve(start=start, end=end, is_bezier=is_bezier, points=points)
 
 
-def _is_cubic(p):
+def _is_cubic(p: Any) -> bool:  # noqa: ANN401
     return isinstance(p, CubicBezier)

graphviz2drawio/mx/Edge.py

@@ -97,11 +97,6 @@ def _get_arrow_shape_and_fill(
 
         return shape, fill
 
-    def curve_start_end(self):
-        if self.dir == DotAttr.BACK:
-            return self.curve.end, self.curve.start
-        return self.curve.start, self.curve.end
-
     @property
     def key_for_label(self) -> str:
         return f"{self.gid}-{self.curve}-{self.dir}"

graphviz2drawio/mx/EdgeFactory.py

@@ -1,3 +1,5 @@
+from xml.etree.ElementTree import Element
+
 from graphviz2drawio.models import SVG
 
 from ..models.CoordsTranslate import CoordsTranslate
@@ -13,7 +15,7 @@ def __init__(self, coords: CoordsTranslate, *, is_directed: bool) -> None:
         self.curve_factory = CurveFactory(coords)
         self.is_directed = is_directed
 
-    def from_svg(self, g) -> Edge:
+    def from_svg(self, g: Element) -> Edge:
         title = SVG.get_title(g)
         if title is None:
             raise MissingTitleError(g)

graphviz2drawio/mx/GraphObj.py

@@ -3,11 +3,11 @@
 
 class GraphObj:
 
-    def __init__(self, sid, gid) -> None:
+    def __init__(self, sid: str, gid: str) -> None:
         self.sid = sid
         self.gid = gid
 
-    def enrich_from_graph(self, attrs) -> None:
+    def enrich_from_graph(self, attrs: list) -> None:
         for k, v in attrs:
             if (
                 k not in _whitelist_attrs

graphviz2drawio/mx/MxGraph.py

@@ -2,6 +2,7 @@
 from xml.etree.ElementTree import Element, SubElement, indent, tostring
 
 from graphviz2drawio.models import DotAttr
+from graphviz2drawio.models.Rect import Rect
 from graphviz2drawio.mx import MxConst
 from graphviz2drawio.mx.Curve import Curve
 from graphviz2drawio.mx.Edge import Edge
@@ -97,7 +98,7 @@ def add_node(self, node: Node) -> None:
         self.add_mx_geo(node_element, node.rect)
 
     @staticmethod
-    def add_mx_geo(element, rect=None) -> None:
+    def add_mx_geo(element: Element, rect: Rect | None = None) -> None:
         if rect is None:
             SubElement(element, MxConst.GEO, attrib={"as": "geometry", "relative": "1"})
         else: