Implement local/global settings

Local means in same directory as pcb file and it overrides global
settings.

Author: qu1ck

.gitignore

@@ -6,5 +6,5 @@
 test
 releases
 demo
-config.ini
+*config.ini
 InteractiveHtmlBom/web/user*

InteractiveHtmlBom/core/config.py

@@ -26,7 +26,6 @@ class Config:
     )  # type: str
 
     # Helper constants
-    config_file = os.path.join(os.path.dirname(__file__), '..', 'config.ini')
     bom_view_choices = ['bom-only', 'left-right', 'top-bottom']
     layer_view_choices = ['F', 'FB', 'B']
     default_sort_order = [
@@ -88,14 +87,22 @@ def _split(s):
     def _join(lst):
         return ','.join([s.replace(',', '\\,') for s in lst])
 
-    def __init__(self, version):
+    def __init__(self, version, local_dir):
         self.version = version
+        self.local_config_file = os.path.join(local_dir, 'ibom.config.ini')
+        self.global_config_file = os.path.join(
+            os.path.dirname(__file__), '..', 'config.ini')
 
     def load_from_ini(self):
         """Init from config file if it exists."""
-        if not os.path.isfile(self.config_file):
+        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
-        f = FileConfig(localFilename=self.config_file)
+
+        f = FileConfig(localFilename=file)
 
         f.SetPath('/html_defaults')
         self.dark_mode = f.ReadBool('dark_mode', self.dark_mode)
@@ -146,8 +153,10 @@ def load_from_ini(self):
             self._join(self.board_variant_blacklist)))
         self.dnp_field = f.Read('dnp_field', self.dnp_field)
 
-    def save(self):
-        f = FileConfig(localFilename=self.config_file)
+    def save(self, locally):
+        file = self.local_config_file if locally else self.global_config_file
+        print('Saving to', file)
+        f = FileConfig(localFilename=file)
 
         f.SetPath('/html_defaults')
         f.WriteBool('dark_mode', self.dark_mode)
@@ -294,9 +303,9 @@ def safe_set_checked_strings(clb, strings):
 
         dlg.finish_init()
 
-    # noinspection PyTypeChecker
-    def add_options(self, parser, file_name_format_hint):
-        # type: (argparse.ArgumentParser, str) -> None
+    @classmethod
+    def add_options(cls, parser):
+        # type: (argparse.ArgumentParser) -> None
         parser.add_argument('--show-dialog', action='store_true',
                             help='Shows config dialog. All other flags '
                                  'will be ignored.')
@@ -319,17 +328,17 @@ def add_options(self, parser, file_name_format_hint):
                             help='Do not redraw pcb on drag by default.',
                             action='store_true')
         parser.add_argument('--board-rotation', type=int,
-                            default=self.board_rotation * 5,
+                            default=cls.board_rotation * 5,
                             help='Board rotation in degrees (-180 to 180). '
                                  'Will be rounded to multiple of 5.')
         parser.add_argument('--checkboxes',
-                            default=self.checkboxes,
+                            default=cls.checkboxes,
                             help='Comma separated list of checkbox columns.')
