footprint: Various minor fixes after more testing

Some places have left placeholders for items/formats that will be implemented in
the future. Also one bigger part will be arcs in zone polygons instead
of "pure" positions (check RoyalBlue54L-Feather board)

Author: Wittmann-MEE

src/kiutils/footprint.py

@@ -22,7 +22,8 @@
 from os import path
 
 from kiutils.items.zones import Zone
-from kiutils.items.common import Image, Coordinate, Net, Group, Font
+from kiutils.items.common import Image, Coordinate, Net, Group, Font, EmbeddedFile
+from kiutils.items.dimensions import Dimension
 from kiutils.items.fpitems import *
 from kiutils.items.gritems import *
 from kiutils.utils.sexpr import sexp_prettify as prettify, sexp_to_string, parse_sexp
@@ -589,11 +590,9 @@ def from_sexpr(cls, exp: list) -> Pad:
                     elif primitive[0] == 'gr_arc': object.customPadPrimitives.append(GrArc().from_sexpr(primitive))
                     elif primitive[0] == 'gr_poly': object.customPadPrimitives.append(GrPoly().from_sexpr(primitive))
                     elif primitive[0] == 'gr_curve': object.customPadPrimitives.append(GrCurve().from_sexpr(primitive))
-                    # XXX: Are dimentions even implemented here?
-                    elif primitive[0] == 'dimension': raise NotImplementedError(
-                        "Dimensions are not yet handled! Please report this bug along with the file being parsed.")
             elif item[0] == 'thermal_bridge_width': object.thermal_bridge_width = item[1]
             elif item[0] == 'thermal_bridge_angle': object.thermal_bridge_angle = item[1]
+            # elif item[0] == 'teardrops': continue
             else:
                 raise ValueError(f"Unrecognized property key: {item[0]}. Full expression: {item}")
 
@@ -848,7 +847,7 @@ def libId(self, symbol_id: str):
     for all pads in the footprint. If not set, the zone thermal_gap setting is used. If not set, the
     zone thermal_gap setting is used."""
 
-    attributes: Attributes = field(default_factory=lambda: Attributes())
+    attributes: Optional[Attributes] = None
     """The optional ``attributes`` section defines the attributes of the footprint"""
 
     privateLayers: List[str] = field(default_factory=list)
@@ -901,6 +900,9 @@ def libId(self, symbol_id: str):
     sheet_file: str = ""
     """The ``sheet_file`` token defines filename of the schematic sheet file associated with this footprint instance."""
 
+    embedded_files: list[EmbeddedFile] = field(default_factory=list)
+    """The ``embedded_files`` store data of embedded files"""
+
     @classmethod
     def from_sexpr(cls, exp: list) -> Footprint:
         """Convert the given S-Expresstion into a Footprint object
@@ -967,10 +969,9 @@ def from_sexpr(cls, exp: list) -> Footprint:
             elif item[0] == 'group': object.groups.append(Group.from_sexpr(item))
             elif item[0] == 'private_layers': object.privateLayers.extend(item[1:])
             elif item[0] == 'net_tie_pad_groups': object.netTiePadGroups.extend(item[1:])
-            elif item[0] == 'dimension':
-                raise NotImplementedError(
-                    "Dimensions are not yet handled! Please report this bug along with the file being parsed.")
+            elif item[0] == 'dimension': object.graphicItems.append(Dimension.from_sexpr(item))
             elif item[0] == 'embedded_fonts': object.embedded_fonts = item[1]
+            elif item[0] == 'embedded_files': object.embedded_files.extend([EmbeddedFile().from_sexpr(f) for f in item[1:]])
             else:
                 raise ValueError(f"Unrecognized property key: {item[0]}. Full expression: {item}")
 
@@ -1185,6 +1186,11 @@ def _to_sexpr_raw(self):
         if self.embedded_fonts is not None:
             expr.append(['embedded_fonts', self.embedded_fonts])
 
+        # Embedded files
+        if len(self.embedded_files) > 0:
+            embedded_files_expr = ['embedded_files'] + [f._to_sexpr_raw() for f in self.embedded_files]
+            expr.append(embedded_files_expr)
+
         for item in self.models:
             expr.append(item._to_sexpr_raw())
 

src/kiutils/items/brditems.py

