Refactor all boolean parameters parsing in from_sexpr calls

Author: Wittmann-MEE

src/kiutils/board.py

@@ -27,7 +27,7 @@
 from kiutils.utils.sexpr import sexp_prettify as prettify, sexp_to_string, parse_sexp
 from kiutils.footprint import Footprint
 from kiutils.misc.config import *
-from kiutils.utils.parsing_utils import parse_bool, format_bool
+from kiutils.utils.parsing_utils import *
 
 @dataclass
 class Board():
@@ -333,7 +333,7 @@ def _to_sexpr_raw(self):
 
         # Embedded fonts
         if self.embedded_fonts is not None:
-            expr.append(format_bool_raw('embedded_fonts', self.embedded_fonts, compact=False, yesno=True))
+            expr.append(format_bool('embedded_fonts', self.embedded_fonts, compact=False, yesno=True))
 
         # Embedded files
         if len(self.embedded_files) > 0:

src/kiutils/footprint.py

@@ -29,7 +29,7 @@
 from kiutils.utils.string_utils import *
 from kiutils.misc.config import *
 from kiutils.utils.format_utils import format_float
-from kiutils.utils.parsing_utils import parse_bool, format_bool, format_bool_raw
+from kiutils.utils.parsing_utils import *
 
 @dataclass
 class Attributes():
