annofabcli 1.102.0__tar.gz → 1.102.1__tar.gz

{annofabcli-1.102.0 → annofabcli-1.102.1}/PKG-INFO

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

{annofabcli-1.102.0 → annofabcli-1.102.1}/annofabcli/annotation/copy_annotation.py

@@ -10,6 +10,7 @@ from dataclasses import dataclass
 from typing import Any, Optional
 
 import annofabapi
+from annofabapi.models import ProjectMemberRole
 from annofabapi.utils import can_put_annotation
 
 import annofabcli
@@ -350,6 +351,8 @@ class CopyAnnotation(CommandLine):
             sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
 
         project_id = args.project_id
+        super().validate_project(project_id, [ProjectMemberRole.OWNER, ProjectMemberRole.ACCEPTER, ProjectMemberRole.WORKER])
+
         str_copy_target_list = get_list_from_args(args.input)
 
         copy_target_list = get_copy_target_list(str_copy_target_list)
@@ -421,6 +424,7 @@ def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argpa
     subcommand_name = "copy"
     subcommand_help = "アノテーションをコピーします．"
     description = "タスク単位または入力データ単位で、アノテーションをコピーします。"
-    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description)
+    epilog = "オーナー、チェッカーまたはアノテータロールを持つユーザで実行してください。"
+    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description, epilog=epilog)
     parse_args(parser)
     return parser

{annofabcli-1.102.0 → annofabcli-1.102.1}/annofabcli/annotation/delete_annotation.py

@@ -356,7 +356,13 @@ class DeleteAnnotation(CommandLine):
         else:
             backup_dir = Path(args.backup)
 
-        super().validate_project(project_id, [ProjectMemberRole.OWNER])
+        if args.force:
+            # --forceオプションが指定されている場合は、完了状態のタスクも削除する
+            # 完了状態のタスクを削除するには、オーナーロールである必要があるため、`args.force`で条件を分岐する
+            super().validate_project(project_id, [ProjectMemberRole.OWNER])
+        else:
+            super().validate_project(project_id, [ProjectMemberRole.OWNER, ProjectMemberRole.ACCEPTER])
+
         main_obj = DeleteAnnotationMain(self.service, project_id, all_yes=args.yes, is_force=args.force)
 
         if args.json is not None:
@@ -452,7 +458,12 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
         f"(ex): ``{json.dumps(EXAMPLE_ANNOTATION_QUERY)}``",
     )
 
-    parser.add_argument("--force", action="store_true", help="指定した場合は、完了状態のタスクのアノテーションも削除します。")
+    parser.add_argument(
+        "--force",
+        action="store_true",
+        help="指定した場合は、完了状態のタスクのアノテーションも削除します。"
+        "ただし、完了状態のタスクを削除するには、オーナーロールを持つユーザーが実行する必要があります。",
+    )
     parser.add_argument(
         "--backup",
         type=str,
@@ -469,7 +480,7 @@ def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argpa
         "タスク配下のアノテーションを削除します。ただし、作業中状態のタスクのアノテーションは削除できません。"
         "間違えてアノテーションを削除したときに復元できるようにするため、 ``--backup`` でバックアップ用のディレクトリを指定することを推奨します。"
     )
-    epilog = "オーナロールを持つユーザで実行してください。"
+    epilog = "オーナーまたはチェッカーロールを持つユーザで実行してください。ただし``--force``オプションを指定した場合は、オーナーロールを持つユーザで実行してください。"  # noqa: E501
 
     parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description, epilog=epilog)
     parse_args(parser)

{annofabcli-1.102.0 → annofabcli-1.102.1}/annofabcli/annotation/merge_segmentation.py

@@ -12,6 +12,7 @@ from typing import Any, Optional
 
 import annofabapi
 import numpy
+from annofabapi.models import ProjectMemberRole
 from annofabapi.pydantic_models.default_annotation_type import DefaultAnnotationType
 from annofabapi.pydantic_models.task_status import TaskStatus
 from annofabapi.segmentation import read_binary_image, write_binary_image
