globus-cli 3.30.0__tar.gz → 3.31.0__tar.gz

{globus_cli-3.30.0/src/globus_cli.egg-info → globus_cli-3.31.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: globus-cli
-Version: 3.30.0
+Version: 3.31.0
 Summary: Globus CLI
 Author-email: Stephen Rosen <sirosen@globus.org>
 Project-URL: homepage, https://github.com/globus/globus-cli
@@ -18,7 +18,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: globus-sdk==3.43.0
+Requires-Dist: globus-sdk==3.45.0
 Requires-Dist: click<9,>=8.1.4
 Requires-Dist: jmespath==1.0.1
 Requires-Dist: packaging>=17.0

{globus_cli-3.30.0 → globus_cli-3.31.0}/pyproject.toml

@@ -28,7 +28,7 @@ classifiers = [
 ]
 requires-python = ">=3.8"
 dependencies = [
-    "globus-sdk==3.43.0",
+    "globus-sdk==3.45.0",
     "click>=8.1.4,<9",
     "jmespath==1.0.1",
     "packaging>=17.0",

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/collection/create/guest.py

@@ -5,7 +5,6 @@ import uuid
 
 import click
 import globus_sdk
-import globus_sdk.experimental.auth_requirements_error
 
 from globus_cli.commands.collection._common import (
     LazyCurrentIdentity,

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/collection/update.py

@@ -37,14 +37,14 @@ class _FullDataField(Field):
     "--force-encryption/--no-force-encryption",
     "force_encryption",
     default=None,
-    help="When set, all transfers to and from this collection are always encrypted",
+    help="When set, all transfers to and from this collection are always encrypted.",
 )
 @click.option(
     "--sharing-restrict-paths",
     type=JSONStringOrFile(null="null"),
     help=(
         "Path restrictions for sharing data on guest collections "
-        "based on this collection. This option is only usable on Mapped Collections"
+        "based on this collection. This option is only usable on Mapped Collections."
     ),
 )
 @click.option(
@@ -55,7 +55,7 @@ class _FullDataField(Field):
         "Allow Guest Collections to be created on this Collection. This option "
         "is only usable on Mapped Collections. If this option is disabled on a "
         "Mapped Collection which already has associated Guest Collections, "
-        "those collections will no longer be accessible"
+        "those collections will no longer be accessible."
     ),
 )
 @click.option(
@@ -66,7 +66,7 @@ class _FullDataField(Field):
         "Mapped Collection. This option is only usable on non high assurance "
         "Mapped Collections and the setting is inherited by the hosted Guest "
         "Collections. Anonymous write ACLs are enabled by default "
-        "(requires an endpoint with API v1.8.0)"
+        "(requires an endpoint with API v1.8.0)."
     ),
 )
 @click.option(
@@ -74,10 +74,9 @@ class _FullDataField(Field):
     "domain_name",
     default=None,
     help=(
-        "DNS host name for the collection (mapped "
-        "collections only). This may be either a host name "
-        "or a fully-qualified domain name, but if it is the latter "
-        "it must be a subdomain of the endpoint's domain"
+        "DNS host name for the collection (mapped collections only). "
+        "This may be either a host name or a fully-qualified domain name, "
+        "but if it is the latter it must be a subdomain of the endpoint's domain."
     ),
 )
 @click.option(
@@ -85,8 +84,8 @@ class _FullDataField(Field):
     "enable_https",
     default=None,
     help=(
-        "Explicitly enable or disable  HTTPS support (requires a managed endpoint "
-        "with API v1.1.0)"
+        "Explicitly enable or disable HTTPS support "
+        "(requires a managed endpoint with API v1.1.0)."
     ),
 )
 @click.option(
@@ -95,9 +94,9 @@ class _FullDataField(Field):
     multiple=True,
     callback=emptyable_opt_list_callback,
     help=(
-        "Connector-specific username allowed to create guest collections."
+        "Connector-specific username allowed to create guest collections. "
         f"{_MULTI_USE_OPTION_STR} to allow multiple users. "
-        'Set a value of "" to clear this'
+        'Set a value of "" to clear this.'
     ),
 )
 @click.option(
@@ -106,9 +105,9 @@ class _FullDataField(Field):
     multiple=True,
     callback=emptyable_opt_list_callback,
     help=(
-        "Connector-specific username denied permission to create guest "
-        f"collections. {_MULTI_USE_OPTION_STR} to deny multiple users. "
-        'Set a value of "" to clear this'
+        "Connector-specific username denied permission to create guest collections. "
+        f"{_MULTI_USE_OPTION_STR} to deny multiple users. "
+        'Set a value of "" to clear this.'
     ),
 )
 @LoginManager.requires_login("auth", "transfer")

