cocotb 1.8.1__cp38-cp38-win32.whl → 1.9.0rc2__cp38-cp38-win32.whl

cocotb/_version.py

@@ -5,4 +5,4 @@
 # 1) we don't load dependencies by storing it in __init__.py
 # 2) we can import it in setup.py for the same reason
 # 3) we can import it into your module
-__version__ = "1.8.1"
+__version__ = "1.9.0rc2"

cocotb/binary.py

@@ -31,11 +31,34 @@ import os
 import random
 import re
 import warnings
+from enum import Enum
+
+from cocotb._deprecation import deprecated
 
 _RESOLVE_TO_0 = "-lL"
 _RESOLVE_TO_1 = "hH"
 _RESOLVE_TO_CHOICE = "xXzZuUwW"
-resolve_x_to = os.getenv("COCOTB_RESOLVE_X", "VALUE_ERROR")
+
+
+class _ResolveXToValue(Enum):
+    VALUE_ERROR = "VALUE_ERROR"
+    ZEROS = "ZEROS"
+    ONES = "ONES"
+    RANDOM = "RANDOM"
+
+
+def _resolve_x_to_from_env() -> _ResolveXToValue:
+    env_value = os.getenv("COCOTB_RESOLVE_X", "VALUE_ERROR")
+    try:
+        return _ResolveXToValue(env_value)
+    except ValueError:
+        raise ValueError(
+            "The COCOTB_RESOLVE_X environment variable is set to an unknown "
+            f"value: {env_value!r}"
+        )
+
+
+resolve_x_to = _resolve_x_to_from_env()
 
 
 class _ResolveTable(dict):
@@ -55,19 +78,21 @@ class _ResolveTable(dict):
 
         self.resolve_x = no_resolve
 
-        if resolve_x_to == "VALUE_ERROR":
+        if resolve_x_to == _ResolveXToValue.VALUE_ERROR:
 
             def resolve_error(key):
                 raise ValueError(
-                    "Unresolvable bit in binary string: '{}'".format(chr(key))
+                    f"Unresolvable bit in binary string: {chr(key)!r}. "
+                    "Set the COCOTB_RESOLVE_X environment variable to "
+                    "configure how special values are resolved."
                 )
 
             self.resolve_x = resolve_error
-        elif resolve_x_to == "ZEROS":
+        elif resolve_x_to == _ResolveXToValue.ZEROS:
             self.update({ord(k): ord("0") for k in _RESOLVE_TO_CHOICE})
-        elif resolve_x_to == "ONES":
+        elif resolve_x_to == _ResolveXToValue.ONES:
             self.update({ord(k): ord("1") for k in _RESOLVE_TO_CHOICE})
-        elif resolve_x_to == "RANDOM":
+        elif resolve_x_to == _ResolveXToValue.RANDOM:
 
             def resolve_random(key):
                 # convert to correct Unicode ordinal:
@@ -376,11 +401,13 @@ class BinaryValue:
         self._str = self._convert_to(val)
 
     @property
+    @deprecated("Use `bv.integer` instead.")
     def value(self):
         """Integer access to the value. **deprecated**"""
         return self.integer
 
     @value.setter
+    @deprecated("Use `bv.integer` instead.")
     def value(self, val):
         self.integer = val
 
@@ -539,14 +566,19 @@ class BinaryValue:
         return False
 
     def __eq__(self, other):
-        if isinstance(other, BinaryValue):
-            other = other.value
-        return self.value == other
-
-    def __ne__(self, other):
-        if isinstance(other, BinaryValue):
-            other = other.value
-        return self.value != other
+        if isinstance(other, (BinaryValue, LogicArray)):
+            return self.binstr == other.binstr
+        elif isinstance(other, int):
+            try:
+                return self.integer == other
+            except ValueError:
+                return False
+        elif isinstance(other, str):
+            return self.binstr == other
+        elif isinstance(other, Logic):
+            return self.binstr == str(other)
+        else:
+            return NotImplemented
 
     def __int__(self):
         return self.integer
