annofabcli 1.114.3__py3-none-any.whl → 1.114.4__py3-none-any.whl

annofabcli/task/list_all_tasks_added_task_history.py

@@ -21,7 +21,7 @@ from annofabcli.common.cli import (
 )
 from annofabcli.common.dataclasses import WaitOptions
 from annofabcli.common.download import DownloadingFile
-from annofabcli.common.enums import FormatArgument
+from annofabcli.common.enums import OutputFormat
 from annofabcli.common.facade import AnnofabApiFacade, TaskQuery, match_task_with_query
 from annofabcli.task.list_tasks_added_task_history import AddingAdditionalInfoToTask, TasksAddedTaskHistoryOutput
 
@@ -118,14 +118,14 @@ class ListAllTasksAddedTaskHistoryMain:
         filtered_task_list = [e for e in task_list if self.match_task_with_conditions(e, task_query=task_query, task_id_set=task_id_set)]
         return filtered_task_list
 
-    def get_task_list_added_task_history(  # noqa: ANN201
+    def get_task_list_added_task_history(
         self,
         task_json_path: Path | None,
         task_history_json_path: Path | None,
         task_id_list: list[str] | None,
         task_query: TaskQuery | None,
         temp_dir: Path | None,
-    ):
+    ) -> list[dict[str, Any]]:
         """
         タスク履歴情報を加えたタスク一覧を取得する。
         """
@@ -178,7 +178,7 @@ class ListAllTasksAddedTaskHistory(CommandLine):
         )
 
         logger.info(f"タスク一覧の件数: {len(task_list)}")
-        TasksAddedTaskHistoryOutput(task_list).output(output_path=args.output, output_format=FormatArgument(args.format))
+        TasksAddedTaskHistoryOutput(task_list).output(output_path=args.output, output_format=OutputFormat(args.format))
 
 
 def main(args: argparse.Namespace) -> None:
@@ -216,8 +216,8 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     argument_parser.add_output()
 
     argument_parser.add_format(
-        choices=[FormatArgument.CSV, FormatArgument.JSON, FormatArgument.PRETTY_JSON],
-        default=FormatArgument.CSV,
+        choices=[OutputFormat.CSV, OutputFormat.JSON, OutputFormat.PRETTY_JSON],
+        default=OutputFormat.CSV,
     )
 
     parser.set_defaults(subcommand_func=main)

annofabcli/task/list_tasks.py

@@ -1,5 +1,6 @@
 import argparse
 import logging
+from pathlib import Path
 from typing import Any
 
 import annofabapi
@@ -8,14 +9,77 @@ from annofabapi.models import Task
 
 import annofabcli.common.cli
 from annofabcli.common.cli import ArgumentParser, CommandLine, build_annofabapi_resource_and_login
-from annofabcli.common.enums import FormatArgument
+from annofabcli.common.enums import OutputFormat
 from annofabcli.common.facade import AnnofabApiFacade
-from annofabcli.common.utils import get_columns_with_priority
+from annofabcli.common.utils import get_columns_with_priority, print_csv, print_id_list, print_json
 from annofabcli.common.visualize import AddProps
 
 logger = logging.getLogger(__name__)
 
 
