duplicity.manifest module

Create and edit manifest for session contents

class duplicity.manifest.Manifest(fh=None)

Bases: object

List of volumes and information about each one

__init__(fh=None)

Create blank Manifest

@param fh: fileobj for manifest @type fh: DupPath

@rtype: Manifest @return: manifest

add_volume_info(vi)

Add volume info vi to manifest and write to manifest

@param vi: volume info to add @type vi: VolumeInfo

@return: void

check_dirinfo()

Return None if dirinfo is the same, otherwise error message

Does not raise an error message if hostname or local_dirname are not available.

@rtype: string @return: None or error message

del_volume_info(vol_num)

Remove volume vol_num from the manifest

@param vol_num: volume number to delete @type vi: int

@return: void

from_string(s)

Initialize self from string s, return self

get_containing_volumes(index_prefix)

Return list of volume numbers that may contain index_prefix

get_files_changed()

set_dirinfo()

Set information about directory from config, and write to manifest file.

@rtype: Manifest @return: manifest

set_files_changed_info(files_changed)

to_string()

Return string version of self (just concatenate vi strings)

@rtype: string @return: self in string form

write_to_path(path)

Write string version of manifest to given path

exception duplicity.manifest.ManifestError

Bases: Exception

Exception raised when problem with manifest

duplicity.manifest.Quote(s)

Return quoted version of s safe to put in a manifest or volume info

duplicity.manifest.Unquote(quoted_string)

Return original string from quoted_string produced by above

class duplicity.manifest.VolumeInfo

Bases: object

Information about a single volume

__init__()

VolumeInfo initializer

contains(index_prefix, recursive=1)

Return true if volume might contain index

If recursive is true, then return true if any index starting with index_prefix could be contained. Otherwise, just check if index_prefix itself is between starting and ending indicies.

from_string(s)

Initialize self from string s as created by to_string

get_best_hash()

Return pair (hash_type, hash_data)

SHA1 is the best hash, and MD5 is the second best hash. None is returned if no hash is available.

set_hash(hash_name, data)

Set the value of hash hash_name (e.g. “MD5”) to data

set_info(vol_number, start_index, start_block, end_index, end_block)

Set essential VolumeInfo information, return self

Call with starting and ending paths stored in the volume. If a multivol diff gets split between volumes, count it as being part of both volumes.

to_string()

Return nicely formatted string reporting all information

exception duplicity.manifest.VolumeInfoError

Bases: Exception

Raised when there is a problem initializing a VolumeInfo from string

duplicity.manifest.maybe_chr(ch)