annoworkapi.annofab module#

外部連携システム"Annofab"に依存した関数やクラスを定義しています。

annoworkapi.annofab.ANNOFAB_PROJECT_URL_PREFIX = 'https://annofab.com/projects/'#

Annofabのプロジェクトを表すURLのプレフィックス

class annoworkapi.annofab.AnnofabWrapper(api: AnnoworkApi)[ソース]#

Annofabに依存したAPIのwrapperです。

パラメータ:

api -- AnnoworkApi Instance

get_jobs_by_annofab_project_id(workspace_id: str, annofab_project_ids: Collection[str]) → dict[str, list[dict[str, Any]]][ソース]#

Annofabのproject_idに紐づくジョブを取得します。

パラメータ:

  • workspace_id -- ワークスペースID

  • annofab_project_ids -- Annofabのproject_idsのcollection

戻り値:

keyがannofabのproject_id, valueがジョブのlistであるdict

annoworkapi.annofab.get_annofab_project_id_from_url(url: str) → str | None[ソース]#

ジョブの外部連携情報に設定されたURLからAnnofabプロジェクトのproject_idを取得します。

パラメータ:

url -- ジョブの外部連携情報であるURL

戻り値:

Annofabプロジェクトのproject_id。URLからproject_idを取得できない場合は、Noneを返します。