Skip to content

Exceptions

matchbox.common.exceptions

Custom exceptions for Matchbox.

Classes:

Attributes:

HTTP_EXCEPTION_REGISTRY module-attribute

HTTP_EXCEPTION_REGISTRY: dict[str, type[MatchboxHttpException]] = {(__name__): exc for exc in (_get_all_subclasses(MatchboxHttpException))}

MatchboxExceptionType module-attribute

MatchboxExceptionType = StrEnum('MatchboxExceptionType', _enum_members)

MatchboxException

MatchboxException(message: str | None = None)

Bases: Exception


              flowchart TD
              matchbox.common.exceptions.MatchboxException[MatchboxException]

              

              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

An exception has occurred in Matchbox..

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxHttpException

MatchboxHttpException(message: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                


              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Base class for exceptions that can be transmitted over HTTP.

Subclasses must define http_status as a class attribute.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status instance-attribute

http_status: HTTPStatus

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxRuntimeError

MatchboxRuntimeError(message: str)

Bases: MatchboxException, RuntimeError


              flowchart TD
              matchbox.common.exceptions.MatchboxRuntimeError[MatchboxRuntimeError]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxRuntimeError
                


              click matchbox.common.exceptions.MatchboxRuntimeError href "" "matchbox.common.exceptions.MatchboxRuntimeError"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Runtime error.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxNameError

MatchboxNameError(message: str)

Bases: MatchboxException, ValueError


              flowchart TD
              matchbox.common.exceptions.MatchboxNameError[MatchboxNameError]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxNameError
                


              click matchbox.common.exceptions.MatchboxNameError href "" "matchbox.common.exceptions.MatchboxNameError"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Name did not pass validation.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxArrowSchemaMismatch

MatchboxArrowSchemaMismatch(expected: Schema, actual: Schema)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxArrowSchemaMismatch[MatchboxArrowSchemaMismatch]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxArrowSchemaMismatch
                


              click matchbox.common.exceptions.MatchboxArrowSchemaMismatch href "" "matchbox.common.exceptions.MatchboxArrowSchemaMismatch"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Arrow schema mismatch.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxClientSettingsException

MatchboxClientSettingsException(message: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxClientSettingsException[MatchboxClientSettingsException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxClientSettingsException
                


              click matchbox.common.exceptions.MatchboxClientSettingsException href "" "matchbox.common.exceptions.MatchboxClientSettingsException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Incorrect configuration provided to client.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxUnparsedClientRequest

MatchboxUnparsedClientRequest(message: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxUnparsedClientRequest[MatchboxUnparsedClientRequest]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxUnparsedClientRequest
                


              click matchbox.common.exceptions.MatchboxUnparsedClientRequest href "" "matchbox.common.exceptions.MatchboxUnparsedClientRequest"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

The API could not parse the content of the client request.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxUnhandledServerResponse

MatchboxUnhandledServerResponse(http_status: int, details: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxUnhandledServerResponse[MatchboxUnhandledServerResponse]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxUnhandledServerResponse
                


              click matchbox.common.exceptions.MatchboxUnhandledServerResponse href "" "matchbox.common.exceptions.MatchboxUnhandledServerResponse"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

The API sent an unexpected response.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxEmptyServerResponse

MatchboxEmptyServerResponse(message: str | None = None, operation: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxEmptyServerResponse[MatchboxEmptyServerResponse]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxEmptyServerResponse
                


              click matchbox.common.exceptions.MatchboxEmptyServerResponse href "" "matchbox.common.exceptions.MatchboxEmptyServerResponse"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

The server returned an empty response when data was expected.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

operation instance-attribute

operation = operation

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxSourceFieldError

MatchboxSourceFieldError(message: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxSourceFieldError[MatchboxSourceFieldError]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxSourceFieldError
                


              click matchbox.common.exceptions.MatchboxSourceFieldError href "" "matchbox.common.exceptions.MatchboxSourceFieldError"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Specified fields diverge with the warehouse.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxSourceClientError

MatchboxSourceClientError(message: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxSourceClientError[MatchboxSourceClientError]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxSourceClientError
                


              click matchbox.common.exceptions.MatchboxSourceClientError href "" "matchbox.common.exceptions.MatchboxSourceClientError"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Location client must be set.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxSourceExtractTransformError

MatchboxSourceExtractTransformError(logic: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxSourceExtractTransformError[MatchboxSourceExtractTransformError]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxSourceExtractTransformError
                


              click matchbox.common.exceptions.MatchboxSourceExtractTransformError href "" "matchbox.common.exceptions.MatchboxSourceExtractTransformError"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Invalid ETL logic detected.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxSourceTableError

MatchboxSourceTableError(message: str | None = None, table_name: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxSourceTableError[MatchboxSourceTableError]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxSourceTableError
                


              click matchbox.common.exceptions.MatchboxSourceTableError href "" "matchbox.common.exceptions.MatchboxSourceTableError"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Tables not found in your source data warehouse.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

table_name instance-attribute

table_name = table_name

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxServerFileError

MatchboxServerFileError(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxServerFileError[MatchboxServerFileError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxServerFileError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxServerFileError href "" "matchbox.common.exceptions.MatchboxServerFileError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

There was an issue with file upload.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 400

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxAuthenticationError

MatchboxAuthenticationError(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxAuthenticationError[MatchboxAuthenticationError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxAuthenticationError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxAuthenticationError href "" "matchbox.common.exceptions.MatchboxAuthenticationError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Authentication failed.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 401

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxPermissionDenied

MatchboxPermissionDenied(message: str | None = None, permission: PermissionType | None = None, resource_type: BackendResourceType | None = None, resource_name: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxPermissionDenied[MatchboxPermissionDenied]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxPermissionDenied
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxPermissionDenied href "" "matchbox.common.exceptions.MatchboxPermissionDenied"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

User lacks required permission for the requested resource.

Methods:

  • to_details

    Return permission, resource_type and resource_name if set.

Attributes:

http_status class-attribute instance-attribute

http_status = 403

permission instance-attribute

permission = permission

resource_type instance-attribute

resource_type = resource_type

resource_name instance-attribute

resource_name = resource_name

to_details

to_details() -> dict[str, Any] | None

Return permission, resource_type and resource_name if set.

MatchboxUserNotFoundError

MatchboxUserNotFoundError(message: str | None = None, user_name: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxUserNotFoundError[MatchboxUserNotFoundError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxUserNotFoundError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxUserNotFoundError href "" "matchbox.common.exceptions.MatchboxUserNotFoundError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

User not found.

Methods:

Attributes:

http_status class-attribute instance-attribute

http_status = 404

user_name instance-attribute

user_name = user_name

to_details

to_details() -> dict[str, Any] | None

Return user_name if set.

MatchboxStepNotFoundError

MatchboxStepNotFoundError(message: str | None = None, name: StepName | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxStepNotFoundError[MatchboxStepNotFoundError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxStepNotFoundError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxStepNotFoundError href "" "matchbox.common.exceptions.MatchboxStepNotFoundError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Step not found.

Methods:

Attributes:

http_status class-attribute instance-attribute

http_status = 404

name instance-attribute

name = name

to_details

to_details() -> dict[str, Any] | None

Return name if set.

MatchboxCollectionNotFoundError

MatchboxCollectionNotFoundError(message: str | None = None, name: CollectionName | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxCollectionNotFoundError[MatchboxCollectionNotFoundError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxCollectionNotFoundError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxCollectionNotFoundError href "" "matchbox.common.exceptions.MatchboxCollectionNotFoundError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Collection not found.

Methods:

Attributes:

http_status class-attribute instance-attribute

http_status = 404

name instance-attribute

name = name

to_details

to_details() -> dict[str, Any] | None

Return name if set.

MatchboxRunNotFoundError

MatchboxRunNotFoundError(message: str | None = None, run_id: RunID | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxRunNotFoundError[MatchboxRunNotFoundError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxRunNotFoundError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxRunNotFoundError href "" "matchbox.common.exceptions.MatchboxRunNotFoundError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Run not found.

Methods:

Attributes:

http_status class-attribute instance-attribute

http_status = 404

run_id instance-attribute

run_id = run_id

to_details

to_details() -> dict[str, Any] | None

Return run_id if set.

MatchboxDataNotFound

MatchboxDataNotFound(message: str | None = None, table: str | None = None, data: list[Any] | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxDataNotFound[MatchboxDataNotFound]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxDataNotFound
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxDataNotFound href "" "matchbox.common.exceptions.MatchboxDataNotFound"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Data doesn’t exist in the Matchbox source table.

Methods:

Attributes:

http_status class-attribute instance-attribute

http_status = 404

table instance-attribute

table = table

data instance-attribute

data = data

to_details

to_details() -> dict[str, Any] | None

Return table and data if set.

MatchboxConnectionError

MatchboxConnectionError(message: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxConnectionError[MatchboxConnectionError]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxConnectionError
                


              click matchbox.common.exceptions.MatchboxConnectionError href "" "matchbox.common.exceptions.MatchboxConnectionError"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Connection to Matchbox’s backend database failed.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxPermissionDeniedError

MatchboxPermissionDeniedError(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxPermissionDeniedError[MatchboxPermissionDeniedError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxPermissionDeniedError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxPermissionDeniedError href "" "matchbox.common.exceptions.MatchboxPermissionDeniedError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Raised when a user lacks permission for an action.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 403

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxDeletionNotConfirmed

MatchboxDeletionNotConfirmed(message: str | None = None, children: list[str | int] | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxDeletionNotConfirmed[MatchboxDeletionNotConfirmed]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxDeletionNotConfirmed
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxDeletionNotConfirmed href "" "matchbox.common.exceptions.MatchboxDeletionNotConfirmed"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Deletion must be confirmed: if certain, rerun with certain=True.

Methods:

Attributes:

http_status class-attribute instance-attribute

http_status = 409

children instance-attribute

children = children

to_details

to_details() -> dict[str, Any] | None

Return children if set.

MatchboxStepAlreadyExists

MatchboxStepAlreadyExists(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxStepAlreadyExists[MatchboxStepAlreadyExists]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxStepAlreadyExists
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxStepAlreadyExists href "" "matchbox.common.exceptions.MatchboxStepAlreadyExists"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Step already exists.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 409

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxStepUpdateError

MatchboxStepUpdateError(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxStepUpdateError[MatchboxStepUpdateError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxStepUpdateError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxStepUpdateError href "" "matchbox.common.exceptions.MatchboxStepUpdateError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Step metadata cannot be updated.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 422

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxStepInvalidData

MatchboxStepInvalidData(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxStepInvalidData[MatchboxStepInvalidData]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxStepInvalidData
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxStepInvalidData href "" "matchbox.common.exceptions.MatchboxStepInvalidData"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Step data does not match fingerprint.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 422

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxStepExistingData

MatchboxStepExistingData(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxStepExistingData[MatchboxStepExistingData]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxStepExistingData
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxStepExistingData href "" "matchbox.common.exceptions.MatchboxStepExistingData"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Data was already set on step.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 409

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxStepNotQueriable

MatchboxStepNotQueriable(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxStepNotQueriable[MatchboxStepNotQueriable]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxStepNotQueriable
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxStepNotQueriable href "" "matchbox.common.exceptions.MatchboxStepNotQueriable"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

The step is not ready to be queried.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 422

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxStepTypeError

MatchboxStepTypeError(message: str | None = None, step_name: StepName | None = None, step_type: StepType | None = None, expected_step_types: list[StepType] | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxStepTypeError[MatchboxStepTypeError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxStepTypeError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxStepTypeError href "" "matchbox.common.exceptions.MatchboxStepTypeError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

An invalid operation was attempted using this type of step.

Methods:

Attributes:

http_status class-attribute instance-attribute

http_status = 422

step_name instance-attribute

step_name = step_name

step_type instance-attribute

step_type = step_type

expected_step_types instance-attribute

expected_step_types = expected_step_types

to_details

to_details() -> dict[str, Any] | None

Return attributes if set.

MatchboxCollectionAlreadyExists

MatchboxCollectionAlreadyExists(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxCollectionAlreadyExists[MatchboxCollectionAlreadyExists]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxCollectionAlreadyExists
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxCollectionAlreadyExists href "" "matchbox.common.exceptions.MatchboxCollectionAlreadyExists"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Collection already exists.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 409

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxRunAlreadyExists

MatchboxRunAlreadyExists(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxRunAlreadyExists[MatchboxRunAlreadyExists]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxRunAlreadyExists
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxRunAlreadyExists href "" "matchbox.common.exceptions.MatchboxRunAlreadyExists"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Run already exists.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 409

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxRunNotWriteable

MatchboxRunNotWriteable(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxRunNotWriteable[MatchboxRunNotWriteable]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxRunNotWriteable
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxRunNotWriteable href "" "matchbox.common.exceptions.MatchboxRunNotWriteable"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Run is not mutable.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 423

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxTooManySamplesRequested

MatchboxTooManySamplesRequested(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxTooManySamplesRequested[MatchboxTooManySamplesRequested]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxTooManySamplesRequested
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxTooManySamplesRequested href "" "matchbox.common.exceptions.MatchboxTooManySamplesRequested"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Too many samples have been requested from the server.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 422

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxGroupNotFoundError

MatchboxGroupNotFoundError(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxGroupNotFoundError[MatchboxGroupNotFoundError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxGroupNotFoundError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxGroupNotFoundError href "" "matchbox.common.exceptions.MatchboxGroupNotFoundError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Raised when a group is not found.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 404

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxGroupAlreadyExistsError

MatchboxGroupAlreadyExistsError(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxGroupAlreadyExistsError[MatchboxGroupAlreadyExistsError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxGroupAlreadyExistsError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxGroupAlreadyExistsError href "" "matchbox.common.exceptions.MatchboxGroupAlreadyExistsError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Raised when attempting to create a group that already exists.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 409

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxSystemGroupError

MatchboxSystemGroupError(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxSystemGroupError[MatchboxSystemGroupError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxSystemGroupError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxSystemGroupError href "" "matchbox.common.exceptions.MatchboxSystemGroupError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Raised when attempting to modify or delete a system group.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 422

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxNoJudgements

MatchboxNoJudgements(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxNoJudgements[MatchboxNoJudgements]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxNoJudgements
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxNoJudgements href "" "matchbox.common.exceptions.MatchboxNoJudgements"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

No judgements found in the database when required for operation.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 404

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxDatabaseWriteError

MatchboxDatabaseWriteError(message: str | None = None)

Bases: MatchboxException


              flowchart TD
              matchbox.common.exceptions.MatchboxDatabaseWriteError[MatchboxDatabaseWriteError]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxDatabaseWriteError
                


              click matchbox.common.exceptions.MatchboxDatabaseWriteError href "" "matchbox.common.exceptions.MatchboxDatabaseWriteError"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Could not be written to the backend DB, likely due to a constraint violation.

Methods:

  • to_details

    Return exception-specific details for serialisation.

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.

MatchboxLockError

MatchboxLockError(message: str | None = None)

Bases: MatchboxHttpException


              flowchart TD
              matchbox.common.exceptions.MatchboxLockError[MatchboxLockError]
              matchbox.common.exceptions.MatchboxHttpException[MatchboxHttpException]
              matchbox.common.exceptions.MatchboxException[MatchboxException]

                              matchbox.common.exceptions.MatchboxHttpException --> matchbox.common.exceptions.MatchboxLockError
                                matchbox.common.exceptions.MatchboxException --> matchbox.common.exceptions.MatchboxHttpException
                



              click matchbox.common.exceptions.MatchboxLockError href "" "matchbox.common.exceptions.MatchboxLockError"
              click matchbox.common.exceptions.MatchboxHttpException href "" "matchbox.common.exceptions.MatchboxHttpException"
              click matchbox.common.exceptions.MatchboxException href "" "matchbox.common.exceptions.MatchboxException"
            

Trying to modify locked data.

Methods:

  • to_details

    Return exception-specific details for serialisation.

Attributes:

http_status class-attribute instance-attribute

http_status = 423

to_details

to_details() -> dict[str, Any] | None

Return exception-specific details for serialisation.

Override in subclasses that have additional constructor arguments.