rucio-clients 35.7.0__py3-none-any.whl → 37.0.0rc2__py3-none-any.whl

rucio/cli/command.py

@@ -0,0 +1,272 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import importlib
+import signal
+import time
+
+import click
+from rich.console import Console
+from rich.status import Status
+from rich.theme import Theme
+from rich.traceback import install
+
+from rucio import version
+from rucio.cli.bin_legacy.rucio import ping, test_server, whoami_account
+from rucio.cli.utils import Arguments, exception_handler, get_client, setup_gfal2_logger, signal_handler
+from rucio.client.richclient import MAX_TRACEBACK_WIDTH, MIN_CONSOLE_WIDTH, CLITheme, get_cli_config, get_pager, setup_rich_logger
+from rucio.common.utils import setup_logger
+
+
+# Taken directly from https://click.palletsprojects.com/en/stable/complex/#defining-the-lazy-group
+class LazyGroup(click.Group):
+    def __init__(self, *args, lazy_subcommands=None, **kwargs):
+        super().__init__(*args, **kwargs)
+        # lazy_subcommands is a map of the form:
+        #
+        #   {command-name} -> {module-name}.{command-object-name}
+        #
+        self.lazy_subcommands = lazy_subcommands or {}
+
+    def list_commands(self, ctx):
+        base = super().list_commands(ctx)
+        lazy = sorted(self.lazy_subcommands.keys())
+        return base + lazy
+
+    def get_command(self, ctx, cmd_name):
+        if cmd_name in self.lazy_subcommands:
+            return self._lazy_load(cmd_name)
+        return super().get_command(ctx, cmd_name)
+
+    def _lazy_load(self, cmd_name):
+        # lazily loading a command, first get the module name and attribute name
+        import_path = self.lazy_subcommands[cmd_name]
+        modname, cmd_object_name = import_path.rsplit(".", 1)
+        # do the import
+        mod = importlib.import_module(modname)
+        # get the Command object from that module
+        cmd_object = getattr(mod, cmd_object_name)
+        # check the result to make debugging easier
+        if not isinstance(cmd_object, click.BaseCommand):
+            raise ValueError(f"Lazy loading of {import_path} failed by returning " "a non-command object")
+        return cmd_object
+
+
+@click.group(
+    cls=LazyGroup,
+    lazy_subcommands={
+        "account": "rucio.cli.account.account",
+        "config": "rucio.cli.config.config",
+        "did": "rucio.cli.did.did",
+        "download": "rucio.cli.download.download",
+        "lifetime-exception": "rucio.cli.lifetime_exception.lifetime_exception",
+        "replica": "rucio.cli.replica.replica",
+        "rse": "rucio.cli.rse.rse",
+        "rule": "rucio.cli.rule.rule",
+        "scope": "rucio.cli.scope.scope",
+        "subscription": "rucio.cli.subscription.subscription",
+        "upload": "rucio.cli.upload.upload_command",
+    },
+    context_settings={"help_option_names": ["-h", "--help"]}
+)  # TODO: Implement https://click.palletsprojects.com/en/stable/options/#dynamic-defaults-for-prompts for args from config or os
+@click.option("--account", "--issuer", "issuer", help="Rucio account to use.")
+@click.option("--auth-host", help="The Rucio Authentication host")
+@click.option("-S", "--auth-strategy", help="Authentication strategy", type=click.Choice(['userpass', 'x509', 'x509_proxy', 'gss', 'ssh', 'saml', 'oidc']))
+# x509 and x509 proxy auth
+@click.option("--ca-certificate", help="CA certificate to verify peer against (SSL)")
+@click.option("--certificate", help="Client certificate file")
+@click.option("--client-key", help="Client key for x509 Authentication")
+@click.option("--config", help="The Rucio configuration file to use")
+@click.option("-H", "--host", help="The Rucio API host")
+# oidc auth
+@click.option("--oidc-user", help="OIDC username")
+@click.option("--oidc-password", help="OIDC password")
+@click.option("--oidc-audience", help="Defines which audience are tokens requested for.")
+@click.option(
+    "--oidc-auto",
+    is_flag=True,
+    default=False,
+    help="""
+        If not specified, username and password credentials are not required and users will be given a URL to use in their browser.
+        If specified, the users explicitly trust Rucio with their IdP credentials"
+    """,
+)
+@click.option(
+    "--oidc-issuer",
+    help="""
+        Defines which Identity Provider is going to be used.
+        The issuer string must correspond to the keys configured in the /etc/idpsecrets.json auth server configuration file")
+    """,
+)
+@click.option(
+    "--oidc-polling",
+    is_flag=True,
+    default=False,
+    help="""
+        If not specified, user will be asked to enter a code returned by the browser to the command line.
+        If --polling is set, Rucio Client should get the token without any further interaction of the user.
+        This option is active only if --auto is *not* specified
+    """,
+)
+@click.option(
+    "--oidc-refresh-lifetime",
+    help="""
+        Max lifetime in hours for this access token; the token will be refreshed by an asynchronous Rucio daemon.
+        If not specified, refresh will be stopped after 4 days.
+        This option is effective only if --oidc-scope includes offline_access scope for a refresh token to be granted to Rucio
+    """,
+)
+@click.option(
+    "--oidc-scope",
+    default="openid profile",
+    help="""
+        Defines which (OIDC) information user will share with Rucio. Rucio requires at least -sc='openid profile'.
+        To request refresh token for Rucio, scope must include 'openid offline_access'
+        and there must be no active access token saved on the side of the currently used Rucio Client,
+    """,
+)
+@click.option("-T", "--timeout", type=float, help="Set all timeout values to seconds")
+@click.option("-U", "--user-agent", default="rucio-clients", help="Rucio User Agent")
+# userpass/gss/saml auth
+@click.option("-u", "--user", help="Username for userpass")
+@click.option("--password", help="Password for userpass")
+@click.option("--vo", help="VO to authenticate at. Only used in multi-VO mode")
+@click.option("-v", "--verbose", default=False, is_flag=True, help="Print more verbose output")
+@click.version_option(version.version_string(), message="%(prog)s %(version)s")
+# Hidden options at the end
+@click.option("--pager", is_flag=True, default=False, hidden=True)
+@exception_handler
+@click.pass_context
+def main(
+    ctx,
+    config,
+    verbose,
+    host,
+    auth_host,
+    issuer,
+    auth_strategy,
+    timeout,
+    user_agent,
+    vo,
+    pager,
+    user,
+    password,
+    oidc_user,
+    oidc_password,
+    oidc_scope,
+    oidc_audience,
+    oidc_auto,
+    oidc_polling,
+    oidc_refresh_lifetime,
+    oidc_issuer,
+    certificate,
+    client_key,
+    ca_certificate,
+):
+    ctx.ensure_object(Arguments)
+    ctx.obj.start_time = time.time()
+
+    ctx.obj.no_pager = not pager
+    pager = get_pager()
+    use_rich = get_cli_config() == "rich"
+
+    console = Console(theme=Theme(CLITheme.LOG_THEMES), soft_wrap=True)
+    console.width = max(MIN_CONSOLE_WIDTH, console.width)
+    spinner = Status("Initializing spinner", spinner=CLITheme.SPINNER, spinner_style=CLITheme.SPINNER_STYLE, console=console)
+
+    ctx.obj.use_rich = use_rich
+    ctx.obj.spinner = spinner
+    ctx.obj.console = console
+    ctx.obj.pager = pager
+
+    if use_rich:
+        install(console=console, word_wrap=True, width=min(console.width, MAX_TRACEBACK_WIDTH))  # Make rich exception tracebacks the default.
+        logger = setup_rich_logger(module_name=__name__, logger_name="user", verbose=verbose, console=console)
+    else:
+        logger = setup_logger(module_name=__name__, logger_name="user", verbose=verbose)
+    args = Arguments(
+        {
+            "config": config,
+            "host": host,
+            "isser": issuer,
+            "auth_host": auth_host,
+            "auth_strategy": auth_strategy,
+            "timeout": timeout,
+            "user_agent": user_agent,
+            "VO": vo,
+            "username": user,
+            "password": password,
+            "oidc_username": oidc_user,
+            "oidc_password": oidc_password,
+            "oidc_scope": oidc_scope,
+            "oidc_audience": oidc_audience,
+            "oidc_auto": oidc_auto,
+            "oidc_polling": oidc_polling,
+            "oidc_refresh_lifetime": oidc_refresh_lifetime,
+            "oidc_issuer": oidc_issuer,
+            "certificate": certificate,
+            "client_key": client_key,
+            "ca_certificate": ca_certificate,
+        }
+    )  # TODO Future improvement - change `get_client` to take these args directly
+    client = get_client(args, logger)  # TODO Future improvement - use envvar functionality in click to remove conditionals checking env vars
+
+    setup_gfal2_logger()
+    signal.signal(signal.SIGINT, lambda sig, frame: signal_handler(sig, frame, logger))
+
+    ctx.obj.client = client
+    ctx.obj.logger = logger
+
+    ctx.call_on_close(_teardown)
+
+
+@click.pass_context
+def _teardown(ctx):
+    time_elapsed = time.time() - ctx.obj.start_time
+
+    if ctx.obj.use_rich:
+        ctx.obj.spinner.stop()
+    if ctx.obj.console.is_terminal and not ctx.obj.no_pager:
+        command_output = ctx.obj.console.end_capture()
+        if command_output == "" and ctx.obj.verbose:
+            print("Completed in %-0.4f sec." % (time_elapsed))
+        else:
+            if ctx.obj.verbose:
+                command_output += "Completed in %-0.4f sec." % (time_elapsed)
+            # Ignore SIGINT during pager execution.
+            signal.signal(signal.SIGINT, signal.SIG_IGN)
+            ctx.obj.pager(command_output)
+    else:
+        if ctx.obj.verbose:
+            print("Completed in %-0.4f sec." % (time_elapsed))
+
+
+@main.command(name="whoami", help="Get information about account whose token is used")
+@click.pass_context
+def exe_whoami(ctx):
+    args = Arguments()
+    whoami_account(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@main.command(name="ping", help="Ping Rucio server")
+@click.pass_context
+def exe_ping(ctx):
+    args = Arguments()
+    ping(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@main.command(name="test-server", help="Test client against the server")
+@click.pass_context
+def exe_test_server(ctx):
+    args = Arguments()
+    test_server(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)

rucio/cli/config.py

@@ -0,0 +1,72 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import click
+
+from rucio.cli.bin_legacy.rucio_admin import delete_config_option, get_config, set_config_option
+from rucio.cli.utils import Arguments
+
+
+@click.group()
+def config():
+    "Modify the configuration table"
+
+
+# TODO Limit to just the section names
+@config.command("list")
+@click.option("-s", "--section", help="Filter by sections")
+@click.option("-k", "--key", help="Show key's value, section required.")
+@click.pass_context
+def list_(ctx, section, key):
+    """List the sections or content of sections in the rucio.cfg"""
+    get_config(Arguments({"section": section, "key": key}), ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+# TODO Change to only add new fields and cannot modify an existing field
+@config.command("add")
+@click.option("-s", "--section", help="Section name", required=True)
+@click.option('--key', help='Attribute key', required=True)
+@click.option('--value', help='Attribute value', required=True)
+@click.pass_context
+def add_(ctx, section, key, value):
+    """
+    Add a new key/value to a section.
+
+    \b
+    Example, Add a key to an existing section:
+        $ rucio config add --section my-section --key key --value value
+    """
+    args = Arguments({"section": section, "option": key, "value": value})
+    set_config_option(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@config.command("remove")
+@click.option("-s", "--section", help="Section", required=True)
+@click.option("-k", "--key", help="Key in section", required=True)
+@click.pass_context
+def remove(ctx, section, key):
+    """Remove the section.key from the config."""
+    args = Arguments({"section": section, "option": key})
+    delete_config_option(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+# @config.command("show")
+# @click.pass_context
+def show(ctx):
+    """Show a single sections options"""
+
+
+# TODO Change this so that it only modifies existing fields
+def update():
+    """Modify an existing command"""
+    pass

rucio/cli/did.py

@@ -0,0 +1,191 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import click
+
+from rucio.cli.bin_legacy.rucio import add_container, add_dataset, attach, close, delete_metadata, detach, erase, get_metadata, list_content, list_content_history, list_dids, list_parent_dids, reopen, set_metadata, stat, touch
+from rucio.cli.utils import Arguments
+
+
+@click.group()
+def did():
+    """Manage Data Identifiers - the source data objects"""
+
+
+@did.command("list")
+@click.option("-r", "--recursive", default=False, is_flag=True, help="List data identifiers recursively.")
+@click.option(
+    "--filter", "filter_",
+    help="""
+    Single or logically combined filtering expression(s) either in the form <key><operator><value>
+    or <value1><operator1><key><operator2><value2> (compound inequality).
+    Keys are equivalent to columns in the DID table.
+    Operators must belong to the set of (<=, >=, ==, !=, >, <). The following conventions for combining expressions
+    are used: ";" represents the logical OR operator; "," represents the logical AND operator',
+    """,
+)  # TODO Shorten this help and make supplying this easier
+@click.option("--short", is_flag=True, default=False, help="Dump the list of DIDs")
+@click.argument("did-pattern", nargs=-1)
+@click.option("--parent", default=False, is_flag=True, help="List the parents of the DID - must use a full DID scope and name")
+# TODO Implement or remove option - view https://github.com/rucio/rucio/issues/7230
+@click.option("--pfn", hidden=True)
+@click.option("--guid", hidden=True)
+@click.pass_context
+def list_(ctx, did_pattern, recursive, filter_, short, parent, pfn, guid):
+    """
+    List the Data IDentifiers matching certain pattern.
+    Only the collections (i.e. dataset or container) are returned by default.
+    With the filter option, you can specify a list of metadata that the Data IDentifier should match
+    """
+    if parent:
+        for did in did_pattern:
+            list_parent_dids(Arguments({"did": did}), ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+    else:
+        args = Arguments({"did": did_pattern, "recursive": recursive, "filter": filter_, "short": short})
+        list_dids(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@did.command("show")
+@click.argument("dids", nargs=-1)
+@click.pass_context
+def show(ctx, dids):
+    """List attributes, statuses, or parents for data identifiers"""
+    stat(Arguments({"dids": dids}), ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@did.command("add")
+@click.argument("did-name")
+@click.option("--type", "dtype", type=click.Choice(["container", "dataset"]))
+@click.option("--monotonic", is_flag=True, default=False, help="Monotonic status to True.")
+@click.option("--lifetime", type=int, help="Lifetime in seconds.")
+@click.pass_context
+def add_(ctx, did_name, dtype, monotonic, lifetime):
+    """Create a new collection-type DID"""
+    args = Arguments({"did": did_name, "monotonic": monotonic, "lifetime": lifetime})
+    if dtype == "container":
+        add_container(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+    else:
+        add_dataset(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@did.command("update")
+@click.argument("dids", nargs=-1)
+@click.option("--rse", "--rse-name", help="The RSE of the DIDs")
+@click.option("--touch", "operation", flag_value="touch", default=True, help="Touch one or more DIDs and set the last accessed date to the current date")
+@click.option("--open", "operation", flag_value="open", help="Reopen a dataset or container (only for privileged users)")
+@click.option("--close", "operation", flag_value="close", help="Close a dataset or container.")
+@click.pass_context
+def update(ctx, dids, rse, operation):
+    """Touch one or more DIDs and set the last accessed date to the current date, or mark them as open or closed."""
+    args = Arguments({"dids": dids, "rse": rse})
+    if operation == "touch":
+        touch(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+    elif operation == "open":
+        reopen(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+    elif operation == "close":
+        close(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+    else:
+        raise ValueError("No operation specified, please use `--help` to see possibilities")  # Should not be possible, but better safe than sorry
+
+
+@did.command("remove")
+@click.option("--undo", is_flag=True, default=False, help="Undo erase DIDs. Only works if has been less than 24 hours since erase operation.")
+@click.argument("dids", nargs=-1)
+@click.pass_context
+def remove(ctx, dids, undo):
+    """
+    This command sets the lifetime of the DID in order to expire in the next 24 hours.
+    Expired DIDs are force-deleted (and their replicas purged).
+    The deletion is not reversible after 24 hours grace time period expired
+    """
+    erase(Arguments({"dids": dids, "undo": undo}), ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@did.group()
+def content():
+    """Manage contents of collection type DIDs"""
+
+
+@content.command("history")
+@click.argument("dids", nargs=-1)
+@click.pass_context
+def content_history(ctx, dids):
+    """List the content history of a collection-type DID"""
+    list_content_history(Arguments({"dids": dids}), ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@content.command("add")
+@click.option("-to", "--to-did", required=True, help="Collection-type DID to which attach [DIDs]")
+@click.option("-f", "--from-file", is_flag=True, default=False, help="[DIDs] is a file instead of a list of did names. The file should contain one did per line.")
+@click.argument("dids", nargs=-1)
+@click.pass_context
+def content_add_(ctx, to_did, from_file, dids):
+    """Attach a list [dids] of Data IDentifiers (file or collection-type) to an other Data IDentifier (collection-type)"""
+    args = Arguments({"dids": dids, "todid": to_did, "fromfile": from_file})
+    attach(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@content.command("remove")
+@click.option("-f", "--from-did", help="Collection-type DID to remove DIDs from")
+@click.argument("dids", nargs=-1)
+@click.pass_context
+def content_remove(ctx, dids, from_did):
+    """Detach [dids], a list of DIDs (file or collection-type) from an other Data Identifier (collection type)"""
+    args = Arguments({"dids": dids, "fromdid": from_did})
+    detach(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@content.command("list")
+@click.argument("dids", nargs=-1)
+@click.option("--short", is_flag=True, default=False, help="Just dump the list of DIDs.")
+@click.pass_context
+def content_list_(ctx, dids, short):
+    """List the content of a collection-type DID"""
+    args = Arguments({"dids": dids, "short": short})
+    list_content(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@did.group()
+def metadata():
+    """Manage metadata for DIDs"""
+
+
+@metadata.command("add")
+@click.argument("did")
+@click.option('--key', help='Attribute key', required=True)
+@click.option('--value', help='Attribute value', required=True)
+@click.pass_context
+def metadata_add_(ctx, did, key, value):
+    """Add metadata to a DID"""
+    args = Arguments({"did": did, "key": key, "value": value})
+    set_metadata(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@metadata.command("remove")
+@click.argument("did")
+@click.option("--key", help="Key to remove from a DID's metadata.")
+@click.pass_context
+def metadata_remove(ctx, did, key):
+    """Remove metadata from a DID"""
+    args = Arguments({"did": did, "key": key})
+    delete_metadata(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+
+
+@metadata.command("list")
+@click.argument("dids", nargs=-1)
+@click.option("--plugin", help="Filter down to metadata from specific metadata plugin")
+@click.pass_context
+def metadata_list_(ctx, dids, plugin):
+    """List metadata for a list of DIDs"""
+    args = Arguments({"dids": dids, "plugin": plugin})
+    get_metadata(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)

rucio/cli/download.py

@@ -0,0 +1,128 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import os
+
+import click
+
+from rucio.cli.bin_legacy.rucio import download as download_exe
+from rucio.cli.utils import Arguments
+from rucio.common.config import config_get_float
+
+
+@click.command()
+@click.argument("dids", nargs=-1)
+@click.option("--dir", default=".", help="The directory to store the downloaded file.")
+@click.option("--allow-tape", is_flag=True, default=False, help="Also consider tape endpoints as source of the download.")
+@click.option("--rses", "--rse-exp", help="RSE Expression to specify allowed sources")
+@click.option("--impl", help="Transfer protocol implementation to use (e.g: xrootd, gfal.NoRename, webdav, ssh.Rsync, rclone).")
+@click.option("--protocol", help="Force the protocol to use.")
+@click.option("--nrandom", type=int, help="Download N random files from the DID.")
+@click.option("--ndownloader", type=int, default=3, help="Choose the number of parallel processes for download.")
+@click.option("--no-subdir", is_flag=True, default=False, help="Don't create a subdirectory for the scope of the files.")
+@click.option("--pfn", help="Specify the exact PFN for the download.")
+@click.option("--no-resolve-archives", is_flag=True, default=False, help="If set archives will not be considered for download.")
+@click.option("--ignore-checksum", is_flag=True, default=False, help="Don't validate checksum for downloaded files.")
+@click.option("--check-local-with-filesize-only", is_flag=True, default=False, help="Don't use checksum verification for already downloaded files, use filesize instead.")
+@click.option(
+    "--transfer-timeout",
+    type=float,
+    default=config_get_float("download", "transfer_timeout", False, None),
+    help="Transfer timeout (in seconds). Default: computed dynamically from --transfer-speed-timeout. If set to any value >= 0, --transfer-speed-timeout is ignored.",
+)  # NOQA: E501
+@click.option("--transfer-speed-timeout", type=float, default=None, help="Minimum allowed average transfer speed (in KBps). Default: 500. Used to dynamically compute the timeout if --transfer-timeout not set. Is not supported for --pfn.")  # NOQA: E501
+@click.option("--aria", default=False, help="Use aria2c utility if possible. (EXPERIMENTAL)")
+@click.option("--archive-did", hidden=True)  # Download from archive is transparent. This option is obsolete.
+# TODO replace with click functionality to automatically pull env vars
+@click.option("--trace-appid", default=os.environ.get("RUCIO_TRACE_APPID", None), hidden=True)
+@click.option("--trace-dataset", default=os.environ.get("RUCIO_TRACE_DATASET", None), hidden=True)
+@click.option("--trace-datasetscope", default=os.environ.get("RUCIO_TRACE_DATASETSCOPE", None), hidden=True)
+@click.option("--trace-eventtype", default=os.environ.get("RUCIO_TRACE_EVENTTYPE", None), hidden=True)
+@click.option("--trace-pq", default=os.environ.get("RUCIO_TRACE_PQ", None), hidden=True)
+@click.option("--trace-taskid", default=os.environ.get("RUCIO_TRACE_TASKID", None), hidden=True)
+@click.option("--trace-usrdn", default=os.environ.get("RUCIO_TRACE_USRDN", None), hidden=True)
+@click.option("--filter", help="Filter files by key-value pairs like guid=2e2232aafac8324db452070304f8d745.")
+@click.option("--scope", help="Scope if you are using the filter option and no full DID.")
+@click.option("--metalink", help="Path to a metalink file.")
+@click.option("--no-show-download-exceptions", default=False, is_flag=True, help="Does not raise NoFilesDownloaded, NotAllFilesDownloaded or incorrect number of output queue files Exception.")  # NOQA: E501
+@click.option("--replica-selection", help="Select the best replica using a replica sorting algorithm provided by replica sorter (e.g., random, geoip).")
+@click.pass_context
+def download(
+    ctx,
+    dids,
+    dir,
+    allow_tape,
+    rses,
+    impl,
+    protocol,
+    nrandom,
+    ndownloader,
+    no_subdir,
+    pfn,
+    no_resolve_archives,
+    ignore_checksum,
+    check_local_with_filesize_only,
+    transfer_timeout,
+    transfer_speed_timeout,
+    aria,
+    archive_did,
+    trace_appid,
+    trace_dataset,
+    trace_datasetscope,
+    trace_eventtype,
+    trace_pq,
+    trace_taskid,
+    trace_usrdn,
+    filter,
+    scope,
+    metalink,
+    no_show_download_exceptions,
+    replica_selection,
+):
+    """
+    Download DID(s) (in the form of scope:name) to a local dir
+    """
+    args = Arguments(
+        {
+            "dids": dids,
+            "dir": dir,
+            "allow_tape": allow_tape,
+            "rses": rses,
+            "impl": impl,
+            "protocol": protocol,
+            "nrandom": nrandom,
+            "ndownloader": ndownloader,
+            "no_subdir": no_subdir,
+            "pfn": pfn,
+            "no_resolve_archives": no_resolve_archives,
+            "ignore_checksum": ignore_checksum,
+            "check_local_with_filesize_only": check_local_with_filesize_only,
+            "transfer_timeout": transfer_timeout,
+            "transfer_speed_timeout": transfer_speed_timeout,
+            "aria": aria,
+            "archive_did": archive_did,
+            "trace_appid": trace_appid,
+            "trace_dataset": trace_dataset,
+            "trace_datasetscope": trace_datasetscope,
+            "trace_eventtype": trace_eventtype,
+            "trace_pq": trace_pq,
+            "trace_taskid": trace_taskid,
+            "trace_usrdn": trace_usrdn,
+            "filter": filter,
+            "scope": scope,
+            "metalink_file": metalink,
+            "deactivate_file_download_exceptions": no_show_download_exceptions,
+            "sort": replica_selection,
+        }
+    )
+    download_exe(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)