+def print_task_list(
+    task_list: list[dict[str, Any]],
+    output_format: OutputFormat,
+    output_file: Path | None,
+) -> None:
+    """
+    タスク一覧を指定されたフォーマットで出力する。
+
+    Args:
+        task_list: タスク一覧
+        output_format: 出力フォーマット
+        output_file: 出力先
+    """
+    task_prior_columns = [
+        "project_id",
+        "task_id",
+        "phase",
+        "phase_stage",
+        "status",
+        "started_datetime",
+        "updated_datetime",
+        "operation_updated_datetime",
+        "account_id",
+        "user_id",
+        "username",
+        "worktime_hour",
+        "number_of_rejections_by_inspection",
+        "number_of_rejections_by_acceptance",
+        "sampling",
+        "input_data_count",
+    ]
+
+    if output_format == OutputFormat.CSV:
+        if len(task_list) > 0:
+            # json_normalizeでメタデータを自動展開
+            df = pandas.json_normalize(task_list)
+
+            # metadata.*列を検出して優先列リストに追加
+            metadata_columns = sorted([col for col in df.columns if col.startswith("metadata.")])
+            prior_columns_with_metadata = task_prior_columns + metadata_columns
+            columns = get_columns_with_priority(df, prior_columns=prior_columns_with_metadata)
+            # work_time_span列を除外（worktime_hourと重複するため）
+            # histories_by_phase列を除外（list型のためCSVでは扱いにくいため）
+            # input_data_id_list列を除外（list型のためCSVでは扱いにくいため。input_data_countで件数は把握できる）
+            columns = [col for col in columns if col not in ["work_time_span", "histories_by_phase", "input_data_id_list"]]
+            print_csv(df[columns], output=output_file)
+        else:
+            df = pandas.DataFrame(columns=task_prior_columns)
+            print_csv(df, output=output_file)
+
+    elif output_format == OutputFormat.PRETTY_JSON:
+        print_json(task_list, is_pretty=True, output=output_file)
+
+    elif output_format == OutputFormat.JSON:
+        print_json(task_list, is_pretty=False, output=output_file)
+
+    elif output_format == OutputFormat.TASK_ID_LIST:
+        task_id_list = [e["task_id"] for e in task_list]
+        print_id_list(task_id_list, output=output_file)
+    else:
+        raise ValueError(f"{output_format}は対応していないフォーマットです。")
+
+
 class ListTasksMain:
     def __init__(self, service: annofabapi.Resource, project_id: str) -> None:
         self.service = service
