py Documentation - Read the Docs

Contents
1 installation info in a nutshell 3
1.1 easy install or pip py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Working from version control or a tarball . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3 activating a checkout with setuptools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.4 Mailing list and issue tracker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 py.path 5
2.1 py.path.local - local file system path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 py.path.svnurl and py.path.svnwc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.3 Common vs. specific API, Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.4 Known problems / limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3 py.code: higher level python code and introspection objects 19
3.1 Contents of the library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.2 The wrappers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4 py.io 25
4.1 IO Capturing examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.2 py.io object reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
5 py.log documentation and musings 27
5.1 Foreword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5.2 Logging organisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5.3 Using the py.log library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
6 py.xml: simple pythonic xml/html file generation 31
6.1 Motivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.2 a pythonic object model , please . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
7 Miscellaneous features of the py lib 35
7.1 Mapping the standard python library into py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
7.2 Support for interaction with system utilities/binaries . . . . . . . . . . . . . . . . . . . . . . . . . . 35
7.3 Cross-Python Version compatibility helpers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
8 1.4.27.dev 37
9 1.4.26 39
10 1.4.25 41
i