Fix value type in _port.py (int, "X" or None is valid)

Author: freand76

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## vx.x.x
  - Fix validation "0", "1", "X" in yosys netlist
+ - Fix value type in _port.py (int, "X" or None is valid)
 
 ## v0.12.0
  - Use default audio output

src/digsim/circuit/_circuit.py

@@ -13,7 +13,7 @@
 from digsim.storage_model import CircuitDataClass, CircuitFileDataClass
 
 from ._waves_writer import WavesWriter
-from .components.atoms import Component, DigsimException, PortOutDelta
+from .components.atoms import VALUE_TYPE, Component, DigsimException, PortOutDelta
 
 
 class CircuitError(DigsimException):
@@ -26,10 +26,10 @@ class CircuitEvent:
     delta events in the simulation.
     """
 
-    def __init__(self, time_ns: int, port: PortOutDelta, value: int | str | None):
+    def __init__(self, time_ns: int, port: PortOutDelta, value: VALUE_TYPE):
         self._time_ns: int = time_ns
         self._port: PortOutDelta = port
-        self._value: int | str | None = value
+        self._value: VALUE_TYPE = value
 
     @property
     def time_ns(self) -> int:
@@ -42,15 +42,15 @@ def port(self) -> PortOutDelta:
         return self._port
 
     @property
-    def value(self) -> int | str | None:
+    def value(self) -> VALUE_TYPE:
         """Get the delta cycle value of this event"""
         return self._value
 
     def is_same_event(self, port: PortOutDelta):
         """Return True if the in the event is the same as"""
         return port == self._port
 
-    def update(self, time_ns: int, value: int | str | None):
+    def update(self, time_ns: int, value: VALUE_TYPE):
         """Update the event with a new time (ns) and a new value"""
         self._time_ns = time_ns
         self._value = value
@@ -231,7 +231,7 @@ def run_until(
         if stop_time_ns >= self._time_ns:
             self.run(ns=stop_time_ns - self._time_ns)
 
-    def add_event(self, port: PortOutDelta, value: int | str | None, propagation_delay_ns: int):
+    def add_event(self, port: PortOutDelta, value: VALUE_TYPE, propagation_delay_ns: int):
         """Add delta cycle event, this will also write values to .vcd file"""
         event_time_ns = self._time_ns + propagation_delay_ns
         # print(f"Add event {port.parent().name()}:{port.name()} => {value}")

src/digsim/circuit/components/atoms/__init__.py

@@ -11,6 +11,7 @@
 )
 from ._digsim_exception import DigsimException  # noqa: F401
 from ._port import (  # noqa: F401
+    VALUE_TYPE,
     Port,
     PortConnectionError,
     PortIn,

src/digsim/circuit/components/atoms/_port.py

@@ -6,10 +6,14 @@
 from __future__ import annotations
 
 import abc
+from typing import Literal, Optional, Union
 
 from ._digsim_exception import DigsimException
 
 
+VALUE_TYPE = Optional[Union[int, Literal["X"]]]
+
+
 class PortConnectionError(DigsimException):
     """Exception for illegal connections"""
 
@@ -23,8 +27,8 @@ def __init__(self, parent, name: str, width: int = 1, output: bool = False):
         self._width: int = width  # The bit-width of this port
         self._output: bool = output  # Is this port an output port
         self._wired_ports: list[Port] = []  # The ports that this port drives
-        self._value: int | str | None = None  # The value of this port
-        self._edge_detect_value: int | str | None = "X"  # Last edge detect value
+        self._value: VALUE_TYPE = None  # The value of this port
+        self._edge_detect_value: VALUE_TYPE = "X"  # Last edge detect value
         self.init()  # Initialize the port
 
     def init(self):
@@ -39,12 +43,12 @@ def wired_ports(self) -> list[Port]:
         return self._wired_ports
 
     @property
-    def value(self) -> int | str | None:
+    def value(self) -> VALUE_TYPE:
         """Get the value of the port, can be "X" """
         return self._value
 
     @value.setter
-    def value(self, value: int | str | None):
+    def value(self, value: VALUE_TYPE):
         """Set the value of the port"""
         self.set_value(value)
 
@@ -98,7 +102,7 @@ def parent(self):
         """Get parent component"""
         return self._parent
 
-    def update_wires(self, value: int | str | None):
+    def update_wires(self, value: VALUE_TYPE):
         """Update connected wires (and self._value) with value"""
         if self._value == value:
             return
@@ -144,7 +148,7 @@ def is_falling_edge(self) -> bool:
         return falling_edge
 
     @abc.abstractmethod
-    def set_value(self, value: int | str | None):
+    def set_value(self, value: VALUE_TYPE):
         """Set value on port"""
 
     @abc.abstractmethod
@@ -195,7 +199,7 @@ def __init__(self, parent, name: str, width: int = 1, output: bool = False):
         super().__init__(parent, name, width, output)
         self._port_driver: Port | None = None  # The port that drives this port
 
-    def set_value(self, value: int | str | None):
+    def set_value(self, value: VALUE_TYPE):
         if value != self.value:
             self.update_wires(value)
 
@@ -221,7 +225,7 @@ class PortIn(PortWire):
     def __init__(self, parent, name: str, width: int = 1):
         super().__init__(parent, name, width, output=False)
 
-    def set_value(self, value: int | str | None):
+    def set_value(self, value: VALUE_TYPE):
         super().set_value(value)
         self.parent().update()
 
@@ -246,16 +250,16 @@ def set_delay_ns(self, delay_ns: int):
         """Set port propagation delay"""
         self._delay_ns = delay_ns
 
-    def set_value(self, value: int | str | None):
+    def set_value(self, value: VALUE_TYPE):
         self.parent().add_event(self, value, self._delay_ns)
 
-    def update_port(self, value: int | str | None):
+    def update_port(self, value: VALUE_TYPE):
         """Update the port output and the connected wires"""
         self.update_wires(value)
         if self._update_parent:
             self.parent().update()
 
-    def delta_cycle(self, value: int | str | None):
+    def delta_cycle(self, value: VALUE_TYPE):
         """Handle the delta cycle event from the circuit"""
         self.update_port(value)
 
@@ -282,11 +286,11 @@ class PortOutImmediate(PortOutDelta):
     def __init__(self, parent, name: str, width: int = 1):
         super().__init__(parent, name, width)
 
-    def set_value(self, value: int | str | None):
+    def set_value(self, value: VALUE_TYPE):
         self.parent().add_event(self, value, 0)
         super().update_port(value)
 
-    def delta_cycle(self, value: int | str | None):
+    def delta_cycle(self, value: VALUE_TYPE):
         """
         Do nothing here, the event is just used to updates waves in Circuit class
         """
@@ -303,7 +307,7 @@ def __init__(self, parent, name: str, parent_port: PortMultiBitWire, output: boo
         super().__init__(parent, name, 1, output)
         self._parent_port = parent_port
 
-    def set_value(self, value: int | str | None):
+    def set_value(self, value: VALUE_TYPE):
         super().set_value(value)
         self._parent_port.update_value_from_bits()
 
@@ -333,7 +337,7 @@ def init(self):
         for bit in self._bits:
             bit.init()
 
-    def set_value(self, value: int | str | None):
+    def set_value(self, value: VALUE_TYPE):
         if value is None or isinstance(value, str):
             return
         for bit_id, bit in enumerate(self._bits):
@@ -375,7 +379,7 @@ def update_value_from_bits(self):
         # Send event just to update waves
         self.parent().add_event(self, value, 0)
 
-    def delta_cycle(self, value: int | str | None):
+    def delta_cycle(self, value: VALUE_TYPE):
         """
         Do nothing here, the event passed in 'update_value_from_bits'
         is just used to updates waves in Circuit class