annofabcli 1.105.0__tar.gz → 1.105.1__tar.gz

{annofabcli-1.105.0 → annofabcli-1.105.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annofabcli
-Version: 1.105.0
+Version: 1.105.1
 Summary: Utility Command Line Interface for AnnoFab
 Author: Kurusugawa Computer Inc.
 License: MIT

{annofabcli-1.105.0 → annofabcli-1.105.1}/annofabcli/annotation/change_annotation_attributes_per_annotation.py

@@ -9,6 +9,7 @@ from pathlib import Path
 from typing import Any, Optional, Union
 
 import annofabapi
+import pandas
 from annofabapi.models import ProjectMemberRole
 from annofabapi.pydantic_models.task_status import TaskStatus
 from pydantic import BaseModel
@@ -205,12 +206,23 @@ class ChangeAttributesPerAnnotation(CommandLine):
     def main(self) -> None:
         args = self.args
 
-        annotation_items = get_json_from_args(args.json)
-        if not isinstance(annotation_items, list):
-            print(f"{self.COMMON_MESSAGE} argument --json: JSON形式が不正です。オブジェクトの配列を指定してください。", file=sys.stderr)  # noqa: T201
-            sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
+        if args.json is not None:
+            annotation_items = get_json_from_args(args.json)
+            if not isinstance(annotation_items, list):
+                print(f"{self.COMMON_MESSAGE} argument --json: JSON形式が不正です。オブジェクトの配列を指定してください。", file=sys.stderr)  # noqa: T201
+                sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
 
-        target_annotation_list = [TargetAnnotation.model_validate(anno) for anno in annotation_items]
+            target_annotation_list = [TargetAnnotation.model_validate(anno) for anno in annotation_items]
+
+        elif args.csv is not None:
+            df_input = pandas.read_csv(args.csv)
+            target_annotation_list = [
+                TargetAnnotation(task_id=e["task_id"], input_data_id=e["input_data_id"], annotation_id=e["annotation_id"], attributes=json.loads(e["attributes"]))
+                for e in df_input.to_dict(orient="records")
+            ]
+        else:
+            print(f"{self.COMMON_MESSAGE} argument '--json' または '--csv' のいずれかを指定してください。", file=sys.stderr)  # noqa: T201
+            sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
 
         project_id = args.project_id
 
@@ -243,13 +255,20 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     argument_parser.add_project_id()
 
     sample_json_obj = [{"task_id": "t1", "input_data_id": "i1", "annotation_id": "a1", "attributes": {"occluded": True}}]
-    parser.add_argument(
+    input_group = parser.add_mutually_exclusive_group(required=True)
+    input_group.add_argument(
         "--json",
         type=str,
-        required=True,
         help="各アノテーションごとに変更内容を記載したJSONリストを指定します。 ``file://`` を先頭に付けるとJSON形式のファイルを指定できます。\n"
         f"(例) '{json.dumps(sample_json_obj, ensure_ascii=False)}'",
     )
+    input_group.add_argument(
+        "--csv",
+        type=str,
+        help="各アノテーションごとに変更内容を記載したCSVファイルを指定します。 \n"
+        "* `task_id`, `input_data_id`, `annotation_id`, `attributes` の4つのカラムが必要です。\n"
+        f"`attributes` カラムには、属性名と値を '{json.dumps({'occluded': True})}' のようにJSON形式で指定します。\n",
+    )
 
     parser.add_argument(
         "--force",

{annofabcli-1.105.0 → annofabcli-1.105.1}/docs/command_reference/annotation/change_attributes_per_annotation.rst

@@ -12,10 +12,14 @@ Description
 Examples
 =================================
 
+変更する属性値をJSON形式で指定する
+---------------------------------------
+
 
 引数 ``--json`` に、変更対象のアノテーションの情報（ ``task_id`` , ``input_data_id`` , ``annotation_id`` ）と変更後の属性値（ ``attributes`` ）をJSON形式で指定します。
 
 ``attributes`` のフォーマットは、 `Command line options <../../user_guide/command_line_options.html#annotation-query-aq>`_ の ``attributes`` キーの値と同じフォーマットです。
+変更したい属性名と値を指定します。
 
 .. code-block:: json
     :caption: annotations.json
@@ -37,6 +41,42 @@ Examples
      --backup backup_dir/ \
 
 
+変更する属性値をCSVで指定する
+---------------------------------------
+引数 ``--csv`` に、変更対象のアノテーションの情報と変更後の属性値が記載されたCSVファイルのパスを指定します。
+
+CSVのフォーマットは以下の通りです。
+
+* ヘッダ行あり
+* カンマ区切り
+
+.. csv-table::
+   :header: 列名,必須,備考
+
+    task_id,Yes,
+    input_data_id,Yes,
+    annotation_id,Yes,
+    attributes,Yes,変更したい属性名と値のオブジェクト（JSON形式）
+
+以下はCSVファイルのサンプルです。
+
+.. code-block::
+    :caption: annotations.csv
+
+    task_id,input_data_id,annotation_id,attributes
+    t1,i1,a1,"{""comment"":""bar"",""number"":3}"
+
+
+.. code-block::
+
+    $ annofabcli annotation change_attributes_per_annotation --project_id p1 \
+     --csv annotations.csv \
+     --backup backup_dir/ \
+
+
+その他のオプション
+---------------------------------------
+
 ``--backup`` にディレクトリを指定すると、変更対象のフレームに含まれるアノテーション情報を、指定したディレクトリに保存します。
 アノテーション情報の復元は、 `annofabcli annotation restore <../annotation/restore.html>`_ コマンドで実現できます。
 
@@ -50,6 +90,7 @@ Examples
 ただし、オーナーロールのユーザーで実行する必要があります。
 
 
+
 Usage Details
 =================================