datalad.customremotes.archives¶

Custom remote to support getting the load from archives present under annex

class datalad.customremotes.archives.ArchiveAnnexCustomRemote(persistent_cache=True, **kwargs)[source]¶

Special custom remote allowing to obtain files from archives

Archives should also be under annex control.

get_file_url(archive_file=None, archive_key=None, file=None, size=None)[source]¶

Given archive (file or a key) and a file – compose URL for access

Examples

dl+archive:SHA256E-s176–69…3e.tar.gz#path=1/d2/2d&size=123: when size of file within archive was known to be 123
dl+archive:SHA256E-s176–69…3e.tar.gz#path=1/d2/2d: when size of file within archive was not provided

Parameters:	size (int, optional) – Size of the file. If not provided, will simply be empty

req_CHECKPRESENT(key)[source]¶

Check if copy is available

TODO: just proxy the call to annex for underlying tarball

Replies

CHECKPRESENT-SUCCESS Key: Indicates that a key has been positively verified to be present in the remote.
CHECKPRESENT-FAILURE Key: Indicates that a key has been positively verified to not be present in the remote.
CHECKPRESENT-UNKNOWN Key ErrorMsg: Indicates that it is not currently possible to verify if the key is present in the remote. (Perhaps the remote cannot be contacted.)

req_CHECKURL(url)[source]¶

Replies

CHECKURL-CONTENTS Size|UNKNOWN Filename: Indicates that the requested url has been verified to exist. The Size is the size in bytes, or use “UNKNOWN” if the size could not be determined. The Filename can be empty (in which case a default is used), or can specify a filename that is suggested to be used for this url.
CHECKURL-MULTI Url Size|UNKNOWN Filename …: Indicates that the requested url has been verified to exist, and contains multiple files, which can each be accessed using their own url. Note that since a list is returned, neither the Url nor the Filename can contain spaces.
CHECKURL-FAILURE: Indicates that the requested url could not be accessed.

req_REMOVE(key)[source]¶

REMOVE-SUCCESS Key: Indicates the key has been removed from the remote. May be returned if the remote didn’t have the key at the point removal was requested
REMOVE-FAILURE Key ErrorMsg: Indicates that the key was unable to be removed from the remote.

req_WHEREIS(key)[source]¶

WHEREIS-SUCCESS String: Indicates a location of a key. Typically an url, the string can be anything that it makes sense to display to the user about content stored in the special remote.
WHEREIS-FAILURE: Indicates that no location is known for a key.

datalad.customremotes.archives.link_file_load(src, dst, dry_run=False)[source]¶: Just a little helper to hardlink files’s load