annofabcli 1.95.0__py3-none-any.whl → 1.96.0__py3-none-any.whl

annofabcli/__version__.py

@@ -1 +1 @@
-__version__ = "1.95.0"  # `poetry-dynamic-versioning`を使ってGitHubのバージョンタグを取得している。変更不要
+__version__ = "1.96.0"  # `poetry-dynamic-versioning`を使ってGitHubのバージョンタグを取得している。変更不要

annofabcli/annotation_specs/export_annotation_specs.py

@@ -20,15 +20,20 @@ from annofabcli.common.utils import print_according_to_format
 logger = logging.getLogger(__name__)
 
 
-class ListAttributeRestriction(CommandLine):
+class ExportAnnotationSpecs(CommandLine):
     COMMON_MESSAGE = "annofabcli annotation_specs export: error:"
 
     def get_history_id_from_before_index(self, project_id: str, before: int) -> Optional[str]:
         histories, _ = self.service.api.get_annotation_specs_histories(project_id)
-        if before + 1 > len(histories):
-            logger.warning(f"アノテーション仕様の履歴は{len(histories)}個のため、最新より{before}個前のアノテーション仕様は見つかりませんでした。")
+        sorted_histories = sorted(histories, key=lambda x: x["updated_datetime"], reverse=True)
+
+        if before + 1 > len(sorted_histories):
+            logger.warning(
+                f"アノテーション仕様の履歴は{len(sorted_histories)}個のため、最新より{before}個前のアノテーション仕様は見つかりませんでした。"
+            )
             return None
-        history = histories[-(before + 1)]
+
+        history = sorted_histories[before]
         return history["history_id"]
 
     def get_exported_annotation_specs(self, project_id: str, history_id: Optional[str]) -> dict[str, Any]:
@@ -107,7 +112,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
 def main(args: argparse.Namespace) -> None:
     service = build_annofabapi_resource_and_login(args)
     facade = AnnofabApiFacade(service)
-    ListAttributeRestriction(service, facade, args).main()
+    ExportAnnotationSpecs(service, facade, args).main()
 
 
 def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:

annofabcli/statistics/list_annotation_attribute.py