@@ -598,25 +598,43 @@ class PlotSettings():
     where the plot files will be saved"""
 
     # Available since KiCad v9
-    # TODO Update docs
 
-    pdf_front_fp_property_popups: Optional[str] = None
+    pdf_front_fp_property_popups: Optional[bool] = None
+    """The optional ``pdf_front_fp_property_popups`` token defines if interactive popups for
+    front-side footprint properties are included in PDF output"""
+
+    pdf_back_fp_property_popups: Optional[bool] = None
+    """The optional ``pdf_back_fp_property_popups`` token defines if interactive popups for
+    back-side footprint properties are included in PDF output"""
 
-    pdf_back_fp_property_popups: Optional[str] = None
+    pdf_metadata: Optional[bool] = None
+    """The optional ``pdf_metadata`` token defines if document metadata should be embedded
+    in the PDF output"""
 
-    pdf_metadata: Optional[str] = None
+    pdf_single_document: Optional[bool] = None
+    """The optional ``pdf_single_document`` token defines if all layers should be plotted
+    into a single PDF document"""
 
-    pdf_single_document: Optional[str] = None
+    plot_black_and_white: Optional[bool] = None
+    """The optional ``plot_black_and_white`` token defines if the plot should be generated
+    in black and white"""
 
-    plot_black_and_white: Optional[str] = None
+    hide_dnp_on_fab: Optional[bool] = None
+    """The optional ``hide_dnp_on_fab`` token defines if 'Do Not Populate' footprints should
+    be hidden on fabrication plots"""
 
-    hide_dnp_on_fab: Optional[str] = None
+    crossout_dnp_on_fab: Optional[bool] = None
+    """The optional ``crossout_dnp_on_fab`` token defines if 'Do Not Populate' footprints
+    should be crossed out on fabrication plots"""
 
-    crossout_dnp_on_fab: Optional[str] = None
+    sketch_dnp_on_fab: Optional[bool] = None
+    """The optional ``sketch_dnp_on_fab`` token defines if 'Do Not Populate' footprints should
+    be drawn in sketch mode on fabrication plots"""
 
-    sketch_dnp_on_fab: Optional[str] = None
+    plot_pad_numbers: Optional[bool] = None
+    """The optional ``plot_pad_numbers`` token defines if pad numbers should be plotted
+    on fabrication layers"""
 
-    plot_pad_numbers: Optional[str] = None
 
     @classmethod
     def from_sexpr(cls, exp: list) -> PlotSettings:
@@ -676,15 +694,15 @@ def from_sexpr(cls, exp: list) -> PlotSettings:
             elif item[0] == 'drillshape' : object.drillShape = item[1]
             elif item[0] == 'scaleselection' : object.scaleSelection = item[1]
             elif item[0] == 'outputdirectory' : object.outputDirectory = item[1]
-            elif item[0] == 'pdf_front_fp_property_popups': object.pdf_front_fp_property_popups = item[1]
-            elif item[0] == 'pdf_back_fp_property_popups': object.pdf_back_fp_property_popups = item[1]
-            elif item[0] == 'pdf_metadata': object.pdf_metadata = item[1]
-            elif item[0] == 'pdf_single_document': object.pdf_single_document = item[1]
-            elif item[0] == 'plot_black_and_white': object.plot_black_and_white = item[1]
-            elif item[0] == 'hidednponfab': object.hide_dnp_on_fab = item[1]
-            elif item[0] == 'sketchdnponfab': object.sketch_dnp_on_fab = item[1]
-            elif item[0] == 'crossoutdnponfab': object.crossout_dnp_on_fab = item[1]
-            elif item[0] == 'plotpadnumbers': object.plot_pad_numbers = item[1]
+            elif item[0] == 'pdf_front_fp_property_popups': object.pdf_front_fp_property_popups = parse_bool(item, 'pdf_front_fp_property_popups')
+            elif item[0] == 'pdf_back_fp_property_popups': object.pdf_back_fp_property_popups = parse_bool(item, 'pdf_back_fp_property_popups')
+            elif item[0] == 'pdf_metadata': object.pdf_metadata = parse_bool(item, 'pdf_metadata')
+            elif item[0] == 'pdf_single_document': object.pdf_single_document = parse_bool(item, 'pdf_single_document')
+            elif item[0] == 'plot_black_and_white':  object.plot_black_and_white = parse_bool(item, 'plot_black_and_white')
+            elif item[0] == 'hidednponfab': object.hide_dnp_on_fab = parse_bool(item, 'hidednponfab')
+            elif item[0] == 'sketchdnponfab': object.sketch_dnp_on_fab = parse_bool(item, 'sketchdnponfab')
+            elif item[0] == 'crossoutdnponfab': object.crossout_dnp_on_fab = parse_bool(item, 'crossoutdnponfab')
+            elif item[0] == 'plotpadnumbers': object.plot_pad_numbers = parse_bool(item, 'plotpadnumbers')
             else:
                 raise ValueError("Unrecognized property key: {item[0]}")
 
@@ -735,22 +753,22 @@ def _to_sexpr_raw(self):
             expr.append(['viasonmask', self.viasOnMask])
 
         expr.append(['mode', self.mode])
-        expr.append(['useauxorigin', 'no'])
+        expr.append(['useauxorigin', self.useAuxOrigin])
         expr.append(['hpglpennumber', self.hpglPenNumber])
         expr.append(['hpglpenspeed', self.hpglPenSpeed])
         expr.append(['hpglpendiameter', (f"{self.hpglPenDiameter:.6f}")])
 
         if self.pdf_front_fp_property_popups is not None:
-            expr.append(['pdf_front_fp_property_popups', self.pdf_front_fp_property_popups])
+            expr.append(format_bool('pdf_front_fp_property_popups', self.pdf_front_fp_property_popups, yesno=True))
 
         if self.pdf_back_fp_property_popups is not None:
-            expr.append(['pdf_back_fp_property_popups', self.pdf_back_fp_property_popups])
+            expr.append(format_bool('pdf_back_fp_property_popups', self.pdf_back_fp_property_popups, yesno=True))
 
         if self.pdf_metadata is not None:
-            expr.append(['pdf_metadata', self.pdf_metadata])
+            expr.append(format_bool('pdf_metadata', self.pdf_metadata, yesno=True))
 
         if self.pdf_single_document is not None:
-            expr.append(['pdf_single_document', self.pdf_single_document])
+            expr.append(format_bool('pdf_single_document', self.pdf_single_document, yesno=True))
 
         expr.append(['dxfpolygonmode', self.dxfPolygonMode])
         expr.append(['dxfimperialunits', self.dxfImperialUnits])
@@ -759,21 +777,21 @@ def _to_sexpr_raw(self):
         expr.append(['psa4output', self.psA4Output])
 
         if self.plot_black_and_white is not None:
-            expr.append(['plot_black_and_white', self.plot_black_and_white])
+            expr.append(format_bool('plot_black_and_white', self.plot_black_and_white, yesno=True))
 
         expr.append(['sketchpadsonfab', self.sketchPadsOnFab])
 
         if self.plot_pad_numbers is not None:
-            expr.append(['plotpadnumbers', self.plot_pad_numbers])
+            expr.append(format_bool('plotpadnumbers', self.plot_pad_numbers, yesno=True))
 
         if self.hide_dnp_on_fab is not None:
-            expr.append(['hidednponfab', self.hide_dnp_on_fab])
+            expr.append(format_bool('hidednponfab', self.hide_dnp_on_fab, yesno=True))
 
         if self.sketch_dnp_on_fab is not None:
-            expr.append(['sketchdnponfab', self.sketch_dnp_on_fab])
+            expr.append(format_bool('sketchdnponfab', self.sketch_dnp_on_fab, yesno=True))
 
         if self.crossout_dnp_on_fab is not None:
-            expr.append(['crossoutdnponfab', self.crossout_dnp_on_fab])
+            expr.append(format_bool('crossoutdnponfab', self.crossout_dnp_on_fab, yesno=True))
 
         if self.plotReference == 'yes':
             expr.append(['plotreference', self.plotReference])
@@ -1139,6 +1157,7 @@ def from_sexpr(cls, exp: list) -> Via:
             elif item[0] == 'net': object.net = item[1]
             elif item[0] == 'tstamp': object.tstamp = item[1]
             elif item[0] == 'uuid': object.tstamp = item[1] # Haha :)
+            # elif item[0] == 'teardrops': continue
             else:
                 raise ValueError(f"Unrecognized property key: {item[0]}. Full expression: {item}")
 

src/kiutils/items/fpitems.py

@@ -75,6 +75,9 @@ class FpText():
     unlocked: Optional[bool] = None
     """The optional ``unlocked`` token defines if the object can be edited"""
 
+    locked: Optional[bool] = None
+    """The optional ``locked`` token defines if the object cannot be edited"""
+
     @classmethod
     def from_sexpr(cls, exp: list) -> FpText:
         """Convert the given S-Expresstion into a FpText object
