SimplHDL 0.5.4__tar.gz → 0.5.6__tar.gz

{simplhdl-0.5.4 → simplhdl-0.5.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SimplHDL
-Version: 0.5.4
+Version: 0.5.6
 Summary: A framework for simulating and implementing HDL designs
 Author-email: Rasmus Grøndahl Olsen <simplhdl@gmail.com>
 Maintainer-email: Rasmus Grøndahl Olsen <simplhdl@gmail.com>

{simplhdl-0.5.4 → simplhdl-0.5.6}/src/SimplHDL.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SimplHDL
-Version: 0.5.4
+Version: 0.5.6
 Summary: A framework for simulating and implementing HDL designs
 Author-email: Rasmus Grøndahl Olsen <simplhdl@gmail.com>
 Maintainer-email: Rasmus Grøndahl Olsen <simplhdl@gmail.com>

simplhdl-0.5.6/src/simplhdl/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.5.6"

{simplhdl-0.5.4 → simplhdl-0.5.6}/src/simplhdl/__main__.py

@@ -5,8 +5,9 @@ import logging
 import traceback
 
 from typing import Sequence
-
 from pathlib import Path
+from rich.logging import RichHandler
+
 from . import __version__
 from .simplhdl import Simplhdl
 from .plugins import load_plugins
@@ -67,7 +68,18 @@ def main():
         args = parse_arguments()
         levels = [logging.INFO, logging.DEBUG, logging.NOTSET]
         level = levels[min(args.verbose, len(levels)-1)]
-        logging.basicConfig(level=level)
+        if level < logging.INFO:
+            show_path = True
+        else:
+            show_path = False
+
+        FORMAT = "[simplhdl.%(module)s] - %(message)s"
+        console = RichHandler(level=level, show_time=False, rich_tracebacks=True, show_path=show_path)
+        logging.basicConfig(
+            level=5,
+            format=FORMAT,
+            handlers=[console]
+        )
         simpl = Simplhdl(args)
         simpl.run()
     except (NotImplementedError, FileNotFoundError, CalledShError,

{simplhdl-0.5.4 → simplhdl-0.5.6}/src/simplhdl/cocotb.py

@@ -41,7 +41,7 @@ class Cocotb:
             return None
         set_ = set()
         try:
-            modules = self.project.DefaultDesign._topLevel.split()
+            modules = self.project.DefaultDesign.TopLevel.split()
         except AttributeError:
             raise FlowError("No top levels found")
 
@@ -58,14 +58,14 @@ class Cocotb:
 
     def hdltoplevels(self) -> str:
         tops = []
-        for t in self.project.DefaultDesign._topLevel.split():
+        for t in self.project.DefaultDesign.TopLevel.split():
             if t != self.top:
                 tops.append(t)
         return ' '.join(tops)
 
     def get_dut(self) -> str:
         try:
-            for top in self.project.DefaultDesign._topLevel.split():
+            for top in self.project.DefaultDesign.TopLevel.split():
                 if top != self.top:
                     return top
         except AttributeError:
@@ -97,13 +97,15 @@ class Cocotb:
                     with open(file.Path, 'r', errors='replace') as f:
                         lines = f.readlines()
                         for line in lines:
-                            if re.search(rf'^\s*module\s+{name}(\s+|\(|;|$)', line):
+                            if re.search(rf'^\s*module\s+{name}(\s+|#\(|\(|;|$)', line):
                                 if file.Library.Name == lib:
                                     logger.info(f"Cocotb dut '{self.dut}' is Verilog")
                                     return VerilogSourceFile
                                 else:
-                                    logger.warning(f"Found HDL module {name} in ",
-                                                   f"library '{file.Library.Name}' expected '{lib}'")
+                                    logger.warning(
+                                        f"Found HDL module {name} in "
+                                        f"library '{file.Library.Name}' expected '{lib}'"
+                                    )
                 else:
                     continue
         except UnicodeDecodeError:

{simplhdl-0.5.4 → simplhdl-0.5.6}/src/simplhdl/flow.py

@@ -1,3 +1,5 @@
+import logging
+
 from argparse import Namespace
 from pathlib import Path
 from typing import Callable, Dict, Set
@@ -16,6 +18,11 @@ class FlowBase(metaclass=ABCMeta):
         self.builddir: Path = builddir
         self.category: FlowCategory = FlowCategory.DEFAULT
         self.tools: Set = set()
+        self.builddir.mkdir(parents=True, exist_ok=True)
+        file = logging.FileHandler(self.builddir.joinpath('simplhdl.log'), mode='w')
+        file.setLevel(logging.NOTSET)
+        file.setFormatter(logging.Formatter('%(asctime)s - %(levelname)s:%(filename)s:%(lineno)d - %(message)s'))
+        logging.getLogger().addHandler(file)
 
     @classmethod
     @abstractmethod

{simplhdl-0.5.4 → simplhdl-0.5.6}/src/simplhdl/flows/flake8/flake8flow.py

@@ -49,7 +49,7 @@ class Flake8Flow(FlowBase):
             self.files = [f.Path for f in self.project.DefaultDesign.DefaultFileSet.Files(PythonSourceFile)]
 
     def generate(self):
-        config = os.getenv('SIMPLHDL_FLAKE8_RULES')
+        config = os.getenv('SIMPLHDL_FLAKE8_CONFIG')
         if config:
             shutil.copy(config, self.builddir.joinpath('setup.cfg'))
         else:

{simplhdl-0.5.4 → simplhdl-0.5.6}/src/simplhdl/flows/verible/veribleflow.py

@@ -8,7 +8,7 @@ from argparse import Namespace
 from pathlib import Path
 from jinja2 import Environment, FileSystemLoader
 
-from simplhdl.flow import FlowFactory, FlowBase
+from simplhdl.flow import FlowFactory, FlowBase, FlowError
 from simplhdl.resources.templates import verible as templates
 from simplhdl.utils import sh, CalledShError, generate_from_template
 from simplhdl.pyedaa import VerilogIncludeFile, VerilogSourceFile, SystemVerilogSourceFile
@@ -51,8 +51,11 @@ class VeribleFlow(FlowBase):
     def generate(self):
         if self.args.rules:
             self.rules = self.args.rules
-        elif os.getenv('SIMPLHDL_VERIBLE_RULES'):
-            self.rules = self.args.rules
+        elif os.getenv('SIMPLHDL_VERIBLE_CONFIG'):
+            rules = os.getenv('SIMPLHDL_VERIBLE_CONFIG')
+            if not Path(rules).exists():
+                raise FlowError(f"Rules file {rules} does not exist")
+            self.rules = rules
         else:
             templatedir = resources_files(self.templates)
             environment = Environment(
@@ -67,7 +70,7 @@ class VeribleFlow(FlowBase):
         command = [
             "verible-verilog-lint",
             "--check_syntax=false",
-            "--ruleset=all",
+            "--ruleset=none",
             "--rules_config", self.rules
         ]
 

{simplhdl-0.5.4 → simplhdl-0.5.6}/src/simplhdl/flows/vsg/vsgflow.py

@@ -74,8 +74,11 @@ class VsgFlow(FlowBase):
                                UsedIn=UsedIn)
         if self.args.rules:
             self.rules = self.args.rules
-        elif os.getenv('SIMPLHDL_VSG_RULES'):
-            self.rules = self.args.rules
+        elif os.getenv('SIMPLHDL_VSG_CONFIG'):
+            rules = os.getenv('SIMPLHDL_VSG_CONFIG')
+            if not Path(rules).exists():
+                raise FlowError(f"Rules file {rules} does not exist")
+            self.rules = rules
         else:
             template = environment.get_template('rules.yml.j2')
             generate_from_template(template, self.builddir)

{simplhdl-0.5.4 → simplhdl-0.5.6}/src/simplhdl/generators/spd.py

@@ -5,7 +5,7 @@ from typing import List, Generator, Optional
 from pathlib import Path
 from xml.etree.ElementTree import Element, parse
 from zipfile import ZipFile
-from shutil import copy, copytree, rmtree
+from shutil import copy, copytree, rmtree, ignore_patterns
 
 from simplhdl.pyedaa import (
     File,
@@ -72,6 +72,7 @@ class Spd:
             sh(command, cwd=filename.parent)
             if not spdfile.exists():
                 raise FileNotFoundError(f"{spdfile}: doesn't exits")
+        logger.debug(f"Parse {spdfile}")
         self.tree = parse(spdfile)
         self.root = self.tree.getroot()
         self.location = spdfile.parent.absolute()
@@ -222,7 +223,7 @@ class QuartusIP(GeneratorBase):
             seen[fileid] = file
 
 
-def parse_qsys(filename: QuartusQSYSSpecificationFile) -> List[File]:
+def get_list_of_ipfiles(filename: QuartusQSYSSpecificationFile) -> List[File]:
     """
     Search for IP files in a QSYS file and return a list of QuartusIPSpecificationFile objects.
     """
@@ -234,6 +235,15 @@ def parse_qsys(filename: QuartusQSYSSpecificationFile) -> List[File]:
             if m:
                 ipfile = filename.Path.parent.joinpath(m.group(1))
                 if ipfile.exists():
+                    logger.debug(f"Found {ipfile} in {filename.Path}")
+                    files.append(QuartusIPSpecificationFile(ipfile))
+                else:
+                    logger.warning(f"File {ipfile} not found")
+            m = re.search(r'<parameter name="logicalView">(.*\.ip)</parameter>', line)
+            if m:
+                ipfile = filename.Path.parent.joinpath(m.group(1))
+                if ipfile.exists():
+                    logger.debug(f"Found {ipfile} in {filename.Path}")
                     files.append(QuartusIPSpecificationFile(ipfile))
                 else:
                     logger.warning(f"File {ipfile} not found")
@@ -244,10 +254,10 @@ def qsys_to_fileset(file: QuartusQSYSSpecificationFile, flow: FlowBase, library)
     """
     Parse a QSYS file and return a FileSet object.
     """
-    ipfiles = parse_qsys(file)
+    ipfiles = get_list_of_ipfiles(file)
     if flow.category == FlowCategory.SIMULATION:
         parent = file.FileSet
-        for ipfile in ipfiles + [file]:
+        for ipfile in [file] + ipfiles:
             spd = Spd(ipfile.Path, flow, file.Path.parent.absolute())
             for fileset in reversed(spd.filesets):
                 # Add fileset to parent, then set parent to fileset to make a chain
@@ -290,14 +300,14 @@ def copy_ipfile(file: QuartusIPSpecificationFile, dest: Path) -> QuartusIPSpecif
     destfile = dest.joinpath(file.Path.name)
     if srcdir.exists():
         if not md5file.exists() or not md5check(file.Path, srcdir, filename=md5file):
-            logger.info(f"Copy {file.Path} to {destfile}")
-            logger.info(f"Copy {srcdir} to {destdir}")
+            logger.debug(f"Copy {file.Path} to {destfile}")
+            logger.debug(f"Copy {srcdir} to {destdir}")
             copy(str(file.Path), str(destfile))
             copytree(str(srcdir), str(destdir), dirs_exist_ok=True)
             md5write(file.Path, srcdir, filename=md5file)
     else:
         if not md5file.exists() or not md5check(file.Path, filename=md5file):
-            logger.info(f"Copy {file.Path} to {destfile}")
+            logger.debug(f"Copy {file.Path} to {destfile}")
             rmtree(destdir, ignore_errors=True)
             copy(str(file.Path), str(destfile))
             md5write(file.Path, filename=md5file)
@@ -311,10 +321,18 @@ def copy_qsysfile(file: QuartusQSYSSpecificationFile, dest: Path) -> QuartusQSYS
     Copy QSYS files to a directory and return a new QuartusQSYSSpecificationFile object with the new path.
     """
     md5file = dest.joinpath(file.Path.name).with_suffix('.md5')
-    qsysdir = dest.joinpath(file.Path.name)
+    qsysdir = dest.joinpath(file.Path.name).with_suffix('')
+
     src = file.Path.parent
     if not md5file.exists() or not md5check(src, filename=md5file):
-        copytree(str(src), str(qsysdir), dirs_exist_ok=True)
+        logger.debug(f"Copy {file.Path} to {qsysdir}")
+        # If destination is a subdirectory of source the copytree will have
+        # to ignore this subdirectory
+        if qsysdir.absolute().is_relative_to(src.absolute()):
+            ignoredir = qsysdir.absolute().relative_to(src.absolute()).parents[-2]
+            copytree(str(src), str(qsysdir), dirs_exist_ok=True, ignore=ignore_patterns(ignoredir))
+        else:
+            copytree(str(src), str(qsysdir), dirs_exist_ok=True)
         md5write(src, filename=md5file)
     file._fileType = QuartusQSYSSpecificationFile
     file._path = qsysdir.joinpath(file.Path.name).with_suffix('.qsys').resolve()
@@ -355,7 +373,7 @@ def unpack(file: Path, dest: Path) -> None:
     """
     Unpack a file to a directory and return the new path.
     """
-    md5file = dest.joinpath(file.name).with_suffix('.md5')
+    md5file = dest.parent.joinpath(file.name).with_suffix('.md5')
     if not md5file.exists() or not md5check(file, filename=md5file):
         logger.info(f"Unpack {file} to {dest}")
         with ZipFile(file, 'r') as zip:

{simplhdl-0.5.4 → simplhdl-0.5.6}/src/simplhdl/pyedaa/design.py

@@ -39,15 +39,16 @@ class Design(pm.Design):
     @property
     def TopLevel(self) -> str:
         """Property setting or returning the fileset's toplevel."""
-        top = set()
+        top = list()
         if self._topLevel is not None:
             for t in self._topLevel.split():
-                top.add(t)
+                top.append(t)
         for fileset in self._fileSets.values():
             if fileset.TopLevel is not None:
                 for t in fileset.TopLevel.split():
-                    top.add(t)
-        return ' '.join(top)
+                    top.append(t)
+        # remove duplicates without changing the order
+        return ' '.join(list(dict.fromkeys(top)))
 
     @TopLevel.setter
     def TopLevel(self, value: str) -> None:

{simplhdl-0.5.4 → simplhdl-0.5.6}/src/simplhdl/utils.py

@@ -17,7 +17,7 @@ class CalledShError(Exception):
     pass
 
 
-def sh(command: List[str], cwd: Optional[Path] = None, output=False, shell=False, env=None):
+def sh(command: List[str], cwd: Optional[Path] = None, output=False, shell=False, env=None, indent=2):
     if os.name == 'nt':
         shell = True
 
@@ -26,7 +26,7 @@ def sh(command: List[str], cwd: Optional[Path] = None, output=False, shell=False
         if output:
             stdout: str = ''
             for line in p.stdout:
-                sys.stdout.buffer.write(line)
+                sys.stdout.buffer.write(b' '*indent + line)
                 sys.stdout.buffer.flush()
                 stdout += line.decode()
             _, stderr = p.communicate()

simplhdl-0.5.4/src/simplhdl/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.5.4"