duplicity.path module

Wrapper class around a file like “/usr/bin/env”

This class makes certain file operations more convenient and associates stat information with filenames

class duplicity.path.DupPath(base, index=(), parseresults=None)

Bases: Path

Represent duplicity data files

Based on the file name, files that are compressed or encrypted will have different open() methods.

__init__(base, index=(), parseresults=None)

DupPath initializer

The actual filename (no directory) must be the single element of the index, unless parseresults is given.

filtered_open(mode='rb', gpg_profile=None)

Return fileobj with appropriate encryption/compression

If encryption is specified but no gpg_profile, use config.default_profile.

class duplicity.path.Path(base, index=())

Bases: ROPath

Path class - wrapper around ordinary local files

Besides caching stat() results, this class organizes various file code.

__init__(base, index=())

Path initializer

append(ext)

Return new Path with ext added to index

chmod(mode)

Change permissions of the path

compare_recursive(other, verbose=None)

Compare self to other Path, descending down directories

contains(child)

Return true if path is a directory and contains child

delete()

Remove this file

deltree()

Remove self by recursively deleting files under it

get_canonical()

Return string of canonical version of path

Remove “.”, and trailing slashes where possible. Note that it’s harder to remove “..”, as “foo/bar/..” is not necessarily “foo”, so we can’t use path.normpath()

get_filename()

Return filename of last component

get_parent_dir()

Return directory that self is in

get_temp_in_same_dir()

Return temp non existent path in same directory as self

isemptydir()

Return true if path is a directory and is empty

listdir()

Return list generated by os.listdir

makedev(type, major, minor)

Make a device file with specified type, major/minor nums

mkdir()

Make directory(s) at specified path

move(new_path)

Like rename but destination may be on different file system

new_index(index)

Return new Path with index index

open(mode='rb')

Return fileobj associated with self

Usually this is just the file data on disk, but can be replaced with arbitrary data using the setfileobj method.

patch_with_attribs(diff_ropath)

Patch self with diff and then copy attributes over

quote(s=None)

Return quoted version of s (defaults to self.name)

The output is meant to be interpreted with shells, so can be used with os.system.

regex_chars_to_quote = re.compile('[\\\\\\"\\$`]')

rename(new_path)

Rename file at current path to new_path.

rename_index(index)

setdata()

Refresh stat cache

touch()

Open the file, write 0 bytes, close

unquote(s)

Return unquoted version of string s, as quoted by above quote()

writefileobj(fin)

Copy file object fin to self. Close both when done.

class duplicity.path.PathDeleter

Bases: ITRBranch

Delete a directory. Called by Path.deltree

can_fast_process(index, path)

True if object can be processed without new branch (stub)

end_process()

Do any final processing before leaving branch (stub)

fast_process(index, path)

Process args without new child branch (stub)

start_process(index, path)

Do some initial processing (stub)

exception duplicity.path.PathException

Bases: Exception

class duplicity.path.ROPath(index, stat=None)

Bases: object

Read only Path

Objects of this class doesn’t represent real files, so they don’t have a name. They are required to be indexed though.

__init__(index, stat=None)

ROPath initializer

blank()

Black out self - set type and stat to None

compare_data(other)

Compare data from two regular files, return true if same

compare_verbose(other, include_data=0)

Compare ROPaths like __eq__, but log reason if different

This is placed in a separate function from __eq__ because __eq__ should be very time sensitive, and logging statements would slow it down. Used when verifying.

Only run if include_data is true.

copy(other)

Copy self to other. Also copies data. Other must be Path

copy_attribs(other)

Only copy attributes from self to other

exists()

True if corresponding file exists

get_data()

Return contents of associated fileobj in string

get_relative_path()

Return relative path, created from index

get_ropath()

Return ropath copy of self

get_tarinfo()

Generate a tarfile.TarInfo object based on self

Doesn’t set size based on stat, because we may want to replace data wiht other stream. Size should be set separately by calling function.

getdevloc()

Return device number path resides on

getmtime()

Return mod time of path in seconds

getperms()

Return permissions mode, owner and group

getsize()

Return length in bytes from stat object

init_from_tarinfo(tarinfo)

Set data from tarinfo object (part of tarfile module)

isdev()

True is self is a device file

isdir()

True if self is dir

isfifo()

True if self is fifo

isreg()

True if self corresponds to regular file

issock()

True is self is socket

issym()

True if self is sym

open(mode)

Return fileobj associated with self

perms_equal(other)

True if self and other have same permissions and ownership

set_from_stat()

Set the value of self.type, self.mode from self.stat

setfileobj(fileobj)

Set file object returned by open()

class duplicity.path.StatResult

Bases: object

Used to emulate the output of os.stat() and related

st_mode = 0