opencos-eda 0.2.49__tar.gz → 0.2.50__tar.gz

{opencos_eda-0.2.49/opencos_eda.egg-info → opencos_eda-0.2.50}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.49
+Version: 0.2.50
 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.49 → opencos_eda-0.2.50}/opencos/commands/multi.py

@@ -590,7 +590,7 @@ class CommandToolsMulti(CommandMulti):
     def multi_which_tools(self, command):
         '''Overrides CommandMulti.multi_which_tool(command), return a list of all
         possible tools that can run this command'''
-        if self.tools is None or len(self.tools) == 0:
+        if self.tools is None or not self.tools:
             # wasn't set via arg --tools, so use all if possible for this command.
             which_tools = self.all_handler_commands.get(command, [])
         else:

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/commands/sim.py

@@ -177,6 +177,11 @@ class CommandSim(CommandDesign):
                     filename=log_fname, bad_strings=bad_strings, must_strings=must_strings,
                     use_bad_strings=use_bad_strings, use_must_strings=use_must_strings
                 )
+            if log_fname:
+                self.artifacts_add(
+                    name=os.path.join(self.args['work-dir'], log_fname),
+                    typ='text', description='Simulator stdout/stderr log file'
+                )
 
     def do_export(self) -> None:
         '''CommandSim helper for handling args --export*

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/eda_base.py

@@ -257,10 +257,15 @@ class Command:
         if self.args['work-dir']:
             if not self.errors_log_f:
                 try:
+                    fullpath = os.path.join(self.args['work-dir'], 'eda.errors.log')
                     self.errors_log_f = open( # pylint: disable=consider-using-with
-                        os.path.join(self.args['work-dir'], 'eda.errors.log'), 'w',
-                        encoding='utf-8'
+                        fullpath, 'w', encoding='utf-8'
                     )
+                    util.artifacts.add(
+                        name=fullpath,
+                        typ='text', description='EDA reported errors'
+                    )
+
                 except FileNotFoundError:
                     pass
             if self.errors_log_f:
@@ -374,8 +379,16 @@ class Command:
         if self.args['keep']:
             open(keep_file, 'w', encoding='utf-8').close() # pylint: disable=consider-using-with
             util.debug(f'create_work_dir: created {keep_file=}')
+
+        # Set the util.artifacts path with our work-dir:
+        util.artifacts.set_artifacts_json_dir(self.args['work-dir'])
+
         return self.args['work-dir']
 
+    def artifacts_add(self, name: str, typ: str, description: str) -> None:
+        '''Adds a file to util.artifacts, derived classes may override'''
+        util.artifacts.add(name=name, typ=typ, description=description)
+
 
     def exec(self, work_dir: str, command_list: list, background: bool = False,
              stop_on_error: bool = True, quiet: bool = False, tee_fpath: str = '',

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/eda_config.py

@@ -308,6 +308,11 @@ def write_eda_config_and_args(
         # Use deep copy b/c otherwise these are references to opencos.eda.
         data[x] = copy.deepcopy(getattr(command_obj_ref, x, ''))
 
+    # copy util.args
+    data['util'] = {
+        'args': util.args
+    }
+
     # fix some burried class references in command_obj_ref.config,
     # otherwise we won't be able to safe load this yaml, so cast as str repr.
     for k, v in getattr(command_obj_ref, 'config', {}).items():

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/eda_config_defaults.yml

@@ -230,17 +230,39 @@ tools:
     compile-args: |
       -sv -svinputport=net -lint
     compile-waivers:
-      - 2275 # 2275 - Existing package 'foo_pkg' will be overwritten.
-      - 2555 # 2555 - assignment to input port foo
+      - 2275 # 2275 - Existing package 'myname_pkg' will be overwritten.
+      - 2555 # 2555 - assignment to input port myname
       - 2583 # 2583 - [SVCHK] - Extra checking for conflicts with always_comb and
              #        always_latch variables is done at vopt time.
     simulate-waivers:
-      - 3009 # 3009: [TSCALE] - Module 'foo' does not have a timeunit/timeprecision
+      - 3009 # 3009: [TSCALE] - Module 'myname' does not have a timeunit/timeprecision
              #       specification in effect, but other modules do.
     simulate-waves-args: |
       +acc
 
 
+  questa_fse:
+    defines:
+      OC_TOOL_QUESTA_FSE: 1
+    log-bad-strings:
+      - "Error:"
+    log-must-strings:
+      - " vsim "
+      - "Errors: 0"
+    compile-args: |
+      -sv -svinputport=net -lint
+    compile-waivers:
+      - 2275 # 2275 - Existing package 'myname_pkg' will be overwritten.
+      - 2555 # 2555 - assignment to input port myname
+      - 2583 # 2583 - [SVCHK] - Extra checking for conflicts with always_comb and
+             #        always_latch variables is done at vopt time.
+    simulate-waivers:
+      - 3009 # 3009: [TSCALE] - Module 'myname' does not have a timeunit/timeprecision
+             #       specification in effect, but other modules do.
+    simulate-waves-args: |
+      -voptargs=+acc=bcgnprst
+
+
   iverilog:
     log-bad-strings:
       - "Error:"
@@ -303,7 +325,7 @@ auto_tools_order:
     # TODO(drew): surelog is disabled from `eda tools-multi`. It is still
     # enabled for `eda [multi] elab --tool surelog`. It does not support
     # type comparisons:
-    #   if type(foo) == type(bar)
+    #   if type(myname) == type(othername)
     # [ERR:UH0700] ... Unsupported expression
     # modelsim_ase also doesn't, but it won't fail elab, whereas surelog does.
     surelog:
@@ -404,6 +426,16 @@ auto_tools_order:
         elab: opencos.tools.modelsim_ase.CommandElabModelsimAse
         sim:  opencos.tools.modelsim_ase.CommandSimModelsimAse
 
+    questa_fse:  # free student edition, works similar to modelsim_ase
+      exe: vsim
+      requires_cmd:
+        - vsim -version
+      requires_in_exe_path:
+        - questa_fse
+      handlers:
+        elab: opencos.tools.questa_fse.CommandElabQuestaFse
+        sim:  opencos.tools.questa_fse.CommandSimQuestaFse
+
     iverilog:
       exe: iverilog
       handlers:

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/tests/test_eda_elab.py

@@ -22,7 +22,8 @@ list_of_elab_tools = [
     'slang',
     'verilator',
     'vivado',
-    'modelsim_ase',
+    'modelsim_ase'
+    'questa_fse',
     'invio',
     'surelog',
     'invio_yosys',

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/tests/test_tools.py

@@ -73,6 +73,7 @@ list_of_tools = [
     'verilator',
     'vivado',
     'modelsim_ase',
+    'questa_fse',
 ]
 
 list_of_deps_targets = [

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/tools/modelsim_ase.py

@@ -1,6 +1,8 @@
 ''' opencos.tools.modelsim_ase - Used by opencos.eda for sim/elab commands w/ --tool=modelsim_ase.
 
 Contains classes for ToolModelsimAse, CommandSimModelsimAse, CommandElabModelsimAse.
