[KiCad Variants][Added] Default action

- Applies in_bom, dnp and fields

Author: set-soft

kibot/fil_base.py

@@ -207,6 +207,8 @@ def reset_filters(comps, kicad_dnp_applied='global'):
         c.set_fitted(fitted)
         c.set_fixed(False)
         c.back_up_fields()
+        c.in_bom = c.in_bom_sch
+        c.kicad_dnp = c.kicad_dnp_sch
 
 
 def apply_fitted_filter(comps, filter):

kibot/kicad/v5_sch.py

@@ -906,13 +906,15 @@ def __init__(self):
         self.tht = False
         # KiCad 6 SCH flags
         self.in_bom = True          # not Exclude from bill of materials
+        self.in_bom_sch = True      # back-up copy
         self.on_board = True        # not Exclude from BoM
         # KiCad 6 PCB flags
         self.in_bom_pcb = True      # not Exclude from bill of materials
         self.in_pos = True          # not Exclude from position files
         self.in_pcb_only = False    # Not in schematic
         # KiCad 7 PCB flags
         self.kicad_dnp = None       # Do Not Populate
+        self.kicad_dnp_sch = None   # back-up copy
         # KiCad 10
         self.in_pos_files = None
         self.duplicate_pin_numbers_are_jumpers = None

kibot/kicad/v6_sch.py

@@ -1397,15 +1397,15 @@ def load(c, project, parent):
             elif i_type == 'exclude_from_sim':
                 comp.exclude_from_sim = _get_yes_no(i, 1, i_type)
             elif i_type == 'in_bom':
-                comp.in_bom = _get_yes_no(i, 1, i_type)
+                comp.in_bom_sch = comp.in_bom = _get_yes_no(i, 1, i_type)
             elif i_type == 'on_board':
                 comp.on_board = _get_yes_no(i, 1, i_type)
             elif i_type == 'in_pos_files':
                 comp.in_pos_files = _get_yes_no(i, 1, i_type)
             elif i_type == 'duplicate_pin_numbers_are_jumpers':
                 comp.duplicate_pin_numbers_are_jumpers = _get_yes_no(i, 1, i_type)
             elif i_type == 'dnp':
-                comp.kicad_dnp = _get_yes_no(i, 1, i_type)
+                comp.kicad_dnp_sch = comp.kicad_dnp = _get_yes_no(i, 1, i_type)
             elif i_type == 'fields_autoplaced':
                 # Not documented
                 comp.fields_autoplaced = True

kibot/optionable.py

@@ -729,6 +729,33 @@ def solve_field_name(field, empty_when_none=False):
             return GS.global_field_distributor[0] if GS.global_field_distributor else field_or_empty
         return field
 
+    def get_kicad_variant(self, c):
+        """ Look for the currently selected variant in the component """
+        vname = 'Default'
+        v = None
+        if self.variant:
+            v = c.variants.get(self.variant.name)
+            if v:
+                logger.debugl(4, f"- Found variant {self.variant.name} for {c.ref}")
+                vname = self.variant.name
+        return v, vname
+
+    def kicad_var_cb(self, c):
+        """ Generic KiCad variants implementation """
+        v, vname = self.get_kicad_variant(c)
+        if v is None:
+            return v, vname
+        # Flags
+        if v.in_bom is not None:
+            c.in_bom = v.in_bom
+        if v.dnp is not None:
+            c.kicad_dnp = v.dnp
+        # Fields
+        for name, value in v.fields.items():
+            c.set_field(name, value)
+            logger.debugl(3, f'- {c.ref} field `{name}` set to `{value}` by `{vname}`')
+        return v, vname
+
 
 class BaseOptions(Optionable):
     """ A class to validate and hold output options.

kibot/out_base.py

@@ -1161,7 +1161,7 @@ def load_list_components(self, forced=False):
         # Apply the variant
         if self.variant:
             # Apply the variant
-            comps = self.variant.filter(comps)
+            comps = self.variant.filter(comps, self.kicad_var_cb)
             self._sub_pcb = self.variant._sub_pcb
         self._comps = comps
 

kibot/out_bom.py

@@ -1009,18 +1009,11 @@ def kicad_var_cb(self, c):
         """ KiCad variants implementation specific for BoM.
             `no in BoM` -> not included
             `DNP` -> not fitted """
-        vname = 'Default'
-        v = None
-        if self.variant:
-            v = c.variants.get(self.variant.name)
-            if v:
-                logger.debugl(4, f"- Found variant {self.variant.name} for {c.ref}")
-                vname = self.variant.name
+        v, vname = super().kicad_var_cb(c)
         # Included
         if self.exclude_marked_in_sch:
-            in_bom = v.in_bom if v is not None and v.in_bom is not None else c.in_bom
-            if c.included and not in_bom:
-                c.included = in_bom
+            if c.included and not c.in_bom:
+                c.included = c.in_bom
                 logger.debugl(3, f'- {c.ref} excluded by `{vname}` from schematic')
         if self.exclude_marked_in_pcb:
             # The variant was applied by "get_board_comps_data"
@@ -1029,15 +1022,11 @@ def kicad_var_cb(self, c):
                 logger.debugl(3, f'- {c.ref} excluded from PCB')
         # DNP (aka DNF)
         if self._kicad_dnp_applied_solved:
-            dnp = v.dnp if v is not None and v.dnp is not None else c.kicad_dnp
+            # dnp = v.dnp if v is not None and v.dnp is not None else c.kicad_dnp
+            dnp = c.kicad_dnp
             if dnp:
                 c.set_fitted(False)
                 logger.debugl(3, f'- {c.ref} DNP by `{vname}`')
-        # Fields
-        if v is not None:
-            for name, value in v.fields.items():
-                c.set_field(name, value)
-                logger.debugl(3, f'- {c.ref} field `{name}` set to `{value}` by `{vname}`')
 
     def run(self, output):
         format = self._format