Welcome to py’s documentation!

see CHANGELOG for latest changes.

Contents:

• installation info in a nutshell
  • easy install or pip py
  • Working from version control or a tarball
  • activating a checkout with setuptools
  • Mailing list and issue tracker
• py.path
  • py.path.local - local file system path
    • basic interactive example
    • reference documentation
      • LocalPath
        • LocalPath.ImportMismatchError
          • LocalPath.ImportMismatchError.add_note()
          • LocalPath.ImportMismatchError.msg
          • LocalPath.ImportMismatchError.name
          • LocalPath.ImportMismatchError.name_from
          • LocalPath.ImportMismatchError.path
          • LocalPath.ImportMismatchError.with_traceback()
        • LocalPath.samefile()
        • LocalPath.remove()
        • LocalPath.computehash()
        • LocalPath.new()
        • LocalPath.dirpath()
        • LocalPath.join()
        • LocalPath.open()
        • LocalPath.check()
        • LocalPath.listdir()
        • LocalPath.size()
        • LocalPath.mtime()
        • LocalPath.copy()
        • LocalPath.rename()
        • LocalPath.dump()
        • LocalPath.mkdir()
        • LocalPath.write_binary()
        • LocalPath.write_text()
        • LocalPath.write()
        • LocalPath.ensure()
        • LocalPath.stat()
        • LocalPath.lstat()
        • LocalPath.setmtime()
        • LocalPath.chdir()
        • LocalPath.as_cwd()
        • LocalPath.realpath()
        • LocalPath.atime()
        • LocalPath.chmod()
        • LocalPath.pypkgpath()
        • LocalPath.pyimport()
        • LocalPath.sysexec()
        • LocalPath.sysfind()
        • LocalPath.get_temproot()
        • LocalPath.mkdtemp()
        • LocalPath.basename
        • LocalPath.bestrelpath()
        • LocalPath.chown()
        • LocalPath.common()
        • LocalPath.dirname
        • LocalPath.ensure_dir()
        • LocalPath.ext
        • LocalPath.fnmatch()
        • LocalPath.load()
        • LocalPath.make_numbered_dir()
        • LocalPath.mklinkto()
        • LocalPath.mksymlinkto()
        • LocalPath.move()
        • LocalPath.parts()
        • LocalPath.purebasename
        • LocalPath.read()
        • LocalPath.read_binary()
        • LocalPath.read_text()
        • LocalPath.readlines()
        • LocalPath.readlink()
        • LocalPath.relto()
        • LocalPath.visit()
  • py.path.svnurl and py.path.svnwc
    • svn path related API reference
      • SvnWCCommandPath
        • SvnWCCommandPath.strpath
        • SvnWCCommandPath.rev
        • SvnWCCommandPath.url
        • SvnWCCommandPath.dump()
        • SvnWCCommandPath.svnurl()
        • SvnWCCommandPath.switch()
        • SvnWCCommandPath.checkout()
        • SvnWCCommandPath.update()
        • SvnWCCommandPath.write()
        • SvnWCCommandPath.dirpath()
        • SvnWCCommandPath.ensure()
        • SvnWCCommandPath.mkdir()
        • SvnWCCommandPath.add()
        • SvnWCCommandPath.remove()
        • SvnWCCommandPath.copy()
        • SvnWCCommandPath.rename()
        • SvnWCCommandPath.lock()
        • SvnWCCommandPath.unlock()
        • SvnWCCommandPath.cleanup()
        • SvnWCCommandPath.status()
        • SvnWCCommandPath.diff()
        • SvnWCCommandPath.blame()
        • SvnWCCommandPath.commit()
        • SvnWCCommandPath.propset()
        • SvnWCCommandPath.propget()
        • SvnWCCommandPath.propdel()
        • SvnWCCommandPath.proplist()
        • SvnWCCommandPath.revert()
        • SvnWCCommandPath.new()
        • SvnWCCommandPath.join()
        • SvnWCCommandPath.info()
        • SvnWCCommandPath.listdir()
        • SvnWCCommandPath.open()
        • SvnWCCommandPath.log()
        • SvnWCCommandPath.size()
        • SvnWCCommandPath.mtime()
        • SvnWCCommandPath.basename
        • SvnWCCommandPath.bestrelpath()
        • SvnWCCommandPath.check()
        • SvnWCCommandPath.common()
        • SvnWCCommandPath.dirname
        • SvnWCCommandPath.ensure_dir()
        • SvnWCCommandPath.ext
        • SvnWCCommandPath.fnmatch()
        • SvnWCCommandPath.load()
        • SvnWCCommandPath.move()
        • SvnWCCommandPath.parts()
        • SvnWCCommandPath.purebasename
        • SvnWCCommandPath.read()
        • SvnWCCommandPath.read_binary()
        • SvnWCCommandPath.read_text()
        • SvnWCCommandPath.readlines()
        • SvnWCCommandPath.relto()
        • SvnWCCommandPath.samefile()
        • SvnWCCommandPath.visit()
      • SvnCommandPath
        • SvnCommandPath.open()
        • SvnCommandPath.dirpath()
        • SvnCommandPath.mkdir()
        • SvnCommandPath.copy()
        • SvnCommandPath.rename()
        • SvnCommandPath.remove()
        • SvnCommandPath.export()
        • SvnCommandPath.ensure()
        • SvnCommandPath.info()
        • SvnCommandPath.listdir()
        • SvnCommandPath.log()
        • SvnCommandPath.basename
        • SvnCommandPath.bestrelpath()
        • SvnCommandPath.check()
        • SvnCommandPath.common()
        • SvnCommandPath.dirname
        • SvnCommandPath.ensure_dir()
        • SvnCommandPath.ext
        • SvnCommandPath.fnmatch()
        • SvnCommandPath.join()
        • SvnCommandPath.load()
        • SvnCommandPath.move()
        • SvnCommandPath.mtime()
        • SvnCommandPath.new()
        • SvnCommandPath.parts()
        • SvnCommandPath.propget()
        • SvnCommandPath.proplist()
        • SvnCommandPath.purebasename
        • SvnCommandPath.read()
        • SvnCommandPath.read_binary()
        • SvnCommandPath.read_text()
        • SvnCommandPath.readlines()
        • SvnCommandPath.relto()
        • SvnCommandPath.samefile()
        • SvnCommandPath.size()
        • SvnCommandPath.url
        • SvnCommandPath.visit()
      • SvnAuth
  • Common vs. specific API, Examples
    • Searching .txt files
    • Working with Paths
    • Checking path types
    • Setting svn-properties
    • SVN authentication
  • Known problems / limitations