@@ -304,6 +305,8 @@ class MergeSegmentation(CommandLine):
             sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
 
         project_id = args.project_id
+        super().validate_project(project_id, [ProjectMemberRole.OWNER, ProjectMemberRole.ACCEPTER, ProjectMemberRole.WORKER])
+
         task_id_list = annofabcli.common.cli.get_list_from_args(args.task_id)
         label_name_list = annofabcli.common.cli.get_list_from_args(args.label_name)
 
@@ -385,6 +388,7 @@ def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argpa
         "複数の塗りつぶしアノテーションを1つにまとめます。"
         "ラベルの種類を「塗りつぶし（インスタンスセグメンテーション）」から「塗りつぶしv2（セマンティックセグメンテーション）」に変更する場合などに有用です。"
     )
-    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description)
+    epilog = "オーナー、チェッカーまたはアノテータロールを持つユーザで実行してください。"
+    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description, epilog=epilog)
     parse_args(parser)
     return parser

{annofabcli-1.102.0 → annofabcli-1.102.1}/annofabcli/annotation/remove_segmentation_overlap.py

@@ -12,6 +12,7 @@ from typing import Any, Optional
 
 import annofabapi
 import numpy
+from annofabapi.models import ProjectMemberRole
 from annofabapi.pydantic_models.task_status import TaskStatus
 from annofabapi.segmentation import read_binary_image, write_binary_image
 from annofabapi.utils import can_put_annotation
@@ -291,8 +292,11 @@ class RemoveSegmentationOverlap(CommandLine):
             sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
 
         project_id = args.project_id
+
         task_id_list = annofabcli.common.cli.get_list_from_args(args.task_id)
 
+        super().validate_project(project_id, [ProjectMemberRole.OWNER, ProjectMemberRole.ACCEPTER, ProjectMemberRole.WORKER])
+
         main_obj = RemoveSegmentationOverlapMain(
             self.service,
             project_id=project_id,
@@ -338,6 +342,7 @@ def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argpa
         "Annofabでインスタンスセグメンテーションは重ねることができてしまいます。"
         "この重なりをなくしたいときに有用です。"
     )
-    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description)
+    epilog = "オーナー、チェッカーまたはアノテータロールを持つユーザで実行してください。"
+    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description, epilog=epilog)
     parse_args(parser)
     return parser

{annofabcli-1.102.0 → annofabcli-1.102.1}/annofabcli/organization_member/delete_organization_member.py

@@ -7,6 +7,7 @@ from typing import Any, Optional
 
 import annofabapi
 import more_itertools
+from annofabapi.models import OrganizationMemberRole
 
 import annofabcli
 import annofabcli.common.cli
@@ -35,8 +36,14 @@ class DeleteOrganizationMemberMain(CommandLineWithConfirm):
     def get_member(organization_member_list: list[dict[str, Any]], user_id: str) -> Optional[dict[str, Any]]:
         return more_itertools.first_true(organization_member_list, pred=lambda e: e["user_id"] == user_id)
 
-    def main(self, organization_name: str, user_ids: Collection[str]) -> None:
-        logger.info(f"{len(user_ids)} 件のユーザを組織'{organization_name}'から脱退させます。")
+    def delete_organization_members_from_organization(self, organization_name: str, user_ids: Collection[str]) -> None:
+        if not self.facade.contains_any_organization_member_role(
+            organization_name, {OrganizationMemberRole.ADMINISTRATOR, OrganizationMemberRole.OWNER}
+        ):
+            logger.warning(f"組織'{organization_name}'に所属していないか、組織メンバーを脱退できるロールを持たないため、スキップします。")
+            return
+
+        logger.info(f"{len(user_ids)} 件のメンバーを組織'{organization_name}'から脱退させます。")
 
         member_list = self.service.wrapper.get_all_organization_members(organization_name)
 
