refactor(transition-status): update docstrings, add test for string transition status

ophyd_devices/utils/psi_device_base_utils.py

@@ -48,19 +48,19 @@ OP_MAP = {
 
 class CompareStatus(SubscriptionStatus):
     """
-    Status class to compare a value from a device signal with a target value.
+    Status class to compare a signal value against a given value.
-    The value can be a float, int, or string. If the value is a string,
+    The comparison is done using the specified operation, which can be one of
-    the operation must be either '==' or '!='. For numeric (float or int) values,
+    '==', '!=', '<', '<=', '>', '>='. If the value is a string, only '==' and '!=' are allowed.
-    the operation can be any of the standard comparison operators.
+    The status is finished when the comparison is true.
 
     Args:
         signal: The device signal to compare.
-        value: The target value to compare against.
+        value: The value to compare against.
-        operation: The comparison operation to use. Defaults to '=='.
+        operation: The operation to use for comparison. Defaults to '=='.
         event_type: The type of event to trigger on comparison. Defaults to None (default sub).
         timeout: The timeout for the status. Defaults to None (indefinite).
         settle_time: The time to wait for the signal to settle before comparison. Defaults to 0.
-        run: Whether to run the status immediately or not. Defaults to True.
+        run: Whether to run the status callback on creation or not. Defaults to True.
     """
 
     def __init__(
@@ -102,25 +102,21 @@ class CompareStatus(SubscriptionStatus):
 
 class TransitionStatus(SubscriptionStatus):
     """
-    Status class to compare a list of transitions.
+    Status class to monitor transitions of a signal value through a list of specified transitions.
-    The transitions can be a list of float, int, or string values.
+    The status is finished when all transitions have been observed in order. The keyword argument
-    The transitions are checked in order, and the status is finished when all transitions
+    `strict` determines whether the transitions must occur in strict order or not.
-    have been matched in sequence. The keyword argument `strict` determines whether
+    If `raise_states` is provided, the status will raise an exception if the signal value matches
-    the transitions must match exactly in order, or if intermediate transitions are allowed.
+    any of the values in `raise_states`.
-    For the first value, the strict check is not applied, meaning that the sequence starts once
-    the first transition is matched.
 
     Args:
-        signal: The device signal to compare.
+        signal: The device signal to monitor.
-        transitions: A list of transitions to compare against.
+        transitions: A list of values to transition through.
-        strict: Whether to enforce strict matching of transitions. Defaults to True.
+        strict: Whether the transitions must occur in strict order. Defaults to True.
-        run: Whether to run the status immediately or not. Defaults to True.
+        raise_states: A list of values that will raise an exception if encountered. Defaults to None.
-        event_type: The type of event to trigger on comparison. Defaults to None (default sub).
+        run: Whether to run the status callback on creation or not. Defaults to True.
+        event_type: The type of event to trigger on transition. Defaults to None (default sub).
         timeout: The timeout for the status. Defaults to None (indefinite).
         settle_time: The time to wait for the signal to settle before comparison. Defaults to 0.
-
-    Raises:
-        ValueError: If the transitions do not match the expected sequence. and strict is True.
     """
 
     def __init__(

tests/test_utils.py

@@ -634,3 +634,56 @@ def test_transition_status():
     assert status.done is True
     assert status.success is True
     assert status.exception() is None
+
+
+def test_transition_status_strings():
+    """Test TransitionStatus with string values"""
+    sig = Signal(name="test_signal", value="a")
+
+    # Test strict=True, without intermediate transitions
+    sig.put("a")
+    status = TransitionStatus(signal=sig, transitions=["b", "c", "d"], strict=True)
+
+    assert status.done is False
+    sig.put("b")
+    assert status.done is False
+    sig.put("c")
+    assert status.done is False
+    sig.put("d")
+    assert status.done is True
+    assert status.success is True
+    assert status.exception() is None
+
+    # Test strict=True with additional intermediate transition
+
+    sig.put("a")
+    status = TransitionStatus(signal=sig, transitions=["b", "c", "d"], strict=True)
+
+    assert status.done is False
+    sig.put("b")  # first transition
+    sig.put("e")
+    sig.put("b")
+    sig.put("c")  # transision
+    assert status.done is False
+    sig.put("f")
+    sig.put("b")
+    sig.put("c")
+    sig.put("d")  # transision
+    assert status.done is True
+    assert status.success is True
+    assert status.exception() is None
+
+    # Test strict=False, with intermediate transitions
+    sig.put("a")
+    status = TransitionStatus(signal=sig, transitions=["b", "c", "d"], strict=False)
+
+    assert status.done is False
+    sig.put("b")  # entering first transition
+    sig.put("d")
+    sig.put("c")  # transision
+    assert status.done is False
+    sig.put("e")
+    sig.put("c")
+    sig.put("d")  # last transition
+    assert status.done is True
+    assert status.success is True