opencos-eda 0.3.5__tar.gz → 0.3.7__tar.gz

{opencos_eda-0.3.5/opencos_eda.egg-info → opencos_eda-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.5
+Version: 0.3.7
 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
@@ -16,11 +16,14 @@ Requires-Dist: schema>=0.7.7
 Requires-Dist: toml>=0.10.2
 Requires-Dist: yamllint>=1.35.1
 Requires-Dist: PySerial>=3.5
-Requires-Dist: cocotb>=2.0
 Requires-Dist: supports_color>=0.2.0
 Provides-Extra: dev
 Requires-Dist: pylint>=3.0.0; extra == "dev"
 Requires-Dist: pytest>=8.3.5; extra == "dev"
+Provides-Extra: cocotb
+Requires-Dist: cocotb>=2.0; extra == "cocotb"
+Requires-Dist: pytest>=8.3.5; extra == "cocotb"
+Requires-Dist: coverage>=7.6.1; extra == "cocotb"
 Provides-Extra: docs
 Requires-Dist: mkdocs; extra == "docs"
 Requires-Dist: mkdocs-material; extra == "docs"

{opencos_eda-0.3.5 → opencos_eda-0.3.7}/opencos/commands/flist.py

@@ -48,7 +48,7 @@ class CommandFList(CommandDesign):
             'bracket-quote-path' : False,
             'single-quote-path'  : False,
             'double-quote-path'  : False,
-            'no-quote-path'      : False,
+            'quote-path'         : True,
             'build-script'       : "", # we don't want this to error either
 
             'print-to-stdout': False,
@@ -122,7 +122,7 @@ class CommandFList(CommandDesign):
 
         pq1 = ""
         pq2 = "" # pq = path quote
-        if self.args['no-quote-path']:
+        if not self.args['quote-path']:
             pass # if we decide to make one of the below default, this will override
         elif self.args['bracket-quote-path']:
             pq1 = "{"

{opencos_eda-0.3.5 → opencos_eda-0.3.7}/opencos/commands/multi.py

@@ -28,7 +28,7 @@ class CommandMulti(CommandParallel):
             'fake': False,
             'parallel': 1,
             'single-timeout': None,
-            'fail-if-no-targets': False,
+            'fail-if-no-targets': True,
             'export-jsonl': False,
             'print-targets': False,
         }
@@ -325,8 +325,9 @@ class CommandMulti(CommandParallel):
             current_targets = len(self.targets)
         util.info(f"Multi: Expanded {target_globs} to {len(self.targets)} {command} targets")
 
-        if parsed.fail_if_no_targets and len(self.targets) == 0:
-            self.error(f'Multi: --fail-if-no-targets set, and {self.targets=}')
+        if self.args['fail-if-no-targets'] and not self.targets:
+            self.error(f'Multi: --fail-if-no-targets set, and {self.targets=}. Disable with',
+                       '--no-fail-if-no-targets, or see: eda multi --help')
         if not all_multi_tools:
             possible_tools = self.all_handler_commands.get(command, [])
             self.error(f'Multi: no tools to run for {command=}, available tools: {possible_tools}')

{opencos_eda-0.3.5 → opencos_eda-0.3.7}/opencos/commands/sim.py

@@ -59,11 +59,11 @@ class CommandSim(CommandDesign):
         self.args.update({
             "pre-sim-tcl": [],
             'compile-args': [],
+            'compile-waivers': [],
             'elab-args': [],
             'sim-args': [],
             'sim-plusargs': [], # lists are handled by 'set_arg(k,v)' so they append.
             'sim-library': [],
-            'compile-waivers': [],
             'sim-waivers': [],
             'coverage': False,
             'waves': False,
@@ -78,7 +78,13 @@ class CommandSim(CommandDesign):
             'verilate-args': [],
         })
         self.args_help.update({
+            'pre-sim-tcl': (
+                'Tool dependent, TCL file to run prior to simulation (if tool supports TCL)'
+            ),
             'compile-args': 'args added to sim/elab "compile" step',
+            'compile-waivers': (
+                'simulation tool depenent waivers by name, applied at compilation step'
+            ),
             'coverage': 'attempt to run coverage steps on the compile/elab/simulation',
             'elab-args':    'args added to sim/elab "elaboration" step, if required by tool',
             'log-bad-strings': 'strings that if present in the log will fail the simulation',
@@ -90,6 +96,10 @@ class CommandSim(CommandDesign):
             'sim-args':      'args added to final "simulation" step',
             'sim-plusargs':  ('"simulation" step run-time args passed to tool, these can also'
                               ' be set using --sim-plusargs=name[=value], or simply +name[=value]'),
+            'sim-library': 'named libraries added to simulation, tool dependent',
+            'sim-waivers': (
+                'simulation tool depenent waivers by name, applied at "simulation" step'
+            ),
             'stop-before-compile': ('Create work-dir sh scripts for compile/elab/simulate, but do'
                                     ' not run them.'),
             'stop-after-compile': 'Create work-dir sh scripts, but only run the compile step.',
@@ -97,10 +107,9 @@ class CommandSim(CommandDesign):
                                      ' simulation step.'),
             'top': 'Name of topmost Verilog/SystemVerilog module, or VHDL entity',
             'verilate-args': ('args added to "compile" step in Verilator simulation'
-                              ' (for --tool=verilator)'),
+                              ' (for --tool=verilator) these are identical to --compile-args'),
             'waves': 'Include waveforms, if possible for tool',
             'waves-start': 'Starting time of waveform capture, if possible for tool',
