annofabcli 1.110.0__tar.gz → 1.111.0__tar.gz

{annofabcli-1.110.0 → annofabcli-1.111.0}/.github/copilot-instructions.md

@@ -29,7 +29,7 @@ AnnofabのCLIです。
 * Noneの判定、空文字列の判定、長さが0のコレクションの判定は、falsyとして判定するのでなく、`if a is not None:`のように判定内容を明記してください。
 * 型ヒントを`dict`にする場合、`dict[str, Any]`のようにキーと値の型を指定する。
 * 変数などに対するコメントは行末に書くのでなく、docstringを使って下の行に書く。
-
+* `from __future__ import annotations`を使わない。
 
 ### ログメッセージ
 * 日本語で書く。
@@ -64,6 +64,7 @@ AnnofabのCLIです。
 
 ### ドキュメント
 * コマンドのドキュメントは、`docs/command_reference/`に作成する。
+* `docs/`配下のrstファイルを参照する場合は、`:doc:`ディレクティブを使う。URLを直接書かない。
 * コマンドの末尾には以下のように`.. argparse::`ディレクティブを追加して、`argparse`から自動生成されるUsage Detailsセクションを挿入する。
 
 ```

{annofabcli-1.110.0 → annofabcli-1.111.0}/PKG-INFO

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

annofabcli-1.111.0/annofabcli/annotation_zip/list_single_point_annotation.py

@@ -0,0 +1,317 @@
+import argparse
+import logging
+import sys
+import tempfile
+from collections.abc import Collection
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any, Optional
+
+import pandas
+from annofabapi.models import InputDataType, ProjectMemberRole
+from dataclasses_json import DataClassJsonMixin
+
+import annofabcli
+import annofabcli.common.cli
+from annofabcli.common.annofab.annotation_zip import lazy_parse_simple_annotation_by_input_data
+from annofabcli.common.cli import COMMAND_LINE_ERROR_STATUS_CODE, ArgumentParser, CommandLine, build_annofabapi_resource_and_login, get_list_from_args
+from annofabcli.common.download import DownloadingFile
+from annofabcli.common.enums import FormatArgument
+from annofabcli.common.facade import (
+    AnnofabApiFacade,
+    TaskQuery,
+    match_annotation_with_task_query,
+)
+from annofabcli.common.utils import print_csv, print_json
+
+logger = logging.getLogger(__name__)
+
+
+@dataclass(frozen=True)
+class AnnotationSinglePointInfo(DataClassJsonMixin):
+    project_id: str
+    task_id: str
+    task_status: str
+    task_phase: str
+    task_phase_stage: int
+
+    input_data_id: str
+    input_data_name: str
+
+    updated_datetime: Optional[str]
+    """アノテーションJSONに格納されているアノテーションの更新日時"""
+
+    label: str
+    annotation_id: str
+    point: dict[str, int]
+
+
+def get_annotation_single_point_info_list(simple_annotation: dict[str, Any], *, target_label_names: Optional[Collection[str]] = None) -> list[AnnotationSinglePointInfo]:
+    result = []
+    target_label_names_set = set(target_label_names) if target_label_names is not None else None
+    for detail in simple_annotation["details"]:
+        if detail["data"]["_type"] == "SinglePoint":
+            label = detail["label"]
+            # ラベル名によるフィルタリング
+            if target_label_names_set is not None and label not in target_label_names_set:
+                continue
+
+            point = detail["data"]["point"]
+
+            result.append(
+                AnnotationSinglePointInfo(
+                    project_id=simple_annotation["project_id"],
+                    task_id=simple_annotation["task_id"],
+                    task_phase=simple_annotation["task_phase"],
+                    task_phase_stage=simple_annotation["task_phase_stage"],
+                    task_status=simple_annotation["task_status"],
+                    input_data_id=simple_annotation["input_data_id"],
+                    input_data_name=simple_annotation["input_data_name"],
+                    label=label,
+                    annotation_id=detail["annotation_id"],
+                    point=point,
+                    updated_datetime=simple_annotation["updated_datetime"],
+                )
+            )
+
+    return result
+
+
+def get_annotation_single_point_info_list_from_annotation_path(
+    annotation_path: Path,
+    *,
+    target_task_ids: Optional[Collection[str]] = None,
+    task_query: Optional[TaskQuery] = None,
+    target_label_names: Optional[Collection[str]] = None,
+) -> list[AnnotationSinglePointInfo]:
+    annotation_point_list = []
+    target_task_ids = set(target_task_ids) if target_task_ids is not None else None
+    iter_parser = lazy_parse_simple_annotation_by_input_data(annotation_path)
+    logger.info(f"アノテーションZIPまたはディレクトリ'{annotation_path}'を読み込みます。")
+    for index, parser in enumerate(iter_parser):
+        if (index + 1) % 10000 == 0:
+            logger.info(f"{index + 1}  件目のJSONを読み込み中")
+        if target_task_ids is not None and parser.task_id not in target_task_ids:
+            continue
+        dict_simple_annotation = parser.load_json()
+        if task_query is not None and not match_annotation_with_task_query(dict_simple_annotation, task_query):
+            continue
+        sub_annotation_point_list = get_annotation_single_point_info_list(dict_simple_annotation, target_label_names=target_label_names)
+        annotation_point_list.extend(sub_annotation_point_list)
+    return annotation_point_list
+
+
+def create_df(
+    annotation_point_list: list[AnnotationSinglePointInfo],
+) -> pandas.DataFrame:
+    columns = [
+        "project_id",
+        "task_id",
+        "task_status",
+        "task_phase",
+        "task_phase_stage",
+        "input_data_id",
+        "input_data_name",
+        "updated_datetime",
+        "label",
+        "annotation_id",
+        "point.x",
+        "point.y",
+    ]
+    df = pandas.DataFrame(
+        [
+            {
+                "project_id": e.project_id,
+                "task_id": e.task_id,
+                "task_status": e.task_status,
+                "task_phase": e.task_phase,
+                "task_phase_stage": e.task_phase_stage,
+                "input_data_id": e.input_data_id,
+                "input_data_name": e.input_data_name,
+                "updated_datetime": e.updated_datetime,
+                "label": e.label,
+                "annotation_id": e.annotation_id,
+                "point.x": e.point["x"],
+                "point.y": e.point["y"],
+            }
+            for e in annotation_point_list
+        ],
+        columns=columns,
+    )
+
+    return df[columns]
+
+
+def print_annotation_single_point(
+    annotation_path: Path,
+    output_file: Path,
+    output_format: FormatArgument,
+    *,
+    target_task_ids: Optional[Collection[str]] = None,
+    task_query: Optional[TaskQuery] = None,
+    target_label_names: Optional[Collection[str]] = None,
+) -> None:
+    annotation_point_list = get_annotation_single_point_info_list_from_annotation_path(
+        annotation_path,
+        target_task_ids=target_task_ids,
+        task_query=task_query,
+        target_label_names=target_label_names,
+    )
+
+    logger.info(f"{len(annotation_point_list)} 件の点アノテーションの情報を出力します。 :: output='{output_file}'")
+
+    if output_format == FormatArgument.CSV:
+        df = create_df(annotation_point_list)
+        print_csv(df, output_file)
+
+    elif output_format in [FormatArgument.PRETTY_JSON, FormatArgument.JSON]:
+        json_is_pretty = output_format == FormatArgument.PRETTY_JSON
+        # DataClassJsonMixinを使用したtoJSON処理
+        print_json(
+            [e.to_dict(encode_json=True) for e in annotation_point_list],
+            is_pretty=json_is_pretty,
+            output=output_file,
+        )
+
+    else:
+        raise ValueError(f"出力形式 '{output_format}' はサポートされていません。")
+
+
+class ListAnnotationSinglePoint(CommandLine):
+    COMMON_MESSAGE = "annofabcli annotation_zip list_single_point_annotation: error:"
+
+    def validate(self, args: argparse.Namespace) -> bool:
+        if args.project_id is None and args.annotation is None:
+            print(  # noqa: T201
+                f"{self.COMMON_MESSAGE} argument --project_id: '--annotation'が未指定のときは、'--project_id' を指定してください。",
+                file=sys.stderr,
+            )
+            return False
+        return True
+
+    def main(self) -> None:
+        args = self.args
+
+        if not self.validate(args):
+            sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
+
+        project_id: Optional[str] = args.project_id
+        if project_id is not None:
+            super().validate_project(project_id, project_member_roles=[ProjectMemberRole.OWNER, ProjectMemberRole.TRAINING_DATA_USER])
+            project, _ = self.service.api.get_project(project_id)
+            if project["input_data_type"] != InputDataType.IMAGE.value:
+                print(f"project_id='{project_id}'であるプロジェクトは画像プロジェクトでないので、終了します", file=sys.stderr)  # noqa: T201
+                sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
+
+        annotation_path = Path(args.annotation) if args.annotation is not None else None
+
+        task_id_list = get_list_from_args(args.task_id) if args.task_id is not None else None
+        task_query = TaskQuery.from_dict(annofabcli.common.cli.get_json_from_args(args.task_query)) if args.task_query is not None else None
+        label_name_list = get_list_from_args(args.label_name) if args.label_name is not None else None
+
+        output_file: Path = args.output
+        output_format = FormatArgument(args.format)
+
+        downloading_obj = DownloadingFile(self.service)
+
+        def download_and_print_annotation_point(project_id: str, temp_dir: Path, *, is_latest: bool) -> None:
+            local_annotation_path = temp_dir / f"{project_id}__annotation.zip"
+            downloading_obj.download_annotation_zip(
+                project_id,
+                dest_path=local_annotation_path,
+                is_latest=is_latest,
+            )
+            print_annotation_single_point(
+                local_annotation_path,
+                output_file,
+                output_format,
+                target_task_ids=task_id_list,
+                task_query=task_query,
+                target_label_names=label_name_list,
+            )
+
+        if project_id is not None:
+            if args.temp_dir is not None:
+                download_and_print_annotation_point(project_id=project_id, temp_dir=args.temp_dir, is_latest=args.latest)
+            else:
+                with tempfile.TemporaryDirectory() as str_temp_dir:
+                    download_and_print_annotation_point(
+                        project_id=project_id,
+                        temp_dir=Path(str_temp_dir),
+                        is_latest=args.latest,
+                    )
+        else:
+            assert annotation_path is not None
+            print_annotation_single_point(
+                annotation_path,
+                output_file,
+                output_format,
+                target_task_ids=task_id_list,
+                task_query=task_query,
+                target_label_names=label_name_list,
+            )
+
+
+def parse_args(parser: argparse.ArgumentParser) -> None:
+    argument_parser = ArgumentParser(parser)
+
+    group = parser.add_mutually_exclusive_group(required=True)
+    group.add_argument(
+        "--annotation",
+        type=str,
+        help="アノテーションzip、またはzipを展開したディレクトリを指定します。",
+    )
+
+    group.add_argument("-p", "--project_id", type=str, help="project_id。アノテーションZIPをダウンロードします。")
+
+    argument_parser.add_format(
+        choices=[FormatArgument.CSV, FormatArgument.JSON, FormatArgument.PRETTY_JSON],
+        default=FormatArgument.CSV,
+    )
+
+    argument_parser.add_output()
+
+    parser.add_argument(
+        "-tq",
+        "--task_query",
+        type=str,
+        help="集計対象タスクを絞り込むためのクエリ条件をJSON形式で指定します。使用できるキーは task_id, status, phase, phase_stage です。"
+        " ``file://`` を先頭に付けると、JSON形式のファイルを指定できます。",
+    )
+    argument_parser.add_task_id(required=False)
+
+    parser.add_argument(
+        "--label_name",
+        type=str,
+        nargs="*",
+        help="指定したラベル名の点アノテーションのみを対象にします。複数指定できます。",
+    )
+
+    parser.add_argument(
+        "--latest",
+        action="store_true",
+        help="``--annotation`` を指定しないとき、最新のアノテーションzipを参照します。このオプションを指定すると、アノテーションzipを更新するのに数分待ちます。",
+    )
+
+    parser.add_argument(
+        "--temp_dir",
+        type=Path,
+        help="指定したディレクトリに、アノテーションZIPなどの一時ファイルをダウンロードします。",
+    )
+
+    parser.set_defaults(subcommand_func=main)
+
+
+def main(args: argparse.Namespace) -> None:
+    service = build_annofabapi_resource_and_login(args)
+    facade = AnnofabApiFacade(service)
+    ListAnnotationSinglePoint(service, facade, args).main()
+
+
+def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:
+    subcommand_name = "list_single_point_annotation"
+    subcommand_help = "アノテーションZIPから点アノテーションの座標情報を出力します。"
+    epilog = "アノテーションZIPをダウンロードする場合は、オーナロールまたはアノテーションユーザロールを持つユーザで実行してください。"
+    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description=subcommand_help, epilog=epilog)
+    parse_args(parser)
+    return parser

{annofabcli-1.110.0 → annofabcli-1.111.0}/annofabcli/annotation_zip/subcommand_annotation_zip.py

@@ -6,6 +6,7 @@ from typing import Optional
 import annofabcli
 from annofabcli.annotation_zip.list_annotation_bounding_box_2d import add_parser as add_parser_list_annotation_bounding_box_2d
 from annofabcli.annotation_zip.list_range_annotation import add_parser as add_parser_list_range_annotation
+from annofabcli.annotation_zip.list_single_point_annotation import add_parser as add_parser_list_single_point_annotation
 
 
 def parse_args(parser: argparse.ArgumentParser) -> None:
@@ -19,6 +20,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     # サブコマンドの定義
     add_parser_list_annotation_bounding_box_2d(subparsers)
     add_parser_list_range_annotation(subparsers)
+    add_parser_list_single_point_annotation(subparsers)
     # 作成中のためコメントアウト
     # add_parser_validate_annotation(subparsers)
 

{annofabcli-1.110.0 → annofabcli-1.111.0}/annofabcli/task/put_tasks.py

@@ -286,7 +286,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
         "--api",
         type=str,
         choices=[e.value for e in ApiWithCreatingTask],
-        help="タスク作成に使うWebAPIを指定できます。 ``--csv`` or ``--json`` を指定したときのみ有効なオプションです。\n未指定の場合は、作成するタスク数に応じて、適切なWebAPIを選択します。\n",
+        help="タスク作成に使うWebAPIを指定できます。未指定の場合は、作成するタスク数に応じて適切なWebAPIを選択します。",
     )
 
     parser.add_argument(

{annofabcli-1.110.0 → annofabcli-1.111.0}/docs/command_reference/annotation_zip/index.rst

@@ -17,6 +17,7 @@ Available Commands
 
    list_bounding_box_annotation
    list_range_annotation
+   list_single_point_annotation
 
 
 Usage Details

annofabcli-1.111.0/docs/command_reference/annotation_zip/list_single_point_annotation.rst

@@ -0,0 +1,47 @@
+====================================================================================
+annotation_zip list_single_point_annotation
+====================================================================================
+
+
+Description
+=================================
+アノテーションZIPから点アノテーションの座標情報を出力します。
+
+Examples
+=================================
+
+.. code-block:: bash
+
+
+    $ annofabcli annotation_zip list_single_point_annotation --project_id prj1 --output out.json --format pretty_json
+
+
+
+.. code-block:: json
+    :caption: out.json
+
+    [
+      {
+        "project_id": "proj1",
+        "task_id": "task_00",
+        "task_status": "complete",
+        "task_phase": "annotation",
+        "task_phase_stage": 1,
+        "input_data_id": "i1",
+        "input_data_name": "i1.jpg",
+        "updated_datetime": "2023-10-01T12:00:00.000+09:00",
+        "label": "cat",
+        "annotation_id": "ann1",
+        "point": {"x": 0, "y": 0}
+      }
+    ]
+
+
+Usage Details
+=================================
+
+.. argparse::
+    :ref: annofabcli.annotation_zip.list_single_point_annotation.add_parser
+    :prog: annofabcli annotation_zip list_single_point_annotation
+    :nosubcommands:
+    :nodefaultconst:

{annofabcli-1.110.0 → annofabcli-1.111.0}/docs/command_reference/project/update_configuration.rst

@@ -38,6 +38,9 @@ Examples
         
         # S3プライベートストレージ認可用AWS IAMロールARN
         "private_storage_aws_iam_role_arn": "arn:aws:iam::123456789012:role/YourRoleName",
+
+        # S3プライベートストレージにアクセスする際に、AWS S3 Transfer Accelerationを使用する
+        "use_s3_transfer_acceleration": true
     }
     
 

{annofabcli-1.110.0 → annofabcli-1.111.0}/docs/command_reference/task/reject.rst

@@ -62,7 +62,7 @@ Examples
      --comment "weather属性を見直してください。" \
      --comment_data '{"x":10,"y":10,"_type":"Point"}'
 
-``--comment_data`` に渡す形式は、https://annofab-cli.readthedocs.io/ja/latest/command_reference/inspection_comment/put_simply.html を参照してください。
+``--comment_data`` に渡す形式は、 :doc:`../comment/put_inspection_simply` コマンドを参照してください。
 
 ``--comment_data`` を指定しない場合は、以下の検査コメントが付与されます。
 

annofabcli-1.111.0/tests/annotation_zip/test_list_single_point_annotation.py

@@ -0,0 +1,102 @@
+"""
+Test cases for annofabcli.annotation_zip.list_single_point_annotation module
+"""
+
+from pathlib import Path
+
+import pytest
+
+from annofabcli.__main__ import main
+from annofabcli.annotation_zip.list_single_point_annotation import get_annotation_single_point_info_list
+
+out_dir = Path("tests/out/annotation_zip")
+data_dir = Path("tests/data/annotation_zip")
+
+
+class TestGetAnnotationSinglePointInfoList:
+    """get_annotation_single_point_info_list関数のテストクラス"""
+
+    def test_get_annotation_single_point_info_list_basic(self):
+        """基本的な動作をテスト：SinglePoint型のアノテーションを正しく抽出できるか"""
+        simple_annotation = {
+            "project_id": "test_project",
+            "task_id": "test_task",
+            "task_phase": "annotation",
+            "task_phase_stage": 1,
+            "task_status": "working",
+            "input_data_id": "test_image.jpg",
+            "input_data_name": "test_image.jpg",
+            "updated_datetime": "2023-01-01T00:00:00+09:00",
+            "details": [
+                {"label": "landmark", "annotation_id": "point1", "data": {"_type": "SinglePoint", "point": {"x": 100, "y": 200}}},
+                {"label": "center", "annotation_id": "point2", "data": {"_type": "SinglePoint", "point": {"x": 50, "y": 75}}},
+            ],
+        }
+
+        result = get_annotation_single_point_info_list(simple_annotation)
+
+        assert len(result) == 2
+
+        # 1番目のアノテーション
+        first_annotation = result[0]
+        assert first_annotation.project_id == "test_project"
+        assert first_annotation.task_id == "test_task"
+        assert first_annotation.task_phase == "annotation"
+        assert first_annotation.task_phase_stage == 1
+        assert first_annotation.task_status == "working"
+        assert first_annotation.input_data_id == "test_image.jpg"
+        assert first_annotation.input_data_name == "test_image.jpg"
+        assert first_annotation.updated_datetime == "2023-01-01T00:00:00+09:00"
+        assert first_annotation.label == "landmark"
+        assert first_annotation.annotation_id == "point1"
+        assert first_annotation.point == {"x": 100, "y": 200}
+
+        # 2番目のアノテーション
+        second_annotation = result[1]
+        assert second_annotation.label == "center"
+        assert second_annotation.annotation_id == "point2"
+        assert second_annotation.point == {"x": 50, "y": 75}
+
+    def test_get_annotation_single_point_info_list_with_label_filter(self):
+        """target_label_names でフィルタリングが正しく機能するかテスト"""
+        simple_annotation = {
+            "project_id": "test_project",
+            "task_id": "test_task",
+            "task_phase": "annotation",
+            "task_phase_stage": 1,
+            "task_status": "working",
+            "input_data_id": "test_image.jpg",
+            "input_data_name": "test_image.jpg",
+            "updated_datetime": "2023-01-01T00:00:00+09:00",
+            "details": [
+                {"label": "landmark", "annotation_id": "point1", "data": {"_type": "SinglePoint", "point": {"x": 100, "y": 200}}},
+                {"label": "center", "annotation_id": "point2", "data": {"_type": "SinglePoint", "point": {"x": 50, "y": 75}}},
+                {"label": "corner", "annotation_id": "point3", "data": {"_type": "SinglePoint", "point": {"x": 0, "y": 0}}},
+            ],
+        }
+
+        # landmarkとcornerのみを取得
+        result = get_annotation_single_point_info_list(simple_annotation, target_label_names=["landmark", "corner"])
+
+        assert len(result) == 2
+        labels = [annotation.label for annotation in result]
+        assert "landmark" in labels
+        assert "corner" in labels
+        assert "center" not in labels
+
+
+@pytest.mark.access_webapi
+class TestCommandLine:
+    def test__list_single_point_annotation(self):
+        main(
+            [
+                "annotation_zip",
+                "list_single_point_annotation",
+                "--annotation",
+                str(data_dir / "image_annotation/"),
+                "--output",
+                str(out_dir / "list_single_point_annotation-out.json"),
+                "--format",
+                "pretty_json",
+            ]
+        )