@@ -45,24 +52,30 @@ class DeleteOrganizationMemberMain(CommandLineWithConfirm):
         for user_id in user_ids:
             member = self.get_member(member_list, user_id)
             if member is None:
-                logger.warning(f"組織メンバにuser_id='{user_id}'のユーザが存在しません。")
+                logger.warning(f"組織'{organization_name}'に user_id='{user_id}'のメンバーが存在しません。")
                 continue
 
             if not self.confirm_processing(
-                f"user_id='{user_id}'のユーザを組織から脱退させますか？ :: username='{member['username']}', role='{member['role']}'"
+                f"組織'{organization_name}'に所属する user_id='{user_id}'のメンバーを脱退させますか？ :: username='{member['username']}'"
             ):
                 continue
 
-            logger.debug(f"user_id='{user_id}'のユーザを組織から脱退させます。 :: username='{member['username']}', role='{member['role']}'")
             try:
                 self.service.api.delete_organization_member(organization_name, user_id)
-                logger.debug(f"user_id='{user_id}'のユーザを組織'{organization_name}'から脱退させました。")
+                logger.debug(f"組織'{organization_name}'から user_id='{user_id}'のメンバーを脱退させました。")
                 success_count += 1
 
             except Exception:  # pylint: disable=broad-except
-                logger.warning(f"user_id='{user_id}'のユーザを組織'{organization_name}'から脱退させるのに失敗しました。", exc_info=True)
+                logger.warning(f"組織'{organization_name}'から user_id='{user_id}'のメンバーを脱退させるのに失敗しました。", exc_info=True)
+
+        logger.info(f"{success_count} / {len(user_ids)} 件のメンバーを組織'{organization_name}'から脱退させました。")
 
-        logger.info(f"{success_count} / {len(user_ids)} 件のユーザを組織'{organization_name}'から脱退させました。")
+    def delete_organization_members_from_organizations(self, organization_names: list[str], user_ids: Collection[str]) -> None:
+        for organization_name in organization_names:
+            try:
+                self.delete_organization_members_from_organization(organization_name, user_ids)
+            except Exception:  # pylint
+                logger.warning(f"組織'{organization_name}'からメンバーを脱退させるのに失敗しました。", exc_info=True)
 
 
 class DeleteOrganizationMember(CommandLine):
@@ -70,9 +83,10 @@ class DeleteOrganizationMember(CommandLine):
         args = self.args
 
         user_id_list = annofabcli.common.cli.get_list_from_args(args.user_id)
+        organization_name_list = annofabcli.common.cli.get_list_from_args(args.organization)
 
         main_obj = DeleteOrganizationMemberMain(self.service, all_yes=args.yes)
-        main_obj.main(organization_name=args.organization, user_ids=user_id_list)
+        main_obj.delete_organization_members_from_organizations(organization_name_list, user_id_list)
 
 
 def main(args: argparse.Namespace) -> None:
@@ -82,7 +96,14 @@ def main(args: argparse.Namespace) -> None:
 
 
 def parse_args(parser: argparse.ArgumentParser) -> None:
-    parser.add_argument("-org", "--organization", required=True, type=str, help="対象の組織の組織名を指定してください。")
+    parser.add_argument(
+        "-org",
+        "--organization",
+        nargs="+",
+        required=True,
+        type=str,
+        help="対象の組織名を指定してます。 ``file://`` を先頭に付けると、一覧が記載されたファイルを指定できます。",
+    )
 
     parser.add_argument(
         "-u",
@@ -90,7 +111,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
         type=str,
         nargs="+",
         required=True,
-        help="組織から脱退させるユーザのuser_idを指定してください。 ``file://`` を先頭に付けると、一覧が記載されたファイルを指定できます。",
+        help="組織から脱退させるメンバーのuser_idを指定します。 ``file://`` を先頭に付けると、一覧が記載されたファイルを指定できます。",
     )
 
     parser.set_defaults(subcommand_func=main)
