exceptions

MSLConnectionError (OSError)

MSLConnectionError(interface: Interface, message: str)

Base class for connection-related exceptions.

Parameters:

Name	Type	Description	Default
interface	Interface	An interface subclass.	required
message	str	A message to append to the generic error message.	required

Source code in src/msl/equipment/interfaces/message_based.py

def __init__(self, interface: Interface, message: str) -> None:
    """Base class for connection-related exceptions.

    Args:
        interface: An interface subclass.
        message: A message to append to the generic error message.
    """
    logger.debug("%r %s", interface, message)
    super().__init__(f"{interface!r}\n{message}")

    self.message: str = message
    """[str][] — The error message."""

message instance-attribute

message: str

str — The error message.

MSLTimeoutError (TimeoutError)

MSLTimeoutError(interface: MessageBased, message: str | None = None)

A timeout exception for I/O operations.

Parameters:

Name	Type	Description	Default
interface	MessageBased	A message-based interface subclass.	required
message	str | None	An optional message to append to the generic timeout error message.	None

Source code in src/msl/equipment/interfaces/message_based.py

def __init__(self, interface: MessageBased, message: str | None = None) -> None:
    """A timeout exception for I/O operations.

    Args:
        interface: A message-based interface subclass.
        message: An optional message to append to the generic timeout error message.
    """
    suffix = f". {message}" if message else ""
    msg = f"Timeout occurred after {interface.timeout} second(s){suffix}"
    logger.debug("%r %s", interface, msg)
    super().__init__(f"{interface!r}\n{msg}")

    self.message: str = msg
    """[str][] — The error message."""

message instance-attribute

message: str

str — The error message.