run_iocsh.utils

Standalone utilities for run-iocsh.

Attributes

log
DEFAULT_POLL_TIMEOUT
DEFAULT_POLL_INTERVAL

Functions

wait_for(→ None)

Poll predicate until it returns True or timeout elapses.

Module Contents

run_iocsh.utils.log

run_iocsh.utils.DEFAULT_POLL_TIMEOUT = 5.0

run_iocsh.utils.DEFAULT_POLL_INTERVAL = 0.1

run_iocsh.utils.wait_for(predicate: collections.abc.Callable[[], bool], timeout: float | None = DEFAULT_POLL_TIMEOUT, poll_interval: float = DEFAULT_POLL_INTERVAL) → None

Poll predicate until it returns True or timeout elapses.

Exceptions from predicate are caught and treated as a false result (polling continues until timeout).

Args:

predicate: Callable invoked repeatedly; success when it returns True. timeout: Maximum seconds to wait. None waits forever, as it does

throughout the standard library. 0 evaluates predicate once and never blocks.

poll_interval: Seconds to sleep between polls.

Raises:

IocshTimeoutError: If the predicate never returns True within

timeout. Also catchable as the builtin TimeoutError.