filesystem filter_annotation#

Description#

アノテーションzipから、特定のファイルを絞り込んでzip展開します。

Examples#

基本的な使い方#

--annotation には、Annofabからダウンロードしたアノテーションzipか、アノテーションzipを展開したディレクトリを指定してください。 アノテーションzipは、annofabcli annotation download コマンドでダウンロードできます。

--task_query を指定して、タスクのフェーズやステータスで絞り込むことができます。以下のコマンドは、完了状態のタスクのみzip展開します。

$ annofabcli filesystem filter_annotation  --annotation annotation.zip \
--task_query '{"status":"complete"}' \
--output_dir out/

特定のタスクのみ絞り込む場合は --task_id 、特定のタスクのみ除外する場合は --exclude_task_id を指定してください。以下のコマンドは、task1, task2以外の完了状態のタスクをzip展開します。

$ annofabcli filesystem filter_annotation  --annotation annotation.zip \
--task_query '{"status":"complete"}' \
--exclude_task_id task1 task2
--output_dir out/

task_id以外にも --input_data_id , --input_data_name で絞り込むことができます。

Usage Details#

アノテーションzipから特定のファイルを絞り込んで、zip展開します。

usage: annofabcli filesystem filter_annotation [-h] [--yes]
                                               [--endpoint_url ENDPOINT_URL]
                                               [--annofab_user_id ANNOFAB_USER_ID]
                                               [--annofab_password ANNOFAB_PASSWORD]
                                               [--annofab_pat ANNOFAB_PAT]
                                               [--mfa_code MFA_CODE]
                                               [--logdir LOGDIR]
                                               [--disable_log] [--debug]
                                               --annotation ANNOTATION
                                               [-tq TASK_QUERY]
                                               [-t TASK_ID [TASK_ID ...] |
                                               --exclude_task_id
                                               EXCLUDE_TASK_ID
                                               [EXCLUDE_TASK_ID ...] | -i
                                               INPUT_DATA_ID
                                               [INPUT_DATA_ID ...] |
                                               --exclude_input_data_id
                                               EXCLUDE_INPUT_DATA_ID
                                               [EXCLUDE_INPUT_DATA_ID ...] |
                                               --input_data_name
                                               INPUT_DATA_NAME
                                               [INPUT_DATA_NAME ...] |
                                               --exclude_input_data_name
                                               EXCLUDE_INPUT_DATA_NAME
                                               [EXCLUDE_INPUT_DATA_NAME ...]]
                                               -o OUTPUT_DIR

Named Arguments#

--annotation

アノテーションzip、またはzipを展開したディレクトリ

-tq, --task_query

タスクを絞り込むためのクエリ条件をJSON形式で指定します。使用できるキーは task_id, status, phase, phase_stage です。 file:// を先頭に付けると、JSON形式のファイルを指定できます。

-t, --task_id

抽出するタスクのtask_idを指定してください。 file:// を先頭に付けると、task_id の一覧が記載されたファイルを指定できます。

--exclude_task_id

除外するタスクのtask_idを指定してください。 file:// を先頭に付けると、task_id の一覧が記載されたファイルを指定できます。

-i, --input_data_id

抽出する入力データのinput_data_idを指定してください。 file:// を先頭に付けると、input_data_id の一覧が記載されたファイルを指定できます。

--exclude_input_data_id

除外する入力データのinput_data_idを指定してください。 file:// を先頭に付けると、input_data_id の一覧が記載されたファイルを指定できます。

--input_data_name

抽出する入力データのinput_data_nameを指定してください。 file:// を先頭に付けると、input_data_name の一覧が記載されたファイルを指定できます。

--exclude_input_data_name

除外する入力データのinput_data_nameを指定してください。 file:// を先頭に付けると、input_data_name の一覧が記載されたファイルを指定できます。

-o, --output_dir

出力先ディレクトリのパス

global optional arguments#

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: 'https://annofab.com'

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--mfa_code

Annofabにログインする際のMFAコード

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。