@@ -818,6 +850,8 @@ class BinaryValue:
                 )
 
 
+from cocotb.types import Logic, LogicArray  # noqa: E402
+
 if __name__ == "__main__":
     import doctest
 

cocotb/config.py

@@ -43,6 +43,7 @@ import argparse
 import os
 import sys
 import textwrap
+from pathlib import Path
 
 import find_libpython
 
@@ -50,14 +51,10 @@ import cocotb
 
 __all__ = ["share_dir", "makefiles_dir", "libs_dir"]
 
-
-share_dir = os.path.join(os.path.dirname(cocotb.__file__), "share")
-makefiles_dir = os.path.join(os.path.dirname(cocotb.__file__), "share", "makefiles")
-libs_dir = os.path.join(os.path.dirname(cocotb.__file__), "libs")
-
-# On Windows use mixed mode "c:/a/b/c" as this work in all cases
-if os.name == "nt":
-    libs_dir = libs_dir.replace("\\", "/")
+base_dir = Path(cocotb.__file__).parent.resolve()
+share_dir = base_dir.joinpath("share").as_posix()
+makefiles_dir = base_dir.joinpath("share").joinpath("makefiles").as_posix()
+libs_dir = base_dir.joinpath("libs").as_posix()
 
 
 def help_vars_text():
@@ -130,6 +127,7 @@ def lib_name(interface: str, simulator: str) -> str:
         "riviera",
         "activehdl",
         "cvc",
+        "nvc",
     ]
     if simulator not in supported_sims:
         raise ValueError(
@@ -167,18 +165,14 @@ def lib_name_path(interface, simulator):
     """
     library_name_path = os.path.join(libs_dir, lib_name(interface, simulator))
 
-    # On Windows use mixed mode "c:/a/b/c" as this work in all cases
-    if os.name == "nt":
-        return library_name_path.replace("\\", "/")
-
-    return library_name_path
+    return Path(library_name_path).as_posix()
 
 
 def _findlibpython():
     libpython_path = find_libpython.find_libpython()
     if libpython_path is None:
         sys.exit(1)
-    return libpython_path
+    return Path(libpython_path).as_posix()
 
 
 class PrintAction(argparse.Action):
@@ -205,9 +199,9 @@ class PrintFuncAction(argparse.Action):
 
 
 def get_parser():
-    prefix_dir = os.path.dirname(os.path.dirname(cocotb.__file__))
+    prefix_dir = base_dir.parent.resolve().as_posix()
     version = cocotb.__version__
-    python_bin = sys.executable
+    python_bin = Path(sys.executable).as_posix()
 
     parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
     parser.add_argument(

cocotb/decorators.py

@@ -140,7 +140,8 @@ class external:
 class _decorator_helper(type):
     """
     Metaclass that allows a type to be constructed using decorator syntax,
-    passing the decorated function as the first argument.
+    passing the decorated function as the first argument. Supports
+    construction with or without having the type called.
 
     So:
 
@@ -154,6 +155,11 @@ class _decorator_helper(type):
     """
 
     def __call__(cls, *args, **kwargs):
+        if len(args) == 1 and callable(args[0]):  # case without parenthesis
+            f = args[0]
+            return type.__call__(cls, f, **kwargs)
+
+        # case with parenthesis
         def decorator(f):
             # fall back to the normal way of constructing an object, now that
             # we have all the arguments

cocotb/handle.py

@@ -403,7 +403,7 @@ class HierarchyArrayObject(RegionObject):
 
         result = re.match(rf"{self._name}__(?P<index>\d+)$", name)
         if not result:
-            result = re.match(rf"{self._name}\((?P<index>\d+)\)$", name)
+            result = re.match(rf"{self._name}\((?P<index>\d+)\)$", name, re.IGNORECASE)
         if not result:
             result = re.match(rf"{self._name}\[(?P<index>\d+)\]$", name)