From commits-noreply at bitbucket.org Mon Aug 3 08:30:43 2009
From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org)
Date: Mon, 03 Aug 2009 06:30:43 -0000
Subject: [py-svn] commit/py-3k: yangyan5: make a simple test(test_test)
which will fail under python3.1
Message-ID: <20090803063043.31361.43806@domU-12-31-39-00-D4-C1.compute-1.internal>
1 new changeset in py-3k:
http://www.bitbucket.org/yangyan5/py-3k/changeset/5c0cfbe9469e/
changeset: r1165:5c0cfbe9469e
user: yangyan5
date: 2009-08-03 08:30:27
summary: make a simple test(test_test) which will fail under python3.1
affected #: 5 files (693 bytes)
Repository URL: http://bitbucket.org/yangyan5/py-3k/
--
This is a commit notification from bitbucket.org.
You are receiving this because you have the service
enabled, addressing the recipient of this email.
From hpk at codespeak.net Tue Aug 4 19:45:35 2009
From: hpk at codespeak.net (hpk at codespeak.net)
Date: Tue, 4 Aug 2009 19:45:35 +0200 (CEST)
Subject: [py-svn] r66740 - in py/trunk: . doc doc/announce doc/test
doc/test/plugin example/assertion example/execnet
example/funcarg example/funcarg/costlysetup/sub1
example/funcarg/costlysetup/sub2 py py/code py/code/testing
py/execnet py/execnet/testing py/io py/io/testing py/magic
py/magic/testing py/path py/path/svn py/process/testing
py/test py/test/dist py/test/dist/testing py/test/looponfail
py/test/plugin py/test/testing
Message-ID: <20090804174535.0D84516804C@codespeak.net>
Author: hpk
Date: Tue Aug 4 19:45:30 2009
New Revision: 66740
Added:
py/trunk/doc/test/plugin/
py/trunk/doc/test/plugin/capture.txt
py/trunk/doc/test/plugin/doctest.txt
py/trunk/doc/test/plugin/figleaf.txt
py/trunk/doc/test/plugin/hooklog.txt
py/trunk/doc/test/plugin/hookspec.txt
py/trunk/doc/test/plugin/index.txt
py/trunk/doc/test/plugin/keyword.txt
py/trunk/doc/test/plugin/links.txt
py/trunk/doc/test/plugin/monkeypatch.txt
py/trunk/doc/test/plugin/oejskit.txt
py/trunk/doc/test/plugin/pastebin.txt
py/trunk/doc/test/plugin/pdb.txt
py/trunk/doc/test/plugin/recwarn.txt
py/trunk/doc/test/plugin/restdoc.txt
py/trunk/doc/test/plugin/resultlog.txt
py/trunk/doc/test/plugin/terminal.txt
py/trunk/doc/test/plugin/unittest.txt
py/trunk/doc/test/plugin/xfail.txt
py/trunk/example/assertion/
py/trunk/example/assertion/failure_demo.py
py/trunk/example/assertion/test_failures.py
py/trunk/example/assertion/test_setup_flow_example.py
py/trunk/example/execnet/redirect_remote_output.py
py/trunk/example/execnet/svn-sync-repo.py
py/trunk/example/execnet/sysinfo.py
py/trunk/example/funcarg/conftest.py
py/trunk/example/funcarg/costlysetup/sub1/__init__.py
py/trunk/example/funcarg/costlysetup/sub2/__init__.py
py/trunk/py/test/dist/testing/acceptance_test.py
py/trunk/py/test/plugin/pytest_capture.py
py/trunk/py/test/plugin/pytest_keyword.py
py/trunk/py/test/plugin/pytest_pastebin.py
py/trunk/py/test/plugin/test_pytest_capture.py
py/trunk/py/test/plugin/test_pytest_runner_xunit.py
py/trunk/py/test/plugin/test_pytest_terminal.py
py/trunk/py/test/testing/test_install.py
Removed:
py/trunk/ez_setup.py
py/trunk/py/test/plugin/pytest_iocapture.py
py/trunk/py/test/plugin/pytest_pocoo.py
py/trunk/py/test/plugin/pytest_resultdb.py
py/trunk/py/test/testing/test_setup_functional.py
Modified:
py/trunk/.hgignore
py/trunk/CHANGELOG
py/trunk/MANIFEST
py/trunk/doc/announce/release-1.0.0.txt
py/trunk/doc/code.txt
py/trunk/doc/confrest.py
py/trunk/doc/contact.txt
py/trunk/doc/download.txt
py/trunk/doc/execnet.txt
py/trunk/doc/index.txt
py/trunk/doc/style.css
py/trunk/doc/test/config.txt
py/trunk/doc/test/extend.txt
py/trunk/doc/test/features.txt
py/trunk/doc/test/funcargs.txt
py/trunk/doc/test/quickstart.txt
py/trunk/doc/test/test.txt
py/trunk/py/__init__.py
py/trunk/py/code/excinfo.py
py/trunk/py/code/testing/test_excinfo.py
py/trunk/py/conftest.py
py/trunk/py/execnet/register.py
py/trunk/py/execnet/testing/test_gateway.py
py/trunk/py/io/stdcapture.py
py/trunk/py/io/terminalwriter.py
py/trunk/py/io/testing/test_stdcapture.py
py/trunk/py/magic/exprinfo.py
py/trunk/py/magic/testing/test_exprinfo.py
py/trunk/py/path/common.py
py/trunk/py/path/svn/wccommand.py
py/trunk/py/process/testing/test_forkedfunc.py
py/trunk/py/test/collect.py
py/trunk/py/test/config.py
py/trunk/py/test/defaultconftest.py
py/trunk/py/test/dist/dsession.py
py/trunk/py/test/dist/mypickle.py
py/trunk/py/test/dist/testing/test_dsession.py
py/trunk/py/test/dist/testing/test_nodemanage.py
py/trunk/py/test/dist/testing/test_txnode.py
py/trunk/py/test/dist/txnode.py
py/trunk/py/test/funcargs.py
py/trunk/py/test/looponfail/remote.py
py/trunk/py/test/plugin/hookspec.py
py/trunk/py/test/plugin/pytest__pytest.py
py/trunk/py/test/plugin/pytest_default.py
py/trunk/py/test/plugin/pytest_doctest.py
py/trunk/py/test/plugin/pytest_execnetcleanup.py
py/trunk/py/test/plugin/pytest_figleaf.py
py/trunk/py/test/plugin/pytest_hooklog.py
py/trunk/py/test/plugin/pytest_monkeypatch.py
py/trunk/py/test/plugin/pytest_pdb.py
py/trunk/py/test/plugin/pytest_pylint.py
py/trunk/py/test/plugin/pytest_pytester.py
py/trunk/py/test/plugin/pytest_recwarn.py
py/trunk/py/test/plugin/pytest_restdoc.py
py/trunk/py/test/plugin/pytest_resultlog.py
py/trunk/py/test/plugin/pytest_runner.py
py/trunk/py/test/plugin/pytest_terminal.py
py/trunk/py/test/plugin/pytest_unittest.py
py/trunk/py/test/plugin/pytest_xfail.py
py/trunk/py/test/plugin/test_pytest_runner.py
py/trunk/py/test/pluginmanager.py
py/trunk/py/test/pycollect.py
py/trunk/py/test/session.py
py/trunk/py/test/testing/acceptance_test.py
py/trunk/py/test/testing/test_config.py
py/trunk/py/test/testing/test_funcargs.py
py/trunk/py/test/testing/test_outcome.py
py/trunk/py/test/testing/test_parseopt.py
py/trunk/py/test/testing/test_pluginmanager.py
py/trunk/py/test/testing/test_pycollect.py
py/trunk/setup.py
Log:
snapshotting mercurial py-trunk (1.0.0) to py/trunk
Modified: py/trunk/.hgignore
==============================================================================
--- py/trunk/.hgignore (original)
+++ py/trunk/.hgignore Tue Aug 4 19:45:30 2009
@@ -11,3 +11,6 @@
*.pyo
*.swp
*.html
+
+build/
+py.egg-info
Modified: py/trunk/CHANGELOG
==============================================================================
--- py/trunk/CHANGELOG (original)
+++ py/trunk/CHANGELOG Tue Aug 4 19:45:30 2009
@@ -1,6 +1,81 @@
-Changes between 1.0.0b3 and 1.0.0
+Changes between 1.0.0b9 and 1.0.0
+=====================================
+
+* more terse reporting try to show filesystem path relatively to current dir
+* improve xfail output a bit
+
+Changes between 1.0.0b8 and 1.0.0b9
+=====================================
+
+* cleanly handle and report final teardown of test setup
+
+* fix svn-1.6 compat issue with py.path.svnwc().versioned()
+ (thanks Wouter Vanden Hove)
+
+* setup/teardown or collection problems now show as ERRORs
+ or with big "E"'s in the progress lines. they are reported
+ and counted separately.
+
+* dist-testing: properly handle test items that get locally
+ collected but cannot be collected on the remote side - often
+ due to platform/dependency reasons
+
+* simplified py.test.mark API - see keyword plugin documentation
+
+* integrate better with logging: capturing now by default captures
+ test functions and their immediate setup/teardown in a single stream
+
+* capsys and capfd funcargs now have a readouterr() and a close() method
+ (underlyingly py.io.StdCapture/FD objects are used which grew a
+ readouterr() method as well to return snapshots of captured out/err)
+
+* make assert-reinterpretation work better with comparisons not
+ returning bools (reported with numpy from thanks maciej fijalkowski)
+
+* reworked per-test output capturing into the pytest_iocapture.py plugin
+ and thus removed capturing code from config object
+
+* item.repr_failure(excinfo) instead of item.repr_failure(excinfo, outerr)
+
+
+Changes between 1.0.0b7 and 1.0.0b8
+=====================================
+
+* pytest_unittest-plugin is now enabled by default
+
+* introduced pytest_keyboardinterrupt hook and
+ refined pytest_sessionfinish hooked, added tests.
+
+* workaround a buggy logging module interaction ("closing already closed
+ files"). Thanks to Sridhar Ratnakumar for triggering.
+
+* if plugins use "py.test.importorskip" for importing
+ a dependency only a warning will be issued instead
+ of exiting the testing process.
+
+* many improvements to docs:
+ - refined funcargs doc , use the term "factory" instead of "provider"
+ - added a new talk/tutorial doc page
+ - better download page
+ - better plugin docstrings
+ - added new plugins page and automatic doc generation script
+
+* fixed teardown problem related to partially failing funcarg setups
+ (thanks MrTopf for reporting), "pytest_runtest_teardown" is now
+ always invoked even if the "pytest_runtest_setup" failed.
+
+* tweaked doctest output for docstrings in py modules,
+ thanks Radomir.
+
+Changes between 1.0.0b3 and 1.0.0b7
=============================================
+* renamed py.test.xfail back to py.test.mark.xfail to avoid
+ two ways to decorate for xfail
+
+* re-added py.test.mark decorator for setting keywords on functions
+ (it was actually documented so removing it was not nice)
+
* remove scope-argument from request.addfinalizer() because
request.cached_setup has the scope arg. TOOWTDI.
Modified: py/trunk/MANIFEST
==============================================================================
--- py/trunk/MANIFEST (original)
+++ py/trunk/MANIFEST Tue Aug 4 19:45:30 2009
@@ -1,10 +1,6 @@
-MANIFEST
-py/__init__.py
-setup.py
-.hgignore
-.hgtags
CHANGELOG
LICENSE
+MANIFEST
README.txt
_findpy.py
doc/announce/release-0.9.0.txt
@@ -32,13 +28,41 @@
doc/test/extend.txt
doc/test/features.txt
doc/test/funcargs.txt
+doc/test/plugin/capture.txt
+doc/test/plugin/doctest.txt
+doc/test/plugin/figleaf.txt
+doc/test/plugin/hooklog.txt
+doc/test/plugin/hookspec.txt
+doc/test/plugin/index.txt
+doc/test/plugin/keyword.txt
+doc/test/plugin/links.txt
+doc/test/plugin/monkeypatch.txt
+doc/test/plugin/oejskit.txt
+doc/test/plugin/pastebin.txt
+doc/test/plugin/pdb.txt
+doc/test/plugin/recwarn.txt
+doc/test/plugin/restdoc.txt
+doc/test/plugin/resultlog.txt
+doc/test/plugin/terminal.txt
+doc/test/plugin/unittest.txt
+doc/test/plugin/xfail.txt
doc/test/quickstart.txt
+doc/test/talks.txt
doc/test/test.txt
doc/test/xunit_setup.txt
doc/xml.txt
+example/assertion/failure_demo.py
+example/assertion/test_failures.py
+example/assertion/test_setup_flow_example.py
example/execnet/popen_read_multiple.py
+example/execnet/redirect_remote_output.py
+example/execnet/svn-sync-repo.py
+example/execnet/sysinfo.py
+example/funcarg/conftest.py
example/funcarg/costlysetup/conftest.py
+example/funcarg/costlysetup/sub1/__init__.py
example/funcarg/costlysetup/sub1/test_quick.py
+example/funcarg/costlysetup/sub2/__init__.py
example/funcarg/costlysetup/sub2/test_two.py
example/funcarg/mysetup/__init__.py
example/funcarg/mysetup/conftest.py
@@ -56,11 +80,9 @@
example/genhtml.py
example/genhtmlcss.py
example/genxml.py
-example/pytest/failure_demo.py
-example/pytest/test_failures.py
-example/pytest/test_setup_flow_example.py
-ez_setup.py
+makepluginlist.py
py/LICENSE
+py/__init__.py
py/_com.py
py/bin/_findpy.py
py/bin/_genscripts.py
@@ -296,6 +318,7 @@
py/test/dist/mypickle.py
py/test/dist/nodemanage.py
py/test/dist/testing/__init__.py
+py/test/dist/testing/acceptance_test.py
py/test/dist/testing/test_dsession.py
py/test/dist/testing/test_mypickle.py
py/test/dist/testing/test_nodemanage.py
@@ -314,27 +337,30 @@
py/test/plugin/conftest.py
py/test/plugin/hookspec.py
py/test/plugin/pytest__pytest.py
+py/test/plugin/pytest_capture.py
py/test/plugin/pytest_default.py
py/test/plugin/pytest_doctest.py
py/test/plugin/pytest_execnetcleanup.py
py/test/plugin/pytest_figleaf.py
py/test/plugin/pytest_hooklog.py
-py/test/plugin/pytest_iocapture.py
+py/test/plugin/pytest_keyword.py
py/test/plugin/pytest_monkeypatch.py
+py/test/plugin/pytest_pastebin.py
py/test/plugin/pytest_pdb.py
-py/test/plugin/pytest_pocoo.py
py/test/plugin/pytest_pylint.py
py/test/plugin/pytest_pytester.py
py/test/plugin/pytest_recwarn.py
py/test/plugin/pytest_restdoc.py
-py/test/plugin/pytest_resultdb.py
py/test/plugin/pytest_resultlog.py
py/test/plugin/pytest_runner.py
py/test/plugin/pytest_terminal.py
py/test/plugin/pytest_tmpdir.py
py/test/plugin/pytest_unittest.py
py/test/plugin/pytest_xfail.py
+py/test/plugin/test_pytest_capture.py
py/test/plugin/test_pytest_runner.py
+py/test/plugin/test_pytest_runner_xunit.py
+py/test/plugin/test_pytest_terminal.py
py/test/pluginmanager.py
py/test/pycollect.py
py/test/session.py
@@ -353,6 +379,7 @@
py/test/testing/test_deprecated_api.py
py/test/testing/test_funcargs.py
py/test/testing/test_genitems.py
+py/test/testing/test_install.py
py/test/testing/test_outcome.py
py/test/testing/test_parseopt.py
py/test/testing/test_pickling.py
@@ -360,7 +387,6 @@
py/test/testing/test_pycollect.py
py/test/testing/test_recording.py
py/test/testing/test_session.py
-py/test/testing/test_setup_functional.py
py/test/testing/test_traceback.py
py/test/web/__init__.py
py/test/web/exception.py
@@ -383,4 +409,5 @@
py/xmlobj/testing/test_html.py
py/xmlobj/testing/test_xml.py
py/xmlobj/visit.py
-py/xmlobj/xml.py
\ No newline at end of file
+py/xmlobj/xml.py
+setup.py
\ No newline at end of file
Modified: py/trunk/doc/announce/release-1.0.0.txt
==============================================================================
--- py/trunk/doc/announce/release-1.0.0.txt (original)
+++ py/trunk/doc/announce/release-1.0.0.txt Tue Aug 4 19:45:30 2009
@@ -1,54 +1,63 @@
-py.test / py lib 1.0.0: new test plugins, funcargs and cleanups
-============================================================================
-Welcome to the 1.0 release bringing new flexibility and
-power to testing with Python. Main news:
+pylib 1.0.0 released: testing-with-python innovations continue
+--------------------------------------------------------------------
-* improved test architecture, featuring super-simple project
- specific or cross-project single-file plugins, e.g:
+Took a few betas but finally i uploaded a `1.0.0 py lib release`_,
+featuring the mature and powerful py.test tool and "execnet-style"
+*elastic* distributed programming. With the new release, there are
+many new advanced automated testing features - here is a quick summary:
- * pytest_unittest.py: run traditional unittest.py tests
- * pytest_xfail.py: mark tests as "expected to fail"
- * pytest_pocoo.py: automatically send tracebacks to pocoo paste service
- * pytest_monkeypatch.py: safely patch parts of your environment in a test function
- * pytest_figleaf.py: generate html coverage reports
- * pytest_resultlog.py: generate buildbot-friendly output
+* funcargs_ - pythonic zero-boilerplate fixtures for Python test functions :
- and many more!
-
-* funcargs - bringing new flexibilty and zero-boilerplate to Python testing:
-
- - cleanly separated test code and test configuration and test value setup
+ - totally separates test code, test configuration and test setup
- ideal for integration and functional tests
- - new generative tests -> deprecation of yield-generated tests
+ - allows for flexible and natural test parametrization schemes
-* distributed testing and distributed execution (py.execnet):
+* new `plugin architecture`_, allowing easy-to-write project-specific and cross-project single-file plugins. The most notable new external plugin is `oejskit`_ which naturally enables **running and reporting of javascript-unittests in real-life browsers**.
- - new unified "TX" URL scheme for specifying remote resources
- - new sync/async ways to handle multiple remote processes
- - much improved documentation
+* many new features done in easy-to-improve `default plugins`_, highlights:
+ * xfail: mark tests as "expected to fail" and report separately.
+ * pastebin: automatically send tracebacks to pocoo paste service
+ * capture: flexibly capture stdout/stderr of subprocesses, per-test ...
+ * monkeypatch: safely monkeypatch modules/classes from within tests
+ * unittest: run and integrate traditional unittest.py tests
+ * figleaf: generate html coverage reports with the figleaf module
+ * resultlog: generate buildbot-friendly reporting output
+ * ...
-See the py.test documentation for more info:
+* `distributed testing`_ and `elastic distributed execution`_:
- http://pytest.org
+ - new unified "TX" URL scheme for specifying remote processes
+ - new distribution modes "--dist=each" and "--dist=load"
+ - new sync/async ways to handle 1:N communication
+ - improved documentation
-The py lib also got smaller and focuses on offering much of the
-well-tested py.test code in independent namespaces:
+The py lib continues to offer most of the functionality used by
+the testing tool in `independent namespaces`_.
-* py.execnet: ad-hoc code distribution to SSH, Socket and local sub processes
-* py.code: higher-level introspection and dynamic generation of python code
-* py.path: path abstractions over local and subversion files
+Some non-test related code, notably greenlets/co-routines and
+api-generation now live as their own projects which simplifies the
+installation procedure because no C-Extensions are required anymore.
-Some non-strictly-test related code, notably greenlets/co-routines
-and apigen now live on their own and have been removed, also simplifying
-the installation procedures.
+The whole package should work well with Linux, Win32 and OSX, on Python
+2.3, 2.4, 2.5 and 2.6. (Expect Python3 compatibility soon!)
-The whole package works well with Linux, OSX and Win32, on
-Python 2.3, 2.4, 2.5 and 2.6. (Expect Python3 compatibility soon!)
+For more info, see the py.test and py lib documentation:
-Download/Install: http://codespeak.net/py/dist/download.html
+ http://pytest.org
+
+ http://pylib.org
-best,
+have fun,
holger
+.. _`independent namespaces`: http://pylib.org
+.. _`funcargs`: http://codespeak.net/py/dist/test/funcargs.html
+.. _`plugin architecture`: http://codespeak.net/py/dist/test/extend.html
+.. _`default plugins`: http://codespeak.net/py/dist/test/plugin/index.html
+.. _`distributed testing`: http://codespeak.net/py/dist/test/dist.html
+.. _`elastic distributed execution`: http://codespeak.net/py/dist/execnet.html
+.. _`1.0.0 py lib release`: http://pypi.python.org/pypi/py
+.. _`oejskit`: http://codespeak.net/py/dist/test/plugin/oejskit.html
+
Modified: py/trunk/doc/code.txt
==============================================================================
--- py/trunk/doc/code.txt (original)
+++ py/trunk/doc/code.txt Tue Aug 4 19:45:30 2009
@@ -1,8 +1,8 @@
-=======
-py.code
-=======
+================================================================================
+py.code: higher level python code and introspection objects
+================================================================================
-The :api:`py.code` part of the 'py lib' contains some functionality to help
+The :api:`py.code` part of the pylib contains some functionality to help
dealing with Python code objects. Even though working with Python's internal
code objects (as found on frames and callables) can be very powerful, it's
usually also quite cumbersome, because the API provided by core Python is
Modified: py/trunk/doc/confrest.py
==============================================================================
--- py/trunk/doc/confrest.py (original)
+++ py/trunk/doc/confrest.py Tue Aug 4 19:45:30 2009
@@ -4,9 +4,27 @@
html = py.xml.html
+class css:
+ #pagetitle = "pagetitle"
+ contentspace = "contentspace"
+ menubar = "menubar"
+ navspace = "navspace"
+ versioninfo = "versioninfo"
+
class Page(object):
doctype = ('\n')
+ googlefragment = """
+
+
+"""
def __init__(self, project, title, targetpath, stylesheeturl=None,
type="text/html", encoding="ISO-8859-1"):
@@ -22,8 +40,8 @@
self._root = html.html(self.head, self.body)
self.fill()
- def a_href(self, name, url):
- return html.a(name, class_="menu", href=url)
+ def a_href(self, name, url, **kwargs):
+ return html.a(name, class_="menu", href=url, **kwargs)
def a_docref(self, name, relhtmlpath):
docpath = self.project.docpath
@@ -39,20 +57,29 @@
def fill_menubar(self):
items = [
- self.a_docref("index", "index.html"),
+ self.a_docref("pylib index", "index.html"),
+ self.a_docref("test doc-index", "test/test.html"),
+ self.a_docref("test quickstart", "test/quickstart.html"),
+ self.a_docref("test features", "test/features.html"),
+ self.a_docref("test plugins", "test/plugin/index.html"),
+ self.a_docref("py.execnet", "execnet.html"),
+ #self.a_docref("py.code", "code.html"),
#self.a_apigenref("api", "api/index.html"),
#self.a_apigenref("source", "source/index.html"),
#self.a_href("source", "http://bitbucket.org/hpk42/py-trunk/src/"),
self.a_href("issues", "http://bitbucket.org/hpk42/py-trunk/issues/"),
self.a_docref("contact", "contact.html"),
- self.a_docref("download", "download.html"),
+ self.a_docref("install", "download.html"),
]
- items2 = [items.pop(0)]
- sep = " "
- for item in items:
- items2.append(sep)
- items2.append(item)
- self.menubar = html.div(id="menubar", *items2)
+ self.menubar = html.div(id=css.menubar, *[
+ html.div(item) for item in items])
+ version = py.version
+ self.menubar.insert(0,
+ html.div("%s" % (py.version), style="font-style: italic;")
+ )
+ #self.a_href("%s-%s" % (self.title, py.version),
+ # "http://pypi.python.org/pypi/py/%s" % version,
+ #id="versioninfo",
def fill(self):
content_type = "%s;charset=%s" %(self.type, self.encoding)
@@ -65,18 +92,19 @@
type="text/css"))
self.fill_menubar()
- self.metaspace = html.div(
- html.div(self.title, class_="project_title"),
- self.menubar,
- id='metaspace')
-
- self.body.append(self.project.logo)
- self.body.append(self.metaspace)
- self.contentspace = html.div(id="contentspace")
+ self.body.append(html.div(
+ self.project.logo,
+ self.menubar,
+ id=css.navspace,
+ ))
+
+ #self.body.append(html.div(self.title, id=css.pagetitle))
+ self.contentspace = html.div(id=css.contentspace)
self.body.append(self.contentspace)
def unicode(self, doctype=True):
page = self._root.unicode()
+ page = page.replace("", self.googlefragment + "")
if doctype:
return self.doctype + page
else:
@@ -115,9 +143,9 @@
encoding = 'latin1'
logo = html.div(
html.a(
- html.img(alt="py lib", id='pyimg', height=114, width=154,
+ html.img(alt="py lib", id='pyimg', height=114/2, width=154/2,
src="http://codespeak.net/img/pylib.png"),
- href="http://codespeak.net"))
+ href="http://pylib.org"))
Page = PyPage
def __init__(self, sourcepath=None):
@@ -173,21 +201,21 @@
stylesheet=stylesheet, encoding=encoding)
content = strip_html_header(content, encoding=encoding)
- page = self.Page(self, "[%s] " % txtpath.purebasename,
+ title = txtpath.purebasename
+ if txtpath.dirpath().basename == "test":
+ title = "py.test " + title
+ # title = "[%s] %s" % (txtpath.purebasename, py.version)
+ page = self.Page(self, title,
outputpath, stylesheeturl=stylesheet)
try:
- svninfo = txtpath.info()
- modified = " modified %s by %s" % (worded_time(svninfo.mtime),
- getrealname(svninfo.last_author))
- except (KeyboardInterrupt, SystemExit):
- raise
- except:
+ modified = py.process.cmdexec(
+ "hg tip --template 'modified {date|shortdate}'"
+ )
+ except py.process.cmdexec.Error:
modified = " "
- page.contentspace.append(
- html.div(html.div(modified, style="float: right; font-style: italic;"),
- id = 'docinfoline'))
+ #page.body.append(html.div(modified, id="docinfoline"))
page.contentspace.append(py.xml.raw(content))
outputpath.ensure().write(page.unicode().encode(encoding))
Modified: py/trunk/doc/contact.txt
==============================================================================
--- py/trunk/doc/contact.txt (original)
+++ py/trunk/doc/contact.txt Tue Aug 4 19:45:30 2009
@@ -1,18 +1,20 @@
-Contact and communication
+Contact and Communication points
===================================
-- **#pylib on irc.freenode.net**: you are welcome to lurk or ask questions!
+- `py-dev developers list`_ announcements and discussions.
-- `py-dev developers list`_ development mailing list.
+- #pylib on irc.freenode.net IRC channel for random questions.
- `tetamap`_: Holger Krekel's blog, often about testing and py.test related news.
-- `py-svn general commit mailing list`_ to follow all development commits.
+- `py-svn general commit mailing list`_ to follow development commits,
-- `development bug/feature tracker`_ this roundup instance serves to file bugs and track issues.
- (soon to be substitued by a google-code or other hosted one).
+- `bitbucket issue tracker`_ use this bitbucket issue tracker to report
+ bugs or request features.
-- `merlinux.eu`_ offers teaching and consulting services.
+- `merlinux.eu`_ offers on-site teaching and consulting services.
+
+.. _`bitbucket issue tracker`: http://bitbucket.org/hpk42/py-trunk/issues/
.. _`merlinux.eu`: http://merlinux.eu
Modified: py/trunk/doc/download.txt
==============================================================================
--- py/trunk/doc/download.txt (original)
+++ py/trunk/doc/download.txt Tue Aug 4 19:45:30 2009
@@ -1,15 +1,16 @@
-==============
-Downloading
-==============
+..
+ ==============
+ Downloading
+ ==============
-.. _`PyPI project page`: http://pypi.python.org/pypi/py/
+ .. _`PyPI project page`: http://pypi.python.org/pypi/py/
-Latest Release, see `PyPI project page`_
+ Latest Release, see `PyPI project page`_
-"easy_install py"
+using setuptools / easy_install
===================================================
-If you have a working `setuptools installation`_ you can install from the command line::
+With a working `setuptools installation`_ you can type::
easy_install -U py
@@ -25,95 +26,103 @@
you can still install the py lib but without greenlets - look
below for the ``install_lib`` target.
-**IMPORTANT NOTE**: if you are using Windows and have previous
-installations of the py lib on your system, please download
+**IMPORTANT NOTE**: if you are using Windows and have
+0.8 versions of the py lib on your system, please download
and execute http://codespeak.net/svn/py/build/winpathclean.py
This will check that no previous files are getting in the way.
-(Unfortunately we don't know about a way to execute this
-code automatically during the above install).
+You can find out the py lib version with::
-Installing on Debian or Fedora
-===================================
+ import py
+ print py.version
-On Debian systems look for ``python-codespeak-lib``.
-*This package is probably outdated - if somebody
-can help with bringing this up to date,
-that would be very much appreciated.*
-Dwayne Bailey has thankfully put together a Fedora `RPM`_.
+.. _`checkout`:
-.. _`RPM`: http://translate.sourceforge.net/releases/testing/fedora/pylib-0.9.2-1.fc9.noarch.rpm
+Installing from version control / develop mode
+=================================================
-.. _`setuptools installation`: http://pypi.python.org/pypi/setuptools
+To follow development or help with fixing things
+for the next release, checkout the complete code
+and documentation source with mercurial_::
+ hg clone https://bitbucket.org/hpk42/py-trunk/
-Downloading a tar/zip archive and installing that
-===================================================
+With a working `setuptools installation`_ you can then issue::
-Go to the python package index (pypi) and download a tar or zip file:
+ python setup.py develop
- http://pypi.python.org/pypi/py/
+in order to work with your checkout version.
-and unpack it to a directory, where you then type::
+For enhancing one of the plugins you may go to
+the ``py/test/plugin/`` sub directory.
- python setup.py install
+.. _mercurial: http://mercurial.selenic.com/wiki/
-If you don't have a working C-compiler you can do::
+.. _`no-setuptools`:
- python setup.py install_lib
+Working without setuptools / from source
+==========================================
-You will then not be able to use greenlets but otherwise
-``py.test`` and all tools and APIs are fine to use.
+If you have a checkout_ or a tarball_ it is actually not neccessary to issue
+``setup.py`` commands in order to use py lib and its tools. You can
+simply add the root directory to ``PYTHONPATH`` and ``py/bin`` or
+``py\bin\win32`` to your ``PATH`` settings.
-Installing from subversion / develop mode
-============================================
+There are also helper scripts to set the environment
+on windows::
-To follow development or help with fixing things
-for the next release, checkout the complete code
-and documentation source::
+ c:\\path\to\checkout\py\env.cmd
- svn co http://codespeak.net/svn/py/release/0.9.x py-0.9.x
+and on linux/osx you can add something like this to
+your shell initialization::
-You can then issue::
+ eval `python ~/path/to/checkout/py/env.py`
- python setup.py develop
+both of which which will get you good settings
+for ``PYTHONPATH`` and ``PATH``.
-in order to work with your checkout version.
+Note also that the command line scripts will look
+for "nearby" py libs, so if you have a layout like this::
-other interesting svn checkout points::
+ mypkg/
+ subpkg1/
+ tests/
+ tests/
+ py/
- http://codespeak.net/
- svn/py/release # release tags and branches
- svn/py/dist # latest stable (may or may not be a release)
- svn/py/trunk # head development / merge point
+then issuing ``py.test subpkg1`` will use the py lib
+from that projects root directory.
+Debian and RPM packages
+===================================
-Working with multiple py lib versions / svn externals
-=======================================================
+As of July 2009 pytest/pylib 1.0 RPMs and Debian packages
+are not yet available. So you will only find older
+versions.
-If you happen to have multiple versions of the py lib
-around or you ship the py lib as an svn-external to
-then you might want to use py lib scripts more directly.
-For example if you have a project layout like this::
+On Debian systems look for ``python-codespeak-lib``.
+*But this package is probably outdated - if somebody
+can help with bringing this up to date,
+that would be very much appreciated.*
- mypkg/
- subpkg1/
- tests/
- tests/
- py/ # as svn-external, could be specific tag/version
+Dwayne Bailey has thankfully put together a Fedora `RPM`_.
-then you want to make sure that the actual local py lib is used
-and not another system-wide version. For this you need to add
-``py/bin`` or ``py\bin\win32`` respectively to your system's PATH settings.
+.. _`RPM`: http://translate.sourceforge.net/releases/testing/fedora/pylib-0.9.2-1.fc9.noarch.rpm
-You can do this by executing (on windows) a script to set the environment::
+.. _`setuptools installation`: http://pypi.python.org/pypi/setuptools
- c:\\path\to\checkout\py\env.cmd
+.. _tarball:
-or on linux/osx you can add something like this to your shell
-initialization::
+Installing from a TAR archive
+===================================================
- eval `python ~/path/to/checkout/py/env.py`
+You need a working `setuptools installation`_.
+
+Go to the python package index (pypi) and download a tar file:
-to get good settings for PYTHONPATH and PATH.
+ http://pypi.python.org/pypi/py/
+
+and unpack it to a directory, where you then type::
+
+ python setup.py install
Modified: py/trunk/doc/execnet.txt
==============================================================================
--- py/trunk/doc/execnet.txt (original)
+++ py/trunk/doc/execnet.txt Tue Aug 4 19:45:30 2009
@@ -1,13 +1,26 @@
-==========
-py.execnet
-==========
+==============================================================================
+py.execnet: *elastic* distributed programming
+==============================================================================
-``py.execnet`` allows to:
+``execnet`` helps you to:
-* instantiate local or remote Python Processes
+* ad-hoc instantiate local or remote Python Processes
* send code for execution in one or many processes
-* asynchronously send and receive data between processes through channels
-* completely avoid manual installation steps on remote places
+* send and receive data between processes through channels
+
+One of it's unique features is that it uses a **zero-install**
+technique: no manual installation steps are required on
+remote places, only a basic working Python interpreter
+and some input/output connection to it.
+
+There is a `EuroPython2009 talk`_ from July 2009 with
+examples and some pictures.
+
+.. contents::
+ :local:
+ :depth: 2
+
+.. _`EuroPython2009 talk`: http://codespeak.net/download/py/ep2009-execnet.pdf
Gateways: immediately spawn local or remote process
===================================================
Modified: py/trunk/doc/index.txt
==============================================================================
--- py/trunk/doc/index.txt (original)
+++ py/trunk/doc/index.txt Tue Aug 4 19:45:30 2009
@@ -1,19 +1,19 @@
-py lib: Main tools and APIs
-===================================
-
-.. _`PyPI project page`: http://pypi.python.org/pypi?%3Aaction=pkg_edit&name=py
+py lib: testing and distributed programming library
+====================================================
-Latest Release, see `PyPI project page`_
+The ``py`` lib has several namespaces which help with testing,
+generating and distributing code across machines. Here is
+documentation on the most interesting ones:
`py.test`_ write and deploy unit- and functional tests to multiple machines.
-`py.execnet`_ rapidly deploy local or remote processes from your program.
+`py.execnet`_ elastic distributed programming.
-`py.path`_: use path objects to transparently access local and svn filesystems.
+`py.code`_: generate code and use advanced introspection/traceback support.
-`py.code`_: generate python code and use advanced introspection/traceback support.
+`py.path`_: use path objects to transparently access local and svn filesystems.
-Minor support functionality
+Other (minor) support functionality
===================================
`py lib scripts`_ to make python development easier.
@@ -27,6 +27,10 @@
`miscellaneous features`_ describes some small but nice py lib features.
+.. _`PyPI project page`: http://pypi.python.org/pypi/py/
+
+For the latest Release, see `PyPI project page`_
+
.. _`download and installation`: download.html
.. _`py-dev at codespeak net`: http://codespeak.net/mailman/listinfo/py-dev
.. _`py.execnet`: execnet.html
@@ -39,27 +43,3 @@
.. _`py.xml`: xml.html
.. _`miscellaneous features`: misc.html
-Full Contents
-===================================
-
-.. toctree::
- :maxdepth: 2
-
- test
- execnet
- path
- code
- bin
- xml
- io
- log
- misc
- coding-style
- contact
- download
- releases
-
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
Modified: py/trunk/doc/style.css
==============================================================================
--- py/trunk/doc/style.css (original)
+++ py/trunk/doc/style.css Tue Aug 4 19:45:30 2009
@@ -67,10 +67,6 @@
dl {
}
-dt {
- font-weight: bold;
-}
-
dd {
line-height: 1.5em;
margin-bottom: 1em;
@@ -85,15 +81,18 @@
code {
color: Black;
/*background-color: #dee7ec;*/
- background-color: #cccccc;
+ /*background-color: #cccccc;*/
}
pre {
padding: 1em;
- border: 1px solid #8cacbb;
+ border: 1px dotted #8cacbb;
color: Black;
+ /*
background-color: #dee7ec;
background-color: #cccccc;
+ background-color: #dee7ec;
+ */
overflow: auto;
}
@@ -111,7 +110,6 @@
span.menu_selected {
color: black;
- font: 140% Verdana, Helvetica, Arial, sans-serif;
text-decoration: none;
padding-right: 0.3em;
background-color: #cccccc;
@@ -120,14 +118,13 @@
a.menu {
/*color: #3ba6ec; */
- font: 140% Verdana, Helvetica, Arial, sans-serif;
+ font: 120% Verdana, Helvetica, Arial, sans-serif;
text-decoration: none;
padding-right: 0.3em;
}
a.menu[href]:visited, a.menu[href]:link{
/*color: #3ba6ec; */
- font: 140% Verdana, Helvetica, Arial, sans-serif;
text-decoration: none;
}
@@ -135,11 +132,12 @@
/*color: black;*/
}
-div.project_title{
+div#pagetitle{
/*border-spacing: 20px;*/
font: 160% Verdana, Helvetica, Arial, sans-serif;
color: #3ba6ec;
vertical-align: middle;
+ left: 80 px;
padding-bottom: 0.3em;
}
@@ -566,7 +564,11 @@
padding: 0px;
}
-div.pagename {
+a#versioninfo {
+ color: blue;
+}
+
+div#pagename {
font-size: 140%;
color: blue;
text-align: center;
@@ -593,37 +595,6 @@
/*background-color: #dddddd; */
}
-span.wikiuserpref {
- padding-top: 1em;
- font-size: 120%;
-}
-
-div.wikitrail {
- vertical-align: bottom;
- /*font-size: -1;*/
- padding-top: 1em;
- display: none;
-}
-
-div.wikiaction {
- vertical-align: middle;
- /*border-bottom: 1px solid #8cacbb;*/
- padding-bottom:1em;
- text-align: left;
- width: 100%;
-}
-
-div.wikieditmenu {
- text-align: right;
-}
-
-form.wikiedit {
- border: 1px solid #8cacbb;
- background-color: #f0f0f0;
- background-color: #fabf00;
- padding: 1em;
- padding-right: 0em;
-}
div.legenditem {
padding-top: 0.5em;
@@ -662,6 +633,10 @@
border-bottom: 1px solid #8CACBB;
}
+h2 {
+ border-bottom: 1px dotted #8CACBB;
+}
+
h1, h2, h3, h4, h5, h6 {
color: Black;
@@ -677,11 +652,10 @@
h1 { font-size: 145%; }
-h2 { font-size: 135%; }
-h3 { font-size: 125%; }
-h4 { font-size: 120%; }
-h5 { font-size: 110%; }
-h6 { font-size: 80%; }
+h2 { font-size: 115%; }
+h3 { font-size: 105%; }
+h4 { font-size: 100%; }
+h5 { font-size: 100%; }
h1 a { text-decoration: None;}
@@ -769,25 +743,16 @@
}
img#pyimg {
- position: absolute;
- top: 4px;
- left: 4px;
+ float: left;
}
div#navspace {
position: absolute;
- top: 100px;
- left: 11px;
font-size: 100%;
width: 150px;
overflow: hidden; /* scroll; */
}
-div#metaspace {
- position: absolute;
- top: 10px;
- left: 170px;
-}
div#errorline {
position: relative;
@@ -799,7 +764,6 @@
position: absolute;
/* font: 120% "Times New Roman", serif;*/
font: 110% Verdana, Helvetica, Arial, sans-serif;
- top: 100px;
left: 170px;
margin-right: 5px;
}
@@ -810,16 +774,17 @@
}
/* for the documentation page */
-div#docinfoline {
- position: relative;
- top: 5px;
- left: 0px;
-
- /*background-color: #dee7ec; */
- padding: 5pt;
- padding-bottom: 1em;
+div#title{
+
+ font-size: 110%;
color: black;
- /*border-width: 1pt;
+
+
+ /*background-color: #dee7ec;
+ #padding: 5pt;
+ #padding-bottom: 1em;
+ #color: black;
+ border-width: 1pt;
border-style: solid;*/
}
Modified: py/trunk/doc/test/config.txt
==============================================================================
--- py/trunk/doc/test/config.txt (original)
+++ py/trunk/doc/test/config.txt Tue Aug 4 19:45:30 2009
@@ -1,5 +1,6 @@
-Test configuration
-========================
+.. contents::
+ :local:
+ :depth: 2
available test options
-----------------------------
@@ -68,25 +69,28 @@
.. _`basetemp`:
-per-testrun temporary directories
+Temporary directories
-------------------------------------------
``py.test`` runs provide means to create per-test session
temporary (sub) directories through the config object.
-You can create directories like this:
+You can create directories by calling a method
+on the config object:
-.. XXX use a more local example, just with "config"
+- ``config.mktemp(basename)``: create and returns a new tempdir
-.. sourcecode: python
+- ``config.ensuretemp(basename)``: create or return a new tempdir
- import py
- basetemp = py.test.config.ensuretemp()
- basetemp_subdir = py.test.config.ensuretemp("subdir")
-
-By default, ``py.test`` creates a ``pytest-NUMBER`` directory
+tempdirs are created as sub directories of a per-session testdir
and will keep around the directories of the last three
test runs. You can also set the base temporary directory
with the `--basetemp`` option. When distributing
tests on the same machine, ``py.test`` takes care to
pass around the basetemp directory such that all temporary
files land below the same basetemp directory.
+
+The config object is available when implementing `function arguments`_
+or `extensions`_ and can otherwise be globally accessed as ``py.test.config``.
+
+.. _`function arguments`: funcargs.html
+.. _`extensions`: extend.html
Modified: py/trunk/doc/test/extend.txt
==============================================================================
--- py/trunk/doc/test/extend.txt (original)
+++ py/trunk/doc/test/extend.txt Tue Aug 4 19:45:30 2009
@@ -4,15 +4,18 @@
.. _`local plugin`:
-py.test implements much of its functionality by calling `well specified
-hooks`_. Python modules which contain such hook functions are called
-plugins. Hook functions are discovered in ``conftest.py`` files or
-in **named** plugins. ``conftest.py`` files are sometimes called "anonymous"
-or conftest plugins. They are useful for keeping test extensions close
-to the application package. Named plugins are normal python modules or packages
-that can be distributed separately. Named plugins need to follow a naming pattern;
-they have an all lowercase ``pytest_`` prefixed name. While conftest plugins are
-discovered automatically, named plugins must be explicitely specified.
+py.test implements much of its functionality by calling `well specified
+hooks`_. Python modules which contain such hook functions are called
+plugins. Hook functions are discovered in ``conftest.py`` files or in
+`named plugins`_. ``conftest.py`` files are sometimes called
+"anonymous" or conftest plugins. They are useful for keeping test
+extensions close to your application. Named plugins are normal python
+modules or packages that can be distributed separately. Named plugins
+need to follow a naming pattern; they have an all lowercase ``pytest_``
+prefixed name. While conftest plugins are discovered automatically,
+named plugins must be explicitely specified.
+
+.. _`named plugins`: plugin/index.html
.. _`tool startup`:
.. _`test tool starts up`:
@@ -95,7 +98,7 @@
information on particular hooks. It's sensible to look at existing
plugins so see example usages and start off with your own plugin.
-.. _`hook definition specification`: http://bitbucket.org/hpk42/py-trunk/src/tip/py/test/plugin/hookspec.py
+.. _`hook definition specification`: plugin/hookspec.html
.. _`configuration hooks`:
@@ -132,8 +135,8 @@
If you want to make global helper functions or objects available
to your test code you can implement:
- def pytest_namespace(config):
- """ return dictionary with items to be made available on py.test. """
+ def pytest_namespace():
+ """ return dictionary with items to be made available on py.test. namespace """
All such returned items will be made available directly on
the ``py.test`` namespace.
Modified: py/trunk/doc/test/features.txt
==============================================================================
--- py/trunk/doc/test/features.txt (original)
+++ py/trunk/doc/test/features.txt Tue Aug 4 19:45:30 2009
@@ -1,32 +1,29 @@
==================================================
-py.test Features
+py.test features
==================================================
py.test is an extensible tool for running all kinds
-of tests one one or more machines. It supports a variety
-of testing methods for your Python application and modules,
-including unit, functional, integration and doc-testing.
-
-It is used in projects that run more than 10000 tests
-daily as well as single-python-module projects.
+of tests on one or more machines. It supports a variety
+of testing methods including unit, functional, integration
+and doc-testing. It is used in projects that run more
+than 10 thousand tests regularly as well as in single-file projects.
py.test presents a clean and powerful command line interface
-and strives to generally make testing a fun effort.
-
-py.test 1.0 works across linux, windows and osx
-and on Python 2.3 - Python 2.6.
+and strives to generally make testing a fun no-boilerplate effort.
+It works and is tested against linux, windows and osx
+on CPython 2.3 - CPython 2.6.
-More detailed feature list:
-
-.. contents::
+.. contents:: List of Contents
:depth: 1
+.. _`autocollect`:
+
automatically collects and executes tests
===============================================
-py.test discovers tests automatically by inspect specified
+py.test discovers tests automatically by inspecting specified
directories or files. By default, it collects all python
-modules a leading ``test_`` or trailing ``_test`` filename.
+modules with a leading ``test_`` or trailing ``_test`` filename.
From each test module every function with a leading ``test_``
or class with a leading ``Test`` name is collected.
@@ -237,13 +234,19 @@
By default, all filename parts and
class/function names of a test function are put into the set
-of keywords for a given test. You may specify additional
+of keywords for a given test. You can specify additional
kewords like this::
- @py.test.mark(webtest=True)
+ @py.test.mark.webtest
def test_send_http():
...
+and then use those keywords to select tests. See the `pytest_keyword`_
+plugin for more information.
+
+.. _`pytest_keyword`: plugin/keyword.html
+
+
disabling a test class
----------------------
@@ -290,7 +293,8 @@
easy to extend
=========================================
-Since 1.0 py.test has advanced `extension mechanisms`_.
+Since 1.0 py.test has advanced `extension mechanisms`_
+and a growing `list of plugins`_.
One can can easily modify or add aspects for for
purposes such as:
@@ -299,6 +303,7 @@
* running non-python tests
* managing custom test state setup
+.. _`list of plugins`: plugin/index.html
.. _`extension mechanisms`: extend.html
.. _`reStructured Text`: http://docutils.sourceforge.net
Modified: py/trunk/doc/test/funcargs.txt
==============================================================================
--- py/trunk/doc/test/funcargs.txt (original)
+++ py/trunk/doc/test/funcargs.txt Tue Aug 4 19:45:30 2009
@@ -1,45 +1,36 @@
-======================================================
-**funcargs**: test setup and parametrization
-======================================================
-
-Since version 1.0 py.test introduces test function arguments,
-in short "funcargs" for your Python test functions. The basic idea
-that your unit-, functional- or acceptance test functions can name
-arguments and py.test will discover a matching provider from your
-test configuration. The mechanism complements the automatic
-discovery of test files, classes and functions which follows
-the `Convention over Configuration`_ strategy. By discovering and
-calling functions ("funcarg providers") that provide values for your
-actual test functions it becomes easy to:
-
-* separate test function code from test state setup/fixtures
-* manage test value setup and teardown depending on
- command line options or configuration
-* parametrize multiple runs of the same test functions
-* present useful debug info if setting up test state goes wrong
-
-Using funcargs, test functions become more expressive,
-more "templaty" and more test-aspect oriented. In fact,
-funcarg mechanisms are meant to be complete and
-convenient enough to
-
-* substitute and improve on most usages of `xUnit style`_ setup.
- For a simple example of how funcargs compare
- to xUnit setup, see the `blog post about
- the monkeypatch funcarg`_.
-
-* substitute and improve on all usages of `old-style generative tests`_,
- i.e. test functions that use the "yield" statement.
- Using yield in test functions is deprecated since 1.0.
+==========================================================
+**funcargs**: test function arguments FTW
+==========================================================
+
+Since version 1.0 py.test features the "funcarg" mechanism which
+allows a test function to take arguments independently provided
+by factory functions. Factory functions allow to encapsulate
+all setup and fixture glue code into nicely separated objects
+and provide a natural way for writing python test functions.
+Compared to `xUnit style`_ the new mechanism is meant to:
+
+* make test functions easier to write and to read
+* isolate test fixture creation to a single place
+* bring new flexibility and power to test state management
+* naturally extend towards parametrizing test functions
+ with multiple argument sets
+ (superseding `old-style generative tests`_)
+* enable creation of zero-boilerplate test helper objects that
+ interact with the execution of a test function, see the
+ `blog post about the monkeypatch funcarg`_.
+If you find issues or have further suggestions for improving
+the mechanism you are welcome to checkout `contact possibilities`_ page.
+
+.. _`contact possibilities`: ../contact.html
.. _`blog post about the monkeypatch funcarg`: http://tetamap.wordpress.com/2009/03/03/monkeypatching-in-unit-tests-done-right/
.. _`xUnit style`: xunit_setup.html
.. _`old-style generative tests`: features.html#generative-tests
-.. _`funcarg provider`:
+.. _`funcarg factory`:
-funcarg providers: instantiating test function arguments
+funcarg factories: setting up test function arguments
==============================================================
Test functions can specify one ore more arguments ("funcargs")
@@ -49,22 +40,22 @@
.. sourcecode:: python
- # ./test_simpleprovider.py
+ # ./test_simplefactory.py
def pytest_funcarg__myfuncarg(request):
return 42
def test_function(myfuncarg):
assert myfuncarg == 17
-If you run this with ``py.test test_simpleprovider.py`` you see something like this:
+If you run this with ``py.test test_simplefactory.py`` you see something like this:
.. sourcecode:: python
============================ test session starts ============================
python: platform linux2 -- Python 2.6.2
- test object 1: /home/hpk/hg/py/trunk/example/funcarg/test_simpleprovider.py
+ test object 1: /home/hpk/hg/py/trunk/example/funcarg/test_simplefactory.py
- test_simpleprovider.py F
+ test_simplefactory.py F
================================= FAILURES ==================================
_______________________________ test_function _______________________________
@@ -75,7 +66,7 @@
> assert myfuncarg == 17
E assert 42 == 17
- test_simpleprovider.py:6: AssertionError
+ test_simplefactory.py:6: AssertionError
========================= 1 failed in 0.11 seconds ==========================
@@ -84,7 +75,7 @@
1. py.test discovers the ``test_function`` because of the ``test_`` prefix.
The test function needs a function argument named ``myfuncarg``.
- A matching provider function is discovered by looking for the special
+ A matching factory function is discovered by looking for the special
name ``pytest_funcarg__myfuncarg``.
2. ``pytest_funcarg__myfuncarg(request)`` is called and
@@ -96,18 +87,17 @@
to use one that isn't available, an error with a list of
available function argument is provided.
-For more interesting provider functions that make good use of the
+For more interesting factory functions that make good use of the
`request object`_ please see the `application setup tutorial example`_.
.. _`request object`:
-funcarg request objects
+funcarg factory request objects
------------------------------------------
-Request objects are passed to funcarg providers. They
-encapsulate a request for a function argument for a
-specific test function. Request objects allow providers
-to access test configuration and test context:
+Request objects are passed to funcarg factories and allow
+to access test configuration, test context and `useful caching
+and finalization helpers`_. Here is a list of attributes:
``request.function``: python function object requesting the argument
@@ -119,9 +109,11 @@
``request.param``: if exists was passed by a `parametrizing test generator`_
+.. _`useful caching and finalization helpers`:
+
-teardown/cleanup after test function execution
-------------------------------------------------
+registering funcarg related finalizers/cleanup
+----------------------------------------------------
.. sourcecode:: python
@@ -130,7 +122,8 @@
Calling ``request.addfinalizer()`` is useful for scheduling teardown
functions. Here is an example for providing a ``myfile``
-object that is to be closed when the test function finishes.
+object that is to be closed when the execution of a
+test function finishes.
.. sourcecode:: python
@@ -140,54 +133,52 @@
return myfile
-perform scope-specific setup and cleanup
----------------------------------------------
+managing fixtures across test modules and test runs
+----------------------------------------------------------
.. sourcecode:: python
- def cached_setup(setup, teardown=None, scope="module", keyextra=None):
+ def cached_setup(setup, teardown=None, scope="module", extrakey=None):
""" cache and return result of calling setup().
- The scope determines the cache key and ``keyextra`` adds to the cachekey.
- The scope also determines when teardown(result) will be called.
- valid scopes:
+ The scope and the ``extrakey`` determine the cache key.
+ The scope also determines when teardown(result)
+ will be called. valid scopes are:
scope == 'function': when the single test function run finishes.
scope == 'module': when tests in a different module are run
scope == 'session': when tests of the session have run.
"""
-example for providing a value that is to be setup only once during a test run:
+Calling ``request.cached_setup()`` helps you to manage fixture
+objects across several scopes. For example, for creating a Database object
+that is to be setup only once during a test session you can use the helper
+like this:
.. sourcecode:: python
- def pytest_funcarg__db(request):
+ def pytest_funcarg__database(request):
return request.cached_setup(
- lambda: ExpensiveSetup(request.config.option.db),
- lambda val: val.close(),
- scope="run"
+ setup=lambda: Database("..."),
+ teardown=lambda val: val.close(),
+ scope="session"
)
requesting values of other funcargs
---------------------------------------------
-Inside a funcarg provider, you sometimes may want to use a
-different function argument which may be specified with
-the test function or not. For such purposes you can
-dynamically request a funcarg value:
-
.. sourcecode:: python
def getfuncargvalue(name):
- """ Lookup and call function argument provider for the given name.
- Each function argument is only requested once per function setup.
+ """ Lookup and call function argument factory for the given name.
+ Each function argument is only created once per function setup.
"""
-You can also use this function if you want to `decorate a funcarg`_
-locally, i.e. you want to provide the normal value but add/do something
-extra. If a provider cannot be found a ``request.Error`` exception will be
-raised.
-
+``request.getfuncargvalue(name)`` calls another funcarg factory function.
+You can use this function if you want to `decorate a funcarg`_, i.e.
+you want to provide the "normal" value but add something
+extra. If a factory cannot be found a ``request.Error``
+exception will be raised.
.. _`test generators`:
.. _`parametrizing test generator`:
@@ -195,7 +186,7 @@
generating parametrized tests with funcargs
===========================================================
-You can directly parametrize multiple runs of the same test
+You can parametrize multiple runs of the same test
function by adding new test function calls with different
function argument values. Let's look at a simple self-contained
example:
@@ -280,7 +271,7 @@
invocations for a given test function.
``param`` if specified will be seen by any
-`funcarg provider`_ as a ``request.param`` attribute.
+`funcarg factory`_ as a ``request.param`` attribute.
Setting it is called *indirect parametrization*.
Indirect parametrization is preferable if test values are
@@ -322,12 +313,12 @@
answer = app.question()
assert answer == 42
-To run this test py.test needs to find and call a provider to
+To run this test py.test needs to find and call a factory to
obtain the required ``mysetup`` function argument. The test
function interacts with the provided application specific setup.
To provide the ``mysetup`` function argument we write down
-a provider method in a `local plugin`_ by putting the
+a factory method in a `local plugin`_ by putting the
following code into a local ``conftest.py``:
.. sourcecode:: python
@@ -448,7 +439,7 @@
conftest.py:23: [1] Skipped: 'specify ssh host with --ssh'
====================== 1 skipped in 0.11 seconds ======================
-Note especially how the test function could stay clear knowing about how to construct test state values or when to skip and with what message. The test function can concentrate on actual test code and test state providers can interact with execution of tests.
+Note especially how the test function could stay clear knowing about how to construct test state values or when to skip and with what message. The test function can concentrate on actual test code and test state factories can interact with execution of tests.
If you specify a command line option like ``py.test --ssh=python.org`` the test will get un-skipped and actually execute.
@@ -503,13 +494,14 @@
For larger scale setups it's sometimes useful to decorare
a funcarg just for a particular test module. We can
-extend the `accept example`_ by putting this in our test class:
+extend the `accept example`_ by putting this in our test module:
.. sourcecode:: python
- def pytest_funcarg__accept(self, request):
- arg = request.getfuncargvalue("accept") # call the next provider
- # create a special layout in our tempdir
+ # method of class
+ def pytest_funcarg__accept(request):
+ # call the next factory in the conftest.py file
+ arg = request.getfuncargvalue("accept")
arg.tmpdir.mkdir("special")
return arg
@@ -517,8 +509,8 @@
def test_sometest(self, accept):
assert accept.tmpdir.join("special").check()
-Our module level provider will be invoked first and it can
-ask its request object to call the next provider and then
+Our module-level "accept" factory is invoked first and here
+it asks its request object to call the next factory and then
decorate its result. This mechanism allows us to stay
ignorant of how/where the function argument is provided -
in our example from a `conftest plugin`_.
@@ -543,7 +535,7 @@
considered an explicit registration mechanism, i.e. calling a register
method on the config object. But lacking a good use case for this
indirection and flexibility we decided to go for `Convention over
-Configuration`_ and allow to directly specify the provider. It has the
+Configuration`_ and allow to directly specify the factory. It has the
positive implication that you should be able to "grep" for
``pytest_funcarg__MYARG`` and will find all providing sites (usually
exactly one).
Added: py/trunk/doc/test/plugin/capture.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/capture.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,131 @@
+
+pytest_capture plugin
+=====================
+
+configurable per-test stdout/stderr capturing mechanisms.
+
+.. contents::
+ :local:
+
+This plugin captures stdout/stderr output for each test separately.
+In case of test failures this captured output is shown grouped
+togtther with the test.
+
+The plugin also provides test function arguments that help to
+assert stdout/stderr output from within your tests, see the
+`funcarg example`_.
+
+
+Capturing of input/output streams during tests
+---------------------------------------------------
+
+By default ``sys.stdout`` and ``sys.stderr`` are substituted with
+temporary streams during the execution of tests and setup/teardown code.
+During the whole testing process it will re-use the same temporary
+streams allowing to play well with the logging module which easily
+takes ownership on these streams.
+
+Also, 'sys.stdin' is substituted with a file-like "null" object that
+does not return any values. This is to immediately error out
+on tests that wait on reading something from stdin.
+
+You can influence output capturing mechanisms from the command line::
+
+ py.test -s # disable all capturing
+ py.test --capture=sys # set StringIO() to each of sys.stdout/stderr
+ py.test --capture=fd # capture stdout/stderr on Filedescriptors 1/2
+
+If you set capturing values in a conftest file like this::
+
+ # conftest.py
+ conf_capture = 'fd'
+
+then all tests in that directory will execute with "fd" style capturing.
+
+sys-level capturing
+------------------------------------------
+
+Capturing on 'sys' level means that ``sys.stdout`` and ``sys.stderr``
+will be replaced with StringIO() objects.
+
+FD-level capturing and subprocesses
+------------------------------------------
+
+The ``fd`` based method means that writes going to system level files
+based on the standard file descriptors will be captured, for example
+writes such as ``os.write(1, 'hello')`` will be captured properly.
+Capturing on fd-level will include output generated from
+any subprocesses created during a test.
+
+.. _`funcarg example`:
+
+Example Usage of the capturing Function arguments
+---------------------------------------------------
+
+You can use the `capsys funcarg`_ and `capfd funcarg`_ to
+capture writes to stdout and stderr streams. Using the
+funcargs frees your test from having to care about setting/resetting
+the old streams and also interacts well with py.test's own
+per-test capturing. Here is an example test function:
+
+.. sourcecode:: python
+
+ def test_myoutput(capsys):
+ print "hello"
+ print >>sys.stderr, "world"
+ out, err = capsys.readouterr()
+ assert out == "hello\n"
+ assert err == "world\n"
+ print "next"
+ out, err = capsys.readouterr()
+ assert out == "next\n"
+
+The ``readouterr()`` call snapshots the output so far -
+and capturing will be continued. After the test
+function finishes the original streams will
+be restored. If you want to capture on
+the filedescriptor level you can use the ``capfd`` function
+argument which offers the same interface.
+
+.. _`capsys funcarg`:
+
+
+the 'capsys' test function argument
+-----------------------------------
+
+captures writes to sys.stdout/sys.stderr and makes
+them available successively via a ``capsys.readouterr()`` method
+which returns a ``(out, err)`` tuple of captured snapshot strings.
+
+.. _`capfd funcarg`:
+
+
+the 'capfd' test function argument
+----------------------------------
+
+captures writes to file descriptors 1 and 2 and makes
+snapshotted ``(out, err)`` string tuples available
+via the ``capsys.readouterr()`` method.
+
+command line options
+--------------------
+
+
+``-s``
+ shortcut for --capture=no.
+``--capture=method``
+ set capturing method during tests: fd (default)|sys|no.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_capture.py`_ plugin source code
+2. put it somewhere as ``pytest_capture.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/doctest.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/doctest.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,40 @@
+
+pytest_doctest plugin
+=====================
+
+collect and execute doctests from modules and test files.
+
+.. contents::
+ :local:
+
+Usage
+-------------
+
+By default all files matching the ``test_*.txt`` pattern will
+be run with the ``doctest`` module. If you issue::
+
+ py.test --doctest-modules
+
+all python files in your projects will be doctest-run
+as well.
+
+command line options
+--------------------
+
+
+``--doctest-modules``
+ search all python files for doctests
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_doctest.py`_ plugin source code
+2. put it somewhere as ``pytest_doctest.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/figleaf.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/figleaf.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,35 @@
+
+pytest_figleaf plugin
+=====================
+
+write and report coverage data with 'figleaf'.
+
+.. contents::
+ :local:
+
+
+
+command line options
+--------------------
+
+
+``-F``
+ trace python coverage with figleaf and write HTML for files below the current working dir
+``--figleaf-data=FIGLEAFDATA``
+ path to coverage tracing file.
+``--figleaf-html=FIGLEAFHTML``
+ path to the coverage html dir.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_figleaf.py`_ plugin source code
+2. put it somewhere as ``pytest_figleaf.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/hooklog.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/hooklog.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,31 @@
+
+pytest_hooklog plugin
+=====================
+
+log invocations of extension hooks to a file.
+
+.. contents::
+ :local:
+
+
+
+command line options
+--------------------
+
+
+``--hooklog=HOOKLOG``
+ write hook calls to the given file.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_hooklog.py`_ plugin source code
+2. put it somewhere as ``pytest_hooklog.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/hookspec.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/hookspec.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,174 @@
+
+hook specification sourcecode
+=============================
+
+.. sourcecode:: python
+
+ """
+ hook specifications for py.test plugins
+ """
+
+ # -------------------------------------------------------------------------
+ # Command line and configuration
+ # -------------------------------------------------------------------------
+
+ def pytest_addoption(parser):
+ """ called before commandline parsing. """
+
+ def pytest_namespace():
+ """ return dict of name->object which will get stored at py.test. namespace"""
+
+ def pytest_configure(config):
+ """ called after command line options have been parsed.
+ and all plugins and initial conftest files been loaded.
+ """
+
+ def pytest_unconfigure(config):
+ """ called before test process is exited. """
+
+ # -------------------------------------------------------------------------
+ # collection hooks
+ # -------------------------------------------------------------------------
+
+ def pytest_collect_directory(path, parent):
+ """ return Collection node or None for the given path. """
+
+ def pytest_collect_file(path, parent):
+ """ return Collection node or None for the given path. """
+
+ def pytest_collectstart(collector):
+ """ collector starts collecting. """
+
+ def pytest_collectreport(report):
+ """ collector finished collecting. """
+
+ def pytest_deselected(items):
+ """ called for test items deselected by keyword. """
+
+ def pytest_make_collect_report(collector):
+ """ perform a collection and return a collection. """
+ pytest_make_collect_report.firstresult = True
+
+ # XXX rename to item_collected()? meaning in distribution context?
+ def pytest_itemstart(item, node=None):
+ """ test item gets collected. """
+
+ # -------------------------------------------------------------------------
+ # Python test function related hooks
+ # -------------------------------------------------------------------------
+
+ def pytest_pycollect_makeitem(collector, name, obj):
+ """ return custom item/collector for a python object in a module, or None. """
+ pytest_pycollect_makeitem.firstresult = True
+
+ def pytest_pyfunc_call(pyfuncitem):
+ """ perform function call to the with the given function arguments. """
+ pytest_pyfunc_call.firstresult = True
+
+ def pytest_generate_tests(metafunc):
+ """ generate (multiple) parametrized calls to a test function."""
+
+ # -------------------------------------------------------------------------
+ # generic runtest related hooks
+ # -------------------------------------------------------------------------
+
+ def pytest_runtest_protocol(item):
+ """ implement fixture, run and report protocol. """
+ pytest_runtest_protocol.firstresult = True
+
+ def pytest_runtest_setup(item):
+ """ called before pytest_runtest_call(). """
+
+ def pytest_runtest_call(item):
+ """ execute test item. """
+
+ def pytest_runtest_teardown(item):
+ """ called after pytest_runtest_call(). """
+
+ def pytest_runtest_makereport(item, call):
+ """ make ItemTestReport for the given item and call outcome. """
+ pytest_runtest_makereport.firstresult = True
+
+ def pytest_runtest_logreport(report):
+ """ process item test report. """
+
+ # special handling for final teardown - somewhat internal for now
+ def pytest__teardown_final(session):
+ """ called before test session finishes. """
+ pytest__teardown_final.firstresult = True
+
+ def pytest__teardown_final_logerror(rep):
+ """ called if runtest_teardown_final failed. """
+
+ # -------------------------------------------------------------------------
+ # test session related hooks
+ # -------------------------------------------------------------------------
+
+ def pytest_sessionstart(session):
+ """ before session.main() is called. """
+
+ def pytest_sessionfinish(session, exitstatus):
+ """ whole test run finishes. """
+
+ # -------------------------------------------------------------------------
+ # hooks for influencing reporting (invoked from pytest_terminal)
+ # -------------------------------------------------------------------------
+
+ def pytest_report_teststatus(rep):
+ """ return shortletter and verbose word. """
+ pytest_report_teststatus.firstresult = True
+
+ def pytest_terminal_summary(terminalreporter):
+ """ add additional section in terminal summary reporting. """
+
+ def pytest_report_iteminfo(item):
+ """ return (fspath, lineno, name) for the item.
+ the information is used for result display and to sort tests
+ """
+ pytest_report_iteminfo.firstresult = True
+
+ # -------------------------------------------------------------------------
+ # doctest hooks
+ # -------------------------------------------------------------------------
+
+ def pytest_doctest_prepare_content(content):
+ """ return processed content for a given doctest"""
+ pytest_doctest_prepare_content.firstresult = True
+
+ # -------------------------------------------------------------------------
+ # distributed testing
+ # -------------------------------------------------------------------------
+
+ def pytest_testnodeready(node):
+ """ Test Node is ready to operate. """
+
+ def pytest_testnodedown(node, error):
+ """ Test Node is down. """
+
+ def pytest_rescheduleitems(items):
+ """ reschedule Items from a node that went down. """
+
+ def pytest_looponfailinfo(failreports, rootdirs):
+ """ info for repeating failing tests. """
+
+
+ # -------------------------------------------------------------------------
+ # error handling and internal debugging hooks
+ # -------------------------------------------------------------------------
+
+ def pytest_plugin_registered(plugin):
+ """ a new py lib plugin got registered. """
+
+ def pytest_plugin_unregistered(plugin):
+ """ a py lib plugin got unregistered. """
+
+ def pytest_internalerror(excrepr):
+ """ called for internal errors. """
+
+ def pytest_keyboard_interrupt(excinfo):
+ """ called for keyboard interrupt. """
+
+ def pytest_trace(category, msg):
+ """ called for debug info. """
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/index.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/index.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,48 @@
+
+Plugins related to Python test functions and programs
+=====================================================
+
+xfail_ mark python test functions as expected-to-fail and report them separately.
+
+figleaf_ write and report coverage data with 'figleaf'.
+
+monkeypatch_ safely patch object attributes, dicts and environment variables.
+
+capture_ configurable per-test stdout/stderr capturing mechanisms.
+
+recwarn_ helpers for asserting deprecation and other warnings.
+
+
+Plugins for other testing styles and languages
+==============================================
+
+unittest_ automatically discover and run traditional "unittest.py" style tests.
+
+doctest_ collect and execute doctests from modules and test files.
+
+oejskit_ run javascript tests in real life browsers
+
+restdoc_ perform ReST syntax, local and remote reference tests on .rst/.txt files.
+
+
+Plugins for generic reporting and failure logging
+=================================================
+
+pastebin_ submit failure or test session information to a pastebin service.
+
+resultlog_ resultlog plugin for machine-readable logging of test results.
+
+terminal_ Implements terminal reporting of the full testing process.
+
+
+internal plugins / core functionality
+=====================================
+
+pdb_ interactive debugging with the Python Debugger.
+
+keyword_ mark test functions with keywords that may hold values.
+
+hooklog_ log invocations of extension hooks to a file.
+
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/keyword.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/keyword.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,46 @@
+
+pytest_keyword plugin
+=====================
+
+mark test functions with keywords that may hold values.
+
+.. contents::
+ :local:
+
+Marking functions and setting rich attributes
+----------------------------------------------------
+
+By default, all filename parts and class/function names of a test
+function are put into the set of keywords for a given test. You can
+specify additional kewords like this::
+
+ @py.test.mark.webtest
+ def test_send_http():
+ ...
+
+This will set an attribute 'webtest' on the given test function
+and by default all such attributes signal keywords. You can
+also set values in this attribute which you could read from
+a hook in order to do something special with respect to
+the test function::
+
+ @py.test.mark.timeout(seconds=5)
+ def test_receive():
+ ...
+
+This will set the "timeout" attribute with a Marker object
+that has a 'seconds' attribute.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_keyword.py`_ plugin source code
+2. put it somewhere as ``pytest_keyword.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/links.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/links.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,33 @@
+.. _`terminal`: terminal.html
+.. _`pytest_recwarn.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_recwarn.py
+.. _`unittest`: unittest.html
+.. _`pytest_monkeypatch.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_monkeypatch.py
+.. _`pytest_keyword.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_keyword.py
+.. _`pastebin`: pastebin.html
+.. _`plugins`: index.html
+.. _`pytest_capture.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_capture.py
+.. _`pytest_doctest.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_doctest.py
+.. _`capture`: capture.html
+.. _`hooklog`: hooklog.html
+.. _`pytest_restdoc.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_restdoc.py
+.. _`pytest_hooklog.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_hooklog.py
+.. _`pytest_pastebin.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_pastebin.py
+.. _`pytest_figleaf.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_figleaf.py
+.. _`xfail`: xfail.html
+.. _`contact`: ../../contact.html
+.. _`checkout the py.test development version`: ../../download.html#checkout
+.. _`oejskit`: oejskit.html
+.. _`pytest_xfail.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_xfail.py
+.. _`figleaf`: figleaf.html
+.. _`extend`: ../extend.html
+.. _`pytest_terminal.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_terminal.py
+.. _`recwarn`: recwarn.html
+.. _`pytest_pdb.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_pdb.py
+.. _`monkeypatch`: monkeypatch.html
+.. _`resultlog`: resultlog.html
+.. _`keyword`: keyword.html
+.. _`restdoc`: restdoc.html
+.. _`pytest_unittest.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_unittest.py
+.. _`doctest`: doctest.html
+.. _`pytest_resultlog.py`: http://bitbucket.org/hpk42/py-trunk/raw/3b3ea41060652c47739450a590c4d71625bc05bd/py/test/plugin/pytest_resultlog.py
+.. _`pdb`: pdb.html
Added: py/trunk/doc/test/plugin/monkeypatch.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/monkeypatch.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,61 @@
+
+pytest_monkeypatch plugin
+=========================
+
+safely patch object attributes, dicts and environment variables.
+
+.. contents::
+ :local:
+
+Usage
+----------------
+
+Use the `monkeypatch funcarg`_ to safely patch the environment
+variables, object attributes or dictionaries. For example, if you want
+to set the environment variable ``ENV1`` and patch the
+``os.path.abspath`` function to return a particular value during a test
+function execution you can write it down like this:
+
+.. sourcecode:: python
+
+ def test_mytest(monkeypatch):
+ monkeypatch.setenv('ENV1', 'myval')
+ monkeypatch.setattr(os.path, 'abspath', lambda x: '/')
+ ... # your test code
+
+The function argument will do the modifications and memorize the
+old state. After the test function finished execution all
+modifications will be reverted. See the `monkeypatch blog post`_
+for an extensive discussion.
+
+.. _`monkeypatch blog post`: http://tetamap.wordpress.com/2009/03/03/monkeypatching-in-unit-tests-done-right/
+
+.. _`monkeypatch funcarg`:
+
+
+the 'monkeypatch' test function argument
+----------------------------------------
+
+The returned ``monkeypatch`` funcarg provides three
+helper methods to modify objects, dictionaries or os.environ::
+
+ monkeypatch.setattr(obj, name, value)
+ monkeypatch.setitem(mapping, name, value)
+ monkeypatch.setenv(name, value)
+
+All such modifications will be undone when the requesting
+test function finished its execution.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_monkeypatch.py`_ plugin source code
+2. put it somewhere as ``pytest_monkeypatch.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/oejskit.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/oejskit.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,12 @@
+pytest_oejskit plugin (EXTERNAL)
+==========================================
+
+The `oejskit`_ offers a py.test plugin for running Javascript tests in life browers. Running inside the browsers comes with some speed cost, on the other hand it means for example the code is tested against the real-word DOM implementations.
+The approach enables to write integration tests such that the JavaScript code is tested against server-side Python code mocked as necessary. Any server-side framework that can already be exposed through WSGI (or for which a subset of WSGI can be written to accommodate the jskit own needs) can play along.
+
+For more info and download please visit the `oejskit PyPI`_ page.
+
+.. _`oejskit`:
+.. _`oejskit PyPI`: http://pypi.python.org/pypi/oejskit
+
+.. source link 'http://bitbucket.org/pedronis/js-infrastructure/src/tip/pytest_jstests.py',
Added: py/trunk/doc/test/plugin/pastebin.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/pastebin.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,46 @@
+
+pytest_pastebin plugin
+======================
+
+submit failure or test session information to a pastebin service.
+
+.. contents::
+ :local:
+
+Usage
+----------
+
+**Creating a URL for each test failure**::
+
+ py.test --pastebin=failed
+
+This will submit full failure information to a remote Paste service and
+provide a URL for each failure. You may select tests as usual or add
+for example ``-x`` if you only want to send one particular failure.
+
+**Creating a URL for a whole test session log**::
+
+ py.test --pastebin=all
+
+Currently only pasting to the http://paste.pocoo.org service is implemented.
+
+command line options
+--------------------
+
+
+``--pastebin=mode``
+ send failed|all info to Pocoo pastebin service.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_pastebin.py`_ plugin source code
+2. put it somewhere as ``pytest_pastebin.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/pdb.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/pdb.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,31 @@
+
+pytest_pdb plugin
+=================
+
+interactive debugging with the Python Debugger.
+
+.. contents::
+ :local:
+
+
+
+command line options
+--------------------
+
+
+``--pdb``
+ start pdb (the Python debugger) on errors.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_pdb.py`_ plugin source code
+2. put it somewhere as ``pytest_pdb.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/recwarn.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/recwarn.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,61 @@
+
+pytest_recwarn plugin
+=====================
+
+helpers for asserting deprecation and other warnings.
+
+.. contents::
+ :local:
+
+Example usage
+---------------------
+
+You can use the ``recwarn`` funcarg to track
+warnings within a test function:
+
+.. sourcecode:: python
+
+ def test_hello(recwarn):
+ from warnings import warn
+ warn("hello", DeprecationWarning)
+ w = recwarn.pop(DeprecationWarning)
+ assert issubclass(w.category, DeprecationWarning)
+ assert 'hello' in str(w.message)
+ assert w.filename
+ assert w.lineno
+
+You can also call a global helper for checking
+taht a certain function call yields a Deprecation
+warning:
+
+.. sourcecode:: python
+
+ import py
+
+ def test_global():
+ py.test.deprecated_call(myfunction, 17)
+
+.. _`recwarn funcarg`:
+
+
+the 'recwarn' test function argument
+------------------------------------
+
+Return a WarningsRecorder instance that provides these methods:
+
+* ``pop(category=None)``: return last warning matching the category.
+* ``clear()``: clear list of warnings
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_recwarn.py`_ plugin source code
+2. put it somewhere as ``pytest_recwarn.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/restdoc.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/restdoc.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,35 @@
+
+pytest_restdoc plugin
+=====================
+
+perform ReST syntax, local and remote reference tests on .rst/.txt files.
+
+.. contents::
+ :local:
+
+
+
+command line options
+--------------------
+
+
+``-R, --urlcheck``
+ urlopen() remote links found in ReST text files.
+``--urltimeout=secs``
+ timeout in seconds for remote urlchecks
+``--forcegen``
+ force generation of html files.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_restdoc.py`_ plugin source code
+2. put it somewhere as ``pytest_restdoc.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/resultlog.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/resultlog.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,31 @@
+
+pytest_resultlog plugin
+=======================
+
+resultlog plugin for machine-readable logging of test results.
+
+.. contents::
+ :local:
+
+Useful for buildbot integration code.
+
+command line options
+--------------------
+
+
+``--resultlog=path``
+ path for machine-readable result log.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_resultlog.py`_ plugin source code
+2. put it somewhere as ``pytest_resultlog.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/terminal.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/terminal.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,39 @@
+
+pytest_terminal plugin
+======================
+
+Implements terminal reporting of the full testing process.
+
+.. contents::
+ :local:
+
+This is a good source for looking at the various reporting hooks.
+
+command line options
+--------------------
+
+
+``--collectonly``
+ only collect tests, don't execute them.
+``--traceconfig``
+ trace considerations of conftest.py files.
+``--nomagic``
+ don't reinterpret asserts, no traceback cutting.
+``--fulltrace``
+ don't cut any tracebacks (default is to cut).
+``--debug``
+ generate and show debugging information.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_terminal.py`_ plugin source code
+2. put it somewhere as ``pytest_terminal.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/unittest.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/unittest.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,34 @@
+
+pytest_unittest plugin
+======================
+
+automatically discover and run traditional "unittest.py" style tests.
+
+.. contents::
+ :local:
+
+Usage
+----------------
+
+This plugin collects and runs Python `unittest.py style`_ tests.
+It will automatically collect ``unittest.TestCase`` subclasses
+and their ``test`` methods from the test modules of a project
+(usually following the ``test_*.py`` pattern).
+
+This plugin is enabled by default.
+
+.. _`unittest.py style`: http://docs.python.org/library/unittest.html
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_unittest.py`_ plugin source code
+2. put it somewhere as ``pytest_unittest.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Added: py/trunk/doc/test/plugin/xfail.txt
==============================================================================
--- (empty file)
+++ py/trunk/doc/test/plugin/xfail.txt Tue Aug 4 19:45:30 2009
@@ -0,0 +1,36 @@
+
+pytest_xfail plugin
+===================
+
+mark python test functions as expected-to-fail and report them separately.
+
+.. contents::
+ :local:
+
+usage
+------------
+
+Use the generic mark decorator to mark your test functions as
+'expected to fail'::
+
+ @py.test.mark.xfail
+ def test_hello():
+ ...
+
+This test will be executed but no traceback will be reported
+when it fails. Instead terminal reporting will list it in the
+"expected to fail" section or "unexpectedly passing" section.
+
+Start improving this plugin in 30 seconds
+=========================================
+
+
+Do you find the above documentation or the plugin itself lacking?
+
+1. Download `pytest_xfail.py`_ plugin source code
+2. put it somewhere as ``pytest_xfail.py`` into your import path
+3. a subsequent ``py.test`` run will use your local version
+
+Further information: extend_ documentation, other plugins_ or contact_.
+
+.. include:: links.txt
Modified: py/trunk/doc/test/quickstart.txt
==============================================================================
--- py/trunk/doc/test/quickstart.txt (original)
+++ py/trunk/doc/test/quickstart.txt Tue Aug 4 19:45:30 2009
@@ -5,55 +5,33 @@
Quickstart
==================
-This document assumes basic python knowledge. If you have a
-`setuptools installation`_, install ``py.test`` by typing::
+.. _here: ../download.html#no-setuptools
- easy_install -U py
-
-For alternative installation methods please see the download_ page.
-
-You should now have a ``py.test`` command line tool and can
-look at its documented cmdline options via this command::
+This document assumes basic python knowledge and a working `setuptools
+installation`_ (otherwise see here_). You can install
+the py lib and py.test by typing::
- py.test -h
-
-Writing and running a test
-==========================
+ easy_install -U py
-``py.test`` is the command line tool to run tests.
-Let's write a first test module by putting the following
-test function into a ``test_sample.py`` file::
+Now open a file ``test_sample.py`` file and put the following
+example content into it::
# content of test_sample.py
def test_answer():
assert 42 == 43
-Now you can run the test by passing it as an argument::
+You can now run the test file like this::
py.test test_sample.py
-What does happen here? ``py.test`` looks for functions and
-methods in the module that start with ``test_``. It then
-executes those tests. Assertions about test outcomes are
-done via the standard ``assert`` statement.
-
-You can also use ``py.test`` to run all tests in a directory structure by
-invoking it without any arguments::
-
- py.test
-
-This will automatically collect and run any Python module whose filenames
-start with ``test_`` or ends with ``_test`` from the directory and any
-subdirectories, starting with the current directory, and run them. Each
-Python test module is inspected for test methods starting with ``test_``.
-
-.. Organising your tests
-.. ---------------------------
-
-Please refer to `features`_ for a walk through the basic features.
-
+and will see an error report on the failing assert statement.
+For further information please refer to `features`_
+or checkout the `tutorials`_ page for more introduction material.
+.. _`automatically collected`: features.html#autocollect
.. _download: ../download.html
.. _features: features.html
+.. _tutorials: talks.html
+
Modified: py/trunk/doc/test/test.txt
==============================================================================
--- py/trunk/doc/test/test.txt (original)
+++ py/trunk/doc/test/test.txt Tue Aug 4 19:45:30 2009
@@ -1,24 +1,32 @@
-=======
-py.test
-=======
+=======================================
+py.test documentation index
+=======================================
+
+the project independent ``py.test`` command line tool helps you to:
* rapidly collect and run tests
-* use unit- or doctests, functional or integration tests
+* run unit- or doctests, functional or integration tests
* distribute tests to multiple environments
-* local or global plugins for custom test scenarios and types
+* use local or global plugins for custom test types and setup
quickstart_: for getting started immediately.
features_: a walk through basic features and usage.
+`available plugins`_: list of py.test plugins
+
funcargs_: powerful parametrized test function setup
`distributed testing`_: distribute test runs to other machines and platforms.
extend_: intro to extend and customize py.test runs
-config_: ``conftest.py`` files and general configuration
+config_: ``conftest.py`` files and the config object
+
+talks_: talk and tutorial slides
+.. _`available plugins`: plugin/index.html
+.. _talks: talks.html
.. _quickstart: quickstart.html
.. _features: features.html
.. _funcargs: funcargs.html
Added: py/trunk/example/assertion/failure_demo.py
==============================================================================
--- (empty file)
+++ py/trunk/example/assertion/failure_demo.py Tue Aug 4 19:45:30 2009
@@ -0,0 +1,120 @@
+from py.test import raises
+import py
+
+def otherfunc(a,b):
+ assert a==b
+
+def somefunc(x,y):
+ otherfunc(x,y)
+
+def otherfunc_multi(a,b):
+ assert (a ==
+ b)
+
+class TestFailing(object):
+ def test_simple(self):
+ def f():
+ return 42
+ def g():
+ return 43
+
+ assert f() == g()
+
+ def test_simple_multiline(self):
+ otherfunc_multi(
+ 42,
+ 6*9)
+
+ def test_not(self):
+ def f():
+ return 42
+ assert not f()
+
+ def test_complex_error(self):
+ def f():
+ return 44
+ def g():
+ return 43
+ somefunc(f(), g())
+
+ def test_z1_unpack_error(self):
+ l = []
+ a,b = l
+
+ def test_z2_type_error(self):
+ l = 3
+ a,b = l
+
+ def test_startswith(self):
+ s = "123"
+ g = "456"
+ assert s.startswith(g)
+
+ def test_startswith_nested(self):
+ def f():
+ return "123"
+ def g():
+ return "456"
+ assert f().startswith(g())
+
+ def test_global_func(self):
+ assert isinstance(globf(42), float)
+
+ def test_instance(self):
+ self.x = 6*7
+ assert self.x != 42
+
+ def test_compare(self):
+ assert globf(10) < 5
+
+ def test_try_finally(self):
+ x = 1
+ try:
+ assert x == 0
+ finally:
+ x = 0
+
+ def test_raises(self):
+ s = 'qwe'
+ raises(TypeError, "int(s)")
+
+ def test_raises_doesnt(self):
+ raises(IOError, "int('3')")
+
+ def test_raise(self):
+ raise ValueError("demo error")
+
+ def test_tupleerror(self):
+ a,b = [1]
+
+ def test_reinterpret_fails_with_print_for_the_fun_of_it(self):
+ l = [1,2,3]
+ print "l is", l
+ a,b = l.pop()
+
+ def test_some_error(self):
+ if namenotexi:
+ pass
+
+ def test_generator(self):
+ yield None
+
+ def func1(self):
+ assert 41 == 42
+
+ def test_generator2(self):
+ yield self.func1
+
+# thanks to Matthew Scott for this test
+def test_dynamic_compile_shows_nicely():
+ src = 'def foo():\n assert 1 == 0\n'
+ name = 'abc-123'
+ module = py.std.imp.new_module(name)
+ code = py.code.compile(src, name, 'exec')
+ exec code in module.__dict__
+ py.std.sys.modules[name] = module
+ module.foo()
+
+
+def globf(x):
+ return x+1
Added: py/trunk/example/assertion/test_failures.py
==============================================================================
--- (empty file)
+++ py/trunk/example/assertion/test_failures.py Tue Aug 4 19:45:30 2009
@@ -0,0 +1,14 @@
+
+import py
+failure_demo = py.magic.autopath().dirpath('failure_demo.py')
+
+pytest_plugins = "pytest_pytester"
+
+def test_failure_demo_fails_properly(testdir):
+ reprec = testdir.inline_run(failure_demo)
+ passed, skipped, failed = reprec.countoutcomes()
+ assert passed == 0
+ assert failed == 20, failed
+ colreports = reprec.getreports("pytest_collectreport")
+ failed = len([x.failed for x in colreports])
+ assert failed == 5
Added: py/trunk/example/assertion/test_setup_flow_example.py
==============================================================================
--- (empty file)
+++ py/trunk/example/assertion/test_setup_flow_example.py Tue Aug 4 19:45:30 2009
@@ -0,0 +1,42 @@
+def setup_module(module):
+ module.TestStateFullThing.classcount = 0
+
+class TestStateFullThing:
+ def setup_class(cls):
+ cls.classcount += 1
+
+ def teardown_class(cls):
+ cls.classcount -= 1
+
+ def setup_method(self, method):
+ self.id = eval(method.func_name[5:])
+
+ def test_42(self):
+ assert self.classcount == 1
+ assert self.id == 42
+
+ def test_23(self):
+ assert self.classcount == 1
+ assert self.id == 23
+
+def teardown_module(module):
+ assert module.TestStateFullThing.classcount == 0
+
+""" For this example the control flow happens as follows::
+ import test_setup_flow_example
+ setup_module(test_setup_flow_example)
+ setup_class(TestStateFullThing)
+ instance = TestStateFullThing()
+ setup_method(instance, instance.test_42)
+ instance.test_42()
+ setup_method(instance, instance.test_23)
+ instance.test_23()
+ teardown_class(TestStateFullThing)
+ teardown_module(test_setup_flow_example)
+
+Note that ``setup_class(TestStateFullThing)`` is called and not
+``TestStateFullThing.setup_class()`` which would require you
+to insert ``setup_class = classmethod(setup_class)`` to make
+your setup function callable.
+"""
+
Added: py/trunk/example/execnet/redirect_remote_output.py
==============================================================================
--- (empty file)
+++ py/trunk/example/execnet/redirect_remote_output.py Tue Aug 4 19:45:30 2009
@@ -0,0 +1,31 @@
+"""
+redirect output from remote to a local function
+showcasing features of the channel object:
+
+- sending a channel over a channel
+- adapting a channel to a file object
+- setting a callback for receiving channel data
+
+"""
+
+import py
+
+gw = py.execnet.PopenGateway()
+
+outchan = gw.remote_exec("""
+ import sys
+ outchan = channel.gateway.newchannel()
+ sys.stdout = outchan.makefile("w")
+ channel.send(outchan)
+""").receive()
+
+# note: callbacks execute in receiver thread!
+def write(data):
+ print "received:", repr(data)
+outchan.setcallback(write)
+
+gw.remote_exec("""
+ print 'hello world'
+ print 'remote execution ends'
+""").waitclose()
+
Added: py/trunk/example/execnet/svn-sync-repo.py
==============================================================================
--- (empty file)
+++ py/trunk/example/execnet/svn-sync-repo.py Tue Aug 4 19:45:30 2009
@@ -0,0 +1,93 @@
+#!/usr/bin/env python
+
+import py
+import sys, os
+
+def usage():
+ arg0 = sys.argv[0]
+ print """%s [user@]remote-host:/repo/location localrepo [identity keyfile]""" % (arg0,)
+
+
+def main(args):
+ remote = args[0]
+ localrepo = py.path.local(args[1])
+ if not localrepo.check(dir=1):
+ raise SystemExit("localrepo %s does not exist" %(localrepo,))
+ if len(args) == 3:
+ keyfile = py.path.local(args[2])
+ else:
+ keyfile = None
+ remote_host, path = remote.split(':', 1)
+ print "ssh-connecting to", remote_host
+ gw = getgateway(remote_host, keyfile)
+
+ local_rev = get_svn_youngest(localrepo)
+
+ # local protocol
+ # 1. client sends rev/repo -> server
+ # 2. server checks for newer revisions and sends dumps
+ # 3. client receives dumps, updates local repo
+ # 4. client goes back to step 1
+ c = gw.remote_exec("""
+ import py
+ import os
+ remote_rev, repopath = channel.receive()
+ while 1:
+ rev = py.process.cmdexec('svnlook youngest "%s"' % repopath)
+ rev = int(rev)
+ if rev > remote_rev:
+ revrange = (remote_rev+1, rev)
+ dumpchannel = channel.gateway.newchannel()
+ channel.send(revrange)
+ channel.send(dumpchannel)
+
+ f = os.popen(
+ "svnadmin dump -q --incremental -r %s:%s %s"
+ % (revrange[0], revrange[1], repopath), 'r')
+ try:
+ while 1:
+ s = f.read(8192)
+ if not s:
+ raise EOFError
+ dumpchannel.send(s)
+ except EOFError:
+ dumpchannel.close()
+ remote_rev = rev
+ else:
+ # using svn-hook instead would be nice here
+ py.std.time.sleep(30)
+ """)
+
+ c.send((local_rev, path))
+ print "checking revisions from %d in %s" %(local_rev, remote)
+ while 1:
+ revstart, revend = c.receive()
+ dumpchannel = c.receive()
+
+ print "receiving revisions", revstart, "-", revend, "replaying..."
+ svn_load(localrepo, dumpchannel)
+ print "current revision", revend
+
+def svn_load(repo, dumpchannel):
+ f = os.popen("svnadmin load -q %s" %(repo, ), "w")
+ for x in dumpchannel:
+ sys.stdout.write(".")
+ sys.stdout.flush()
+ f.write(x)
+ print >>sys.stdout
+ f.close()
+
+def get_svn_youngest(repo):
+ rev = py.process.cmdexec('svnlook youngest "%s"' % repo)
+ return int(rev)
+
+def getgateway(host, keyfile=None):
+ return py.execnet.SshGateway(host, identity=keyfile)
+
+if __name__ == '__main__':
+ if len(sys.argv) < 3:
+ usage()
+ raise SystemExit(1)
+
+ main(sys.argv[1:])
+
Added: py/trunk/example/execnet/sysinfo.py
==============================================================================
--- (empty file)
+++ py/trunk/example/execnet/sysinfo.py Tue Aug 4 19:45:30 2009
@@ -0,0 +1,140 @@
+"""
+sysinfo.py [host1] [host2] [options]
+
+obtain system info from remote machine.
+"""
+
+import py
+import sys
+
+optparse = py.compat.optparse
+
+parser = optparse.OptionParser(usage=__doc__)
+parser.add_option("-f", "--sshconfig", action="store", dest="ssh_config", default=None,
+ help="use given ssh config file, and add info all contained hosts for getting info")
+parser.add_option("-i", "--ignore", action="store", dest="ignores", default=None,
+ help="ignore hosts (useful if the list of hostnames come from a file list)")
+
+def parsehosts(path):
+ path = py.path.local(path)
+ l = []
+ rex = py.std.re.compile(r'Host\s*(\S+)')
+ for line in path.readlines():
+ m = rex.match(line)
+ if m is not None:
+ sshname, = m.groups()
+ l.append(sshname)
+ return l
+
+class RemoteInfo:
+ def __init__(self, gateway):
+ self.gw = gateway
+ self._cache = {}
+
+ def exreceive(self, execstring):
+ if execstring not in self._cache:
+ channel = self.gw.remote_exec(execstring)
+ self._cache[execstring] = channel.receive()
+ return self._cache[execstring]
+
+ def getmodattr(self, modpath):
+ module = modpath.split(".")[0]
+ return self.exreceive("""
+ import %s
+ channel.send(%s)
+ """ %(module, modpath))
+
+ def islinux(self):
+ return self.getmodattr('sys.platform').find("linux") != -1
+
+ def getfqdn(self):
+ return self.exreceive("""
+ import socket
+ channel.send(socket.getfqdn())
+ """)
+
+ def getmemswap(self):
+ if self.islinux():
+ return self.exreceive("""
+ import commands, re
+ out = commands.getoutput("free")
+ mem = re.search(r"Mem:\s+(\S*)", out).group(1)
+ swap = re.search(r"Swap:\s+(\S*)", out).group(1)
+ channel.send((mem, swap))
+ """)
+
+ def getcpuinfo(self):
+ if self.islinux():
+ return self.exreceive("""
+ # a hyperthreaded cpu core only counts as 1, although it
+ # is present as 2 in /proc/cpuinfo. Counting it as 2 is
+ # misleading because it is *by far* not as efficient as
+ # two independent cores.
+ cpus = {}
+ cpuinfo = {}
+ f = open("/proc/cpuinfo")
+ lines = f.readlines()
+ f.close()
+ for line in lines + ['']:
+ if line.strip():
+ key, value = line.split(":", 1)
+ cpuinfo[key.strip()] = value.strip()
+ else:
+ corekey = (cpuinfo.get("physical id"),
+ cpuinfo.get("core id"))
+ cpus[corekey] = 1
+ numcpus = len(cpus)
+ model = cpuinfo.get("model name")
+ channel.send((numcpus, model))
+ """)
+
+def debug(*args):
+ print >>sys.stderr, " ".join(map(str, args))
+def error(*args):
+ debug("ERROR", args[0] + ":", *args[1:])
+
+def getinfo(sshname, ssh_config=None, loginfo=sys.stdout):
+ debug("connecting to", sshname)
+ try:
+ gw = py.execnet.SshGateway(sshname, ssh_config=ssh_config)
+ except IOError:
+ error("could not get sshagteway", sshname)
+ else:
+ ri = RemoteInfo(gw)
+ #print "%s info:" % sshname
+ prefix = sshname.upper() + " "
+ print >>loginfo, prefix, "fqdn:", ri.getfqdn()
+ for attr in (
+ "sys.platform",
+ "sys.version_info",
+ ):
+ loginfo.write("%s %s: " %(prefix, attr,))
+ loginfo.flush()
+ value = ri.getmodattr(attr)
+ loginfo.write(str(value))
+ loginfo.write("\n")
+ loginfo.flush()
+ memswap = ri.getmemswap()
+ if memswap:
+ mem,swap = memswap
+ print >>loginfo, prefix, "Memory:", mem, "Swap:", swap
+ cpuinfo = ri.getcpuinfo()
+ if cpuinfo:
+ numcpu, model = cpuinfo
+ print >>loginfo, prefix, "number of cpus:", numcpu
+ print >>loginfo, prefix, "cpu model", model
+ return ri
+
+if __name__ == '__main__':
+ options, args = parser.parse_args()
+ hosts = list(args)
+ ssh_config = options.ssh_config
+ if ssh_config:
+ hosts.extend(parsehosts(ssh_config))
+ ignores = options.ignores or ()
+ if ignores:
+ ignores = ignores.split(",")
+ for host in hosts:
+ if host not in ignores:
+ getinfo(host, ssh_config=ssh_config)
+
Added: py/trunk/example/funcarg/conftest.py
==============================================================================
--- (empty file)
+++ py/trunk/example/funcarg/conftest.py Tue Aug 4 19:45:30 2009
@@ -0,0 +1,3 @@
+import py
+
+collect_ignore = 'mysetup', 'mysetup2', 'test_simpleprovider.py', 'parametrize'
Added: py/trunk/example/funcarg/costlysetup/sub1/__init__.py
==============================================================================
--- (empty file)
+++ py/trunk/example/funcarg/costlysetup/sub1/__init__.py Tue Aug 4 19:45:30 2009
@@ -0,0 +1 @@
+#
Added: py/trunk/example/funcarg/costlysetup/sub2/__init__.py
==============================================================================
--- (empty file)
+++ py/trunk/example/funcarg/costlysetup/sub2/__init__.py Tue Aug 4 19:45:30 2009
@@ -0,0 +1 @@
+#
Deleted: /py/trunk/ez_setup.py
==============================================================================
--- /py/trunk/ez_setup.py Tue Aug 4 19:45:30 2009
+++ (empty file)
@@ -1,276 +0,0 @@
-#!python
-"""Bootstrap setuptools installation
-
-If you want to use setuptools in your package's setup.py, just include this
-file in the same directory with it, and add this to the top of your setup.py::
-
- from ez_setup import use_setuptools
- use_setuptools()
-
-If you want to require a specific version of setuptools, set a download
-mirror, or use an alternate download directory, you can do so by supplying
-the appropriate options to ``use_setuptools()``.
-
-This file can also be run as a script to install or upgrade setuptools.
-"""
-import sys
-DEFAULT_VERSION = "0.6c9"
-DEFAULT_URL = "http://pypi.python.org/packages/%s/s/setuptools/" % sys.version[:3]
-
-md5_data = {
- 'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca',
- 'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb',
- 'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b',
- 'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a',
- 'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618',
- 'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac',
- 'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5',
- 'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4',
- 'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c',
- 'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b',
- 'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27',
- 'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277',
- 'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa',
- 'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e',
- 'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e',
- 'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f',
- 'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2',
- 'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc',
- 'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167',
- 'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64',
- 'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d',
- 'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20',
- 'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab',
- 'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53',
- 'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2',
- 'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e',
- 'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372',
- 'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902',
- 'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de',
- 'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b',
- 'setuptools-0.6c9-py2.3.egg': 'a83c4020414807b496e4cfbe08507c03',
- 'setuptools-0.6c9-py2.4.egg': '260a2be2e5388d66bdaee06abec6342a',
- 'setuptools-0.6c9-py2.5.egg': 'fe67c3e5a17b12c0e7c541b7ea43a8e6',
- 'setuptools-0.6c9-py2.6.egg': 'ca37b1ff16fa2ede6e19383e7b59245a',
-}
-
-import sys, os
-try: from hashlib import md5
-except ImportError: from md5 import md5
-
-def _validate_md5(egg_name, data):
- if egg_name in md5_data:
- digest = md5(data).hexdigest()
- if digest != md5_data[egg_name]:
- print >>sys.stderr, (
- "md5 validation of %s failed! (Possible download problem?)"
- % egg_name
- )
- sys.exit(2)
- return data
-
-def use_setuptools(
- version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
- download_delay=15
-):
- """Automatically find/download setuptools and make it available on sys.path
-
- `version` should be a valid setuptools version number that is available
- as an egg for download under the `download_base` URL (which should end with
- a '/'). `to_dir` is the directory where setuptools will be downloaded, if
- it is not already available. If `download_delay` is specified, it should
- be the number of seconds that will be paused before initiating a download,
- should one be required. If an older version of setuptools is installed,
- this routine will print a message to ``sys.stderr`` and raise SystemExit in
- an attempt to abort the calling script.
- """
- was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules
- def do_download():
- egg = download_setuptools(version, download_base, to_dir, download_delay)
- sys.path.insert(0, egg)
- import setuptools; setuptools.bootstrap_install_from = egg
- try:
- import pkg_resources
- except ImportError:
- return do_download()
- try:
- pkg_resources.require("setuptools>="+version); return
- except pkg_resources.VersionConflict, e:
- if was_imported:
- print >>sys.stderr, (
- "The required version of setuptools (>=%s) is not available, and\n"
- "can't be installed while this script is running. Please install\n"
- " a more recent version first, using 'easy_install -U setuptools'."
- "\n\n(Currently using %r)"
- ) % (version, e.args[0])
- sys.exit(2)
- else:
- del pkg_resources, sys.modules['pkg_resources'] # reload ok
- return do_download()
- except pkg_resources.DistributionNotFound:
- return do_download()
-
-def download_setuptools(
- version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
- delay = 15
-):
- """Download setuptools from a specified location and return its filename
-
- `version` should be a valid setuptools version number that is available
- as an egg for download under the `download_base` URL (which should end
- with a '/'). `to_dir` is the directory where the egg will be downloaded.
- `delay` is the number of seconds to pause before an actual download attempt.
- """
- import urllib2, shutil
- egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3])
- url = download_base + egg_name
- saveto = os.path.join(to_dir, egg_name)
- src = dst = None
- if not os.path.exists(saveto): # Avoid repeated downloads
- try:
- from distutils import log
- if delay:
- log.warn("""
----------------------------------------------------------------------------
-This script requires setuptools version %s to run (even to display
-help). I will attempt to download it for you (from
-%s), but
-you may need to enable firewall access for this script first.
-I will start the download in %d seconds.
-
-(Note: if this machine does not have network access, please obtain the file
-
- %s
-
-and place it in this directory before rerunning this script.)
----------------------------------------------------------------------------""",
- version, download_base, delay, url
- ); from time import sleep; sleep(delay)
- log.warn("Downloading %s", url)
- src = urllib2.urlopen(url)
- # Read/write all in one block, so we don't create a corrupt file
- # if the download is interrupted.
- data = _validate_md5(egg_name, src.read())
- dst = open(saveto,"wb"); dst.write(data)
- finally:
- if src: src.close()
- if dst: dst.close()
- return os.path.realpath(saveto)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-def main(argv, version=DEFAULT_VERSION):
- """Install or upgrade setuptools and EasyInstall"""
- try:
- import setuptools
- except ImportError:
- egg = None
- try:
- egg = download_setuptools(version, delay=0)
- sys.path.insert(0,egg)
- from setuptools.command.easy_install import main
- return main(list(argv)+[egg]) # we're done here
- finally:
- if egg and os.path.exists(egg):
- os.unlink(egg)
- else:
- if setuptools.__version__ == '0.0.1':
- print >>sys.stderr, (
- "You have an obsolete version of setuptools installed. Please\n"
- "remove it from your system entirely before rerunning this script."
- )
- sys.exit(2)
-
- req = "setuptools>="+version
- import pkg_resources
- try:
- pkg_resources.require(req)
- except pkg_resources.VersionConflict:
- try:
- from setuptools.command.easy_install import main
- except ImportError:
- from easy_install import main
- main(list(argv)+[download_setuptools(delay=0)])
- sys.exit(0) # try to force an exit
- else:
- if argv:
- from setuptools.command.easy_install import main
- main(argv)
- else:
- print "Setuptools version",version,"or greater has been installed."
- print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
-
-def update_md5(filenames):
- """Update our built-in md5 registry"""
-
- import re
-
- for name in filenames:
- base = os.path.basename(name)
- f = open(name,'rb')
- md5_data[base] = md5(f.read()).hexdigest()
- f.close()
-
- data = [" %r: %r,\n" % it for it in md5_data.items()]
- data.sort()
- repl = "".join(data)
-
- import inspect
- srcfile = inspect.getsourcefile(sys.modules[__name__])
- f = open(srcfile, 'rb'); src = f.read(); f.close()
-
- match = re.search("\nmd5_data = {\n([^}]+)}", src)
- if not match:
- print >>sys.stderr, "Internal error!"
- sys.exit(2)
-
- src = src[:match.start(1)] + repl + src[match.end(1):]
- f = open(srcfile,'w')
- f.write(src)
- f.close()
-
-
-if __name__=='__main__':
- if len(sys.argv)>2 and sys.argv[1]=='--md5update':
- update_md5(sys.argv[2:])
- else:
- main(sys.argv[1:])
-
-
-
-
-
-
Modified: py/trunk/py/__init__.py
==============================================================================
--- py/trunk/py/__init__.py (original)
+++ py/trunk/py/__init__.py Tue Aug 4 19:45:30 2009
@@ -18,8 +18,9 @@
"""
from initpkg import initpkg
+trunk = None
-version = "1.0.0b6"
+version = trunk or "1.0.0"
initpkg(__name__,
description = "py.test and pylib: advanced testing tool and networking lib",
@@ -31,7 +32,7 @@
author_email = "holger at merlinux.eu, py-dev at codespeak.net",
long_description = globals()['__doc__'],
classifiers = [
- "Development Status :: 4 - Beta",
+ "Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: POSIX",
Modified: py/trunk/py/code/excinfo.py
==============================================================================
--- py/trunk/py/code/excinfo.py (original)
+++ py/trunk/py/code/excinfo.py Tue Aug 4 19:45:30 2009
@@ -57,14 +57,15 @@
reprcrash = ReprFileLocation(path, lineno+1, exconly)
return reprcrash
- def getrepr(self, showlocals=False, style="long", tbfilter=True, funcargs=False):
+ def getrepr(self, showlocals=False, style="long",
+ abspath=False, tbfilter=True, funcargs=False):
""" return str()able representation of this exception info.
showlocals: show locals per traceback entry
style: long|short|no traceback style
tbfilter: hide entries (where __tracebackhide__ is true)
"""
fmt = FormattedExcinfo(showlocals=showlocals, style=style,
- tbfilter=tbfilter, funcargs=funcargs)
+ abspath=abspath, tbfilter=tbfilter, funcargs=funcargs)
return fmt.repr_excinfo(self)
def __str__(self):
@@ -78,11 +79,12 @@
flow_marker = ">"
fail_marker = "E"
- def __init__(self, showlocals=False, style="long", tbfilter=True, funcargs=False):
+ def __init__(self, showlocals=False, style="long", abspath=True, tbfilter=True, funcargs=False):
self.showlocals = showlocals
self.style = style
self.tbfilter = tbfilter
self.funcargs = funcargs
+ self.abspath = abspath
def _getindent(self, source):
# figure out indent for given source
@@ -154,8 +156,9 @@
if name == '__builtins__':
lines.append("__builtins__ =