@@ -62,9 +62,9 @@ class Attributes():
     Available since KiCad 7"""
 
     # Available since KiCad v9
-    # TODO Update docs
 
     dnp: Optional[bool] = None
+    """The optional ``dnp`` token indicates that the footprint will not be populated"""
 
     @classmethod
     def from_sexpr(cls, exp: list) -> Attributes:
@@ -87,18 +87,15 @@ def from_sexpr(cls, exp: list) -> Attributes:
             raise Exception("Expression does not have the correct type")
 
         object = cls()
-        if len(exp) > 1:
-            # Attributes token may be set with no other items (empty attributes)
-            # Test case for this: test_fp_empty_attr.kicad_mod
-            if exp[1] == 'through_hole' or exp[1] == 'smd':
-                object.type = exp[1]
-
         for item in exp[1:]:
-            if parse_bool(item, 'board_only'): object.boardOnly = True
-            elif parse_bool(item, 'exclude_from_pos_files'): object.excludeFromPosFiles = True
-            elif parse_bool(item, 'exclude_from_bom'): object.excludeFromBom = True
-            elif parse_bool(item, 'allow_missing_courtyard'): object.allowMissingCourtyard = True
-            elif parse_bool(item, 'dnp'): object.dnp = True
+            if is_bool_key(item, 'board_only'): object.boardOnly = parse_bool(item, 'board_only')
+            elif is_bool_key(item, 'exclude_from_pos_files'): object.excludeFromPosFiles = parse_bool(item, 'exclude_from_pos_files')
+            elif is_bool_key(item, 'exclude_from_bom'): object.excludeFromBom = parse_bool(item, 'exclude_from_bom')
+            elif is_bool_key(item, 'allow_missing_courtyard'): object.allowMissingCourtyard = parse_bool(item, 'allow_missing_courtyard')
+            elif is_bool_key(item, 'dnp'): object.dnp = parse_bool(item, 'dnp')
+            elif item in ['through_hole', 'smd']: object.type = item
+            else:
+                raise ValueError(f"Unrecognized property key: {item[0]}. Full expression: {item}")
 
         return object
 
@@ -199,7 +196,7 @@ def from_sexpr(cls, exp: list) -> Model:
         object.path = exp[1]
 
         for item in exp[2:]:
-            if parse_bool(item, 'hide'): object.hide = True
+            if is_bool_key(item, 'hide'): object.hide = parse_bool(item, 'hide')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'opacity': object.opacity = item[1]
@@ -227,7 +224,7 @@ def to_sexpr(self, indent=2, newline=True) -> str:
     def _to_sexpr_raw(self):
         expr = ['model', escape_and_quote(self.path)]
 
-        expr.append(format_bool_raw('hide', self.hide))
+        expr.append(format_bool('hide', self.hide))
 
         if self.opacity is not None:
             expr.append(['opacity', self.opacity])
@@ -554,8 +551,8 @@ def from_sexpr(cls, exp: list) -> Pad:
         object.shape = exp[3]
 
         for item in exp[4:]:
-            if parse_bool(item, 'locked'): object.locked = True
-            elif parse_bool(item, 'zone_layer_connections'): object.zone_layer_connections = True
+            if is_bool_key(item, 'locked'): object.locked = parse_bool(item, 'locked')
+            elif is_bool_key(item, 'zone_layer_connections'): object.zone_layer_connections = parse_bool(item, 'zone_layer_connections')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'at': object.position = Position().from_sexpr(item)
@@ -623,7 +620,7 @@ def _to_sexpr_raw(self):
             self.shape
         ]
 
-        expr.append(format_bool_raw('locked', self.locked))
+        expr.append(format_bool('locked', self.locked))
 
         pos = ['at', format_float(self.position.X), format_float(self.position.Y)]
         if self.position.angle is not None:
@@ -650,7 +647,7 @@ def _to_sexpr_raw(self):
         if self.roundrectRatio is not None:
             expr.append(['roundrect_rratio', self.roundrectRatio])
 
-        expr.append(format_bool_raw('zone_layer_connections', self.zone_layer_connections))
+        expr.append(format_bool('zone_layer_connections', self.zone_layer_connections))
 
         if self.chamferRatio is not None:
             expr.append(['chamfer_ratio', self.chamferRatio])
@@ -927,8 +924,8 @@ def from_sexpr(cls, exp: list) -> Footprint:
         object = cls()
         object.libId = exp[1]
         for item in exp[2:]:
-            if parse_bool(item, 'locked'): object.locked = True
-            elif parse_bool(item, 'placed'): object.placed = True
+            if is_bool_key(item, 'locked'): object.locked = parse_bool(item, 'locked')
+            elif is_bool_key(item, 'placed'): object.placed = parse_bool(item, 'placed')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'version': object.version = item[1]
@@ -1092,8 +1089,8 @@ def to_sexpr(self, indent=0, newline=True, layerInFirstLine=False) -> str:
     def _to_sexpr_raw(self):
         expr = ['footprint', escape_and_quote(self.libId)]
 
-        expr.append(format_bool_raw('locked', self.locked))
-        expr.append(format_bool_raw('placed', self.placed))
+        expr.append(format_bool('locked', self.locked))
+        expr.append(format_bool('placed', self.placed))
 
         if self.version is not None:
             expr.append(['version', self.version])

src/kiutils/items/brditems.py

@@ -21,7 +21,7 @@
 from kiutils.items.common import Position
 from kiutils.utils.string_utils import *
 from kiutils.utils.format_utils import format_float
-from kiutils.utils.parsing_utils import parse_bool, format_bool_raw
+from kiutils.utils.parsing_utils import *
 from kiutils.utils.sexpr import sexp_to_string
 
 @dataclass
@@ -409,8 +409,8 @@ def from_sexpr(cls, exp: list) -> Stackup:
 
         object = cls()
         for item in exp[1:]:
-            if parse_bool(item, 'castellated_pads'): object.castellatedPads = True
-            elif parse_bool(item, 'edge_plating'): object.edgePlating = True
+            if is_bool_key(item, 'castellated_pads'): object.castellatedPads = parse_bool(item, 'castellated_pads')
+            elif is_bool_key(item, 'edge_plating'): object.edgePlating = parse_bool(item, 'edge_plating')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'layer': object.layers.append(StackupLayer().from_sexpr(item))
@@ -1005,7 +1005,7 @@ def from_sexpr(cls, exp: list) -> Segment:
 
         object = cls()
         for item in exp[1:]:
-            if parse_bool(item, 'locked'): object.locked = True
+            if is_bool_key(item, 'locked'): object.locked = parse_bool(item, 'locked')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'start': object.start = Position().from_sexpr(item)
@@ -1042,7 +1042,7 @@ def _to_sexpr_raw(self):
         ]
 
         if self.locked:
-            expr.append(format_bool_raw("locked", self.locked))
+            expr.append(format_bool("locked", self.locked))
 
         expr.extend([
             ['layer', escape_and_quote(self.layer)],
@@ -1098,9 +1098,9 @@ class Via():
     """The ``tstamp`` token defines the unique identifier of the via"""
 
     # Available since KiCad v9
-    # TODO Update docs
 
     zone_layer_connections: bool = False
+    """The ``zone_layer_connections`` token indicates which cooper layers are connected"""
 
     @classmethod
     def from_sexpr(cls, exp: list) -> Via:
@@ -1124,12 +1124,12 @@ def from_sexpr(cls, exp: list) -> Via:
 
         object = cls()
         for item in exp[1:]:
-            if parse_bool(item, 'locked'): object.locked = True
-            elif parse_bool(item, 'remove_unused_layers'): object.removeUnusedLayers = True
-            elif parse_bool(item, 'keepEndLayers'): object.keepEndLayers = True
-            elif parse_bool(item, 'free'): object.free = True
-            elif parse_bool(item, 'zone_layer_connections'): object.zone_layer_connections = True
-            elif not isinstance(item, list) and item in ['micro','blind']: object.type = item
+            if is_bool_key(item, 'locked'): object.locked = parse_bool(item, 'locked')
+            elif is_bool_key(item, 'remove_unused_layers'): object.removeUnusedLayers = parse_bool(item, 'remove_unused_layers')
+            elif is_bool_key(item, 'keepEndLayers'): object.keepEndLayers = parse_bool(item, 'keepEndLayers')
+            elif is_bool_key(item, 'free'): object.free = parse_bool(item, 'free')
+            elif is_bool_key(item, 'zone_layer_connections'): object.zone_layer_connections = parse_bool(item, 'zone_layer_connections')
+            elif not isinstance(item, list) and item in ['micro', 'blind']: object.type = item
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'at': object.position = Position().from_sexpr(item)
@@ -1177,16 +1177,16 @@ def _to_sexpr_raw(self):
         expr.append(layer_list)
 
         if self.removeUnusedLayers:
-            expr.append(format_bool_raw("remove_unused_layers", self.removeUnusedLayers))
+            expr.append(format_bool("remove_unused_layers", self.removeUnusedLayers))
 
         if self.keepEndLayers:
-            expr.append(format_bool_raw("keep_end_layers", self.keepEndLayers))
+            expr.append(format_bool("keep_end_layers", self.keepEndLayers))
 
         if self.locked:
-            expr.append(format_bool_raw("locked", self.locked))
+            expr.append(format_bool("locked", self.locked))
 
         if self.free:
-            expr.append(format_bool_raw("free", self.free))
+            expr.append(format_bool("free", self.free))
 
         if self.zone_layer_connections:
             expr.append(['zone_layer_connections'])
@@ -1255,7 +1255,7 @@ def from_sexpr(cls, exp: list) -> Arc:
 
         object = cls()
         for item in exp[1:]:
-            if parse_bool(item, 'locked'): object.locked = True
+            if is_bool_key(item, 'locked'): object.locked = parse_bool(item, 'locked')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'start': object.start = Position().from_sexpr(item)
@@ -1288,7 +1288,7 @@ def _to_sexpr_raw(self):
         expr = ['arc']
 
         if self.locked:
-            expr.append(format_bool_raw("locked", self.locked))
+            expr.append(format_bool("locked", self.locked))
 
         expr.extend([
             ['start', format_float(self.start.X), format_float(self.start.Y)],
@@ -1512,7 +1512,7 @@ def from_sexpr(cls, exp: list) -> Generated:
 
         object = cls()
         for item in exp[1:]:
-            if parse_bool(item, 'locked'): object.locked = True
+            if is_bool_key(item, 'locked'): object.locked = parse_bool(item, 'locked')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'uuid': object.uuid = item[1]
@@ -1583,7 +1583,7 @@ def _to_sexpr_raw(self):
         ]
 
         if self.locked:
-            expr.append(format_bool_raw("locked", self.locked))
+            expr.append(format_bool("locked", self.locked))
 
         if len(self.base_line) > 0:
             base_line_pts = ['pts']

src/kiutils/items/common.py

@@ -25,7 +25,7 @@
 
 from kiutils.utils.string_utils import *
 from kiutils.utils.format_utils import format_float
-from kiutils.utils.parsing_utils import parse_bool, format_bool_raw
+from kiutils.utils.parsing_utils import *
 from kiutils.utils.sexpr import sexp_to_string
 
 def is_url(path: str) -> bool:
@@ -75,14 +75,13 @@ def from_sexpr(cls, exp: list) -> Position:
         object = cls()
         object.X = float(exp[1])
         object.Y = float(exp[2])
-        if len(exp) >= 4:
-            # More than four components means X, Y, and either angle or unlocked are present
-            if exp[3] != 'unlocked':
+        if len(exp) > 3:
+            # More than three components means X, Y, and either angle or unlocked are present
+            if is_bool_key(exp[3], 'unlocked'):
+                object.unlocked = parse_bool(exp[3], 'unlocked')
+            else:
                 object.angle = exp[3]
 
-        for item in exp:
-            if parse_bool(item, 'unlocked'): object.unlocked = True
-
         return object
 
     def to_sexpr(self) -> str:
@@ -352,8 +351,8 @@ def from_sexpr(cls, exp: list) -> Font:
 
         object = cls()
         for item in exp[1:]:
-            if parse_bool(item, 'bold'): object.bold = True
-            elif parse_bool(item, 'italic'): object.italic = True
+            if is_bool_key(item, 'bold'): object.bold = parse_bool(item, 'bold')
+            elif is_bool_key(item, 'italic'): object.italic = parse_bool(item, 'italic')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'face': object.face = item[1]
@@ -392,13 +391,13 @@ def _to_sexpr_raw(self):
             expr.append(['thickness', self.thickness])
 
         if self.bold:
-            expr.append(format_bool_raw('bold', self.bold))
+            expr.append(format_bool('bold', self.bold))
 
         if self.color is not None:
             expr.append(self.color._to_sexpr_raw())
 
         if self.italic:
-            expr.append(format_bool_raw('italic', self.italic))
+            expr.append(format_bool('italic', self.italic))
 
         if self.lineSpacing is not None:
             expr.append(['line_spacing', self.lineSpacing])
@@ -529,7 +528,7 @@ def from_sexpr(cls, exp: list) -> Effects:
 
         object = cls()
         for item in exp[1:]:
-            if parse_bool(item, 'hide'): object.hide = True
+            if is_bool_key(item, 'hide'): object.hide = parse_bool(item, 'hide')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'font': object.font = Font().from_sexpr(item)
@@ -566,7 +565,7 @@ def _to_sexpr_raw(self):
         if self.href is not None:
             expr.append(['href', dequote(self.href)])
 
-        expr.append(format_bool_raw("hide", self.hide))
+        expr.append(format_bool("hide", self.hide))
 
         return expr
 
@@ -667,7 +666,7 @@ def from_sexpr(cls, exp: list) -> Group:
         object = cls()
         object.name = exp[1]
         for item in exp[2:]:
-            if parse_bool(item, 'locked'): object.locked = True
+            if is_bool_key(item, 'locked'): object.locked = parse_bool(item, 'locked')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'id': object.id = item[1]
@@ -696,7 +695,7 @@ def _to_sexpr_raw(self):
             'group',
             escape_and_quote(self.name),
             ['uuid', escape_and_quote(self.id)],
-            format_bool_raw("locked", self.locked),
+            format_bool("locked", self.locked),
             ['members'] + [quote(member) for member in self.members],
         ]
         return expr
@@ -951,8 +950,8 @@ def from_sexpr(cls, exp: list) -> Property:
             object.value = exp[2]
 
         for item in exp[3:]:
-            if item[0] == 'show_name': object.showName = parse_bool(item, 'show_name')
-            elif item[0] == 'do_not_autoplace': object.do_not_autoplace = parse_bool(item, 'do_not_autoplace')
+            if is_bool_key(item, 'show_name'): object.showName = parse_bool(item, 'show_name')
+            elif is_bool_key(item, 'do_not_autoplace'): object.do_not_autoplace = parse_bool(item, 'do_not_autoplace')
             elif not isinstance(item, list):
                 raise ValueError(f"Expected list property [key, value], got: {item}. Full expression: {exp}")
             elif item[0] == 'id': object.id = item[1]
@@ -994,10 +993,10 @@ def _to_sexpr_raw(self):
             expr.append(['id', self.id])
 
         if self.showName:
-            expr.append(format_bool_raw('show_name', self.showName))
+            expr.append(format_bool('show_name', self.showName))
 
         if self.do_not_autoplace:
-            expr.append(format_bool_raw('do_not_autoplace', self.do_not_autoplace, compact=True))
+            expr.append(format_bool('do_not_autoplace', self.do_not_autoplace, compact=True))
 
         if self.effects is not None:
             expr.append(self.effects._to_sexpr_raw())