Fix Python warnings and errors, cleanup code

Author: Wittmann-MEE

src/kiutils/board.py

@@ -15,8 +15,7 @@
 
 from __future__ import annotations
 
-from dataclasses import dataclass, field
-from typing import Optional, List, Dict
+from typing import Dict
 from os import path
 
 from kiutils.items.common import Group, Image, Net, PageSettings, TitleBlock
@@ -27,7 +26,7 @@
 from kiutils.utils.strings import dequote
 from kiutils.utils import sexpr
 from kiutils.footprint import Footprint
-from kiutils.misc.config import KIUTILS_CREATE_NEW_VERSION_STR, KIUTILS_CREATE_NEW_GENERATOR_STR
+from kiutils.misc.config import *
 
 @dataclass
 class Board():
@@ -189,10 +188,10 @@ def create_new(cls) -> Board:
         Returns:
             - Board: Empty board
         """
-        board = cls(
-            version = KIUTILS_CREATE_NEW_VERSION_STR,
-            generator = KIUTILS_CREATE_NEW_GENERATOR_STR
-        )
+        board = Board()
+        board.version = KIUTILS_CREATE_NEW_VERSION_STR
+        board.generator = KIUTILS_CREATE_NEW_GENERATOR_STR
+        board.generator_version = KIUTILS_CREATE_NEW_GENERATOR_VERSION_STR
 
         # Add all standard layers to board
         board.layers.extend([
@@ -267,8 +266,7 @@ def to_sexpr(self, indent=0, newline=True) -> str:
 
         addNewLine = False
 
-        generator_version = f' (generator_version "{self.generator_version}")' if self.generator_version is not None else ''
-        expression =  f'{indents}(kicad_pcb (version {self.version}) (generator {self.generator}){generator_version}\n\n'
+        expression =  f'{indents}(kicad_pcb (version {self.version}) (generator {self.generator}) (generator_version "{self.generator_version}")\n\n'
         expression += self.general.to_sexpr(indent+2) + '\n'
         expression += self.paper.to_sexpr(indent+2)
         if self.titleBlock is not None:

src/kiutils/footprint.py

@@ -18,17 +18,16 @@
 import calendar
 import datetime
 import re
-from dataclasses import dataclass, field
-from typing import Optional, List, Dict
+from typing import Dict
 from os import path
 
 from kiutils.items.zones import Zone
-from kiutils.items.common import Image, Position, Coordinate, Net, Group, Font
+from kiutils.items.common import Image, Coordinate, Net, Group, Font
 from kiutils.items.fpitems import *
 from kiutils.items.gritems import *
 from kiutils.utils import sexpr
 from kiutils.utils.strings import dequote, remove_prefix
-from kiutils.misc.config import KIUTILS_CREATE_NEW_VERSION_STR
+from kiutils.misc.config import *
 
 @dataclass
 class Attributes():
@@ -112,7 +111,7 @@ def to_sexpr(self, indent=0, newline=False) -> str:
         Returns:
             - str: S-Expression of this object
         """