-        parser.add_argument('--bom-view', default=self.bom_view,
-                            choices=self.bom_view_choices,
+        parser.add_argument('--bom-view', default=cls.bom_view,
+                            choices=cls.bom_view_choices,
                             help='Default BOM view.')
-        parser.add_argument('--layer-view', default=self.layer_view,
-                            choices=self.layer_view_choices,
+        parser.add_argument('--layer-view', default=cls.layer_view,
+                            choices=cls.layer_view_choices,
                             help='Default layer view.')
         parser.add_argument('--no-compression',
                             help='Disable compression of pcb data.',
@@ -338,11 +347,11 @@ def add_options(self, parser, file_name_format_hint):
                             action='store_true')
 
         # General
-        parser.add_argument('--dest-dir', default=self.bom_dest_dir,
+        parser.add_argument('--dest-dir', default=cls.bom_dest_dir,
                             help='Destination directory for bom file '
                                  'relative to pcb file directory.')
-        parser.add_argument('--name-format', default=self.bom_name_format,
-                            help=file_name_format_hint.replace('%', '%%'))
+        parser.add_argument('--name-format', default=cls.bom_name_format,
+                            help=cls.FILE_NAME_FORMAT_HINT.replace('%', '%%'))
         parser.add_argument('--include-tracks', action='store_true',
                             help='Include track/zone information in output. '
                                  'F.Cu and B.Cu layers only.')
@@ -351,9 +360,9 @@ def add_options(self, parser, file_name_format_hint):
         parser.add_argument('--sort-order',
                             help='Default sort order for components. '
                                  'Must contain "~" once.',
-                            default=','.join(self.component_sort_order))
+                            default=','.join(cls.component_sort_order))
         parser.add_argument('--blacklist',
-                            default=','.join(self.component_blacklist),
+                            default=','.join(cls.component_blacklist),
                             help='List of comma separated blacklisted '
                                  'components or prefixes with *. '
                                  'E.g. "X1,MH*"')
@@ -372,10 +381,10 @@ def add_options(self, parser, file_name_format_hint):
                                  'for --show-fields and --group-fields '
                                  'with values "Value,Footprint,X,Y"')
         parser.add_argument('--show-fields',
-                            default=self._join(self.show_fields),
+                            default=cls._join(cls.show_fields),
                             help='List of fields to show in the BOM.')
         parser.add_argument('--group-fields',
-                            default=self._join(self.group_fields),
+                            default=cls._join(cls.group_fields),
                             help='Fields that components will be grouped by.')
         parser.add_argument('--normalize-field-case',
                             help='Normalize extra field name case. E.g. "MPN" '
@@ -390,7 +399,7 @@ def add_options(self, parser, file_name_format_hint):
         parser.add_argument('--variants-blacklist', default='',
                             help='List of board variants to '
                                  'exclude from the BOM.')
-        parser.add_argument('--dnp-field', default=self.dnp_field,
+        parser.add_argument('--dnp-field', default=cls.dnp_field,
                             help='Name of the extra field that indicates '
                                  'do not populate status. Components with '
                                  'this field not empty will be excluded.')

InteractiveHtmlBom/core/ibom.py

@@ -318,9 +318,9 @@ def main(parser, config, logger):
 
 def run_with_dialog(parser, config, logger):
     # type: (EcadParser, Config, Logger) -> None
-    def save_config(dialog_panel):
+    def save_config(dialog_panel, locally=False):
         config.set_from_dialog(dialog_panel)
-        config.save()
+        config.save(locally)
 
     config.load_from_ini()
     dlg = SettingsDialog(extra_data_func=parser.parse_extra_data,

InteractiveHtmlBom/dialog/dialog_base.py

@@ -46,19 +46,19 @@ def __init__( self, parent, id = wx.ID_ANY, pos = wx.DefaultPosition, size = wx.
 
         bSizer39 = wx.BoxSizer( wx.HORIZONTAL )
 
-        self.m_button41 = wx.Button( self, wx.ID_ANY, u"Save current settings", wx.DefaultPosition, wx.DefaultSize, 0|wx.BORDER_DEFAULT )
-        bSizer39.Add( self.m_button41, 0, wx.ALL, 5 )
+        self.saveSettingsBtn = wx.Button( self, wx.ID_ANY, u"Save current settings...", wx.DefaultPosition, wx.DefaultSize, 0|wx.BORDER_DEFAULT )
+        bSizer39.Add( self.saveSettingsBtn, 0, wx.ALL, 5 )
 
 
         bSizer39.Add( ( 50, 0), 1, wx.EXPAND, 5 )
 
-        self.m_button42 = wx.Button( self, wx.ID_ANY, u"Generate BOM", wx.DefaultPosition, wx.DefaultSize, 0|wx.BORDER_DEFAULT )
+        self.generateBomBtn = wx.Button( self, wx.ID_ANY, u"Generate BOM", wx.DefaultPosition, wx.DefaultSize, 0|wx.BORDER_DEFAULT )
 
-        self.m_button42.SetDefault()
-        bSizer39.Add( self.m_button42, 0, wx.ALL, 5 )
+        self.generateBomBtn.SetDefault()
+        bSizer39.Add( self.generateBomBtn, 0, wx.ALL, 5 )
 
-        self.m_button43 = wx.Button( self, wx.ID_CANCEL, u"Cancel", wx.DefaultPosition, wx.DefaultSize, 0|wx.BORDER_DEFAULT )
-        bSizer39.Add( self.m_button43, 0, wx.ALL, 5 )
+        self.cancelBtn = wx.Button( self, wx.ID_CANCEL, u"Cancel", wx.DefaultPosition, wx.DefaultSize, 0|wx.BORDER_DEFAULT )
+        bSizer39.Add( self.cancelBtn, 0, wx.ALL, 5 )
 
 
         bSizer20.Add( bSizer39, 0, wx.EXPAND, 5 )
@@ -68,16 +68,16 @@ def __init__( self, parent, id = wx.ID_ANY, pos = wx.DefaultPosition, size = wx.
         self.Layout()
 
         # Connect Events
-        self.m_button41.Bind( wx.EVT_BUTTON, self.OnSaveSettings )
-        self.m_button42.Bind( wx.EVT_BUTTON, self.OnGenerateBom )
-        self.m_button43.Bind( wx.EVT_BUTTON, self.OnExit )
+        self.saveSettingsBtn.Bind( wx.EVT_BUTTON, self.OnSave )
+        self.generateBomBtn.Bind( wx.EVT_BUTTON, self.OnGenerateBom )
+        self.cancelBtn.Bind( wx.EVT_BUTTON, self.OnExit )
 
     def __del__( self ):
         pass
 
 
     # Virtual event handlers, override them in your derived class
-    def OnSaveSettings( self, event ):
+    def OnSave( self, event ):
         event.Skip()
 
     def OnGenerateBom( self, event ):

InteractiveHtmlBom/dialog/settings_dialog.py

@@ -54,18 +54,37 @@ def __init__(self, parent, extra_data_func, extra_data_wildcard,
         self.notebook.AddPage(self.html, "Html defaults")
         self.notebook.AddPage(self.fields, "Fields")
 
+        self.save_menu = wx.Menu()
+        self.save_locally = self.save_menu.Append(
+            wx.ID_ANY, u"Locally", wx.EmptyString, wx.ITEM_NORMAL)
+        self.save_globally = self.save_menu.Append(
+            wx.ID_ANY, u"Globally", wx.EmptyString, wx.ITEM_NORMAL)
+
+        self.Bind(
+            wx.EVT_MENU, self.OnSaveLocally, id=self.save_locally.GetId())
+        self.Bind(
+            wx.EVT_MENU, self.OnSaveGlobally, id=self.save_globally.GetId())
+
     def OnExit(self, event):
         self.GetParent().EndModal(wx.ID_CANCEL)
 
-    def OnSaveSettings(self, event):
-        self.config_save_func(self)
-
     def OnGenerateBom(self, event):
         self.GetParent().EndModal(wx.ID_OK)
 
     def finish_init(self):
         self.html.OnBoardRotationSlider(None)
 
+    def OnSave(self, event):
+        # type: (wx.CommandEvent) -> None
+        pos = wx.Point(0, event.GetEventObject().GetSize().y)
+        self.saveSettingsBtn.PopupMenu(self.save_menu, pos)
+
+    def OnSaveGlobally(self, event):
+        self.config_save_func(self)
+
+    def OnSaveLocally(self, event):
+        self.config_save_func(self, locally=True)
+
 
 # Implementing HtmlSettingsPanelBase
 class HtmlSettingsPanel(dialog_base.HtmlSettingsPanelBase):

InteractiveHtmlBom/dialog_test.py

@@ -1,4 +1,5 @@
-from dialog.settings_dialog import *
+import wx
+from dialog.settings_dialog import SettingsDialog
 
 
 class MyApp(wx.App):

InteractiveHtmlBom/ecad/kicad.py

@@ -778,16 +778,18 @@ def defaults(self):
     def Run(self):
         from ..version import version
         from ..errors import ParsingException
-        config = Config(version)
+
+        logger = ibom.Logger()
         board = pcbnew.GetBoard()
         pcb_file_name = board.GetFileName()
 
-        logger = ibom.Logger()
         if not pcb_file_name:
             logger.error('Please save the board file before generating BOM.')
             return
 
+        config = Config(version, os.path.dirname(pcb_file_name))
         parser = PcbnewParser(pcb_file_name, config, logger, board)
+
         try:
             ibom.run_with_dialog(parser, config, logger)
         except ParsingException as e:

InteractiveHtmlBom/generate_interactive_bom.py

@@ -40,15 +40,22 @@ def to_utf(s):
     parser.add_argument('file',
                         type=lambda s: to_utf(s),
                         help="KiCad PCB file")
-    config = Config(version)
-    config.add_options(parser, config.FILE_NAME_FORMAT_HINT)
+
+    Config.add_options(parser)
     args = parser.parse_args()
     logger = ibom.Logger(cli=True)
+
     if not os.path.isfile(args.file):
         exit_error(logger, ExitCodes.ERROR_FILE_NOT_FOUND,
                    "File %s does not exist." % args.file)
+
     print("Loading %s" % args.file)
-    parser = get_parser_by_extension(os.path.abspath(args.file), config, logger)
+
+    config = Config(version, os.path.dirname(os.path.abspath(args.file)))
+
+    parser = get_parser_by_extension(
+        os.path.abspath(args.file), config, logger)
+
     if args.show_dialog:
         if not create_wx_app:
             exit_error(logger, ExitCodes.ERROR_NO_DISPLAY,

settings_dialog.fbp

@@ -191,7 +191,7 @@
                                 <property name="gripper">0</property>
                                 <property name="hidden">0</property>
                                 <property name="id">wxID_ANY</property>
-                                <property name="label">Save current settings</property>
+                                <property name="label">Save current settings...</property>
                                 <property name="margins"></property>
                                 <property name="markup">0</property>
                                 <property name="max_size"></property>
@@ -201,7 +201,7 @@
                                 <property name="minimize_button">0</property>
                                 <property name="minimum_size"></property>
                                 <property name="moveable">1</property>
-                                <property name="name">m_button41</property>
+                                <property name="name">saveSettingsBtn</property>
                                 <property name="pane_border">1</property>
                                 <property name="pane_position"></property>
                                 <property name="pane_size"></property>
@@ -224,7 +224,7 @@
                                 <property name="window_extra_style"></property>
                                 <property name="window_name"></property>
                                 <property name="window_style">wxBORDER_DEFAULT</property>
-                                <event name="OnButtonClick">OnSaveSettings</event>
+                                <event name="OnButtonClick">OnSave</event>
                             </object>
                         </object>
                         <object class="sizeritem" expanded="1">
@@ -285,7 +285,7 @@
                                 <property name="minimize_button">0</property>
                                 <property name="minimum_size"></property>
                                 <property name="moveable">1</property>
-                                <property name="name">m_button42</property>
+                                <property name="name">generateBomBtn</property>
                                 <property name="pane_border">1</property>
                                 <property name="pane_position"></property>
                                 <property name="pane_size"></property>
@@ -359,7 +359,7 @@
                                 <property name="minimize_button">0</property>
                                 <property name="minimum_size"></property>
                                 <property name="moveable">1</property>
-                                <property name="name">m_button43</property>
+                                <property name="name">cancelBtn</property>
                                 <property name="pane_border">1</property>
                                 <property name="pane_position"></property>
                                 <property name="pane_size"></property>