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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.47
+Version: 0.2.49
 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/__init__.py

@@ -0,0 +1,6 @@
+'''__init__ package for opencos.'''
+
+from ._version import VERSION, NAME
+
+__version__ = VERSION
+__pyproject_name__ = NAME

opencos_eda-0.2.49/opencos/_version.py

@@ -0,0 +1,19 @@
+''' private helper package for `eda --version`'''
+
+import sys
+
+NAME = 'opencos-eda'
+
+# Use standard library metadata module starting Python 3.8
+if sys.version_info >= (3, 8):
+
+    from importlib import metadata
+    try:
+        VERSION = metadata.version(NAME)
+    except metadata.PackageNotFoundError:
+        # Handle case where the package is not installed (e.g., running from source checkout)
+        VERSION = "0.0.0"
+
+else:
+    # This package only supports >= 3.8, so not doing the importlib_metadata method.
+    VERSION = "unknown" # Or raise an error, or handle differently

{opencos_eda-0.2.47 → opencos_eda-0.2.49}/opencos/commands/flist.py

@@ -9,6 +9,7 @@ import os
 
 from opencos import util
 from opencos.eda_base import CommandDesign
+from opencos.utils.str_helpers import strip_all_quotes
 
 class CommandFList(CommandDesign):
     '''Base class command handler for: eda flist ...'''
@@ -140,14 +141,14 @@ class CommandFList(CommandDesign):
             if self.args['emit-non-sources']:
                 if self.files_non_source:
                     print('## reqs (non-source files that are dependencies):', file=fo)
-                    prefix = util.strip_all_quotes(self.args['prefix-non-sources'])
+                    prefix = strip_all_quotes(self.args['prefix-non-sources'])
                     for f in self.files_non_source:
                         if self.args['emit-rel-path']:
                             f = os.path.relpath(f)
                         print('##    ' + prefix + pq1 + f + pq2, file=fo)
 
         if self.args['emit-define']:
-            prefix = util.strip_all_quotes(self.args['prefix-define'])
+            prefix = strip_all_quotes(self.args['prefix-define'])
             for d, value in self.defines.items():
                 if value is None:
                     newline = prefix + d
@@ -176,31 +177,31 @@ class CommandFList(CommandDesign):
                 print(newline, file=fo)
 
         if self.args['emit-incdir']:
-            prefix = util.strip_all_quotes(self.args['prefix-incdir'])
+            prefix = strip_all_quotes(self.args['prefix-incdir'])
             for i in self.incdirs:
                 if self.args['emit-rel-path']:
                     i = os.path.relpath(i)
                 print(prefix + pq1 + i + pq2, file=fo)
         if self.args['emit-v']:
-            prefix = util.strip_all_quotes(self.args['prefix-v'])
+            prefix = strip_all_quotes(self.args['prefix-v'])
             for f in self.files_v:
                 if self.args['emit-rel-path']:
                     f = os.path.relpath(f)
                 print(prefix + pq1 + f + pq2, file=fo)
         if self.args['emit-sv']:
-            prefix = util.strip_all_quotes(self.args['prefix-sv'])
+            prefix = strip_all_quotes(self.args['prefix-sv'])
             for f in self.files_sv:
                 if self.args['emit-rel-path']:
                     f = os.path.relpath(f)
                 print(prefix + pq1 + f + pq2, file=fo)
         if self.args['emit-vhd']:
-            prefix = util.strip_all_quotes(self.args['prefix-vhd'])
+            prefix = strip_all_quotes(self.args['prefix-vhd'])
             for f in self.files_vhd:
                 if self.args['emit-rel-path']:
                     f = os.path.relpath(f)
                 print(prefix + pq1 + f + pq2, file=fo)
         if self.args['emit-cpp']:
-            prefix = util.strip_all_quotes(self.args['prefix-cpp'])
+            prefix = strip_all_quotes(self.args['prefix-cpp'])
             for f in self.files_cpp:
                 if self.args['emit-rel-path']:
                     f = os.path.relpath(f)

{opencos_eda-0.2.47 → opencos_eda-0.2.49}/opencos/commands/multi.py

@@ -9,10 +9,12 @@ import os
 import shutil
 from pathlib import Path
 
-from opencos import util, eda_base, deps_helpers, eda_config, export_helper, \
+from opencos import util, eda_base, eda_config, export_helper, \
     eda_tool_helper
-from opencos.deps_helpers import get_deps_markup_file, deps_markup_safe_load
 from opencos.eda_base import CommandParallel, get_eda_exec
+from opencos.deps.deps_file import get_deps_markup_file, deps_markup_safe_load, \
+    deps_data_get_all_targets, deps_list_target_sanitize
+from opencos.utils.str_helpers import fnmatch_or_re, dep_str2list
 
 class CommandMulti(CommandParallel):
     '''eda.py command handler for: eda multi <command> <args,targets,target-globs,...>'''
