py Documentation - Read the Docs

py Documentation, Release 1.4.27.dev1
ignore is an Exception class that is ignoredwhen calling dirlist() on any of the paths (by default, all exceptions
are reported)
bf if True will cause a breadthfirst search instead of the default depthfirst. Default: False
sort if True will sort entries within each directory level.
class py._path.svnwc.SvnAuth(username, password, cache_auth=True, interactive=True)
container for auth information for Subversion
2.3 Common vs. specific API, Examples
All Path objects support a common set of operations, suitable for many use cases and allowing to transparently switch
the path object within an application (e.g. from “local” to “svnwc”). The common set includes functions such as
path.read() to read all data from a file, path.write() to write data, path.listdir() to get a list of directory entries,
path.check() to check if a node exists and is of a particular type, path.join() to get to a (grand)child, path.visit() to
recursively walk through a node’s children, etc. Only things that are not common on ‘normal’ filesystems (yet), such
as handling metadata (e.g. the Subversion “properties”) require using specific APIs.
A quick ‘cookbook’ of small examples that will be useful ‘in real life’, which also presents parts of the ‘common’
API, and shows some non-common methods:
2.3.1 Searching .txt files
Search for a particular string inside all files with a .txt extension in a specific directory.
>>> dirpath = temppath.ensure(’testdir’, dir=True)
>>> dirpath.join(’textfile1.txt’).write(’foo bar baz’)
>>> dirpath.join(’textfile2.txt’).write(’frob bar spam eggs’)
>>> subdir = dirpath.ensure(’subdir’, dir=True)
>>> subdir.join(’textfile1.txt’).write(’foo baz’)
>>> subdir.join(’textfile2.txt’).write(’spam eggs spam foo bar spam’)
>>> results = []
>>> for fpath in dirpath.visit(’*.txt’):
... if ’bar’ in fpath.read():
... results.append(fpath.basename)
>>> results.sort()
>>> results
[’textfile1.txt’, ’textfile2.txt’, ’textfile2.txt’]
2.3.2 Working with Paths
This example shows the py.path features to deal with filesystem paths Note that the filesystem is never touched, all
operations are performed on a string level (so the paths don’t have to exist, either):
>>> p1 = py.path.local(’/foo/bar’)
>>> p2 = p1.join(’baz/qux’)
>>> p2 == py.path.local(’/foo/bar/baz/qux’)
True
>>> sep = py.path.local.sep
>>> p2.relto(p1).replace(sep, ’/’) # os-specific path sep in the string
’baz/qux’
>>> p2.bestrelpath(p1).replace(sep, ’/’)
’../..’
>>> p2.join(p2.bestrelpath(p1)) == p1
16 Chapter 2. py.path