Implement custom output name format with substitutions

Issue #67

Author: qu1ck

InteractiveHtmlBom/config.py

@@ -37,6 +37,7 @@ class Config:
 
     # General section
     bom_dest_dir = 'bom/'  # This is relative to pcb file directory
+    bom_name_format = 'ibom'
     component_sort_order = default_sort_order
     component_blacklist = []
     blacklist_virtual = True
@@ -76,6 +77,7 @@ def __init__(self):
 
         f.SetPath('/general')
         self.bom_dest_dir = f.Read('bom_dest_dir', self.bom_dest_dir)
+        self.bom_name_format = f.Read('bom_name_format', self.bom_name_format)
         self.component_sort_order = self._split(f.Read(
                 'component_sort_order',
                 ','.join(self.component_sort_order)))
@@ -121,6 +123,7 @@ def save(self):
             bom_dest_dir = os.path.relpath(
                     bom_dest_dir, self.netlist_initial_directory)
         f.Write('bom_dest_dir', bom_dest_dir)
+        f.Write('bom_name_format', self.bom_name_format)
         f.Write('component_sort_order',
                 ','.join(self.component_sort_order))
         f.Write('component_blacklist',
@@ -154,6 +157,7 @@ def set_from_dialog(self, dlg):
 
         # General
         self.bom_dest_dir = dlg.general.bomDirPicker.Path
+        self.bom_name_format = dlg.general.fileNameFormatTextControl.Value
         self.component_sort_order = dlg.general.componentSortOrderBox.GetItems()
         self.component_blacklist = dlg.general.blacklistBox.GetItems()
         self.blacklist_virtual = \
@@ -197,6 +201,7 @@ def transfer_to_dialog(self, dlg):
         else:
             dlg.general.bomDirPicker.Path = os.path.join(
                     self.netlist_initial_directory, self.bom_dest_dir)
+        dlg.general.fileNameFormatTextControl.Value = self.bom_name_format
         dlg.general.componentSortOrderBox.SetItems(self.component_sort_order)
         dlg.general.blacklistBox.SetItems(self.component_blacklist)
         dlg.general.blacklistVirtualCheckbox.Value = self.blacklist_virtual
@@ -222,8 +227,8 @@ def safe_set_checked_strings(clb, strings):
         dlg.finish_init()
 
     # noinspection PyTypeChecker
-    def add_options(self, parser):
-        # type: (argparse.ArgumentParser) -> None
+    def add_options(self, parser, file_name_format_hint):
+        # type: (argparse.ArgumentParser, str) -> None
         parser.add_argument('--show-dialog', action='store_true',
                             help='Shows config dialog. All other flags '
                                  'will be ignored.')
@@ -259,6 +264,8 @@ def add_options(self, parser):
         parser.add_argument('--dest-dir', default=self.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('--sort-order',
                             help='Default sort order for components. '
                                  'Must contain "~" once.',
@@ -310,6 +317,7 @@ def set_from_args(self, args):
 
         # General
         self.bom_dest_dir = args.dest_dir
+        self.bom_name_format = args.name_format
         self.component_sort_order = self._split(args.sort_order)
         self.component_blacklist = self._split(args.blacklist)
         self.blacklist_virtual = not args.no_blacklist_virtual

InteractiveHtmlBom/dialog/__init__.py

@@ -1 +1 @@
-from .settings_dialog import SettingsDialog
+from .settings_dialog import SettingsDialog, GeneralSettingsPanel

InteractiveHtmlBom/dialog/dialog_base.py

@@ -190,10 +190,39 @@ def __init__( self, parent, id = wx.ID_ANY, pos = wx.DefaultPosition, size = wx.
 
         bSizer32 = wx.BoxSizer( wx.VERTICAL )
 
-        sbSizer6 = wx.StaticBoxSizer( wx.StaticBox( self, wx.ID_ANY, u"Bom destination directory" ), wx.VERTICAL )
+        sbSizer6 = wx.StaticBoxSizer( wx.StaticBox( self, wx.ID_ANY, u"Bom destination" ), wx.VERTICAL )
+        
+        fgSizer1 = wx.FlexGridSizer( 0, 2, 0, 0 )
+        fgSizer1.AddGrowableCol( 1 )
+        fgSizer1.SetFlexibleDirection( wx.BOTH )
+        fgSizer1.SetNonFlexibleGrowMode( wx.FLEX_GROWMODE_SPECIFIED )
+        
+        self.m_staticText8 = wx.StaticText( sbSizer6.GetStaticBox(), wx.ID_ANY, u"Directory", wx.DefaultPosition, wx.DefaultSize, 0 )
+        self.m_staticText8.Wrap( -1 )
+        
+        fgSizer1.Add( self.m_staticText8, 0, wx.ALIGN_CENTER_VERTICAL|wx.ALL, 5 )
 
         self.bomDirPicker = wx.DirPickerCtrl( sbSizer6.GetStaticBox(), wx.ID_ANY, wx.EmptyString, u"Select bom folder", wx.DefaultPosition, wx.DefaultSize, wx.DIRP_SMALL|wx.DIRP_USE_TEXTCTRL|wx.BORDER_SIMPLE )
-        sbSizer6.Add( self.bomDirPicker, 0, wx.EXPAND|wx.BOTTOM|wx.RIGHT|wx.LEFT, 5 )
+        fgSizer1.Add( self.bomDirPicker, 1, wx.ALIGN_CENTER_VERTICAL|wx.ALL|wx.EXPAND, 5 )
+        
+        self.m_staticText9 = wx.StaticText( sbSizer6.GetStaticBox(), wx.ID_ANY, u"Name format", wx.DefaultPosition, wx.DefaultSize, 0 )
+        self.m_staticText9.Wrap( -1 )
+        
+        fgSizer1.Add( self.m_staticText9, 0, wx.ALIGN_CENTER_VERTICAL|wx.ALL, 5 )
+        
+        bSizer20 = wx.BoxSizer( wx.HORIZONTAL )
+        
+        self.fileNameFormatTextControl = wx.TextCtrl( sbSizer6.GetStaticBox(), wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 )
+        bSizer20.Add( self.fileNameFormatTextControl, 1, wx.ALIGN_CENTER_VERTICAL|wx.ALL|wx.EXPAND, 5 )
+        
+        self.m_button12 = wx.Button( sbSizer6.GetStaticBox(), wx.ID_ANY, u"?", wx.DefaultPosition, wx.DefaultSize, wx.BU_EXACTFIT )
+        bSizer20.Add( self.m_button12, 0, wx.ALIGN_CENTER_VERTICAL|wx.ALL, 4 )
+        
+        
+        fgSizer1.Add( bSizer20, 1, wx.EXPAND, 5 )
+        
+        
+        sbSizer6.Add( fgSizer1, 1, wx.EXPAND, 5 )
 
 
         bSizer32.Add( sbSizer6, 0, wx.ALL|wx.EXPAND, 5 )
@@ -282,6 +311,7 @@ def __init__( self, parent, id = wx.ID_ANY, pos = wx.DefaultPosition, size = wx.
         bSizer32.Fit( self )
 
         # Connect Events
+        self.m_button12.Bind( wx.EVT_BUTTON, self.OnNameFormatHintClick )
         self.m_button1.Bind( wx.EVT_BUTTON, self.OnComponentSortOrderUp )
         self.m_button2.Bind( wx.EVT_BUTTON, self.OnComponentSortOrderDown )
         self.m_button3.Bind( wx.EVT_BUTTON, self.OnComponentSortOrderAdd )
@@ -294,6 +324,9 @@ def __del__( self ):
 
 
     # Virtual event handlers, overide them in your derived class
+    def OnNameFormatHintClick( self, event ):
+        event.Skip()
+    
     def OnComponentSortOrderUp( self, event ):
         event.Skip()
 

InteractiveHtmlBom/dialog/settings_dialog.py

@@ -74,6 +74,21 @@ def OnBoardRotationSlider(self, event):
 
 # Implementing GeneralSettingsPanelBase
 class GeneralSettingsPanel(dialog_base.GeneralSettingsPanelBase):
+    FILE_NAME_FORMAT_HINT = (
+        'Output file name format supports substitutions:\n' +
+        '\n' +
+        '    %f : original pcb file name without extension.\n' +
+        '    %p : pcb/project title from pcb metadata.\n' +
+        '    %c : company from pcb metadata.\n' +
+        '    %r : revision from pcb metadata.\n' +
+        '    %d : pcb date from metadata if available, ' +
+        'file modification date otherwise.\n' +
+        '    %D : bom generation date.\n' +
+        '    %T : bom generation time.\n' +
+        '\n' +
+        'Extension .html will be added automatically.'
+    )  # type: str
+
     def __init__(self, parent):
         dialog_base.GeneralSettingsPanelBase.__init__(self, parent)
 
@@ -143,6 +158,10 @@ def OnComponentBlacklistRemove(self, event):
             if self.blacklistBox.Count > 0:
                 self.blacklistBox.SetSelection(max(selection - 1, 0))
 
+    def OnNameFormatHintClick(self, event):
+        wx.MessageBox(self.FILE_NAME_FORMAT_HINT, 'File name format help',
+                      style=wx.ICON_NONE|wx.OK)
+
 
 # Implementing ExtraFieldsPanelBase
 class ExtraFieldsPanel(dialog_base.ExtraFieldsPanelBase):

InteractiveHtmlBom/generate_interactive_bom.py

@@ -511,7 +511,22 @@ def open_file(filename):
         logwarn('Failed to open browser: {}'.format(oe.message))
 
 
-def generate_file(pcb_file_dir, pcbdata, config):
+def process_substitutions(bom_name_format, pcb_file_name, metadata):
+    # type: (str, str, dict)->str
+    name = bom_name_format.replace('%f', os.path.splitext(pcb_file_name)[0])
+    name = name.replace('%p', metadata['title'])
+    name = name.replace('%c', metadata['company'])
+    name = name.replace('%r', metadata['revision'])
+    name = name.replace('%d', metadata['date'].replace(':', '-'))
+    now = datetime.now()
+    name = name.replace('%D', now.strftime('%Y-%m-%d'))
+    name = name.replace('%T', now.strftime('%H-%M-%S'))
+    # sanitize the name to avoid characters illegal in file systems
+    name = re.sub(r'[/\\?%*:|"<>]', '_', name)
+    return name + '.html'
+
+
+def generate_file(pcb_file_dir, pcb_file_name, pcbdata, config):
     def get_file_content(file_name):
         path = os.path.join(os.path.dirname(__file__), "web", file_name)
         with open(path, "r") as f:
@@ -520,12 +535,14 @@ def get_file_content(file_name):
     loginfo("Dumping pcb json data")
 
     if os.path.isabs(config.bom_dest_dir):
-        bom_file_name = config.bom_dest_dir
+        bom_file_dir = config.bom_dest_dir
     else:
-        bom_file_name = os.path.join(pcb_file_dir, config.bom_dest_dir)
-    if not os.path.isdir(bom_file_name):
-        os.makedirs(bom_file_name)
-    bom_file_name = os.path.join(bom_file_name, "ibom.html")
+        bom_file_dir = os.path.join(pcb_file_dir, config.bom_dest_dir)
+    if not os.path.isdir(bom_file_dir):
+        os.makedirs(bom_file_dir)
+    bom_file_name = process_substitutions(
+            config.bom_name_format, pcb_file_name, pcbdata['metadata'])
+    bom_file_name = os.path.join(bom_file_dir, bom_file_name)
     pcbdata_js = "var pcbdata = " + json.dumps(pcbdata)
     config_js = "var config = " + config.get_html_config()
     html = get_file_content("ibom.html")
@@ -579,10 +596,10 @@ def main(pcb, config):
         file_date = datetime.fromtimestamp(file_mtime).strftime(
                 '%Y-%m-%d %H:%M:%S')
     title = title_block.GetTitle()
+    pcb_file_name = os.path.basename(pcb_file_name)
     if not title:
-        title = os.path.basename(pcb_file_name)
         # remove .kicad_pcb extension
-        title = os.path.splitext(title)[0]
+        title = os.path.splitext(pcb_file_name)[0]
     edges, bbox = parse_edges(pcb)
     if bbox is None:
         logerror('Please draw pcb outline on the edges '
@@ -619,7 +636,7 @@ def main(pcb, config):
         pcbdata["bom"]["F" if layer == pcbnew.F_Cu else "B"] = bom_table
 
     pcbdata["font_data"] = font_parser.get_parsed_font()
-    bom_file = generate_file(pcb_file_dir, pcbdata, config)
+    bom_file = generate_file(pcb_file_dir, pcb_file_name, pcbdata, config)
 
     if config.open_browser:
         loginfo("Opening file in browser")
@@ -689,7 +706,8 @@ def Run(self):
             formatter_class=argparse.ArgumentDefaultsHelpFormatter)
     parser.add_argument('file', type=str, help="KiCad PCB file")
     config = Config()
-    config.add_options(parser)
+    config.add_options(
+            parser, dialog.GeneralSettingsPanel.FILE_NAME_FORMAT_HINT)
     args = parser.parse_args()
     if not os.path.isfile(args.file.decode('utf8')):
         print("File %s does not exist." % args.file)