globus_cli-3.31.0/src/globus_cli/commands/endpoint/activate.py

@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+import uuid
+
+import click
+
+from globus_cli.parsing import command, endpoint_id_arg, mutex_option_group
+
+
+@command("activate", deprecated=True, hidden=True)
+@endpoint_id_arg
+@click.option("--web", is_flag=True, default=False)
+@click.option("--no-browser", is_flag=True, default=False)
+@click.option("--myproxy", is_flag=True, default=False)
+@click.option("--myproxy-username", "-U")
+@click.option("--myproxy-password", "-P", hidden=True)
+@click.option("--myproxy-lifetime", type=int)
+@click.option("--no-autoactivate", is_flag=True, default=False)
+@click.option("--force", is_flag=True, default=False)
+@mutex_option_group("--web", "--myproxy")
+def endpoint_activate(
+    *,
+    endpoint_id: uuid.UUID,
+    myproxy: bool,
+    myproxy_username: str | None,
+    myproxy_password: str | None,
+    myproxy_lifetime: int | None,
+    web: bool,
+    no_browser: bool,
+    no_autoactivate: bool,
+    force: bool,
+) -> None:
+    """
+    Activate an endpoint.
+
+    Endpoint Activation has been removed from the Globus ecosystem. This command
+    no longer does anything.
+    """
+    click.echo(
+        click.style(
+            "`globus endpoint activate` has been deprecated and "
+            "will be removed in a future release.",
+            fg="yellow",
+        ),
+        err=True,
+    )

globus_cli-3.31.0/src/globus_cli/commands/endpoint/deactivate.py

@@ -0,0 +1,24 @@
+import uuid
+
+import click
+
+from globus_cli.parsing import command, endpoint_id_arg
+
+
+@command("deactivate", deprecated=True, hidden=True)
+@endpoint_id_arg
+def endpoint_deactivate(*, endpoint_id: uuid.UUID) -> None:
+    """
+    Deactivate an endpoint.
+
+    Endpoint Activation has been removed from the Globus ecosystem. This command
+    no longer does anything.
+    """
+    click.echo(
+        click.style(
+            "`globus endpoint deactivate` has been deprecated and "
+            "will be removed in a future release.",
+            fg="yellow",
+        ),
+        err=True,
+    )

globus_cli-3.31.0/src/globus_cli/commands/endpoint/is_activated.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+import uuid
+
+import click
+
+from globus_cli.parsing import command, endpoint_id_arg
+
+
+@command("is-activated", deprecated=True, hidden=True)
+@endpoint_id_arg
+@click.option("--until", type=int)
+@click.option("--absolute-time", is_flag=True, show_default=True, default=False)
+def endpoint_is_activated(
+    *,
+    endpoint_id: uuid.UUID,
+    until: int | None,
+    absolute_time: bool,
+) -> None:
+    """
+    Check if an endpoint is activated or requires activation.
+
+    Endpoint Activation has been removed from the Globus ecosystem. This command
+    no longer does anything.
+    """
+    click.echo(
+        click.style(
+            "`globus endpoint is-activated` has been deprecated and "
+            "will be removed in a future release.",
+            fg="yellow",
+        ),
+        err=True,
+    )

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/endpoint/set_subscription_id.py