-        if (self.type == None
+        if (self.type is None
             and self.boardOnly == False
             and self.excludeFromBom == False
             and self.excludeFromPosFiles == False
@@ -980,32 +979,29 @@ def create_new(cls, library_id: str, value: str,
         if type not in ['smd', 'through_hole', 'other']:
             raise Exception("Unsupported type was given")
 
-        fp = cls(
-            version = KIUTILS_CREATE_NEW_VERSION_STR,
-            generator = 'kiutils'
-        )
+        fp = Footprint()
+        fp.version = KIUTILS_CREATE_NEW_VERSION_STR
+        fp.generator = KIUTILS_CREATE_NEW_GENERATOR_STR
+        fp.generator_version = KIUTILS_CREATE_NEW_GENERATOR_VERSION_STR
         fp.libId = library_id
 
         # Create text items that are created when adding a new footprint to a library
-        # TODO - In v9 these are not FpTexts anymore but rather Properties
-        fp.graphicItems.extend(
-            [
-                FpText(
-                    type = 'reference', text = reference, layer = 'F.SilkS',
-                    effects = Effects(font=Font(thickness=0.15)),
-                    position = Position(X=0, Y=-0.5, unlocked=True)
-                ),
-                FpText(
-                    type = 'value', text = value, layer ='F.Fab',
-                    effects  = Effects(font=Font(thickness=0.15)),
-                    position = Position(X=0, Y=1, unlocked=True)
-                ),
-                FpText(
-                    type = 'user', text = '${REFERENCE}', layer = 'F.Fab',
-                    effects = Effects(font=Font(thickness=0.15)),
-                    position = Position(X=0, Y=2.5, unlocked=True)
-                )
-            ]
+        fp.properties['Reference'] = FpProperty(
+            type='Reference', text=reference, layer='F.SilkS',
+            effects=Effects(font=Font(thickness=0.15)),
+            at=Position(X=0, Y=-0.5, unlocked=True)
+        ),
+        fp.properties['Value'] = FpProperty(
+            type='Value', text=value, layer='F.Fab',
+            effects=Effects(font=Font(thickness=0.15)),
+            at=Position(X=0, Y=1, unlocked=True)
+        ),
+        fp.graphicItems.append(
+            FpText(
+                type = 'user', text = '${REFERENCE}', layer = 'F.Fab',
+                effects = Effects(font=Font(thickness=0.15)),
+                position = Position(X=0, Y=2.5, unlocked=True)
+            )
         )
 
         # The type ``other`` does not set the attributes type token
@@ -1053,7 +1049,7 @@ def to_sexpr(self, indent=0, newline=True, layerInFirstLine=False) -> str:
         placed = f' (placed yes)' if self.placed else ''
         version = f' (version {self.version})' if self.version is not None else ''
         generator = f' (generator {self.generator})' if self.generator is not None else ''
-        generator_version = f' (generator_version "{self.generator_version}")' if self.generator_version is not None else ''
+        generator_version = f' (generator_version "{self.generator_version}")'
         tstamp = f' (uuid "{self.tstamp}")' if self.tstamp is not None else ''
 
         expression =  f'{indents}(footprint "{dequote(self.libId)}"{locked}{placed}{version}{generator}{generator_version}{tstamp}'

src/kiutils/items/common.py

@@ -328,6 +328,7 @@ def from_sexpr(cls, exp: list) -> Font:
         for item in exp[1:]:
             if not isinstance(item, list):
                 raise Exception(f"Property '{item}' which is not in key -> value mapping. Expression: {exp}")
+
             if item[0] == 'face': object.face = item[1]
             if item[0] == 'size':
                 object.height = item[1]
@@ -353,12 +354,12 @@ def to_sexpr(self, indent=0, newline=False) -> str:
         endline = '\n' if newline else ''
         face_name, thickness, bold, italic, linespacing, color = '', '', '', '', '', ''
 
-        if self.face is not None:        face_name = f'(face "{dequote(self.face)}") '
-        if self.thickness is not None:   thickness = f' (thickness {self.thickness})'
-        if self.bold == True:            bold = ' (bold yes)'
-        if self.italic == True:          italic = ' (italic yes)'
-        if self.lineSpacing is not None: linespacing = f' (line_spacing {self.lineSpacing})'
-        if self.color is not None:       color = f' {self.color.to_sexpr()}'
+        if self.face is not None:           face_name = f'(face "{dequote(self.face)}") '
+        if self.thickness is not None:      thickness = f' (thickness {self.thickness})'
+        if self.bold:                       bold = ' (bold yes)'
+        if self.italic:                     italic = ' (italic yes)'
+        if self.lineSpacing is not None:    linespacing = f' (line_spacing {self.lineSpacing})'
+        if self.color is not None:          color = f' {self.color.to_sexpr()}'
 
         expression = f'{indents}(font {face_name}(size {self.height} {self.width}){color}{thickness}{bold}{italic}{linespacing}){endline}'
         return expression
@@ -424,7 +425,7 @@ def to_sexpr(self, indent=0, newline=False) -> str:
         endline = '\n' if newline else ''
 
         if self.horizontally is None and self.vertically is None and self.mirror == False:
-            return f'{indents}{endline}';
+            return f'{indents}{endline}'
 
         horizontally, vertically, mirror = '', '', ''
 
@@ -970,7 +971,7 @@ class RenderCache():
     id: int = 0
     """The ``id`` token is some number after the text. Defaults to 0."""
 
-    polygons: List[Position] = field(default_factory=list)
+    polygons: List[RenderCachePolygon] = field(default_factory=list)
     """The ``polygons`` token is a list of polygons that define the outline of the cached text"""
 
     @classmethod
@@ -1015,7 +1016,7 @@ def to_sexpr(self, indent: int = 4, newline: bool = True) -> str:
 
         expression = f'{indents}(render_cache "{dequote(self.text)}" {self.id}\n'
         for poly in self.polygons:
-            expression += poly.to_sexpr(indent+2)
+            expression += poly.to_sexpr()
         expression += f'{indents}){endline}'
         return expression
 
@@ -1177,7 +1178,7 @@ class ProjectInstance(ABC):
     """The ``name`` token defines the name of the project instance"""
 
     @abstractmethod
-    def from_sexpr(cls, exp: list) -> ProjectInstance:
+    def from_sexpr(self, cls, exp: list) -> ProjectInstance:
         raise NotImplementedError
 
     @abstractmethod

src/kiutils/items/gritems.py

@@ -187,50 +187,50 @@ def from_sexpr(cls, exp: list) -> GrTextBox:
                         'Most definitely there were changes introduced between Kicad 7 and 9.'
                         'If you know what you are doing, proceed to verify/fix and remove the exception.')
 
-        """Convert the given S-Expression into a GrTextBox object
-
-        Args:
-            - exp (list): Part of parsed S-Expression ``(gr_text_box ...)``
-
-        Raises:
-            - Exception: When given parameter's type is not a list
-            - Exception: When the first item of the list is not fp_text_box
-
-        Returns:
-            - GrTextBox: Object of the class initialized with the given S-Expression
-        """
-        if not isinstance(exp, list) or len(exp) < 2:
-            raise Exception("Expression does not have the correct type")
-
-        if exp[0] != 'gr_text_box':
-            raise Exception("Expression does not have the correct type")
-
-        object = cls()
-
-        # Extract "locked" token, if any is present
-        if exp[1] == "locked" and not isinstance(exp[2], list):
-            object.locked = True
-            object.text = exp[2]
-            start_at = 3
-        else:
-            object.text = exp[1]
-            start_at = 2
-
-        for item in exp[start_at:]:
-            if item[0] == 'start': object.start = Position.from_sexpr(item)
-            if item[0] == 'end': object.end = Position.from_sexpr(item)
-            if item[0] == 'pts':
-                for point in item[1:]:
-                    object.pts.append(Position().from_sexpr(point))
-            if item[0] == 'angle': object.angle = item[1]
-            if item[0] == 'layer': object.layer = item[1]
-            if item[0] == 'tstamp': object.tstamp = item[1]
-            if item[0] == 'tstamp': object.uuid = item[1] # Haha :)
-            if item[0] == 'effects': object.effects = Effects.from_sexpr(item)
-            if item[0] == 'stroke': object.stroke = Stroke.from_sexpr(item)
-            if item[0] == 'render_cache': object.renderCache = RenderCache.from_sexpr(item)
-
-        return object
+        # """Convert the given S-Expression into a GrTextBox object
+        #
+        # Args:
+        #     - exp (list): Part of parsed S-Expression ``(gr_text_box ...)``
+        #
+        # Raises:
+        #     - Exception: When given parameter's type is not a list
+        #     - Exception: When the first item of the list is not fp_text_box
+        #
+        # Returns:
+        #     - GrTextBox: Object of the class initialized with the given S-Expression
+        # """
+        # if not isinstance(exp, list) or len(exp) < 2:
+        #     raise Exception("Expression does not have the correct type")
+        #
+        # if exp[0] != 'gr_text_box':
+        #     raise Exception("Expression does not have the correct type")
+        #
+        # object = cls()
+        #
+        # # Extract "locked" token, if any is present
+        # if exp[1] == "locked" and not isinstance(exp[2], list):
+        #     object.locked = True
+        #     object.text = exp[2]
+        #     start_at = 3
+        # else:
+        #     object.text = exp[1]
+        #     start_at = 2
+        #
+        # for item in exp[start_at:]:
+        #     if item[0] == 'start': object.start = Position.from_sexpr(item)
+        #     if item[0] == 'end': object.end = Position.from_sexpr(item)
+        #     if item[0] == 'pts':
+        #         for point in item[1:]:
+        #             object.pts.append(Position().from_sexpr(point))
+        #     if item[0] == 'angle': object.angle = item[1]
+        #     if item[0] == 'layer': object.layer = item[1]
+        #     if item[0] == 'tstamp': object.tstamp = item[1]
+        #     if item[0] == 'tstamp': object.uuid = item[1] # Haha :)
+        #     if item[0] == 'effects': object.effects = Effects.from_sexpr(item)
+        #     if item[0] == 'stroke': object.stroke = Stroke.from_sexpr(item)
+        #     if item[0] == 'render_cache': object.renderCache = RenderCache.from_sexpr(item)
+        #
+        # return object
 
     def to_sexpr(self, indent: int = 2, newline: bool = True) -> str:
         """Generate the S-Expression representing this object

src/kiutils/items/schitems.py

@@ -1062,7 +1062,7 @@ def libId(self, symbol_id: str):
     # Available since KiCad v9
 
     # TODO Missing docs
-    excludeFromSim: Optinal[str] = None
+    excludeFromSim: Optional[str] = None
 
     @classmethod
     def from_sexpr(cls, exp: list) -> SchematicSymbol:

src/kiutils/items/syitems.py

@@ -20,7 +20,7 @@
 from dataclasses import dataclass, field
 from typing import List, Optional
 
-from kiutils.items.common import Fill, Position, Stroke, Effects, Fill
+from kiutils.items.common import Position, Stroke, Effects, Fill
 from kiutils.utils.strings import dequote
 
 @dataclass
@@ -79,9 +79,14 @@ def from_sexpr(cls, exp: list) -> SyArc:
                 # Pretty sure this isn't the case but let's be safe
                 if item == 'private':
                     object.private = True
+                    continue
                 else:
                     raise Exception(f"Property '{item}' which is not in key -> value mapping. Expression: {exp}")
-            if item[0] == 'private' and item[1] == 'yes': object.private = True
+
+            if item[0] == 'private' and item[1] == 'yes':
+                object.private = True
+                continue
+
             if item[0] == 'start': object.start = Position().from_sexpr(item)
             if item[0] == 'mid': object.mid = Position().from_sexpr(item)
             if item[0] == 'end': object.end = Position().from_sexpr(item)
@@ -166,9 +171,14 @@ def from_sexpr(cls, exp: list) -> SyCircle:
                 # Pretty sure this isn't the case but let's be safe
                 if item == 'private':
                     object.private = True
+                    continue
                 else:
                     raise Exception(f"Property '{item}' which is not in key -> value mapping. Expression: {exp}")
-            if item[0] == 'private' and item[1] == 'yes': object.private = True
+
+            if item[0] == 'private' and item[1] == 'yes':
+                object.private = True
+                continue
+
             if item[0] == 'center': object.center = Position().from_sexpr(item)
             if item[0] == 'radius': object.radius = item[1]
             if item[0] == 'stroke': object.stroke = Stroke().from_sexpr(item)
@@ -254,14 +264,15 @@ def to_sexpr(self, indent: int = 6, newline: bool = True) -> str:
         indents = ' '*indent
         endline = '\n' if newline else ''
 
-        expression =  f'{indents}(curve\n'
-        expression =  f'{indents}  (pts\n'
+        expression  =  f'{indents}(curve\n'
+        expression +=  f'{indents}  (pts\n'
         for point in self.points:
-            expression =  f'{indents}    (xy {point.X} {point.Y})\n'
-        expression =  f'{indents}  )\n'
+            expression +=  f'{indents}    (xy {point.X} {point.Y})\n'
+        expression +=  f'{indents}  )\n'
         expression += self.stroke.to_sexpr(indent+2)
         expression += self.fill.to_sexpr(indent+2)
         expression += f'{indents}){endline}'
+
         return expression
 
 @dataclass
@@ -386,9 +397,14 @@ def from_sexpr(cls, exp: list) -> SyRect:
                 # Pretty sure this isn't the case but let's be safe
                 if item == 'private':
                     object.private = True
+                    continue
                 else:
                     raise Exception(f"Property '{item}' which is not in key -> value mapping. Expression: {exp}")
-            if item[0] == 'private' and item[1] == 'yes': object.private = True
+
+            if item[0] == 'private' and item[1] == 'yes':
+                object.private = True
+                continue
+
             if item[0] == 'start': object.start = Position().from_sexpr(item)
             if item[0] == 'end': object.end = Position().from_sexpr(item)
             if item[0] == 'stroke': object.stroke = Stroke().from_sexpr(item)

src/kiutils/items/zones.py

@@ -365,7 +365,7 @@ def from_sexpr(cls, exp: list) -> FilledPolygon:
                 raise Exception("We didn't deal with this so far."
                                 "A small modification such as checking that item[1] is yes or no might be needed."
                                 "Verify/fix if needed and remove this exception.")
-                object.island = True
+                # object.island = True
             if item[0] == 'pts':
                 for position in item[1:]:
                     object.coordinates.append(Position().from_sexpr(position))