annofabcli 1.100.0__py3-none-any.whl → 100.2__py3-none-any.whl

annofabcli/annotation_specs/list_annotation_specs_label_attribute.py

@@ -0,0 +1,220 @@
+from __future__ import annotations
+
+import argparse
+import json
+import logging
+import sys
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any, Optional
+
+import pandas
+from annofabapi.models import Lang
+from annofabapi.util.annotation_specs import get_message_with_lang
+from dataclasses_json import DataClassJsonMixin
+
+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.enums import FormatArgument
+from annofabcli.common.facade import AnnofabApiFacade
+from annofabcli.common.utils import print_according_to_format, print_csv
+
+logger = logging.getLogger(__name__)
+
+
+@dataclass
+class LabelAndAttribute(DataClassJsonMixin):
+    label_id: str
+    label_name_en: Optional[str]
+    label_name_ja: Optional[str]
+    label_name_vi: Optional[str]
+    annotation_type: str
+
+    attribute_id: str
+    """属性ID
+
+    Notes:
+        APIレスポンスの ``additional_data_definition_id`` に相当します。
+        ``additional_data_definition_id`` という名前がアノテーションJSONの `attributes` と対応していることが分かりにくかったので、`attribute_id`という名前に変えました。
+    """  # noqa: E501
+    attribute_name_en: Optional[str]
+    attribute_name_ja: Optional[str]
+    attribute_name_vi: Optional[str]
+    attribute_type: str
+
+
+def create_label_attribute_list(labels_v3: list[dict[str, Any]], additionals_v3: list[dict[str, Any]]) -> list[LabelAndAttribute]:
+    """
+    APIから取得したラベル情報（v3版）から、`LabelAndAttribute`のlistを生成します。
+
+    Args:
+        labels_v3: APIから取得したラベル情報（v3版）
+    """
+
+    def to_dataclass_list(label: dict[str, Any]) -> list[LabelAndAttribute]:
+        result = []
+        for attribute_id in label["additional_data_definitions"]:
+            attribute = dict_attributes[attribute_id]
+
+            result.append(
+                LabelAndAttribute(
+                    label_id=label["label_id"],
+                    label_name_en=get_message_with_lang(label["label_name"], lang=Lang.EN_US),
+                    label_name_ja=get_message_with_lang(label["label_name"], lang=Lang.JA_JP),
+                    label_name_vi=get_message_with_lang(label["label_name"], lang=Lang.VI_VN),
+                    annotation_type=label["annotation_type"],
+                    attribute_id=attribute_id,
+                    attribute_name_en=get_message_with_lang(attribute["name"], lang=Lang.EN_US),
+                    attribute_name_ja=get_message_with_lang(attribute["name"], lang=Lang.JA_JP),
+                    attribute_name_vi=get_message_with_lang(attribute["name"], lang=Lang.VI_VN),
+                    attribute_type=attribute["type"],
+                )
+            )
+        return result
+
+    dict_attributes = {}
+    for elm in additionals_v3:
+        dict_attributes[elm["additional_data_definition_id"]] = elm
+
+    result = []
+    for label in labels_v3:
+        result.extend(to_dataclass_list(label))
+    return result
+
+
+class PrintAnnotationSpecsLabelAndAttribute(CommandLine):
+    COMMON_MESSAGE = "annofabcli annotation_specs list_label: error:"
+
+    def print_annotation_specs_label(self, annotation_specs_v3: dict[str, Any], output_format: FormatArgument, output: Optional[str] = None) -> None:
+        # アノテーション仕様のv2とv3はほとんど同じなので、`convert_annotation_specs_labels_v2_to_v1`にはV3のアノテーション仕様を渡す
+        label_attribute_list = create_label_attribute_list(annotation_specs_v3["labels"], annotation_specs_v3["additionals"])
+
+        if output_format == FormatArgument.CSV:
+            columns = [
+                "label_id",
+                "label_name_en",
+                "label_name_ja",
+                "label_name_vi",
+                "annotation_type",
+                "attribute_id",
+                "attribute_name_en",
+                "attribute_name_ja",
+                "attribute_name_vi",
+                "attribute_type",
+            ]
+
+            df = pandas.DataFrame(label_attribute_list, columns=columns)
+            print_csv(df, output)
+
+        elif output_format in [FormatArgument.JSON, FormatArgument.PRETTY_JSON]:
+            print_according_to_format([e.to_dict() for e in label_attribute_list], format=output_format, output=output)
+
+    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}個前のアノテーション仕様は見つかりませんでした。")
+            return None
+        history = histories[-(before + 1)]
+        logger.info(
+            f"{history['updated_datetime']}のアノテーション仕様を出力します。history_id={history['history_id']}, comment={history['comment']}"
+        )
+        return history["history_id"]
+
+    def main(self) -> None:
+        args = self.args
+
+        if args.project_id is not None:
+            if args.before is not None:
+                history_id = self.get_history_id_from_before_index(args.project_id, args.before)
+                if history_id is None:
+                    print(  # noqa: T201
+                        f"{self.COMMON_MESSAGE} argument --before: 最新より{args.before}個前のアノテーション仕様は見つかりませんでした。",
+                        file=sys.stderr,
+                    )
+                    sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
+            else:
+                # args.beforeがNoneならば、必ずargs.history_idはNoneでない
+                history_id = args.history_id
+
+            annotation_specs, _ = self.service.api.get_annotation_specs(args.project_id, query_params={"history_id": history_id, "v": "3"})
+
+        elif args.annotation_specs_json is not None:
+            with args.annotation_specs_json.open() as f:
+                annotation_specs = json.load(f)
+
+        else:
+            raise RuntimeError("'--project_id'か'--annotation_specs_json'のどちらかを指定する必要があります。")
+
+        self.print_annotation_specs_label(annotation_specs, output_format=FormatArgument(args.format), output=args.output)
+
+
+def parse_args(parser: argparse.ArgumentParser) -> None:
+    argument_parser = ArgumentParser(parser)
+
+    required_group = parser.add_mutually_exclusive_group(required=True)
+    required_group.add_argument(
+        "-p", "--project_id", help="対象のプロジェクトのproject_idを指定します。APIで取得したアノテーション仕様情報を元に出力します。"
+    )
+    required_group.add_argument(
+        "--annotation_specs_json",
+        type=Path,
+        help="指定したアノテーション仕様のJSONファイルを指定します。"
+        "JSONファイルに記載された情報を元に出力します。ただしアノテーション仕様の ``format_version`` は ``3`` である必要があります。",
+    )
+
+    # 過去のアノテーション仕様を参照するためのオプション
+    old_annotation_specs_group = parser.add_mutually_exclusive_group()
+    old_annotation_specs_group.add_argument(
+        "--history_id",
+        type=str,
+        help=(
+            "出力したいアノテーション仕様のhistory_idを指定してください。 "
+            "history_idは ``annotation_specs list_history`` コマンドで確認できます。 "
+            "指定しない場合は、最新のアノテーション仕様が出力されます。 "
+        ),
+    )
+
+    old_annotation_specs_group.add_argument(
+        "--before",
+        type=int,
+        help=(
+            "出力したい過去のアノテーション仕様が、最新よりいくつ前のアノテーション仕様であるかを指定してください。  "
+            "たとえば ``1`` を指定した場合、最新より1個前のアノテーション仕様を出力します。 "
+            "指定しない場合は、最新のアノテーション仕様が出力されます。 "
+        ),
+    )
+
+    parser.add_argument(
+        "-f",
+        "--format",
+        type=str,
+        choices=[FormatArgument.CSV.value, FormatArgument.JSON.value, FormatArgument.PRETTY_JSON.value],
+        default=FormatArgument.CSV.value,
+        help="出力フォーマット ",
+    )
+
+    argument_parser.add_output()
+
+    parser.set_defaults(subcommand_func=main)
+
+
+def main(args: argparse.Namespace) -> None:
+    service = build_annofabapi_resource_and_login(args)
+    facade = AnnofabApiFacade(service)
+    PrintAnnotationSpecsLabelAndAttribute(service, facade, args).main()
+
+
+def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:
+    subcommand_name = "list_label_attribute"
+
+    subcommand_help = "アノテーション仕様のラベルとラベルに含まれている属性の一覧を出力します。"
+
+    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help)
+    parse_args(parser)
+    return parser

