opencos-eda 0.2.47__py3-none-any.whl → 0.2.49__py3-none-any.whl

opencos/peakrdl_cleanup.py

@@ -1,20 +1,26 @@
 #!/usr/bin/env python3
 
+''' peakrdl_cleanup is intended as CLI or callable via run(file-in, file-out)
+
+to apply verilator comment waivers to a SystemVerilog file
+'''
+
 import sys
-import os
 
-def run(file_in, file_out):
-    with open(file_in) as f:
+
+def run(file_in: str, file_out: str) -> None:
+    '''Returns None, writes file_out (filepath) with updates given file_in (filepath)'''
+
+    with open(file_in, encoding='utf-8') as f:
         lines = f.readlines()
 
-    with open(file_out, 'w') as f:
+    with open(file_out, 'w', encoding='utf-8') as f:
         f.write('// verilator lint_off MULTIDRIVEN\n')
         for line in lines:
             f.write(line)
         f.write('// verilator lint_on  MULTIDRIVEN\n')
 
+
 if __name__ == '__main__':
     assert len(sys.argv) == 3, f'{sys.argv=}'
-    file_in = sys.argv[1]
-    file_out = sys.argv[2]
-    run(file_in, file_out)
+    run(file_in=sys.argv[1], file_out=sys.argv[2])

opencos/seed.py

@@ -1,28 +1,36 @@
+''' opencos.seed handles getting a 'seed' int, and keeping a list of seeds.
+
+Used by opencos.command.sim and opencos.tools, because some tools prefer 32-bit uint,
+31-bit > 0, or want to avoid a seed=0
+'''
+
 import random
+import time
 
-seeds = list()
+seeds = []
 
+def get_seed(style: str = "", limit_31bit: bool = True, avoid_zero: bool = True) -> int:
+    '''Returns a random int, using python random or time.time, with constraints.
 
-def get_seed(style : str = "", limit_31bit=True, avoid_zero=True):
-    '''Returns a random int
+    Appends returned value to global list seeds.
 
     style (str)
-      -- "", default: uses python random.randint
-      -- "time"     : uses python int(time.time())
+      -- "", default: uses python random.randint 32-bit
+      -- "time"     : uses python time.time_ns() 32-bit LSBs
     '''
 
-    global seeds
     seed = 1
 
     if style.lower() == "time":
-        seed = int(time.time())
+        # use the float value fractional portion
+        seed = time.time_ns() & 0xFFFF_FFFF
     else:
-        seed = random.randint(0, 0xFFFFFFFF)
+        seed = random.randint(0, 0xFFFF_FFFF)
 
-    if limit_31bit and seed >> 31:
-        seed >>= 1
+    if limit_31bit:
+        seed &= 0x7FFF_FFFF
     if avoid_zero and seed == 0:
-        seed += 1
+        seed = 1
 
     seeds.append(seed)
     return seed

opencos/tests/helpers.py

@@ -9,8 +9,9 @@ from pathlib import Path
 
 from contextlib import redirect_stdout, redirect_stderr
 
-from opencos import eda, util
+from opencos import eda
 from opencos import deps_schema
+from opencos.utils.markup_helpers import yaml_safe_load
 
 def can_run_eda_command(*commands, config: dict) -> bool:
     '''Returns True if we have any installed tool that can run: eda <command>'''
@@ -74,7 +75,7 @@ def assert_gen_deps_yml_good(filepath:str, want_target:str='') -> dict:
 
     so we also confirm they pass the deps_schema.FILE_SIMPLIFIED'''
     assert os.path.exists(filepath), f'{filepath=} does not exist'
-    data = util.yaml_safe_load(filepath)
+    data = yaml_safe_load(filepath)
     assert len(data.keys()) > 0
     if want_target:
         assert want_target, f'{want_target=} not in {filepath=} {data=}'
@@ -124,20 +125,35 @@ def assert_export_jsonl_good(filepath:str, jsonl:bool=True) -> list:
 class Helpers:
     '''We do so much with logging in this file, might as well make it reusable'''
     DEFAULT_DIR = ''
-    DEFAULT_LOG = 'eda.log'
+    DEFAULT_LOG_DIR = os.getcwd()
+    DEFAULT_LOG = os.path.join(DEFAULT_LOG_DIR, '.pytest.eda.log')
     def chdir(self):
         '''Changes directory to self.DEFAULT_DIR and removes eda.work, eda.export paths'''
         chdir_remove_work_dir('', self.DEFAULT_DIR)
 
