datalad.api.download_cds

datalad.api.download_cds(spec: str | dict, path: str, *, dataset: str | None = None, message: str | None = None, batch: bool = False, lazy: bool = False, save: bool = True) → Iterable[dict]

Downloads specified datasets from the CDS data store

Parameters:

  • spec -- A json string or python dictionary containing the key "dataset" with the datasets name (i.e. what is shown as the first parameter to cdsapi.Client.retrieve if you do a "Show API request" on some dataset in the CDS) and the key "sub-selection" with the sub- selection of the dataset that should be fetched (i.e. what is shown as the second parameter to cdsapi.Client.retrieve).

  • path (str) -- target path to download to.

  • dataset (Dataset or None, optional) -- specify the dataset to add files to. If no dataset is given, an attempt is made to identify the dataset based on the current working directory. Use save=False to prevent adding files to the dataset. [Default: None]

  • message (str or None, optional) -- a description of the state or the changes made to a dataset. [Default: None]

  • batch (bool, optional) -- By default a single call to git annex addurl will be made for each request to download. The batch option can be supplied to instead re- use a git annex addurl --batch process for multiple consecutive calls to download-cds. This is only useful when used with the python API. [Default: False]

  • lazy (bool, optional) -- By default the file will be immediately downloaded. If the lazy flag is supplied then the CDS request is only recorded as a source for the file, but no download is initiated. Keep in mind that there is no way to validate the correctness of the request if the lazy flag is used. [Default: False]

  • save (bool, optional) -- by default all modifications to a dataset are immediately saved. Giving this option will disable this behavior. [Default: True]

  • on_failure ({'ignore', 'continue', 'stop'}, optional) -- behavior to perform on failure: 'ignore' any failure is reported, but does not cause an exception; 'continue' if any failure occurs an exception will be raised at the end, but processing other actions will continue for as long as possible; 'stop': processing will stop on first failure and an exception is raised. A failure is any result with status 'impossible' or 'error'. Raised exception is an IncompleteResultsError that carries the result dictionaries of the failures in its failed attribute. [Default: 'continue']

  • result_filter (callable or None, optional) -- if given, each to-be-returned status dictionary is passed to this callable, and is only returned if the callable's return value does not evaluate to False or a ValueError exception is raised. If the given callable supports **kwargs it will additionally be passed the keyword arguments of the original API call. [Default: None]

  • result_renderer -- select rendering mode command results. 'tailored' enables a command- specific rendering style that is typically tailored to human consumption, if there is one for a specific command, or otherwise falls back on the the 'generic' result renderer; 'generic' renders each result in one line with key info like action, status, path, and an optional message); 'json' a complete JSON line serialization of the full result record; 'json_pp' like 'json', but pretty-printed spanning multiple lines; 'disabled' turns off result rendering entirely; '<template>' reports any value(s) of any result properties in any format indicated by the template (e.g. '{path}', compare with JSON output for all key-value choices). The template syntax follows the Python "format() language". It is possible to report individual dictionary values, e.g. '{metadata[name]}'. If a 2nd-level key contains a colon, e.g. 'music:Genre', ':' must be substituted by '#' in the template, like so: '{metadata[music#Genre]}'. [Default: 'tailored']

  • result_xfm ({'datasets', 'successdatasets-or-none', 'paths', 'relpaths', 'metadata'} or callable or None, optional) -- if given, each to-be-returned result status dictionary is passed to this callable, and its return value becomes the result instead. This is different from result_filter, as it can perform arbitrary transformation of the result value. This is mostly useful for top- level command invocations that need to provide the results in a particular format. Instead of a callable, a label for a pre-crafted result transformation can be given. [Default: None]

  • return_type ({'generator', 'list', 'item-or-list'}, optional) -- return value behavior switch. If 'item-or-list' a single value is returned instead of a one-item return value list, or a list in case of multiple return values. None is return in case of an empty list. [Default: 'list']