Source code for bosdyn.client.exceptions

# Copyright (c) 2023 Boston Dynamics, Inc.  All rights reserved.
# Downloading, reproducing, distributing or otherwise using the SDK Software
# is subject to the terms and conditions of the Boston Dynamics Software
# Development Kit License (20191101-BDSDK-SL).

[docs]class Error(Exception): """Base exception that all public api exceptions are derived from."""
[docs]class ResponseError(Error): """Exception triggered by a server response whose rpc succeeded.""" def __init__(self, response, error_message=None): super(ResponseError, self).__init__() self.response = response if error_message is not None: self.error_message = error_message elif response is not None: self.error_message = response.header.error.message else: self.error_message = "" def __str__(self): if self.response is not None: full_classname = self.response.DESCRIPTOR.full_name else: full_classname = "Error" return '{} ({}): {}'.format(full_classname, self.__class__.__name__, self.error_message)
[docs]class InvalidRequestError(ResponseError): """The provided request arguments are ill-formed or invalid, independent of the system state."""
[docs]class LeaseUseError(ResponseError): """Request was rejected due to using an invalid lease.""" def __init__(self, response, lease_use_result): super().__init__(response) self.lease_use_result = lease_use_result
[docs]class LicenseError(ResponseError): """Request was rejected due to using an invalid license."""
[docs]class ServerError(ResponseError): """Service encountered an unrecoverable error."""
[docs]class InternalServerError(ServerError): """Service experienced an unexpected error state."""
[docs]class UnsetStatusError(ServerError): """Response's status field (in either message or common header) was UNKNOWN value."""
[docs]class RpcError(Error): """An error occurred trying to reach a service on the robot.""" def __init__(self, original_error, error_message=None): super(RpcError, self).__init__() self.error = original_error self.error_message = error_message or str(original_error) def __str__(self): return '{}: {}'.format(self.__class__.__name__, self.error_message)
[docs]class RetryableRpcError(RpcError): """An RpcError that denotes the same request may succeed if retried."""
[docs]class PersistentRpcError(RpcError): """An RpcError that will almost certainly continue to keep failing if retried"""
[docs]class ClientCancelledOperationError(PersistentRpcError): """The user cancelled the rpc request."""
[docs]class InvalidClientCertificateError(PersistentRpcError): """The provided client certificate is invalid."""
[docs]class NonexistentAuthorityError(PersistentRpcError): """The app token's authority field names a nonexistent service."""
[docs]class PermissionDeniedError(PersistentRpcError): """The rpc request was denied access."""
[docs]class ProxyConnectionError(RetryableRpcError): """The proxy on the robot could not be reached."""
[docs]class ResponseTooLargeError(RetryableRpcError): """The rpc response was larger than allowed max size."""
[docs]class ServiceUnavailableError(RetryableRpcError): """The proxy could not find the (possibly unregistered) service."""
[docs]class TooManyRequestsError(RetryableRpcError): """The remote procedure call did not go through the proxy due to rate limiting."""
[docs]class ServiceFailedDuringExecutionError(RetryableRpcError): """The service encountered an unexpected failure."""
[docs]class TimedOutError(RetryableRpcError): """The remote procedure call did not terminate within the allotted time."""
[docs]class UnableToConnectToRobotError(RetryableRpcError): """The robot may be offline or otherwise unreachable."""
[docs]class RetryableUnavailableError(UnableToConnectToRobotError): """Service unavailable or channel reset. Likely transient and can be resolved by retrying."""
[docs]class UnauthenticatedError(PersistentRpcError): """The user needs to authenticate or does not have permission to access requested service."""
[docs]class UnknownDnsNameError(PersistentRpcError): """The system is unable to translate the domain name."""
[docs]class NotFoundError(PersistentRpcError): """The backend system could not be found."""
[docs]class UnimplementedError(PersistentRpcError): """The API does not recognize the request and is unable to complete the request."""
[docs]class TransientFailureError(RetryableRpcError): """The channel is in state TRANSIENT_FAILURE, often caused by a connection failure."""
[docs]class TimeSyncRequired(Error): """Time synchronization is required but none seems to be established."""
[docs]class CustomParamError(ResponseError): """A custom parameter that was provided did not match the specification""" def __init__(self, response, custom_param_error): super().__init__(response) self.custom_param_error = custom_param_error def __str__(self): if self.response is not None: full_classname = self.response.DESCRIPTOR.full_name else: full_classname = "Error" return '{} ({}): Parameter Errors\n{}'.format( full_classname, self.__class__.__name__, '\n'.join(self.custom_param_error.error_messages))