@@ -53,7 +117,7 @@ class ListTasksMain:
 
         """
 
-        def remove_key(arg_key: str):  # noqa: ANN202
+        def remove_key(arg_key: str) -> None:
             if arg_key in task_query:
                 logger.info(f"タスク検索クエリから、`{arg_key}`　キーを削除しました。")
                 task_query.pop(arg_key)
@@ -96,7 +160,6 @@ class ListTasksMain:
             task_query = {}
 
         if user_id_list is None:
-            logger.debug(f"task_query: {task_query}")
             tasks = self.service.wrapper.get_all_tasks(project_id, query_params=task_query)
             if len(tasks) == 10000:
                 logger.warning("タスク一覧は10,000件で打ち切られている可能性があります。")
@@ -151,27 +214,6 @@ class ListTasks(CommandLine):
         super().__init__(service, facade, args)
         self.visualize = AddProps(self.service, args.project_id)
 
-    PRIOR_COLUMNS = [  # noqa: RUF012
-        "project_id",
-        "task_id",
-        "phase",
-        "phase_stage",
-        "status",
-        "started_datetime",
-        "updated_datetime",
-        "operation_updated_datetime",
-        "account_id",
-        "user_id",
-        "username",
-        "worktime_hour",
-        "number_of_rejections_by_inspection",
-        "number_of_rejections_by_acceptance",
-        "metadata",
-        "sampling",
-        "input_data_count",
-        "input_data_id_list",
-    ]
-
     def main(self) -> None:
         args = self.args
 
@@ -190,17 +232,11 @@ class ListTasks(CommandLine):
             user_id_list=user_id_list,
         )
 
-        logger.debug(f"タスク一覧の件数: {len(task_list)}")
+        logger.info(f"{len(task_list)}件のタスク情報を出力します。")
 
-        if len(task_list) > 0:
-            if self.str_format == FormatArgument.CSV.value:
-                df = pandas.DataFrame(task_list)
-                columns = get_columns_with_priority(df, prior_columns=self.PRIOR_COLUMNS)
-                self.print_csv(df[columns])
-            else:
-                self.print_according_to_format(task_list)
-        else:
-            logger.info("タスク一覧の件数が0件のため、出力しません。")
+        output_file = args.output
+        output_format = OutputFormat(args.format)
+        print_task_list(task_list, output_format, output_file)
 
 
 def main(args: argparse.Namespace) -> None:
@@ -245,8 +281,8 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     )
 
     argument_parser.add_format(
-        choices=[FormatArgument.CSV, FormatArgument.JSON, FormatArgument.PRETTY_JSON, FormatArgument.TASK_ID_LIST],
-        default=FormatArgument.CSV,
+        choices=[OutputFormat.CSV, OutputFormat.JSON, OutputFormat.PRETTY_JSON, OutputFormat.TASK_ID_LIST],
+        default=OutputFormat.CSV,
     )
     argument_parser.add_output()
 

annofabcli/task/list_tasks_added_task_history.py

@@ -14,7 +14,7 @@ from annofabapi.utils import get_task_history_index_skipped_acceptance, get_task
 
 import annofabcli.common.cli
 from annofabcli.common.cli import ArgumentParser, CommandLine, build_annofabapi_resource_and_login
-from annofabcli.common.enums import FormatArgument
+from annofabcli.common.enums import OutputFormat
 from annofabcli.common.facade import AnnofabApiFacade
 from annofabcli.common.utils import isoduration_to_hour, print_csv, print_json
 from annofabcli.common.visualize import AddProps
@@ -384,7 +384,7 @@ class ListTasksAddedTaskHistoryMain:
 
         for index, task in enumerate(task_list):
             if (index + 1) % 100 == 0:
-                logger.debug(f"{index + 1} 件目のタスク履歴情報を取得します。")
+                logger.info(f"{index + 1} 件目のタスク履歴情報を取得します。")
 
             obj.add_additional_info_to_task(task)
             task_id = task["task_id"]
@@ -422,7 +422,6 @@ class TasksAddedTaskHistoryOutput:
             "user_id",
             "username",
             "input_data_count",
-            "metadata",
             "sampling",
             # 作業時間情報
             "worktime_hour",
@@ -454,20 +453,30 @@ class TasksAddedTaskHistoryOutput:
             ]
         )
 
-    def output(self, output_path: Path, output_format: FormatArgument) -> None:
+    def output(self, output_path: Path, output_format: OutputFormat) -> None:
         task_list = self.task_list
         logger.debug(f"タスク {len(task_list)} 件の情報を出力します。")
-        if output_format == FormatArgument.CSV:
-            df_task = pandas.DataFrame(task_list, columns=self._get_output_target_columns())
-            print_csv(
-                df_task[self._get_output_target_columns()],
-                output=output_path,
-            )
-
-        elif output_format == FormatArgument.JSON:
+        if output_format == OutputFormat.CSV:
+            if len(task_list) > 0:
+                # json_normalizeでメタデータを自動展開
+                df = pandas.json_normalize(task_list)
+
+                # metadata.*列を検出して出力対象列リストに追加
+                metadata_columns = sorted([col for col in df.columns if col.startswith("metadata.")])
+                output_columns = self._get_output_target_columns() + metadata_columns
+                # 出力列を output_columns に含まれる列のみに限定（意図しない列の混入を防ぐ）
+                columns = [col for col in output_columns if col in df.columns]
+                print_csv(df[columns], output=output_path)
+            else:
+                df = pandas.DataFrame(columns=self._get_output_target_columns())
+                print_csv(df, output=output_path)
+
+        elif output_format == OutputFormat.JSON:
             print_json(task_list, is_pretty=False, output=output_path)
-        elif output_format == FormatArgument.PRETTY_JSON:
+        elif output_format == OutputFormat.PRETTY_JSON:
             print_json(task_list, is_pretty=True, output=output_path)
+        else:
+            raise ValueError(f"{output_format=}は不正な値です。")
 
 
 class ListTasksAddedTaskHistory(CommandLine):
@@ -481,7 +490,7 @@ class ListTasksAddedTaskHistory(CommandLine):
         task_list = main_obj.main(task_query=task_query, task_id_list=task_id_list)
 
         output_obj = TasksAddedTaskHistoryOutput(task_list)
-        output_obj.output(args.output, output_format=FormatArgument(args.format))
+        output_obj.output(args.output, output_format=OutputFormat(args.format))
 
 
 def main(args: argparse.Namespace) -> None:
@@ -519,8 +528,8 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     argument_parser.add_output()
 
     argument_parser.add_format(
-        choices=[FormatArgument.CSV, FormatArgument.JSON, FormatArgument.PRETTY_JSON],
-        default=FormatArgument.CSV,
+        choices=[OutputFormat.CSV, OutputFormat.JSON, OutputFormat.PRETTY_JSON],
+        default=OutputFormat.CSV,
     )
 
     parser.set_defaults(subcommand_func=main)

annofabcli/task_history/list_all_task_history.py

@@ -10,7 +10,7 @@ from annofabapi.models import TaskHistory
 import annofabcli.common.cli
 from annofabcli.common.cli import ArgumentParser, CommandLine, build_annofabapi_resource_and_login
 from annofabcli.common.download import DownloadingFile
-from annofabcli.common.enums import FormatArgument
+from annofabcli.common.enums import OutputFormat
 from annofabcli.common.facade import AnnofabApiFacade
 from annofabcli.common.visualize import AddProps
 
@@ -92,7 +92,7 @@ class ListTaskHistoryWithJson(CommandLine):
         project_id: str,
         task_history_json: Path | None,
         task_id_list: list[str] | None,
-        arg_format: FormatArgument,
+        arg_format: OutputFormat,
         temp_dir: Path | None,
     ):
         """