+
+Note that this is for 32-bit Modelsim Student Edition. Consider using --tool=questa_fse instead.
 '''
 
 # pylint: disable=R0801 # (duplicate code in derived classes, such as if-condition return.)
@@ -151,6 +153,9 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
                 ]):
             vlog_dot_f_lines += ['-suppress', str(waiver)]
 
+        if self.args['gui'] or self.args['waves']:
+            vlog_dot_f_lines += self.tool_config.get('compile-waves-args', '').split()
+
         vlog_dot_f_fname = filename
         vlog_dot_f_fpath = os.path.join(self.args['work-dir'], vlog_dot_f_fname)
 
@@ -203,6 +208,10 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
         voptargs_str = ""
         if self.args['gui'] or self.args['waves']:
             voptargs_str = self.tool_config.get('simulate-waves-args', '+acc')
+            util.artifacts.add_extension(
+                search_paths=self.args['work-dir'], file_extension='wlf',
+                typ='waveform', description='Modelsim/Questa Waveform WLF (Wave Log Format) file'
+            )
 
         # TODO(drew): support self.args['sim_libary', 'elab-args', sim-args'] (3 lists)
         # to add to vsim_one_liner.
@@ -331,6 +340,19 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
         return ' '.join(vsim_suppress_list)
 
 
+    def artifacts_add(self, name: str, typ: str, description: str) -> None:
+        '''Override from Command.artifacts_add, so we can catch known file
+
+        names to make their typ/description better, such as CommandSim using
+        sim.log
+        '''
+        _, leafname = os.path.split(name)
+        if leafname == 'sim.log':
+            description = 'Modelsim/Questa Transcript log file'
+
+        super().artifacts_add(name=name, typ=typ, description=description)
+
+
 class CommandElabModelsimAse(CommandSimModelsimAse):
     '''CommandElabModelsimAse is a command handler for: eda elab --tool=modelsim_ase'''
 

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/tools/questa.py

@@ -40,9 +40,11 @@ class ToolQuesta(Tool):
             self.error(f"{self._EXE} not in path, need to setup",
                        "(i.e. source /opt/intelFPGA_pro/23.4/settings64.sh")
             util.debug(f"{path=}")
-            if self._EXE.endswith('qrun') and 'modelsim_ase' in path:
-                util.warning(f"{self._EXE=} Questa path is for starter edition (modelsim_ase),",
-                             "consider using --tool modelsim_ase")
+            if self._EXE.endswith('qrun') and \
+               any(x in path for x in ('modelsim_ase', 'questa_fse')):
+                util.warning(f"{self._EXE=} Questa path is for starter edition",
+                             "(modelsim_ase, questa_fse), consider using --tool=modelsim_ase",
+                             "or --tool=questa_fse")
         else:
             self.sim_exe = path
             self.sim_exe_base_path, _ = os.path.split(path)

opencos_eda-0.2.50/opencos/tools/questa_fse.py

@@ -0,0 +1,57 @@
+''' opencos.tools.questa_fse - Used by opencos.eda for sim/elab commands w/ --tool=questa_fse.
+
+Contains classes for CommandSimQuestaFse, CommandElabQuestaFse.
+'''
+
+# pylint: disable=R0801 # (duplicate code in derived classes, such as if-condition return.)
+# pylint: disable=too-many-ancestors
+
+import os
+
+from opencos.tools.modelsim_ase import CommandSimModelsimAse
+
+
+class CommandSimQuestaFse(CommandSimModelsimAse):
+    '''CommandSimQuestaFse is a command handler for: eda sim --tool=questa_fse
+
+    Note this inherits 99% from CommandSimModelSimAse for command handling
+    '''
+    _TOOL = 'questa_fse'
+    _EXE = 'vsim'
+
+    def __init__(self, config: dict):
+        # this will setup with self._TOOL = modelsim_ase, which is not ideal so
+        # we have to repait it later.
+        CommandSimModelsimAse.__init__(self, config=config)
+
+        # repairs: override self._TOOL, and run get_versions() again.
+        self._TOOL = 'questa_fse'
+
+        self.shell_command = os.path.join(self.sim_exe_base_path, 'vsim')
+        self.starter_edition = True
+        self.args.update({
+            'tool': self._TOOL, # override
+            'gui': False,
+        })
+
+
+    def set_tool_defines(self):
+        '''Override from questa.ToolQuesta'''
+        # Update any defines from config.tools.questa_fse:
+        self.defines.update(
+            self.tool_config.get(
+                'defines',
+                # defaults, if not set:
+                {
+                 'OC_TOOL_QUESTA_FSE': 1
+                }
+            )
+        )
+
+
+class CommandElabQuestaFse(CommandSimQuestaFse):
+    '''CommandElabQuestaFse is a command handler for: eda elab --tool=questa_fse'''
+
+    def __init__(self, config:dict):
+        super().__init__(config)
+        self.args['stop-after-elaborate'] = True

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/tools/slang.py

@@ -191,14 +191,20 @@ class CommandElabSlang(CommandElab, ToolSlang):
 
         return command_list
 
-    def _get_slang_json_args(self, command_exe:str) -> list:
+    def _get_slang_json_args(self, command_exe: str) -> list:
         command_list = []
 
-        if self.args.get('slang-json', False) and command_exe == 'slang':
+        _, command_exe_leaf = os.path.split(command_exe)
+        if self.args.get('slang-json', False) and command_exe_leaf == 'slang':
             for arg in self.all_json_args:
                 if arg not in command_list:
                     command_list.append(arg)
                     if arg == '--ast-json': # needs filename
                         command_list.append('slang.json')
+                        util.artifacts.add(
+                            name=os.path.join(self.args['work-dir'], 'slang.json'),
+                            typ='json',
+                            description='Abstract syntax tree from slang --ast-json'
+                        )
 
         return command_list

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/tools/verilator.py

@@ -346,6 +346,16 @@ class VerilatorSim(CommandSim, ToolVerilator):
             util.info(f'--waves arg present, no $dumpfile found, adding SV file: {file_to_add}')
             self.add_file(file_to_add)
 
+        # register .vcd or .fst artifacts:
+        util.artifacts.add_extension(
+            search_paths=self.args['work-dir'], file_extension='fst',
+            typ='waveform', description='Simulation Waveform FST (Fast Signal Trace) file'
+        )
+        util.artifacts.add_extension(
+            search_paths=self.args['work-dir'], file_extension='vcd',
+            typ='waveform', description='Simulation Waveform VCD (Value Change Dump) file'
+        )
+
 
     def _get_start_verilator_command_list(self, lint_only: bool = False) -> list:
 
@@ -447,6 +457,21 @@ class VerilatorSim(CommandSim, ToolVerilator):
         return verilate_args
 
 
+    def artifacts_add(self, name: str, typ: str, description: str) -> None:
+        '''Override from Command.artifacts_add, so we can catch known file
+
+        names to make their typ/description better, such as CommandSim using
+        sim.log or compile.log
+        '''
+        _, leafname = os.path.split(name)
+        if leafname == 'sim.log':
+            description = 'Verilated executable log from stdout/stderr'
+        elif leafname == 'compile.log':
+            description = 'Verilator compile step log from verilator call'
+
+        super().artifacts_add(name=name, typ=typ, description=description)
+
+
 class VerilatorElab(VerilatorSim):
     '''VerilatorElab is a command handler for: eda elab --tool=verilator'''
 

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/tools/vivado.py

@@ -63,29 +63,14 @@ class ToolVivado(Tool):
             util.info("environment for XILINX_VIVADO is not set or doesn't match the vivado path:",
                       f"XILINX_VIVADO={xilinx_vivado} EXE PATH={self.vivado_exe}")
 
-        version = None
-        # Note this is commented out b/c it's a bit slow, up to 1.0 second to
-        # run their tool just to query the version information.
-        # Do this if you need the extra minor version like 2024.2.1.
-        #try:
-        #    # Get version from vivado -version, or xsim --version:
-        #    vivado_ret = subprocess.run(['vivado', '-version'], capture_output=True)
-        #    lines = vivado_ret.stdout.decode('utf-8', errors='replace').split('\n')
-        #    words = lines[0].split() # vivado v2024.2.1 (64-bit)
-        #    version = words[1][1:] # 2024.2.1
-        #    self._VERSION = version
-        #except:
-        #    pass
-
-        if not version:
-            # Get version based on install path name:
-            util.debug(f"vivado path = {self.vivado_exe}")
-            m = re.search(r'(\d\d\d\d)\.(\d)', self.vivado_exe)
-            if m:
-                version = m.group(1) + '.' + m.group(2)
-                self._VERSION = version
-            else:
-                self.error("Vivado path doesn't specificy version, expecting (dddd.d)")
+        # Get version based on install path name. Calling vivado -verison is too slow.
+        util.debug(f"vivado path = {self.vivado_exe}")
+        m = re.search(r'(\d\d\d\d)\.(\d)', self.vivado_exe)
+        if m:
+            version = m.group(1) + '.' + m.group(2)
+            self._VERSION = version
+        else:
+            self.error("Vivado path doesn't specificy version, expecting (dddd.d)")
 
         if version:
             numbers_list = version.split('.')
@@ -260,6 +245,14 @@ class CommandSimVivado(CommandSim, ToolVivado):
     def get_simulate_command_lists(self, **kwargs) -> list:
         # create TCL
         tcl_name = os.path.abspath(os.path.join(self.args['work-dir'], self.args['tcl-file']))
+
+        if self.args['waves']:
+            util.artifacts.add_extension(
+                search_paths=self.args['work-dir'], file_extension='wdb',
+                typ='waveform', description='Vivado XSim Waveform WDB (Wave DataBase) file'
+            )
+
+
         with open( tcl_name, 'w', encoding='utf-8' ) as fo:
             if self.args['waves']:
                 if self.args['waves-start']:
@@ -345,6 +338,23 @@ class CommandSimVivado(CommandSim, ToolVivado):
             self.files_v.insert(0, glbl_v)
 
 
+    def artifacts_add(self, name: str, typ: str, description: str) -> None:
+        '''Override from Command.artifacts_add, so we can catch known file
+
+        names to make their typ/description better, such as CommandSim using
+        sim.log or compile.log
+        '''
+        _, leafname = os.path.split(name)
+        if leafname == 'xsim.log':
+            description = 'Vivado XSim simulation step (3/3) log from stdout/stderr'
+        elif leafname == 'xelab.log':
+            description = 'Vivado XSim elaboration step (2/3) log from stdout/stderr'
+        elif leafname == 'xvlog.log':
+            description = 'Vivado XSim compile step (1/3) log from stdout/stderr'
+
+        super().artifacts_add(name=name, typ=typ, description=description)
+
+
 class CommandElabVivado(CommandSimVivado):
     '''CommandElabVivado is a command handler for: eda elab --tool=vivado, uses xvlog, xelab'''
     def __init__(self, config: dict):
@@ -933,9 +943,6 @@ class CommandUploadVivado(CommandUpload, ToolVivado):
         util.info("Upload done")
 
 
-
-
-
 class CommandOpenVivado(CommandOpen, ToolVivado):
     '''CommandOpenVivado command handler class used by: eda open --tool vivado'''
     def __init__(self, config: dict):

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/opencos/util.py

@@ -1,16 +1,19 @@
 '''opencos.util -- support global logging, argparser for printing (colors)'''
 
-import sys
-import subprocess
+import argparse
+import atexit
 import datetime
+import json
 import os
-import time
-import atexit
+import re
 import shutil
+import subprocess
+import sys
+import time
 import traceback
-import argparse
-import re
 
+from enum import Enum
+from pathlib import Path
 from importlib import import_module
 
 global_exit_allowed = False # pylint: disable=invalid-name
@@ -26,6 +29,7 @@ args = {                    # pylint: disable=invalid-name
     'fancy' : sys.stdout.isatty(),
     'warnings' : 0,
     'errors' : 0,
+    'artifacts-json': True,
 }
 
 class Colors:
@@ -70,6 +74,138 @@ def yellow_text(text: str) -> str:
         return Colors.yellow + text + Colors.normal
     return text
 
+class ArtifactTypes(Enum):
+    '''Types that are allow-listed for artifacts.add* methods. If you don't use one of
+    these, you'll get a warning'''
+    TEXT = 0
+    JSON = 1
+    YAML = 2
+    WAVEFORM = 3
+    DOTF = 4
+    TCL = 5
+    SHELL = 6
+
+class Artifacts:
+    '''Class to hold file artifacts, for logs generated by EDA, or other artifcats created
+    by a specific tool.
+
+    If enabled, will write out an artifacts.json file upon util.exit()
+    '''
+
+    data = {}
+    unresolved_data = {}
+    enabled = True
+    artifacts_json_filepath = os.path.join('eda.work', 'artifacts.json')
+
+    def _get_type_str(self, typ: str) -> (bool, str):
+        '''Gets the name from ArtifactTypes, and returns tuple of (True, str)
+
+        if the ArtifactTypes exists, else (False, str.upper())'''
+        ret = getattr(ArtifactTypes, typ.upper(), '')
+        if ret:
+            return True, ret.name.lower()
+        return False, typ.lower()
+
+    def add(self, name: str, typ: str, description: str = '') -> None:
+        '''Adds file to artifacts'''
+
+        if not self.enabled:
+            return # artifacts dumping disabled.
+
+        _, shortname = os.path.split(name)
+        if shortname in self.data:
+            return # artifact already registered
+
+        type_exists, type_str = self._get_type_str(typ)
+        if not type_exists:
+            warning(f'Unknown artifacts {typ=} add for {name=} {description=}')
+
+        self.data[shortname] = {
+            'name': name,
+            'type': type_str,
+            'size': 0, # will be filled in when JSON written upon exit.
+            'description': description,
+        }
+
+    def add_extension(
+            self, search_paths: list, file_extension: str, typ: str, description: str = ''
+    ) -> None:
+        '''Adds a placeholder for file extensions to add to artifacts
+
+        For example, when saving a Simulation waves, we may know it's a .fst or .vcd file,
+        but we do not know what the testbench SV file has set in $dumpfile(filepath)
+        '''
+        type_exists, type_str = self._get_type_str(typ)
+        if not type_exists:
+            warning(f'Unknown artifacts {typ=} add_extension for {search_paths=}',
+                    f'{file_extension=} {description=}')
+
+        if isinstance(search_paths, str):
+            sp = [search_paths]
+        else:
+            sp = search_paths
+        self.unresolved_data[file_extension] = {
+            'search_paths': sp,
+            'type': type_str,
+            'description': description
+        }
+
+    def set_artifacts_json_dir(self, dirpath: str) -> None:
+        '''Sets the artifacts_json_filepath'''
+        _, right = os.path.split(self.artifacts_json_filepath)
+        self.artifacts_json_filepath = os.path.join(dirpath, right)
+
+    def reset(self, enable: bool = True) -> None:
+        '''Clears internal data (dict). Called by util.process_tokens()'''
+        self.data = {}
+        self.unresolved_data = {}
+        self.enabled = enable or args['artifacts-json']
+        self.artifacts_json_filepath = os.path.join('eda.work', 'artifacts.json')
+
+    def _resolve_unresolved_data(self, ext: str) -> None:
+        '''Find files for this extension that were registered using add_extension(...)
+
+        adds to self.data'''
+        entry = self.unresolved_data[ext]
+        if not entry:
+            return
+
+        for search_path in entry['search_paths']:
+            p = Path(search_path)
+            for posix_filename in p.glob(f'*.{ext}'):
+                self.add(
+                    name=str(posix_filename), typ=entry['type'], description=entry['description']
+                )
+
+    def write_json(self) -> None:
+        '''Write out the artifacts.json file, called by util.exit()'''
+
+        if not self.enabled:
+            return # artifacts dumping disabled.
+
+        if self.unresolved_data:
+            for ext in self.unresolved_data:
+                self._resolve_unresolved_data(ext)
+
+        if not self.data:
+            return # do nothing if we have no artifacts
+
+        # Update all file sizes:
+        for key, entry in self.data.items():
+            if os.path.isfile(entry['name']):
+                entry['size'] = os.path.getsize(entry['name'])
+            else:
+                # file doesn't exist, remove it from artifacts.
+                warning(f'Removing {key} ({entry["name"]}) from artifacts (file does not exist)')
+                del self.data[key]
+
+        with open(self.artifacts_json_filepath, 'w', encoding='utf-8') as f:
+            json.dump(self.data, f, indent=4)
+            info(f'Wrote artifacts JSON: {self.artifacts_json_filepath}')
+
+
+artifacts = Artifacts()
+
 
 class UtilLogger:
     '''Class for the util.global_log'''
