Package plumbum.path¶

class plumbum.path.base.FSUser[source]¶

A special object that represents a file-system user. It derives from int, so it behaves just like a number (uid/gid), but also have a .name attribute that holds the string-name of the user, if given (otherwise None)

__weakref__¶

list of weak references to the object (if defined)

class plumbum.path.base.Path[source]¶

An abstraction over file system paths. This class is abstract, and the two implementations are LocalPath and RemotePath.

__div__(other)[source]¶

Joins two paths

__truediv__(other)¶

Joins two paths

__floordiv__(expr)[source]¶

Returns a (possibly empty) list of paths that matched the glob-pattern under this path

__iter__()[source]¶

Iterate over the files in this directory

up(count=1)[source]¶

Go up in count directories (the default is 1)

walk(filter=<function <lambda>>, dir_filter=<function <lambda>>)[source]¶

traverse all (recursive) sub-elements under this directory, that match the given filter. By default, the filter accepts everything; you can provide a custom filter function that takes a path as an argument and returns a boolean

Parameters:	filter – the filter (predicate function) for matching results. Only paths matching this predicate are returned. Defaults to everything. dir_filter – the filter (predicate function) for matching directories. Only directories matching this predicate are recursed into. Defaults to everything.

basename¶

The basename component of this path

dirname¶

The dirname component of this path

uid¶

The user that owns this path. The returned value is a FSUser object which behaves like an int (as expected from uid), but it also has a .name attribute that holds the string-name of the user

gid¶

The group that owns this path. The returned value is a FSUser object which behaves like an int (as expected from gid), but it also has a .name attribute that holds the string-name of the group

join(*parts)[source]¶

Joins this path with any number of paths

list()[source]¶

Returns the files in this directory

isdir()[source]¶

Returns True if this path is a directory, False otherwise

isfile()[source]¶

Returns True if this path is a regular file, False otherwise

islink()[source]¶

Returns True if this path is a symbolic link, False otherwise

exists()[source]¶

Returns True if this path exists, False otherwise

glob(pattern)[source]¶

Returns a (possibly empty) list of paths that matched the glob-pattern under this path

delete()[source]¶

Deletes this path (recursively, if a directory)

move(dst)[source]¶

Moves this path to a different location

rename(newname)[source]¶

Renames this path to the new name (only the basename is changed)

copy(dst, override=False)[source]¶

Copies this path (recursively, if a directory) to the destination path

mkdir()[source]¶

Creates a directory at this path; if the directory already exists, silently ignore

open(mode='r')[source]¶

opens this path as a file

read(encoding=None)[source]¶

returns the contents of this file. By default the data is binary (bytes), but you can specify the encoding, e.g., 'latin1' or 'utf8'

write(data, encoding=None)[source]¶

writes the given data to this file. By default the data is expected to be binary (bytes), but you can specify the encoding, e.g., 'latin1' or 'utf8'

chown(owner=None, group=None, recursive=None)[source]¶

Change ownership of this path.

Parameters:	owner – The owner to set (either uid or username), optional owner – The group to set (either gid or groupname), optional recursive – whether to change ownership of all contained files and subdirectories. Only meaningful when self is a directory. If None, the value will default to True if self is a directory, False otherwise.

chmod(mode)[source]¶

Change the mode of path to the numeric mode.

Parameters:	mode – file mode as for os.chmod

access(mode=0)[source]¶

Test file existence or permission bits

Parameters:	mode – a bitwise-or of access bits, or a string-representation thereof: 'f', 'x', 'r', 'w' for os.F_OK, os.X_OK, os.R_OK, os.W_OK

link(dst)[source]¶

Creates a hard link from self to dst

Parameters:	dst – the destination path

symlink(dst)[source]¶

Creates a symbolic link from self to dst

Parameters:	dst – the destination path

unlink()[source]¶

Deletes a symbolic link

split()[source]¶

Splits the path on directory separators, yielding a list of directories, e.g, "/var/log/messages" will yield ['var', 'log', 'messages'].

relative_to(source)[source]¶

Computes the “relative path” require to get from source to self. They satisfy the invariant source_path + (target_path - source_path) == target_path. For example:

/var/log/messages - /var/log/messages = []
/var/log/messages - /var              = [log, messages]
/var/log/messages - /                 = [var, log, messages]
/var/log/messages - /var/tmp          = [.., log, messages]
/var/log/messages - /opt              = [.., var, log, messages]
/var/log/messages - /opt/lib          = [.., .., var, log, messages]

__sub__(other)[source]¶

Same as self.relative_to(other)

class plumbum.path.base.RelativePath(parts)[source]¶

Relative paths are the “delta” required to get from one path to another. Note that relative path do not point at anything, and thus are not paths. Therefore they are system agnostic (but closed under addition) Paths are always absolute and point at “something”, whether existent or not.

Relative paths are created by subtracting paths (Path.relative_to)

__weakref__¶

list of weak references to the object (if defined)

class plumbum.path.local.LocalPath(*parts)[source]¶

The class implementing local-machine paths

basename¶

The basename component of this path

dirname¶

The dirname component of this path

uid¶

The user that owns this path. The returned value is a FSUser object which behaves like an int (as expected from uid), but it also has a .name attribute that holds the string-name of the user

gid¶

The group that owns this path. The returned value is a FSUser object which behaves like an int (as expected from gid), but it also has a .name attribute that holds the string-name of the group

join(*others)[source]¶

Joins this path with any number of paths

list()[source]¶

Returns the files in this directory

isdir()[source]¶

Returns True if this path is a directory, False otherwise

isfile()[source]¶

Returns True if this path is a regular file, False otherwise