-            'work-dir': 'Optional override for working directory, defaults to ./eda.work/<top>.sim',
             'test-mode': ('stops the command early without executing, if --gui is present will'
                           ' instead test without spawning gui')
 
@@ -145,6 +154,7 @@ class CommandSim(CommandDesign):
             self.run_dep_commands()
             self.do_it()
             self.run_post_tool_dep_commands()
+            self.report_pass_fail()
         return unparsed
 
 
@@ -198,6 +208,9 @@ class CommandSim(CommandDesign):
 
             clist = list(obj).copy()
             tee_fpath = getattr(obj, 'tee_fpath', None)
+            work_dir = getattr(obj, 'work_dir', None)
+            if not work_dir:
+                work_dir = self.args['work-dir']
 
             util.debug(f'run_commands_check_logs: {clist=}, {tee_fpath=}')
 
@@ -207,24 +220,28 @@ class CommandSim(CommandDesign):
             if log_filename:
                 log_fname = log_filename
 
+
             _, stdout, _ = self.exec(
-                work_dir=self.args['work-dir'], command_list=clist, tee_fpath=tee_fpath
+                work_dir=work_dir, command_list=clist, tee_fpath=tee_fpath
             )
 
             if check_logs and log_fname:
                 # Note this call will check on stdout if not GUI, not opening the log_fname,
                 # but if this is GUI we normally lose stdout and have to open the log.
-                gui_mode = self.args.get('gui', False)
-                file_contents_str = '' if gui_mode else stdout
+                if self.args.get('gui', False):
+                    file_contents_str = ''
+                else:
+                    file_contents_str = stdout
+
                 self.check_logs_for_errors(
-                    filename=os.path.join(self.args['work-dir'], log_fname),
+                    filename=os.path.join(work_dir, log_fname),
                     file_contents_str=file_contents_str,
                     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),
+                    name=os.path.join(work_dir, log_fname),
                     typ='text', description='Simulator stdout/stderr log file'
                 )
 
@@ -253,6 +270,7 @@ class CommandSim(CommandDesign):
         tool = self.args.get('tool', None)
         # Certain args are allow-listed here
         deps_file_args = []
