cocotb 1.9.2__cp311-cp311-win_amd64.whl → 2.0.0rc2__cp311-cp311-win_amd64.whl

cocotb/_sim_versions.py → cocotb_tools/sim_versions.py

@@ -2,6 +2,8 @@
 # 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.
 
@@ -11,7 +13,7 @@ These are for cocotb-internal use only.
     These classes silently allow comparing versions of different simulators.
 """
 
-from cocotb._vendor.distutils_version import LooseVersion
+from cocotb_tools._vendor.distutils_version import LooseVersion
 
 
 class ActivehdlVersion(LooseVersion):
@@ -21,25 +23,21 @@ class ActivehdlVersion(LooseVersion):
     ActivehdlVersion("10.5a.12.6914") > ActivehdlVersion("10.5.216.6767")
     """
 
-    pass
-
 
 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)")
+        >>> 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
     """
 
-    pass
-
 
 class GhdlVersion(LooseVersion):
     """Version numbering class for GHDL."""
 
-    pass
-
 
 class IcarusVersion(LooseVersion):
     """Version numbering class for Icarus Verilog.
@@ -51,14 +49,10 @@ class IcarusVersion(LooseVersion):
         True
     """
 
-    pass
-
 
 class ModelsimVersion(LooseVersion):
     """Version numbering class for Mentor ModelSim."""
 
-    pass
-
 
 class QuestaVersion(LooseVersion):
     """Version numbering class for Mentor Questa.
@@ -96,8 +90,6 @@ class RivieraVersion(LooseVersion):
         True
     """
 
-    pass
-
 
 class VcsVersion(LooseVersion):
     """Version numbering class for Synopsys VCS.
@@ -107,8 +99,6 @@ class VcsVersion(LooseVersion):
         True
     """
 
-    pass
-
 
 class VerilatorVersion(LooseVersion):
     """Version numbering class for Verilator.
@@ -118,8 +108,6 @@ class VerilatorVersion(LooseVersion):
         True
     """
 
-    pass
-
 
 class XceliumVersion(LooseVersion):
     """Version numbering class for Cadence Xcelium.
@@ -131,8 +119,6 @@ class XceliumVersion(LooseVersion):
         True
     """
 
-    pass
-
 
 class IusVersion(XceliumVersion):  # inherit everything from Xcelium
     """Version numbering class for Cadence IUS.
