229 lines
16 KiB
HTML
229 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>py lib: Main tools and APIs — py lib v1.0.0b1 documentation</title>
|
|
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '',
|
|
VERSION: '1.0.0b1',
|
|
COLLAPSE_MODINDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
<link rel="top" title="py lib v1.0.0b1 documentation" href="" />
|
|
<link rel="next" title="1. py.test" href="test.html" />
|
|
</head>
|
|
<body>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="test.html" title="1. py.test"
|
|
accesskey="N">next</a> |</li>
|
|
<li><a href="">py lib v1.0.0b1 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<div class="section" id="py-lib-main-tools-and-apis">
|
|
<h1>py lib: Main tools and APIs<a class="headerlink" href="#py-lib-main-tools-and-apis" title="Permalink to this headline">¶</a></h1>
|
|
<p><a class="reference external" href="test.html">py.test</a> write and deploy unit- and functional tests to multiple machines.</p>
|
|
<p><a class="reference external" href="execnet.html">py.execnet</a> rapidly deploy local or remote processes from your program.</p>
|
|
<p><a class="reference external" href="path.html">py.path</a>: use path objects to transparently access local and svn filesystems.</p>
|
|
<p><a class="reference external" href="code.html">py.code</a>: generate python code and use advanced introspection/traceback support.</p>
|
|
</div>
|
|
<div class="section" id="minor-support-functionality">
|
|
<h1>Minor support functionality<a class="headerlink" href="#minor-support-functionality" title="Permalink to this headline">¶</a></h1>
|
|
<p><a class="reference external" href="bin.html">py lib scripts</a> to make python development easier.</p>
|
|
<p><a class="reference external" href="xml.html">py.xml</a> for generating in-memory xml/html object trees</p>
|
|
<p><a class="reference external" href="io.html">py.io</a>: Helper Classes for Capturing of Input/Output</p>
|
|
<p><a class="reference external" href="log.html">py.log</a>: an alpha document about the ad-hoc logging facilities</p>
|
|
<p><a class="reference external" href="misc.html">miscellaneous features</a> describes some small but nice py lib features.</p>
|
|
</div>
|
|
<div class="section" id="full-contents">
|
|
<h1>Full Contents<a class="headerlink" href="#full-contents" title="Permalink to this headline">¶</a></h1>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference external" href="test.html">1. py.test</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="test-quickstart.html">1.1. Quickstart</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="test-features.html">1.2. Features</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="test-plugins.html">1.3. Included plugins</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="test-ext.html">1.4. Writing plugins</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="test-dist.html">1.5. Distributed testing</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="test-config.html">1.6. Test configuration</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="test-examples.html">1.7. Working Examples</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="impl-test.html">1.8. Implementation and Customization of <tt class="docutils literal"><span class="pre">py.test</span></tt></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="execnet.html">2. py.execnet</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="execnet.html#gateways-immediately-spawn-local-or-remote-process">2.1. Gateways: immediately spawn local or remote process</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="execnet.html#remote-exec-execute-source-code-remotely">2.2. remote_exec: execute source code remotely</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="execnet.html#channels-bidirectionally-exchange-data-between-hosts">2.3. Channels: bidirectionally exchange data between hosts</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="execnet.html#xspec-string-specification-for-gateway-type-and-configuration">2.4. XSpec: string specification for gateway type and configuration</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="execnet.html#examples-of-py-execnet-usage">2.5. Examples of py.execnet usage</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="path.html">3. py.path</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="path.html#path-implementations-provided-by-py-path">3.1. Path implementations provided by <tt class="docutils literal"><span class="pre">py.path</span></tt></a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="path.html#common-vs-specific-api">3.2. Common vs. specific API</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="path.html#known-problems-limitations">3.3. Known problems / limitations</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="path.html#future-plans">3.4. Future plans</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="code.html">4. py.code</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="code.html#contents-of-the-library">4.1. Contents of the library</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="code.html#the-wrappers">4.2. The wrappers</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="bin.html">5. <tt class="docutils literal"><span class="pre">py/bin/</span></tt> scripts</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="bin.html#py-test">5.1. <tt class="docutils literal"><span class="pre">py.test</span></tt></a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="bin.html#py-cleanup">5.2. <tt class="docutils literal"><span class="pre">py.cleanup</span></tt></a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="bin.html#py-countloc">5.3. <tt class="docutils literal"><span class="pre">py.countloc</span></tt></a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="bin.html#py-lookup">5.4. <tt class="docutils literal"><span class="pre">py.lookup</span></tt></a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="bin.html#py-rest">5.5. <tt class="docutils literal"><span class="pre">py.rest</span></tt></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="xml.html">6. py.xml: Lightweight and flexible xml/html generation</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="xml.html#motivation">6.1. Motivation</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="xml.html#a-pythonic-object-model-please">6.2. a pythonic object model , please</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="io.html">7. py.io</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="io.html#io-capturing-examples">7.1. IO Capturing examples</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="log.html">8. py.log documentation and musings</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="log.html#foreword">8.1. Foreword</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="log.html#logging-organisation">8.2. Logging organisation</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="log.html#using-the-py-log-library">8.3. Using the py.log library</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="misc.html">9. Miscellaneous features of the py lib</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="misc.html#mapping-the-standard-python-library-into-py">9.1. Mapping the standard python library into py</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="misc.html#support-for-interaction-with-system-utilities-binaries">9.2. Support for interaction with system utilities/binaries</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="misc.html#cross-python-version-compatibility-helpers">9.3. Cross-Python Version compatibility helpers</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="why_py.html">10. Why, who, what and how do you do <em>the py lib</em>?</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="why_py.html#why-did-we-start-the-py-lib">10.1. Why did we start the py lib?</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="why_py.html#what-is-the-py-libs-current-focus">10.2. What is the py libs current focus?</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="why_py.html#how-does-py-development-work">10.3. How does py development work?</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="why_py.html#who-is-we">10.4. Who is “we”?</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="future.html">11. Visions and ideas for further development of the py lib</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="future.html#distribute-tests-ad-hoc-across-multiple-platforms">11.1. Distribute tests ad-hoc across multiple platforms</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="future.html#make-apigen-useful-for-more-projects">11.2. Make APIGEN useful for more projects</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="future.html#consider-apigen-and-pdb-integration">11.3. Consider APIGEN and pdb integration</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="future.html#distribute-channels-programs-across-networks">11.4. Distribute channels/programs across networks</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="future.html#benchmarking-and-persistent-storage">11.5. Benchmarking and persistent storage</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="future.html#refactor-path-implementations-to-use-a-filesystem-abstraction">11.6. Refactor path implementations to use a Filesystem Abstraction</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="future.html#integrate-interactive-completion">11.7. Integrate interactive completion</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="future.html#consider-more-features">11.8. Consider more features</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="coding-style.html">12. Coding Style for the Py lib and friendly applications</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="coding-style.html#honour-pep-8-style-guide-for-python-code">12.1. Honour PEP 8: Style Guide for Python Code</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="coding-style.html#documentation-and-testing">12.2. Documentation and Testing</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="coding-style.html#naming">12.3. naming</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="coding-style.html#committing">12.4. committing</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="coding-style.html#miscellaneous">12.5. Miscellaneous</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="links.html">13. Links</a></li>
|
|
<li class="toctree-l1"><a class="reference external" href="contact.html">14. Contact and communication</a></li>
|
|
<li class="toctree-l1"><a class="reference external" href="download.html">15. Downloading</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="download.html#easy-install-py">15.1. “easy_install py”</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="download.html#installing-on-debian-or-fedora">15.2. Installing on Debian or Fedora</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="download.html#downloading-a-tar-zip-archive-and-installing-that">15.3. Downloading a tar/zip archive and installing that</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="download.html#installing-from-subversion-develop-mode">15.4. Installing from subversion / develop mode</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="download.html#working-with-multiple-py-lib-versions-svn-externals">15.5. Working with multiple py lib versions / svn externals</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="releases.html">16. Release notes</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="release-1.0.0.html">16.1. py lib 0.9.0: py.test, distributed execution, greenlets and more</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="release-0.9.2.html">16.2. py lib 0.9.2: bugfix release</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="release-0.9.0.html">16.3. py lib 1.0.0: XXX</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="simple">
|
|
<li><a class="reference external" href="genindex.html"><em>Index</em></a></li>
|
|
<li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li>
|
|
<li><a class="reference external" href="search.html"><em>Search Page</em></a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="">Table Of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference external" href="">py lib: Main tools and APIs</a></li>
|
|
<li><a class="reference external" href="#minor-support-functionality">Minor support functionality</a></li>
|
|
<li><a class="reference external" href="#full-contents">Full Contents</a><ul>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="test.html"
|
|
title="next chapter">1. py.test</a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/index.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
<div id="searchbox" style="display: none">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="search.html" method="get">
|
|
<input type="text" name="q" size="18" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<p class="searchtip" style="font-size: 90%">
|
|
Enter search terms or a module, class or function name.
|
|
</p>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="test.html" title="1. py.test"
|
|
>next</a> |</li>
|
|
<li><a href="">py lib v1.0.0b1 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2009, Holger Krekel.
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.7.
|
|
</div>
|
|
</body>
|
|
</html> |