opencos-eda 0.2.46__tar.gz → 0.2.47__tar.gz

{opencos_eda-0.2.46/opencos_eda.egg-info → opencos_eda-0.2.47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.46
+Version: 0.2.47
 Summary: A simple Python package for wrapping RTL simuliatons and synthesis
 Author-email: Simon Sabato <simon@cognichip.ai>, Drew Ranck <drew@cognichip.ai>
 Project-URL: Homepage, https://github.com/cognichip/opencos

{opencos_eda-0.2.46 → opencos_eda-0.2.47}/opencos/deps_helpers.py

@@ -68,7 +68,9 @@ class Defaults:
         'shell',
         'work-dir-add-srcs', 'work-dir-add-sources',
         'peakrdl',
-        'run-from-work-dir',
+        'run-from-work-dir',     # default True
+        'filepath-subst-target-dir', # default True
+        'dirpath-subst-target-dir',  # default False
         'var-subst-args',
         'var-subst-os-env',
         'tee',
@@ -384,7 +386,13 @@ def deps_list_target_sanitize(entry, default_key:str='deps', target_node:str='',
     assert False, f"Can't convert to list {entry=} {default_key=} {target_node=} {deps_file=}"
 
 
-def path_substitutions_relative_to_work_dir(exec_list : list, info_str : str, target_path : str):
+def path_substitutions_relative_to_work_dir(
+        exec_list: list, info_str: str, target_path: str,
+        enable_filepath_subst: bool, enable_dirpath_subst: bool
+) -> list:
+
+    if not enable_filepath_subst and not enable_dirpath_subst:
+        return exec_list
 
     # Look for path substitutions, b/c we later "work" in self.args['work-dir'], but
     # files should be relative to our target_path.
@@ -398,10 +406,18 @@ def path_substitutions_relative_to_work_dir(exec_list : list, info_str : str, ta
             # need this, and we can't assume dir levels in the work-dir.
             try:
                 try_path = os.path.abspath(os.path.join(os.path.abspath(target_path), m.group(1)))
-                if os.path.isfile(try_path) or os.path.isdir(try_path):
+                if enable_filepath_subst and  os.path.isfile(try_path):
+                    # make the substitution
+                    exec_list[i] = word.replace(m.group(1), try_path)
+                    debug(f'file path substitution {info_str=} {target_path=}: replaced - {word=}'
+                          f'is now ={exec_list[i]}. This can be disabled in DEPS with:',
+                          '"filepath-subst-targetdir: false"')
+                elif enable_dirpath_subst and os.path.isdir(try_path):
                     # make the substitution
                     exec_list[i] = word.replace(m.group(1), try_path)
-                    debug(f'path substitution {info_str=} {target_path=}: replaced - {word=} is now ={exec_list[i]}')
+                    debug(f'dir path substitution {info_str=} {target_path=}: replaced - {word=}'
+                          f'is now ={exec_list[i]}. This can be disabled in DEPS with:',
+                          '"dirpath-subst-targetdir: false"')
             except:
                 pass
 
@@ -1034,7 +1050,10 @@ class DepsProcessor:
 
 
 
-def parse_deps_shell_str(line : str, target_path : str, target_node : str, enable : bool = True):
+def parse_deps_shell_str(line: str, target_path: str, target_node: str,
+                         enable_filepath_subst_target_dir: bool = True,
+                         enable_dirpath_subst_target_dir: bool = False,
+                         enable: bool = True) -> dict:
     '''Returns None or a dict of a possible shell command from line (str)
 
      Examples of 'line' str:
@@ -1050,25 +1069,30 @@ def parse_deps_shell_str(line : str, target_path : str, target_node : str, enabl
     target_node (str) -- from dependency parsing, the target containing this 'line' str.
     '''
     if not enable:
-        return None
+        return {}
 
     m = re.match(r'^\s*shell\@(.*)\s*$', line)
     if not m:
-        return None
+        return {}
 
     exec_str = m.group(1)
     exec_list = exec_str.split()
 
     # Look for path substitutions, b/c we later "work" in self.args['work-dir'], but
     # files should be relative to our target_path.
-    exec_list = path_substitutions_relative_to_work_dir(exec_list=exec_list, info_str='shell@', target_path=target_path)
+    # Note this can be disable in DEPS via path-subst-target-dir=False
+    exec_list = path_substitutions_relative_to_work_dir(
+        exec_list=exec_list, info_str='shell@', target_path=target_path,
+        enable_filepath_subst=enable_filepath_subst_target_dir,
+        enable_dirpath_subst=enable_dirpath_subst_target_dir
+    )
 
-    d = {'target_path': os.path.abspath(target_path),
-         'target_node': target_node,
-         'run_from_work_dir': True,
-         'exec_list': exec_list,
-         }
-    return d
+    return {
+        'target_path': os.path.abspath(target_path),
+        'target_node': target_node,
+        'run_from_work_dir': True, # may be overriden later.
+        'exec_list': exec_list,
+    }
 
 
 def parse_deps_work_dir_add_srcs(line : str, target_path : str, target_node : str, enable : bool = True):
@@ -1100,8 +1124,12 @@ def parse_deps_work_dir_add_srcs(line : str, target_path : str, target_node : st
     return d
 
 
-def parse_deps_peakrdl(line : str, target_path : str, target_node : str, enable : bool = True,
-                       tool : str = ''):
+def parse_deps_peakrdl(
+        line: str, target_path: str, target_node: str, enable: bool = True,
+        enable_filepath_subst_target_dir: bool = True,
+        enable_dirpath_subst_target_dir: bool = False,
+        tool: str = ''
+) -> dict:
     '''Returns None or a dict describing a PeakRDL CSR register generator dependency
 
      Examples of 'line' str:
@@ -1172,10 +1200,13 @@ def parse_deps_peakrdl(line : str, target_path : str, target_node : str, enable
     # Make these look like a dep_shell_command:
     for one_cmd_as_list in shell_commands:
         ret_dict['shell_commands_list'].append(
-            parse_deps_shell_str(line = ' shell@ ' + ' '.join(one_cmd_as_list),
-                                 target_path = target_path,
-                                 target_node = target_node
-                                 )
+            parse_deps_shell_str(
+                line=(' shell@ ' + ' '.join(one_cmd_as_list)),
+                target_path=target_path,
+                target_node=target_node,
+                enable_filepath_subst_target_dir=enable_filepath_subst_target_dir,
+                enable_dirpath_subst_target_dir=enable_dirpath_subst_target_dir
+            )
         )
 
     # Make the work_dir_add_srcs dict:
@@ -1237,14 +1268,22 @@ def deps_commands_handler(config: dict, eda_args: dict,
             var_subst_dict = eda_args
 
         tee_fpath = command.get('tee', None)
-        run_from_work_dir = command.get('run-from-work-dir', True) # for shell, default True
+
+        # These are both optional bools, default True, would have to explicitly be set to False
+        # to take effect:
+        run_from_work_dir = command.get('run-from-work-dir', True)
+        filepath_subst_target_dir = command.get('filepath-subst-target-dir', True)
+        dirpath_subst_target_dir = command.get('dirpath-subst-target-dir', False)
 
         for key,item in command.items():
 
-            # skip the var-subst-* keys, since these types are bools
-            if key.startswith('var-subst') or \
-               key.startswith('tee') or \
-               key.startswith('run-from-work-dir'):
+            # skip the tee and var-subst-* keys, since these types are bools and not commands.
+            if key in ['tee',
+                       'var-subst-os-env',
+                       'var-subst-args',
+                       'run-from-work-dir',
+                       'filepath-subst-target-dir',
+                       'dirpath-subst-target-dir']:
                 continue
 
             # Optional variable substituion in commands
@@ -1255,9 +1294,11 @@ def deps_commands_handler(config: dict, eda_args: dict,
             if key == 'shell':
                 # For now, piggyback on parse_deps_shell_str:
                 ret_dict = parse_deps_shell_str(
-                    line = 'shell@ ' + item,
-                    target_path = target_path,
-                    target_node = target_node,
+                    line=('shell@ ' + item),
+                    target_path=target_path,
+                    target_node=target_node,
+                    enable_filepath_subst_target_dir=filepath_subst_target_dir,
+                    enable_dirpath_subst_target_dir=dirpath_subst_target_dir,
                     enable=config['dep_command_enables']['shell'],
                 )
                 # To support 'tee: <some-file>' need to append it to last
@@ -1286,6 +1327,8 @@ def deps_commands_handler(config: dict, eda_args: dict,
                     line = 'peakrdl@ ' + item,
                     target_path = target_path,
                     target_node = target_node,
+                    enable_filepath_subst_target_dir=filepath_subst_target_dir,
+                    enable_dirpath_subst_target_dir=dirpath_subst_target_dir,
                     enable=config['dep_command_enables']['peakrdl'],
                     tool=eda_args.get('tool', '')
                 )

{opencos_eda-0.2.46 → opencos_eda-0.2.47}/opencos/deps_schema.py

@@ -71,6 +71,12 @@ my_target_name:
         var-subst-os-env:            <---- bool, perform var substitution using os.environ
         run-from-work-dir:           <---- bool, default True, if False runs from target dir
                                            instead of work-dir.
+        filepath-subst-target-dir:   <---- bool, default True, if False does not perform
+                                           file path substitution relative to target dir
+                                           (if substituted file exists).
+        dirpath-subst-target-dir:    <---- bool, default False, if True performs
+                                           directory path substitution relative to target dir
+                                           (if substituted directory exists).
         tee:                         <---- string, filename to write logs to
       - work-dir-add-sources:        <---- work-dir-add-sources, optional list (or string)
         - some_file_gen_from_sh.sv   <---- string filename that we created with sh command
@@ -153,6 +159,8 @@ DEPS_COMMANDS_LIST = [
         Optional('var-subst-args'): bool,
         Optional('var-subst-os-env'): bool,
         Optional('run-from-work-dir'): bool,
+        Optional('filepath-subst-target-dir'): bool,
+        Optional('dirpath-subst-target-dir'): bool,
         Optional('tee'): Or(str, type(None)),
     },
     {

{opencos_eda-0.2.46 → opencos_eda-0.2.47}/opencos/tests/test_deps_helpers.py

@@ -14,7 +14,7 @@ from opencos import eda_tool_helper, deps_helpers
 
 THISPATH = os.path.dirname(__file__)
 
-# Figure out what tools the system has available, without calling eda.main(..)
+# Figure out what tools the system has avail, without calling eda.main(..)
 config, tools_loaded = eda_tool_helper.get_config_and_tools_loaded()
 
 
@@ -58,63 +58,100 @@ def test_get_all_targets_eda_multi():
 def test_parse_deps_shell_str__no_parse():
     line = 'some_file.sv'
     d = deps_helpers.parse_deps_shell_str(line, '', '')
-    assert d is None, f'{d=}'
+    assert not d, f'{d=}'
 
     line = 'some_target:'
     d = deps_helpers.parse_deps_shell_str(line, '', '')
-    assert d is None, f'{d=}'
+    assert not d, f'{d=}'
 
     line = '   csr@some_file.sv'
     d = deps_helpers.parse_deps_shell_str(line, '', '')
-    assert d is None, f'{d=}'
+    assert not d, f'{d=}'
 
 def test_parse_deps_shell_str__cp():
     line = '    shell@ cp ./oclib_fifo_test.sv oclib_fifo_test_COPY.sv ;'
     d = deps_helpers.parse_deps_shell_str(line, '', '')
-    assert d is not None, f'{d=}'
+    assert d, f'{d=}'
     assert d['exec_list'] == ['cp', './oclib_fifo_test.sv', 'oclib_fifo_test_COPY.sv', ';'], f'{d=}'
 
 def test_parse_deps_shell_str__echo():
     line = '    shell@echo "hello world"'
     d = deps_helpers.parse_deps_shell_str(line, '', '')
-    assert d is not None, f'{d=}'
+    assert d, f'{d=}'
     assert d['exec_list'] == ['echo', '"hello', 'world"'], f'{d=}'
 
-def test_parse_deps_shell_str__path_replacement():
+def test_parse_deps_shell_str__enable_filepath_replacement():
     # Dealing w/ relative paths, change the current working directory to the module directory
+    # Default is enabled.
     module_dir = os.path.dirname(os.path.abspath(__file__))
     os.chdir(module_dir)
     line = 'shell@cp ../deps_helpers.py foo.py'
     d = deps_helpers.parse_deps_shell_str(line, target_path='./', target_node='foo_target')
-    assert d is not None, f'{d=}'
+    assert d, f'{d=}'
     assert d['exec_list'] == ['cp', os.path.abspath('../deps_helpers.py'), 'foo.py'], f'{d=}'
     assert d['target_node'] == 'foo_target'
     assert d['target_path'] == os.path.abspath('./')
 
+def test_parse_deps_shell_str__disable_filepath_replacement():
+    # Dealing w/ relative paths, change the current working directory to the module directory
+    module_dir = os.path.dirname(os.path.abspath(__file__))
+    os.chdir(module_dir)
+    line = 'shell@cp ../deps_helpers.py foo.py'
+    d = deps_helpers.parse_deps_shell_str(line, target_path='./', target_node='foo_target',
+                                          enable_filepath_subst_target_dir=False)
+    assert d, f'{d=}'
+    assert d['exec_list'] == ['cp', '../deps_helpers.py', 'foo.py'], f'{d=}'
+    assert d['target_node'] == 'foo_target'
+    assert d['target_path'] == os.path.abspath('./')
+
+def test_parse_deps_shell_str__enable_dirpath_replacement():
+    # Dealing w/ relative paths, change the current working directory to the module directory
+    module_dir = os.path.dirname(os.path.abspath(__file__))
+    os.chdir(module_dir)
+    line = 'shell@ls -ltr ./'
+    d = deps_helpers.parse_deps_shell_str(line, target_path='./', target_node='foo_target',
+                                          enable_dirpath_subst_target_dir=True)
+    assert d, f'{d=}'
+    assert d['exec_list'] == ['ls', '-ltr', os.path.abspath('./')], f'{d=}'
+    assert d['target_node'] == 'foo_target'
+    assert d['target_path'] == os.path.abspath('./')
+
+def test_parse_deps_shell_str__disable_dirpath_replacement():
+    # Dealing w/ relative paths, change the current working directory to the module directory
+    # Default is disabled.
+    module_dir = os.path.dirname(os.path.abspath(__file__))
+    os.chdir(module_dir)
+    line = 'shell@ls -ltr ./'
+    d = deps_helpers.parse_deps_shell_str(line, target_path='./', target_node='foo_target')
+    assert d, f'{d=}'
+    assert d['exec_list'] == ['ls', '-ltr', './'], f'{d=}'
+    assert d['target_node'] == 'foo_target'
+    assert d['target_path'] == os.path.abspath('./')
+
 
 def test_parse_deps_work_dir_add_srcs__no_parse():
     line = 'some_file.sv'
     d = deps_helpers.parse_deps_work_dir_add_srcs(line, '', '')
-    assert d is None, f'{d=}'
+    assert not d, f'{d=}'
 
     line = 'some_target:'
     d = deps_helpers.parse_deps_work_dir_add_srcs(line, '', '')
-    assert d is None, f'{d=}'
+    assert not d, f'{d=}'
 
     line = '   csr@some_file.sv'
     d = deps_helpers.parse_deps_work_dir_add_srcs(line, '', '')
-    assert d is None, f'{d=}'
+    assert not d, f'{d=}'
 
 def test_parse_deps_work_dir_add_srcs__single_file():
     line = '    work_dir_add_srcs@ single_file.txt'
     d = deps_helpers.parse_deps_work_dir_add_srcs(line, '', '')
-    assert d is not None, f'{d=}'
+    assert d, f'{d=}'
     assert d['file_list'] == ['single_file.txt']
 
 def test_parse_deps_work_dir_add_srcs__several_file():
     line = '    work_dir_add_srcs@ single_file.txt another.sv  gen-verilog/mine.v ./gen-vhdl/wordy.vhdl'
     d = deps_helpers.parse_deps_work_dir_add_srcs(line, '', '')
-    assert d is not None, f'{d=}'
+    assert d, f'{d=}'
     assert d['file_list'] == [
         'single_file.txt', 'another.sv', 'gen-verilog/mine.v', './gen-vhdl/wordy.vhdl'
     ]
@@ -123,33 +160,33 @@ def test_parse_deps_work_dir_add_srcs__several_file():
 def test_parse_deps_peakrdl__no_parse():
     line = 'some_file.sv'
     d = deps_helpers.parse_deps_peakrdl(line, '', '')
-    assert d is None, f'{d=}'
+    assert not d, f'{d=}'
 
     line = 'some_target:'
     d = deps_helpers.parse_deps_peakrdl(line, '', '')
-    assert d is None, f'{d=}'
+    assert not d, f'{d=}'
 
     line = '   csr@some_file.sv'
     d = deps_helpers.parse_deps_peakrdl(line, '', '')
-    assert d is None, f'{d=}'
+    assert not d, f'{d=}'
 
 def test_parse_deps_peakrdl__with_top():
     line = '    peakrdl@ --cpuif axi4-lite-flat --top   my_fancy_csrs ./my_csrs.rdl'
     d = deps_helpers.parse_deps_peakrdl(line, '', '')
-    assert d is not None, f'{d=}'
+    assert d, f'{d=}'
     assert len(d['shell_commands_list']) > 0
     assert d['work_dir_add_srcs']['file_list'] == ['peakrdl/my_fancy_csrs_pkg.sv', 'peakrdl/my_fancy_csrs.sv']
 
 def test_parse_deps_peakrdl__with_top2():
     line = '    peakrdl@ --cpuif axi4-lite-flat --top=my_fancy_csrs ./my_csrs.rdl'
     d = deps_helpers.parse_deps_peakrdl(line, '', '')
-    assert d is not None, f'{d=}'
+    assert d, f'{d=}'
     assert len(d['shell_commands_list']) > 0
     assert d['work_dir_add_srcs']['file_list'] == ['peakrdl/my_fancy_csrs_pkg.sv', 'peakrdl/my_fancy_csrs.sv']
 
 def test_parse_deps_peakrdl__infer_top():
     line = '    peakrdl@ --cpuif axi4-lite-flat ./my_csrs.rdl'
     d = deps_helpers.parse_deps_peakrdl(line, '', '')
-    assert d is not None, f'{d=}'
+    assert d, f'{d=}'
     assert len(d['shell_commands_list']) > 0
     assert d['work_dir_add_srcs']['file_list'] == ['peakrdl/my_csrs_pkg.sv', 'peakrdl/my_csrs.sv']

{opencos_eda-0.2.46 → opencos_eda-0.2.47}/opencos/tools/vivado.py

@@ -136,7 +136,7 @@ class CommandSimVivado(CommandSim, ToolVivado):
     def __init__(self, config: dict):
         CommandSim.__init__(self, config)
         ToolVivado.__init__(self, config=self.config)
-        # add args specific to this simulator
+        # add args specific to this tool
         self.args.update({
             'gui':        False,
             'tcl-file':   'sim.tcl',
@@ -349,7 +349,7 @@ class CommandElabVivado(CommandSimVivado):
     '''CommandElabVivado is a command handler for: eda elab --tool=vivado, uses xvlog, xelab'''
     def __init__(self, config: dict):
         CommandSimVivado.__init__(self, config)
-        # add args specific to this simulator
+        # add args specific to this tool
         self.args['stop-after-elaborate'] = True
 
 
@@ -358,7 +358,7 @@ class CommandSynthVivado(CommandSynth, ToolVivado):
     def __init__(self, config: dict):
         CommandSynth.__init__(self, config)
         ToolVivado.__init__(self, config=self.config)
-        # add args specific to this simulator
+        # add args specific to this tool
         self.args['gui'] = False
         self.args['tcl-file'] = "synth.tcl"
         self.args['xdc'] = ""
@@ -401,9 +401,7 @@ class CommandSynthVivado(CommandSynth, ToolVivado):
         defines = ""
         for key, value in self.defines.items():
             defines += (f"-verilog_define {key}" + (" " if value is None else f"={value} "))
-        incdirs = ""
-        if self.incdirs:
-            incdirs = " -include_dirs " + ";".join(self.incdirs)
+        incdirs = ' '.join([f'-include_dirs {x}' for x in self.incdirs])
         flatten = ""
         if self.args['flatten-all']:
             flatten = "-flatten_hierarchy full"
@@ -547,7 +545,7 @@ class CommandProjVivado(CommandProj, ToolVivado):
     def __init__(self, config: dict):
         CommandProj.__init__(self, config)
         ToolVivado.__init__(self, config=self.config)
-        # add args specific to this simulator
+        # add args specific to this tool
         self.args['gui'] = True
         self.args['oc-vivado-tcl'] = True
         self.args['tcl-file'] = "proj.tcl"
@@ -630,10 +628,11 @@ class CommandBuildVivado(CommandBuild, ToolVivado):
     def __init__(self, config: dict):
         CommandBuild.__init__(self, config)
         ToolVivado.__init__(self, config=self.config)
-        # add args specific to this simulator
+        # add args specific to this tool
         self.args['gui'] = False
         self.args['fpga'] = ""
         self.args['proj'] = False
+        self.args['resynth'] = False
         self.args['reset'] = False
         self.args['all-sv'] = False
 
@@ -705,6 +704,8 @@ class CommandBuildVivado(CommandBuild, ToolVivado):
         ]
         if self.args['proj']:
             command_list += ['--proj']
+        if self.args['resynth']:
+            command_list += ['--resynth']
         if self.args['reset']:
             command_list += ['--reset']
 
@@ -732,7 +733,7 @@ class CommandUploadVivado(CommandUpload, ToolVivado):
     def __init__(self, config: dict):
         CommandUpload.__init__(self, config)
         ToolVivado.__init__(self, config=self.config)
-        # add args specific to this simulator
+        # add args specific to this tool
         self.args.update({
             'gui': False,
             'bitfile': "",
@@ -743,8 +744,10 @@ class CommandUploadVivado(CommandUpload, ToolVivado):
             'device': -1,
             'host': "localhost",
             'port': 3121,
-            'tcl-file': "upload.tcl",
             'all-sv': False,
+            'tcl-file': "eda_upload.tcl",
+            'log-file': "eda_upload.log",
+            'test-mode': False,
         })
         # TODO(drew): Add self.args_help.update({...})
 
@@ -825,7 +828,7 @@ class CommandUploadVivado(CommandUpload, ToolVivado):
 
         # ── Generate TCL script ───────────────────────────────────────────────────
         script_file = Path(self.args['tcl-file'])
-        log_file    = Path("eda_upload.log")
+        log_file    = Path(self.args['log-file'])
 
         try:
             with script_file.open("w", encoding="utf-8") as fout:
@@ -924,6 +927,9 @@ class CommandUploadVivado(CommandUpload, ToolVivado):
             command_list.append('-notrace')
         self.exec(Path(util.getcwd()), command_list)
 
+        if not self.args['keep']:
+            os.unlink(self.args['tcl-file'])
+
         util.info("Upload done")
 
 
@@ -935,7 +941,7 @@ class CommandOpenVivado(CommandOpen, ToolVivado):
     def __init__(self, config: dict):
         CommandOpen.__init__(self, config)
         ToolVivado.__init__(self, config=self.config)
-        # add args specific to this simulator
+        # add args specific to this tool
         self.args['gui'] = True
         self.args['file'] = False
         self.args['all-sv'] = False

{opencos_eda-0.2.46 → opencos_eda-0.2.47/opencos_eda.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.46
+Version: 0.2.47
 Summary: A simple Python package for wrapping RTL simuliatons and synthesis
 Author-email: Simon Sabato <simon@cognichip.ai>, Drew Ranck <drew@cognichip.ai>
 Project-URL: Homepage, https://github.com/cognichip/opencos

{opencos_eda-0.2.46 → opencos_eda-0.2.47}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [project]
 name = "opencos-eda"
-version = "0.2.46"
+version = "0.2.47"
 dependencies = [
   # opencos/eda.py dependencies
   "mergedeep >= 1.3.4",