@@ -0,0 +1,310 @@
+# pylint: disable=too-many-lines
+from __future__ import annotations
+
+import argparse
+import logging
+import sys
+import tempfile
+import zipfile
+from collections.abc import Collection, Iterator
+from pathlib import Path
+from typing import Any, Literal, Optional, Union
+
+import pandas
+import pydantic
+from annofabapi.models import ProjectMemberRole
+from annofabapi.parser import (
+    SimpleAnnotationParser,
+    lazy_parse_simple_annotation_dir,
+    lazy_parse_simple_annotation_zip,
+)
+
+import annofabcli
+import annofabcli.common.cli
+from annofabcli.common.cli import (
+    COMMAND_LINE_ERROR_STATUS_CODE,
+    ArgumentParser,
+    CommandLine,
+    build_annofabapi_resource_and_login,
+)
+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.type_util import assert_noreturn
+from annofabcli.common.utils import print_csv, print_json
+
+logger = logging.getLogger(__name__)
+
+
+def lazy_parse_simple_annotation_by_input_data(annotation_path: Path) -> Iterator[SimpleAnnotationParser]:
+    if not annotation_path.exists():
+        raise RuntimeError(f"'{annotation_path}' は存在しません。")
+
+    if annotation_path.is_dir():
+        return lazy_parse_simple_annotation_dir(annotation_path)
+    elif zipfile.is_zipfile(str(annotation_path)):
+        return lazy_parse_simple_annotation_zip(annotation_path)
+    else:
+        raise RuntimeError(f"'{annotation_path}'は、zipファイルまたはディレクトリではありません。")
+
+
+class AnnotationAttribute(pydantic.BaseModel):
+    """
+    入力データまたはタスク単位の区間アノテーションの長さ情報。
+    """
+
+    task_id: str
+    task_status: str
+    task_phase: str
+    task_phase_stage: int
+
+    input_data_id: str
+    input_data_name: str
+    annotation_id: str
+    label: str
+    attributes: dict[str, Union[str, int, bool]]
+
+
+def get_annotation_attribute_list_from_annotation_json(
+    simple_annotation: dict[str, Any], *, target_labels: Collection[str] | None = None
+) -> list[AnnotationAttribute]:
+    """
+    1個のアノテーションJSONに対して、アノテーションの属性情報を取得します。
+
+    Args:
+        simple_annotation: アノテーションJSONファイルの内容
+        target_labels: 絞り込むラベルのcollection
+    """
+    details = simple_annotation["details"]
+
+    result = []
+    for detail in details:
+        if target_labels is not None:  # noqa: SIM102
+            if detail["label"] not in target_labels:
+                continue
+
+        result.append(
+            AnnotationAttribute(
+                task_id=simple_annotation["task_id"],
+                task_status=simple_annotation["task_status"],
+                task_phase=simple_annotation["task_phase"],
+                task_phase_stage=simple_annotation["task_phase_stage"],
+                input_data_id=simple_annotation["input_data_id"],
+                input_data_name=simple_annotation["input_data_name"],
+                label=detail["label"],
+                annotation_id=detail["annotation_id"],
+                attributes=detail["attributes"],
+            )
+        )
+    return result
+
+
+def get_annotation_attribute_list_from_annotation_zipdir_path(
+    annotation_zipdir_path: Path,
+    *,
+    target_task_ids: Optional[Collection[str]] = None,
+    task_query: Optional[TaskQuery] = None,
+    target_labels: Collection[str] | None = None,
+) -> list[AnnotationAttribute]:
+    """
+    アノテーションzipまたはそれを展開したディレクトリから、アノテーションの属性のlistを取得します。
+
+    Args:
+    """
+    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_zipdir_path)
+
+    result = []
+    logger.debug("アノテーションzipまたはディレクトリを読み込み中")
+    for index, parser in enumerate(iter_parser):
+        if (index + 1) % 1000 == 0:
+            logger.debug(f"{index + 1}  件目のJSONを読み込み中")
+
+        if target_task_ids is not None and parser.task_id not in target_task_ids:
+            continue
+
+        simple_annotation_dict = parser.load_json()
+        if task_query is not None:  # noqa: SIM102
+            if not match_annotation_with_task_query(simple_annotation_dict, task_query):
+                continue
+
+        sub_result = get_annotation_attribute_list_from_annotation_json(simple_annotation_dict, target_labels=target_labels)
+        result.extend(sub_result)
+
+    return result
+
+
+def print_annotation_attribute_list_as_csv(annotation_attribute_list: list, output_file: Optional[Path]) -> None:
+    df = pandas.json_normalize(annotation_attribute_list)
+
+    # columns = [
+    #     "task_id",
+    #     "task_status"
+    #     "task_phase",
+    #     "task_phase_stage",
+    #     "input_data_id",
+    #     "input_data_name",
+    #     "annotation_id",
+    #     "label",
+
+    # ]
+
+    print_csv(df, output_file)
+
+
+def print_annotation_attribute_list(
+    annotation_attribute_list: list[AnnotationAttribute],
+    output_file: Path,
+    output_format: Literal[FormatArgument.CSV, FormatArgument.JSON, FormatArgument.PRETTY_JSON],
+) -> None:
+    tmp_annotation_attribute_list = [e.model_dump() for e in annotation_attribute_list]
+    if output_format == FormatArgument.CSV:
+        print_annotation_attribute_list_as_csv(tmp_annotation_attribute_list, output_file)
+    elif output_format == FormatArgument.JSON:
+        print_json(tmp_annotation_attribute_list, output=output_file, is_pretty=False)
+    elif output_format == FormatArgument.PRETTY_JSON:
+        print_json(tmp_annotation_attribute_list, output=output_file, is_pretty=True)
+    else:
+        raise assert_noreturn(output_format)
+
+
+class ListAnnotationAttribute(CommandLine):
+    COMMON_MESSAGE = "annofabcli statistics list_annotation_attribute: 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])
+
+        annotation_path = Path(args.annotation) if args.annotation is not None else None
+
+        task_id_list = annofabcli.common.cli.get_list_from_args(args.task_id) if args.task_id is not None else None
+        label_name_list = annofabcli.common.cli.get_list_from_args(args.label_name) if args.label_name 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
+
+        output_file: Path = args.output
+        output_format = FormatArgument(args.format)
+
+        downloading_obj = DownloadingFile(self.service)
+
+        def download_and_print_annotation_attribute_list(
+            project_id: str, temp_dir: Path, *, is_latest: bool, annotation_path: Optional[Path]
+        ) -> None:
+            if annotation_path is None:
+                annotation_path = temp_dir / f"{project_id}__annotation.zip"
+                downloading_obj.download_annotation_zip(
+                    project_id,
+                    dest_path=annotation_path,
+                    is_latest=is_latest,
+                )
+
+            annotation_attribute_list = get_annotation_attribute_list_from_annotation_zipdir_path(
+                annotation_zipdir_path=annotation_path, target_task_ids=task_id_list, task_query=task_query, target_labels=label_name_list
+            )
+            print_annotation_attribute_list(annotation_attribute_list, output_file, output_format)  # type: ignore[arg-type]
+
+        if project_id is not None:
+            if args.temp_dir is not None:
+                download_and_print_annotation_attribute_list(
+                    project_id=project_id, temp_dir=args.temp_dir, is_latest=args.latest, annotation_path=annotation_path
+                )
+            else:
+                # `NamedTemporaryFile`を使わない理由: Windowsで`PermissionError`が発生するため
+                # https://qiita.com/yuji38kwmt/items/c6f50e1fc03dafdcdda0 参考
+                with tempfile.TemporaryDirectory() as str_temp_dir:
+                    download_and_print_annotation_attribute_list(
+                        project_id=project_id, temp_dir=Path(str_temp_dir), is_latest=args.latest, annotation_path=annotation_path
+                    )
+        else:
+            assert annotation_path is not None
+            annotation_attribute_list = get_annotation_attribute_list_from_annotation_zipdir_path(
+                annotation_zipdir_path=annotation_path, target_task_ids=task_id_list, task_query=task_query, target_labels=label_name_list
+            )
+            print_annotation_attribute_list(annotation_attribute_list, output_file, output_format)  # type: ignore[arg-type]
+
+
+def parse_args(parser: argparse.ArgumentParser) -> None:
+    argument_parser = ArgumentParser(parser)
+
+    annotation_group = parser.add_mutually_exclusive_group(required=True)
+    annotation_group.add_argument(
+        "--annotation",
+        type=str,
+        help="アノテーションzip、またはzipを展開したディレクトリを指定します。指定しない場合はAnnofabからダウンロードします。",
+    )
+
+    annotation_group.add_argument("-p", "--project_id", type=str, help="対象プロジェクトの project_id")
+
+    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="+",
+        required=False,
+        help="出力対象のアノテーションのラベル名(英語)を指定します。指定しない場合はラベル名で絞り込みません。"
+        " ``file://`` を先頭に付けると、ラベル名の一覧が記載されたファイルを指定できます。",
+    )
+
+    parser.add_argument(
+        "--latest",
+        action="store_true",
+        help="``--annotation`` を指定しないとき、最新のアノテーションzipを参照します。このオプションを指定すると、アノテーションzipを更新するのに数分待ちます。",  # noqa: E501
+    )
+
+    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)
+    ListAnnotationAttribute(service, facade, args).main()
+
+
+def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:
+    subcommand_name = "list_annotation_attribute"
+    subcommand_help = "アノテーションZIPを読み込み、アノテーションの属性値の一覧を出力します。"
+    epilog = "オーナロールまたはアノテーションユーザロールを持つユーザで実行してください。"
+    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description=subcommand_help, epilog=epilog)
+    parse_args(parser)
+    return parser

