opencos-eda 0.3.10__py3-none-any.whl → 0.3.11__py3-none-any.whl

opencos/eda_config.py

@@ -10,11 +10,11 @@ Order of precedence for default value of eda arg: --config-yaml:
 import copy
 import os
 import argparse
-import shutil
 
 import mergedeep
 
 from opencos import util
+from opencos.files import safe_shutil_which
 from opencos.util import safe_emoji
 from opencos.utils.markup_helpers import yaml_safe_load, yaml_safe_writer
 
@@ -24,12 +24,11 @@ class Defaults:
     Defaults.config_yml is set depending on search order for default eda_config[_defaults].yml
     '''
 
-    environ_override_config_yml = os.environ.get('EDA_CONFIG_YML', '')
-    home_override_config_yml = os.path.join(
-        os.environ.get('HOME', ''), '.opencos-eda', 'EDA_CONFIG.yml'
-    )
+    environ_override_config_yml = ''
+    home_override_config_yml = ''
     opencos_config_yml = 'eda_config_defaults.yml'
     config_yml = ''
+    config_yml_set_from = ''
 
     supported_config_keys = set([
         'DEFAULT_HANDLERS', 'DEFAULT_HANDLERS_HELP',
@@ -39,11 +38,13 @@ class Defaults:
         'deps_markup_supported',
         'deps_subprocess_shell',
         'bare_plusarg_supported',
+        'deps_expandvars_enable',
         'dep_sub',
         'vars',
         'file_extensions',
         'command_determines_tool',
         'command_tool_is_optional',
+        'command_has_subcommands',
         'tools',
         'auto_tools_order',
     ])
@@ -74,12 +75,36 @@ class Defaults:
 
 EDA_OUTPUT_CONFIG_FNAME = 'eda_output_config.yml'
 
-if os.path.isfile(Defaults.environ_override_config_yml):
-    Defaults.config_yml = Defaults.environ_override_config_yml
-elif os.path.isfile(Defaults.home_override_config_yml):
-    Defaults.config_yml = Defaults.home_override_config_yml
-else:
+def set_defaults() -> None:
+    '''Updates Defaults *config_yml members, sets Defaults.config_yml'''
+
+    Defaults.environ_override_config_yml = os.environ.get(
+        'EDA_CONFIG_YML', os.environ.get('EDA_CONFIG_YAML', '')
+    )
+    if Defaults.environ_override_config_yml and \
+       os.path.isfile(Defaults.environ_override_config_yml):
+        Defaults.config_yml = Defaults.environ_override_config_yml
+        Defaults.config_yml_set_from = 'env EDA_CONFIG_YML'
+        return
+
+    home = os.environ.get('HOME', os.environ.get('HOMEPATH', ''))
+    if home and os.path.isdir(os.path.join(home, '.opencos-eda')):
+        Defaults.home_override_config_yml = [
+            os.path.join(home, '.opencos-eda', 'EDA_CONFIG.yml'),
+            os.path.join(home, '.opencos-eda', 'EDA_CONFIG.yaml')
+        ]
+        for x in Defaults.home_override_config_yml:
+            if os.path.isfile(x):
+                Defaults.config_yml = x
+                Defaults.config_yml_set_from = 'file [$HOME|$HOMEPATH]/.opencos-eda'
+                return
+
+    # else default:
     Defaults.config_yml = Defaults.opencos_config_yml
+    Defaults.config_yml_set_from = ''
+
+
+set_defaults()
 
 
 def find_eda_config_yml_fpath(
@@ -232,12 +257,21 @@ def get_config_merged_with_defaults(config:dict) -> dict:
 
 def get_argparser() -> argparse.ArgumentParser:
     '''Returns an ArgumentParser, handles --config-yml=<filename> arg'''
+
+    # re-run set_defaults() in case a --env-file overwrote Defaults.config_yml
+    set_defaults()
+
     parser = argparse.ArgumentParser(
         prog=f'{safe_emoji("🔎 ")}opencos eda config options', add_help=False, allow_abbrev=False
     )
-    parser.add_argument('--config-yml', type=str, default=Defaults.config_yml,
-                        help=('YAML filename to use for configuration (default'
-                              f' {Defaults.config_yml})'))
+    parser.add_argument(
+        '--config-yml', type=str, default=Defaults.config_yml,
+        help=(
+            f'YAML filename to use for configuration (default {Defaults.config_yml}).'
+            ' Can be overriden using environmnet var EDA_CONFIG_YML=FILE, or from file'
+            ' [$HOME|$HOMEPATH]/.opencos-eda/EDA_CONFIG.yml'
+        )
+    )
     return parser
 
 
@@ -255,7 +289,6 @@ def get_eda_config(args:list, quiet=False) -> (dict, list):
 
     This will merge the result with the default config (if overriden)
     '''