+    def _resolve_logfile(self, logfile=None) -> str:
+        '''Returns the logfile's filepath'''
+        ret = logfile
+        if ret is None:
+            ret = self.DEFAULT_LOG
+        else:
+            left, right = os.path.split(logfile)
+            if not left or left in [os.path.sep, '.', '..']:
+                # relative logfile put in DEFAULT_LOG_DIR:
+                ret = os.path.join(self.DEFAULT_LOG_DIR, right)
+        return ret
+
     def log_it(self, command_str:str, logfile=None, use_eda_wrap=True) -> int:
         '''Replacement for calling eda.main or eda_wrap, when you want an internal logfile
 
         Usage:
-            rc = self.log_it('sim foo', logfile='yes.log')
+            rc = self.log_it('sim foo')
             assert rc == 0
+
+        Note this will run with --no-default-log to avoid a Windows problem with stomping
+        on a log file.
         '''
-        if logfile is None:
-            logfile = self.DEFAULT_LOG
+        logfile = self._resolve_logfile(logfile)
         rc = 50
 
         # TODO(drew): There are some issues with log_it redirecting stdout from vivado
@@ -148,16 +164,15 @@ class Helpers:
         with open(logfile, 'w', encoding='utf-8') as f:
             with redirect_stdout(f), redirect_stderr(f):
                 if use_eda_wrap:
-                    rc = eda_wrap(*(command_str.split()))
+                    rc = eda_wrap('--no-default-log', *(command_str.split()))
                 else:
-                    rc = eda.main(*(command_str.split()))
+                    rc = eda.main('--no-default-log', *(command_str.split()))
             print(f'Wrote: {os.path.abspath(logfile)=}')
         return rc
 
     def is_in_log(self, *want_str, logfile=None, windows_path_support=False):
         '''Check if any of want_str args are in the logfile, or self.DEFAULT_LOG'''
-        if logfile is None:
-            logfile = self.DEFAULT_LOG
+        logfile = self._resolve_logfile(logfile)
         want_str0 = ' '.join(list(want_str))
         want_str1 = want_str0.replace('/', '\\')
         with open(logfile, encoding='utf-8') as f:
@@ -169,8 +184,7 @@ class Helpers:
 
     def get_log_lines_with(self, *want_str, logfile=None, windows_path_support=False):
         '''gets all log lines with any of want_str args are in the logfile, or self.DEFAULT_LOG'''
-        if logfile is None:
-            logfile = self.DEFAULT_LOG
+        logfile = self._resolve_logfile(logfile)
         ret_list = []
         want_str0 = ' '.join(list(want_str))
         want_str1 = want_str0.replace('/', '\\')
@@ -186,8 +200,7 @@ class Helpers:
         '''gets all log lines with any of *want_str within a single word
         in the logfile or self.DEFAULT_LOG
         '''
-        if logfile is None:
-            logfile = self.DEFAULT_LOG
+        logfile = self._resolve_logfile(logfile)
         ret_list = []
         want_str0 = ' '.join(list(want_str))
         want_str1 = want_str0.replace('/', '\\')

opencos/tests/test_deps_helpers.py

@@ -1,7 +1,7 @@
-'''pytests for opencos.deps_helpers'''
+'''pytests for opencos.deps modules'''
 
-# TODO(drew): these need to be refactored if we cleanup deps_helpers.py, this still
-# uses the old DEPS (non-markup) command format, such as 'shell@some bash command'
+# TODO(drew): these need to be refactored if we cleanup opencos.deps commands;
+# this uses the old DEPS (non-markup) command format, such as 'shell@some bash command'
 
 # TODO(drew): for now, ignore long lines and docstrings
 # pylint: disable=line-too-long,missing-function-docstring
@@ -10,7 +10,9 @@ from pathlib import Path
 import os
 import pytest
 
-from opencos import eda_tool_helper, deps_helpers
+from opencos import eda_tool_helper
+
+from opencos.deps import deps_file, deps_commands
 
 THISPATH = os.path.dirname(__file__)
 
@@ -19,9 +21,9 @@ config, tools_loaded = eda_tool_helper.get_config_and_tools_loaded()
 
 
 def test_get_all_targets():
-    '''Makes sure that deps_helpers.get_all_targets(filter_str:str) works'''
+    '''Makes sure that deps_file.get_all_targets(filter_str:str) works'''
 