@@ -40,10 +40,11 @@ def set_endpoint_subscription_id(
     login_manager: LoginManager, *, endpoint_id: uuid.UUID, subscription_id: str
 ) -> None:
     """
-    For GCS endpoints, refer to ``globus gcs endpoint set-subscription-id``. For
-    GCP endpoints, refer to ``globus gcp set-subscription-id``.
-
-    -----------------------------
+    [NOTE]
+    ====
+    For GCS endpoints, refer to ``globus gcs endpoint set-subscription-id``.
+    For GCP endpoints, refer to ``globus gcp set-subscription-id``.
+    ====
 
     Set an endpoint's subscription ID.
 

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/endpoint/show.py

@@ -12,7 +12,6 @@ STANDARD_FIELDS = [
     Field("ID", "id"),
     Field("Owner", "owner_string"),
     Field("Description", "description", wrap_enabled=True),
-    Field("Activated", "activated"),
     Field("Shareable", "shareable"),
     Field("Department", "department"),
     Field("Keywords", "keywords"),

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/flows/run/resume.py

@@ -110,9 +110,12 @@ def check_inactive_reason(
 def _get_inactive_reason(
     run_doc: dict[str, t.Any] | globus_sdk.GlobusHTTPResponse
 ) -> GlobusAuthRequirementsError | None:
-    from globus_sdk.experimental.auth_requirements_error import (
-        to_auth_requirements_error,
-    )
+    try:
+        from globus_sdk.gare import to_gare  # type: ignore[import-not-found]
+    except ImportError:
+        from globus_sdk.experimental.auth_requirements_error import (
+            to_auth_requirements_error as to_gare,
+        )
 
     if not run_doc.get("status") == "INACTIVE":
         return None
@@ -121,7 +124,7 @@ def _get_inactive_reason(
     if not isinstance(details, dict):
         return None
 
-    return to_auth_requirements_error(details)
+    return to_gare(details)  # type: ignore[no-any-return]
 
 
 def _has_required_consent(

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/group/_common.py

@@ -64,6 +64,7 @@ _BASE_GROUP_RECORD_FIELDS = [
         "my_memberships[].role",
         formatter=formatters.SortedArray,
     ),
+    Field("Terms and Conditions", "terms_and_conditions", wrap_enabled=True),
 ]
 GROUP_FIELDS = [Field("Group ID", "id")] + _BASE_GROUP_RECORD_FIELDS
 GROUP_FIELDS_W_SUBSCRIPTION = (

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/group/update.py

@@ -15,6 +15,9 @@ from ._common import group_id_arg
 @group_id_arg
 @click.option("--name", help="Name for the group")
 @click.option("--description", help="Description for the group")
+@click.option(
+    "--terms-and-conditions", help="Terms and conditions for group membership"
+)
 @LoginManager.requires_login("groups")
 def group_update(
     login_manager: LoginManager,
@@ -22,6 +25,7 @@ def group_update(
     group_id: uuid.UUID,
     name: str | None,
     description: str | None,
+    terms_and_conditions: str | None,
 ) -> None:
     """Update an existing group."""
     groups_client = login_manager.get_groups_client()
@@ -30,10 +34,14 @@ def group_update(
     group = groups_client.get_group(group_id)
 
     # assemble put data using existing values for any field not given
-    # note that the API does not accept the full group document, so we must
-    # specify name and description instead of just iterating kwargs
+    # note that the API only allows modification of certain fields
+    #   https://groups.api.globus.org/redoc#tag/groups/operation/update_group_v2_groups__group_id__put
     data = {}
-    for attrname, argval in (("name", name), ("description", description)):
+    for attrname, argval in (
+        ("name", name),
+        ("description", description),
+        ("terms_and_conditions", terms_and_conditions),
+    ):
         if argval is not None:
             data[attrname] = argval
         else:

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/list_commands.py

@@ -42,12 +42,7 @@ def _print_tree(
 def list_commands() -> None:
     """
     Prints the name and a short description of every command available in the globus