• py.code: higher level python code and introspection objects
  • Contents of the library
  • The wrappers
    • py.code.Code
      • Code
        • Code.path
        • Code.fullsource
        • Code.source()
        • Code.getargs()
    • py.code.Source
      • Source
        • Source.strip()
        • Source.putaround()
        • Source.indent()
        • Source.getstatement()
        • Source.getstatementrange()
        • Source.deindent()
        • Source.isparseable()
        • Source.compile()
    • py.code.Traceback
      • Traceback
        • Traceback.Entry
        • Traceback.cut()
        • Traceback.filter()
        • Traceback.getcrashentry()
        • Traceback.recursionindex()
    • py.code.Frame
      • Frame
        • Frame.statement
        • Frame.eval()
        • Frame.exec_()
        • Frame.repr()
        • Frame.getargs()
    • py.code.ExceptionInfo
      • ExceptionInfo
        • ExceptionInfo.type
        • ExceptionInfo.value
        • ExceptionInfo.tb
        • ExceptionInfo.typename
        • ExceptionInfo.traceback
        • ExceptionInfo.exconly()
        • ExceptionInfo.errisinstance()
        • ExceptionInfo.getrepr()
      • Traceback
        • Traceback.Entry
        • Traceback.cut()
        • Traceback.filter()
        • Traceback.getcrashentry()
        • Traceback.recursionindex()
• py.io
  • IO Capturing examples
    • py.io.StdCapture
    • py.io.StdCaptureFD
  • py.io object reference
    • StdCaptureFD
      • StdCaptureFD.resume()
      • StdCaptureFD.done()
      • StdCaptureFD.readouterr()
      • StdCaptureFD.call()
      • StdCaptureFD.reset()
      • StdCaptureFD.suspend()
    • StdCapture
      • StdCapture.done()
      • StdCapture.resume()
      • StdCapture.readouterr()
      • StdCapture.call()
      • StdCapture.reset()
      • StdCapture.suspend()
    • TerminalWriter
      • TerminalWriter.chars_on_current_line
      • TerminalWriter.width_of_current_line
• py.log documentation and musings
  • Foreword
  • Logging organisation
  • Using the py.log library
    • Importing
    • Creating a producer
    • Creating a consumer
    • Associating producers and consumers
    • Writing log messages
• py.xml: simple pythonic xml/html file generation
  • Motivation
  • a pythonic object model , please
    • generating arbitrary xml structures
    • basic example for generating html
    • CSS-styling your html Tags
    • More to come …
• Miscellaneous features of the py lib
  • Mapping the standard python library into py
  • Support for interaction with system utilities/binaries
    • The shell based approach
    • local paths have sysexec
    • finding an executable local path
  • Cross-Python Version compatibility helpers

Indices and tables

• Index

• Search Page