ftrack_api.exception¶
-
exception
ftrack_api.exception.
Error
(message=None, details=None)[source]¶ ftrack specific error.
-
default_message
= 'Unspecified error occurred.'¶
-
__init__
(message=None, details=None)[source]¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AuthenticationError
(message=None, details=None)[source]¶ Raise when an authentication error occurs.
-
default_message
= 'Authentication error.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
ServerError
(message=None, details=None)[source]¶ Raise when the server reports an error.
-
default_message
= 'Server reported error processing request.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
ServerCompatibilityError
(message=None, details=None)[source]¶ Raise when server appears incompatible.
-
default_message
= 'Server incompatible.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
NotFoundError
(message=None, details=None)[source]¶ Raise when something that should exist is not found.
-
default_message
= 'Not found.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
NotUniqueError
(message=None, details=None)[source]¶ Raise when unique value required and duplicate detected.
-
default_message
= 'Non-unique value detected.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
IncorrectResultError
(message=None, details=None)[source]¶ Raise when a result is incorrect.
-
default_message
= 'Incorrect result detected.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
NoResultFoundError
(message=None, details=None)[source]¶ Raise when a result was expected but no result was found.
-
default_message
= 'Expected result, but no result was found.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
MultipleResultsFoundError
(message=None, details=None)[source]¶ Raise when a single result expected, but multiple results found.
-
default_message
= 'Expected single result, but received multiple results.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
EntityTypeError
(message=None, details=None)[source]¶ Raise when an entity type error occurs.
-
default_message
= 'Entity type error.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
UnrecognisedEntityTypeError
(entity_type, **kw)[source]¶ Raise when an unrecognised entity type detected.
-
default_message
= 'Entity type "{entity_type}" not recognised.'¶
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
OperationError
(message=None, details=None)[source]¶ Raise when an operation error occurs.
-
default_message
= 'Operation error.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
InvalidStateError
(message=None, details=None)[source]¶ Raise when an invalid state detected.
-
default_message
= 'Invalid state.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
InvalidStateTransitionError
(current_state, target_state, entity, **kw)[source]¶ Raise when an invalid state transition detected.
-
default_message
= 'Invalid transition from {current_state!r} to {target_state!r} state for entity {entity!r}'¶
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AttributeError
(message=None, details=None)[source]¶ Raise when an error related to an attribute occurs.
-
default_message
= 'Attribute error.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
ImmutableAttributeError
(attribute, **kw)[source]¶ Raise when modification of immutable attribute attempted.
-
default_message
= 'Cannot modify value of immutable {attribute.name!r} attribute.'¶
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
CollectionError
(collection, **kw)[source]¶ Raise when an error related to collections occurs.
-
default_message
= 'Collection error.'¶
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
ImmutableCollectionError
(collection, **kw)[source]¶ Raise when modification of immutable collection attempted.
-
default_message
= 'Cannot modify value of immutable collection {collection!r}.'¶
-
__init__
(collection, **kw)¶ Initialise error.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
DuplicateItemInCollectionError
(item, collection, **kw)[source]¶ Raise when duplicate item in collection detected.
-
default_message
= 'Item {item!r} already exists in collection {collection!r}.'¶
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
ParseError
(message=None, details=None)[source]¶ Raise when a parsing error occurs.
-
default_message
= 'Failed to parse.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
EventHubError
(message=None, details=None)[source]¶ Raise when issues related to event hub occur.
-
default_message
= 'Event hub error occurred.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
EventHubConnectionError
(message=None, details=None)[source]¶ Raise when event hub encounters connection problem.
-
default_message
= 'Event hub is not connected.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
EventHubPacketError
(message=None, details=None)[source]¶ Raise when event hub encounters an issue with a packet.
-
default_message
= 'Invalid packet.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
PermissionDeniedError
(message=None, details=None)[source]¶ Raise when permission is denied.
-
default_message
= 'Permission denied.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
LocationError
(message=None, details=None)[source]¶ Base for errors associated with locations.
-
default_message
= 'Unspecified location error'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
ComponentNotInAnyLocationError
(message=None, details=None)[source]¶ Raise when component not available in any location.
-
default_message
= 'Component not available in any location.'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
ComponentNotInLocationError
(components, location, **kw)[source]¶ Raise when component(s) not in location.
-
default_message
= 'Component(s) {formatted_components} not found in location {location}.'¶
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
ComponentInLocationError
(components, location, **kw)[source]¶ Raise when component(s) already exists in location.
-
default_message
= 'Component(s) {formatted_components} already exist in location {location}.'¶
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorError
(message=None, details=None)[source]¶ Base for errors associated with accessors.
-
default_message
= 'Unspecified accessor error'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorOperationFailedError
(operation='', resource_identifier=None, error=None, **kw)[source]¶ Base for failed operations on accessors.
-
default_message
= 'Operation {operation} failed: {error}'¶
-
__init__
(operation='', resource_identifier=None, error=None, **kw)[source]¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorUnsupportedOperationError
(operation='', resource_identifier=None, error=None, **kw)[source]¶ Raise when operation is unsupported.
-
default_message
= 'Operation {operation} unsupported.'¶
-
__init__
(operation='', resource_identifier=None, error=None, **kw)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorPermissionDeniedError
(operation='', resource_identifier=None, error=None, **kw)[source]¶ Raise when permission denied.
-
default_message
= 'Cannot {operation} {resource_identifier}. Permission denied.'¶
-
__init__
(operation='', resource_identifier=None, error=None, **kw)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorResourceIdentifierError
(resource_identifier, **kw)[source]¶ Raise when a error related to a resource_identifier occurs.
-
default_message
= 'Resource identifier is invalid: {resource_identifier}.'¶
-
__init__
(resource_identifier, **kw)[source]¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorFilesystemPathError
(resource_identifier, **kw)[source]¶ Raise when a error related to an accessor filesystem path occurs.
-
default_message
= 'Could not determine filesystem path from resource identifier: {resource_identifier}.'¶
-
__init__
(resource_identifier, **kw)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorResourceError
(operation='', resource_identifier=None, error=None, **kw)[source]¶ Base for errors associated with specific resource.
-
default_message
= 'Unspecified resource error: {resource_identifier}'¶
-
__init__
(operation='', resource_identifier=None, error=None, **kw)[source]¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorResourceNotFoundError
(operation='', resource_identifier=None, error=None, **kw)[source]¶ Raise when a required resource is not found.
-
default_message
= 'Resource not found: {resource_identifier}'¶
-
__init__
(operation='', resource_identifier=None, error=None, **kw)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorParentResourceNotFoundError
(operation='', resource_identifier=None, error=None, **kw)[source]¶ Raise when a parent resource (such as directory) is not found.
-
default_message
= 'Parent resource is missing: {resource_identifier}'¶
-
__init__
(operation='', resource_identifier=None, error=None, **kw)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorResourceInvalidError
(operation='', resource_identifier=None, error=None, **kw)[source]¶ Raise when a resource is not the right type.
-
default_message
= 'Resource invalid: {resource_identifier}'¶
-
__init__
(operation='', resource_identifier=None, error=None, **kw)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
AccessorContainerNotEmptyError
(operation='', resource_identifier=None, error=None, **kw)[source]¶ Raise when container is not empty.
-
default_message
= 'Container is not empty: {resource_identifier}'¶
-
__init__
(operation='', resource_identifier=None, error=None, **kw)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
StructureError
(message=None, details=None)[source]¶ Base for errors associated with structures.
-
default_message
= 'Unspecified structure error'¶
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
ftrack_api.exception.
ConnectionClosedError
(message=None, details=None)[source]¶ Raise when attempt to use closed connection detected.
-
__init__
(message=None, details=None)¶ Initialise exception with message.
If message is None, the class ‘default_message’ will be used.
details should be a mapping of extra information that can be used in the message and also to provide more context.
-
args
¶
-
default_message
= 'Connection closed.'¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-