File Handling in Paver (paver.path)

Python 2.5+ path module that adds with-statement features.

class paver.path25.path

Represents a filesystem path.

For documentation on individual methods, consult their counterparts in os.path.

access(mode)

Return true if current user has access to this path.

mode - One of the constants os.F_OK, os.R_OK, os.W_OK, os.X_OK

atime

Last access time of the file.

bytes()

Open this file, read all bytes, return them as a string.

ctime

Creation time of the file.

dirs(pattern=None)

D.dirs() -> List of this directory’s subdirectories.

The elements of the list are path objects. This does not walk recursively into subdirectories (but see path.walkdirs).

With the optional ‘pattern’ argument, this only lists directories whose names match the given pattern. For example:

d.dirs('build-*')

drive

The drive specifier, for example ‘C:’. This is always empty on systems that don’t use drive specifiers.

expand()

Clean up a filename by calling expandvars(), expanduser(), and normpath() on it.

This is commonly everything needed to clean up a filename read from a configuration file, for example.

ext

The file extension, for example ‘.py’.

files(pattern=None)

D.files() -> List of the files in this directory.

The elements of the list are path objects. This does not walk into subdirectories (see path.walkfiles).

With the optional ‘pattern’ argument, this only lists files whose names match the given pattern. For example:

d.files('*.pyc')

fnmatch(pattern)

Return True if self.name matches the given pattern.

pattern - A filename pattern with wildcards,

for example '*.py'.

get_owner()

Return the name of the owner of this file or directory.

This follows symbolic links.

On Windows, this returns a name of the form ur’DOMAINUser Name’. On Windows, a group can own a file or directory.

classmethod getcwd()

Return the current working directory as a path object.

glob(pattern)

Return a list of path objects that match the pattern.

pattern - a path relative to this directory, with wildcards.

For example, path(‘/users’).glob(‘/bin/‘) returns a list of all the files users have in their bin directories.

joinpath(*args)

Join two or more path components, adding a separator character (os.sep) if needed. Returns a new path object.

lines(encoding=None, errors='strict', retain=True)

Open this file, read all lines, return them in a list.

Optional arguments:

encoding - The Unicode encoding (or character set) of

the file. The default is None, meaning the content of the file is read as 8-bit characters and returned as a list of (non-Unicode) str objects.

errors - How to handle Unicode errors; see help(str.decode)

for the options. Default is ‘strict’

retain - If true, retain newline characters; but all newline

character combinations (‘r’, ‘n’, ‘rn’) are translated to ‘n’. If false, newline characters are stripped off. Default is True.

This uses ‘U’ mode in Python 2.3 and later.

link(newpath)

Create a hard link at ‘newpath’, pointing to this file.

listdir(pattern=None)

D.listdir() -> List of items in this directory.

Use D.files() or D.dirs() instead if you want a listing of just files or just subdirectories.

The elements of the list are path objects.

With the optional ‘pattern’ argument, this only lists items whose names match the given pattern.

lstat()

Like path.stat(), but do not follow symbolic links.

mtime

Last-modified time of the file.

name

The name of this file or directory without the full path.

For example, path(‘/usr/local/lib/libpython.so’).name == ‘libpython.so’

namebase

The same as path.name, but with one file extension stripped off.

For example, path(‘/home/guido/python.tar.gz’).name == ‘python.tar.gz’, but path(‘/home/guido/python.tar.gz’).namebase == ‘python.tar’

open(mode='r')

Open this file. Return a file object.

owner

Name of the owner of this file or directory.

parent

This path’s parent directory, as a new path object.

For example, path(‘/usr/local/lib/libpython.so’).parent == path(‘/usr/local/lib’)

read_hash(hash_name)

Calculate given hash for this file.

List of supported hashes can be obtained from hashlib package. This reads the entire file.

read_hexhash(hash_name)

Calculate given hash for this file, returning hexdigest.

List of supported hashes can be obtained from hashlib package. This reads the entire file.

read_md5()

Calculate the md5 hash for this file.

This reads through the entire file.

readlink()

Return the path to which this symbolic link points.

The result may be an absolute or a relative path.

readlinkabs()

Return the path to which this symbolic link points.

The result is always an absolute path.

relpath()

Return this path as a relative path, based from the current working directory.

relpathto(dest)

Return a relative path from self to dest.

If there is no relative path from self to dest, for example if they reside on different drives in Windows, then this returns dest.abspath().

size

Size of the file, in bytes.

splitall()

Return a list of the path components in this path.

The first item in the list will be a path. Its value will be either os.curdir, os.pardir, empty, or the root directory of this path (for example, ‘/’ or ‘C:\’). The other items in the list will be strings.

path.path.joinpath(*result) will yield the original path.

splitdrive()

p.splitdrive() -> Return (p.drive, <the rest of p>).

Split the drive specifier from this path. If there is no drive specifier, p.drive is empty, so the return value is simply (path(‘’), p). This is always the case on Unix.

splitext()

p.splitext() -> Return (p.stripext(), p.ext).

Split the filename extension from this path and return the two parts. Either part may be empty.

The extension is everything from ‘.’ to the end of the last path segment. This has the property that if (a, b) == p.splitext(), then a + b == p.

splitpath()

p.splitpath() -> Return (p.parent, p.name).

stat()

Perform a stat() system call on this path.

statvfs()

Perform a statvfs() system call on this path.

stripext()

p.stripext() -> Remove one file extension from the path.

For example, path(‘/home/guido/python.tar.gz’).stripext() returns path(‘/home/guido/python.tar’).