+        print(f'SUPER DREW DEBUG: {self.get_command_line_args()=}')
         for a in self.get_command_line_args():
             if any(a.startswith(x) for x in [
                     '--compile-args',
@@ -265,7 +283,8 @@ class CommandSim(CommandDesign):
                     '--stop-',
                     '--lint-',
                     '--verilate',
-                    '--verilator']):
+                    '--verilator',
+                    '--cocotb-test-']):
                 deps_file_args.append(a)
 
         export_obj.run(

{opencos_eda-0.3.5 → opencos_eda-0.3.7}/opencos/deps/deps_processor.py

@@ -10,7 +10,7 @@ import os
 from opencos import files
 from opencos import eda_config
 from opencos.util import debug, info, warning, error, read_tokens_from_dot_f, \
-    patch_args_for_dir
+    patch_args_for_dir, load_env_file
 from opencos.utils.str_helpers import dep_str2list
 from opencos.deps.deps_file import deps_target_get_deps_list
 from opencos.deps.deps_commands import deps_commands_handler
@@ -192,9 +192,15 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
         # Since some args (util.py, eda_config.py, eda.py) can only be handled from command
         # line, it would be nice if -f or --input-file is handled from DEPS, so we'll special
         # case that now. Recursively resolve -f / --input-file.
+        # Do similary for --env-file (also only supported in util.py)
         parser = argparse.ArgumentParser(
             prog='deps_processor -f/--input-file', add_help=False, allow_abbrev=False
         )
+        parser.add_argument('--env-file', default=[], action='append',
+                            help=(
+                                "dotenv file(s) to pass ENV vars, (default: .env loaded first,"
+                                " subsequent files' vars override .env"
+                            ))
         parser.add_argument('-f', '--input-file', default=[], action='append',
                             help=(
                                 'Input .f file to be expanded as eda args, defines, incdirs,'
@@ -225,7 +231,12 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
             # recurse until we've resolved nested .f files.
             return self.apply_args(args_list=tokens2)
 
-        tokens = tokens2 # if no --input-file values, keep parsing the remaining tokens2
+        if parsed.env_file:
+            for env_file in parsed.env_file:
+                load_env_file(env_file)
+
+        # if no --input-file/--env-file values, keep parsing the remaining tokens2:
+        tokens = tokens2
 
         # We have to special-case anything with --tool[=value] in tokens, otherwise
         # the user may think they were allowed to set --tool, but in our flow the Command handler

{opencos_eda-0.3.5 → opencos_eda-0.3.7}/opencos/eda.py

@@ -20,7 +20,8 @@ from pathlib import Path
 
 import opencos
 from opencos import util, eda_config, eda_base
-from opencos.eda_base import Tool, which_tool, get_eda_exec
+from opencos.util import safe_emoji, Colors
+from opencos.eda_base import Tool, which_tool, get_eda_exec, print_eda_usage_line
 from opencos.utils import vsim_helper, vscode_helper
 from opencos.utils.subprocess_helpers import subprocess_run_background
 from opencos.utils import status_constants, str_helpers, subprocess_helpers
@@ -75,7 +76,7 @@ def get_all_commands_help_str(config: dict) -> str:
         all_commands_help.append(f'    {key:<{max_command_str_len}} - {value.strip()}')
     if all_commands_help:
         all_commands_help = [
-            'Where <command> is one of:',
+            f'Where {Colors.byellow}COMMAND{Colors.normal} is one of:',
             '',
         ] + all_commands_help
     return '\n'.join(all_commands_help)
@@ -94,22 +95,24 @@ def usage(tokens: list, config: dict, command: str = "", tool: str = "") -> int:
     '''
 
     if command == "":
-        print(
-"""
-Usage:
-    eda [<options>] <command> [options] <files|targets, ...>
-"""
-        )
+        util.info('Help:', color=Colors.cyan)
+        print()
+        print_eda_usage_line()
         print(get_all_commands_help_str(config=config))
-        print(
-"""
-And <files|targets, ...> is one or more source file or DEPS markup file target,
-    such as .v, .sv, .vhd[l], .cpp files, or a target key in a DEPS.[yml|yaml|toml|json].
-    Note that you can prefix source files with `sv@`, `v@`, `vhdl@` or `cpp@` to
-    force use that file as systemverilog, verilog, vhdl, or C++, respectively.
-
-"""
-        )
+        print()
+        print(str_helpers.indent_wrap_long_text(
+            (
+                f'{safe_emoji("❕ ")}where {Colors.byellow}FILES|TARGETS{Colors.normal}'
+                ' is one or more source file or DEPS markup file target,'
+                ' such as .v, .sv, .vhd[l], .cpp files, or a target key in a'
+                f' {Colors.byellow}DEPS.[yml|yaml|toml|json]{Colors.normal}. Note that you can'
+                f' prefix source files with {Colors.bcyan}sv@{Colors.normal},'
+                f' {Colors.bcyan}v@{Colors.normal}, {Colors.bcyan}vhdl@{Colors.normal},'
+                f' or {Colors.bcyan}cpp@{Colors.normal}'
+                ' to force use that file as systemverilog, verilog, vhdl, or C++, respectively.'
+            ), width=str_helpers.get_terminal_columns(), indent=4
+        ))
+        print()
         eda_base.print_base_help()
         return 0
 
@@ -495,7 +498,7 @@ def check_command_handler_cls(command_obj:object, command:str, parsed_args) -> i
 def signal_handler(sig, frame) -> None: # pylint: disable=unused-argument
     '''Handles Ctrl-C, called by main_cli() if running from command line'''
     util.fancy_stop()
-    util.info('Received Ctrl+C...', start='\nINFO: [EDA] ')
+    util.error(f'{safe_emoji("❌ ")}Received Ctrl+C...', start='\nINFO: [EDA] ')
     subprocess_helpers.cleanup_all()
     util.exit(-1)
 
@@ -526,7 +529,7 @@ def main(*args):
         sys.exit(0)
 
     if not util.args['quiet']:
-        util.info(f'eda: version {opencos.__version__}')
+        util.info(f'eda: version {opencos.__version__}', color=Colors.bcyan)
         # And show the command that was run (all args):
         util.info(f"main: eda {' '.join(args)}; (run from {os.getcwd()})")
 
@@ -536,7 +539,7 @@ def main(*args):
     # Note - we used to call: config = init_config(config=config)
     # However, we now defer calling init_config(..) until eda.process_tokens(..)
 
-    util.info("*** OpenCOS EDA ***")
+    util.info("*** OpenCOS EDA ***", color=Colors.bcyan)
 
     if len(args) == 0 or (len(args) == 1 and '--debug' in args):
         # special snowflake case if someone called with a singular arg --debug