annofabcli/annotation_specs/subcommand_annotation_specs.py

@@ -11,6 +11,7 @@ import annofabcli.annotation_specs.list_annotation_specs_attribute
 import annofabcli.annotation_specs.list_annotation_specs_choice
 import annofabcli.annotation_specs.list_annotation_specs_history
 import annofabcli.annotation_specs.list_annotation_specs_label
+import annofabcli.annotation_specs.list_annotation_specs_label_attribute
 import annofabcli.annotation_specs.list_attribute_restriction
 import annofabcli.annotation_specs.list_label_color
 import annofabcli.annotation_specs.put_label_color
@@ -31,6 +32,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     annofabcli.annotation_specs.list_annotation_specs_choice.add_parser(subparsers)
     annofabcli.annotation_specs.list_annotation_specs_history.add_parser(subparsers)
     annofabcli.annotation_specs.list_annotation_specs_label.add_parser(subparsers)
+    annofabcli.annotation_specs.list_annotation_specs_label_attribute.add_parser(subparsers)
     annofabcli.annotation_specs.list_label_color.add_parser(subparsers)
     annofabcli.annotation_specs.put_label_color.add_parser(subparsers)
 

annofabcli/common/annofab/annotation_specs.py

@@ -0,0 +1,25 @@
+from typing import Any
+
+
+def keybind_to_text(keybind: list[dict[str, Any]]) -> str:
+    """
+    以下の構造を持つkeybindを、人が読める形式に変換します。
+    {"alt": False, "code": "Numpad1", "ctrl": False, "shift": False}
+    """
+
+    def to_str(one_keybind: dict[str, Any]) -> str:
+        keys = []
+        if one_keybind.get("ctrl", False):
+            keys.append("Ctrl")
+        if one_keybind.get("alt", False):
+            keys.append("Alt")
+        if one_keybind.get("shift", False):
+            keys.append("Shift")
+        code = one_keybind.get("code", "")
+        assert code is not None
+
+        keys.append(f"{code}")
+        return "+".join(keys)
+
+    tmp_list = [to_str(elm) for elm in keybind]
+    return ",".join(tmp_list)