symlink(newlink)

Create a symbolic link at ‘newlink’, pointing here.

text(encoding=None, errors='strict')

Open this file, read it in, return the content as a string.

This uses ‘U’ mode in Python 2.3 and later, so ‘rn’ and ‘r’ are automatically translated to ‘n’.

Optional arguments:

encoding - The Unicode encoding (or character set) of

the file. If present, the content of the file is decoded and returned as a unicode object; otherwise it is returned as an 8-bit str.

errors - How to handle Unicode errors; see help(str.decode)

for the options. Default is ‘strict’.

touch()

Set the access/modified times of this file to the current time. Create the file if it does not exist.

utime(times)

Set the access and modified times of this file.

walk(pattern=None, errors='strict')

D.walk() -> iterator over files and subdirs, recursively.

The iterator yields path objects naming each child item of this directory and its descendants. This requires that D.isdir().

This performs a depth-first traversal of the directory tree. Each directory is returned just before all its children.

The errors= keyword argument controls behavior when an error occurs. The default is ‘strict’, which causes an exception. The other allowed values are ‘warn’, which reports the error via warnings.warn(), and ‘ignore’.

walkdirs(pattern=None, errors='strict')

D.walkdirs() -> iterator over subdirs, recursively.

With the optional ‘pattern’ argument, this yields only directories whose names match the given pattern. For example, mydir.walkdirs('*test') yields only directories with names ending in ‘test’.

The errors= keyword argument controls behavior when an error occurs. The default is ‘strict’, which causes an exception. The other allowed values are ‘warn’, which reports the error via warnings.warn(), and ‘ignore’.

walkfiles(pattern=None, errors='strict')

D.walkfiles() -> iterator over files in D, recursively.

The optional argument, pattern, limits the results to files with names that match the pattern. For example, mydir.walkfiles('*.tmp') yields only files with the .tmp extension.

write_bytes(bytes, append=False)

Open this file and write the given bytes to it.

Default behavior is to overwrite any existing file. Call p.write_bytes(bytes, append=True) to append instead.

write_lines(lines, encoding=None, errors='strict', linesep='n', append=False)

Write the given lines of text to this file.

By default this overwrites any existing file at this path.

This puts a platform-specific newline sequence on every line. See ‘linesep’ below.

lines - A list of strings.

encoding - A Unicode encoding to use. This applies only if

‘lines’ contains any Unicode strings.

errors - How to handle errors in Unicode encoding. This

also applies only to Unicode strings.

linesep - The desired line-ending. This line-ending is

applied to every line. If a line already has any standard line ending (‘r’, ‘n’, ‘rn’, u’x85’, u’rx85’, u’u2028’), that will be stripped off and this will be used instead. The default is os.linesep, which is platform-dependent (‘rn’ on Windows, ‘n’ on Unix, etc.) Specify None to write the lines as-is, like file.writelines().

Use the keyword argument append=True to append lines to the file. The default is to overwrite the file. Warning: When you use this with Unicode data, if the encoding of the existing data in the file is different from the encoding you specify with the encoding= parameter, the result is mixed-encoding data, which can really confuse someone trying to read the file later.

write_text(text, encoding=None, errors='strict', linesep='n', append=False)

Write the given text to this file.

The default behavior is to overwrite any existing file; to append instead, use the ‘append=True’ keyword argument.

There are two differences between path.write_text() and path.write_bytes(): newline handling and Unicode handling. See below.

Parameters:

• text - str/unicode - The text to be written.
• encoding - str - The Unicode encoding that will be used. This is ignored if ‘text’ isn’t a Unicode string.
• errors - str - How to handle Unicode encoding errors. Default is ‘strict’. See help(unicode.encode) for the options. This is ignored if ‘text’ isn’t a Unicode string.
• linesep - keyword argument - str/unicode - The sequence of characters to be used to mark end-of-line. The default is os.linesep. You can also specify None; this means to leave all newlines as they are in ‘text’.
• append - keyword argument - bool - Specifies what to do if the file already exists (True: append to the end of it; False: overwrite it.) The default is False.

— Newline handling.

write_text() converts all standard end-of-line sequences (‘n’, ‘r’, and ‘rn’) to your platform’s default end-of-line sequence (see os.linesep; on Windows, for example, the end-of-line marker is ‘rn’).

If you don’t like your platform’s default, you can override it using the ‘linesep=’ keyword argument. If you specifically want write_text() to preserve the newlines as-is, use ‘linesep=None’.

This applies to Unicode text the same as to 8-bit text, except there are three additional standard Unicode end-of-line sequences: u’x85’, u’rx85’, and u’u2028’.

(This is slightly different from when you open a file for writing with fopen(filename, “w”) in C or open(filename, ‘w’) in Python.)

— Unicode

If ‘text’ isn’t Unicode, then apart from newline handling, the bytes are written verbatim to the file. The ‘encoding’ and ‘errors’ arguments are not used and must be omitted.

If ‘text’ is Unicode, it is first converted to bytes using the specified ‘encoding’ (or the default encoding if ‘encoding’ isn’t specified). The ‘errors’ argument applies only to this conversion.

paver.path25.pushd(*args, **kwds)

A context manager (Python 2.5+ only) for stepping into a directory and automatically coming back to the previous one. The original directory is returned. Usage is like this:

from __future__ import with_statement
# the above line is only needed for Python 2.5

from paver.easy import *

@task
def my_task():
    with pushd('new/directory') as old_dir:
        ...do stuff...