@@ -115,6 +251,8 @@ class UtilLogger:
             debug(f"Opened logfile '{filename}' for writing")
             self.filepath = filename
             self.write_timestamp(f'start - {self.filepath}')
+            # add to global artifacts:
+            artifacts.add(name=filename, typ='text', description='EDA stdout logfile')
         except Exception as e:
             error(f"Error opening '{filename}' for writing, {e}")
             self.clear()
@@ -213,6 +351,8 @@ def get_argparser() -> argparse.ArgumentParser:
     parser.add_argument('--no-respawn', action='store_true',
                         help=('Legacy mode (default respawn disabled) for respawning eda.py'
                               ' using $OC_ROOT/bin'))
+    parser.add_argument('--artifacts-json', **bool_action_kwargs,
+                        help='Store a work-dir/artifacts.json file of known tool output files')
     return parser
 
 
@@ -265,21 +405,29 @@ def process_tokens(tokens:list) -> (argparse.Namespace, list):
 
     debug(f'util.process_tokens: {parsed=} {unparsed=}  from {tokens=}')
 
+    # clear existing artifacts dicts (mostly for pytests repeatedly calling eda.main),
+    # set artifacts.enabled based on args['artifacts-json']
+    artifacts.reset(enable=parsed.artifacts_json)
+
     if parsed.force_logfile:
         start_log(parsed.force_logfile, force=True)
     elif parsed.logfile:
         start_log(parsed.logfile, force=False)
     elif parsed.default_log and \