annofabcli/common/download.py

@@ -50,7 +50,7 @@ class DownloadingFile:
 
         max_wait_minutes = self.get_max_wait_minutes(wait_options)
         filetype = DOWNLOADING_FILETYPE_DICT[job_type]
-        logger.info(f"{filetype}の更新処理が完了するまで、最大{max_wait_minutes}分間待ちます。job_id={job_id}")
+        logger.info(f"{filetype}の更新処理が完了するまで、最大{max_wait_minutes}分間待ちます。job_id='{job_id}'")
         result = self.service.wrapper.wait_for_completion(
             project_id,
             job_type=job_type,

annofabcli/common/exceptions.py

@@ -46,7 +46,7 @@ class ProjectAuthorizationError(AuthorizationError):
 
     def __init__(self, project_title: str, roles: list[ProjectMemberRole]) -> None:
         role_values = [e.value for e in roles]
-        msg = f"プロジェクト: {project_title} に、ロール: {role_values} のいずれかが付与されていません。"
+        msg = f"プロジェクト'{project_title}'に対して、ロール'{role_values}'のいずれかが必要です。"
         super().__init__(msg)
 
 
@@ -57,7 +57,7 @@ class OrganizationAuthorizationError(AuthorizationError):
 
     def __init__(self, organization_name: str, roles: list[OrganizationMemberRole]) -> None:
         role_values = [e.value for e in roles]
-        msg = f"組織: {organization_name} に、ロール: {role_values} のいずれかが付与されていません。"
+        msg = f"組織'{organization_name}'に対して、ロール'{role_values}'のいずれかが必要です。"
         super().__init__(msg)
 
 

annofabcli/common/facade.py

@@ -499,12 +499,12 @@ class AnnofabApiFacade:
             task_query.account_id = self.get_account_id_from_user_id(project_id, task_query.user_id)
         return task_query
 
-    def validate_project(  # noqa: ANN201
+    def validate_project(
         self,
         project_id: str,
         project_member_roles: Optional[list[ProjectMemberRole]] = None,
         organization_member_roles: Optional[list[OrganizationMemberRole]] = None,
-    ):
+    ) -> None:
         """
         プロジェクト or 組織に対して、必要な権限が付与されているかを確認する。
 

annofabcli/common/image.py

@@ -85,7 +85,7 @@ def fill_annotation(
         if outer_image is not None:
             draw.bitmap([0, 0], outer_image, fill=color)
         else:
-            logger.warning(f"アノテーション種類が`{data_type}`ですが、`outer_image`がNoneです。 annotation_id={annotation.annotation_id}")
+            logger.warning(f"アノテーション種類が`{data_type}`ですが、`outer_image`がNoneです。 annotation_id='{annotation.annotation_id}'")
 
     return draw
 
@@ -344,7 +344,7 @@ def write_annotation_images_from_path(
         output_image_file = output_dir_path / f"{Path(parser.json_file_path).stem}.{output_image_extension}"
         tmp_image_size = _get_image_size(parser.input_data_id)
         if tmp_image_size is None:
-            logger.warning(f"task_id={parser.task_id}, input_data_id={parser.input_data_id}: 画像サイズを取得できなかったので、スキップします。")
+            logger.warning(f"task_id='{parser.task_id}', input_data_id='{parser.input_data_id}': 画像サイズを取得できなかったので、スキップします。")
             continue
 
         write_annotation_image(

annofabcli/input_data/delete_input_data.py

@@ -42,11 +42,11 @@ class DeleteInputData(CommandLine):
                     f"supplementary_data_name={supplementary_data['supplementary_data_name']}"
                 )
                 deleted_count += 1
-            except requests.HTTPError as e:
-                logger.warning(e)
+            except requests.HTTPError:
                 logger.warning(
                     f"補助情報の削除に失敗しました。input_data_id={input_data_id}, supplementary_data_id={supplementary_data_id}, "
-                    f"supplementary_data_name={supplementary_data['supplementary_data_name']}"
+                    f"supplementary_data_name={supplementary_data['supplementary_data_name']}",
+                    exc_info=True,
                 )
                 continue
 
@@ -69,7 +69,7 @@ class DeleteInputData(CommandLine):
     def delete_input_data(self, project_id: str, input_data_id: str, input_data_index: int, delete_supplementary: bool, force: bool):  # noqa: ANN201, FBT001
         input_data = self.service.wrapper.get_input_data_or_none(project_id, input_data_id)
         if input_data is None:
-            logger.info(f"input_data_id={input_data_id} は存在しません。")
+            logger.info(f"input_data_id='{input_data_id}'である入力データは存在しません。")
             return False
 
         task_list = self.service.wrapper.get_all_tasks(project_id, query_params={"input_data_ids": input_data_id})
@@ -137,9 +137,8 @@ class DeleteInputData(CommandLine):
                 if result:
                     count_delete_input_data += 1
 
-            except requests.exceptions.HTTPError as e:
-                logger.warning(e)
-                logger.warning(f"input_data_id='{input_data_id}'の削除に失敗しました。")
+            except requests.exceptions.HTTPError:
+                logger.warning(f"input_data_id='{input_data_id}'である入力データの削除に失敗しました。", exc_info=True)
                 continue
 
         logger.info(f"プロジェクト'{project_title}'から 、{count_delete_input_data}/{len(input_data_id_list)} 件の入力データを削除しました。")

annofabcli/job/delete_job.py

@@ -29,14 +29,14 @@ class DeleteJobMain:
         count = 0
         for job_id in job_id_list:
             if job_id not in exists_job_id_set:
-                logger.debug(f"job_id={job_id} のジョブは存在しなかったのでスキップします。")
+                logger.debug(f"job_id='{job_id}' のジョブは存在しなかったのでスキップします。")
                 continue
             try:
                 self.service.api.delete_project_job(project_id, job_type.value, job_id)
-                logger.debug(f"job_type={job_type.value}, job_id={job_id} のジョブを削除しました。")
+                logger.debug(f"job_type={job_type.value}, job_id='{job_id}' のジョブを削除しました。")
                 count += 1
-            except Exception as e:  # pylint: disable=broad-except
-                logger.warning(e)
+            except Exception:  # pylint: disable=broad-except
+                logger.warning(f"job_type={job_type.value}, job_id='{job_id}' のジョブの削除に失敗しました。", exc_info=True)
         logger.info(f"{count} / {len(job_id_list)} 件のジョブを削除しました。")
 
 

annofabcli/organization_member/list_organization_member.py

@@ -48,9 +48,8 @@ class ListOrganizationMember(CommandLine):
         for organization_name in organization_name_list:
             try:
                 organization_member_list.extend(self.get_organization_member_list(organization_name))
-            except requests.HTTPError as e:
-                logger.warning(e)
-                logger.warning(f"{organization_name} の組織メンバを取得できませんでした。")
+            except requests.HTTPError:
+                logger.warning(f"組織'{organization_name}'のメンバー一覧を取得できませんでした。", exc_info=True)
                 continue
 
         if args.format == FormatArgument.CSV.value:

annofabcli/project_member/change_project_members.py

@@ -115,9 +115,8 @@ class ChangeProjectMembers(CommandLine):
                 logger.debug(f"user_id = {user_id} のプロジェクトメンバ情報を変更しました。member_role={member_role}, member_info={member_info}")
                 count_invite_members += 1
 
-            except requests.exceptions.HTTPError as e:
-                logger.warning(e)
-                logger.warning(f"プロジェクトメンバの登録に失敗しました。user_id={user_id}")
+            except requests.exceptions.HTTPError:
+                logger.warning(f"プロジェクトメンバの登録に失敗しました。 :: user_id='{user_id}'", exc_info=True)
 
         logger.info(f"{project_title} に、{count_invite_members} / {len(user_id_list)} 件のプロジェクトメンバを変更しました。")
 

annofabcli/project_member/drop_project_members.py

@@ -49,10 +49,11 @@ class DropProjectMembersMain:
             }
             try:
                 self.service.api.put_project_member(project_id, user_id, request_body=request_body)
-                logger.debug(f"{project_title}({project_id}) のプロジェクトメンバから、{user_id} を脱退させました。")
-            except requests.HTTPError as e:
-                logger.warning(e)
-                logger.warning(f"{project_title}({project_id}) のプロジェクトメンバから、{user_id} を脱退させられませんでした。")
+                logger.debug(f"プロジェクト'{project_title}'(project_id='{project_id}') から、user_id='{user_id}'のユーザーを脱退させました。")
+            except requests.HTTPError:
+                logger.warning(
+                    f"プロジェクト'{project_title}'(project_id='{project_id}') から、user_id='{user_id}'のユーザーを脱退させられませんでした。"
+                )
 
     def drop_role_with_organization(self, organization_name: str, user_id_list: list[str]):  # noqa: ANN201
         projects = self.service.wrapper.get_all_projects_of_organization(organization_name, query_params={"account_id": self.service.api.account_id})
@@ -64,14 +65,13 @@ class DropProjectMembersMain:
         for project_id in project_id_list:
             try:
                 if not self.facade.my_role_is_owner(project_id):
-                    logger.warning(f"オーナではないため、プロジェクトメンバを脱退させられません。project_id = {project_id}")
+                    logger.warning(f"オーナではないため、プロジェクトメンバを脱退させられません。 :: project_id='{project_id}'")
                     continue
 
                 self.drop_project_members(project_id, user_id_list)
 
-            except requests.HTTPError as e:
-                logger.warning(e)
-                logger.warning(f"project_id={project_id} のプロジェクトメンバからユーザを脱退させられませんでした。")
+            except requests.HTTPError:
+                logger.warning(f"project_id='{project_id}' のプロジェクトメンバからユーザを脱退させられませんでした。", exc_info=True)
 
 
 class DropProjectMembers(CommandLine):

annofabcli/project_member/invite_project_members.py

@@ -55,10 +55,10 @@ class InviteProjectMemberMain:
             try:
                 self.service.api.put_project_member(project_id, user_id, request_body=request_body)
                 logger.debug(f"{project_title}({project_id}) のプロジェクトメンバに、{user_id} を {member_role.value} ロールで追加しました。")
-            except requests.HTTPError as e:
-                logger.warning(e)
+            except requests.HTTPError:
                 logger.warning(
-                    f"{project_title}({project_id}) のプロジェクトメンバに、{user_id} を {member_role.value} ロールで追加できませんでした。"
+                    f"{project_title}({project_id}) のプロジェクトメンバに、{user_id} を {member_role.value} ロールで追加できませんでした。",
+                    exc_info=True,
                 )
 
     def assign_role_with_organization(self, organization_name: str, user_id_list: list[str], member_role: ProjectMemberRole):  # noqa: ANN201
@@ -75,9 +75,8 @@ class InviteProjectMemberMain:
 
                 self.invite_project_members(project_id, user_id_list, member_role)
 
-            except requests.HTTPError as e:
-                logger.warning(e)
-                logger.warning(f"project_id={project_id} のプロジェクトメンバにユーザを招待できませんでした。")
+            except requests.HTTPError:
+                logger.warning(f"project_id='{project_id}' のプロジェクトメンバにユーザを招待できませんでした。")
 
 
 class InviteUser(CommandLine):

annofabcli/project_member/list_users.py

@@ -48,16 +48,16 @@ class ListUser(CommandLine):
         for project_id in project_id_list:
             try:
                 project, _ = self.service.api.get_project(project_id)
-            except requests.exceptions.HTTPError as e:
-                logger.warning(e)
+            except requests.exceptions.HTTPError:
                 logger.warning(
-                    f"project_id = {project_id} のプロジェクトにアクセスできなかった（存在しないproject_id、またはプロジェクトメンバでない）"
+                    f"project_id='{project_id}' のプロジェクトにアクセスできなかった（存在しないproject_id、またはプロジェクトメンバでない）",
+                    exc_info=True,
                 )
                 continue
 
             project_title = project["title"]
             project_members = self.get_all_project_members(project_id, include_inactive=include_inactive)
-            logger.info(f"{project_title} のプロジェクトメンバを {len(project_members)} 件取得した。project_id={project_id}")
+            logger.info(f"{project_title} のプロジェクトメンバを {len(project_members)} 件取得した。project_id='{project_id}'")
 
             for member in project_members:
                 AddProps.add_properties_of_project(member, project_title)

annofabcli/task/complete_tasks.py

@@ -76,7 +76,7 @@ class CompleteTasksMain(CommandLineWithConfirm):
         comment_status: CommentStatus,
     ):
         if comment_list is None or len(comment_list) == 0:
-            logger.warning(f"変更対象の検査コメントはなかった。task_id = {task.task_id}, input_data_id = {input_data_id}")
+            logger.warning(f"変更対象の検査コメントはなかった。task_id='{task.task_id}', input_data_id='{input_data_id}'")
             return
 
         def to_req_inspection(comment: dict[str, Any]) -> dict[str, Any]:
@@ -332,7 +332,7 @@ class CompleteTasksMain(CommandLineWithConfirm):
 
         task: Task = Task.from_dict(dict_task)
         logger.info(
-            f"{logging_prefix} : タスク情報 task_id={task_id}, phase={task.phase.value}, phase_stage={task.phase_stage}, status={task.status.value}"
+            f"{logging_prefix} : タスク情報 task_id='{task_id}', phase={task.phase.value}, phase_stage={task.phase_stage}, status={task.status.value}"
         )
         if not self._validate_task(task, target_phase=target_phase, target_phase_stage=target_phase_stage, task_query=task_query):
             return False