From 2c01354569294a4302392d16ebd9c2e4b0e43340 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Mon, 10 May 2021 12:29:25 -0700 Subject: [PATCH] management: Use required kwargs in add_realm_args. This makes management commands more readable, since one doesn't need to know details of how the library works to read based code. --- zerver/lib/management.py | 2 +- zerver/management/commands/add_users_to_streams.py | 2 +- zerver/management/commands/bulk_change_user_name.py | 2 +- zerver/management/commands/change_user_role.py | 2 +- zerver/management/commands/create_default_stream_groups.py | 2 +- zerver/management/commands/create_stream.py | 2 +- zerver/management/commands/create_user.py | 2 +- zerver/management/commands/deactivate_realm.py | 2 +- zerver/management/commands/delete_realm.py | 2 +- zerver/management/commands/dump_messages.py | 2 +- zerver/management/commands/edit_linkifiers.py | 2 +- zerver/management/commands/export.py | 2 +- zerver/management/commands/generate_invite_links.py | 2 +- zerver/management/commands/generate_multiuse_invite_link.py | 2 +- zerver/management/commands/merge_streams.py | 2 +- zerver/management/commands/reactivate_realm.py | 2 +- zerver/management/commands/realm_domain.py | 2 +- zerver/management/commands/remove_users_from_stream.py | 2 +- zerver/management/commands/rename_stream.py | 2 +- zerver/management/commands/scrub_realm.py | 2 +- zerver/management/commands/send_realm_reactivation_email.py | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) diff --git a/zerver/lib/management.py b/zerver/lib/management.py index b6023c46f1..79ceb86372 100644 --- a/zerver/lib/management.py +++ b/zerver/lib/management.py @@ -45,7 +45,7 @@ class ZulipBaseCommand(BaseCommand): return parser def add_realm_args( - self, parser: ArgumentParser, required: bool = False, help: Optional[str] = None + self, parser: ArgumentParser, *, required: bool = False, help: Optional[str] = None ) -> None: if help is None: help = """The numeric or string ID (subdomain) of the Zulip organization to modify. diff --git a/zerver/management/commands/add_users_to_streams.py b/zerver/management/commands/add_users_to_streams.py index 392cf4d86d..9c4a6fb795 100644 --- a/zerver/management/commands/add_users_to_streams.py +++ b/zerver/management/commands/add_users_to_streams.py @@ -10,7 +10,7 @@ class Command(ZulipBaseCommand): help = """Add some or all users in a realm to a set of streams.""" def add_arguments(self, parser: CommandParser) -> None: - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) self.add_user_list_args(parser, all_users_help="Add all users in realm to these streams.") parser.add_argument( diff --git a/zerver/management/commands/bulk_change_user_name.py b/zerver/management/commands/bulk_change_user_name.py index cd43e1bd17..e7e2afef55 100644 --- a/zerver/management/commands/bulk_change_user_name.py +++ b/zerver/management/commands/bulk_change_user_name.py @@ -16,7 +16,7 @@ class Command(ZulipBaseCommand): metavar="", help="file containing rows of the form ,", ) - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: str) -> None: data_file = options["data_file"] diff --git a/zerver/management/commands/change_user_role.py b/zerver/management/commands/change_user_role.py index a2642bb430..eb08312d1f 100644 --- a/zerver/management/commands/change_user_role.py +++ b/zerver/management/commands/change_user_role.py @@ -40,7 +40,7 @@ ONLY perform this on customer request from an authorized person. action="store_false", help="Remove can_forge_sender or can_create_users permission.", ) - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: Any) -> None: email = options["email"] diff --git a/zerver/management/commands/create_default_stream_groups.py b/zerver/management/commands/create_default_stream_groups.py index d00addc8e4..8fd3bbfc3b 100644 --- a/zerver/management/commands/create_default_stream_groups.py +++ b/zerver/management/commands/create_default_stream_groups.py @@ -14,7 +14,7 @@ Create default stream groups which the users can choose during sign up. """ def add_arguments(self, parser: ArgumentParser) -> None: - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) parser.add_argument( "-n", diff --git a/zerver/management/commands/create_stream.py b/zerver/management/commands/create_stream.py index 93bafc01b1..f1a3db75a7 100644 --- a/zerver/management/commands/create_stream.py +++ b/zerver/management/commands/create_stream.py @@ -12,7 +12,7 @@ This should be used for TESTING only, unless you understand the limitations of the command.""" def add_arguments(self, parser: ArgumentParser) -> None: - self.add_realm_args(parser, True, "realm in which to create the stream") + self.add_realm_args(parser, required=True, help="realm in which to create the stream") parser.add_argument("stream_name", metavar="", help="name of stream to create") def handle(self, *args: Any, **options: str) -> None: diff --git a/zerver/management/commands/create_user.py b/zerver/management/commands/create_user.py index 6aeb1b362e..50c999f390 100644 --- a/zerver/management/commands/create_user.py +++ b/zerver/management/commands/create_user.py @@ -53,7 +53,7 @@ Omit both and for interactive user creation. help="full name of new user", ) self.add_realm_args( - parser, True, "The name of the existing realm to which to add the user." + parser, required=True, help="The name of the existing realm to which to add the user." ) def handle(self, *args: Any, **options: Any) -> None: diff --git a/zerver/management/commands/deactivate_realm.py b/zerver/management/commands/deactivate_realm.py index 084b595a48..ce50856f59 100644 --- a/zerver/management/commands/deactivate_realm.py +++ b/zerver/management/commands/deactivate_realm.py @@ -12,7 +12,7 @@ class Command(ZulipBaseCommand): parser.add_argument( "--redirect_url", metavar="", help="URL to which the realm has moved" ) - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: str) -> None: realm = self.get_realm(options) diff --git a/zerver/management/commands/delete_realm.py b/zerver/management/commands/delete_realm.py index d79883b2a6..4efee4f437 100644 --- a/zerver/management/commands/delete_realm.py +++ b/zerver/management/commands/delete_realm.py @@ -12,7 +12,7 @@ class Command(ZulipBaseCommand): realms used for testing; consider using deactivate_realm instead.""" def add_arguments(self, parser: ArgumentParser) -> None: - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: str) -> None: realm = self.get_realm(options) diff --git a/zerver/management/commands/dump_messages.py b/zerver/management/commands/dump_messages.py index 0689a052fb..b451eb34ee 100644 --- a/zerver/management/commands/dump_messages.py +++ b/zerver/management/commands/dump_messages.py @@ -13,7 +13,7 @@ class Command(ZulipBaseCommand): def add_arguments(self, parser: CommandParser) -> None: default_cutoff = time.time() - 60 * 60 * 24 * 30 # 30 days. - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) parser.add_argument( "--since", type=int, diff --git a/zerver/management/commands/edit_linkifiers.py b/zerver/management/commands/edit_linkifiers.py index 407a792423..3dc71d0f30 100644 --- a/zerver/management/commands/edit_linkifiers.py +++ b/zerver/management/commands/edit_linkifiers.py @@ -35,7 +35,7 @@ Example: ./manage.py realm_filters --realm=zulip --op=show nargs="?", help="format string to substitute", ) - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: str) -> None: realm = self.get_realm(options) diff --git a/zerver/management/commands/export.py b/zerver/management/commands/export.py index 51977bc57c..cbcaf40f01 100644 --- a/zerver/management/commands/export.py +++ b/zerver/management/commands/export.py @@ -110,7 +110,7 @@ class Command(ZulipBaseCommand): action="store_true", help="Automatically delete the local tarball after a successful export", ) - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: Any) -> None: realm = self.get_realm(options) diff --git a/zerver/management/commands/generate_invite_links.py b/zerver/management/commands/generate_invite_links.py index d8c3899c88..4702af46e9 100644 --- a/zerver/management/commands/generate_invite_links.py +++ b/zerver/management/commands/generate_invite_links.py @@ -24,7 +24,7 @@ class Command(ZulipBaseCommand): nargs="*", help="email of users to generate an activation link for", ) - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: Any) -> None: duplicates = False diff --git a/zerver/management/commands/generate_multiuse_invite_link.py b/zerver/management/commands/generate_multiuse_invite_link.py index a3f90014e6..5420fe5711 100644 --- a/zerver/management/commands/generate_multiuse_invite_link.py +++ b/zerver/management/commands/generate_multiuse_invite_link.py @@ -10,7 +10,7 @@ class Command(ZulipBaseCommand): help = "Generates invite link that can be used for inviting multiple users" def add_arguments(self, parser: ArgumentParser) -> None: - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) parser.add_argument("-s", "--streams", help="A comma-separated list of stream names.") diff --git a/zerver/management/commands/merge_streams.py b/zerver/management/commands/merge_streams.py index b290a408e8..beecae8743 100644 --- a/zerver/management/commands/merge_streams.py +++ b/zerver/management/commands/merge_streams.py @@ -29,7 +29,7 @@ class Command(ZulipBaseCommand): parser.add_argument( "stream_to_destroy", help="name of stream to merge into the stream being kept" ) - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: str) -> None: realm = self.get_realm(options) diff --git a/zerver/management/commands/reactivate_realm.py b/zerver/management/commands/reactivate_realm.py index 3ce0b4349f..c8e1144323 100644 --- a/zerver/management/commands/reactivate_realm.py +++ b/zerver/management/commands/reactivate_realm.py @@ -9,7 +9,7 @@ class Command(ZulipBaseCommand): help = """Script to reactivate a deactivated realm.""" def add_arguments(self, parser: ArgumentParser) -> None: - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: str) -> None: realm = self.get_realm(options) diff --git a/zerver/management/commands/realm_domain.py b/zerver/management/commands/realm_domain.py index 2d5feeb697..8b44d35a0f 100644 --- a/zerver/management/commands/realm_domain.py +++ b/zerver/management/commands/realm_domain.py @@ -21,7 +21,7 @@ class Command(ZulipBaseCommand): "--allow-subdomains", action="store_true", help="Whether subdomains are allowed or not." ) parser.add_argument("domain", metavar="", nargs="?", help="domain to add or remove") - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: str) -> None: realm = self.get_realm(options) diff --git a/zerver/management/commands/remove_users_from_stream.py b/zerver/management/commands/remove_users_from_stream.py index 524a477250..edeec6e060 100644 --- a/zerver/management/commands/remove_users_from_stream.py +++ b/zerver/management/commands/remove_users_from_stream.py @@ -13,7 +13,7 @@ class Command(ZulipBaseCommand): def add_arguments(self, parser: CommandParser) -> None: parser.add_argument("-s", "--stream", required=True, help="A stream name.") - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) self.add_user_list_args( parser, all_users_help="Remove all users in realm from this stream." ) diff --git a/zerver/management/commands/rename_stream.py b/zerver/management/commands/rename_stream.py index d607226166..bb90922073 100644 --- a/zerver/management/commands/rename_stream.py +++ b/zerver/management/commands/rename_stream.py @@ -14,7 +14,7 @@ class Command(ZulipBaseCommand): parser.add_argument( "new_name", metavar="", help="new name to rename the stream to" ) - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: str) -> None: realm = self.get_realm(options) diff --git a/zerver/management/commands/scrub_realm.py b/zerver/management/commands/scrub_realm.py index 247469f8af..c5a56ce051 100644 --- a/zerver/management/commands/scrub_realm.py +++ b/zerver/management/commands/scrub_realm.py @@ -9,7 +9,7 @@ class Command(ZulipBaseCommand): help = """Script to scrub a deactivated realm.""" def add_arguments(self, parser: ArgumentParser) -> None: - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: str) -> None: realm = self.get_realm(options) diff --git a/zerver/management/commands/send_realm_reactivation_email.py b/zerver/management/commands/send_realm_reactivation_email.py index ce10238074..197bda0dc3 100644 --- a/zerver/management/commands/send_realm_reactivation_email.py +++ b/zerver/management/commands/send_realm_reactivation_email.py @@ -9,7 +9,7 @@ class Command(ZulipBaseCommand): help = """Sends realm reactivation email to admins""" def add_arguments(self, parser: ArgumentParser) -> None: - self.add_realm_args(parser, True) + self.add_realm_args(parser, required=True) def handle(self, *args: Any, **options: str) -> None: realm = self.get_realm(options)