-    cli. Commands are grouped by their parent commands,
-    e.g. 'globus endpoint activate' is listed as 'activate' under 'globus endpoint'.
-
-    Note that commands with the same listed name under different parent commands
-    are distinct. e.g. 'globus task update' is a distinct command from
-    'globus endpoint update'.
+    cli. Commands are grouped by their parent commands.
     """
     # get the root context (the click context for the entire CLI tree)
     root_ctx = click.get_current_context().find_root()

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/logout.py

@@ -54,8 +54,14 @@ flow.
     is_flag=True,
     default=False,
 )
+@click.option("--delete-client", is_flag=True, hidden=True)
 @LoginManager.requires_login()
-def logout_command(login_manager: LoginManager, *, ignore_errors: bool) -> None:
+def logout_command(
+    login_manager: LoginManager,
+    *,
+    ignore_errors: bool,
+    delete_client: bool,
+) -> None:
     """
     Logout of the Globus CLI
 
@@ -89,10 +95,15 @@ def logout_command(login_manager: LoginManager, *, ignore_errors: bool) -> None:
             "Logging out of Globus{}\n".format(" as " + username if username else "")
         )
 
-    # first, try to delete the templated credentialed client
-    # ignore failure (maybe creds are already invalidated or the client was deleted)
-    # client logins don't do this as they don't use a templated client
-    if not is_client_login():
+    # By default, preserve the templated client to avoid revocation of associated
+    # consents (which can cause refresh token revocation, causing resources
+    # associated with those tokens to become inoperable)
+    # If the user has specifically requested a client deletion via hidden option,
+    # then try to delete the templated credentialed client
+    # ignoring failure by default (maybe creds are already invalidated or the
+    # client was deleted)
+    # Always skip for client logins, which don't use a templated client
+    if delete_client and not is_client_login():
         try:
             delete_templated_client()
         except globus_sdk.AuthAPIError:
@@ -108,13 +119,9 @@ def logout_command(login_manager: LoginManager, *, ignore_errors: bool) -> None:
                     "Continuing... (--ignore-errors)",
                 )
 
-    # because the client was deleted above, the tokens should all be revoked
-    # but it could have been the `--ignore-errors` case, so take a shot at revoking
-    # tokens
-    # use the native client for this purpose so that we definitely have a valid API
-    # client in this case
+    # Attempt to revoke all tokens in storage; use the internal native client to ensure
+    # we have a valid Auth client
     native_client = internal_native_client()
-
     adapter = token_storage_adapter()
 
     for rs, tokendata in adapter.get_by_resource_server().items():

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/search/index/delete.py

@@ -1,14 +1,16 @@
-import click
+import uuid
 
 from globus_cli.login_manager import LoginManager
 from globus_cli.parsing import command
 from globus_cli.termio import display
 
+from .._common import index_id_arg
+
 
 @command("delete")
 @LoginManager.requires_login("search")