@@ -68,7 +70,7 @@ class CommandMulti(CommandParallel):
         return command, level
 
 
-    def resolve_path_and_target_patterns(
+    def resolve_path_and_target_patterns( # pylint: disable=too-many-locals
             self, base_path: str, target: str, level: int = -1
     ) -> dict:
         '''Returns a dict of: key = matching path, value = set of matched targets.
@@ -91,24 +93,38 @@ class CommandMulti(CommandParallel):
 
         matching_targets_dict = {}
 
+        # Let's not glob.glob if the path_pattern and target_pattern are
+        # exact, aka if it does not have special characters for glob: * or ?
+        # for the target, we also support re, so: * + ?
+        if any(x in path_pattern for x in ['*', '?']):
+            paths_from_pattern = list(glob.glob(path_pattern, recursive=True))
+        else:
+            paths_from_pattern = [path_pattern]
+
+        target_pattern_needs_lookup = any(x in target_pattern for x in ['*', '?', '+'])
+
         # resolve the path_pattern portion using glob.
         # we'll have to check for DEPS markup files in path_pattern, to match the target_wildcard
         # using fnmatch or re.
-        for path in glob.glob(path_pattern, recursive=True):
+        for path in paths_from_pattern:
 
             if self.path_hidden_or_work_dir(path):
                 continue
 
-            deps_markup_file = deps_helpers.get_deps_markup_file(path)
+            deps_markup_file = get_deps_markup_file(path)
             if deps_markup_file:
-                data = deps_helpers.deps_markup_safe_load(deps_markup_file)
-                deps_targets = deps_helpers.deps_data_get_all_targets(data)
+                data = deps_markup_safe_load(deps_markup_file)
+                deps_targets = deps_data_get_all_targets(data)
                 rel_path = os.path.relpath(path)
 
                 debug(f'in {rel_path=} looking for {target_pattern=} in {deps_targets=}')
 
                 for t in deps_targets:
-                    if deps_helpers.fnmatch_or_re(pattern=target_pattern, string=t):
+                    if target_pattern_needs_lookup:
+                        matched = fnmatch_or_re(pattern=target_pattern, string=t)
+                    else:
+                        matched = t == target_pattern
+                    if matched:
                         if rel_path not in matching_targets_dict:
                             matching_targets_dict[rel_path] = set()
                         matching_targets_dict[rel_path].add(t)
@@ -162,14 +178,11 @@ class CommandMulti(CommandParallel):
         all_multi_tools = self.multi_which_tools(command)
 
         deps_file = get_deps_markup_file(base_path)
-        data = None
+        data = {}
         if self.config['deps_markup_supported'] and deps_file:
             data = deps_markup_safe_load(deps_file)
 
-        if data is None:
-            data = {}
-
-        deps_targets = deps_helpers.deps_data_get_all_targets(data)
+        deps_targets = deps_data_get_all_targets(data)
         deps_file_defaults = data.get('DEFAULTS', {})
 
         # Loop through all the targets in DEPS.yml, skipping DEFAULTS
@@ -182,7 +195,7 @@ class CommandMulti(CommandParallel):
             # Since we support a few schema flavors for a target (our
             # 'target_node' key in a DEPS.yml file) santize the entry
             # so it's a {} with a 'deps' key:
-            entry_sanitized = deps_helpers.deps_list_target_sanitize(
+            entry_sanitized = deps_list_target_sanitize(
                 entry, target_node=target_node, deps_file=deps_file
             )
 
@@ -215,8 +228,8 @@ class CommandMulti(CommandParallel):
 
                 commands = x.get('commands', [])
                 tools = x.get('tools', [])
-                ignore_commands_list = deps_helpers.dep_str2list(commands)
-                ignore_tools_list = deps_helpers.dep_str2list(tools)
+                ignore_commands_list = dep_str2list(commands)
+                ignore_tools_list = dep_str2list(tools)
 
                 debug(f"{ignore_tools_list=}, {ignore_commands_list=} {target_node=}")
                 debug(f"{command=} --> {all_multi_tools=}")
@@ -392,9 +405,13 @@ class CommandMulti(CommandParallel):
             # Special case for 'multi' --export-jsonl, run reach child with --export-json
             command_list.append('--export-json')
         if tool and len(all_multi_tools) > 1:
-            command_list.append(f'--job-name={short_target}.{command}.{tool}')
+            jobname = f'{short_target}.{command}.{tool}'
         else:
-            command_list.append(f'--job-name={short_target}.{command}')
+            jobname = f'{short_target}.{command}'
+        command_list.append(f'--job-name={jobname}')
+        logfile = os.path.join(self.args['eda-dir'], f'eda.{jobname}.log')
+        command_list.append(f'--force-logfile={logfile}')
+
 
     def append_jobs_from_targets(self, args:list):
         '''Helper method in CommandMulti to apply 'args' (list) to all self.targets,

{opencos_eda-0.2.47 → opencos_eda-0.2.49}/opencos/commands/sweep.py

@@ -8,6 +8,7 @@ import re
 
 from opencos import util
 from opencos.eda_base import CommandDesign, CommandParallel, get_eda_exec, which_tool
+from opencos.utils.str_helpers import strip_outer_quotes
 
 class CommandSweep(CommandDesign, CommandParallel):
     '''Command handler for: eda sweep ...'''
@@ -77,7 +78,7 @@ class CommandSweep(CommandDesign, CommandParallel):
 
         for sweep_arg_value in self.args['sweep']:
             # Deal with --sweep= args we already parsed, but haven't expanded yet.
-            sweep_arg_value = util.strip_outer_quotes(sweep_arg_value)
+            sweep_arg_value = strip_outer_quotes(sweep_arg_value)
             sweep_axis_list_entry = self._process_sweep_arg(sweep_arg_value=sweep_arg_value)
             if sweep_axis_list_entry:
                 sweep_axis_list.append(sweep_axis_list_entry)
@@ -136,7 +137,7 @@ class CommandSweep(CommandDesign, CommandParallel):
         Return value is {} or {'lhs': str, 'operator': str (+ or =), 'values': list}
         '''
 
-        sweep_arg_value = util.strip_outer_quotes(sweep_arg_value)
+        sweep_arg_value = strip_outer_quotes(sweep_arg_value)
 
         util.debug(f'{sweep_arg_value=}')
         # Try to match a sweep range expansion:
@@ -206,14 +207,18 @@ class CommandSweep(CommandDesign, CommandParallel):
             snapshot_name = snapshot_name.replace(os.sep, '_') \
                 + f'.{self.single_command}{sweep_string}'
             eda_path = get_eda_exec('sweep')
+            logfile = os.path.join(self.args['eda-dir'], f'eda.{snapshot_name}.log')
             self.jobs.append({
                 'name' : snapshot_name,
                 'index' : len(self.jobs),
                 'command': self.single_command,
                 'target': self.sweep_target,
                 'command_list' : (
-                    [eda_path, self.single_command, self.sweep_target,
-                     f'--job-name={snapshot_name}'] + arg_tokens
+                    [
+                        eda_path, self.single_command, self.sweep_target,
+                        f'--job-name={snapshot_name}',
+                        f'--force-logfile={logfile}',
+                    ] + arg_tokens
                 )
             })
             return

{opencos_eda-0.2.47 → opencos_eda-0.2.49}/opencos/commands/waves.py

@@ -143,7 +143,7 @@ class CommandWaves(CommandDesign):
             else:
                 self.error(f"Don't know how to open {wave_file} without GtkWave in PATH")
         elif wave_file.endswith('.vcd'):
-            if 'gtkwave' in self.config['tools_loaded'] and shutil.which('gktwave'):
+            if 'gtkwave' in self.config['tools_loaded'] and shutil.which('gtkwave'):
                 command_list = ['gtkwave', wave_file]
                 self.exec(os.path.dirname(wave_file), command_list)
             elif self._vsim_available(from_tools=self.VSIM_VCD_TOOLS):

opencos_eda-0.2.49/opencos/deps/defaults.py

@@ -0,0 +1,69 @@
+''' opencos.deps.defaults -- pymodule for defaults referenced by other modules here'''
+
+
+DEPS_FILE_EXTS = set([
+    '.yml', '.yaml', '.toml', '.json',
+    # Treat no extension DEPS as YAML.
+    ''
+])
+
+ROOT_TABLE_KEYS_NOT_TARGETS = set([
+    "DEFAULTS",
+    "METADATA",
+])
+
+KNOWN_EDA_COMMANDS = set([
+    "sim",
+    "elab",
+    "synth",
+    "flist",
+    "proj",
+    "multi",
+    "tools-multi",
+    "sweep",
+    "build",
+    "waves",
+    "upload",
+    "open",
+    "export",
+])
+
+SUPPORTED_TARGET_TABLE_KEYS = set([
+    'args',
+    'defines',
+    'incdirs',
+    'top',
+    'deps',
+    'reqs',
+    'multi',
+    'tags',
+    'commands'] + list(KNOWN_EDA_COMMANDS))
+
+SUPPORTED_DEP_KEYS_BY_TYPE = {
+    dict: set(['commands']),
+    str: set(['*']),
+}
+
+SUPPORTED_TAG_KEYS = set([
+    'with-tools',
+    'with-args',
+    'args',
+    'deps',
+    'reqs',
+    'defines',
+    'incdirs',
+    'replace-config-tools',
+    'additive-config-tools',
+])
+
+SUPPORTED_COMMAND_KEYS = set([
+    'shell',
+    'work-dir-add-srcs', 'work-dir-add-sources',
+    'peakrdl',
+    'run-from-work-dir',     # default True
+    'filepath-subst-target-dir', # default True
+    'dirpath-subst-target-dir',  # default False
+    'var-subst-args',
+    'var-subst-os-env',
+    'tee',
+])