annofabapi.resource module#

class annofabapi.resource.Resource(credentials: IdPass | Pat, *, endpoint_url: str = 'https://annofab.com', input_mfa_code_via_stdin: bool = False)[source]#

AnnofabApi, Wrapperのインスタンスを保持するクラス

Parameters:

login_user_id – AnnofabにログインするときのユーザID
login_password – Annofabにログインするときのパスワード
endpoint_url – Annofab APIのエンドポイント。
input_mfa_code_via_stdin – MFAコードを標準入力から入力するかどうか Falseを渡して且つMFAコードの入力を求められるアカウントを利用する場合、mfa_codeを引数にloginメソッドを直接呼び出さなければならず、そうしない場合は例外を送出する

api#: annofabapi.AnnofabApi のインスタンス

wrapper#: annofabapi.Wrapper のインスタンス

api2#: annofabapi.AnnofabApi2 のインスタンス

annofabapi.resource.build(login_user_id: str | None = None, login_password: str | None = None, pat: str | None = None, *, endpoint_url: str = 'https://annofab.com', input_mfa_code_via_stdin: bool = False) → Resource[source]#

AnnofabApi, Wrapperのインスタンスを保持するインスタンスを生成する。

pat``が渡された場合はそれが優先して利用される。 ``pat / login_user_id / login_password の全てがNoneの場合は、.netrc ファイルまたは環境変数から認証情報を取得する。認証情報は、環境変数, .netrc ファイルの順に読み込む。

環境変数は``ANNOFAB_USER_ID`` , ANNOFAB_PASSWORD, ANNOFAB_PAT を参照し、``ANNOFAB_PAT``が設定されている場合はそれ以外を無視する。

Parameters:

login_user_id – AnnofabにログインするときのユーザID
login_password – Annofabにログインするときのパスワード
pat – パーソナルアクセストークン。この値を渡した場合、login_user_idとlogin_passwordは無視される
endpoint_url – Annofab APIのエンドポイント。
input_mfa_code_via_stdin – MFAコードを標準入力から入力するかどうか Falseを渡して且つMFAコードの入力を求められるアカウントを利用する場合、mfa_codeを引数にloginメソッドを直接呼び出さなければならず、そうしない場合は例外を送出する

Returns:

AnnofabApi, Wrapperのインスタンスを保持するインスタンス

Raises:

CredentialsNotFoundError – `.netrc`ファイルまたは環境変数にAnnofabの認証情報がなかった

annofabapi.resource.build_from_env(*, endpoint_url: str = 'https://annofab.com', input_mfa_code_via_stdin: bool = False) → Resource[source]#

環境変数 ANNOFAB_USER_ID , ANNOFAB_PASSWORD, ANNOFAB_PAT から、annofabapi.Resourceインスタンスを生成する。 ``ANNOFAB_PAT``が設定されている場合はそれが優先して利用される。

Parameters:

endpoint_url – Annofab APIのエンドポイント。
input_mfa_code_via_stdin – MFAコードを標準入力から入力するかどうか Falseを渡して且つMFAコードの入力を求められるアカウントを利用する場合、mfa_codeを引数にloginメソッドを直接呼び出さなければならず、そうしない場合は例外を送出する

Returns:

annofabapi.Resourceインスタンス

Raises:

CredentialsNotFoundError – 環境変数にAnnofabの認証情報がなかった

annofabapi.resource.build_from_netrc(*, endpoint_url: str = 'https://annofab.com', input_mfa_code_via_stdin: bool = False) → Resource[source]#

.netrc ファイルから、annofabapi.Resourceインスタンスを生成する。

Parameters:

endpoint_url – Annofab APIのエンドポイント。
input_mfa_code_via_stdin – MFAコードを標準入力から入力するかどうか Falseを渡して且つMFAコードの入力を求められるアカウントを利用する場合、mfa_codeを引数にloginメソッドを直接呼び出さなければならず、そうしない場合は例外を送出する

Returns:

annofabapi.Resourceインスタンス

Raises:

CredentialsNotFoundError – `.netrc`ファイルにAnnofabの認証情報がなかった