opencos-eda 0.2.34__py3-none-any.whl → 0.2.36__py3-none-any.whl

opencos/deps_helpers.py

@@ -261,7 +261,8 @@ def get_all_targets(
         base_path: str = os.getcwd(),
         filter_str: str = '',
         filter_using_multi: str = '',
-        error_on_empty_return: bool = True
+        error_on_empty_return: bool = True,
+        lstrip_path: bool = True
 ) -> list:
     '''Returns a list of [dir/target, ... ] using relpath from base_path
 
@@ -273,6 +274,8 @@ def get_all_targets(
     To all targets from dirs.
     '''
 
+    _path_lprefix = str(Path('.')) + os.path.sep
+
     if filter_using_multi:
         targets = []
         orig_dir = os.path.abspath(os.getcwd())
@@ -295,9 +298,10 @@ def get_all_targets(
                 this_dir, leaf_target = os.path.split(target)
                 if fnmatch_or_re(pattern=filter_str,
                                  string=leaf_target):
-                    targets.add(
-                        os.path.join(os.path.relpath(this_dir, start=base_path), leaf_target)
-                    )
+                    t = os.path.join(os.path.relpath(this_dir, start=base_path), leaf_target)
+                    if lstrip_path:
+                        t = t.removeprefix(_path_lprefix)
+                    targets.add(t)
             targets = list(targets)
         if not targets and error_on_empty_return:
             error(f'get_all_targets: {base_path=} {filter_using_multi=} returned no targets')
@@ -314,9 +318,10 @@ def get_all_targets(
         for leaf_target in deps_data_get_all_targets(data):
             if not filter_str or fnmatch_or_re(pattern=filter_str,
                                                string=leaf_target):
-                targets.add(
-                    os.path.join(os.path.relpath(this_dir, start=base_path), leaf_target)
-                )
+                t = os.path.join(os.path.relpath(this_dir, start=base_path), leaf_target)
+                if lstrip_path:
+                    t = t.removeprefix(_path_lprefix)
+                targets.add(t)
 
     if not targets and error_on_empty_return:
         error(f'get_all_targets: {base_path=} {dirs=} {filter_str=} returned no targets')

opencos/eda_config_defaults.yml

@@ -144,7 +144,6 @@ tools:
 
     coverage-args: |
       --annotate logs/annotated
-      --annotate-min 1
       coverage.dat
 
     # If you want to set your own run-time plusarg on all verilator exe's for --waves,

opencos/eda_deps_bash_completion.bash

@@ -15,7 +15,7 @@
 # what we want to add target completion to:
 SCRIPT_NAME="eda"
 # how we get the completion targets:
-EXTRACTION_SCRIPT_NAME="eda_extract_deps_keys"
+EXTRACTION_SCRIPT_NAME="eda_targets"
 
 _eda_script_completion() {
 

opencos/eda_extract_targets.py

@@ -0,0 +1,117 @@
+#!/usr/bin/env python3
+
+'''
+Helper pymodule used by eda_deps_bash_completion.bash, extracts valid
+targets from DEPS files
+'''
+
+import sys
+import os
+from pathlib import Path
+import json
+
+import yaml
+import toml
+
+from opencos.deps_helpers import get_all_targets
+
+PATH_LPREFIX = str(Path('.')) + os.path.sep
+
+
+def get_terminal_columns():
+    """
+    Retrieves the number of columns (width) of the terminal window.
+
+    Returns:
+        int: The number of columns in the terminal, or a default value (e.g., 80)
+             if the terminal size cannot be determined.
+    """
+    try:
+        size = os.get_terminal_size()
+        return size.columns
+    except OSError:
+        # Handle cases where the terminal size cannot be determined (e.g., not in a TTY)
+        return 80  # Default to 80 columns
+    else:
+        return 80
+
+
+def print_columns_manual(data: list, num_columns: int = 4, auto_columns: bool = True) -> None:
+    """Prints a list of strings in columns, manually aligning them."""
+    if not data:
+        print()
+        return
+
+    _spacing = 2
+
+    # Calculate maximum width for each column
+    max_lengths = [0] * num_columns
+    max_item_len = 0
+    for i, item in enumerate(data):
+        col_index = i % num_columns
+        max_lengths[col_index] = max(max_lengths[col_index], len(item))
+        max_item_len = max(max_item_len, len(item))
+
+    if auto_columns and num_columns > 1:
+        window_cols = get_terminal_columns()
+        max_line_len = 0
+        for x in max_lengths:
+            max_line_len += x + _spacing
+        if max_line_len > window_cols:
+            # subtract a column (already >= 2):
+            return print_columns_manual(data=data, num_columns=num_columns-1, auto_columns=True)
+        if max_line_len + max_item_len + _spacing < window_cols:
+            # add 1 more column if we're guaranteed to have room.
+            return print_columns_manual(data=data, num_columns=num_columns+1, auto_columns=True)
+        # else continue
+
+    # Print data in columns
+    for i, item in enumerate(data):
+        col_index = i % num_columns
+        print(item.ljust(max_lengths[col_index] + _spacing), end="")  # Add padding
+        if col_index == num_columns - 1 or i == len(data) - 1:
+            print() # New line at the end of a row or end of data
+
+
+def run(partial_path: str = '', base_path=str(Path('.'))) -> None:
+    '''Returns None, prints DEPS keys into pretty columns, using arg
+
+    partial_path as a string filter for target completions.
+    '''
+    partial_target = ''
+    if not partial_path or partial_path == str(Path('.')):
+        partial_path = PATH_LPREFIX
+    if not os.path.exists(partial_path):
+        partial_path, partial_target = os.path.split(partial_path)
+    if not partial_path:
+        partial_path = PATH_LPREFIX
+
+    try:
+        keys = get_all_targets(
+            dirs=[partial_path],
+            base_path=base_path,
+            filter_str=partial_target,
+            error_on_empty_return=False,
+            lstrip_path=True
+        )
+    except:
+        keys = []
+
+    print_columns_manual(data=keys, num_columns=4, auto_columns=True)
+
+
+def main() -> None:
+    '''Returns None, prints DEPS keys into pretty columns, uses sys.argv[1] for args:
+
+    sys.args[1] -- optional partial path for target completions
+    '''
+
+    if len(sys.argv) > 1:
+        partial_path = sys.argv[1]
+    else:
+        partial_path = PATH_LPREFIX
+    run(partial_path)
+
+
+if __name__ == "__main__":
+    main()

opencos/export_helper.py

@@ -1,4 +1,5 @@
 import os
+import shutil
 import json
 
 from opencos import util
@@ -75,7 +76,7 @@ def find_sv_included_files_within_file(filename:str,
                                        known_incdir_paths:list,
                                        warnings:bool=True,
                                        modify_files_and_save_to_path=None,
-                                       unmodified_files_link_to_path=None) -> list:
+                                       unmodified_files_copy_to_path=None) -> list:
     '''Given a filename (full path) and a list of known incdir paths, returns
     a list of included files (full path).
 
@@ -83,8 +84,8 @@ def find_sv_included_files_within_file(filename:str,
     to strip all path information on the `include "(path)" for example:
       `include "foo.svh" -- no modifications
       `include "../bar.svh" -- is modified to become `include "bar.svh"
-    (Optional) unmodified_files_link_to_path (str: directory/path) if you wish
-    to symlink unmodified files to this path.
+    (Optional) unmodified_files_copy_to_path (str: directory/path) if you wish
+    to copy unmodified files to this path.
     '''
 
     found_included_files = set()
@@ -97,7 +98,7 @@ def find_sv_included_files_within_file(filename:str,
 
     filename_no_path = os.path.split(filename)[1]
 
-    debug(f'export_helper: {filename=} {modify_files_and_save_to_path=} {unmodified_files_link_to_path=}')
+    debug(f'export_helper: {filename=} {modify_files_and_save_to_path=} {unmodified_files_copy_to_path=}')
 
     with open(filename) as f:
 
@@ -153,13 +154,13 @@ def find_sv_included_files_within_file(filename:str,
                     else:
                         outf.write(line)
 
-    # Optionally soft-link unmodified files to some path?
-    if len(modified_lines) == 0 and unmodified_files_link_to_path:
-        if os.path.isdir(unmodified_files_link_to_path):
-            dst = os.path.join(unmodified_files_link_to_path, filename_no_path)
+    # Copy unmodified files to some path.
+    if len(modified_lines) == 0 and unmodified_files_copy_to_path:
+        if os.path.isdir(unmodified_files_copy_to_path):
+            dst = os.path.join(unmodified_files_copy_to_path, filename_no_path)
             if not os.path.exists(dst):
-                debug(f'export_helper: Linked {filename=} to {dst=}')
-                os.symlink(src=filename, dst=dst)
+                debug(f'export_helper: Copied unmodified {filename=} to {dst=}')
+                shutil.copy(src=filename, dst=dst)
 
 
     # Back to the list found_included_files that we observed within our filename, we
@@ -193,7 +194,7 @@ def find_sv_included_files_within_file(filename:str,
 def get_list_sv_included_files(all_src_files:list, known_incdir_paths:list, target:str='',
                                warnings:bool=True,
                                modify_files_and_save_to_path=None,
-                               unmodified_files_link_to_path=None) -> list:
+                               unmodified_files_copy_to_path=None) -> list:
     ''' Given a list of all_src_files, and list of known_incdir_paths, returns a list
     of all included files (fullpath). This is recurisve if an included file includes another file.
 
@@ -205,7 +206,7 @@ def get_list_sv_included_files(all_src_files:list, known_incdir_paths:list, targ
         `include "foo.svh" -- no modifications
         `include "../bar.svh" -- is modified to become `include "bar.svh"
       Set to None (default) to disable.
-    unmodified_files_link_to_path -- (str: directory/path) if you wish to symlink unmodified
+    unmodified_files_copy_to_path -- (str: directory/path) if you wish to copy unmodified
       files to this path. Set to None (default) to disable.
     '''
 
@@ -220,7 +221,7 @@ def get_list_sv_included_files(all_src_files:list, known_incdir_paths:list, targ
             known_incdir_paths=known_incdir_paths,
             warnings=warnings,
             modify_files_and_save_to_path=modify_files_and_save_to_path,
-            unmodified_files_link_to_path=unmodified_files_link_to_path
+            unmodified_files_copy_to_path=unmodified_files_copy_to_path
         )
 
         for f in included_files_list:
@@ -239,7 +240,7 @@ def get_list_sv_included_files(all_src_files:list, known_incdir_paths:list, targ
                     known_incdir_paths=known_incdir_paths,
                     warnings=warnings,
                     modify_files_and_save_to_path=modify_files_and_save_to_path,
-                    unmodified_files_link_to_path=unmodified_files_link_to_path
+                    unmodified_files_copy_to_path=unmodified_files_copy_to_path
                 )
                 sv_included_files_dict[fname] = True # mark as traversed.
 
@@ -317,7 +318,7 @@ class ExportHelper:
             known_incdir_paths=self.cmd_design_obj.incdirs,
             target=self.target,
             modify_files_and_save_to_path=self.out_dir,
-            unmodified_files_link_to_path=self.out_dir
+            unmodified_files_copy_to_path=self.out_dir
         )
 
         info(f"export_helper: {self.target=} included files {self.included_files=}")
@@ -325,7 +326,7 @@ class ExportHelper:
         for filename in self.cmd_design_obj.files_non_source:
             dst = os.path.join(self.out_dir, os.path.split(filename)[1])
             if not os.path.exists(dst):
-                os.symlink(src=filename, dst=dst)
+                shutil.copy(src=filename, dst=dst)
 
     def create_deps_yml_in_out_dir(self, deps_file_args:list=list()):
         if not self.target:
@@ -449,11 +450,11 @@ class ExportHelper:
         info(f'export_helper: Wrote {dst=}')
 
         # If this was from an `export` command, and the self.out_dir != self.args['work-dir'], then
-        # link the export.json to the work-dir:
+        # copy the export.json to the work-dir:
         if self.out_dir != self.args['work-dir']:
             util.safe_mkdirs(base=self.args['work-dir'], new_dirs=['export'])
             src = os.path.abspath(os.path.join(self.out_dir, 'export.json'))
             dst = os.path.join(self.args['work-dir'], 'export', 'export.json')
             if not os.path.exists(dst):
-                os.symlink(src=src, dst=dst)
-            info(f'export_helper: Linked to {dst=}')
+                shutil.copy(src=filename, dst=dst)
+            info(f'export_helper: Copied {src=} to {dst=}')

opencos/tools/verilator.py

@@ -78,6 +78,7 @@ class VerilatorSim(CommandSim, ToolVerilator):
             'dump-vcd': False,
             'lint-only': False,
             'cc-mode': False,
+            'verilator-coverage-args': [],
         })
 
         self.args_help.update({
@@ -303,9 +304,11 @@ class VerilatorSim(CommandSim, ToolVerilator):
             verilated_post_exec_coverage_command_list = [self.verilator_coverage_exe]
             config_coverage_args = self.tool_config.get(
                 'coverage-args',
-                '--annotate logs/annotated --annotate-min 1 coverage.dat').split()
+                '--annotate logs/annotated coverage.dat').split()
+
+            verilated_post_exec_coverage_command_list += \
+                config_coverage_args + self.args['verilator-coverage-args']
 
-            verilated_post_exec_coverage_command_list += config_coverage_args
 
             return [ util.ShellCommandList(verilated_post_exec_coverage_command_list,
                                            tee_fpath='coverage.log') ] # single entry list

{opencos_eda-0.2.34.dist-info → opencos_eda-0.2.36.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.34
+Version: 0.2.36
 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.34.dist-info → opencos_eda-0.2.36.dist-info}/RECORD

@@ -1,18 +1,18 @@
 opencos/__init__.py,sha256=ZQ7aOCbP0jkIMYGdVrb-mkZX3rnvaK8epBkmp506tXU,85
 opencos/_version.py,sha256=qN7iBoOv-v4tEZz-Pu9sVUJwefshJOsgdaddn8HcHio,510
 opencos/_waves_pkg.sv,sha256=1lbhQOVGc3t_R8czYjP40hssP0I3FlZOpHTkI7yKFbI,1251
-opencos/deps_helpers.py,sha256=zM9n6k61jaW9SE7VTtfMNaF8oA9UFloEcI685NLOpIQ,56711
+opencos/deps_helpers.py,sha256=Pgo3dO_QBHzGB0lE2B0uf2vWWDy3dSDN0pvW-eA6ocs,56939
 opencos/deps_schema.py,sha256=MhytzXwp071F14RwxqHt78ak8Qruoe4FeK5XSzkO2f0,14658
 opencos/eda.py,sha256=NCsSAnWANumzP2EzlsT-TvGUEuY8ONpHo-cvTcWC2wM,21261
 opencos/eda_base.py,sha256=Fi21IIKvYIzyj_vQtaqPwrUXDaszfIixoB80-TQMM2k,77455
 opencos/eda_config.py,sha256=CXfFVW4QOtP1gpMcX8JhCe93_aibcdbGoS7RAiYQnOs,8561
-opencos/eda_config_defaults.yml,sha256=V4Pns5x77GzN6O-azBHwpOEKRDrLmlqIa89GFQnrrJ8,9218
+opencos/eda_config_defaults.yml,sha256=4ryY9THfaeL2kclo5KLkC7F1_g7FbjVzDMQFdAsvTl0,9195
 opencos/eda_config_max_verilator_waivers.yml,sha256=lTAU4IOEbUWVlPzuer1YYhIyxpPINeA4EJqcRIT-Ymk,840
 opencos/eda_config_reduced.yml,sha256=2mV9CiUEj_tyJnQsC9_k0RlxuBrky0zW1HX2xlDVEjU,1469
-opencos/eda_deps_bash_completion.bash,sha256=X0ennY88UmwevqW9Ihi_kPyOnmkGa-23_k1v_zvRvkc,1960
-opencos/eda_extract_deps_keys.py,sha256=o3GR-W3wLERRa36f_2jOcyM5iemMYHD8oBq_RQQKM-0,2411
+opencos/eda_deps_bash_completion.bash,sha256=BmCZNnRBioiPf93qwjtOmIPdDeHes0ojS_s_k4jhMoo,1950
+opencos/eda_extract_targets.py,sha256=Qc4IEx82ZNY2bLNYY0htpB4XLT-Mr2JQfPriyRigWkI,3467
 opencos/eda_tool_helper.py,sha256=MxNd_ImyA13DZbzMol1R5H8tJZddJfqyDgFVR2ad374,1666
-opencos/export_helper.py,sha256=EBlfJcA5dN176UnaXjUgLhCN1Vu5jBTI1EzL9w4j5gM,19662
+opencos/export_helper.py,sha256=2SfzHM3m6b5Wh-OMgRWv5I_A95MHIYBn8-H_P3YC7ZQ,19680
 opencos/export_json_convert.py,sha256=KsP1ESmSWs8ouecDC5ikuwOFZNJtLjmiYOvYLeN5UZU,3768
 opencos/files.py,sha256=IB-hTRrVQx884GNqdJX1V1ikSRUS1Vwu-B3yX0AN6FI,1495
 opencos/names.py,sha256=LMhAE5UH5LEy4zqHp3rOe6tP26i_Dka6JOJzKMo_bkg,1201
@@ -63,13 +63,13 @@ opencos/tools/slang.py,sha256=74EDAAnN7mrrYxgxaPDaoRJZK7Se9B_HsW8Ioi2Nw44,7425
 opencos/tools/slang_yosys.py,sha256=8zLwScd3PjouuLQpLvpX837kGqYQiJ9bnButCwrmSqI,15047
 opencos/tools/surelog.py,sha256=JOMs8SqnzJ_ZL5mEdyyn3Z1r1Kc8hfbV3Pnen1YzxWA,4980
 opencos/tools/tabbycad_yosys.py,sha256=h9kkAi479cZzYfb4R9WBNY_JmR6BgVFj4s3VShnGpoA,7813
-opencos/tools/verilator.py,sha256=NNn9xF-YWFE6B8a9BNeuK-10xNCXPzACqyfKdwuqKTY,17996
+opencos/tools/verilator.py,sha256=0ZHAkkUqnsM1A4B8-u6tff3lhl-cgfDUx-Dq7DaRwkI,18080
 opencos/tools/vivado.py,sha256=cL5IZdudqquddvZqHQGDVmaHSxgBZsMUmAq18q8AgoM,39134
 opencos/tools/yosys.py,sha256=Nov3zKyliZ6rHwMbH4f8XEkoo9H66T2-MN-KNQTjWFk,3530
-opencos_eda-0.2.34.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-opencos_eda-0.2.34.dist-info/licenses/LICENSE.spdx,sha256=8gn1610RMP6eFgT3Hm6q9VKXt0RvdTItL_oxMo72jII,189
-opencos_eda-0.2.34.dist-info/METADATA,sha256=aaIwkGXIKulNSdvr33AIA_v89iT4i5YiTp6rYwt_3ZM,604
-opencos_eda-0.2.34.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-opencos_eda-0.2.34.dist-info/entry_points.txt,sha256=777csZnOi0t9uC8lrdTchl9_Lu11t0UTo9xIKLNabNE,176
-opencos_eda-0.2.34.dist-info/top_level.txt,sha256=J4JDP-LpRyJqPNeh9bSjx6yrLz2Mk0h6un6YLmtqql4,8
-opencos_eda-0.2.34.dist-info/RECORD,,
+opencos_eda-0.2.36.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+opencos_eda-0.2.36.dist-info/licenses/LICENSE.spdx,sha256=8gn1610RMP6eFgT3Hm6q9VKXt0RvdTItL_oxMo72jII,189
+opencos_eda-0.2.36.dist-info/METADATA,sha256=bcp36pjsJ-jZgB8xXIiaYRKT86yOHYl_cBgKHaMVDDI,604
+opencos_eda-0.2.36.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+opencos_eda-0.2.36.dist-info/entry_points.txt,sha256=V8OE1lySAFcFQpDNJuVxVZteeSmDH-joLMhGvrxrvmg,164
+opencos_eda-0.2.36.dist-info/top_level.txt,sha256=J4JDP-LpRyJqPNeh9bSjx6yrLz2Mk0h6un6YLmtqql4,8
+opencos_eda-0.2.36.dist-info/RECORD,,

{opencos_eda-0.2.34.dist-info → opencos_eda-0.2.36.dist-info}/entry_points.txt

@@ -1,5 +1,5 @@
 [console_scripts]
 eda = opencos.eda:main_cli
 eda_deps_schema = opencos.deps_schema:main
-eda_extract_deps_keys = opencos.eda_extract_deps_keys:main
+eda_targets = opencos.eda_extract_targets:main
 oc_cli = opencos.oc_cli:main

opencos/eda_extract_deps_keys.py

@@ -1,81 +0,0 @@
-#!/usr/bin/env python3
-
-'''
-Helper pymodule used by eda_deps_bash_completion.bash, extracts valid
-targets from DEPS files
-'''
-
-import sys
-import os
-import json
-
-import yaml
-import toml
-
-from opencos.deps_helpers import get_deps_markup_file
-
-def get_markup_table_keys(partial_path='./') -> list:
-    '''Returns a list of root level keys for DEPS.[yml|yaml|toml|json]
-
-    Does not include DEFAULTS.
-    '''
-    partial_target = ''
-    if not partial_path or partial_path == '.':
-        partial_path = './'
-
-    if not os.path.exists(partial_path):
-        partial_path, partial_target = os.path.split(partial_path)
-    if not partial_path:
-        partial_path = './'
-
-    filepath = get_deps_markup_file(base_path=partial_path)
-    if not filepath:
-        # Couldn't find a DEPS file, let bash completion handle it (with -W words or -G glob)
-        return []
-
-    data = {}
-    _, file_ext = os.path.splitext(filepath)
-    try:
-        if file_ext in ['', '.yml', 'yaml']:
-            with open(filepath, 'r', encoding='utf-8') as f:
-                data = yaml.safe_load(f)
-        elif file_ext == '.toml':
-            data = toml.load(filepath)
-        elif file_ext == '.json':
-            with open(filepath, 'r', encoding='utf-8') as f:
-                data = json.load(f)
-    except Exception: # pylint: disable=broad-exception-caught
-        return []
-
-    if not isinstance(data, dict):
-        # We found a DEPS file, but it wasn't a table/dict so we can't return root keys
-        return []
-
-    # Try to resolve path/to/target/partial_target_
-    # -- prepend path information to found targets in path/to/target/DEPS
-    prepend = ''
-    if partial_path and partial_path != './':
-        prepend = partial_path
-        if not partial_path.endswith('/'):
-            prepend += '/'
-
-    # Return the list of keys w/ prepended path information, and don't include
-    # uppercase strings like 'DEFAULTS' or 'METADATA'
-    return [
-        prepend + x for x in list(data.keys()) if x.startswith(partial_target) and not x.isupper()
-    ]
-
-
-def main() -> None:
-    '''Returns None, prints DEPS keys space separated, uses sys.argv for a single
-    partial path arg (DEPS file to examine)'''
-
-    if len(sys.argv) > 1:
-        partial_path = sys.argv[1]
-    else:
-        partial_path = './'
-    keys = get_markup_table_keys(partial_path)
-    print(" ".join(keys))
-
-if __name__ == "__main__":
-    main()