project diff#

Description#

プロジェクト間の以下の情報について、差分を出力します。

Examples#

基本的な使い方#

比較したいプロジェクトのproject_idを指定してください。

以下のコマンドは、プロジェクトprj1とprj2の差分を出力します。差分がない場合、標準出力は空です。

$ annofabcli project diff  prj1 prj2

特定の項目のみ差分を出力する場合は、--target を指定してください。指定できる値は以下の通りです。

  • annotation_labels : アノテーション仕様のラベル情報

  • inspection_phrases : 定型指摘

  • members : プロジェクトメンバ

  • settings : プロジェクト設定

$ annofabcli project diff prj1 prj2 --target annotation_labels

出力結果#

プロジェクト間の差分は、以下のように出力されます。

=== prj1_title1(prj1) と prj1_title2(prj2) の差分を表示
=== プロジェクトメンバの差分 ===
プロジェクトメンバは同一
=== プロジェクト設定の差分 ===
プロジェクト設定は同一
=== 定型指摘の差分 ===
定型指摘は同一
=== アノテーションラベル情報の差分 ===
ラベル名(en): car は差分あり
[('change', 'color.red', (4, 0)),
('change', 'color.green', (251, 255)),
('change', 'color.blue', (171, 204))]
ラベル名(en): bike は同一

dict 型の差分は、dictdiffer のフォーマットで出力されます。

Usage Details#

プロジェクト間の差分を表示する。ただし、Annofabで生成されるIDや、変化する日時などは比較しない。

usage: annofabcli project diff [-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]
                               [--target {annotation_labels,inspection_phrases,members,settings} [{annotation_labels,inspection_phrases,members,settings} ...]]
                               project_id1 project_id2

Positional Arguments#

project_id1

比較対象のプロジェクトのproject_id

project_id2

比較対象のプロジェクトのproject_id

Named Arguments#

--target

Possible choices: annotation_labels, inspection_phrases, members, settings

比較する項目。指定しなければ全項目を比較する。annotation_labels: アノテーション仕様のラベル情報, inspection_phrases: 定型指摘,members: プロジェクトメンバ,settings: プロジェクト設定,

Default: ['annotation_labels', 'inspection_phrases', 'members', 'settings']

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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

オーナ、チェッカーロールのいずれかを持つユーザで実行してください。

On this page
Edit on GitHub