opencos-eda 0.3.1__tar.gz → 0.3.2__tar.gz

{opencos_eda-0.3.1/opencos_eda.egg-info → opencos_eda-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.1
+Version: 0.3.2
 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.3.1 → opencos_eda-0.3.2}/opencos/deps/deps_file.py

@@ -249,8 +249,11 @@ class DepsFile:
                 self.rel_deps_file = os.path.join(os.path.relpath(deps_path), deps_leaf)
 
         self.error = getattr(command_design_ref, 'error', None)
+        self.error_ifarg = getattr(command_design_ref, 'error_ifarg', None)
         if not self.error:
             self.error = util.error
+        if not self.error_ifarg:
+            self.error_ifarg = util.error
 
 
     def found(self) -> bool:
@@ -320,19 +323,28 @@ class DepsFile:
                 # If we don't have caller_info, likely came from command line (or DEPS JSON data):
                 if '.' in target_node:
                     # Likely a filename (target_node does not include path)
-                    self.error(f'Trying to resolve command-line target={t_full} (file?):',
-                               f'File={t_node} not found in directory={t_path}',
-                               error_code=EDA_DEPS_FILE_NOT_FOUND)
+                    self.error_ifarg(
+                        f'Trying to resolve command-line target={t_full} (file?):',
+                        f'File={t_node} not found in directory={t_path}',
+                        arg='error-unknown-args',
+                        error_code=EDA_DEPS_FILE_NOT_FOUND
+                    )
                 elif not self.rel_deps_file:
                     # target, but there's no DEPS file
-                    self.error(f'Trying to resolve command-line target={t_full}:',
-                               f'but path {t_path} has no DEPS markup file (DEPS.yml)',
-                               error_code=EDA_DEPS_FILE_NOT_FOUND)
+                    self.error_ifarg(
+                        f'Trying to resolve command-line target={t_full}:',
+                        f'but path {t_path} has no DEPS markup file (DEPS.yml)',
+                        arg='error-unknown-args',
+                        error_code=EDA_DEPS_FILE_NOT_FOUND
+                    )
                 else:
                     self.warning_show_available_targets()
-                    self.error(f'Trying to resolve command-line target={t_full}:',
-                               f'was not found in deps_file={self.rel_deps_file}',
-                               error_code=EDA_DEPS_TARGET_NOT_FOUND)
+                    self.error_ifarg(
+                        f'Trying to resolve command-line target={t_full}:',
+                        f'was not found in deps_file={self.rel_deps_file}',
+                        arg='error-unknown-args',
+                        error_code=EDA_DEPS_TARGET_NOT_FOUND
+                    )
 
             else:
                 # If we have caller_info, then this was a recursive call from another
@@ -340,22 +352,31 @@ class DepsFile:
 
                 if '.' in target_node:
                     # Likely a filename (target_node does not include path)
-                    self.error(f'Trying to resolve target={t_full} (file?):',
-                               f'called from {caller_info},',
-                               f'File={t_node} not found in directory={t_path}',
-                               error_code=EDA_DEPS_FILE_NOT_FOUND)
+                    self.error_ifarg(
+                        f'Trying to resolve target={t_full} (file?):',
+                        f'called from {caller_info},',
+                        f'File={t_node} not found in directory={t_path}',
+                        arg='error-unknown-args',
+                        error_code=EDA_DEPS_FILE_NOT_FOUND
+                    )
                 elif not self.rel_deps_file:
                     # target, but there's no DEPS file
-                    self.error(f'Trying to resolve target={t_full}:',
-                               f'called from {caller_info},',
-                               f'but {t_path} has no DEPS markup file (DEPS.yml)',
-                               error_code=EDA_DEPS_FILE_NOT_FOUND)
+                    self.error_ifarg(
+                        f'Trying to resolve target={t_full}:',
+                        f'called from {caller_info},',
+                        f'but {t_path} has no DEPS markup file (DEPS.yml)',
+                        arg='error-unknown-args',
+                        error_code=EDA_DEPS_FILE_NOT_FOUND
+                    )
                 else:
                     self.warning_show_available_targets()
