annofabapi.exceptions module

annofabapi.exceptions

This module contains the set of annofabapi exceptions.

exception annofabapi.exceptions.AnnofabApiException

annofabapiに関するException

exception annofabapi.exceptions.AnnotationOuterFileNotFoundError(outer_file_path: str, zipfile_path: str | None = None)

アノテーション情報の外部ファイル（塗りつぶしの画像ファイルなど）が、存在しない場合のエラー

Parameters:

• outer_file_path – 存在しなかった外部ファイルのパス

• zipfile_path – 指定した場合、「zipファイル内に外部ファイルが存在しなかった」という旨のメッセージを設定する。

exception annofabapi.exceptions.CheckSumError(message: str, uploaded_data_hash: str, response_etag: str)

アップロードしたデータ（ファイルやバイナリデータ）の整合性が一致していないときのエラー。

Parameters:

• uploaded_data_hash – アップロード対象のデータのハッシュ値（MD5）

• response_etag – アップロードしたときのレスポンスヘッダ’ETag’の値

uploaded_data_hash

アップロード対象のデータのハッシュ値（MD5）

response_etag

アップロードしたときのレスポンスヘッダ’ETag’の値

exception annofabapi.exceptions.CredentialsNotFoundError

Annofabの認証情報が見つからないときのエラー

exception annofabapi.exceptions.MfaEnabledUserExecutionError(user_id: str)

MFAが有効化されたユーザーが実行したことを示すエラー

exception annofabapi.exceptions.NotLoggedInError(message: str | None = None)

ログインしていない状態で、ログインしていることが前提のwebapiを実行したときのエラー

Parameters:

• outer_file_path – 存在しなかった外部ファイルのパス

• zipfile_path – 指定した場合、「zipファイル内に外部ファイルが存在しなかった」という旨のメッセージを設定する。