@@ -111,7 +111,7 @@ class ListTaskHistoryWithJson(CommandLine):
         main_obj = ListTaskHistoryWithJsonMain(self.service)
         task_history_dict = main_obj.get_task_history_dict(project_id, task_history_json=task_history_json, task_id_list=task_id_list, temp_dir=temp_dir)
         logger.debug(f"{len(task_history_dict)} 件のタスクの履歴情報を出力します。")
-        if arg_format == FormatArgument.CSV:
+        if arg_format == OutputFormat.CSV:
             all_task_history_list = main_obj.to_all_task_history_list_from_dict(task_history_dict)
             self.print_according_to_format(all_task_history_list)
         else:
@@ -127,7 +127,7 @@ class ListTaskHistoryWithJson(CommandLine):
             args.project_id,
             task_history_json=args.task_history_json,
             task_id_list=task_id_list,
-            arg_format=FormatArgument(args.format),
+            arg_format=OutputFormat(args.format),
             temp_dir=temp_dir,
         )
 
@@ -164,8 +164,8 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     )
 
     argument_parser.add_format(
-        choices=[FormatArgument.CSV, FormatArgument.JSON, FormatArgument.PRETTY_JSON],
-        default=FormatArgument.CSV,
+        choices=[OutputFormat.CSV, OutputFormat.JSON, OutputFormat.PRETTY_JSON],
+        default=OutputFormat.CSV,
     )
     argument_parser.add_output()
 

annofabcli/task_history/list_task_history.py

@@ -6,7 +6,7 @@ from annofabapi.models import TaskHistory
 
 import annofabcli.common.cli
 from annofabcli.common.cli import ArgumentParser, CommandLine, build_annofabapi_resource_and_login
-from annofabcli.common.enums import FormatArgument
+from annofabcli.common.enums import OutputFormat
 from annofabcli.common.facade import AnnofabApiFacade
 from annofabcli.common.visualize import AddProps
 
@@ -78,7 +78,7 @@ class ListTaskHistory(CommandLine):
         self,
         project_id: str,
         task_id_list: list[str] | None,