annofabcli/statistics/subcommand_statistics.py

@@ -4,6 +4,7 @@ from typing import Optional
 import annofabcli
 import annofabcli.common.cli
 import annofabcli.stat_visualization.merge_visualization_dir
+import annofabcli.statistics.list_annotation_attribute
 import annofabcli.statistics.list_annotation_count
 import annofabcli.statistics.list_annotation_duration
 import annofabcli.statistics.list_video_duration
@@ -21,6 +22,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     subparsers = parser.add_subparsers(dest="subcommand_name")
 
     # サブコマンドの定義
+    annofabcli.statistics.list_annotation_attribute.add_parser(subparsers)
     annofabcli.statistics.list_annotation_count.add_parser(subparsers)
     annofabcli.statistics.list_annotation_duration.add_parser(subparsers)
     annofabcli.statistics.list_video_duration.add_parser(subparsers)

{annofabcli-1.95.0.dist-info → annofabcli-1.96.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: annofabcli
-Version: 1.95.0
+Version: 1.96.0
 Summary: Utility Command Line Interface for AnnoFab
 Home-page: https://github.com/kurusugawa-computer/annofab-cli
 License: MIT

{annofabcli-1.95.0.dist-info → annofabcli-1.96.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 annofabcli/__init__.py,sha256=NMA7kFxmLlCiILQPHJa9mEuqXxtLALw_dwyXYsvz4VM,71
 annofabcli/__main__.py,sha256=JzfycqVG9ENhWOCxTouZwpHwWTSrI-grLsaMudxjyBM,5283
-annofabcli/__version__.py,sha256=qh48jc0AerpxMn6bU6jgOxQqy6_nPvZpVTJ5jCGYCDI,132
+annofabcli/__version__.py,sha256=vUosqVW-MeQrE_vPK0xlTVGwdsd_pcLlczOaCRqUXgg,132
 annofabcli/annotation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annofabcli/annotation/annotation_query.py,sha256=ke3W3RT1-WfFzwt-TXcQwGmghG34vcKJkM_jxgbNKjU,15922
 annofabcli/annotation/change_annotation_attributes.py,sha256=zHXyENZfbMGL_15xiK7Cy4cQ2sV0GjSVmKuPm3sOX7Y,17173
@@ -15,7 +15,7 @@ annofabcli/annotation/list_annotation_count.py,sha256=T9fbaoxWeDJIVgW_YgHRldbwrV
 annofabcli/annotation/restore_annotation.py,sha256=naUEbt48ION9JSijCBR2aQdaoCrRu005tYq0vgUtyp0,14683
 annofabcli/annotation/subcommand_annotation.py,sha256=Xu4SOHLpo_kPZbvE8hQHr9NRduPTESqu7pYC4LGDlXg,1872
 annofabcli/annotation_specs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-annofabcli/annotation_specs/export_annotation_specs.py,sha256=CGmcyP8DbfFUcWnJgJSgxYS9FkV3mW15zZPDab7LNBE,4685
+annofabcli/annotation_specs/export_annotation_specs.py,sha256=eZF5fj2P5U22_5UKgbpsUhZEUvVPMPerMpN4miIcnSA,4821
 annofabcli/annotation_specs/get_annotation_specs_with_attribute_id_replaced.py,sha256=L0H0M31Amnm3ZEg9JdQe2A1vprsCLPTpj0LUFnP6GDY,8330
 annofabcli/annotation_specs/get_annotation_specs_with_choice_id_replaced.py,sha256=mISJAgRTBMvISPk5__0w0MmhTkyQCcGPDin8K97x5Eg,6943
 annofabcli/annotation_specs/get_annotation_specs_with_label_id_replaced.py,sha256=5tlvSdUXAUn8uQ1BXNWxkR2MIKnV6AJoxveiwD21IAo,7114
@@ -130,12 +130,13 @@ annofabcli/stat_visualization/write_performance_rating_csv.py,sha256=TDn7-poyFt2
 annofabcli/statistics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annofabcli/statistics/histogram.py,sha256=CvzDxT2cKLSnBGSqkZE6p92PayGxYYja1YyB24M4ALU,3245
 annofabcli/statistics/linegraph.py,sha256=0kr7jVBNMiM2ECYhv3Ry5RitElKerSl9ZKxbKzfiplI,12494
+annofabcli/statistics/list_annotation_attribute.py,sha256=WM0-Zw0Pm35olqrSXvbHnrb4mbC02qcjshLCrbPE3zg,12432
 annofabcli/statistics/list_annotation_count.py,sha256=xsqXxRO21MW7Wbs96PEa8gHb3i7bxjQvoMHLB2eT-0g,50360
 annofabcli/statistics/list_annotation_duration.py,sha256=9PCg1IA_g4HoHHSfsMVb2zBMLfLJ3u9Id8Qa9L8Qhko,31923
 annofabcli/statistics/list_video_duration.py,sha256=uNeMteRBX2JG_AWmcgMJj0Jzbq_qF7bvAwr25GmeIiw,9124
 annofabcli/statistics/list_worktime.py,sha256=C7Yu3IOW2EvhkJJv6gY3hNdS9_TOLmT_9LZsB7vLJ1o,6493
 annofabcli/statistics/scatter.py,sha256=IUCwXix9GbZb6V82wjjb5q2eamrT5HQsU_bzDTjAFnM,11011
-annofabcli/statistics/subcommand_statistics.py,sha256=Exf7fpOnz8jezBEDKdTwVN7_upN0jzwDt8g0kS9H0Hw,2129
+annofabcli/statistics/subcommand_statistics.py,sha256=JPixzhJGClQYVH6Tgby3KTD85df-aEJKvLAjfJCv-1E,2259
 annofabcli/statistics/summarize_task_count.py,sha256=8OH6BBRYRjHJkWRTjU0A0OfXa7f3NIRHrxPNFlRt_hM,9707
 annofabcli/statistics/summarize_task_count_by_task_id_group.py,sha256=TSSmcFv615NLcq6uqXmg3ilYqSHl3A5qp90msVQM1gE,8646
 annofabcli/statistics/summarize_task_count_by_user.py,sha256=TRoJXpt2HOVb8QO2YtRejkOAxyK80_NsPt3Vk9es9C8,6948
@@ -199,8 +200,8 @@ annofabcli/task_history_event/download_task_history_event_json.py,sha256=hQLVbQ0
 annofabcli/task_history_event/list_all_task_history_event.py,sha256=JQEgwOIXbbTIfeX23AVaoySHViOR9UGm9uoXuhVEBqo,6446
 annofabcli/task_history_event/list_worktime.py,sha256=9jsRYa2C9bva8E1Aqxv9CCKDuCP0MvbiaIyQFTDpjqY,13150
 annofabcli/task_history_event/subcommand_task_history_event.py,sha256=mJVJoT4RXk4HWnY7-Nrsl4If-gtaIIEXd2z7eFZwM2I,1260
-annofabcli-1.95.0.dist-info/LICENSE,sha256=pcqWYfxFtxBzhvKp3x9MXNM4xciGb2eFewaRhXUNHlo,1081
-annofabcli-1.95.0.dist-info/METADATA,sha256=iAatfNNAeWskgaipQQ13ZHVSsEVHvmDTes41DtynbCQ,5626
-annofabcli-1.95.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-annofabcli-1.95.0.dist-info/entry_points.txt,sha256=A8vlN9fiMhbYRcdBfSpl7piYzAwvkMhRXIPQUAvQFUo,55
-annofabcli-1.95.0.dist-info/RECORD,,
+annofabcli-1.96.0.dist-info/LICENSE,sha256=pcqWYfxFtxBzhvKp3x9MXNM4xciGb2eFewaRhXUNHlo,1081
+annofabcli-1.96.0.dist-info/METADATA,sha256=kHn5yPXYeuO3FK-MKUhhRcZ5vAhUakxbnLEOlqM6KsY,5626
+annofabcli-1.96.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+annofabcli-1.96.0.dist-info/entry_points.txt,sha256=A8vlN9fiMhbYRcdBfSpl7piYzAwvkMhRXIPQUAvQFUo,55
+annofabcli-1.96.0.dist-info/RECORD,,