Skip to content

academy.exception

ActionCancelledError 

ActionCancelledError(name: str)

Bases: Exception

Action was cancelled by the agent.

This often happens when an agent is shutdown mid-action execution and configured to cancel running actions.

Source code in academy/exception.py 
19
20
def __init__(self, name: str) -> None:
    super().__init__(f'Action "{name}" was cancelled by the agent.')

AgentNotInitializedError 

AgentNotInitializedError()

Bases: Exception

Agent runtime context has not been initialized.

This error is typically raised when accessing the runtime context for an agent before the agent has been executed.

Source code in academy/exception.py 
30
31
32
33
34
def __init__(self) -> None:
    super().__init__(
        'Agent runtime context has not been initialized. '
        'Has the agent been started?',
    )

ExchangeError

Bases: Exception

Base type for exchange related errors.

BadEntityIdError 

BadEntityIdError(uid: EntityId)

Bases: ExchangeError

Entity associated with the identifier is unknown.

Source code in academy/exception.py 
46
47
def __init__(self, uid: EntityId) -> None:
    super().__init__(f'Unknown identifier {uid}.')

ForbiddenError

Bases: ExchangeError

Exchange client does not have permission to access resources.

MailboxTerminatedError 

MailboxTerminatedError(uid: EntityId)

Bases: ExchangeError

Entity mailbox is terminated and cannot send or receive messages.

Constructing this error type implicitly returns one of the derived types, AgentTerminatedError or UserTerminatedError, based on the entity type.

Source code in academy/exception.py 
73
74
75
def __init__(self, uid: EntityId) -> None:
    super().__init__(f'Mailbox for {uid} has been terminated.')
    self.uid = uid

AgentTerminatedError 

AgentTerminatedError(uid: AgentId[Any])

Bases: MailboxTerminatedError

Agent mailbox is terminated and cannot send or receive messages.

Source code in academy/exception.py 
88
89
def __init__(self, uid: AgentId[Any]) -> None:
    super().__init__(uid)

UserTerminatedError 

UserTerminatedError(uid: UserId)

Bases: MailboxTerminatedError

User mailbox is terminated and cannot send or receive messages.

Source code in academy/exception.py 
95
96
def __init__(self, uid: UserId) -> None:
    super().__init__(uid)

UnauthorizedError

Bases: ExchangeError

Exchange client has not provided valid authentication credentials.

HandleClosedError 

HandleClosedError(
    agent_id: AgentId[Any], client_id: EntityId | None
)

Bases: Exception

Agent handle has been closed.

Source code in academy/exception.py 
108
109
110
111
112
113
114
115
116
117
118
def __init__(
    self,
    agent_id: AgentId[Any],
    client_id: EntityId | None,
) -> None:
    message = (
        f'Handle to {agent_id} bound to {client_id} has been closed.'
        if client_id is not None
        else f'Handle to {agent_id} has been closed.'
    )
    super().__init__(message)

HandleNotBoundError 

HandleNotBoundError(aid: AgentId[Any])

Bases: Exception

Handle to agent is in an unbound state.

An UnboundRemoteHandle is initialized with a target agent ID, but is not attached to an exchange client that the handle can use for communication.

An unbound handle can be turned into a usable handle by binding it to an exchange client with UnboundRemoteHandle.bind_to_client().

Source code in academy/exception.py 
133
134
135
136
137
def __init__(self, aid: AgentId[Any]) -> None:
    super().__init__(
        f'Handle to {aid} is not bound to an exchange client. See the '
        'exception docstring for troubleshooting.',
    )

raise_exceptions 

raise_exceptions(
    exceptions: Iterable[BaseException],
    *,
    message: str | None = None
) -> None

Raise exceptions as a group.

Raises a set of exceptions as an ExceptionGroup in Python 3.11 and later. If only one exception is provided, it is raised directly. In Python 3.10 and older, only one exception is raised.

This is a no-op if the size of exceptions is zero.

Parameters:

  • exceptions (Iterable[BaseException]) –

    An iterable of exceptions to raise.

  • message (str | None, default: None ) –

    Custom error message for the exception group.

Source code in academy/exception.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
def raise_exceptions(
    exceptions: Iterable[BaseException],
    *,
    message: str | None = None,
) -> None:
    """Raise exceptions as a group.

    Raises a set of exceptions as an [`ExceptionGroup`][ExceptionGroup]
    in Python 3.11 and later. If only one exception is provided, it is raised
    directly. In Python 3.10 and older, only one exception is raised.

    This is a no-op if the size of `exceptions` is zero.

    Args:
        exceptions: An iterable of exceptions to raise.
        message: Custom error message for the exception group.
    """
    excs = tuple(exceptions)
    if len(excs) == 0:
        return

    if sys.version_info >= (3, 11) and len(excs) > 1:  # pragma: >=3.11 cover
        message = (
            message if message is not None else 'Caught multiple exceptions!'
        )
        # Note that BaseExceptionGroup will return ExceptionGroup if all
        # of the errors are Exception, rather than BaseException, so that this
        # can be caught by "except Exception".
        raise BaseExceptionGroup(message, excs)  # noqa: F821
    else:  # pragma: <3.11 cover
        raise excs[0]