-                    self.error(f'Trying to resolve target={t_full}:',
-                               f'called from {caller_info},',
-                               f'Target not found in deps_file={self.rel_deps_file}',
-                               error_code=EDA_DEPS_TARGET_NOT_FOUND)
+                    self.error_ifarg(
+                        f'Trying to resolve target={t_full}:',
+                        f'called from {caller_info},',
+                        f'Target not found in deps_file={self.rel_deps_file}',
+                        arg='error-unknown-args',
+                        error_code=EDA_DEPS_TARGET_NOT_FOUND
+                    )
         else:
             debug(f'Found {target_node=} in deps_file={self.rel_deps_file}')
             found_target = True

{opencos_eda-0.3.1 → opencos_eda-0.3.2}/opencos/eda_base.py

@@ -250,7 +250,9 @@ class Command: # pylint: disable=too-many-public-methods
                             ' --disable-tags has higher precedence than --enable-tags.'),
             'test-mode': ('command and tool dependent, usually stops the command early without'
                           ' executing.'),
-            'error-unknown-args': 'Enable errors on unknown/unparsable args',
+            'error-unknown-args': (
+                'Enable errors on unknown/unparsable args, or unknown/nonexistent files, or targets'
+            ),
         })
         self.modified_args = {}
         self.config = copy.deepcopy(config) # avoid external modifications.
@@ -497,9 +499,11 @@ class Command: # pylint: disable=too-many-public-methods
 
         # Do some minimal type handling, preserving the type(self.args[key])
         if key not in self.args:
-            self.error_unknown_arg(
+            self.error_ifarg(
                 f'set_arg, {key=} not in self.args {value=}',
-                f'({self.command_name=}, {self.__class__.__name__=})'
+                f'({self.command_name=}, {self.__class__.__name__=})',
+                arg='error-unknown-args',
+                error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR
             )
 
         cur_value = self.args[key]
@@ -695,9 +699,11 @@ class Command: # pylint: disable=too-many-public-methods
         _, unparsed = self.run_argparser_on_list(tokens)
         if process_all and unparsed:
             self.warning_show_known_args()
-            self.error_unknown_arg(
+            self.error_ifarg(
                 f"Didn't understand argument: '{unparsed=}' in",
-                f"{self.command_name=} context, {pwd=}"
+                f"{self.command_name=} context, {pwd=}",
+                arg='error-unknown-args',
+                error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR
             )
 
         return unparsed
@@ -914,13 +920,17 @@ class Command: # pylint: disable=too-many-public-methods
         lines.append(self.pretty_str_known_args(command=commands[-1])) # use last command if > 1
         util.warning("\n".join(lines))
 
-    def error_unknown_arg(self, *msg) -> None:
+    def error_ifarg(
+            self, *msg, arg: str, error_code: int = status_constants.EDA_COMMAND_OR_ARGS_ERROR
+    ) -> None:
         '''For errors involving an unknown --arg, they can be optionally disabled
 
-        using --no-error-unknown-args
+        using CLI: --no-error-unknown-args, and this method arg='error-uknown-arg'
+
+        Note if arg is not present in self.args, the error is enabled.
         '''
-        if self.args['error-unknown-args']:
-            self.error(*msg, error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR)
+        if self.args.get(arg, True):
+            self.error(*msg, error_code=error_code)
         else:
             util.warning(*msg)
 
@@ -1497,8 +1507,12 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
                     found_target = True
                     break # move on to the next target
             if not found_target and error_on_not_found: # if STILL not found_this_target...
-                self.error(f"Unable to resolve {target=}",
-                           error_code=status_constants.EDA_DEPS_TARGET_NOT_FOUND)
+                # allow this if --no-error-unknown-args:
+                self.error_ifarg(
+                    f"Unable to resolve {target=}",
+                    arg='error-unknown-args',
+                    error_code=status_constants.EDA_DEPS_TARGET_NOT_FOUND
+                )
 
         # if we've found any target since being called, it means we found the one we were called for
         return found_target
@@ -1660,9 +1674,11 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
         if process_all and possible_unparsed_args:
             _tool = self.safe_which_tool()
             self.warning_show_known_args()
-            self.error_unknown_arg(
+            self.error_ifarg(
                 f"Didn't understand unparsed args: {possible_unparsed_args}, for command",
-                f"'{self.command_name}', tool '{_tool}'"
+                f"'{self.command_name}', tool '{_tool}'",
+                arg='error-unknown-args',
+                error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR
             )
 
         remove_list = []
@@ -1721,9 +1737,11 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
         # we were unable to figure out what this command line token is for...
         if process_all and unparsed:
             self.warning_show_known_args()
-            self.error_unknown_arg(
+            self.error_ifarg(
                 f"Didn't understand remaining args or targets {unparsed=} for command",
-                f"'{self.command_name}'"
+                f"'{self.command_name}'",
+                arg='error-unknown-args',
+                error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR
             )
 
         # handle a missing self.args['top'] with last filepath or last target:
@@ -2269,9 +2287,11 @@ class CommandParallel(Command):
         bad_remaining_args = [x for x in single_cmd_unparsed if x.startswith('-')]
         if bad_remaining_args:
             self.warning_show_known_args(command=f'{self.command_name} {command}')
-            self.error_unknown_arg(
+            self.error_ifarg(
                 f'for {self.command_name} {command=} the following args are unknown',
-                f'{bad_remaining_args}'
+                f'{bad_remaining_args}',
+                arg='error-unknown-args',
+                error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR
             )
 
         # Remove unparsed args starting with '+', since those are commonly sent downstream to

{opencos_eda-0.3.1 → opencos_eda-0.3.2}/opencos/tests/helpers.py

@@ -9,12 +9,14 @@ from pathlib import Path
 
 from contextlib import redirect_stdout, redirect_stderr
 
-from opencos import eda
-from opencos import deps_schema
+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.subprocess_helpers import subprocess_run_background
 
+# Figure out what tools the system has available, without calling eda.main(..)
+config, tools_loaded = eda_tool_helper.get_config_and_tools_loaded()
+
 
 def eda_wrap_is_sim_fail(rc: int, quiet: bool = False) -> bool:
     '''Because eda_wrap calls eda_main(..) and will continue running
@@ -30,11 +32,11 @@ def eda_wrap_is_sim_fail(rc: int, quiet: bool = False) -> bool:
         status_constants.EDA_DEFAULT_ERROR
     )
 
-def can_run_eda_command(*commands, config: dict) -> bool:
+def can_run_eda_command(*commands, cfg: dict = config) -> bool:
     '''Returns True if we have any installed tool that can run: eda <command>'''
     runnable = []
     for command in list(commands):
-        handler = config['command_handler'].get(command, None)
+        handler = cfg['command_handler'].get(command, None)
         if not handler:
             return False
         if handler and getattr(handler, 'CHECK_REQUIRES', []):
@@ -44,7 +46,7 @@ def can_run_eda_command(*commands, config: dict) -> bool:
         # We cannot run tools that have disable-auto set:
         tool = getattr(handler, '_TOOL', '')
         if handler and tool:
-            entry = config['auto_tools_order'][0].get(tool, {})
+            entry = cfg['auto_tools_order'][0].get(tool, {})
             if entry and entry.get('disable-auto', False):
                 # This tool cannot automatically run our command.
                 return False
@@ -52,6 +54,14 @@ def can_run_eda_command(*commands, config: dict) -> bool:
         runnable.append(True)
     return runnable and all(runnable)
 
+def can_run_eda_sim(cfg: dict = config) -> bool:
+    '''Returns True if we have any installed tool that can run: eda sim'''
+    return can_run_eda_command('sim', cfg=cfg)
+
+def can_run_eda_elab(cfg: dict = config) -> bool:
+    '''Returns True if we have any installed tool that can run: eda elab'''
+    return can_run_eda_command('elab', cfg=cfg)
+
 def chdir_remove_work_dir(startpath, relpath):
     '''Changes dir to startpath/relpath, removes the work directories (eda.work, eda.export*)'''
     os.chdir(os.path.join(str(Path(startpath)), str(Path(relpath))))

{opencos_eda-0.3.1 → opencos_eda-0.3.2}/opencos/tests/test_eda.py

@@ -23,11 +23,12 @@ import subprocess
 
 import pytest
 
-from opencos import eda, eda_tool_helper
+from opencos import eda
 from opencos.utils.markup_helpers import yaml_safe_load
 from opencos.tests import helpers
 from opencos.tests.helpers import eda_wrap, eda_sim_wrap, eda_elab_wrap, \
-    Helpers
+    Helpers, tools_loaded, can_run_eda_sim
+
 
 
 THISPATH = os.path.dirname(__file__)
@@ -36,17 +37,6 @@ def chdir_remove_work_dir(relpath):
     '''Changes dir to relpath, removes the work directories (eda.work, eda.export*)'''
     return helpers.chdir_remove_work_dir(THISPATH, relpath)
 
-# Figure out what tools the system has available, without calling eda.main(..)
-config, tools_loaded = eda_tool_helper.get_config_and_tools_loaded()
-
-def can_run_eda_sim() -> bool:
-    '''Returns True if we have any installed tool that can run: eda sim'''
-    return helpers.can_run_eda_command('sim', config=config)
-
-def can_run_eda_elab() -> bool:
-    '''Returns True if we have any installed tool that can run: eda elab'''
-    return helpers.can_run_eda_command('elab', config=config)
-
 @pytest.mark.skipif(
     'verilator' not in tools_loaded and 'vivado' not in tools_loaded,
     reason="requires verilator OR vivado"

{opencos_eda-0.3.1 → opencos_eda-0.3.2}/opencos/tests/test_tools.py

@@ -6,25 +6,23 @@ import os
 import sys
 import pytest
 
-from opencos import eda, eda_tool_helper, eda_base
+from opencos import eda, eda_base
 
 from opencos.tools.verilator import ToolVerilator
 from opencos.tools.vivado import ToolVivado
 from opencos.tools.cocotb import ToolCocotb
 from opencos.tests import helpers
-from opencos.tests.helpers import eda_wrap, eda_wrap_is_sim_fail
+from opencos.tests.helpers import eda_wrap, eda_wrap_is_sim_fail, config, tools_loaded
 from opencos.utils.markup_helpers import yaml_safe_load
 from opencos.utils import status_constants
 
 
-thispath = os.path.dirname(__file__)
+THISPATH = os.path.dirname(__file__)
 
 def chdir_remove_work_dir(relpath):
     '''Changes dir to relpath, removes the work directories (eda.work, eda.export*)'''
-    return helpers.chdir_remove_work_dir(thispath, relpath)
+    return helpers.chdir_remove_work_dir(THISPATH, relpath)
 
-# Figure out what tools the system has available, without calling eda.main(..)
-config, tools_loaded = eda_tool_helper.get_config_and_tools_loaded()
 
 def test_tools_loaded():
     '''Does not directly call 'eda.main' instead create a few Tool
@@ -37,7 +35,7 @@ def test_tools_loaded():
     # 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', config=config):
+       not helpers.can_run_eda_command('elab', 'sim', cfg=config):
         # Windows, not handlers for elab or sim:
         pass
     else:
@@ -129,7 +127,7 @@ def test_sim_elab_tools_pass_or_fail(command, tool, target, sim_expect_pass, add
         added_args = added_sim_args_str.split()
 
     relative_dir = "deps_files/test_err_fatal"
-    os.chdir(os.path.join(thispath, relative_dir))
+    os.chdir(os.path.join(THISPATH, relative_dir))
     rc = eda.main(command, '--tool', tool, *(added_args), target)
     print(f'{rc=}')
     if command != 'sim' or sim_expect_pass:

{opencos_eda-0.3.1 → opencos_eda-0.3.2/opencos_eda.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.1
+Version: 0.3.2
 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.3.1 → opencos_eda-0.3.2}/pyproject.toml

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