cocotb 2.0.0rc2__cp313-cp313-macosx_11_0_arm64.whl

cocotb_tools/sim_versions.py

@@ -0,0 +1,140 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# type: ignore  # distutils is untyped, so there's little reason to check this file
+
+"""
+Classes to compare simulation versions.
+
+These are for cocotb-internal use only.
+
+.. warning::
+    These classes silently allow comparing versions of different simulators.
+"""
+
+from cocotb_tools._vendor.distutils_version import LooseVersion
+
+
+class ActivehdlVersion(LooseVersion):
+    """Version numbering class for Aldec Active-HDL.
+
+    NOTE: unsupported versions exist, e.g.
+    ActivehdlVersion("10.5a.12.6914") > ActivehdlVersion("10.5.216.6767")
+    """
+
+
+class CvcVersion(LooseVersion):
+    """Version numbering class for Tachyon DA CVC.
+
+    Example:
+        >>> CvcVersion(
+        ...     "OSS_CVC_7.00b-x86_64-rhel6x of 07/07/14 (Linux-elf)"
+        ... ) > CvcVersion("OSS_CVC_7.00a-x86_64-rhel6x of 07/07/14 (Linux-elf)")
+        True
+    """
+
+
+class GhdlVersion(LooseVersion):
+    """Version numbering class for GHDL."""
+
+
+class IcarusVersion(LooseVersion):
+    """Version numbering class for Icarus Verilog.
+
+    Example:
+        >>> IcarusVersion("11.0 (devel)") > IcarusVersion("10.3 (stable)")
+        True
+        >>> IcarusVersion("10.3 (stable)") <= IcarusVersion("10.3 (stable)")
+        True
+    """
+
+
+class ModelsimVersion(LooseVersion):
+    """Version numbering class for Mentor ModelSim."""
+
+
+class QuestaVersion(LooseVersion):
+    """Version numbering class for Mentor Questa.
+
+    Example:
+        >>> QuestaVersion("10.7c 2018.08") > QuestaVersion("10.7b 2018.06")
+        True
+        >>> QuestaVersion("2020.1 2020.01") > QuestaVersion("10.7c 2018.08")
+        True
+        >>> QuestaVersion("2020.1 2020.01") == QuestaVersion("2020.1")
+        True
+        >>> QuestaVersion("2023.1_2 2023.03") > QuestaVersion("2023.1_1")
+        True
+    """
+
+    def parse(self, vstring):
+        # A Questa version string, as returned by the simulator, consists of two
+        # space-separated parts. The first part is the actual version number,
+        # the second part seems to be the year and month of the initial release.
+        # We only need the first part, which is also used in public
+        # communication by Siemens.
+        try:
+            first_component = vstring.split(" ", 1)[0]
+        except IndexError:
+            first_component = vstring
+
+        super().parse(first_component)
+
+
+class RivieraVersion(LooseVersion):
+    """Version numbering class for Aldec Riviera-PRO.
+
+    Example:
+        >>> RivieraVersion("2019.10.138.7537") == RivieraVersion("2019.10.138.7537")
+        True
+    """
+
+
+class VcsVersion(LooseVersion):
+    """Version numbering class for Synopsys VCS.
+
+    Example:
+        >>> VcsVersion("Q-2020.03-1_Full64") > VcsVersion("K-2015.09_Full64")
+        True
+    """
+
+
+class VerilatorVersion(LooseVersion):
+    """Version numbering class for Verilator.
+
+    Example:
+        >>> VerilatorVersion("4.032 2020-04-04") > VerilatorVersion("4.031 devel")
+        True
+    """
+
+
+class XceliumVersion(LooseVersion):
+    """Version numbering class for Cadence Xcelium.
+
+    Example:
+        >>> XceliumVersion("20.06-g183") > XceliumVersion("20.03-s002")
+        True
+        >>> XceliumVersion("20.07-e501") > XceliumVersion("20.06-g183")
+        True
+    """
+
+
+class IusVersion(XceliumVersion):  # inherit everything from Xcelium
+    """Version numbering class for Cadence IUS.
+
+    Example:
+        >>> IusVersion("15.20-s050") > IusVersion("15.20-s049")
+        True
+    """
+
+
+class NvcVersion(LooseVersion):
+    """Version numbering class for NVC."""
+
+    @classmethod
+    def from_commandline(cls, cmdline):
+        firstline = cmdline.split("\n")[0]
+        sim, version, *version_extra = firstline.strip().split(" ")
+        assert sim == "nvc"
+        return cls(version)

pygpi/entry.py

@@ -0,0 +1,42 @@
+import importlib
+import operator
+import os
+from typing import Callable, List, Tuple
+
+
+def load_entry(argv: List[str]) -> None:
+    """Gather entry point information by parsing :envvar:`PYGPI_USERS`."""
+
+    entry_point_str = os.environ.get(
+        "PYGPI_USERS",
+        ",".join(
+            (
+                "cocotb_tools._coverage:start_cocotb_library_coverage",
+                "cocotb.logging:_configure",
+                "cocotb._init:init_package_from_simulation",
+                "cocotb._init:run_regression",
+            )
+        ),
+    )
+
+    # Parse the entry point string of the form "module:func,module:func,...".
+    # Any failure prevents any entry points from being loaded.
+    entry_points: List[Tuple[str, str]] = []
+    try:
+        entry_points_str = entry_point_str.split(",")
+        for entry_point_str in entry_points_str:
+            entry_module_str, entry_func_str = entry_point_str.split(":")
+            # TODO maybe some basic validation of the module and function names.
+            # WITHOUT IMPORTING THEM.
+            entry_points.append((entry_module_str, entry_func_str))
+    except Exception as e:
+        raise RuntimeError(f"Failure to parse PYGPI_USERS ('{entry_point_str}')") from e
+
+    # Run all entry points.
+    # Expect failure to stop the loading of any additional entry points.
+    for entry_module_str, entry_func_str in entry_points:
+        entry_module = importlib.import_module(entry_module_str)
+        entry_func: Callable[[List[str]], object] = operator.attrgetter(entry_func_str)(
+            entry_module
+        )
+        entry_func(argv)