globus-cli 3.33.1__tar.gz → 3.35.0__tar.gz

{globus_cli-3.33.1/src/globus_cli.egg-info → globus_cli-3.35.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: globus-cli
-Version: 3.33.1
+Version: 3.35.0
 Summary: Globus CLI
 Author-email: Stephen Rosen <sirosen@globus.org>
+License-Expression: Apache-2.0
 Project-URL: homepage, https://github.com/globus/globus-cli
 Keywords: globus,cli,command line
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: POSIX
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: globus-sdk==3.53.0
+Requires-Dist: globus-sdk==3.56.0
 Requires-Dist: click<9,>=8.1.4
 Requires-Dist: jmespath==1.0.1
 Requires-Dist: packaging>=17.0

{globus_cli-3.33.1 → globus_cli-3.35.0}/pyproject.toml

@@ -9,6 +9,7 @@ readme = "README.rst"
 authors = [
     { name = "Stephen Rosen", email = "sirosen@globus.org" },
 ]
+license = "Apache-2.0"
 keywords = [
     "globus",
     "cli",
@@ -17,7 +18,6 @@ keywords = [
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: Apache Software License",
     "Operating System :: POSIX",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.8",
@@ -29,7 +29,7 @@ classifiers = [
 ]
 requires-python = ">=3.8"
 dependencies = [
-    "globus-sdk==3.53.0",
+    "globus-sdk==3.56.0",
     "click>=8.1.4,<9",
     "jmespath==1.0.1",
     "packaging>=17.0",
@@ -88,8 +88,41 @@ attr = "globus_cli.version.__version__"
 profile = "black"
 
 [tool.pytest.ini_options]
-addopts = "--timeout 3 --color=yes"
-filterwarnings = ["error"]
+addopts = "-n auto --maxprocesses 4 --dist loadscope --timeout 3 --color=yes"
+filterwarnings = [
+    "error",
+    # ignore SDK warnings for 'filter_role' until
+    # 'filter_roles' update is applied
+    "ignore:The `filter_role` parameter is deprecated.:globus_sdk.exc.RemovedInV4Warning:",
+]
+
+[tool.coverage.run]
+parallel = true
+source = ["globus_cli"]
+[tool.coverage.paths]
+source = [
+    "src/",
+    "*/site-packages/",
+]
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+fail_under = 87
+exclude_lines =[
+    # the pragma to disable coverage
+    "pragma: no cover",
+    # don't complain if tests don't hit unimplemented methods/modes
+    "raise NotImplementedError",
+    "assert_never()",
+    # don't check on executable components of importable modules
+    "if __name__ == .__main__.:",
+    # don't check coverage on type checking conditionals
+    "if t.TYPE_CHECKING:",
+    # skip overloads
+    "@t.overload",
+    # skip abstract methods
+    "@abc.abstractmethod",
+]
 
 [tool.scriv]
 version = "literal: src/globus_cli/version.py: __version__"

globus_cli-3.35.0/src/globus_cli/_click_compat.py

@@ -0,0 +1,55 @@
+"""
+A compatibility module for handling click v8.2.0+ and 8.1.x API differences.
+"""
+
+import functools
+import importlib.metadata
+import typing as t
+
+import click
+
+C = t.TypeVar("C", bound=t.Callable[..., t.Any])
+
+CLICK_VERSION = importlib.metadata.version("click")
+
+OLDER_CLICK_API = CLICK_VERSION.startswith("8.1.")
+NEWER_CLICK_API = not OLDER_CLICK_API
+
+
+def shim_get_metavar(f: C) -> C:
+    """
+    Make a ParamType.get_metavar function compatible with both the 8.1.x and
+    the 8.2.0+ APIs.
+
+    Under 8.2.0, `ctx: click.Context` is passed, while older versions do not.
+    Therefore, do nothing on 8.2.0+ and pass `ctx=None' if the older click
+    version is in use.
+
+    NOTE: we pass `ctx=None` which violates the declared types (but works at
+    runtime) because when running under older click versions, there may not be
+    a current click context.
+    """
+    if OLDER_CLICK_API:
+
+        @functools.wraps(f)
+        def wrapper(*args: t.Any, **kwargs: t.Any) -> t.Any:
+            return f(*args, **kwargs, ctx=None)
+
+        return wrapper  # type: ignore[return-value]
+
+    return f
+
+
+def shim_get_missing_message(f: C) -> C:
+    """
+    Shim `get_missing_message` in a similar way to `get_metavar` above.
+    """
+    if OLDER_CLICK_API:
+
+        @functools.wraps(f)
+        def wrapper(*args: t.Any, **kwargs: t.Any) -> t.Any:
+            return f(*args, **kwargs, ctx=click.get_current_context())
+
+        return wrapper  # type: ignore[return-value]
+
+    return f

{globus_cli-3.33.1 → globus_cli-3.35.0}/src/globus_cli/commands/api.py

@@ -9,6 +9,7 @@ import click
 import globus_sdk
 
 from globus_cli import termio, version
+from globus_cli._click_compat import shim_get_metavar
 from globus_cli.login_manager import LoginManager, is_client_login
 from globus_cli.login_manager.scopes import CLI_SCOPE_REQUIREMENTS
 from globus_cli.parsing import command, endpoint_id_arg, group, mutex_option_group
@@ -19,7 +20,8 @@ C = t.TypeVar("C", bound=AnyCommand)
 
 
 class QueryParamType(click.ParamType):
-    def get_metavar(self, param: click.Parameter) -> str:
+    @shim_get_metavar
+    def get_metavar(self, param: click.Parameter, ctx: click.Context) -> str:
         return "Key=Value"
 
     def get_type_annotation(self, param: click.Parameter) -> type:
@@ -44,7 +46,8 @@ class QueryParamType(click.ParamType):
 
 
 class HeaderParamType(click.ParamType):
-    def get_metavar(self, param: click.Parameter) -> str:
+    @shim_get_metavar
+    def get_metavar(self, param: click.Parameter, ctx: click.Context) -> str:
         return "Key:Value"
 
     def get_type_annotation(self, param: click.Parameter) -> type:
@@ -134,7 +137,7 @@ def _get_resource_server(service_name: str) -> str:
         "groups": globus_sdk.GroupsClient.resource_server,
         "search": globus_sdk.SearchClient.resource_server,
         "transfer": globus_sdk.TransferClient.resource_server,
-        "timer": globus_sdk.TimerClient.resource_server,
+        "timers": globus_sdk.TimerClient.resource_server,
     }.get(service_name)
     if _resource_server is None:
         raise NotImplementedError(f"unrecognized service: {service_name}")
@@ -154,7 +157,7 @@ def _get_client(
         return login_manager.get_search_client()
     elif service_name == "transfer":
         return login_manager.get_transfer_client()
-    elif service_name == "timer":
+    elif service_name == "timers":
         return login_manager.get_timer_client()
     else:
         raise NotImplementedError(f"unrecognized service: {service_name}")
@@ -167,7 +170,7 @@ def _get_url(service_name: str) -> str:
         "groups": "https://groups.api.globus.org/v2/",
         "search": "https://search.api.globus.org/",
         "transfer": "https://transfer.api.globus.org/v0.10/",
-        "timer": "https://timer.automate.globus.org/",
+        "timers": "https://timer.automate.globus.org/",
         "gcs": "https://$GCS_MANAGER/",
     }[service_name]
 
@@ -356,7 +359,14 @@ def api_command() -> None:
 
 # note: this must be written as a separate call and not inlined into the loop body
 # this ensures that it acts as a closure over 'service_name'
-def build_command(service_name: ServiceNameLiteral | t.Literal["gcs"]) -> click.Command:
+def build_command(
+    command_name: ServiceNameLiteral | t.Literal["gcs", "timer"],
+) -> click.Command:
+    service_name: ServiceNameLiteral | t.Literal["gcs"] = (
+        "timers" if command_name == "timer" else command_name
+    )
+    hidden: bool = command_name == "timer"
+
     helptext = f"""\
 Make API calls to Globus {service_name.title()}
 
@@ -364,14 +374,14 @@ The arguments are an HTTP method name and a path within the service to which the
 should be made. The path will be joined with the known service URL.
 For example, a call of
 
-    globus api {service_name} GET /foo/bar
+    globus api {command_name} GET /foo/bar
 
-sends a 'GET' request to '{_get_url(service_name)}foo/bar'
+sends a 'GET' request to `{_get_url(service_name)}foo/bar`
 """
 
     if service_name != "gcs":
 
-        @command(service_name, help=helptext)
+        @command(command_name, help=helptext, hidden=hidden)
         @LoginManager.requires_login(service_name)
         @_service_command_params
         def service_command(
@@ -457,3 +467,4 @@ for service_name_ in CLI_SCOPE_REQUIREMENTS:
 del service_name_
 
 api_command.add_command(build_command("gcs"))
+api_command.add_command(build_command("timer"))

{globus_cli-3.33.1 → globus_cli-3.35.0}/src/globus_cli/commands/collection/create/guest.py

@@ -17,6 +17,7 @@ from globus_cli.endpointish import EntityType
 from globus_cli.login_manager import LoginManager, MissingLoginError
 from globus_cli.login_manager.context import LoginContext
 from globus_cli.parsing import command, endpointish_params, mutex_option_group
+from globus_cli.parsing.shared_options import activity_notifications_option
 from globus_cli.services.gcs import CustomGCSClient
 from globus_cli.termio import display
 
@@ -42,6 +43,7 @@ from globus_cli.termio import display
 @mutex_option_group("--user-credential-id", "--local-username")
 @endpointish_params.create(name="collection")
 @identity_id_option
+@activity_notifications_option("GCS")
 @click.option(
     "--enable-https/--disable-https",
     "enable_https",
@@ -74,6 +76,7 @@ def collection_create_guest(
     organization: str | None | ExplicitNullType,
     user_message: str | None | ExplicitNullType,
     user_message_link: str | None | ExplicitNullType,
+    activity_notifications: dict[str, list[str]] | None | ExplicitNullType,
     verify: dict[str, bool],
 ) -> None:
     """
@@ -99,6 +102,7 @@ def collection_create_guest(
 
     converted_kwargs: dict[str, t.Any] = ExplicitNullType.nullify_dict(
         {
+            "activity_notification_policy": activity_notifications,
             "collection_base_path": collection_base_path,
             "contact_info": contact_info,
             "contact_email": contact_email,

{globus_cli-3.33.1 → globus_cli-3.35.0}/src/globus_cli/commands/collection/list.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import sys
 import typing as t
 import uuid
 
@@ -11,8 +12,22 @@ from globus_cli.parsing import command, endpoint_id_arg
 from globus_cli.termio import Field, display, formatters
 from globus_cli.utils import PagingWrapper
 
+if sys.version_info >= (3, 10):
+    from typing import TypeAlias
+else:
+    from typing_extensions import TypeAlias
 
-class ChoiceSlugified(click.Choice):
+# until our minimum click version is 8.2.0+ , we need to handle the fact that
+# click.Choice became a generic in 8.2.0
+# we cannot leave it without a defined type parameter, as we have
+# "no-any-generics" set for mypy
+if t.TYPE_CHECKING:
+    ChoiceType: TypeAlias = click.Choice[str]
+else:
+    ChoiceType = click.Choice
+
+
+class ChoiceSlugified(ChoiceType):
     """
     Allow either hyphens or underscores, e.g. both 'mapped-collections' or
     'mapped_collections'

{globus_cli-3.33.1 → globus_cli-3.35.0}/src/globus_cli/commands/collection/update.py

@@ -18,6 +18,7 @@ from globus_cli.parsing import (
     emptyable_opt_list_callback,
     endpointish_params,
 )
+from globus_cli.parsing.shared_options import activity_notifications_option
 from globus_cli.termio import Field, display
 
 _MULTI_USE_OPTION_STR = "Give this option multiple times in a single command"
@@ -33,12 +34,6 @@ class _FullDataField(Field):
 @command("update", short_help="Update a Collection definition.")
 @collection_id_arg
 @endpointish_params.update(name="collection")
-@click.option(
-    "--force-encryption/--no-force-encryption",
-    "force_encryption",
-    default=None,
-    help="When set, all transfers to and from this collection are always encrypted.",
-)
 @click.option(
     "--sharing-restrict-paths",
     type=JSONStringOrFile(null="null"),
@@ -110,10 +105,12 @@ class _FullDataField(Field):
         'Set a value of "" to clear this.'
     ),
 )
+@activity_notifications_option("GCS")
 @LoginManager.requires_login("auth", "transfer")
 def collection_update(
     login_manager: LoginManager,
     *,
+    activity_notifications: dict[str, list[str]] | None | ExplicitNullType,
     collection_id: uuid.UUID,
     display_name: str | None,
     description: str | None | ExplicitNullType,
@@ -181,6 +178,7 @@ def collection_update(
             "user_message_link": user_message_link,
             "sharing_users_allow": sharing_users_allow,
             "sharing_users_deny": sharing_users_deny,
+            "activity_notification_policy": activity_notifications,
         }
     )
     converted_kwargs.update(verify)

{globus_cli-3.33.1 → globus_cli-3.35.0}/src/globus_cli/commands/flows/create.py

@@ -38,6 +38,30 @@ ROLE_TYPES = ("flow_viewer", "flow_starter", "flow_administrator", "flow_owner")
 @starters_option
 @viewers_option
 @keywords_option
+@click.option(
+    "--run-manager",
+    "run_managers",
+    type=str,
+    multiple=True,
+    help="""
+        A principal that may manage the flow's runs.
+
+        This option can be specified multiple times
+        to create a list of run managers.
+    """,
+)
+@click.option(
+    "--run-monitor",
+    "run_monitors",
+    type=str,
+    multiple=True,
+    help="""
+        A principal that may monitor the flow's runs.
+
+        This option can be specified multiple times
+        to create a list of run monitors.
+    """,
+)
 @click.option(
     "--subscription-id",
     help="Set a subscription_id for the flow, marking it as subscription tier.",
@@ -56,6 +80,8 @@ def create_command(
     starters: tuple[str, ...],
     viewers: tuple[str, ...],
     keywords: tuple[str, ...],
+    run_managers: tuple[str, ...],
+    run_monitors: tuple[str, ...],
     subscription_id: uuid.UUID | None,
 ) -> None:
     """
@@ -106,6 +132,8 @@ def create_command(
         flow_starters=list(starters),
         flow_administrators=list(administrators),
         keywords=list(keywords),
+        run_managers=list(run_managers),
+        run_monitors=list(run_monitors),
         subscription_id=subscription_id,
     )
 
@@ -141,6 +169,16 @@ def create_command(
             "flow_starters",
             formatter=formatters.ArrayFormatter(element_formatter=principal_formatter),
         ),
+        Field(
+            "Run Managers",
+            "run_managers",
+            formatter=formatters.ArrayFormatter(element_formatter=principal_formatter),
+        ),
+        Field(
+            "Run Monitors",
+            "run_monitors",
+            formatter=formatters.ArrayFormatter(element_formatter=principal_formatter),
+        ),
     ]
 
     display(res, fields=fields, text_mode=display.RECORD)

{globus_cli-3.33.1 → globus_cli-3.35.0}/src/globus_cli/commands/flows/list.py

@@ -10,7 +10,14 @@ from globus_cli.parsing import ColonDelimitedChoiceTuple, command
 from globus_cli.termio import Field, display, formatters
 from globus_cli.utils import PagingWrapper
 
-ROLE_TYPES = ("flow_viewer", "flow_starter", "flow_administrator", "flow_owner")
+ROLE_TYPES = (
+    "flow_viewer",
+    "flow_starter",
+    "flow_administrator",
+    "flow_owner",
+    "run_manager",
+    "run_monitor",
+)
 ORDER_BY_FIELDS = (
     "id",
     "scope_string",
@@ -29,8 +36,10 @@ ORDER_BY_FIELDS = (
 @command("list")
 @click.option(
     "--filter-role",
+    "filter_roles",
     type=click.Choice(ROLE_TYPES),
     help="Filter results by the flow's role type associated with the caller",
+    multiple=True,
 )
 @click.option(
     "--filter-fulltext",
@@ -71,10 +80,17 @@ ORDER_BY_FIELDS = (
 def list_command(
     login_manager: LoginManager,
     *,
-    filter_role: (
-        t.Literal["flow_viewer", "flow_starter", "flow_administrator", "flow_owner"]
-        | None
-    ),
+    filter_roles: tuple[
+        t.Literal[
+            "flow_viewer",
+            "flow_starter",
+            "flow_administrator",
+            "flow_owner",
+            "run_manager",
+            "run_monitor",
+        ],
+        ...,
+    ],
     orderby: tuple[
         tuple[
             t.Literal[
@@ -98,7 +114,7 @@ def list_command(
     paginator = Paginator.wrap(flows_client.list_flows)
     flow_iterator = PagingWrapper(
         paginator(
-            filter_role=filter_role,
+            filter_roles=filter_roles,  # type: ignore[arg-type]
             filter_fulltext=filter_fulltext,
             orderby=",".join(f"{field} {order}" for field, order in orderby),
         ).items(),

{globus_cli-3.33.1 → globus_cli-3.35.0}/src/globus_cli/commands/flows/run/list.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import typing as t
 import uuid
 
 import click
@@ -10,6 +11,14 @@ from globus_cli.parsing import command
 from globus_cli.termio import Field, display
 from globus_cli.utils import PagingWrapper
 
+ROLE_TYPES = (
+    "run_owner",
+    "run_manager",
+    "run_monitor",
+    "flow_run_manager",
+    "flow_run_monitor",
+)
+
 
 @command("list")
 @click.option(
@@ -22,6 +31,13 @@ from globus_cli.utils import PagingWrapper
     multiple=True,
     type=click.UUID,
 )
+@click.option(
+    "--filter-role",
+    "filter_roles",
+    type=click.Choice(ROLE_TYPES),
+    help="Filter results by the run's role type associated with the caller",
+    multiple=True,
+)
 @click.option(
     "--limit",
     default=25,
@@ -32,7 +48,20 @@ from globus_cli.utils import PagingWrapper
 )
 @LoginManager.requires_login("flows")
 def list_command(
-    login_manager: LoginManager, *, limit: int, filter_flow_id: tuple[uuid.UUID, ...]
+    login_manager: LoginManager,
+    *,
+    limit: int,
+    filter_flow_id: tuple[uuid.UUID, ...],
+    filter_roles: tuple[
+        t.Literal[
+            "run_owner",
+            "run_manager",
+            "run_monitor",
+            "flow_run_manager",
+            "flow_run_monitor",
+        ],
+        ...,
+    ],
 ) -> None:
     """
     List runs.
@@ -45,7 +74,10 @@ def list_command(
 
     paginator = Paginator.wrap(flows_client.list_runs)
     run_iterator = PagingWrapper(
-        paginator(filter_flow_id=filter_flow_id).items(),
+        paginator(
+            filter_flow_id=filter_flow_id,
+            filter_roles=filter_roles,  # type: ignore[arg-type]
+        ).items(),
         json_conversion_key="runs",
         limit=limit,
     )

{globus_cli-3.33.1 → globus_cli-3.35.0}/src/globus_cli/commands/flows/show.py

@@ -20,7 +20,13 @@ def show_command(login_manager: LoginManager, *, flow_id: uuid.UUID) -> None:
     res = flows_client.get_flow(flow_id)
 
     principal_formatter = formatters.auth.PrincipalURNFormatter(auth_client)
-    for principal_set_name in ("flow_administrators", "flow_viewers", "flow_starters"):
+    for principal_set_name in (
+        "flow_administrators",
+        "flow_viewers",
+        "flow_starters",
+        "run_managers",
+        "run_monitors",
+    ):
         for value in res.get(principal_set_name, ()):
             principal_formatter.add_item(value)
     principal_formatter.add_item(res.get("flow_owner"))
@@ -48,6 +54,16 @@ def show_command(login_manager: LoginManager, *, flow_id: uuid.UUID) -> None:
             "flow_starters",
             formatter=formatters.ArrayFormatter(element_formatter=principal_formatter),
         ),
+        Field(
+            "Run Managers",
+            "run_managers",
+            formatter=formatters.ArrayFormatter(element_formatter=principal_formatter),
+        ),
+        Field(
+            "Run Monitors",
+            "run_monitors",
+            formatter=formatters.ArrayFormatter(element_formatter=principal_formatter),
+        ),
     ]
 
     display(res, fields=fields, text_mode=display.RECORD)