-    targets = deps_helpers.get_all_targets(
+    targets = deps_file.get_all_targets(
         dirs=[
             str(Path('../../lib/tests')),
             str(Path('../../lib/rams/tests')),
@@ -42,9 +44,9 @@ def test_get_all_targets():
     reason="requires vivado or verilator"
 )
 def test_get_all_targets_eda_multi():
-    '''Makes sure that deps_helpers.get_all_targets(filter_using_mult:str) works'''
+    '''Makes sure that deps_file.get_all_targets(filter_using_mult:str) works'''
 
-    targets = deps_helpers.get_all_targets(
+    targets = deps_file.get_all_targets(
         base_path=THISPATH,
         filter_using_multi='sim ../../lib/tests/*test ../../lib/rams/tests/*test',
     )
@@ -57,26 +59,26 @@ def test_get_all_targets_eda_multi():
 
 def test_parse_deps_shell_str__no_parse():
     line = 'some_file.sv'
-    d = deps_helpers.parse_deps_shell_str(line, '', '')
+    d = deps_commands.parse_deps_shell_str(line, '', '')
     assert not d, f'{d=}'
 
     line = 'some_target:'
-    d = deps_helpers.parse_deps_shell_str(line, '', '')
+    d = deps_commands.parse_deps_shell_str(line, '', '')
     assert not d, f'{d=}'
 
     line = '   csr@some_file.sv'
-    d = deps_helpers.parse_deps_shell_str(line, '', '')
+    d = deps_commands.parse_deps_shell_str(line, '', '')
     assert not d, f'{d=}'
 
 def test_parse_deps_shell_str__cp():
     line = '    shell@ cp ./oclib_fifo_test.sv oclib_fifo_test_COPY.sv ;'
-    d = deps_helpers.parse_deps_shell_str(line, '', '')
+    d = deps_commands.parse_deps_shell_str(line, '', '')
     assert d, f'{d=}'
     assert d['exec_list'] == ['cp', './oclib_fifo_test.sv', 'oclib_fifo_test_COPY.sv', ';'], f'{d=}'
 
 def test_parse_deps_shell_str__echo():
     line = '    shell@echo "hello world"'
-    d = deps_helpers.parse_deps_shell_str(line, '', '')
+    d = deps_commands.parse_deps_shell_str(line, '', '')
     assert d, f'{d=}'
     assert d['exec_list'] == ['echo', '"hello', 'world"'], f'{d=}'
 
@@ -85,10 +87,11 @@ def test_parse_deps_shell_str__enable_filepath_replacement():
     # Default is enabled.
     module_dir = os.path.dirname(os.path.abspath(__file__))
     os.chdir(module_dir)
-    line = 'shell@cp ../deps_helpers.py foo.py'
-    d = deps_helpers.parse_deps_shell_str(line, target_path='./', target_node='foo_target')
+    line = 'shell@cp ../deps/deps_commands.py .pytest.copied.py'
+    d = deps_commands.parse_deps_shell_str(line, target_path='./', target_node='foo_target')
     assert d, f'{d=}'
-    assert d['exec_list'] == ['cp', os.path.abspath('../deps_helpers.py'), 'foo.py'], f'{d=}'
+    spath = os.path.abspath(os.path.join('..', 'deps', 'deps_commands.py'))
+    assert d['exec_list'] == ['cp', spath, '.pytest.copied.py'], f'{d=}'
     assert d['target_node'] == 'foo_target'
     assert d['target_path'] == os.path.abspath('./')
 
@@ -96,11 +99,11 @@ def test_parse_deps_shell_str__disable_filepath_replacement():
     # Dealing w/ relative paths, change the current working directory to the module directory
     module_dir = os.path.dirname(os.path.abspath(__file__))
     os.chdir(module_dir)
-    line = 'shell@cp ../deps_helpers.py foo.py'
-    d = deps_helpers.parse_deps_shell_str(line, target_path='./', target_node='foo_target',
+    line = 'shell@cp ../deps/deps_commands.py .pytest.copied.py'
+    d = deps_commands.parse_deps_shell_str(line, target_path='./', target_node='foo_target',
                                           enable_filepath_subst_target_dir=False)
     assert d, f'{d=}'
-    assert d['exec_list'] == ['cp', '../deps_helpers.py', 'foo.py'], f'{d=}'
+    assert d['exec_list'] == ['cp', '../deps/deps_commands.py', '.pytest.copied.py'], f'{d=}'
     assert d['target_node'] == 'foo_target'
     assert d['target_path'] == os.path.abspath('./')
 
@@ -109,7 +112,7 @@ def test_parse_deps_shell_str__enable_dirpath_replacement():
     module_dir = os.path.dirname(os.path.abspath(__file__))
     os.chdir(module_dir)
     line = 'shell@ls -ltr ./'
-    d = deps_helpers.parse_deps_shell_str(line, target_path='./', target_node='foo_target',
+    d = deps_commands.parse_deps_shell_str(line, target_path='./', target_node='foo_target',
                                           enable_dirpath_subst_target_dir=True)
     assert d, f'{d=}'
     assert d['exec_list'] == ['ls', '-ltr', os.path.abspath('./')], f'{d=}'
@@ -122,7 +125,7 @@ def test_parse_deps_shell_str__disable_dirpath_replacement():
     module_dir = os.path.dirname(os.path.abspath(__file__))
     os.chdir(module_dir)
     line = 'shell@ls -ltr ./'
-    d = deps_helpers.parse_deps_shell_str(line, target_path='./', target_node='foo_target')
+    d = deps_commands.parse_deps_shell_str(line, target_path='./', target_node='foo_target')
     assert d, f'{d=}'
     assert d['exec_list'] == ['ls', '-ltr', './'], f'{d=}'
     assert d['target_node'] == 'foo_target'
@@ -131,26 +134,26 @@ def test_parse_deps_shell_str__disable_dirpath_replacement():
 
 def test_parse_deps_work_dir_add_srcs__no_parse():
     line = 'some_file.sv'
-    d = deps_helpers.parse_deps_work_dir_add_srcs(line, '', '')
+    d = deps_commands.parse_deps_work_dir_add_srcs(line, '', '')
     assert not d, f'{d=}'
 
     line = 'some_target:'
-    d = deps_helpers.parse_deps_work_dir_add_srcs(line, '', '')
+    d = deps_commands.parse_deps_work_dir_add_srcs(line, '', '')
     assert not d, f'{d=}'
 
     line = '   csr@some_file.sv'
-    d = deps_helpers.parse_deps_work_dir_add_srcs(line, '', '')
+    d = deps_commands.parse_deps_work_dir_add_srcs(line, '', '')
     assert not d, f'{d=}'
 
 def test_parse_deps_work_dir_add_srcs__single_file():
     line = '    work_dir_add_srcs@ single_file.txt'
-    d = deps_helpers.parse_deps_work_dir_add_srcs(line, '', '')
+    d = deps_commands.parse_deps_work_dir_add_srcs(line, '', '')
     assert d, f'{d=}'
     assert d['file_list'] == ['single_file.txt']
 
 def test_parse_deps_work_dir_add_srcs__several_file():
     line = '    work_dir_add_srcs@ single_file.txt another.sv  gen-verilog/mine.v ./gen-vhdl/wordy.vhdl'
-    d = deps_helpers.parse_deps_work_dir_add_srcs(line, '', '')
+    d = deps_commands.parse_deps_work_dir_add_srcs(line, '', '')
     assert d, f'{d=}'
     assert d['file_list'] == [
         'single_file.txt', 'another.sv', 'gen-verilog/mine.v', './gen-vhdl/wordy.vhdl'
@@ -159,34 +162,34 @@ def test_parse_deps_work_dir_add_srcs__several_file():
 
 def test_parse_deps_peakrdl__no_parse():
     line = 'some_file.sv'
-    d = deps_helpers.parse_deps_peakrdl(line, '', '')
+    d = deps_commands.parse_deps_peakrdl(line, '', '')
     assert not d, f'{d=}'
 
     line = 'some_target:'
-    d = deps_helpers.parse_deps_peakrdl(line, '', '')
+    d = deps_commands.parse_deps_peakrdl(line, '', '')
     assert not d, f'{d=}'
 
     line = '   csr@some_file.sv'
-    d = deps_helpers.parse_deps_peakrdl(line, '', '')
+    d = deps_commands.parse_deps_peakrdl(line, '', '')
     assert not d, f'{d=}'
 
 def test_parse_deps_peakrdl__with_top():
     line = '    peakrdl@ --cpuif axi4-lite-flat --top   my_fancy_csrs ./my_csrs.rdl'
-    d = deps_helpers.parse_deps_peakrdl(line, '', '')
+    d = deps_commands.parse_deps_peakrdl(line, '', '')
     assert d, f'{d=}'
     assert len(d['shell_commands_list']) > 0
     assert d['work_dir_add_srcs']['file_list'] == ['peakrdl/my_fancy_csrs_pkg.sv', 'peakrdl/my_fancy_csrs.sv']
 
 def test_parse_deps_peakrdl__with_top2():
     line = '    peakrdl@ --cpuif axi4-lite-flat --top=my_fancy_csrs ./my_csrs.rdl'
-    d = deps_helpers.parse_deps_peakrdl(line, '', '')
+    d = deps_commands.parse_deps_peakrdl(line, '', '')
     assert d, f'{d=}'
     assert len(d['shell_commands_list']) > 0
     assert d['work_dir_add_srcs']['file_list'] == ['peakrdl/my_fancy_csrs_pkg.sv', 'peakrdl/my_fancy_csrs.sv']
 
 def test_parse_deps_peakrdl__infer_top():
     line = '    peakrdl@ --cpuif axi4-lite-flat ./my_csrs.rdl'
-    d = deps_helpers.parse_deps_peakrdl(line, '', '')
+    d = deps_commands.parse_deps_peakrdl(line, '', '')
     assert d, f'{d=}'
     assert len(d['shell_commands_list']) > 0
     assert d['work_dir_add_srcs']['file_list'] == ['peakrdl/my_csrs_pkg.sv', 'peakrdl/my_csrs.sv']