-@click.argument("INDEX_ID")
-def delete_command(login_manager: LoginManager, *, index_id: str) -> None:
+@index_id_arg
+def delete_command(login_manager: LoginManager, *, index_id: uuid.UUID) -> None:
     """Delete a Search index."""
     search_client = login_manager.get_search_client()
     display(

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/session/consent.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import click
-from globus_sdk.scopes import MutableScope
+from globus_sdk.scopes import Scope
 
 from globus_cli import utils
 from globus_cli.login_manager import LoginManager, compute_timer_scope
@@ -36,7 +36,7 @@ def session_consent(
     This command is necessary when the CLI needs access to resources which require the
     user to explicitly consent to access.
     """
-    scope_list: list[str | MutableScope] = [
+    scope_list: list[str | Scope] = [
         utils.unquote_cmdprompt_single_quotes(s) for s in scopes
     ]
 

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/timer/create/transfer.py

@@ -6,7 +6,7 @@ import uuid
 
 import click
 import globus_sdk
-from globus_sdk.scopes import GCSCollectionScopeBuilder, MutableScope
+from globus_sdk.scopes import GCSCollectionScopeBuilder, Scope
 
 from globus_cli.endpointish import Endpointish
 from globus_cli.login_manager import LoginManager, is_client_login
@@ -314,7 +314,7 @@ def resolve_optional_local_time(
 
 def _derive_needed_scopes(
     needs_data_access: list[str],
-) -> dict[str, MutableScope]:
+) -> dict[str, Scope]:
     # Render the fully nested scope strings for each target
     scopes_needed = {}
     for target in needs_data_access:
@@ -330,7 +330,7 @@ def _derive_needed_scopes(
 
 def _derive_missing_scopes(
     auth_client: CustomAuthClient,
-    scopes_needed: dict[str, MutableScope],
+    scopes_needed: dict[str, Scope],
 ) -> list[str]:
     # read the identity ID stored from the login flow
     user_identity_id = get_current_identity_id()
@@ -350,8 +350,8 @@ def _derive_missing_scopes(
 
 
 # shorthand helper for constructing a nested scope
-def _ez_make_nested_scope(*scope_strings: str) -> MutableScope:
-    current_node = MutableScope(scope_strings[-1])
+def _ez_make_nested_scope(*scope_strings: str) -> Scope:
+    current_node = Scope(scope_strings[-1])
     for current_scope in scope_strings[-2::-1]:
-        current_node = MutableScope(current_scope, dependencies=[current_node])
+        current_node = Scope(current_scope, dependencies=[current_node])
     return current_node

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/commands/timer/resume.py

@@ -103,9 +103,12 @@ def check_inactive_reason(
 def _get_inactive_reason(
     timer_doc: dict[str, t.Any] | globus_sdk.GlobusHTTPResponse
 ) -> GlobusAuthRequirementsError | None:
-    from globus_sdk.experimental.auth_requirements_error import (
-        to_auth_requirements_error,
-    )
+    try:
+        from globus_sdk.gare import to_gare  # type: ignore[import-not-found]
+    except ImportError:
+        from globus_sdk.experimental.auth_requirements_error import (
+            to_auth_requirements_error as to_gare,
+        )
 
     if timer_doc.get("status") != "inactive":
         return None
@@ -114,7 +117,7 @@ def _get_inactive_reason(
     if reason.get("cause") != "globus_auth_requirements":
         return None
 
-    return to_auth_requirements_error(reason.get("detail", {}))
+    return to_gare(reason.get("detail", {}))  # type: ignore[no-any-return]
 
 
 def _has_required_consent(

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/login_manager/auth_flows.py

@@ -6,7 +6,7 @@ import typing as t
 
 import click
 import globus_sdk
-from globus_sdk.scopes import MutableScope
+from globus_sdk.scopes import Scope
 
 from .tokenstore import (
     internal_auth_client,
@@ -17,7 +17,7 @@ from .tokenstore import (
 
 
 def do_link_auth_flow(
-    scopes: str | t.Sequence[str | MutableScope],
+    scopes: str | t.Sequence[str | Scope],
     *,
     session_params: dict[str, str] | None = None,
 ) -> bool:
@@ -58,7 +58,7 @@ def do_link_auth_flow(
 
 
 def do_local_server_auth_flow(
-    scopes: str | t.Sequence[str | MutableScope],
+    scopes: str | t.Sequence[str | Scope],
     *,
     session_params: dict[str, str] | None = None,
 ) -> bool:

{globus_cli-3.30.0 → globus_cli-3.31.0}/src/globus_cli/login_manager/manager.py

@@ -7,20 +7,26 @@ import uuid
 
 import click
 import globus_sdk
-from globus_sdk.experimental.consents import ConsentForest
-from globus_sdk.experimental.scope_parser import Scope
 from globus_sdk.scopes import (
     AuthScopes,
     FlowsScopes,
     GCSCollectionScopeBuilder,
     GCSEndpointScopeBuilder,
     GroupsScopes,
-    MutableScope,
+    Scope,
     SearchScopes,
-    TimerScopes,
+    TimersScopes,
     TransferScopes,
 )
 
+# TODO: remove this after an SDK release provides scopes.consents
+try:
+    from globus_sdk.scopes.consents import (  # type: ignore[import-not-found]
+        ConsentForest,
+    )
+except ImportError:
+    from globus_sdk.experimental.consents import ConsentForest
+
 from globus_cli.endpointish import Endpointish, EntityType
 from globus_cli.types import ServiceNameLiteral
 
@@ -54,21 +60,19 @@ R = t.TypeVar("R")
 class LoginManager:
     def __init__(self) -> None:
         self._token_storage = token_storage_adapter()
-        self._nonstatic_requirements: dict[str, list[str | MutableScope]] = {}
+        self._nonstatic_requirements: dict[str, list[str | Scope]] = {}
 
-    def add_requirement(
-        self, rs_name: str, scopes: t.Sequence[str | MutableScope]
-    ) -> None:
+    def add_requirement(self, rs_name: str, scopes: t.Sequence[str | Scope]) -> None:
         self._nonstatic_requirements[rs_name] = list(scopes)
 
     @property
-    def login_requirements(self) -> t.Iterator[tuple[str, list[str | MutableScope]]]:
+    def login_requirements(self) -> t.Iterator[tuple[str, list[str | Scope]]]:
         for req in CLI_SCOPE_REQUIREMENTS.values():
             yield req["resource_server"], req["scopes"]
         yield from self._nonstatic_requirements.items()
 
     @property
-    def always_required_scopes(self) -> t.Iterator[str | MutableScope]:
+    def always_required_scopes(self) -> t.Iterator[str | Scope]:
         """
         scopes which are required on all login flows, regardless of the specified
         scopes for that flow
@@ -179,7 +183,9 @@ class LoginManager:
         else:
             # If there are dependent scopes all required scope paths are present in the
             #   user's cached consent forest.
-            return self._cached_consent_forest.meets_scope_requirements(required_scopes)
+            return (  # type: ignore[no-any-return]
+                self._cached_consent_forest.meets_scope_requirements(required_scopes)
+            )
 
     @property
     @functools.lru_cache(maxsize=1)  # noqa: B019
@@ -195,7 +201,7 @@ class LoginManager:
         local_server_message: str | None = None,
         epilog: str | None = None,
         session_params: dict[str, str] | None = None,
-        scopes: list[str | MutableScope] | None = None,
+        scopes: list[str | Scope] | None = None,
     ) -> None:
         if is_client_login():
             click.echo(
@@ -371,7 +377,7 @@ class LoginManager:
         return globus_sdk.SearchClient(authorizer=authorizer, app_name=version.app_name)
 
     def get_timer_client(self) -> globus_sdk.TimerClient:
-        authorizer = self._get_client_authorizer(TimerScopes.resource_server)
+        authorizer = self._get_client_authorizer(TimersScopes.resource_server)
         return globus_sdk.TimerClient(authorizer=authorizer, app_name=version.app_name)
 
     def _get_gcs_info(
@@ -455,7 +461,7 @@ class LoginManager:
 
         if not include_data_access:
             # Just require an endpoint:manage_collections scope
-            scope = GCSEndpointScopeBuilder(gcs_id).make_mutable("manage_collections")
+            scope = Scope(GCSEndpointScopeBuilder(gcs_id).manage_collections)
             login_context = LoginContext(
                 login_command=f"globus login --gcs {gcs_id}",
                 error_message="Missing 'manage_collections' consent on an endpoint.",
@@ -463,7 +469,7 @@ class LoginManager:
         else:
             # Require an endpoint:manage_collections scope with a dependent
             #   collection[data_access] scope
-            scope = GCSEndpointScopeBuilder(gcs_id).make_mutable("manage_collections")
+            scope = Scope(GCSEndpointScopeBuilder(gcs_id).manage_collections)
             data_access = GCSCollectionScopeBuilder(str(collection_id)).data_access
             scope.add_dependency(data_access)