tensorbay.exception

TensorBay cutoms exceptions.

The class hierarchy for TensorBay custom exceptions is:

+-- TensorBayException
    +-- ClientError
        +-- StatusError
        +-- DatasetTypeError
        +-- FrameError
        +-- ResponseError
            +-- AccessDeniedError
            +-- ForbiddenError
            +-- InvalidParamsError
            +-- NameConflictError
            +-- RequestParamsMissingError
            +-- ResourceNotExistError
            +-- InternalServerError
            +-- UnauthorizedError
   +-- UtilityError
       +-- AttrError
    +-- TBRNError
    +-- OpenDatasetError
        +-- NoFileError
        +-- FileStructureError

OperationError is removed in version v1.13.0. Use StatusError or ValueError instead.

exception tensorbay.exception.TensorBayException(message: Optional[str] = None)[source]

Bases: Exception

This is the base class for TensorBay custom exceptions.

Parameters: message – The error message.

exception tensorbay.exception.ClientError(message: Optional[str] = None)[source]

Bases: tensorbay.exception.TensorBayException

This is the base class for custom exceptions in TensorBay client module.

exception tensorbay.exception.StatusError(message: Optional[str] = None, *, is_draft: Optional[bool] = None)[source]

Bases: tensorbay.exception.ClientError

This class defines the exception for illegal status.

Parameters

is_draft – Whether the status is draft.
message – The error message.

exception tensorbay.exception.DatasetTypeError(message: Optional[str] = None, *, dataset_name: Optional[str] = None, is_fusion: Optional[bool] = None)[source]

Bases: tensorbay.exception.ClientError

This class defines the exception for incorrect type of the requested dataset.

Parameters

dataset_name – The name of the dataset whose requested type is wrong.
is_fusion – Whether the dataset is a fusion dataset.

exception tensorbay.exception.FrameError(message: Optional[str] = None)[source]

Bases: tensorbay.exception.ClientError

This class defines the exception for incorrect frame id.

exception tensorbay.exception.ResponseError(message: Optional[str] = None, *, response: Optional[requests.models.Response] = None)[source]

Bases: tensorbay.exception.ClientError

This class defines the exception for post response error.

Parameters: response – The response of the request.

response: The response of the request.

exception tensorbay.exception.AccessDeniedError(message: Optional[str] = None, *, response: Optional[requests.models.Response] = None)[source]

Bases: tensorbay.exception.ResponseError

This class defines the exception for access denied response error.

exception tensorbay.exception.ForbiddenError(message: Optional[str] = None, *, response: Optional[requests.models.Response] = None)[source]

Bases: tensorbay.exception.ResponseError

This class defines the exception for illegal operations Tensorbay forbids.

exception tensorbay.exception.InvalidParamsError(message: Optional[str] = None, *, response: Optional[requests.models.Response] = None, param_name: Optional[str] = None, param_value: Optional[str] = None)[source]

Bases: tensorbay.exception.ResponseError

This class defines the exception for invalid parameters response error.

Parameters

response – The response of the request.
param_name – The name of the invalid parameter.
param_value – The value of the invalid parameter.

response: The response of the request.

exception tensorbay.exception.NameConflictError(message: Optional[str] = None, *, response: Optional[requests.models.Response] = None, resource: Optional[str] = None, identification: Optional[Union[str, int]] = None)[source]

Bases: tensorbay.exception.ResponseError

This class defines the exception for name conflict response error.

Parameters

response – The response of the request.
resource – The type of the conflict resource.
identification – The identification of the conflict resource.

response: The response of the request.

exception tensorbay.exception.RequestParamsMissingError(message: Optional[str] = None, *, response: Optional[requests.models.Response] = None)[source]

Bases: tensorbay.exception.ResponseError

This class defines the exception for request parameters missing response error.

exception tensorbay.exception.ResourceNotExistError(message: Optional[str] = None, *, response: Optional[requests.models.Response] = None, resource: Optional[str] = None, identification: Optional[Union[str, int]] = None)[source]

Bases: tensorbay.exception.ResponseError

This class defines the exception for resource not existing response error.

Parameters

response – The response of the request.
resource – The type of the conflict resource.
identification – The identification of the conflict resource.
response – The response of the request.

exception tensorbay.exception.InternalServerError(message: Optional[str] = None, *, response: Optional[requests.models.Response] = None)[source]

Bases: tensorbay.exception.ResponseError

This class defines the exception for internal server error.

exception tensorbay.exception.UnauthorizedError(message: Optional[str] = None, *, response: Optional[requests.models.Response] = None)[source]

Bases: tensorbay.exception.ResponseError

This class defines the exception for unauthorized response error.

exception tensorbay.exception.OpenDatasetError(message: Optional[str] = None)[source]

Bases: tensorbay.exception.TensorBayException

This is the base class for custom exceptions in TensorBay opendataset module.

exception tensorbay.exception.NoFileError(message: Optional[str] = None, *, pattern: Optional[str] = None)[source]

Bases: tensorbay.exception.OpenDatasetError

This class defines the exception for no matching file found in the opendataset directory.

Parameters: pattern – Glob pattern.

exception tensorbay.exception.FileStructureError(message: Optional[str] = None)[source]

Bases: tensorbay.exception.OpenDatasetError

This class defines the exception for incorrect file structure in opendataset directory.

exception tensorbay.exception.ModuleImportError(message: Optional[str] = None, *, module_name: Optional[str] = None, package_name: Optional[str] = None)[source]

Bases: tensorbay.exception.OpenDatasetError, ModuleNotFoundError

This class defines the exception for import error of optional module in opendataset module.

Parameters

module_name – The name of the optional module.
package_name – The package name of the optional module.

exception tensorbay.exception.TBRNError(message: Optional[str] = None)[source]

Bases: tensorbay.exception.TensorBayException

This class defines the exception for invalid TBRN.

exception tensorbay.exception.UtilityError(message: Optional[str] = None)[source]

Bases: tensorbay.exception.TensorBayException

This is the base class for custom exceptions in TensorBay utility module.

exception tensorbay.exception.AttrError(message: Optional[str] = None)[source]

Bases: tensorbay.exception.UtilityError

This class defines the exception for dynamic attr have default value.