Skip to content

Commit

Permalink
update wrapper.py: Docstringの修正
Browse files Browse the repository at this point in the history
  • Loading branch information
@yuji38kwmt
yuji38kwmt committed Jun 17, 2019
1 parent 9052ef4 commit a54e4ac
Showing 1 changed file with 32 additions and 14 deletions.
46 changes: 32 additions & 14 deletions annofabapi/wrapper.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,10 @@ def download_annotation_archive(self, project_id: str,
dest_path: str) -> str:
"""
simpleアノテーションZIPをダウンロードする。
Args:
project_id: プロジェクトID
dest_path: ダウンロード先
dest_path: ダウンロード先のファイルパス
Returns:
ダウンロード元のURL
Expand All @@ -127,7 +128,7 @@ def get_all_annotation_list(self,
すべてのアノテーション情報を取得する。
Args:
project_id: プロジェクトID
query_params: Query Parameter
query_params: `api.get_annotation_list` メソッドのQuery Parameter
Returns:
すべてのアノテーション一覧
Expand All @@ -145,9 +146,11 @@ def copy_annotation_specs(self, src_project_id: str,
"""
アノテーション仕様を、別のプロジェクトにコピーする。
【注意】誤って実行しないようにすること
Args:
src_project_id: コピー元のproject_id
dest_project_id: コピー先のproject_id
Returns:
put_annotation_specsのContent
"""
Expand All @@ -172,9 +175,10 @@ def get_all_input_data_list(self,
) -> List[InputData]:
"""
すべての入力データを取得する。
Args:
project_id: プロジェクトID
query_params: Query Parameter
query_params: `api.get_input_data_list` メソッドのQuery Parameter
Returns:
入力データ一覧
Expand All @@ -190,6 +194,7 @@ def upload_file_to_s3(self,
content_type: Optional[str] = None) -> str:
"""
createTempPath APIを使ってアップロード用のURLとS3パスを取得して、ファイルをアップロードする。
Args:
project_id: プロジェクトID
file_path: アップロードするファイルのパス
Expand Down Expand Up @@ -237,8 +242,8 @@ def put_input_data_from_file(self,
Args:
project_id: プロジェクトID
input_data_id:
file_path: アップロードするファイル
input_data_id: 入力データID
file_path: アップロードするファイルのパス
request_body: `put_input_data` に渡すrequest body. Keyに`input_data_name` がなければ、ファイルパスが設定される。
content_type: アップロードするファイルのMIME Type. Noneの場合、ファイルパスから推測する。
Expand Down Expand Up @@ -276,8 +281,8 @@ def put_supplementary_data_from_file(self,
Args:
project_id: プロジェクトID
input_data_id:
supplementary_data_id:
input_data_id: 入力データID
supplementary_data_id: 補助情報ID
file_path: アップロードするファイル(text , image)
request_body: `put_supplementary_data` に渡すRequest Body.
`supplementary_data_name` , `supplementary_data_type` は指定されていなければ、ファイルパスから取得した情報が設定される。
Expand Down Expand Up @@ -383,7 +388,7 @@ def get_all_projects_of_organization(
組織配下のすべてのプロジェクト一覧を取得する
Args:
organization_name: 組織名
query_params: Query Parameter
query_params: `api.get_projects_of_organization` メソッドに渡すQuery Parameter
Returns:
すべてのプロジェクト一覧
Expand Down Expand Up @@ -419,6 +424,7 @@ def download_project_tasks_url(self, project_id: str,
"""
プロジェクトのタスク全件ファイルをダウンロードする。
ファイルの中身はJSON。
Args:
project_id: プロジェクトID
dest_path: ダウンロード先ファイルのパス
Expand All @@ -438,6 +444,7 @@ def download_project_inspections_url(self, project_id: str,
"""
プロジェクトの検査コメント全件ファイルをダウンロードする。
ファイルの中身はJSON。
Args:
project_id: プロジェクトID
dest_path: ダウンロード先ファイルのパス
Expand All @@ -457,6 +464,7 @@ def download_project_task_history_events_url(self, project_id: str,
"""
プロジェクトのタスク履歴イベント全件ファイルをダウンロードする。
ファイルの中身はJSON。
Args:
project_id: プロジェクトID
dest_path: ダウンロード先ファイルのパス
Expand All @@ -479,10 +487,11 @@ def get_all_project_members(self,
query_params: Optional[Dict[str, Any]] = None
) -> List[ProjectMember]:
"""
すべてのプロジェクトメンバを取得する
すべてのプロジェクトメンバを取得する.
Args:
project_id: プロジェクトID
query_params: Query Parameter
query_params: `api.get_project_members` メソッドのQuery Parameter
Returns:
すべてのプロジェクトメンバ一覧
Expand Down Expand Up @@ -549,6 +558,7 @@ def assign_role_to_project_members(self, project_id: str,
project_id: プロジェクトID
user_id_list: 追加/更新するメンバのuser_idのList
member_role: 割り当てるロール.
Returns:
`putProjectMember` APIのContentのList
Expand All @@ -574,6 +584,7 @@ def drop_role_to_project_members(self, project_id, user_id_list: List[str]
Args:
project_id: プロジェクトID
user_id_list: 脱退させるメンバのuser_idのList
Returns:
`putProjectMember` APIのContentのList
"""
Expand Down Expand Up @@ -637,6 +648,7 @@ def initiate_tasks_generation_by_csv(self, project_id: str,
) -> Dict[str, Any]:
"""
CSV Fileでタスクを生成する
Args:
project_id: プロジェクトID
csvfile_path: CSVファイルのパス
Expand Down Expand Up @@ -667,12 +679,13 @@ def get_all_tasks(self,
) -> List[Task]:
"""
すべてのタスクを取得する。
Args:
project_id: プロジェクトID
query_params: Query Parameter
query_params: `api.get_tasks`メソッドに渡すQuery Parameter
Returns:
タスク一覧
すべてのタスク一覧
"""
return self._get_all_objects(self.api.get_tasks,
limit=200,
Expand All @@ -686,6 +699,7 @@ def get_latest_instruction(self, project_id: str) -> str:
"""
最新の作業ガイドの取得.
ガイドが設定されていない場合は空文字を返す。
Args:
project_id: プロジェクトID
Expand All @@ -706,6 +720,7 @@ def upload_instruction_image(self,
content_type: Optional[str] = None) -> str:
"""
作業ガイドの画像をアップロードする。image_idはUUIDv4
Args:
project_id: プロジェクトID
image_id: 作業ガイド画像ID
Expand Down Expand Up @@ -749,9 +764,11 @@ def delete_all_succeeded_job(self, project_id: str,
job_type: str) -> List[ProjectJob]:
"""
成功したジョブをすべて削除する
Args:
project_id: プロジェクトID
job_type: ジョブ種別("copy-project" "gen-inputs" "gen-tasks" "gen-annotation")
Returns:
削除したジョブの一覧
"""
Expand All @@ -770,12 +787,13 @@ def get_all_project_job(self, project_id: str,
"""
すべてのバックグランドジョブを取得する。
2019/01時点でAPIが未実装のため、このメソッドも未実装。
Args:
project_id: プロジェクトID
query_params: Query Parameter
query_params: `api.get_project_job` メソッドに渡すQuery Parameter
Returns:
バックグランドジョブ一覧
すべてのバックグランドジョブ一覧
"""

# return self._get_all_objects(self.api.get_project_job,
Expand Down

0 comments on commit a54e4ac

Please sign in to comment.