@@ -100,6 +103,7 @@ def from_sexpr(cls, exp: list) -> FpText:
         object.text = exp[2]
         for item in exp[3:]:
             if is_bool_key(item, 'unlocked'): object.unlocked = parse_bool(item, 'unlocked')
+            elif is_bool_key(item, 'locked'): object.locked = parse_bool(item, 'locked')
             elif 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}")
@@ -133,6 +137,9 @@ def to_sexpr(self, indent: int = 2, newline: bool = True) -> str:
     def _to_sexpr_raw(self):
         expr = ['fp_text', self.type, escape_and_quote(self.text)]
 
+        if 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:
             pos.append(format_float(self.position.angle))

src/kiutils/items/zones.py

@@ -649,6 +649,7 @@ def from_sexpr(cls, exp: list) -> Zone:
             elif item[0] == 'filled_polygon': object.filledPolygons.append(FilledPolygon().from_sexpr(item))
             elif item[0] == 'fill_segments': object.fillSegments = FillSegments().from_sexpr(item)
             elif item[0] == 'placement': object.placement = PlacementSettings().from_sexpr(item)
+            # elif item[0] == 'attr': continue
             else:
                 raise ValueError(f"Unrecognized property key: {item[0]}. Full expression: {item}")
 

tests/test_board.py

@@ -39,7 +39,6 @@ def test_boardSmartPrintCoreH7x(self):
         board = Board().from_file(self.testData.pathToTestFile)
         self.assertTrue(to_file_and_compare(board, self.testData))
 
-    # TODO - This test contains "dimensions" which are not supported yet
     def test_TokayLite(self):
         """Tests the behavior when creating and exporting TokayLite board"""
         self.testData.pathToTestFile = Path(BOARD_COMMUNITY) / 'TokayLite'