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

{opencos_eda-0.3.6/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.6
+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
@@ -17,11 +17,13 @@ Requires-Dist: toml>=0.10.2
 Requires-Dist: yamllint>=1.35.1
 Requires-Dist: PySerial>=3.5
 Requires-Dist: supports_color>=0.2.0
-Requires-Dist: cocotb>=2.0
-Requires-Dist: pytest>=8.3.5
-Requires-Dist: coverage>=7.6.1
 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.6 → 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.6 → 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.6 → 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')
 

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

@@ -20,8 +20,8 @@ from pathlib import Path
 
 import opencos
 from opencos import util, eda_config, eda_base
-from opencos.util import safe_emoji
-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
@@ -76,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)
@@ -95,22 +95,24 @@ def usage(tokens: list, config: dict, command: str = "", tool: str = "") -> int:
     '''
 
     if command == "":
-        print(
-f"""
-{safe_emoji("🔦 ")}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(
-f"""
-{safe_emoji("❕ ")}where <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
 
@@ -527,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()})")
 
@@ -537,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

{opencos_eda-0.3.6 → opencos_eda-0.3.7}/opencos/eda_base.py

@@ -26,7 +26,7 @@ from opencos import eda_config
 
 from opencos.util import Colors, safe_emoji
 from opencos.utils.str_helpers import sprint_time, strip_outer_quotes, string_or_space, \
-    indent_wrap_long_text, pretty_list_columns_manual
+    indent_wrap_long_text, pretty_list_columns_manual, get_terminal_columns
 from opencos.utils.subprocess_helpers import subprocess_run_background
 from opencos.utils import status_constants
 
@@ -42,6 +42,24 @@ def print_base_help() -> None:
     print(get_argparser_short_help())
 
 
+def print_eda_usage_line(no_targets: bool = False, command_name='COMMAND') -> None:
+    '''Prints line for eda [options] COMMAND [options] FILES|TARGETS,...'''
+    print(f'{safe_emoji("🔦 ")}Usage:')
+    if no_targets:
+        print(
+            (f'    {Colors.bold}{Colors.yellow}eda {Colors.cyan}[options]'
+             f' {Colors.yellow}{command_name} {Colors.cyan}[options]{Colors.normal}')
+        )
+    else:
+        print(
+            (f'    {Colors.bold}{Colors.yellow}eda {Colors.cyan}[options]'
+             f' {Colors.yellow}{command_name} {Colors.cyan}[options]'
+             f' {Colors.yellow}FILES|TARGETS,...{Colors.normal}')
+        )
+    print()
+
+
+
 def get_argparser() -> argparse.ArgumentParser:
     '''Returns the ArgumentParser for general eda CLI'''
     parser = argparse.ArgumentParser(
@@ -82,7 +100,7 @@ def get_argparsers_args_list() -> list:
 
 
 def get_eda_exec(command: str = '') -> str:
-    '''Returns the full path of `eda` executable to be used for a given eda <command>'''
+    '''Returns the full path of `eda` executable to be used for a given eda COMMAND'''
     # NOTE(drew): This is kind of flaky. 'eda multi' reinvokes 'eda'. But the executable for 'eda'
     # is one of:
     # 1. pip3 install opencos-eda
@@ -133,6 +151,17 @@ def which_tool(command: str, config: dict) -> str:
     return tool
 
 
+def get_class_tool_name(command_obj: object) -> str:
+    '''Attempts to return command_obj._TOOL via command_obj.get_tool_name()'''
+    if f := getattr(command_obj, 'get_tool_name', None):
+        if callable(f):
+            ret = f()
+            if ret and isinstance(ret, str):
+                return ret
+    return ''
+
+
+
 class Tool:
     '''opencos.eda_base.Tool is a base class used by opencos.tools.<name>.
 
@@ -182,6 +211,10 @@ class Tool:
                 util.info(f'Override for {self._TOOL} using exe {exe}')
                 self._EXE = exe
 