-        arg_format: FormatArgument,
+        arg_format: OutputFormat,
     ) -> None:
         """
         タスク一覧を出力する
@@ -94,7 +94,7 @@ class ListTaskHistory(CommandLine):
 
         main_obj = ListTaskHistoryMain(self.service)
         task_history_dict = main_obj.get_task_history_dict_for_output(project_id, task_id_list=task_id_list)
-        if arg_format == FormatArgument.CSV:
+        if arg_format == OutputFormat.CSV:
             all_task_history_list = main_obj.to_all_task_history_list_from_dict(task_history_dict)
             if len(all_task_history_list) > 0:
                 self.print_according_to_format(all_task_history_list)
@@ -111,7 +111,7 @@ class ListTaskHistory(CommandLine):
         self.print_task_history_list(
             args.project_id,
             task_id_list=task_id_list,
-            arg_format=FormatArgument(args.format),
+            arg_format=OutputFormat(args.format),
         )
 
 
@@ -134,8 +134,8 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     )
 
     argument_parser.add_format(
-        choices=[FormatArgument.CSV, FormatArgument.JSON, FormatArgument.PRETTY_JSON],
-        default=FormatArgument.CSV,
+        choices=[OutputFormat.CSV, OutputFormat.JSON, OutputFormat.PRETTY_JSON],
+        default=OutputFormat.CSV,
     )
     argument_parser.add_output()
 

annofabcli/task_history_event/list_all_task_history_event.py

@@ -19,7 +19,7 @@ from annofabcli.common.cli import (
     get_list_from_args,
 )
 from annofabcli.common.download import DownloadingFile
-from annofabcli.common.enums import FormatArgument
+from annofabcli.common.enums import OutputFormat
 from annofabcli.common.facade import AnnofabApiFacade
 from annofabcli.common.visualize import AddProps
 
@@ -86,7 +86,7 @@ class ListTaskHistoryEventWithJson(CommandLine):
         project_id: str,
         task_history_event_json: Path | None,
         task_id_list: list[str] | None,
-        arg_format: FormatArgument,
+        arg_format: OutputFormat,
         temp_dir: Path | None,
     ) -> None:
         super().validate_project(project_id, project_member_roles=None)
@@ -96,7 +96,7 @@ class ListTaskHistoryEventWithJson(CommandLine):
 
         logger.debug(f"{len(task_history_event_list)} 件のタスク履歴イベントの情報を出力します。")
 
-        if arg_format == FormatArgument.CSV:
+        if arg_format == OutputFormat.CSV:
             columns = [
                 "project_id",
                 "task_id",
@@ -133,7 +133,7 @@ class ListTaskHistoryEventWithJson(CommandLine):
             args.project_id,
             task_history_event_json=args.task_history_event_json,
             task_id_list=task_id_list,
-            arg_format=FormatArgument(args.format),
+            arg_format=OutputFormat(args.format),
             temp_dir=temp_dir,
         )
 
@@ -178,8 +178,8 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     )
 
     argument_parser.add_format(
-        choices=[FormatArgument.CSV, FormatArgument.JSON, FormatArgument.PRETTY_JSON],
-        default=FormatArgument.CSV,
+        choices=[OutputFormat.CSV, OutputFormat.JSON, OutputFormat.PRETTY_JSON],
+        default=OutputFormat.CSV,
     )
     argument_parser.add_output()
 

annofabcli/task_history_event/list_worktime.py

@@ -23,7 +23,7 @@ from annofabcli.common.cli import (
     get_list_from_args,
 )
 from annofabcli.common.download import DownloadingFile
-from annofabcli.common.enums import FormatArgument
+from annofabcli.common.enums import OutputFormat
 from annofabcli.common.facade import AnnofabApiFacade
 from annofabcli.common.visualize import AddProps
 
@@ -255,7 +255,7 @@ class ListWorktimeFromTaskHistoryEvent(CommandLine):
         task_history_event_json: Path | None,
         task_id_list: list[str] | None,
         user_id_list: list[str] | None,
-        arg_format: FormatArgument,
+        arg_format: OutputFormat,
     ) -> None:
         super().validate_project(project_id, project_member_roles=None)
 
@@ -270,7 +270,7 @@ class ListWorktimeFromTaskHistoryEvent(CommandLine):
         logger.debug(f"作業時間一覧の件数: {len(worktime_list)}")
         dict_worktime_list = [e.to_dict() for e in worktime_list]
 
-        if arg_format == FormatArgument.CSV:
+        if arg_format == OutputFormat.CSV:
             columns = [
                 "project_id",
                 "task_id",
@@ -312,7 +312,7 @@ class ListWorktimeFromTaskHistoryEvent(CommandLine):
             task_history_event_json=args.task_history_event_json,
             task_id_list=task_id_list,
             user_id_list=user_id_list,
-            arg_format=FormatArgument(args.format),
+            arg_format=OutputFormat(args.format),
         )
 
     @staticmethod
@@ -359,8 +359,8 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     )
 
     argument_parser.add_format(
-        choices=[FormatArgument.CSV, FormatArgument.JSON, FormatArgument.PRETTY_JSON],
-        default=FormatArgument.CSV,
+        choices=[OutputFormat.CSV, OutputFormat.JSON, OutputFormat.PRETTY_JSON],
+        default=OutputFormat.CSV,
     )
     argument_parser.add_output()
 

{annofabcli-1.114.3.dist-info → annofabcli-1.114.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annofabcli
-Version: 1.114.3
+Version: 1.114.4
 Summary: Utility Command Line Interface for AnnoFab
 Author: Kurusugawa Computer Inc.
 License: MIT
@@ -24,7 +24,7 @@ Requires-Dist: dictdiffer
 Requires-Dist: isodate
 Requires-Dist: more-itertools
 Requires-Dist: numpy
-Requires-Dist: pandas<3,>=2
+Requires-Dist: pandas>=2
 Requires-Dist: pillow
 Requires-Dist: pydantic>=2.12; python_version >= '3.14'
 Requires-Dist: pyquery