globus-cli 3.30.1__tar.gz → 3.32.0__tar.gz

{globus_cli-3.30.1/src/globus_cli.egg-info → globus_cli-3.32.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: globus-cli
-Version: 3.30.1
+Version: 3.32.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.44.0
+Requires-Dist: globus-sdk==3.46.0
 Requires-Dist: click<9,>=8.1.4
 Requires-Dist: jmespath==1.0.1
 Requires-Dist: packaging>=17.0
@@ -29,7 +29,7 @@ Requires-Dist: coverage>=7; extra == "test"
 Requires-Dist: pytest>=7; extra == "test"
 Requires-Dist: pytest-xdist<4; extra == "test"
 Requires-Dist: pytest-timeout<3; extra == "test"
-Requires-Dist: click-type-test==0.0.7; python_version >= "3.10" and extra == "test"
+Requires-Dist: click-type-test==1.0.0; python_version >= "3.10" and extra == "test"
 Requires-Dist: responses==0.25.3; extra == "test"
 Requires-Dist: ruamel.yaml==0.18.6; extra == "test"
 Requires-Dist: setuptools; python_version >= "3.12" and extra == "test"

{globus_cli-3.30.1 → globus_cli-3.32.0}/pyproject.toml

@@ -28,7 +28,7 @@ classifiers = [
 ]
 requires-python = ">=3.8"
 dependencies = [
-    "globus-sdk==3.44.0",
+    "globus-sdk==3.46.0",
     "click>=8.1.4,<9",
     "jmespath==1.0.1",
     "packaging>=17.0",
@@ -48,7 +48,7 @@ test = [
     "pytest>=7",
     "pytest-xdist<4",
     "pytest-timeout<3",
-    "click-type-test==0.0.7;python_version>='3.10'",
+    "click-type-test==1.0.0;python_version>='3.10'",
     "responses==0.25.3",
     # loading test fixture data
     "ruamel.yaml==0.18.6",
@@ -66,7 +66,7 @@ attr = "globus_cli.version.__version__"
 profile = "black"
 
 [tool.pytest.ini_options]
-addopts = "--timeout 3"
+addopts = "--timeout 3 --color=yes"
 filterwarnings = ["error"]
 
 [tool.scriv]
@@ -79,6 +79,7 @@ entry_title_template = '{{ version }} ({{ date.strftime("%Y-%m-%d") }})'
 
 [tool.mypy]
 strict = true
+sqlite_cache = true
 
 # additional settings (not part of strict=true)
 warn_unreachable = true

{globus_cli-3.30.1 → globus_cli-3.32.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.1 → globus_cli-3.32.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.32.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.32.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.32.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.1 → globus_cli-3.32.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.1 → globus_cli-3.32.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.1 → globus_cli-3.32.0}/src/globus_cli/commands/endpoint/user_credential/create/s3.py

@@ -35,7 +35,7 @@ def s3(
     gcs_client = login_manager.get_gcs_client(endpoint_id=endpoint_id)
     auth_client = login_manager.get_auth_client()
 
-    # TODO: replace with SDK class once available
+    # TODO: replace with SDK class if one becomes available
     policies = {
         "DATA_TYPE": "s3_user_credential_policies#1.0.0",
         "s3_key_id": s3_key_id,

{globus_cli-3.30.1 → globus_cli-3.32.0}/src/globus_cli/commands/flows/run/resume.py

@@ -16,9 +16,7 @@ from globus_cli.utils import CLIAuthRequirementsError
 # NB: GARE parsing requires other SDK components and therefore needs to be deferred to
 # avoid the performance impact of non-lazy imports
 if t.TYPE_CHECKING:
-    from globus_sdk.experimental.auth_requirements_error import (
-        GlobusAuthRequirementsError,
-    )
+    from globus_sdk.gare import GARE
 
 
 @command("resume")
@@ -66,7 +64,7 @@ def resume_command(
 def check_inactive_reason(
     login_manager: LoginManager,
     run_id: uuid.UUID,
-    gare: GlobusAuthRequirementsError | None,
+    gare: GARE | None,
 ) -> None:
     if gare is None:
         return
@@ -109,10 +107,8 @@ 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,
-    )
+) -> GARE | None:
+    from globus_sdk.gare import to_gare
 
     if not run_doc.get("status") == "INACTIVE":
         return None
@@ -121,7 +117,7 @@ def _get_inactive_reason(
     if not isinstance(details, dict):
         return None
 
-    return to_auth_requirements_error(details)
+    return to_gare(details)
 
 
 def _has_required_consent(

{globus_cli-3.30.1 → globus_cli-3.32.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.1 → globus_cli-3.32.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.1 → globus_cli-3.32.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.1 → globus_cli-3.32.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.1 → globus_cli-3.32.0}/src/globus_cli/commands/task/show.py

@@ -53,6 +53,9 @@ TRANSFER_FIELDS = [
 SUCCESSFULL_TRANSFER_FIELDS = [
     Field("Source Path", "source_path"),
     Field("Destination Path", "destination_path"),
+    Field("Size", "size"),
+    Field("Checksum Algorithm", "checksum_algorithm"),
+    Field("Checksum", "checksum"),
 ]
 
 SKIPPED_PATHS_FIELDS = [

{globus_cli-3.30.1 → globus_cli-3.32.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
@@ -102,11 +102,22 @@ e.g. '1h30m', '500s', '10d'
     "--delete",
     is_flag=True,
     default=False,
+    hidden=True,
     help=(
         "Delete any files in the destination directory not contained in the source. "
         'This results in "directory mirroring." Only valid on recursive transfers.'
     ),
 )
+@click.option(
+    "--delete-destination-extra",
+    is_flag=True,
+    default=False,
+    help=(
+        "Delete any files in the destination directory not contained in the source. "
+        'This results in "directory mirroring." Only valid on recursive transfers.'
+    ),
+)
+@mutex_option_group("--delete", "--delete-destination-extra")
 @LoginManager.requires_login("auth", "timer", "transfer")
 def transfer_command(
     login_manager: LoginManager,
@@ -122,6 +133,7 @@ def transfer_command(
     stop_after_date: datetime.datetime | None,
     stop_after_runs: int | None,
     delete: bool,
+    delete_destination_extra: bool,
     sync_level: t.Literal["exists", "size", "mtime", "checksum"] | None,
     encrypt_data: bool,
     verify_checksum: bool,
@@ -174,21 +186,30 @@ def transfer_command(
     source_endpoint, cmd_source_path = source
     dest_endpoint, cmd_dest_path = destination
 
-    if recursive is not None:
-        if batch:
-            # avoid 'mutex_option_group', emit a custom error message
-            option_name = "--recursive" if recursive else "--no-recursive"
-            raise click.UsageError(
-                f"You cannot use {option_name} in addition to --batch. "
-                f"Instead, use {option_name} on lines of --batch input which need it."
-            )
+    if delete:
+        msg = (
+            "`--delete` has been deprecated and will be removed in a future release. "
+            "Use `--delete-destination-extra` instead."
+        )
+        click.echo(click.style(msg, fg="yellow"), err=True)
 
-        if delete and not recursive:
-            msg = "The --delete option cannot be specified with --no-recursion."
-            raise click.UsageError(msg)
+    # avoid 'mutex_option_group', emit a custom error message
+    if recursive is not None and batch:
+        option_name = "--recursive" if recursive else "--no-recursive"
+        raise click.UsageError(
+            f"You cannot use `{option_name}` in addition to `--batch`. "
+            f"Instead, use `{option_name}` on lines of `--batch` input which need it."
+        )
+    if recursive is False and (delete_destination_extra or delete):
+        option_name = (
+            "--delete-destination-extra" if delete_destination_extra else "--delete"
+        )
+        raise click.UsageError(
+            f"The `{option_name}` option cannot be specified with `--no-recursive`."
+        )
     if (cmd_source_path is None or cmd_dest_path is None) and (not batch):
         raise click.UsageError(
-            "transfer requires either SOURCE_PATH and DEST_PATH or --batch"
+            "Transfer requires either `SOURCE_PATH` and `DEST_PATH` or `--batch`"
         )
 
     # Interval must be null iff the timer is 'once', i.e. stop-after-runs == 1.
@@ -197,12 +218,12 @@ def transfer_command(
     start_ = resolve_optional_local_time(start)
     if stop_after_runs == 1:
         if interval is not None:
-            raise click.UsageError("'--interval' is invalid with `--stop-after-runs=1`")
+            raise click.UsageError("`--interval` is invalid with `--stop-after-runs=1`")
         schedule = globus_sdk.OnceTimerSchedule(datetime=start_)
     else:
         if interval is None:
             raise click.UsageError(
-                "'--interval' is required unless `--stop-after-runs=1`"
+                "`--interval` is required unless `--stop-after-runs=1`"
             )
 
         end: dict[str, t.Any] | globus_sdk.MissingType = globus_sdk.MISSING
@@ -278,7 +299,7 @@ def transfer_command(
         encrypt_data=encrypt_data,
         skip_source_errors=skip_source_errors,
         fail_on_quota_errors=fail_on_quota_errors,
-        delete_destination_extra=delete,
+        delete_destination_extra=(delete or delete_destination_extra),
         # mypy can't understand kwargs expansion very well
         **notify,  # type: ignore[arg-type]
     )
@@ -314,14 +335,13 @@ 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:
         target_scope = GCSCollectionScopeBuilder(target).data_access
         scopes_needed[target] = _ez_make_nested_scope(
             globus_sdk.TimerClient.scopes.timer,
-            "https://auth.globus.org/scopes/actions.globus.org/transfer/transfer",
             globus_sdk.TransferClient.scopes.all,
             target_scope,
         )
@@ -330,7 +350,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 +370,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.1 → globus_cli-3.32.0}/src/globus_cli/commands/timer/resume.py

@@ -16,9 +16,7 @@ from globus_cli.utils import CLIAuthRequirementsError
 # NB: GARE parsing requires other SDK components and therefore needs to be deferred to
 # avoid the performance impact of non-lazy imports
 if t.TYPE_CHECKING:
-    from globus_sdk.experimental.auth_requirements_error import (
-        GlobusAuthRequirementsError,
-    )
+    from globus_sdk.gare import GARE
 
 
 @command("resume", short_help="Resume a timer.")
@@ -59,7 +57,7 @@ def resume_command(
 def check_inactive_reason(
     login_manager: LoginManager,
     timer_id: uuid.UUID,
-    gare: GlobusAuthRequirementsError | None,
+    gare: GARE | None,
 ) -> None:
     if gare is None:
         return
@@ -102,10 +100,8 @@ 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,
-    )
+) -> GARE | None:
+    from globus_sdk.gare import to_gare
 
     if timer_doc.get("status") != "inactive":
         return None
@@ -114,7 +110,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", {}))
 
 
 def _has_required_consent(