-
     parser = get_argparser()
     try:
         parsed, unparsed = parser.parse_known_args(args + [''])
@@ -267,7 +300,13 @@ def get_eda_config(args:list, quiet=False) -> (dict, list):
 
     if parsed.config_yml:
         if not quiet:
-            util.info(f'eda_config: --config-yml={parsed.config_yml} observed')
+            if parsed.config_yml != Defaults.config_yml:
+                # It was set on CLI:
+                util.info(f'eda_config: --config-yml={parsed.config_yml} observed')
+            elif Defaults.config_yml_set_from:
+                # It was picked up via env or HOME/.opencos-eda/ override:
+                util.info(f'eda_config: --config-yml={parsed.config_yml} observed, from',
+                          f'{Defaults.config_yml_set_from}')
         fullpath = find_eda_config_yml_fpath(parsed.config_yml)
         config = get_config(fullpath)
         if not quiet:
@@ -390,7 +429,7 @@ def tool_try_add_to_path( # pylint: disable=too-many-branches
         util.error(f'--tool setting for {tool}: {user_exe} is not an executable')
         return name
 
-    user_exe = shutil.which(user_exe)
+    user_exe = safe_shutil_which(user_exe)
 
     if update_config:
         if isinstance(config_exe, list):
@@ -399,7 +438,7 @@ def tool_try_add_to_path( # pylint: disable=too-many-branches
                 # update all entries, if we can, if the value is also in 'path'
                 # from our set --tool=Name=path/exe
                 new_value = os.path.join(path, os.path.split(value)[1])
-                if os.path.exists(new_value) and shutil.which(new_value) and \
+                if os.path.exists(new_value) and safe_shutil_which(new_value) and \
                    os.access(new_value, os.X_OK):
                     config['auto_tools_order'][0][name]['exe'][index] = new_value
         else:

opencos/eda_config_defaults.yml

@@ -12,7 +12,6 @@ DEFAULT_HANDLERS:
   synth       : opencos.commands.CommandSynth
   proj        : opencos.commands.CommandProj
   build       : opencos.commands.CommandBuild
-  upload      : opencos.commands.CommandUpload
   open        : opencos.commands.CommandOpen
   lec         : opencos.commands.CommandLec
   # These commands don't necessarily require a tool
@@ -22,6 +21,7 @@ DEFAULT_HANDLERS:
   flist       : opencos.commands.CommandFList
   # These commands (waves, export, targets) do not require a tool, or
   # will self determine the tool. See command_tool_is_optional in this config file.
+  upload      : opencos.commands.CommandUpload
   waves       : opencos.commands.CommandWaves
   export      : opencos.commands.CommandExport
   shell       : opencos.commands.CommandShell
@@ -73,6 +73,7 @@ dep_tags_enables:
 deps_markup_supported: true  # Support DEPS.yml files (also .yaml, .toml, .json)
 deps_subprocess_shell: true  # Support subprocess commands using shell=True
 bare_plusarg_supported: true # Support for CLI, DEPS args or deps: +<string> that isn't +define or +incdirs
+deps_expandvars_enable : true # Support env $VAR replacement on targets or files in DEPS.yml
 
 dep_sub: [ ] # Legacy, no longer supported.
 vars: { }    # Legacy, no longer supported.
@@ -110,6 +111,7 @@ file_extensions:
 command_determines_tool:
   # eda commands that will self-determine the tool to use
   - waves
+  - upload
 
 command_tool_is_optional:
   # eda commands that may not need to use a tool at all, will skip auto_tools_order if --tool=None (default)
@@ -118,6 +120,12 @@ command_tool_is_optional:
   - targets
   - deps-help
 
+command_has_subcommands:
+  - multi
+  - tools-multi
+  - sweep
+
+
 
 tools:
 
@@ -440,17 +448,20 @@ auto_tools_order:
       exe: code
       requires_vscode_extension:
         - lramseyer.vaporview
-      handlers: { }
+      handlers:
+        waves: opencos.commands.waves.CommandWaves
 
     surfer:
       exe: code
       requires_vscode_extension:
         - surfer-project.surfer
-      handlers: { }
+      handlers:
+        waves: opencos.commands.waves.CommandWaves
 
     gtkwave:
       exe: gtkwave
-      handlers: { }
+      handlers:
+        waves: opencos.commands.waves.CommandWaves
 
     quartus:
       exe: quartus_sh
@@ -474,6 +485,7 @@ auto_tools_order:
         open:   opencos.tools.vivado.CommandOpenVivado
         flist:  opencos.tools.vivado.CommandFListVivado
         build:  opencos.tools.vivado.CommandBuildVivado
+        waves:  opencos.commands.waves.CommandWaves
 
     slang_yosys:
       exe: yosys
@@ -517,6 +529,7 @@ auto_tools_order:
         elab: opencos.tools.questa.CommandElabQuesta
         sim: opencos.tools.questa.CommandSimQuesta
         flist: opencos.tools.questa.CommandFListQuesta
+        waves:  opencos.commands.waves.CommandWaves
 
     riviera:
       exe: vsim
@@ -527,6 +540,7 @@ auto_tools_order:
         lint: opencos.tools.riviera.CommandLintRiviera
         elab: opencos.tools.riviera.CommandElabRiviera
         sim:  opencos.tools.riviera.CommandSimRiviera
+        waves:  opencos.commands.waves.CommandWaves
 
     questa_fe:
       exe: vsim
@@ -536,6 +550,7 @@ auto_tools_order:
         elab: opencos.tools.questa_fe.CommandElabQuestaFe
         sim: opencos.tools.questa_fe.CommandSimQuestaFe
         flist: opencos.tools.questa_fe.CommandFListQuestaFe
+        waves:  opencos.commands.waves.CommandWaves
 
     questa_fse:  # free student edition, works similar to modelsim_ase
       exe: vsim
@@ -545,6 +560,7 @@ auto_tools_order:
         elab: opencos.tools.questa_fse.CommandElabQuestaFse
         sim:  opencos.tools.questa_fse.CommandSimQuestaFse
         flist: opencos.tools.questa_fse.CommandFListQuestaFse
+        waves:  opencos.commands.waves.CommandWaves
 
     modelsim_ase:
       exe: vsim
@@ -553,6 +569,7 @@ auto_tools_order:
         lint: opencos.tools.modelsim_ase.CommandLintModelsimAse
         elab: opencos.tools.modelsim_ase.CommandElabModelsimAse
         sim:  opencos.tools.modelsim_ase.CommandSimModelsimAse
+        waves:  opencos.commands.waves.CommandWaves
 
     iverilog:
       exe: iverilog

opencos/files.py

@@ -13,6 +13,7 @@ as part of a verilog $readmemh, etc)
 '''
 
 import os
+import shutil
 
 # Ways to force files not ending in .sv to be systemverilog (for tools
 # that require -sv vs Verilog-2001'''
@@ -31,8 +32,12 @@ FORCE_PREFIX_DICT = {
 
 ALL_FORCED_PREFIXES = set(list(FORCE_PREFIX_DICT.keys()))
 
-def get_source_file(target:str) -> (bool, str, str):
+def get_source_file(target: str) -> (bool, str, str):
     '''Returns tuple: bool if file exists, filepath str, and optional forced file type str'''
+
+    if '$' in target:
+        target = os.path.expandvars(target)
+
     if os.path.isfile(target):
         # target exists as a file, return True w/ original target:
         return True, target, ''
@@ -47,3 +52,23 @@ def get_source_file(target:str) -> (bool, str, str):
 
     # target or fpath didn't exist, return False with the original target:
     return False, target, ''
+
+
+def safe_shutil_which(path: str) -> str:
+    '''Windows/WSL compatible Wrapper for shutil.which that checks for 'path':
+
+    - path
+    - path.exe
+    - path.bat
+
+    Returns full path str returned by shutil.which
+    '''
+    for ext in ('', '.exe', 'bat'):
+        if found := shutil.which(f'{path}{ext}'):
+            return found
+    return ''
+
+# Note that in Windows, 'python' will return the venv or uv version, 'python3' will
+# return the installed version (which may not be what you want), so we'll prefer
+# 'python':
+PY_EXE = safe_shutil_which('python') or safe_shutil_which('python3')

opencos/tools/cocotb.py

@@ -4,12 +4,12 @@ Contains classes for ToolCocotb, CommandSimCocotb.
 '''
 
 import os
-import shutil
 import subprocess
 
 from opencos import util
-from opencos.eda_base import Tool
 from opencos.commands import CommandSim
+from opencos.eda_base import Tool
+from opencos.files import safe_shutil_which, PY_EXE
 from opencos.utils import status_constants
 from opencos.utils.str_helpers import sanitize_defines_for_sh
 from opencos.tools import verilator # For default waivers.
@@ -30,7 +30,7 @@ class ToolCocotb(Tool):
             return self._VERSION
 
         # Check if python is available
-        python_path = shutil.which('python') or shutil.which('python3')
+        python_path = PY_EXE
         if not python_path:
             self.error('"python" or "python3" not in path, required for cocotb')
         else:
@@ -128,7 +128,7 @@ class CommandSimCocotb(CommandSim, ToolCocotb):
             util.warning('--cocotb-simulator is not set, a simulation cannot be run with'
                          'this arg value')
             return
-        exe = shutil.which(simulator)
+        exe = safe_shutil_which(simulator)
         if not exe:
             util.warning(f'--cocotb-simulator={simulator}, {simulator} is not present in PATH',
                          'a simulation cannot be run with this arg value')
@@ -330,7 +330,7 @@ class CommandSimCocotb(CommandSim, ToolCocotb):
     def _generate_runner_script_content(self, test_module: str, hdl_sources: list) -> str:
         '''Generate the content for the Python runner script'''
 
-        if shutil.which('verilator'):
+        if safe_shutil_which('verilator'):
             # TODO(drew): this shortcuts if verilator is truly usable,
             # consider using eda_tool_helper to get "tools_loaded", which
             # is not set in self.config['tools_loaded'] when --tool=cocotb.

opencos/tools/invio.py

@@ -5,9 +5,9 @@
 import importlib.util
 
 from opencos import util
-from opencos.tools import invio_helpers
-from opencos.eda_base import Tool
 from opencos.commands import CommandElab
+from opencos.eda_base import Tool
+from opencos.tools import invio_helpers
 
 
 

opencos/tools/invio_yosys.py

@@ -8,6 +8,7 @@ import os
 import importlib.util
 
 from opencos import util
+from opencos.files import PY_EXE
 from opencos.tools import invio_helpers
 from opencos.tools.yosys import ToolYosys, CommonSynthYosys
 
@@ -100,7 +101,7 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
 
 
         invio_command_list = util.ShellCommandList(
-            ['python3', invio_dict['full_py_filename']], tee_fpath=invio_dict['full_py_filename']
+            [PY_EXE, invio_dict['full_py_filename']], tee_fpath=invio_dict['full_py_filename']
         )
 
         # Optinally create and run a sta.f:

opencos/tools/iverilog.py

@@ -3,12 +3,12 @@
 Contains classes for ToolIverilog CommandSimIverilog, CommandElabIverilog.
 '''
 
-import shutil
 import subprocess
 
 from opencos import util
-from opencos.eda_base import Tool
 from opencos.commands import CommandSim
+from opencos.eda_base import Tool
+from opencos.files import safe_shutil_which
 from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 
@@ -28,7 +28,7 @@ class ToolIverilog(Tool):
         if self._VERSION:
             return self._VERSION
 
-        iverilog_path = shutil.which(self._EXE)
+        iverilog_path = safe_shutil_which(self._EXE)
         if iverilog_path is None:
             self.error(f'"{self._EXE}" not in path, need to get it ({self._URL})')
         else: