Exceptions

exception b2sdk.v3.exception.AccessDenied(*args, **kwargs)

exception b2sdk.v3.exception.AccountInfoError(*args, **kwargs)

Base class for all account info errors.

exception b2sdk.v3.exception.AlreadyFailed(*args, **kwargs)

exception b2sdk.v3.exception.B2ConnectionError(*args, **kwargs)

exception b2sdk.v3.exception.B2Error(*args, **kwargs)

property prefix

Nice, auto-generated error message prefix.

>>> B2SimpleError().prefix
'Simple error'
>>> AlreadyFailed().prefix
'Already failed'

should_retry_http()

Return true if this is an error that can cause an HTTP call to be retried.

should_retry_upload()

Return true if this is an error that should tell the upload code to get a new upload URL and try the upload again.

exception b2sdk.v3.exception.B2HttpCallbackException(*args, **kwargs)

exception b2sdk.v3.exception.B2HttpCallbackPostRequestException(*args, **kwargs)

exception b2sdk.v3.exception.B2HttpCallbackPreRequestException(*args, **kwargs)

exception b2sdk.v3.exception.B2RequestTimeout(*args, **kwargs)

exception b2sdk.v3.exception.B2RequestTimeoutDuringUpload(*args, **kwargs)

should_retry_http()

Return true if this is an error that can cause an HTTP call to be retried.

exception b2sdk.v3.exception.B2SimpleError(*args, **kwargs)

A B2Error with a message prefix.

exception b2sdk.v3.exception.BadDateFormat(*args, **kwargs)

prefix = 'Date from server'

exception b2sdk.v3.exception.BadFileInfo(*args, **kwargs)

exception b2sdk.v3.exception.BadJson(*args, **kwargs)

prefix = 'Bad request'

exception b2sdk.v3.exception.BadRequest(message, code)

exception b2sdk.v3.exception.BadUploadUrl(*args, **kwargs)

should_retry_upload()

Return true if this is an error that should tell the upload code to get a new upload URL and try the upload again.

exception b2sdk.v3.exception.BrokenPipe(*args, **kwargs)

should_retry_upload()

Return true if this is an error that should tell the upload code to get a new upload URL and try the upload again.

exception b2sdk.v3.exception.BucketIdNotFound(bucket_id)

exception b2sdk.v3.exception.BucketNotAllowed(*args, **kwargs)

exception b2sdk.v3.exception.CapabilityNotAllowed(*args, **kwargs)

exception b2sdk.v3.exception.CapExceeded(*args, **kwargs)

exception b2sdk.v3.exception.ChecksumMismatch(checksum_type, expected, actual)

exception b2sdk.v3.exception.ClockSkew(clock_skew_seconds)

The clock on the server differs from the local clock by too much.

exception b2sdk.v3.exception.Conflict(*args, **kwargs)

exception b2sdk.v3.exception.ConnectionReset(*args, **kwargs)

should_retry_upload()

Return true if this is an error that should tell the upload code to get a new upload URL and try the upload again.

exception b2sdk.v3.exception.CopyArgumentsMismatch(*args, **kwargs)

exception b2sdk.v3.exception.CorruptAccountInfo(file_name)

Raised when an account info file is corrupted.

exception b2sdk.v3.exception.DestFileNewer(dest_path, source_path, dest_prefix, source_prefix)

should_retry_http()

Return true if this is an error that can cause an HTTP call to be retried.

exception b2sdk.v3.exception.DestinationDirectoryDoesntAllowOperation(*args, **kwargs)

exception b2sdk.v3.exception.DestinationDirectoryDoesntExist(*args, **kwargs)

exception b2sdk.v3.exception.DestinationIsADirectory(*args, **kwargs)

exception b2sdk.v3.exception.DestinationParentIsNotADirectory(*args, **kwargs)

exception b2sdk.v3.exception.DisablingFileLockNotSupported(*args, **kwargs)

exception b2sdk.v3.exception.DuplicateBucketName(*args, **kwargs)

prefix = 'Bucket name is already in use'

exception b2sdk.v3.exception.EmailNotVerified(message, code)

should_retry_upload()

Return true if this is an error that should tell the upload code to get a new upload URL and try the upload again.

exception b2sdk.v3.exception.EmptyDirectory(path)

exception b2sdk.v3.exception.EnvironmentEncodingError(filename, encoding)

Raised when a file name can not be decoded with system encoding.

exception b2sdk.v3.exception.FileAlreadyHidden(*args, **kwargs)

exception b2sdk.v3.exception.FileNameNotAllowed(*args, **kwargs)

exception b2sdk.v3.exception.FileNotPresent(bucket_name=None, file_id_or_name=None)

exception b2sdk.v3.exception.FileSha1Mismatch(*args, **kwargs)

prefix = 'Upload file SHA1 mismatch'

exception b2sdk.v3.exception.IncompleteSync(*args, **kwargs)

exception b2sdk.v3.exception.InvalidArgument(parameter_name, message)

Raised when one or more arguments are invalid

exception b2sdk.v3.exception.InvalidAuthToken(message, code)

Specific type of Unauthorized that means the auth token is invalid. This is not the case where the auth token is valid, but does not allow access.

exception b2sdk.v3.exception.InvalidJsonResponse(content)

Parameters:

content (bytes) –

UP_TO_BYTES_COUNT = 200

exception b2sdk.v3.exception.InvalidMetadataDirective(*args, **kwargs)

exception b2sdk.v3.exception.InvalidRange(content_length, range_)

exception b2sdk.v3.exception.InvalidUploadSource(*args, **kwargs)

exception b2sdk.v3.exception.MaxFileSizeExceeded(size, max_allowed_size)

exception b2sdk.v3.exception.MaxRetriesExceeded(limit, exception_info_list)

exception b2sdk.v3.exception.MissingAccountData(key)

Raised when there is no account info data available.

exception b2sdk.v3.exception.MissingPart(*args, **kwargs)

prefix = 'Part number has not been uploaded'

exception b2sdk.v3.exception.NonExistentBucket(bucket_name=None, file_id_or_name=None)

exception b2sdk.v3.exception.NoPaymentHistory(message, code)

should_retry_upload()

Return true if this is an error that should tell the upload code to get a new upload URL and try the upload again.

exception b2sdk.v3.exception.NotADirectory(path)

exception b2sdk.v3.exception.NotAllowedByAppKeyError(*args, **kwargs)

Base class for errors caused by restrictions on an application key.

exception b2sdk.v3.exception.PartSha1Mismatch(key)

exception b2sdk.v3.exception.PotentialS3EndpointPassedAsRealm(content)

Parameters:

content (bytes) –

exception b2sdk.v3.exception.RestrictedBucket(bucket_names)

exception b2sdk.v3.exception.RestrictedBucketMissing

exception b2sdk.v3.exception.RetentionWriteError(*args, **kwargs)

exception b2sdk.v3.exception.ServiceError(*args, **kwargs)

Used for HTTP status codes 500 through 599.

exception b2sdk.v3.exception.SourceReplicationConflict(*args, **kwargs)

exception b2sdk.v3.exception.StorageCapExceeded(*args, **kwargs)

exception b2sdk.v3.exception.TooManyRequests(retry_after_seconds=None)

should_retry_http()

Return true if this is an error that can cause an HTTP call to be retried.

exception b2sdk.v3.exception.TransactionCapExceeded(*args, **kwargs)

class b2sdk.v3.exception.TransientErrorMixin

should_retry_http()

should_retry_upload()

exception b2sdk.v3.exception.TruncatedOutput(bytes_read, file_size)

exception b2sdk.v3.exception.UnableToCreateDirectory(path)

exception b2sdk.v3.exception.Unauthorized(message, code)

should_retry_upload()

Return true if this is an error that should tell the upload code to get a new upload URL and try the upload again.

exception b2sdk.v3.exception.UnexpectedCloudBehaviour(*args, **kwargs)

exception b2sdk.v3.exception.UnknownError(*args, **kwargs)

exception b2sdk.v3.exception.UnknownHost(*args, **kwargs)

exception b2sdk.v3.exception.UnrecognizedBucketType(*args, **kwargs)

exception b2sdk.v3.exception.UnsatisfiableRange(*args, **kwargs)

exception b2sdk.v3.exception.UnsupportedFilename(message, filename)

Raised when a filename is not supported by the scan operation

exception b2sdk.v3.exception.UnusableFileName(*args, **kwargs)

Raise when a filename doesn’t meet the rules.

Could possibly use InvalidUploadSource, but this is intended for the filename on the server, which could differ. https://www.backblaze.com/b2/docs/files.html.

b2sdk.v3.exception.interpret_b2_error(status, code, message, response_headers, post_params=None)

Parameters:

• status (int) –

• code (Optional[str]) –

• message (Optional[str]) –

• response_headers (dict[str, Any]) –

• post_params (Optional[dict[str, Any]]) –

Return type:

B2Error

b2sdk.v3.exception.check_invalid_argument(parameter_name, message, *exceptions)

Raise InvalidArgument in case of one of given exception was thrown.

Parameters:

• parameter_name (str) –

• message (str) –

• exceptions (type[Exception]) –

Return type:

Iterator[None]

exception b2sdk.v3.exception.SSECKeyIdMismatchInCopy(*args, **kwargs)

exception b2sdk.v3.exception.SSECKeyError(*args, **kwargs)

exception b2sdk.v3.exception.WrongEncryptionModeForBucketDefault(encryption_mode)