+         not any(x in unparsed for x in ('help', '-h', '--help')) and \
          (parsed.force_logfile is None and parsed.logfile is None):
         # Use a forced logfile in the eda.work/eda.log:
+        # avoid this if someone has --help arg not yet parsed.
         start_log(global_log.default_log_filepath, force=True)
 
 
     parsed_as_dict = vars(parsed)
     for key,value in parsed_as_dict.items():
+        key = key.replace('_', '-')
         if value is not None:
             args[key] = value # only update with non-None values to our global 'args' dict
 
+
     return parsed, unparsed
 
 # ********************
@@ -500,6 +648,10 @@ def exit( # pylint: disable=redefined-builtin
         error_code: int = 0, quiet: bool = False
 ) -> int:
     '''sys.exit(int) wrapper, returns the error_code if global_exit_allowed=False'''
+
+    # Save out artifacts file:
+    artifacts.write_json()
+
     if global_exit_allowed:
         if not quiet:
             info(f"Exiting with {args['warnings']} warnings, {args['errors']} errors")

{opencos_eda-0.2.49 → opencos_eda-0.2.50/opencos_eda.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.49
+Version: 0.2.50
 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.49 → opencos_eda-0.2.50}/opencos_eda.egg-info/SOURCES.txt

@@ -71,6 +71,7 @@ opencos/tools/invio_yosys.py
 opencos/tools/iverilog.py
 opencos/tools/modelsim_ase.py
 opencos/tools/questa.py
+opencos/tools/questa_fse.py
 opencos/tools/riviera.py
 opencos/tools/slang.py
 opencos/tools/slang_yosys.py

{opencos_eda-0.2.49 → opencos_eda-0.2.50}/pyproject.toml

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