@@ -142,4 +128,13 @@ class IusVersion(XceliumVersion):  # inherit everything from Xcelium
         True
     """
 
-    pass
+
+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

@@ -1,26 +1,42 @@
 import importlib
+import operator
 import os
-from functools import reduce
-from types import ModuleType
-from typing import Callable, Tuple
+from typing import Callable, List, Tuple
 
 
-def load_entry() -> Tuple[ModuleType, Callable]:
-    """Gather entry point information by parsing :envvar:`PYGPI_ENTRY_POINT`."""
+def load_entry(argv: List[str]) -> None:
+    """Gather entry point information by parsing :envvar:`PYGPI_USERS`."""
+
     entry_point_str = os.environ.get(
-        "PYGPI_ENTRY_POINT", "cocotb:_initialise_testbench"
+        "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:
-        if ":" not in entry_point_str:
-            raise ValueError(
-                "Invalid PYGPI_ENTRY_POINT, missing entry function (no colon)."
-            )
-        entry_module_str, entry_func_str = entry_point_str.split(":", 1)
-        entry_module = importlib.import_module(entry_module_str)
-        entry_func = reduce(getattr, entry_func_str.split("."), entry_module)
+        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(
-            "Failure to parse PYGPI_ENTRY_POINT ('{}')".format(entry_point_str)
-        ) from e
-    else:
-        return entry_module, entry_func
+        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)

cocotb/ANSI.py

@@ -1,92 +0,0 @@
-# Copyright (c) 2013, 2018 Potential Ventures Ltd
-# Copyright (c) 2013 SolarFlare Communications Inc
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#     * Redistributions of source code must retain the above copyright
-#       notice, this list of conditions and the following disclaimer.
-#     * Redistributions in binary form must reproduce the above copyright
-#       notice, this list of conditions and the following disclaimer in the
-#       documentation and/or other materials provided with the distribution.
-#     * Neither the name of Potential Ventures Ltd,
-#       SolarFlare Communications Inc nor the
-#       names of its contributors may be used to endorse or promote products
-#       derived from this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
-# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-"""
-    Some constants for doing ANSI stuff.
-"""
-# flake8: noqa (skip this file for flake8: pypi.python.org/pypi/flake8)
-_ESCAPE = "\033["
-
-# see https://en.wikipedia.org/wiki/ANSI_escape_code#Colors
-
-DEFAULT_FG = _ESCAPE + "39m"
-DEFAULT_BG = _ESCAPE + "49m"
-DEFAULT = DEFAULT_BG + DEFAULT_FG
-
-BLACK_FG = _ESCAPE + "30m"
-RED_FG = _ESCAPE + "31m"
-GREEN_FG = _ESCAPE + "32m"
-YELLOW_FG = _ESCAPE + "33m"
-BLUE_FG = _ESCAPE + "34m"
-MAGENTA_FG = _ESCAPE + "35m"
-CYAN_FG = _ESCAPE + "36m"
-WHITE_FG = _ESCAPE + "37m"
-
-BLACK_BG = _ESCAPE + "40m"
-RED_BG = _ESCAPE + "41m"
-GREEN_BG = _ESCAPE + "42m"
-YELLOW_BG = _ESCAPE + "43m"
-BLUE_BG = _ESCAPE + "44m"
-MAGENTA_BG = _ESCAPE + "45m"
-CYAN_BG = _ESCAPE + "46m"
-WHITE_BG = _ESCAPE + "47m"
-
-BRIGHT_BLACK_FG = _ESCAPE + "90m"
-BRIGHT_RED_FG = _ESCAPE + "91m"
-BRIGHT_GREEN_FG = _ESCAPE + "92m"
-BRIGHT_YELLOW_FG = _ESCAPE + "93m"
-BRIGHT_BLUE_FG = _ESCAPE + "94m"
-BRIGHT_MAGENTA_FG = _ESCAPE + "95m"
-BRIGHT_CYAN_FG = _ESCAPE + "96m"
-BRIGHT_WHITE_FG = _ESCAPE + "97m"
-
-BRIGHT_BLACK_BG = _ESCAPE + "100m"
-BRIGHT_RED_BG = _ESCAPE + "101m"
-BRIGHT_GREEN_BG = _ESCAPE + "102m"
-BRIGHT_YELLOW_BG = _ESCAPE + "103m"
-BRIGHT_BLUE_BG = _ESCAPE + "104m"
-BRIGHT_MAGENTA_BG = _ESCAPE + "105m"
-BRIGHT_CYAN_BG = _ESCAPE + "106m"
-BRIGHT_WHITE_BG = _ESCAPE + "107m"
-
-
-COLOR_DEFAULT = DEFAULT
-
-COLOR_WARNING = YELLOW_FG
-COLOR_ERROR = RED_FG
-COLOR_CRITICAL = RED_BG + BLACK_FG
-COLOR_TEST = BLUE_FG
-COLOR_PASSED = GREEN_FG
-COLOR_SKIPPED = YELLOW_FG
-COLOR_FAILED = RED_FG
-
-COLOR_HILITE_SUMMARY = WHITE_FG + RED_BG
-COLOR_HILITE_HEXDIFF_DEFAULT = YELLOW_FG
-COLOR_HILITE_HEXDIFF_1 = CYAN_FG
-COLOR_HILITE_HEXDIFF_2 = RED_FG
-COLOR_HILITE_HEXDIFF_3 = MAGENTA_BG
-COLOR_HILITE_HEXDIFF_4 = CYAN_BG + BLACK_FG