@@ -98,10 +119,9 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
 
 def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:
     subcommand_name = "delete"
-    subcommand_help = "組織からユーザを脱退させます。"
-    description = "組織からユーザを脱退させます。"
+    subcommand_help = "組織からメンバーを脱退させます。"
     epilog = "組織オーナまたは組織管理者ロールを持つユーザで実行してください。"
 
-    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, command_help=subcommand_help, description=description, epilog=epilog)
+    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, command_help=subcommand_help, epilog=epilog)
     parse_args(parser)
     return parser

{annofabcli-1.102.0 → annofabcli-1.102.1}/annofabcli/organization_member/invite_organization_member.py

@@ -29,8 +29,14 @@ class InviteOrganizationMemberMain(CommandLineWithConfirm):
         self.facade = AnnofabApiFacade(service)
         super().__init__(all_yes)
 
-    def main(self, organization_name: str, user_ids: Collection[str], role: str) -> None:
-        logger.info(f"{len(user_ids)} 件のユーザを組織'{organization_name}'に招待して、ロール'{role}'を付与します。")
+    def invite_members_to_organization(self, organization_name: str, user_ids: Collection[str], role: str) -> None:
+        if not self.facade.contains_any_organization_member_role(
+            organization_name, {OrganizationMemberRole.ADMINISTRATOR, OrganizationMemberRole.OWNER}
+        ):
+            logger.warning(f"組織'{organization_name}'に所属していないか、組織メンバーを招待できるロールを持たないため、スキップします。")
+            return
+
+        logger.info(f"{len(user_ids)} 件のメンバーを組織'{organization_name}'に招待して、ロール'{role}'を付与します。")
 
         organization_member_list = self.service.wrapper.get_all_organization_members(organization_name)
         all_user_ids = {e["user_id"] for e in organization_member_list}
@@ -39,21 +45,28 @@ class InviteOrganizationMemberMain(CommandLineWithConfirm):
         success_count = 0
         for user_id in user_ids:
             if user_id in all_user_ids:
-                logger.warning(f"user_id='{user_id}'のユーザは、すでに組織'{organization_name}'に存在しています。")
+                logger.warning(f"user_id='{user_id}'のメンバーは、すでに組織'{organization_name}'に存在しているため、スキップします。")
                 continue
 
-            if not self.confirm_processing(f"user_id='{user_id}'のユーザを組織'{organization_name}'に招待しますか？ :: role='{role}'"):
+            if not self.confirm_processing(f"user_id='{user_id}'のメンバーを組織'{organization_name}'に招待して、ロール'{role}'を付与しますか？"):
                 continue
 
             try:
                 self.service.api.invite_organization_member(organization_name, user_id, request_body={"role": role})
-                logger.debug(f"user_id='{user_id}'のユーザを組織'{organization_name}'に招待しました。")
+                logger.debug(f"user_id='{user_id}'のメンバーを組織'{organization_name}'に招待しました。")
                 success_count += 1
 
             except Exception:  # pylint: disable=broad-except
-                logger.warning(f"user_id='{user_id}'のユーザを組織'{organization_name}'に招待するのに失敗しました。", exc_info=True)
+                logger.warning(f"user_id='{user_id}'のメンバーを組織'{organization_name}'に招待するのに失敗しました。", exc_info=True)
+
+        logger.info(f"{success_count} / {len(user_ids)} 件のメンバーを組織'{organization_name}'に招待しました。")
 
-        logger.info(f"{success_count} / {len(user_ids)} 件のユーザを組織'{organization_name}'に招待しました。")
+    def invite_members_to_organizations(self, organization_names: list[str], user_ids: Collection[str], role: str) -> None:
+        for organization_name in organization_names:
+            try:
+                self.invite_members_to_organization(organization_name, user_ids, role)
+            except Exception:  # pylint
+                logger.warning(f"組織'{organization_name}'にメンバーを招待するのに失敗しました。", exc_info=True)
 
 
 class InviteOrganizationMember(CommandLine):