+    def get_tool_name(self) -> str:
+        '''Returns _TOOL'''
+        return str(self._TOOL)
+
     def get_full_tool_and_versions(self) -> str:
         '''Returns tool:version, such as: verilator:5.033'''
         if not self._VERSION:
@@ -198,7 +231,7 @@ class Tool:
 
 
 class Command: # pylint: disable=too-many-public-methods
-    '''Base class for all: eda <command>
+    '''Base class for all: eda COMMAND
 
     The Command class should be used when you don't require files, otherwise consider
     CommandDesign.
@@ -235,21 +268,54 @@ class Command: # pylint: disable=too-many-public-methods
             'error-unknown-args': True,
         })
         self.args_help.update({
-            'stop-before-compile': ('stop this run before any compile (if possible for tool) and'
-                                    ' save .sh scripts in eda-dir/'),
-            'eda-dir':     'relative directory where eda logs are saved',
+            'keep': (
+                'Determined by eda <tool>, generally prevents jobs from overwriting artifacts'
+            ),
+            'force': 'Determined by eda <tool>, force override',
+            'fake': (
+                'Determined by eda <tool>, generally is a dry-run that does not execute tool'
+            ),
+            'stop-before-compile': (
+                'stop this run before any compile steps (if possible for tool) and'
+                ' save .sh scripts in eda-dir/'
+            ),
+            'stop-after-compile': (
+                'stop this run after any compile steps (if possible for tool) and'
+                ' save .sh scripts in eda-dir/'
+            ),
+            'stop-after-elaborate': (
+                'stop this run after any elaborate steps (if possible for tool) and'
+                ' save .sh scripts in eda-dir/'
+            ),
+            'lint': 'tool dependent, run with linting options',
+            "job-name" : 'Optional, used to create a sub directory under base work-dir (eda-dir)',
+            "sub-work-dir" : (
+                'Optional, similar to job-name, can be used to name the directory created under'
+                ' eda-dir'
+            ),
+            'eda-dir':   'Optional, relative base directory where eda logs are saved',
             'export':      'export results for these targets in eda-dir',
             'export-run':  'export, and run, results for these targets in eda-dir',
             'export-json': 'export, and save a JSON file per target',
-            'work-dir':    ('Optional override for working directory, often defaults to'
-                            ' ./eda.work/<top>.<command>'),
+            'work-dir':    ('Optional override for working directory, if unset will often use '
+                            ' ./eda.work/[TOP|TARGET].COMMAND'),
             "work-dir-use-target-dir": ('Set the work-dir to be the same as the in-place location'
                                        ' where the target (DEPS) exists'),
-            'enable-tags': ('DEPS markup tag names to be force enabled for this'
-                            ' command (mulitple appends to list).'),
-            'diable-tags': ('DEPS markup tag names to be disabled (even if they'
-                            ' match the criteria) for this command (mulitple appends to list).'
-                            ' --disable-tags has higher precedence than --enable-tags.'),
+            "suffix": (
+                "Optional, determined by eda COMMAND, used by 'multi' jobs information logging"
+            ),
+            "design": (
+                "Optional, used to override both the work-dir, and if unset the top DEPS target"
+            ),
+            'enable-tags': (
+                'DEPS markup tag names to be force enabled for this'
+                ' command (mulitple appends to list).'
+            ),
+            'disable-tags': (
+                'DEPS markup tag names to be disabled (even if they match the criteria) for this'
+                ' command (mulitple appends to list). --disable-tags has higher precedence than'
+                ' --enable-tags.'
+            ),
             'test-mode': ('command and tool dependent, usually stops the command early without'
                           ' executing.'),
             'error-unknown-args': (
@@ -356,7 +422,7 @@ class Command: # pylint: disable=too-many-public-methods
     ) -> str:
         '''Creates the working directory and populates self.args['work-dir']
 
-        Generally uses ./ self.args['eda-dir'] / <target-name>.<command> /
+        Generally uses ./ self.args['eda-dir'] / TARGET-NAME.COMMAND /
         however, self.args['job-name'] or ['sub-work-dir'] can override that.
 
         Additionally, the work-dir is attempted to be deleted if it already exists
@@ -619,20 +685,33 @@ class Command: # pylint: disable=too-many-public-methods
             # is []. If the parsed Namespace has values set to None or [], we do not update. This
             # means that as deps are processed that have args set, they cannot override the top
             # level args that were already set, nor be overriden by defaults.
-            if isinstance(value, bool):
-                # For bool, support --key and --no-key with action=argparse.BooleanOptionalAction.
-                # Note, this means you cannot use --some-bool=True, or --some-bool=False, has to
-                # be --some-bool or --no-some-bool.
-                parser.add_argument(
-                    *arguments, default=None, **bool_action_kwargs, **help_kwargs)
-            elif isinstance(value, (list, set)):
-                parser.add_argument(*arguments, default=value, action='append', **help_kwargs)
-            elif isinstance(value, (int, str)):
-                parser.add_argument(*arguments, default=value, type=type(value), **help_kwargs)
-            elif value is None:
-                parser.add_argument(*arguments, default=None, **help_kwargs)
-            else:
-                assert False, f'{key=} {value=} how do we do argparse for this type of value?'
+            try:
+                if isinstance(value, bool):
+                    # For bool, support --key and --no-key with
+                    # action=argparse.BooleanOptionalAction. Note, this means you cannot use
+                    # --some-bool=True, or --some-bool=False, has to be --some-bool or
+                    # --no-some-bool.
+                    # Also we cannot have self.args.keys() that start with 'no-', which is
+                    # why this entire thing is wrapped with try/except.
+                    parser.add_argument(
+                        *arguments, default=None, **bool_action_kwargs, **help_kwargs)
+                elif isinstance(value, (list, set)):
+                    parser.add_argument(*arguments, default=value, action='append', **help_kwargs)
+                elif isinstance(value, (int, str)):
+                    parser.add_argument(*arguments, default=value, type=type(value), **help_kwargs)
+                elif value is None:
+                    parser.add_argument(*arguments, default=None, **help_kwargs)
+                else:
+                    assert False, f'{key=} {value=} how do we do argparse for this type of value?'
+            except Exception as e:
+                if isinstance(value, bool):
+                    self.error(f'Could not add argument: {key=} {value=} {type(value)=}',
+                               f'{arguments=} {bool_action_kwargs=} {help_kwargs=} {e=}')
+                else:
+                    self.error(f'Could not add argument: {key=} {value=} {type(value)=}',
+                               f'{arguments=} {help_kwargs=} {e=}')
+
+
 
         return parser
 
@@ -730,7 +809,7 @@ class Command: # pylint: disable=too-many-public-methods
     def get_command_from_unparsed_args(
             self, tokens: list, error_if_no_command: bool = True
     ) -> str:
-        '''Given a list of unparsed args, try to fish out the eda <command> value.
+        '''Given a list of unparsed args, try to fish out the eda COMMAND value.
 
         This will remove the value from the tokens list.
         '''
@@ -742,7 +821,7 @@ class Command: # pylint: disable=too-many-public-methods
                 break
 
         if not ret and error_if_no_command:
-            self.error(f"Looking for a valid eda {self.command_name} <command>",
+            self.error(f"Looking for a valid eda {self.command_name} COMMAND",
                        f"but didn't find one in {tokens=}",
                        error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR)
         return ret
@@ -808,19 +887,16 @@ class Command: # pylint: disable=too-many-public-methods
         if self.args_help has additional help information.
         '''
 
-        # Indent long lines (>100) to indent=56 (this is where we leave off w/ {vstr:12} below.
-        def indent_me(text:str):
-            return indent_wrap_long_text(text, width=100, indent=56)
+        # Indent long lines (>100) to indent=24 (this is where usual argparse help leaves off)
+        def indent_me(text: str, initial_indent: int = 23):
+            return indent_wrap_long_text(
+                ' ' * initial_indent + text, width=get_terminal_columns(), indent=24
+            )
 
-        util.info('Help:')
+        util.info('Help:', color=Colors.cyan)
         # using bare 'print' here, since help was requested, avoids --color and --quiet
         print()
-        print(f'{safe_emoji("🔦 ")}Usage:')
-        if no_targets:
-            print(f'    eda [options] {self.command_name} [options]')
-        else:
-            print(f'    eda [options] {self.command_name} [options] [files|targets, ...]')
-        print()
+        print_eda_usage_line(no_targets=no_targets, command_name=self.command_name)
 
         print_base_help()
         lines = []
@@ -829,10 +905,18 @@ class Command: # pylint: disable=too-many-public-methods
             return
 
         if self.command_name:
-            lines.append(f"{safe_emoji('🔧 ')}Generic help for command='{self.command_name}'"
-                         f" (using '{self.__class__.__name__}')")
+            line = (
+                f"{safe_emoji('🔧 ')}{Colors.cyan}Generic help for"
+                f" command={Colors.byellow}{self.command_name}{Colors.cyan}"
+            )
+            if tool := get_class_tool_name(self):
+                line += f" tool={Colors.byellow}{tool}"
+            line += f" {Colors.normal}(using '{self.__class__.__name__}')"
+            lines.append(line)
         else:
-            lines.append("{safe_emoji('🔧 ')}Generic help (from class Command):")
+            lines.append(
+                f"{safe_emoji('🔧 ')}{Colors.cyan}Generic help:{Colors.normal}"
+            )
 
         # Attempt to run argparser on args, but don't error if it fails.
         unparsed = []
@@ -842,44 +926,46 @@ class Command: # pylint: disable=too-many-public-methods
             except Exception:
                 pass
 
-        for k in sorted(self.args.keys()):
-            v = self.args[k]
-            vstr = str(v)
-            khelp = self.args_help.get(k, '')
-            if khelp:
-                khelp = f'  - {khelp}'
-            if isinstance(v, bool):
-                lines.append(indent_me(f"  --{k:20} : boolean    : {vstr:12}{khelp}"))
-            elif isinstance(v, int):
-                lines.append(indent_me(f"  --{k:20} : integer    : {vstr:12}{khelp}"))
-            elif isinstance(v, list):
-                lines.append(indent_me(f"  --{k:20} : list       : {vstr:12}{khelp}"))
-            elif isinstance(v, str):
-                vstr = "'" + v + "'"
-                lines.append(indent_me(f"  --{k:20} : string     : {vstr:12}{khelp}"))
-            else:
-                lines.append(indent_me(f"  --{k:20} : <unknown>  : {vstr:12}{khelp}"))
+        short_help_lines = util.get_argparser_short_help(
+            parser=self.get_argparser(support_underscores=False)
+        ).split('\n')
+        short_help_lines.pop(0) # Strip first line w/ argparser prog name
+        lines.extend(short_help_lines)
+
+        # For these custom args, -GParameter=Value, +define+Name[=value] +incdir+path
+        # make colors to look like python >= 3.14, if that is our version.
+        color = Colors()
+        if sys.version_info.major < 3 or \
+           (sys.version_info.major == 3 and sys.version_info.minor < 14):
+            color.disable() # strip our color object if < 3.14
+
 
         lines.append('')
+        lines.append(
+            f"  {color.cyan}-G{color.byellow}<parameterName>{color.normal}=" \
+            + f"{color.yellow}<value>{color.normal}"
+        )
         lines.append(indent_me((
-            "  -G<parameterName>=<value>      "
             " Add parameter to top level, support bit/int/string types only."
             " Example: -GDEPTH=8 (DEPTH treated as SV int/integer)."
             " -GENABLE=1 (ENABLED treated as SV bit/int/integer)."
             " -GName=eda (Name treated as SV string \"eda\")."
         )))
+
+        lines.append(f"  {color.cyan}+define+{color.byellow}<defineName>{color.normal}")
         lines.append(indent_me((
-            "  +define+<defineName>           "
             " Add define w/out value to tool ahead of SV sources"
             " Example: +define+SIM_SPEEDUP"
         )))
+        lines.append(
+            f"  {color.cyan}+define+{color.byellow}<defineName>{color.normal}=" \
+            + f"{color.yellow}<value>{color.normal}")
         lines.append(indent_me((
-            "  +define+<defineName>=<value>   "
             " Add define w/ value to tool ahead of SV sources"
             " Example: +define+TECH_LIB=2 +define+FULL_NAME=\"E D A\""
         )))
+        lines.append(f"  {color.cyan}+incdir+{color.byellow}PATH{color.normal}")
         lines.append(indent_me((
-            "  +incdir+<path>                 "
             " Add path (absolute or relative) for include directories"
             " for SystemVerilog `include \"<some-file>.svh\""
             " Example: +incdir+../lib"

{opencos_eda-0.3.6 → opencos_eda-0.3.7}/opencos/tests/deps_files/command_order/DEPS.yml

@@ -29,3 +29,16 @@ target_test_with_post_tool_commands:
           run-after-tool: true
     - target_echo_hi_bye
   top: foo
+
+
+test_run_from_work_dir:
+  deps:
+    - commands:
+        - shell: echo "pwd=$PWD"
+          run-from-work-dir: true
+
+test_run_from_work_dir_false:
+  deps:
+    - commands:
+        - shell: echo "pwd=$PWD"
+          run-from-work-dir: false

{opencos_eda-0.3.6 → opencos_eda-0.3.7}/opencos/tests/helpers.py

@@ -10,8 +10,8 @@ from pathlib import Path
 from contextlib import redirect_stdout, redirect_stderr
 
 from opencos import eda, eda_tool_helper, deps_schema
-from opencos.utils.markup_helpers import yaml_safe_load
 from opencos.utils import status_constants
+from opencos.utils.markup_helpers import yaml_safe_load
 from opencos.utils.subprocess_helpers import subprocess_run_background
 
 # Figure out what tools the system has available, without calling eda.main(..)
@@ -238,7 +238,7 @@ class Helpers:
 
     def log_it(
             self, command_str: str, logfile=None, use_eda_wrap: bool = True,
-            run_in_subprocess: bool = False,
+            run_in_subprocess: bool = False, include_default_log: bool = False,
             preserve_env: bool = False
     ) -> int:
         '''Replacement for calling eda.main or eda_wrap, when you want an internal logfile
@@ -257,13 +257,17 @@ class Helpers:
         logfile = self._resolve_logfile(logfile)
         rc = 50
 
+        eda_log_arg = '--no-default-log'
+        if include_default_log:
+            eda_log_arg = ''
+
         # TODO(drew): There are some issues with log_it redirecting stdout from vivado
         # and modelsim_ase. So this may not work for all tools, you may have to directly
         # look at eda.work/{target}.sim/sim.log or xsim.log.
         print(f'{os.getcwd()=}')
         print(f'{command_str=}')
         if run_in_subprocess or self.RUN_IN_SUBPROCESS:
-            command_list = ['eda', '--no-default-log'] + command_str.split()
+            command_list = ['eda', eda_log_arg] + command_str.split()
             _, _, rc = subprocess_run_background(
                 work_dir=self.DEFAULT_DIR,
                 command_list=command_list,
@@ -275,9 +279,9 @@ class Helpers:
             with open(logfile, 'w', encoding='utf-8') as f:
                 with redirect_stdout(f), redirect_stderr(f):
                     if use_eda_wrap or self.USE_EDA_WRAP:
-                        rc = eda_wrap('--no-default-log', *(command_str.split()))
+                        rc = eda_wrap(eda_log_arg, *(command_str.split()))
                     else:
-                        rc = eda.main('--no-default-log', *(command_str.split()))
+                        rc = eda.main(eda_log_arg, *(command_str.split()))
                 print(f'Wrote: {os.path.abspath(logfile)=}')
 
         if self.PRESERVE_ENV or preserve_env:

{opencos_eda-0.3.6 → opencos_eda-0.3.7}/opencos/tests/test_eda.py

@@ -648,7 +648,7 @@ class TestsRequiresIVerilog(Helpers):
         print(f'{rc=}')
         assert rc == 0
         assert self.is_in_log('Detected iverilog')
-        assert self.is_in_log("Generic help for command='sim' (using 'CommandSimIverilog')")
+        assert self.is_in_log("Generic help for command=sim tool=iverilog")
 
     def test_iverilog_sim(self):
         '''Test for command sim'''

{opencos_eda-0.3.6 → opencos_eda-0.3.7}/opencos/tests/test_tools.py

@@ -3,6 +3,7 @@
 # pylint: disable=R0801 # (similar lines in 2+ files)
 
 import os
+import shutil
 import sys
 import pytest
 
@@ -32,14 +33,19 @@ def test_tools_loaded():
     assert config
     assert len(config.keys()) > 0
 
+
     # It's possible we're running in some container or install that has no tools, for example,
     # Windows.
     if sys.platform.startswith('win') and \
        not helpers.can_run_eda_command('elab', 'sim', cfg=config):
-        # Windows, not handlers for elab or sim:
+        # Windows, no handlers for elab or sim:
         pass
     else:
-        assert len(tools_loaded) > 0
+        basic_tools_available_via_path = any(shutil.which(x) for x in (
+            'verilator', 'iverilog', 'xsim', 'vsim', 'slang', 'yosys'
+        ))
+        if basic_tools_available_via_path:
+            assert len(tools_loaded) > 0
 
     def version_checker(
             obj: eda_base.Tool, chk_str: str
@@ -49,7 +55,7 @@ def test_tools_loaded():
         assert chk_str in full_ver, f'{chk_str=} not in {full_ver=}'
         ver_num = full_ver.rsplit(':', maxsplit=1)[-1]
         if 'b' in ver_num:
-            ver_num = ver_num.split('b')[0] # TODO(chaitanya): remove once cocotb 2.0 is released
+            ver_num = ver_num.split('b')[0]
         if '.' in ver_num:
             major_ver = ver_num.split('.')[0]
             assert major_ver.isdigit(), (

{opencos_eda-0.3.6 → opencos_eda-0.3.7}/opencos/tools/verilator.py

@@ -76,7 +76,6 @@ class VerilatorSim(CommandSim, ToolVerilator):
         ToolVerilator.__init__(self, config=self.config)
         self.args.update({
             'gui': False,
-            'tcl-file': None,
             'dump-vcd': False,
             'waves-fst': True,
             'waves-vcd': False,
@@ -95,7 +94,7 @@ class VerilatorSim(CommandSim, ToolVerilator):
                 ' plusarg and apply $dumpfile("dump.fst").'
             ),
             'waves-fst': (
-                '(Default True) If using --waves, apply simulation runtime arg +trace.'
+                'If using --waves, apply simulation runtime arg +trace.'
                 ' Note that if you do not have SV code using $dumpfile, eda will add'
                 ' _waves_pkg.sv to handle this for you with +trace runtime plusarg.'
             ),

{opencos_eda-0.3.6 → opencos_eda-0.3.7}/opencos/tools/yosys.py

@@ -70,9 +70,9 @@ class ToolYosys(Tool):
                 [self.sta_exe, '-version'], capture_output=True, check=False
             )
             util.debug(f'{self.yosys_exe} {sta_version_ret=}')
-            sta_ver = sta_version_ret.stdout.decode('utf-8', errors='replace').split()[0]
-            if sta_ver:
-                self.sta_version = sta_ver
+            sta_ver = sta_version_ret.stdout.decode('utf-8', errors='replace').split()
+            if sta_ver and isinstance(sta_ver, list):
+                self.sta_version = sta_ver[0]
 
         version_ret = subprocess.run(
             [self.yosys_exe, '--version'], capture_output=True, check=False

{opencos_eda-0.3.6 → opencos_eda-0.3.7}/opencos/util.py

@@ -54,7 +54,11 @@ class Colors:
     red = "\x1B[31m"
     green = "\x1B[32m"
     yellow = "\x1B[33m" # This looks orange, but it's techincally yellow
+    cyan = "\x1b[36m"
     foreground = "\x1B[39m"
+    bold = "\x1B[1m"
+    byellow = "\x1B[1m\x1B[33m"
+    bcyan = "\x1B[1m\x1b[36m"
     normal = "\x1B[0m"
 
     @staticmethod
@@ -67,6 +71,14 @@ class Colors:
             return color + text + "\x1B[0m" # (normal)
         return text
 
+    def disable(self) -> None:
+        '''Clears all color str in class Colors, to prevent print() methods that use
+        util.Colors from printing color'''
+        for x in dir(self):
+            if not callable(getattr(self, x, None)) and isinstance(x, str) and \
+               not x.startswith('_'):
+                setattr(self, x, '')
+
 
 def safe_emoji(emoji: str, default: str = '') -> str:
     '''Returns emoji character if args['emoji'] is True'''
@@ -421,7 +433,7 @@ def get_argparser_short_help(parser: object = None) -> str:
             break
 
     # skip the line that says 'options:', replace with the progname:
-    return f'{parser.prog}:\n' + '\n'.join(full_lines[lineno + 1:])
+    return f'{Colors.cyan}{parser.prog}:{Colors.normal}\n' + '\n'.join(full_lines[lineno + 1:])
 
 
 def process_token(arg: list) -> bool:
@@ -533,13 +545,14 @@ def process_tokens( # pylint: disable=too-many-branches
     global debug_level # pylint: disable=global-statement
     debug_level = 0
 
-    # Deal with --debug, --debug-level, --env-file, -f/--input-file(s) tokens first,
-    # for now put dot-f file contents in front of of tokens, do this first in a
-    # separate custom argparser:
+    # Deal with --version, --debug, --debug-level, --env-file, -f/--input-file(s)
+    # tokens first, for now put dot-f file contents in front of of tokens, do this first
+    # in a separate custom argparser:
     bool_action_kwargs = get_argparse_bool_action_kwargs()
     parser = argparse.ArgumentParser(
         prog='opencos -f/--input-file', add_help=False, allow_abbrev=False
     )
+    parser.add_argument('--version', default=False, action='store_true')
     parser.add_argument('--debug', **bool_action_kwargs,
                         help='Display additional debug messaging level 1 or higher')
     parser.add_argument('--debug-level', type=int, default=0,
@@ -560,6 +573,10 @@ def process_tokens( # pylint: disable=too-many-branches
     except argparse.ArgumentError:
         error(f'util -f/--input-file, problem attempting to parse_known_args for: {tokens}')
 
+    if parsed.version:
+        # Stop processing, return nothing, caller can print version and exit.
+        return parsed, []
+
     process_debug_args(parsed=parsed)
     debug(f'util.process_tokens: {parsed=} {unparsed=} from: {tokens}')
 
@@ -599,6 +616,9 @@ def process_tokens( # pylint: disable=too-many-branches
         warning(f'python error, nested -f/--input-file(s) {parsed.input_file} should',
                 'have already been resolved')
 
+    if not parsed.color:
+        Colors.disable(Colors) # strip strings in Colors class
+
     # 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)
@@ -836,7 +856,9 @@ def error(
     global max_error_code # pylint: disable=global-statement
 
     if start is None:
-        start = "ERROR: " + (f"[{progname}] " if progname_in_message else "")
+        start = f"{Colors.bold}ERROR:{Colors.normal}{Colors.red} "
+        if progname_in_message:
+            start += f"[{progname}] "
         start += safe_emoji("❌ ")
     args['errors'] += 1
     max_error_code = max(max_error_code, error_code)

{opencos_eda-0.3.6 → opencos_eda-0.3.7}/opencos/utils/subprocess_helpers.py

@@ -6,7 +6,9 @@ import subprocess
 import sys
 
 import psutil
+from opencos import util
 from opencos.util import debug, error, info, warning, progname, global_log
+from opencos.utils.str_helpers import strip_ansi_color
 
 IS_WINDOWS = sys.platform.startswith('win')
 
@@ -68,7 +70,7 @@ def subprocess_run_background( # pylint: disable=too-many-branches
 
     proc_kwargs = {'shell': shell,
                    'stdout': subprocess.PIPE,
-                   'stderr': subprocess.STDOUT,
+                   'stderr': subprocess.STDOUT
                    }
     if work_dir:
         proc_kwargs['cwd'] = work_dir
@@ -101,14 +103,29 @@ def subprocess_run_background( # pylint: disable=too-many-branches
             error(f'Unable to open file "{tee_fpath}" for writing, {e}')
 
     for line in iter(proc.stdout.readline, b''):
-        line = line.rstrip().decode("utf-8", errors="replace")
+        line = line.decode("utf-8", errors="replace") # leave \n intact
+
+        # Since we don't control what the subprocess command did, if it
+        # thinks we support color, but user ran with --no-color, we need to strip ANSI colors:
+        if not util.args['color']:
+            line = strip_ansi_color(line)
+
+        # Print the line with color, if --color:
         if not background:
-            print(line)
+            print(line, end='')
+
+        # for all logs, and the returned stdout str, if we haven't stripped color yet,
+        # we need to now, before writing to tee_fpath_f, or to global_log:
+        if util.args['color']:
+            line = strip_ansi_color(line)
+        line = line.replace('\r', '') # remove CR
+
         if tee_fpath_f:
-            tee_fpath_f.write(line + '\n')
+            tee_fpath_f.write(line)
         if global_log.file:
-            global_log.write(line, '\n')
-        stdout += line + '\n'
+            # directly write to file handle, avoid util.UtilLogger.write(line, end='')
+            global_log.file.write(line)
+        stdout += line
 
     proc.communicate()
     remove_completed_parent_pid(proc.pid)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.6
+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
@@ -17,11 +17,13 @@ Requires-Dist: toml>=0.10.2
 Requires-Dist: yamllint>=1.35.1
 Requires-Dist: PySerial>=3.5
 Requires-Dist: supports_color>=0.2.0
-Requires-Dist: cocotb>=2.0
-Requires-Dist: pytest>=8.3.5
-Requires-Dist: coverage>=7.6.1
 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.6 → opencos_eda-0.3.7}/opencos_eda.egg-info/requires.txt

@@ -8,12 +8,15 @@ toml>=0.10.2
 yamllint>=1.35.1
 PySerial>=3.5
 supports_color>=0.2.0
+
+[cocotb]
 cocotb>=2.0
 pytest>=8.3.5
 coverage>=7.6.1
 
 [dev]
 pylint>=3.0.0
+pytest>=8.3.5
 
 [docs]
 mkdocs

{opencos_eda-0.3.6 → opencos_eda-0.3.7}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [project]
 name = "opencos-eda"
-version = "0.3.6"
+version = "0.3.7"
 dependencies = [
   # opencos/eda.py dependencies
   "mergedeep >= 1.3.4",
@@ -16,10 +16,6 @@ dependencies = [
   # opencos/oc_cli.py dependencies
   "PySerial >= 3.5",
   "supports_color >= 0.2.0",
-  # cocotb, pytest + coverage no longer optional.
-  "cocotb >= 2.0",
-  "pytest >= 8.3.5",
-  "coverage >= 7.6.1", # For python3.10, we could go >= 7.11.3
 ]
 requires-python = ">= 3.8"
 authors = [
@@ -31,6 +27,14 @@ description = "A simple Python package for wrapping RTL simuliatons and synthesi
 [project.optional-dependencies]
 dev = [
   "pylint >= 3.0.0",
+  "pytest >= 8.3.5",
+]
+cocotb = [
+  # cocotb is optional. You may want to set env COCOTB_IGNORE_PYTHON_REQUIRES
+  # cocotb set a maximum python version
+  "cocotb >= 2.0",
+  "pytest >= 8.3.5",
+  "coverage >= 7.6.1", # For python3.10, we could go >= 7.11.3
 ]
 docs = [
   "mkdocs",