gritems: Add support for nets in graphical items

Author: Wittmann-MEE

src/kiutils/items/gritems.py

@@ -63,6 +63,10 @@ class GrText:
     
     Available since KiCad v7"""
 
+    net: Optional[int] = None
+    """The optional ``net`` token defines by net ordinal number which net in the net section that
+    the graphical item is part of."""
+
     @classmethod
     def from_sexpr(cls, exp: list) -> GrText:
         """Convert the given S-Expresstion into a GrText object
@@ -106,6 +110,8 @@ def from_sexpr(cls, exp: list) -> GrText:
                 object.tstamp = item[1]  # Haha :)
             elif item[0] == "render_cache":
                 object.renderCache = RenderCache.from_sexpr(item)
+            elif item[0] == "net":
+                object.net = item[1]
             else:
                 raise ValueError(
                     f"Unrecognized property key: {item[0]}. Full expression: {item}"
@@ -144,6 +150,9 @@ def _to_sexpr_raw(self):
         if layer:
             expr.append(layer)
 
+        if self.net is not None:
+            expr.append(["net", self.net])
+
         if self.tstamp is not None:
             expr.append(["uuid", quote(self.tstamp)])
 
@@ -352,6 +361,10 @@ class GrLine:
     locked: bool = False
     """The ``locked`` token defines if the object may be moved or not"""
 
+    net: Optional[int] = None
+    """The optional ``net`` token defines by net ordinal number which net in the net section that
+    the graphical item is part of."""
+
     @classmethod
     def from_sexpr(cls, exp: list) -> GrLine:
         """Convert the given S-Expresstion into a GrLine object
@@ -394,6 +407,8 @@ def from_sexpr(cls, exp: list) -> GrLine:
                 object.width = item[1]
             elif item[0] == "stroke":
                 object.stroke = GrStroke().from_sexpr(item)
+            elif item[0] == "net":
+                object.net = item[1]
             else:
                 raise ValueError(
                     f"Unrecognized property key: {item[0]}. Full expression: {item}"
@@ -438,6 +453,9 @@ def _to_sexpr_raw(self):
         if self.layer is not None:
             expr.append(["layer", escape_and_quote(self.layer)])
 
+        if self.net is not None:
+            expr.append(["net", self.net])
+
         if self.tstamp is not None:
             expr.append(["uuid", quote(self.tstamp)])
 
@@ -475,6 +493,10 @@ class GrRect:
     locked: bool = False
     """The ``locked`` token defines if the object may be moved or not"""
 
+    net: Optional[int] = None
+    """The optional ``net`` token defines by net ordinal number which net in the net section that
+    the graphical item is part of."""
+
     @classmethod
     def from_sexpr(cls, exp: list) -> GrRect:
         """Convert the given S-Expresstion into a GrRect object
@@ -519,6 +541,8 @@ def from_sexpr(cls, exp: list) -> GrRect:
                 object.width = item[1]
             elif item[0] == "stroke":
                 object.stroke = GrStroke().from_sexpr(item)
+            elif item[0] == "net":
+                object.net = item[1]
             else:
                 raise ValueError(
                     f"Unrecognized property key: {item[0]}. Full expression: {item}"
@@ -564,6 +588,9 @@ def _to_sexpr_raw(self):
         if self.layer is not None:
             expr.append(["layer", escape_and_quote(self.layer)])
 
+        if self.net is not None:
+            expr.append(["net", self.net])
+
         if self.tstamp is not None:
             expr.append(["uuid", quote(self.tstamp)])
 
@@ -601,6 +628,10 @@ class GrCircle:
     locked: bool = False
     """The ``locked`` token defines if the object may be moved or not"""
 
+    net: Optional[int] = None
+    """The optional ``net`` token defines by net ordinal number which net in the net section that
+    the graphical item is part of."""
+
     @classmethod
     def from_sexpr(cls, exp: list) -> GrCircle:
         """Convert the given S-Expresstion into a GrCircle object
@@ -645,6 +676,8 @@ def from_sexpr(cls, exp: list) -> GrCircle:
                 object.width = item[1]
             elif item[0] == "stroke":
                 object.stroke = GrStroke().from_sexpr(item)
+            elif item[0] == "net":
+                object.net = item[1]
             else:
                 raise ValueError(
                     f"Unrecognized property key: {item[0]}. Full expression: {item}"
@@ -690,6 +723,9 @@ def _to_sexpr_raw(self):
         if self.layer is not None:
             expr.append(["layer", escape_and_quote(self.layer)])
 
+        if self.net is not None:
+            expr.append(["net", self.net])
+
         if self.tstamp is not None:
             expr.append(["uuid", quote(self.tstamp)])
 
@@ -727,6 +763,10 @@ class GrArc:
     locked: bool = False
     """The ``locked`` token defines if the object may be moved or not"""
 
+    net: Optional[int] = None
+    """The optional ``net`` token defines by net ordinal number which net in the net section that
+    the graphical item is part of."""
+
     @classmethod
     def from_sexpr(cls, exp: list) -> GrArc:
         """Convert the given S-Expresstion into a GrArc object
@@ -771,6 +811,8 @@ def from_sexpr(cls, exp: list) -> GrArc:
                 object.width = item[1]
             elif item[0] == "stroke":
                 object.stroke = GrStroke().from_sexpr(item)
+            elif item[0] == "net":
+                object.net = item[1]
             else:
                 raise ValueError(
                     f"Unrecognized property key: {item[0]}. Full expression: {item}"
@@ -814,6 +856,9 @@ def _to_sexpr_raw(self):
         if self.layer is not None:
             expr.append(["layer", escape_and_quote(self.layer)])
 
+        if self.net is not None:
+            expr.append(["net", self.net])
+
         if self.tstamp is not None:
             expr.append(["uuid", quote(self.tstamp)])
 
@@ -848,6 +893,10 @@ class GrPoly:
     locked: bool = False
     """The ``locked`` token defines if the object may be moved or not"""
 
+    net: Optional[int] = None
+    """The optional ``net`` token defines by net ordinal number which net in the net section that
+    the graphical item is part of."""
+
     @classmethod
     def from_sexpr(cls, exp: list) -> GrPoly:
         """Convert the given S-Expresstion into a GrPoly object
@@ -892,6 +941,8 @@ def from_sexpr(cls, exp: list) -> GrPoly:
                 object.width = item[1]
             elif item[0] == "stroke":
                 object.stroke = GrStroke().from_sexpr(item)
+            elif item[0] == "net":
+                object.net = item[1]
             else:
                 raise ValueError(
                     f"Unrecognized property key: {item[0]}. Full expression: {item}"
@@ -947,6 +998,9 @@ def _to_sexpr_raw(self):
         if self.layer is not None:
             expr.append(["layer", escape_and_quote(self.layer)])
 
+        if self.net is not None:
+            expr.append(["net", self.net])
+
         if self.tstamp is not None:
             expr.append(["uuid", quote(self.tstamp)])
 
@@ -978,6 +1032,10 @@ class GrCurve:
     locked: bool = False
     """The ``locked`` token defines if the object may be moved or not"""
 
+    net: Optional[int] = None
+    """The optional ``net`` token defines by net ordinal number which net in the net section that
+    the graphical item is part of."""
+
     @classmethod
     def from_sexpr(cls, exp: list) -> GrCurve:
         """Convert the given S-Expresstion into a GrCurve object
@@ -1019,6 +1077,8 @@ def from_sexpr(cls, exp: list) -> GrCurve:
                 object.width = item[1]
             elif item[0] == "stroke":
                 object.stroke = GrStroke().from_sexpr(item)
+            elif item[0] == "net":
+                object.net = item[1]
             else:
                 raise ValueError(
                     f"Unrecognized property key: {item[0]}. Full expression: {item}"
@@ -1066,6 +1126,9 @@ def _to_sexpr_raw(self):
         if self.layer is not None:
             expr.append(["layer", escape_and_quote(self.layer)])
 
+        if self.net is not None:
+            expr.append(["net", self.net])
+
         if self.tstamp is not None:
             expr.append(["uuid", quote(self.tstamp)])
 
@@ -1074,10 +1137,13 @@ def _to_sexpr_raw(self):
 
 @dataclass
 class GrStroke:
+    """The ``stroke`` token defines a line-style used to draw the shape's border."""
 
     width: float = 0.0
+    """The ``width`` token defines the line width of a stroke."""
 
     type: str = ""
+    """The ``type`` token defines the type of the stroke (solid, dashed, etc.)."""
 
     @classmethod
     def from_sexpr(cls, exp: list) -> GrStroke: