InteractiveHtmlBom 2.11.2__tar.gz → 2.12.0__tar.gz

{interactivehtmlbom-2.11.2 → interactivehtmlbom-2.12.0}/.gitignore

@@ -9,3 +9,10 @@ demo
 *config.ini
 InteractiveHtmlBom/web/user*
 dist/
+
+# kicad's files
+.history
+*.lck
+*.kicad_prl
+*.kicad_pro
+*-backups

{interactivehtmlbom-2.11.2 → interactivehtmlbom-2.12.0}/InteractiveHtmlBom/core/config.py

@@ -347,15 +347,27 @@ class Config:
         # Html
         parser.add_argument('--dark-mode', help='Default to dark mode.',
                             action='store_true')
+        parser.add_argument('--no-dark-mode', dest='dark_mode',
+                            help='Do not default to dark mode.',
+                            action='store_false', default=False)
         parser.add_argument('--hide-pads',
                             help='Hide footprint pads by default.',
                             action='store_true')
+        parser.add_argument('--show-pads', dest='hide_pads',
+                            help='Show footprint pads by default.',
+                            action='store_false', default=False)
         parser.add_argument('--show-fabrication',
                             help='Show fabrication layer by default.',
                             action='store_true')
+        parser.add_argument('--hide-fabrication', dest='show_fabrication',
+                            help='Hide fabrication layer by default.',
+                            action='store_false', default=False)
         parser.add_argument('--hide-silkscreen',
                             help='Hide silkscreen by default.',
                             action='store_true')
+        parser.add_argument('--show-silkscreen', dest='hide_silkscreen',
+                            help='Show silkscreen by default.',
+                            action='store_false', default=False)
         parser.add_argument('--highlight-pin1',
                             default=cls.highlight_pin1_choices[0],
                             const=cls.highlight_pin1_choices[1],
@@ -365,6 +377,9 @@ class Config:
         parser.add_argument('--no-redraw-on-drag',
                             help='Do not redraw pcb on drag by default.',
                             action='store_true')
+        parser.add_argument('--redraw-on-drag', dest='no_redraw_on_drag',
+                            help='Redraw pcb on drag by default.',
+                            action='store_false', default=False)
         parser.add_argument('--board-rotation', type=int,
                             default=cls.board_rotation * 5,
                             help='Board rotation in degrees (-180 to 180). '
@@ -372,6 +387,10 @@ class Config:
         parser.add_argument('--offset-back-rotation',
                             help='Offset the back of the pcb by 180 degrees',
                             action='store_true')
+        parser.add_argument('--no-offset-back-rotation',
+                            dest='offset_back_rotation',
+                            help='Do not offset the back of the pcb by 180 degrees',
+                            action='store_false', default=False)
         parser.add_argument('--checkboxes',
                             default=cls.checkboxes,
                             help='Comma separated list of checkbox columns.')
@@ -388,8 +407,16 @@ class Config:
         parser.add_argument('--no-compression',
                             help='Disable compression of pcb data.',
                             action='store_true')
+        parser.add_argument('--compression', dest='no_compression',
+                            help='Enable compression of pcb data.',
+                            action='store_false', default=False)
         parser.add_argument('--no-browser', help='Do not launch browser.',
                             action='store_true')
+        parser.add_argument('--browser', dest='no_browser',
+                            help='Launch browser.',
+                            action='store_false', default=False)
+        parser.add_argument('--use-ini', help='Use all run options from ibom ini file.',
+                            action='store_true')
 
         # General
         parser.add_argument('--dest-dir', default=cls.bom_dest_dir,
@@ -400,8 +427,14 @@ class Config:
         parser.add_argument('--include-tracks', action='store_true',
                             help='Include track/zone information in output. '
                                  'F.Cu and B.Cu layers only.')
+        parser.add_argument('--exclude-tracks', dest='include_tracks',
+                           action='store_false', default=False,
+                           help='Exclude track/zone information from output.')
         parser.add_argument('--include-nets', action='store_true',
                             help='Include netlist information in output.')
+        parser.add_argument('--exclude-nets', dest='include_nets',
+                           action='store_false', default=False,
+                           help='Exclude netlist information from output.')
         parser.add_argument('--sort-order',
                             help='Default sort order for components. '
                                  'Must contain "~" once.',
@@ -413,8 +446,15 @@ class Config:
                                  'E.g. "X1,MH*"')
         parser.add_argument('--no-blacklist-virtual', action='store_true',
                             help='Do not blacklist virtual components.')
+        parser.add_argument('--blacklist-virtual', dest='no_blacklist_virtual',
+                            action='store_false', default=False,
+                            help='Blacklist virtual components.')
         parser.add_argument('--blacklist-empty-val', action='store_true',
                             help='Blacklist components with empty value.')
+        parser.add_argument('--no-blacklist-empty-val',
+                            dest='blacklist_empty_val',
+                            action='store_false', default=False,
+                            help='Do not blacklist components with empty value.')
 
         # Fields section
         parser.add_argument('--netlist-file',
@@ -435,6 +475,10 @@ class Config:
                             help='Normalize extra field name case. E.g. "MPN" '
                                  ', "mpn" will be considered the same field.',
                             action='store_true')
+        parser.add_argument('--no-normalize-field-case',
+                            dest='normalize_field_case',
+                            help='Do not normalize extra field name case.',
+                            action='store_false', default=False)
         parser.add_argument('--variant-field',
                             help='Name of the extra field that stores board '
                                  'variant for component.')
@@ -451,6 +495,109 @@ class Config:
                                  'do not populate status. Components with '
                                  'this field not empty will be excluded.')
 
+    def get_ini_defaults(self):
+        # type: () -> dict | None
+        """Read the ibom ini file and return its values keyed by the dest
+        of the matching command line option, suitable for passing to
+        ArgumentParser.set_defaults(). Installing the ini values as parser
+        defaults makes options given on the command line override the ini
+        while all other options fall back to the ini values.
+
+        Returns None if no ini file exists in the usual locations.
+        """
+        import configparser
+
+        if os.path.isfile(self.local_config_file):
+            file = self.local_config_file
+        elif os.path.isfile(self.global_config_file):
+            file = self.global_config_file
+        else:
+            return None
+        print("Loading options from %s" % file)
+
+        # Interpolation is disabled because values like bom_name_format
+        # legitimately contain '%'.
+        ini = configparser.ConfigParser(interpolation=None)
+        ini.read(file)
+
+        # Each entry is (section, key, dest, kind) mapping an ini key to
+        # the dest of the command line option holding the same setting.
+        # kind describes how the ini value translates to the value argparse
+        # would have produced for that dest:
+        #   'bool': same boolean
+        #   'not' : inverted boolean (the ini stores the positive setting,
+        #           the option's dest stores the negated one)
+        #   'str' : verbatim string; comma separated lists stay joined,
+        #           set_from_args splits them
+        # board_rotation is handled separately below. extra_data_file is
+        # intentionally not read from the ini; it is chosen dynamically
+        # unless given on the command line.
+        ini_options = [
+            # Html
+            ('html_defaults', 'dark_mode', 'dark_mode', 'bool'),
+            ('html_defaults', 'show_pads', 'hide_pads', 'not'),
+            ('html_defaults', 'show_fabrication', 'show_fabrication',
+             'bool'),
+            ('html_defaults', 'show_silkscreen', 'hide_silkscreen', 'not'),
+            ('html_defaults', 'highlight_pin1', 'highlight_pin1', 'str'),
+            ('html_defaults', 'redraw_on_drag', 'no_redraw_on_drag', 'not'),
+            ('html_defaults', 'offset_back_rotation', 'offset_back_rotation',
+             'bool'),
+            ('html_defaults', 'checkboxes', 'checkboxes', 'str'),
+            ('html_defaults', 'mark_when_checked', 'mark_when_checked',
+             'str'),
+            ('html_defaults', 'bom_view', 'bom_view', 'str'),
+            ('html_defaults', 'layer_view', 'layer_view', 'str'),
+            ('html_defaults', 'compression', 'no_compression', 'not'),
+            ('html_defaults', 'open_browser', 'no_browser', 'not'),
+            # General
+            ('general', 'bom_dest_dir', 'dest_dir', 'str'),
+            ('general', 'bom_name_format', 'name_format', 'str'),
+            ('general', 'component_sort_order', 'sort_order', 'str'),
+            ('general', 'component_blacklist', 'blacklist', 'str'),
+            ('general', 'blacklist_virtual', 'no_blacklist_virtual', 'not'),
+            ('general', 'blacklist_empty_val', 'blacklist_empty_val',
+             'bool'),
+            ('general', 'include_tracks', 'include_tracks', 'bool'),
+            ('general', 'include_nets', 'include_nets', 'bool'),
+            # Fields
+            ('fields', 'show_fields', 'show_fields', 'str'),
+            ('fields', 'group_fields', 'group_fields', 'str'),
+            ('fields', 'normalize_field_case', 'normalize_field_case',
+             'bool'),
+            ('fields', 'board_variant_field', 'variant_field', 'str'),
+            ('fields', 'board_variant_whitelist', 'variants_whitelist',
+             'str'),
+            ('fields', 'board_variant_blacklist', 'variants_blacklist',
+             'str'),
+            ('fields', 'dnp_field', 'dnp_field', 'str'),
+        ]
+
+        defaults = {}
+        for section, key, dest, kind in ini_options:
+            if not ini.has_option(section, key):
+                continue
+            if kind == 'bool':
+                defaults[dest] = ini.getboolean(section, key)
+            elif kind == 'not':
+                defaults[dest] = not ini.getboolean(section, key)
+            else:
+                defaults[dest] = ini.get(section, key)
+
+        # The ini stores rotation in multiples of 5 degrees, the command
+        # line option takes degrees.
+        if ini.has_option('html_defaults', 'board_rotation'):
+            defaults['board_rotation'] = \
+                ini.getint('html_defaults', 'board_rotation') * 5
+
+        # migration from previous settings
+        if defaults.get('highlight_pin1') == '0':
+            defaults['highlight_pin1'] = 'none'
+        if defaults.get('highlight_pin1') == '1':
+            defaults['highlight_pin1'] = 'all'
+
+        return defaults
+
     def set_from_args(self, args):
         # type: (argparse.Namespace) -> None
         import math

{interactivehtmlbom-2.11.2 → interactivehtmlbom-2.12.0}/InteractiveHtmlBom/ecad/kicad.py

@@ -11,6 +11,12 @@ from ..core.config import Config
 from ..core.fontparser import FontParser
 
 
+# sneaky monkeypatch to work around
+# https://gitlab.com/kicad/code/kicad/-/work_items/25423
+if not hasattr(pcbnew.SwigPyIterator, 'next'):
+    setattr(pcbnew.SwigPyIterator, 'next', lambda o: next(o))
+
+
 KICAD_VERSION = [5, 1, 0]
 
 if hasattr(pcbnew, 'Version'):
@@ -263,6 +269,9 @@ class PcbnewParser(EcadParser):
 
         for i in range(poly.OutlineCount()):
             result.append(self.parse_line_chain(poly.Outline(i)))
+            if hasattr(poly, "HoleCount"):
+                for j in range(poly.HoleCount(i)):
+                    result.append(self.parse_line_chain(poly.Hole(i, j)))
 
         return result
 
@@ -270,6 +279,17 @@ class PcbnewParser(EcadParser):
         # type: (pcbnew.PCB_TEXT) -> dict
         if not d.IsVisible() and d.GetClass() not in ["PTEXT", "PCB_TEXT"]:
             return None
+        if (hasattr(d, "IsKnockout") and d.IsKnockout()
+                and hasattr(d, "GetEffectiveShape")):
+            shape = d.GetEffectiveShape()
+            if (shape and hasattr(shape, "Cast")
+                    and hasattr(pcbnew, "SH_POLY_SET")
+                    and shape.Type() == pcbnew.SH_POLY_SET):
+                polygons = self.parse_poly_set(shape.Cast())
+                if polygons:
+                    return {
+                        "polygons": polygons
+                    }
         pos = self.normalize(d.GetPosition())
         if hasattr(d, "GetTextThickness"):
             thickness = d.GetTextThickness() * 1e-6
@@ -372,6 +392,21 @@ class PcbnewParser(EcadParser):
             "svgpath": svgpath
         }
 
+    def parse_barcode(self, d):
+        # type: (pcbnew.BOARD_ITEM) -> dict
+        if hasattr(d, "GetPolyShape"):
+            polygons = self.parse_poly_set(d.GetPolyShape())
+            if not polygons:
+                return None
+            return {
+                "type": "polygon",
+                "pos": [0, 0],
+                "angle": 0,
+                "polygons": polygons,
+                "filled": 1,
+            }
+        return None
+
     def parse_drawing(self, d):
         # type: (pcbnew.BOARD_ITEM) -> list
         result = []
@@ -387,6 +422,8 @@ class PcbnewParser(EcadParser):
                 s = self.parse_text(d.Text())
             else:
                 s = self.parse_text(d)
+        elif d.GetClass() in ["BARCODE", "PCB_BARCODE"]:
+            s = self.parse_barcode(d)
         else:
             self.logger.info("Unsupported drawing class %s, skipping",
                              d.GetClass())

{interactivehtmlbom-2.11.2 → interactivehtmlbom-2.12.0}/InteractiveHtmlBom/generate_interactive_bom.py

@@ -56,16 +56,33 @@ def main():
                         help="KiCad PCB file")
 
     Config.add_options(parser, version)
-    args = parser.parse_args()
     logger = ibom.Logger(cli=True)
 
-    if not os.path.isfile(args.file):
+    # First pass over the arguments to find the pcb file and --use-ini.
+    pre_args, _ = parser.parse_known_args()
+
+    if not os.path.isfile(pre_args.file):
         exit_error(logger, ExitCodes.ERROR_FILE_NOT_FOUND,
-                   "File %s does not exist." % args.file)
+                   "File %s does not exist." % pre_args.file)
+
+    config = Config(version,
+                    os.path.dirname(os.path.abspath(pre_args.file)))
+
+    # With --use-ini the ini values are installed as parser defaults before
+    # the final parse: options given on the command line override the ini
+    # while all other options fall back to the ini values.
+    if pre_args.use_ini and not pre_args.show_dialog:
+        ini_defaults = config.get_ini_defaults()
+        if ini_defaults is None:
+            exit_error(logger, ExitCodes.ERROR_FILE_NOT_FOUND,
+                       "No ibom ini file found in usual locations.")
+        else:
+            parser.set_defaults(**ini_defaults)
+
+    args = parser.parse_args()
 
     print("Loading %s" % args.file)
 
-    config = Config(version, os.path.dirname(os.path.abspath(args.file)))
     config.kicad_variant = args.kicad_variant
 
     parser = get_parser_by_extension(

{interactivehtmlbom-2.11.2 → interactivehtmlbom-2.12.0}/InteractiveHtmlBom/version.py

@@ -3,7 +3,7 @@ import os
 import subprocess
 
 
-LAST_TAG = 'v2.11.2'
+LAST_TAG = 'v2.12.0'
 
 
 def _get_git_version():

{interactivehtmlbom-2.11.2 → interactivehtmlbom-2.12.0}/InteractiveHtmlBom/web/ibom.css

@@ -8,7 +8,7 @@
   --pin1-outline-color: #ffb629;
   --pin1-outline-color-highlight: #ffb629;
   --pin1-outline-color-highlight-both: #fcbb39;
-  --pin1-outline-color-highlight-marked: #fdbe41;
+  --pin1-outline-color-highlight-marked: #00000000;
   --silkscreen-edge-color: #aa4;
   --silkscreen-polygon-color: #4aa;
   --silkscreen-text-color: #4aa;

{interactivehtmlbom-2.11.2 → interactivehtmlbom-2.12.0}/InteractiveHtmlBom/web/render.js

@@ -347,7 +347,7 @@ function drawFootprint(ctx, layer, scalefactor, footprint, colors, highlight, ou
       drawDrawing(ctx, scalefactor, drawing.drawing, colors.pad);
     }
   }
-  ctx.lineWidth = 3 / scalefactor;
+  ctx.lineWidth = (outline ? 1 : 3) / scalefactor;
   // draw pads
   if (settings.renderPads) {
     for (var pad of footprint.pads) {
@@ -386,7 +386,7 @@ function drawFootprints(canvas, layer, scalefactor, highlight) {
   }
 
   for (var i = 0; i < pcbdata.footprints.length; i++) {
-    var mod = pcbdata.footprints[i];
+    var fp = pcbdata.footprints[i];
     var outline = settings.renderDnpOutline && pcbdata.bom.skipped.includes(i);
     var h = highlightedFootprints.includes(i);
     var d = markedFootprints.has(i);
@@ -403,7 +403,7 @@ function drawFootprints(canvas, layer, scalefactor, highlight) {
       }
     }
     if( h || d || !highlight) {
-      drawFootprint(ctx, layer, scalefactor, mod, colors, highlight, outline);
+      drawFootprint(ctx, layer, scalefactor, fp, colors, highlight, outline);
     }
   }
 }

{interactivehtmlbom-2.11.2 → interactivehtmlbom-2.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: InteractiveHtmlBom
-Version: 2.11.2
+Version: 2.12.0
 Summary: Generate Interactive Html BOM for your electronics projects
 Project-URL: Documentation, https://github.com/openscopeproject/InteractiveHtmlBom/wiki
 Project-URL: Issues, https://github.com/openscopeproject/InteractiveHtmlBom/issues