annofabapi.utils module#
- annofabapi.utils.can_put_annotation(task: Dict[str, Any], my_account_id: str) bool[source]#
対象タスクが、put_annotation APIで、アノテーションを更新できる状態かどうか。 過去に担当者が割り当たっている場合、または現在の担当者が自分自身の場合は、アノテーションを更新できる。
- Parameters:
task – 対象タスク
my_account_id – 自分（ログインしているユーザ）のアカウントID
- Returns:
Trueならば、タスクの状態を変更せずに`put_annotation` APIを実行できる。
- annofabapi.utils.get_message_for_i18n(internationalization_message: Dict[str, Any], lang: str = 'en-US') str[source]#
アノテーション仕様で使われている`InternalizationMessage`クラスの値から、指定された言語のメッセージを取得する。
- Parameters:
internationalization_message – 多言語化されたメッセージ
lang – 取得したいメッセージに対応する言語コード。`en-US`または`ja-JP`のみサポートしています。
- Returns:
指定した言語に対応するメッセージ。
- Raises:
ValueError – 引数langに対応するメッセージが見つからない場合
- annofabapi.utils.get_number_of_rejections(task_histories: List[Dict[str, Any]], phase: TaskPhase, phase_stage: int = 1) int[source]#
タスク履歴から、指定されたタスクフェーズでの差し戻し回数を取得する。
- Parameters:
task_histories – タスク履歴
phase – どのフェーズで差し戻されたか(TaskPhase.INSPECTIONかTaskPhase.ACCEPTANCE)
phase_stage – どのフェーズステージで差し戻されたか。デフォルトは1。
- Returns:
差し戻し回数
- annofabapi.utils.get_task_history_index_skipped_acceptance(task_history_list: List[Dict[str, Any]]) List[int][source]#
受入がスキップされたタスク履歴のインデックス番号（0始まり）を返す。
- Parameters:
task_history_list – タスク履歴List
- Returns:
受入フェーズがスキップされた履歴のインデックス番号（0始まり）。受入がスキップされていない場合は空リストを返す。