@@ -61,9 +74,10 @@ class InviteOrganizationMember(CommandLine):
         args = self.args
 
         user_id_list = annofabcli.common.cli.get_list_from_args(args.user_id)
+        organization_name_list = annofabcli.common.cli.get_list_from_args(args.organization)
 
         main_obj = InviteOrganizationMemberMain(self.service, all_yes=args.yes)
-        main_obj.main(organization_name=args.organization, user_ids=user_id_list, role=args.role)
+        main_obj.invite_members_to_organizations(organization_name_list, user_id_list, role=args.role)
 
 
 def main(args: argparse.Namespace) -> None:
@@ -73,7 +87,7 @@ def main(args: argparse.Namespace) -> None:
 
 
 def parse_args(parser: argparse.ArgumentParser) -> None:
-    parser.add_argument("-org", "--organization", required=True, type=str, help="対象の組織の組織名を指定してください。")
+    parser.add_argument("-org", "--organization", nargs="+", required=True, type=str, help="招待先の組織名を指定してください。")
 
     parser.add_argument(
         "-u",
@@ -81,7 +95,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
         type=str,
         nargs="+",
         required=True,
-        help="組織に招待するユーザのuser_idを指定してください。 ``file://`` を先頭に付けると、一覧が記載されたファイルを指定できます。",
+        help="組織に招待するメンバーのuser_idを指定してます。 ``file://`` を先頭に付けると、一覧が記載されたファイルを指定できます。",
     )
 
     role_choices = [e.value for e in OrganizationMemberRole]
@@ -90,7 +104,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
         type=str,
         choices=role_choices,
         required=True,
-        help="招待するユーザに割り当てる組織メンバのロールを指定してください。",
+        help="招待するメンバーに割り当てるロールを指定してください。",
     )
 
     parser.set_defaults(subcommand_func=main)
@@ -98,10 +112,9 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
 
 def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:
     subcommand_name = "invite"
-    subcommand_help = "組織にユーザを招待します。"
-    description = "組織にユーザを招待します。"
+    subcommand_help = "組織にメンバーを招待します。"
     epilog = "組織オーナまたは組織管理者ロールを持つユーザで実行してください。"
 
-    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, command_help=subcommand_help, description=description, epilog=epilog)
+    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, command_help=subcommand_help, epilog=epilog)
     parse_args(parser)
     return parser

{annofabcli-1.102.0 → annofabcli-1.102.1}/docs/command_reference/organization_member/delete.rst

@@ -4,7 +4,7 @@ organization_member delete
 
 Description
 =================================
-組織からユーザを脱退させます。
+組織からメンバーを脱退させます。
 
 
 Examples
@@ -14,7 +14,7 @@ Examples
 基本的な使い方
 --------------------------
 
-対象組織の名前を ``--organization`` に、脱退させるユーザのuser_idを ``--user_id`` に指定します。
+対象組織の名前を ``--organization`` に、脱退させるメンバーのuser_idを ``--user_id`` に指定します。
 
 
 .. code-block::

{annofabcli-1.102.0 → annofabcli-1.102.1}/docs/command_reference/organization_member/invite.rst

@@ -4,7 +4,7 @@ organization_member invite
 
 Description
 =================================
-組織にユーザを招待します。
+組織にメンバーを招待します。
 
 
 Examples
@@ -14,7 +14,7 @@ Examples
 基本的な使い方
 --------------------------
 
-対象組織の名前を ``--organization`` に、招待するユーザのuser_idを ``--user_id`` に、組織メンバロールを ``--role`` に指定します。
+対象組織の名前を ``--organization`` に、招待するメンバーのuser_idを ``--user_id`` に、組織メンバーロールを ``--role`` に指定します。
 
 
 .. code-block::