duplicity.backend module

Provides a common interface to all backends and certain sevices intended to be used by the backends themselves.

class duplicity.backend.Backend(parsed_url)

Bases: object

See README in backends directory for information on how to write a backend.

__init__(parsed_url)

__subprocess_popen(args)

For internal use. Execute the given command line, interpreted as a shell command. Returns int Exitcode, string StdOut, string StdErr

get_password()

Return a password for authentication purposes. The password will be obtained from the backend URL, the environment, by asking the user, or by some other method. When applicable, the result will be cached for future invocations.

munge_password(commandline)

Remove password from commandline by substituting the password found in the URL, if any, with a generic place-holder.

This is intended for display purposes only, and it is not guaranteed that the results are correct (i.e., more than just the ‘:password@’ may be substituted.

popen_breaks = {}

subprocess_popen(commandline)

Execute the given command line with error check. Returns int Exitcode, string StdOut, string StdErr

Raise a BackendException on failure.

use_getpass = True

class duplicity.backend.BackendWrapper(backend)

Bases: object

Represents a generic duplicity backend, capable of storing and retrieving files.

__do_put(source_path, remote_filename)

__init__(backend)

_do_delete(*args)

_do_delete_list(*args)

_do_query(*args)

_do_query_list(*args)

close()

Close the backend, releasing any resources held and invalidating any file objects obtained from the backend.

delete(filename_list)

Delete each filename in filename_list, in order if possible.

get(*args)

get_data(filename, parseresults=None)

Retrieve a file from backend, process it, return contents.

get_fileobj_read(filename, parseresults=None)

Return fileobject opened for reading of filename on backend

The file will be downloaded first into a temp file. When the returned fileobj is closed, the temp file will be deleted.

list(*args)

move(*args)

pre_process_download(remote_filename)

Manages remote access before downloading files (unseal data in cold storage for instance)

pre_process_download_batch(remote_filenames)

Manages remote access before downloading files (unseal data in cold storage for instance)

put(*args)

query_info(filename_list)

Return metadata about each filename in filename_list

class duplicity.backend.ParsedUrl(url_string)

Bases: object

Parse the given URL as a duplicity backend URL.

Returns the data of a parsed URL with the same names as that of the standard urlparse.urlparse() except that all values have been resolved rather than deferred. There are no get_* members. This makes sure that the URL parsing errors are detected early.

Raise InvalidBackendURL on invalid URL’s

__init__(url_string)

geturl()

strip_auth()

duplicity.backend._get_code_from_exception(backend, operation, e)

duplicity.backend.get_backend(url_string)

Instantiate a backend suitable for the given URL, or return None if the given string looks like a local path rather than a URL.

Raise InvalidBackendURL if the URL is not a valid URL.

duplicity.backend.get_backend_object(url_string)

Find the right backend class instance for the given URL, or return None if the given string looks like a local path rather than a URL.

Raise InvalidBackendURL if the URL is not a valid URL.

duplicity.backend.import_backends()

Import files in the duplicity/backends directory where the filename ends in ‘backend.py’ and ignore the rest.

@rtype: void @return: void

duplicity.backend.is_backend_url(url_string)

@return Whether the given string looks like a backend URL.

duplicity.backend.register_backend(scheme, backend_factory)

Register a given backend factory responsible for URL:s with the given scheme.

The backend must be a callable which, when called with a URL as the single parameter, returns an object implementing the backend protocol (i.e., a subclass of Backend).

Typically the callable will be the Backend subclass itself.

This function is not thread-safe and is intended to be called during module importation or start-up.

duplicity.backend.register_backend_prefix(scheme, backend_factory)

Register a given backend factory responsible for URL:s with the given scheme prefix.

The backend must be a callable which, when called with a URL as the single parameter, returns an object implementing the backend protocol (i.e., a subclass of Backend).

Typically the callable will be the Backend subclass itself.

This function is not thread-safe and is intended to be called during module importation or start-up.

duplicity.backend.retry(operation, fatal=True)

duplicity.backend.strip_auth_from_url(parsed_url)

Return a URL from a urlparse object without a username or password.

duplicity.backend.strip_prefix(url_string, prefix_scheme)

strip the prefix from a string e.g. par2+ftp://… -> ftp://…