islink()[source]¶

Returns True if this path is a symbolic link, False otherwise

exists()[source]¶

Returns True if this path exists, False otherwise

glob(pattern)[source]¶

Returns a (possibly empty) list of paths that matched the glob-pattern under this path

delete()[source]¶

Deletes this path (recursively, if a directory)

move(dst)[source]¶

Moves this path to a different location

copy(dst, override=False)[source]¶

Copies this path (recursively, if a directory) to the destination path

mkdir()[source]¶

Creates a directory at this path; if the directory already exists, silently ignore

open(mode='rb')[source]¶

opens this path as a file

read(encoding=None)[source]¶

returns the contents of this file. By default the data is binary (bytes), but you can specify the encoding, e.g., 'latin1' or 'utf8'

write(data, encoding=None)[source]¶

writes the given data to this file. By default the data is expected to be binary (bytes), but you can specify the encoding, e.g., 'latin1' or 'utf8'

chown(owner=None, group=None, recursive=None)[source]¶

Change ownership of this path.

Parameters:	owner – The owner to set (either uid or username), optional owner – The group to set (either gid or groupname), optional recursive – whether to change ownership of all contained files and subdirectories. Only meaningful when self is a directory. If None, the value will default to True if self is a directory, False otherwise.

chmod(mode)[source]¶

Change the mode of path to the numeric mode.

Parameters:	mode – file mode as for os.chmod

access(mode=0)[source]¶

Test file existence or permission bits

Parameters:	mode – a bitwise-or of access bits, or a string-representation thereof: 'f', 'x', 'r', 'w' for os.F_OK, os.X_OK, os.R_OK, os.W_OK

link(dst)[source]¶

Creates a hard link from self to dst

Parameters:	dst – the destination path

symlink(dst)[source]¶

Creates a symbolic link from self to dst

Parameters:	dst – the destination path

unlink()[source]¶

Deletes a symbolic link

class plumbum.path.local.LocalWorkdir[source]¶

Working directory manipulator

chdir(newdir)[source]¶

Changes the current working directory to the given one

Parameters:	newdir – The destination director (a string or a LocalPath)

getpath()[source]¶

Returns the current working directory as a LocalPath object

__call__(*args, **kwds)[source]¶

A context manager used to chdir into a directory and then chdir back to the previous location; much like pushd/popd.

Parameters:	newdir – The destination director (a string or a LocalPath)

class plumbum.path.remote.StatRes(tup)[source]¶

POSIX-like stat result

__weakref__¶

list of weak references to the object (if defined)

class plumbum.path.remote.RemotePath(remote, *parts)[source]¶

The class implementing remote-machine paths

basename¶

The basename component of this path

dirname¶

The dirname component of this path

uid¶

The user that owns this path. The returned value is a FSUser object which behaves like an int (as expected from uid), but it also has a .name attribute that holds the string-name of the user

gid¶

The group that owns this path. The returned value is a FSUser object which behaves like an int (as expected from gid), but it also has a .name attribute that holds the string-name of the group

join(*parts)[source]¶

Joins this path with any number of paths

list()[source]¶

Returns the files in this directory

isdir()[source]¶

Returns True if this path is a directory, False otherwise

isfile()[source]¶

Returns True if this path is a regular file, False otherwise

islink()[source]¶

Returns True if this path is a symbolic link, False otherwise

exists()[source]¶

Returns True if this path exists, False otherwise

glob(pattern)[source]¶

Returns a (possibly empty) list of paths that matched the glob-pattern under this path

delete()[source]¶

Deletes this path (recursively, if a directory)

unlink()¶

Deletes this path (recursively, if a directory)

move(dst)[source]¶

Moves this path to a different location

copy(dst, override=False)[source]¶

Copies this path (recursively, if a directory) to the destination path

mkdir()[source]¶

Creates a directory at this path; if the directory already exists, silently ignore

read(encoding=None)[source]¶

returns the contents of this file. By default the data is binary (bytes), but you can specify the encoding, e.g., 'latin1' or 'utf8'

write(data, encoding=None)[source]¶

writes the given data to this file. By default the data is expected to be binary (bytes), but you can specify the encoding, e.g., 'latin1' or 'utf8'

chown(owner=None, group=None, recursive=None)[source]¶

Change ownership of this path.

Parameters:	owner – The owner to set (either uid or username), optional owner – The group to set (either gid or groupname), optional recursive – whether to change ownership of all contained files and subdirectories. Only meaningful when self is a directory. If None, the value will default to True if self is a directory, False otherwise.

chmod(mode)[source]¶

Change the mode of path to the numeric mode.

Parameters:	mode – file mode as for os.chmod

access(mode=0)[source]¶

Test file existence or permission bits

Parameters:	mode – a bitwise-or of access bits, or a string-representation thereof: 'f', 'x', 'r', 'w' for os.F_OK, os.X_OK, os.R_OK, os.W_OK

link(dst)[source]¶

Creates a hard link from self to dst

Parameters:	dst – the destination path

symlink(dst)[source]¶

Creates a symbolic link from self to dst

Parameters:	dst – the destination path

class plumbum.path.remote.RemoteWorkdir(remote)[source]¶

Remote working directory manipulator

chdir(newdir)[source]¶

Changes the current working directory to the given one

__weakref__¶

list of weak references to the object (if defined)

getpath()[source]¶

Returns the current working directory as a remote path <plumbum.path.remote.RemotePath> object

__call__(*args, **kwds)[source]¶

A context manager used to chdir into a directory and then chdir back to the previous location; much like pushd/popd.

Parameters:	newdir – The destination director (a string or a RemotePath)