tox: virtualenv-based automation of test activities

pytest: rapid no-boilerplate testing with Python

home | + all docs | install | examples | customize | --- a/doc/announce/release-1.0.0.txt +++ /dev/null @@ -1,63 +0,0 @@ - -pylib 1.0.0 released: testing-with-python innovations continue --------------------------------------------------------------------- - -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: - -* funcargs_ - pythonic zero-boilerplate fixtures for Python test functions : - - - totally separates test code, test configuration and test setup - - ideal for integration and functional tests - - allows for flexible and natural test parametrization schemes - -* 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**. - -* 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 - * ... - -* `distributed testing`_ and `elastic distributed execution`_: - - - 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 continues to offer most of the functionality used by -the testing tool in `independent namespaces`_. - -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. - -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!) - -For more info, see the py.test and py lib documentation: - - http://pytest.org - - http://pylib.org - -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 - --- a/doc/announce/release-1.0.2.txt +++ /dev/null @@ -1,5 +0,0 @@ -1.0.2: packaging fixes ------------------------------------------------------------------------ - -this release is purely a release for fixing packaging issues. - --- a/doc/features.txt +++ /dev/null @@ -1,64 +0,0 @@ -py.test Features -================== - -mature no-boilerplate testing with Python ------------------------------------------------- - -- automatic, customizable :ref:`Python test discovery` -- simple test functions and freely groupable tests -- simple ``assert`` statements for assertions -- powerful parametrization of test functions -- very helpful traceback and failing assertion reporting -- use ``print`` or ``pdb`` debugging on failures -- enables fully :pep:`8` compliant coding style -- powerful :ref:`usage` possibilities, well sorted command line options -- used in many projects, ranging from 10 to 10K tests -- tested on Unix and Windows from Python 2.4 up to Python 3.1 and 3.2 -- keyword/testname based selection of tests - -supports common testing practises and methods ------------------------------------------------------------ - -- can integrate ``nose``, ``unittest.py`` and ``doctest.py`` style - tests, including running testcases made for Django and trial -- supports extended `xUnit style setup`_ -- supports domain-specific :ref:`non-python tests` -- supports generating testing coverage reports -- `Javasript unit- and functional testing`_ - -.. _`Javasript unit- and functional testing`: http://pypi.python.org/pypi/oejskit - -distributing tests to local/remote subprocesses --------------------------------------------------------- - -- can distribute tests to multiple CPUs -- can distribute tests to remote ssh or socket connected machines -- can run tests in subprocess, re-run failing ones on file-change - -extensive plugin and customization system ------------------------------------------------------- - -.. _`easy`: http://bruynooghe.blogspot.com/2009/12/skipping-slow-test-by-default-in-pytest.html - -- all collection, reporting, running aspects are delegated to hook functions -- hook functions are implemented per-directory, per-project or through PyPI released plugins -- it is `easy`_ to add command line options or - do other kind of add-ons and customizations. - -integrates well with CI systems ----------------------------------------- - -- produces compatible JunitXML output for Hudson or other CI servers -- produces "resultlog" text files for easy parsing -- integrates well with tox_ - -.. _`tox`: http://codespeak.net/tox - -skip or expect-to-fail a test -------------------------------------------- - -- skip tests if there are platform or dependency mismatches -- xfail a test (on certain platforms)indicating an implementation problem -- you can use skip and xfail imperatively or as a decorating marker - -.. include:: links.inc --- a/doc/develop.txt +++ b/doc/develop.txt @@ -15,15 +15,12 @@ Working from version control or a tarbal To follow development or start experiments, checkout the complete code and documentation source with mercurial_:: - hg clone https://bitbucket.org/hpk42/py-trunk/ - -Development takes place on the 'trunk' branch. + hg clone https://bitbucket.org/hpk42/pytest/ You can also go to the python package index and download and unpack a TAR file:: - http://pypi.python.org/pypi/py/ - + http://pypi.python.org/pypi/pytest/ activating a checkout with setuptools -------------------------------------------- --- a/doc/announce/release-1.1.0.txt +++ /dev/null @@ -1,115 +0,0 @@ -py.test/pylib 1.1.0: Python3, Jython, advanced skipping, cleanups ... --------------------------------------------------------------------------------- - -Features: - -* compatible to Python3 (single py2/py3 source), `easy to install`_ -* conditional skipping_: skip/xfail based on platform/dependencies -* generalized marking_: mark tests one a whole-class or whole-module basis - -Fixes: - -* code reduction and "de-magification" (e.g. 23 KLoc -> 11 KLOC) -* distribute testing requires the now separately released execnet_ package -* funcarg-setup/caching, "same-name" test modules now cause an exlicit error -* de-cluttered reporting options, --report for skipped/xfail details - -Compatibilities - -1.1.0 should allow running test code that already worked well with 1.0.2 -plus some more due to improved unittest/nose compatibility. - -More information: http://pytest.org - -thanks and have fun, - -holger (http://twitter.com/hpk42) - -.. _execnet: http://codespeak.net/execnet -.. _`easy to install`: ../install.html -.. _marking: ../test/plugin/mark.html -.. _skipping: ../test/plugin/skipping.html - - -Changelog 1.0.2 -> 1.1.0 ------------------------------------------------------------------------ - -* remove py.rest tool and internal namespace - it was - never really advertised and can still be used with - the old release if needed. If there is interest - it could be revived into its own tool i guess. - -* fix issue48 and issue59: raise an Error if the module - from an imported test file does not seem to come from - the filepath - avoids "same-name" confusion that has - been reported repeatedly - -* merged Ronny's nose-compatibility hacks: now - nose-style setup_module() and setup() functions are - supported - -* introduce generalized py.test.mark function marking - -* reshuffle / refine command line grouping - -* deprecate parser.addgroup in favour of getgroup which creates option group - -* add --report command line option that allows to control showing of skipped/xfailed sections - -* generalized skipping: a new way to mark python functions with skipif or xfail - at function, class and modules level based on platform or sys-module attributes. - -* extend py.test.mark decorator to allow for positional args - -* introduce and test "py.cleanup -d" to remove empty directories - -* fix issue #59 - robustify unittest test collection - -* make bpython/help interaction work by adding an __all__ attribute - to ApiModule, cleanup initpkg - -* use MIT license for pylib, add some contributors - -* remove py.execnet code and substitute all usages with 'execnet' proper - -* fix issue50 - cached_setup now caches more to expectations - for test functions with multiple arguments. - -* merge Jarko's fixes, issue #45 and #46 - -* add the ability to specify a path for py.lookup to search in - -* fix a funcarg cached_setup bug probably only occuring - in distributed testing and "module" scope with teardown. - -* many fixes and changes for making the code base python3 compatible, - many thanks to Benjamin Peterson for helping with this. - -* consolidate builtins implementation to be compatible with >=2.3, - add helpers to ease keeping 2 and 3k compatible code - -* deprecate py.compat.doctest|subprocess|textwrap|optparse - -* deprecate py.magic.autopath, remove py/magic directory - -* move pytest assertion handling to py/code and a pytest_assertion - plugin, add "--no-assert" option, deprecate py.magic namespaces - in favour of (less) py.code ones. - -* consolidate and cleanup py/code classes and files - -* cleanup py/misc, move tests to bin-for-dist - -* introduce delattr/delitem/delenv methods to py.test's monkeypatch funcarg - -* consolidate py.log implementation, remove old approach. - -* introduce py.io.TextIO and py.io.BytesIO for distinguishing between - text/unicode and byte-streams (uses underlying standard lib io.* - if available) - -* make py.unittest_convert helper script available which converts "unittest.py" - style files into the simpler assert/direct-test-classes py.test/nosetests - style. The script was written by Laura Creighton. - -* simplified internal localpath implementation --- a/doc/announce/release-1.2.1.txt +++ /dev/null @@ -1,66 +0,0 @@ -py.test/pylib 1.2.1: little fixes and improvements --------------------------------------------------------------------------------- - -py.test is an advanced automated testing tool working with -Python2, Python3 and Jython versions on all major operating -systems. It has a simple plugin architecture and can run many -existing common Python test suites without modification. It offers -some unique features not found in other testing tools. -See http://pytest.org for more info. - -py.test 1.2.1 brings bug fixes and some new options and abilities triggered -by user feedback: - -* --funcargs [testpath] will show available builtin- and project funcargs. -* display a short and concise traceback if funcarg lookup fails. -* early-load "conftest.py" files in non-dot first-level sub directories. -* --tb=line will print a single line for each failing test (issue67) -* py.cleanup has a number of new options, cleanups up setup.py related files -* fix issue78: always call python-level teardown functions even if the - according setup failed. - -For more detailed information see the changelog below. - -cheers and have fun, - -holger - - -Changes between 1.2.1 and 1.2.0 -===================================== - -- refined usage and options for "py.cleanup":: - - py.cleanup # remove "*.pyc" and "*$py.class" (jython) files - py.cleanup -e .swp -e .cache # also remove files with these extensions - py.cleanup -s # remove "build" and "dist" directory next to setup.py files - py.cleanup -d # also remove empty directories - py.cleanup -a # synonym for "-s -d -e 'pip-log.txt'" - py.cleanup -n # dry run, only show what would be removed - -- add a new option "py.test --funcargs" which shows available funcargs - and their help strings (docstrings on their respective factory function) - for a given test path - -- display a short and concise traceback if a funcarg lookup fails - -- early-load "conftest.py" files in non-dot first-level sub directories. - allows to conveniently keep and access test-related options in a ``test`` - subdir and still add command line options. - -- fix issue67: new super-short traceback-printing option: "--tb=line" will print a single line for each failing (python) test indicating its filename, lineno and the failure value - -- fix issue78: always call python-level teardown functions even if the - according setup failed. This includes refinements for calling setup_module/class functions - which will now only be called once instead of the previous behaviour where they'd be called - multiple times if they raise an exception (including a Skipped exception). Any exception - will be re-corded and associated with all tests in the according module/class scope. - -- fix issue63: assume <40 columns to be a bogus terminal width, default to 80 - -- fix pdb debugging to be in the correct frame on raises-related errors - -- update apipkg.py to fix an issue where recursive imports might - unnecessarily break importing - -- fix plugin links --- a/doc/announce/release-0.9.0.txt +++ /dev/null @@ -1,7 +0,0 @@ -py lib 1.0.0: XXX -====================================================================== - -Welcome to the 1.0.0 py lib release - a library aiming to -support agile and test-driven python development on various levels. - -XXX --- a/doc/announce/release-2.0.0.txt +++ b/doc/announce/release-2.0.0.txt @@ -126,46 +126,4 @@ Important Notes if a certain dependency or command line option is missing. -More Detailed Changes between 1.3.4 and 2.0.0 -================================================== - -- pytest-2.0 is now its own package and depends on pylib-2.0 -- new ability: python -m pytest / python -m pytest.main ability -- new python invcation: pytest.main(args, plugins) to load - some custom plugins early. -- try harder to run unittest test suites in a more compatible manner - by deferring setup/teardown semantics to the unittest package. -- introduce a new way to set config options via ini-style files, - by default setup.cfg and tox.ini files are searched. The old - ways (certain environment variables, dynamic conftest.py reading - is removed). -- add a new "-q" option which decreases verbosity and prints a more - nose/unittest-style "dot" output. -- fix issue135 - marks now work with unittest test cases as well -- fix issue126 - introduce py.test.set_trace() to trace execution via - PDB during the running of tests even if capturing is ongoing. -- fix issue123 - new "python -m py.test" invocation for py.test - (requires Python 2.5 or above) -- fix issue124 - make reporting more resilient against tests opening - files on filedescriptor 1 (stdout). -- fix issue109 - sibling conftest.py files will not be loaded. - (and Directory collectors cannot be customized anymore from a Directory's - conftest.py - this needs to happen at least one level up). -- introduce (customizable) assertion failure representations and enhance - output on assertion failures for comparisons and other cases (Floris Bruynooghe) -- nose-plugin: pass through type-signature failures in setup/teardown - functions instead of not calling them (Ed Singleton) -- remove py.test.collect.Directory (follows from a major refactoring - and simplification of the collection process) -- majorly reduce py.test core code, shift function/python testing to own plugin -- fix issue88 (finding custom test nodes from command line arg) -- refine 'tmpdir' creation, will now create basenames better associated - with test names (thanks Ronny) -- "xpass" (unexpected pass) tests don't cause exitcode!=0 -- fix issue131 / issue60 - importing doctests in __init__ files used as namespace packages -- fix issue93 stdout/stderr is captured while importing conftest.py -- fix bug: unittest collected functions now also can have "pytestmark" - applied at class/module level -- add ability to use "class" level for cached_setup helper -- fix strangeness: mark.* objects are now immutable, create new instances - +see :ref:`changelog` for more detailed changes. --- a/doc/capture.txt +++ b/doc/capture.txt @@ -17,14 +17,14 @@ Setting capturing methods or disabling c There are two ways in which ``py.test`` can perform capturing: -* ``fd`` level capturing (default): All writes going to the operating - system file descriptors 1 and 2 will be captured, for example writes such - as ``os.write(1, 'hello')``. Capturing on ``fd``-level also includes +* ``fd`` level capturing (default): All writes going to the operating + system file descriptors 1 and 2 will be captured, for example writes such + as ``os.write(1, 'hello')``. Capturing on ``fd``-level also includes **output from subprocesses**. -* ``sys`` level capturing: The ``sys.stdout`` and ``sys.stderr`` will +* ``sys`` level capturing: The ``sys.stdout`` and ``sys.stderr`` will will be replaced with in-memory files and the ``print`` builtin or - output from code like ``sys.stderr.write(...)`` will be captured with + output from code like ``sys.stderr.write(...)`` will be captured with this method. .. _`disable capturing`: @@ -42,6 +42,8 @@ If you set capturing values in a conftes then all tests in that directory will execute with "fd" style capturing. +_ `printdebugging`: + Accessing captured output from a test function --------------------------------------------------- --- a/doc/announce/release-1.2.0.txt +++ /dev/null @@ -1,116 +0,0 @@ -py.test/pylib 1.2.0: junitxml, standalone test scripts, pluginization --------------------------------------------------------------------------------- - -py.test is an advanced automated testing tool working with -Python2, Python3 and Jython versions on all major operating -systems. It has a simple plugin architecture and can run many -existing common Python test suites without modification. It offers -some unique features not found in other testing tools. -See http://pytest.org for more info. - -py.test 1.2.0 brings many bug fixes and interesting new abilities: - -* --junitxml=path will create an XML file for use with CI processing -* --genscript=path creates a standalone py.test-equivalent test-script -* --ignore=path prevents collection of anything below that path -* --confcutdir=path only lookup conftest.py test configs below that path -* a 'pytest_report_header' hook to add info to the terminal report header -* a 'pytestconfig' function argument gives direct access to option values -* 'pytest_generate_tests' can now be put into a class as well -* on CPython py.test additionally installs as "py.test-VERSION", on - Jython as py.test-jython and on PyPy as py.test-pypy-XYZ - -Apart from many bug fixes 1.2.0 also has better pluginization: -Distributed testing and looponfailing testing now live in the -separately installable 'pytest-xdist' plugin. The same is true for -'pytest-figleaf' for doing coverage reporting. Those two plugins -can serve well now as blue prints for doing your own. - -thanks to all who helped and gave feedback, -have fun, - -holger krekel, January 2010 - -Changes between 1.2.0 and 1.1.1 -===================================== - -- moved dist/looponfailing from py.test core into a new - separately released pytest-xdist plugin. - -- new junitxml plugin: --junitxml=path will generate a junit style xml file - which is processable e.g. by the Hudson CI system. - -- new option: --genscript=path will generate a standalone py.test script - which will not need any libraries installed. thanks to Ralf Schmitt. - -- new option: --ignore will prevent specified path from collection. - Can be specified multiple times. - -- new option: --confcutdir=dir will make py.test only consider conftest - files that are relative to the specified dir. - -- new funcarg: "pytestconfig" is the pytest config object for access - to command line args and can now be easily used in a test. - -- install 'py.test' and `py.which` with a ``-$VERSION`` suffix to - disambiguate between Python3, python2.X, Jython and PyPy installed versions. - -- new "pytestconfig" funcarg allows access to test config object - -- new "pytest_report_header" hook can return additional lines - to be displayed at the header of a test run. - -- (experimental) allow "py.test path::name1::name2::..." for pointing - to a test within a test collection directly. This might eventually - evolve as a full substitute to "-k" specifications. - -- streamlined plugin loading: order is now as documented in - customize.html: setuptools, ENV, commandline, conftest. - also setuptools entry point names are turned to canonical namees ("pytest_*") - -- automatically skip tests that need 'capfd' but have no os.dup - -- allow pytest_generate_tests to be defined in classes as well - -- deprecate usage of 'disabled' attribute in favour of pytestmark -- deprecate definition of Directory, Module, Class and Function nodes - in conftest.py files. Use pytest collect hooks instead. - -- collection/item node specific runtest/collect hooks are only called exactly - on matching conftest.py files, i.e. ones which are exactly below - the filesystem path of an item - -- change: the first pytest_collect_directory hook to return something - will now prevent further hooks to be called. - -- change: figleaf plugin now requires --figleaf to run. Also - change its long command line options to be a bit shorter (see py.test -h). - -- change: pytest doctest plugin is now enabled by default and has a - new option --doctest-glob to set a pattern for file matches. - -- change: remove internal py._* helper vars, only keep py._pydir - -- robustify capturing to survive if custom pytest_runtest_setup - code failed and prevented the capturing setup code from running. - -- make py.test.* helpers provided by default plugins visible early - - works transparently both for pydoc and for interactive sessions - which will regularly see e.g. py.test.mark and py.test.importorskip. - -- simplify internal plugin manager machinery -- simplify internal collection tree by introducing a RootCollector node - -- fix assert reinterpreation that sees a call containing "keyword=..." - -- fix issue66: invoke pytest_sessionstart and pytest_sessionfinish - hooks on slaves during dist-testing, report module/session teardown - hooks correctly. - -- fix issue65: properly handle dist-testing if no - execnet/py lib installed remotely. - -- skip some install-tests if no execnet is available - -- fix docs, fix internal bin/ script generation - --- a/doc/goodpractises.txt +++ b/doc/goodpractises.txt @@ -1,6 +1,6 @@ .. highlightlang:: python -.. _`good practises`: +.. _`goodpractises`: Good Integration Practises ================================================= @@ -21,6 +21,78 @@ server Hudson_. .. _`buildout`: http://www.buildout.org/ .. _pip: http://pypi.python.org/pypi/pip +Use tox and Continous Integration servers +------------------------------------------------- + +If you are (often) releasing code to the public you +may want to look into `tox`_, the virtualenv test automation +tool and its `pytest support `_. +The basic idea is to generate a JUnitXML file through the ``--junitxml=PATH`` option and have a continous integration server like Hudson_ pick it up. + +.. _standalone: +.. _`genscript method`: + +Create a py.test standalone Script +------------------------------------------- + +If you are a maintainer or application developer and want others +to easily run tests you can generate a completely standalone "py.test" +script:: + + py.test --genscript=runtests.py + +generates a ``runtests.py`` script which is a fully functional basic +``py.test`` script, running unchanged under Python2 and Python3. +You can tell people to download the script and then e.g. run it like this:: + + python runtests.py + + +.. _`Distribute for installation`: http://pypi.python.org/pypi/distribute#installation-instructions +.. _`distribute installation`: http://pypi.python.org/pypi/distribute + + +Integrating with distutils / ``python setup.py test`` +-------------------------------------------------------- + +You can easily integrate test runs into your distutils or +setuptools based project. Use the `genscript method`_ +to generate a standalone py.test script:: + + py.test --genscript=runtests.py + +and make this script part of your distribution and then add +this to your ``setup.py`` file:: + + from distutils.core import setup, Command + # you can also import from setuptools + + class PyTest(Command): + user_options = [] + def initialize_options(self): + pass + def finalize_options(self): + pass + def run(self): + import sys,subprocess + errno = subprocess.call([sys.executable, 'runtest.py']) + raise SystemExit(errno) + setup( + #..., + cmdclass = {'test': PyTest}, + #..., + ) + +If you now type:: + + python setup.py test + +this will execute your tests using ``runtest.py``. As this is a +standalone version of ``py.test`` no prior installation whatsoever is +required for calling the test command. You can also pass additional +arguments to the subprocess-calls like your test directory or other +options. + .. _`test discovery`: .. _`Python test discovery`: @@ -93,70 +165,5 @@ You can always run your tests by pointin you must follow the convention of having directory and file names map to the import names. -.. _standalone: -.. _`genscript method`: - -Generating a py.test standalone Script -------------------------------------------- - -If you are a maintainer or application developer and want others -to easily run tests you can generate a completely standalone "py.test" -script:: - - py.test --genscript=runtests.py - -generates a ``runtests.py`` script which is a fully functional basic -``py.test`` script, running unchanged under Python2 and Python3. -You can tell people to download and then e.g. run it like this to -produce a Paste URL:: - - python runtests.py --pastebin=all - -and ask them to send you the resulting URL. - -.. _`Distribute for installation`: http://pypi.python.org/pypi/distribute#installation-instructions -.. _`distribute installation`: http://pypi.python.org/pypi/distribute - - -Integrating with distutils / ``python setup.py test`` --------------------------------------------------------- - -You can easily integrate test runs into your distutils or -setuptools based project. Use the `genscript method`_ -to generate a standalone py.test script:: - - py.test --genscript=runtests.py - -and make this script part of your distribution and then add -this to your ``setup.py`` file:: - - from distutils.core import setup, Command - # you can also import from setuptools - - class PyTest(Command): - user_options = [] - def initialize_options(self): - pass - def finalize_options(self): - pass - def run(self): - import sys,subprocess - errno = subprocess.call([sys.executable, 'runtest.py']) - raise SystemExit(errno) - setup( - #..., - cmdclass = {'test': PyTest}, - #..., - ) - -If you now type:: - - python setup.py test - -this will execute your tests using ``runtest.py``. As this is a -standalone version of ``py.test`` no prior installation whatsoever is -required for calling the test command. You can also pass additional -arguments to the subprocess-calls like your test directory or other -options. .. include:: links.inc --- a/pytest.py +++ b/pytest.py @@ -1,11 +1,7 @@ """ unit and functional testing with Python. - -see http://pytest.org for documentation and details - -(c) Holger Krekel and others, 2004-2010 """ -__version__ = '2.0.0.dev38' +__version__ = '2.0.0.dev39' __all__ = ['main'] from _pytest.core import main, UsageError, _preloadplugins --- a/doc/faq.txt +++ b/doc/faq.txt @@ -6,7 +6,7 @@ Some Issues and Questions If you don't find an answer here, checkout the :ref:`contact channels` to get help. -On naming, nosetests, licensing and magic XXX +On naming, nosetests, licensing and magic ------------------------------------------------ Why a ``py.test`` instead of a ``pytest`` command? @@ -21,14 +21,16 @@ but then again many people have gotten u is another tool named "pytest" so we just decided to stick with ``py.test``. -What's py.test's relation to ``nosetests``? +What's the relation to nose and unittest? +++++++++++++++++++++++++++++++++++++++++++++++++ py.test and nose_ share basic philosophy when it comes to running Python tests. In fact, you can run many tests -written for unittest or nose with py.test. nose_ was originally created +written nose with py.test. nose_ was originally created as a clone of ``py.test`` when py.test was in the ``0.8`` release -cycle. +cycle. As of version 2.0 support for running unittest test +suites is majorly improved and you should be able to run +many Django and Twisted test suites. .. _features: test/features.html --- a/_pytest/python.py +++ b/_pytest/python.py @@ -775,33 +775,34 @@ def getlocation(function, curdir): # builtin pytest.raises helper def raises(ExpectedException, *args, **kwargs): - """ assert that a code block/function call raises an exception. + """ assert that a code block/function call raises @ExpectedException + and raise a failure exception otherwise. + + If using Python 2.5 or above, you may use this function as a + context manager:: - If using Python 2.5 or above, you may use this function as a - context manager:: + >>> with raises(ZeroDivisionError): + ... 1/0 - >>> with raises(ZeroDivisionError): - ... 1/0 + Or you can specify a callable by passing a to-be-called lambda:: - Or you can specify a callable by passing a to-be-called lambda:: + >>> raises(ZeroDivisionError, lambda: 1/0) + - >>> raises(ZeroDivisionError, lambda: 1/0) - + or you can specify an arbitrary callable with arguments:: - or you can specify an arbitrary callable with arguments:: + >>> def f(x): return 1/x + ... + >>> raises(ZeroDivisionError, f, 0) + + >>> raises(ZeroDivisionError, f, x=0) + - >>> def f(x): return 1/x - ... - >>> raises(ZeroDivisionError, f, 0) - - >>> raises(ZeroDivisionError, f, x=0) - - - A third possibility is to use a string which which will - be executed:: - - >>> raises(ZeroDivisionError, "f(0)") - + A third possibility is to use a string which which will + be executed:: + + >>> raises(ZeroDivisionError, "f(0)") + """ __tracebackhide__ = True --- a/doc/example/pythoncollection.txt +++ b/doc/example/pythoncollection.txt @@ -18,7 +18,8 @@ change naming conventions ----------------------------------------------------- You can configure different naming conventions by setting -the :confval:`pytest_pycollect` configuration option. Example:: +the :confval:`python_files`, :confval:`python_classes` and +:confval:`python_functions` configuration options. Example:: # content of setup.cfg # can also be defined in in tox.ini or pytest.ini file @@ -57,7 +58,7 @@ example if you have unittest2 installed py.test --pyargs unittest2.test.test_skipping -q -which will run the respective test module. Like with +which would run the respective test module. Like with other options, through an ini-file and the :confval:`addopts` option you can make this change more permanently:: --- a/doc/announce/release-1.0.1.txt +++ /dev/null @@ -1,48 +0,0 @@ -1.0.1: improved reporting, nose/unittest.py support, bug fixes ------------------------------------------------------------------------ - -This is a bugfix release of pylib/py.test also coming with: - -* improved documentation, improved navigation -* test failure reporting improvements -* support for directly running existing nose/unittest.py style tests - -visit here for more info, including quickstart and tutorials: - - http://pytest.org and http://pylib.org - - -Changelog 1.0.0 to 1.0.1 ------------------------- - -* added a default 'pytest_nose' plugin which handles nose.SkipTest, - nose-style function/method/generator setup/teardown and - tries to report functions correctly. - -* improved documentation, better navigation: see http://pytest.org - -* added a "--help-config" option to show conftest.py / ENV-var names for - all longopt cmdline options, and some special conftest.py variables. - renamed 'conf_capture' conftest setting to 'option_capture' accordingly. - -* unicode fixes: capturing and unicode writes to sys.stdout - (through e.g a print statement) now work within tests, - they are encoded as "utf8" by default, also terminalwriting - was adapted and somewhat unified between windows and linux - -* fix issue #27: better reporting on non-collectable items given on commandline - (e.g. pyc files) - -* fix issue #33: added --version flag (thanks Benjamin Peterson) - -* fix issue #32: adding support for "incomplete" paths to wcpath.status() - -* "Test" prefixed classes are *not* collected by default anymore if they - have an __init__ method - -* monkeypatch setenv() now accepts a "prepend" parameter - -* improved reporting of collection error tracebacks - -* simplified multicall mechanism and plugin architecture, - renamed some internal methods and argnames --- a/doc/announce/release-1.3.4.txt +++ /dev/null @@ -1,22 +0,0 @@ -py.test/pylib 1.3.4: fixes and new native traceback option -=========================================================================== - -pylib/py.test 1.3.4 is a minor maintenance release mostly containing bug fixes -and a new "--tb=native" traceback option to show "normal" Python standard -tracebacks instead of the py.test enhanced tracebacks. See below for more -change info and http://pytest.org for more general information on features -and configuration of the testing tool. - -Thanks to the issue reporters and generally to Ronny Pfannschmidt for help. - -cheers, -holger krekel - -Changes between 1.3.3 and 1.3.4 -================================================== - -- fix issue111: improve install documentation for windows -- fix issue119: fix custom collectability of __init__.py as a module -- fix issue116: --doctestmodules work with __init__.py files as well -- fix issue115: unify internal exception passthrough/catching/GeneratorExit -- fix issue118: new --tb=native for presenting cpython-standard exceptions --- a/doc/contact.txt +++ b/doc/contact.txt @@ -15,7 +15,8 @@ Contact channels - #pylib on irc.freenode.net IRC channel for random questions. -- `tetamap`_: Holger Krekel's blog, often about testing and py.test related news. +- private mail to Holger.Krekel at gmail com if you have sensitive issues to communicate + - `commit mailing list`_ - `merlinux.eu`_ offers on-site teaching and consulting services. --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ def main(): name='pytest', description='py.test: simple powerful testing with Python', long_description = long_description, - version='2.0.0.dev38', + version='2.0.0.dev39', url='http://pytest.org', license='MIT license', platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'], --- a/doc/_templates/indexsidebar.html +++ b/doc/_templates/indexsidebar.html @@ -12,10 +12,11 @@

pytest on PyPI

easy_install pytest

pip install pytest

{% endif %}

Questions? Suggestions?

Checkout support channels +

contact channels

--- /dev/null +++ b/doc/naming20.txt @@ -0,0 +1,20 @@ + +.. _naming20: + +New pytest names in 2.0 (flat is better than nested) +---------------------------------------------------- + +If you used older version of the ``py`` distribution (which +included the py.test command line tool and Python name space) +you accessed helpers and possibly collection classes through +the ``py.test`` Python namespaces. The new ``pytest`` +Python module flaty provides the same objects, following +these renaming rules:: + + py.test.XYZ -> pytest.XYZ + py.test.collect.XYZ -> pytest.XYZ + py.test.cmdline.main -> pytest.main + +The old ``py.test.*`` ways to access functionality remain +valid but you are encouraged to do global renames according +to the above rules in your test code. --- a/doc/example/simple.txt +++ b/doc/example/simple.txt @@ -1,26 +1,9 @@ .. highlightlang:: python -simple hook using patterns +basic patterns and examples ========================================================== -adding custom options ----------------------- - -py.test supports adding of standard optparse_ Options. -A plugin may implement the ``addoption`` hook for registering -custom options:: - - def pytest_addoption(parser): - parser.addoption("-M", "--myopt", action="store", - help="specify string to set myopt") - - def pytest_configure(config): - if config.option.myopt: - # do action based on option value - -.. _optparse: http://docs.python.org/library/optparse.html - pass different values to a test function, depending on command line options ---------------------------------------------------------------------------- @@ -37,7 +20,7 @@ Here is a basic pattern how to achieve t For this to work we need to add a command line option and -provide the ``cmdopt`` through a function argument factory:: +provide the ``cmdopt`` through a :ref:`function argument ` factory:: # content of conftest.py def pytest_addoption(parser): --- a/CHANGELOG +++ b/CHANGELOG @@ -7,6 +7,8 @@ Changes between 1.3.4 and 2.0.0dev0 some custom plugins early. - try harder to run unittest test suites in a more compatible manner by deferring setup/teardown semantics to the unittest package. + also work harder to run twisted/trial and Django tests which + should now basically work by default. - introduce a new way to set config options via ini-style files, by default setup.cfg and tox.ini files are searched. The old ways (certain environment variables, dynamic conftest.py reading --- a/doc/overview.txt +++ b/doc/overview.txt @@ -1,13 +1,13 @@ ================================================== -Overview and Introduction +Getting started basics ================================================== .. toctree:: :maxdepth: 2 - features.txt getting-started.txt usage.txt goodpractises.txt + projects.txt faq.txt --- a/doc/announce/release-1.3.3.txt +++ /dev/null @@ -1,26 +0,0 @@ -py.test/pylib 1.3.3: windows and other fixes -=========================================================================== - -pylib/py.test 1.3.3 is a minor bugfix release featuring some improvements -and fixes. See changelog_ for full history. - -have fun, -holger krekel - -.. _changelog: ../changelog.html - -Changes between 1.3.2 and 1.3.3 -================================================== - -- fix issue113: assertion representation problem with triple-quoted strings - (and possibly other cases) -- make conftest loading detect that a conftest file with the same - content was already loaded, avoids surprises in nested directory structures - which can be produced e.g. by Hudson. It probably removes the need to use - --confcutdir in most cases. -- fix terminal coloring for win32 - (thanks Michael Foord for reporting) -- fix weirdness: make terminal width detection work on stdout instead of stdin - (thanks Armin Ronacher for reporting) -- remove trailing whitespace in all py/text distribution files - --- a/doc/customize.txt +++ b/doc/customize.txt @@ -11,6 +11,7 @@ You can get help on options and ini-conf This will display command line and configuration file settings which were registered by installed plugins. + how test configuration is read from setup/tox ini-files -------------------------------------------------------- @@ -40,6 +41,26 @@ will look in the following dirs for a co If argument is provided to a py.test run, the current working directory is used to start the search. +.. _`how to change command line options defaults`: +.. _`adding default options`: + +how to change command line options defaults +------------------------------------------------ + +py.test provides a simple way to set some default +command line options. For example, if you want +to always see detailed info on skipped and xfailed +tests, as well as have terser "dot progress output", +you can add this to your root directory:: + + # content of pytest.ini + # (or tox.ini or setup.cfg) + [pytest] + addopts = -rsxX -q + +From now on, running ``py.test`` will implicitely add +the specified options. + builtin configuration file options ---------------------------------------------- @@ -86,18 +107,20 @@ builtin configuration file options This would tell py.test to not recurse into typical subversion or sphinx-build directories or into any ``tmp`` prefixed directory. -.. confval:: python_discovery +.. confval:: python_files - Determines names and patterns for finding Python tests, specified - through indendent ``name = value`` settings with these possible names:: + One or more Glob-style file patterns determining which python files + are considered as test modules. - [pytest] - python_discovery = - file =

- func = - class = +.. confval:: python_classes - See :ref:`change naming conventions` for examples. the ``class`` - to be empty in which case all non-underscore empty classes - will be considered. + One or more name prefixes determining which test classes + are considered as test modules. +.. confval:: python_functions + + One or more name prefixes determining which test functions + and methods are considered as test modules. + + See :ref:`change naming conventions` for examples. + --- a/doc/apiref.txt +++ b/doc/apiref.txt @@ -4,7 +4,6 @@ py.test reference documentation ================================================ - .. toctree:: :maxdepth: 2 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -6,6 +6,7 @@ include LICENSE #include conftest.py graft doc graft testing +exclude doc/_build include testing #exclude *.orig #exclude *.orig --- /dev/null +++ b/doc/example/reportingdemo.txt @@ -0,0 +1,486 @@ + +.. _`tbreportdemo`: + +Demo of Python failure reports with py.test +================================================== + +Here is a nice run of several tens of failures +and how py.test presents things (unfortunately +not showing the nice colors here in the HTML that you +get on the terminal - we are working on that):: + + assertion $ py.test failure_demo.py + =========================== test session starts ============================ + platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev38 + collecting ... + collected 35 items + + failure_demo.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF + + ================================= FAILURES ================================= + ____________________________ test_generative[0] ____________________________ + + param1 = 3, param2 = 6 + + def test_generative(param1, param2): + > assert param1 * 2 < param2 + E assert (3 * 2) < 6 + + failure_demo.py:15: AssertionError + _________________________ TestFailing.test_simple __________________________ + + self = + + def test_simple(self): + def f(): + return 42 + def g(): + return 43 + + > assert f() == g() + E assert 42 == 43 + E + where 42 = () + E + and 43 = () + + failure_demo.py:28: AssertionError + ____________________ TestFailing.test_simple_multiline _____________________ + + self = + + def test_simple_multiline(self): + otherfunc_multi( + 42, + > 6*9) + + failure_demo.py:33: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + a = 42, b = 54 + + def otherfunc_multi(a,b): + assert (a == + > b) + E assert 42 == 54 + + failure_demo.py:12: AssertionError + ___________________________ TestFailing.test_not ___________________________ + + self = + + def test_not(self): + def f(): + return 42 + > assert not f() + E assert not 42 + E + where 42 = () + + failure_demo.py:38: AssertionError + _________________ TestSpecialisedExplanations.test_eq_text _________________ + + self = + + def test_eq_text(self): + > assert 'spam' == 'eggs' + E assert 'spam' == 'eggs' + E - spam + E + eggs + + failure_demo.py:42: AssertionError + _____________ TestSpecialisedExplanations.test_eq_similar_text _____________ + + self = + + def test_eq_similar_text(self): + > assert 'foo 1 bar' == 'foo 2 bar' + E assert 'foo 1 bar' == 'foo 2 bar' + E - foo 1 bar + E ? ^ + E + foo 2 bar + E ? ^ + + failure_demo.py:45: AssertionError + ____________ TestSpecialisedExplanations.test_eq_multiline_text ____________ + + self = + + def test_eq_multiline_text(self): + > assert 'foo\nspam\nbar' == 'foo\neggs\nbar' + E assert 'foo\nspam\nbar' == 'foo\neggs\nbar' + E foo + E - spam + E + eggs + E bar + + failure_demo.py:48: AssertionError + ______________ TestSpecialisedExplanations.test_eq_long_text _______________ + + self = + + def test_eq_long_text(self): + a = '1'*100 + 'a' + '2'*100 + b = '1'*100 + 'b' + '2'*100 + > assert a == b + E assert '111111111111...2222222222222' == '111111111111...2222222222222' + E Skipping 90 identical leading characters in diff + E Skipping 91 identical trailing characters in diff + E - 1111111111a222222222 + E ? ^ + E + 1111111111b222222222 + E ? ^ + + failure_demo.py:53: AssertionError + _________ TestSpecialisedExplanations.test_eq_long_text_multiline __________ + + self = + + def test_eq_long_text_multiline(self): + a = '1\n'*100 + 'a' + '2\n'*100 + b = '1\n'*100 + 'b' + '2\n'*100 + > assert a == b + E assert '1\n1\n1\n1\n...n2\n2\n2\n2\n' == '1\n1\n1\n1\n...n2\n2\n2\n2\n' + E Skipping 190 identical leading characters in diff + E Skipping 191 identical trailing characters in diff + E 1 + E 1 + E 1 + E 1 + E 1 + E - a2 + E + b2 + E 2 + E 2 + E 2 + E 2 + + failure_demo.py:58: AssertionError + _________________ TestSpecialisedExplanations.test_eq_list _________________ + + self = + + def test_eq_list(self): + > assert [0, 1, 2] == [0, 1, 3] + E assert [0, 1, 2] == [0, 1, 3] + E At index 2 diff: 2 != 3 + + failure_demo.py:61: AssertionError + ______________ TestSpecialisedExplanations.test_eq_list_long _______________ + + self = + + def test_eq_list_long(self): + a = [0]*100 + [1] + [3]*100 + b = [0]*100 + [2] + [3]*100 + > assert a == b + E assert [0, 0, 0, 0, 0, 0, ...] == [0, 0, 0, 0, 0, 0, ...] + E At index 100 diff: 1 != 2 + + failure_demo.py:66: AssertionError + _________________ TestSpecialisedExplanations.test_eq_dict _________________ + + self = + + def test_eq_dict(self): + > assert {'a': 0, 'b': 1} == {'a': 0, 'b': 2} + E assert {'a': 0, 'b': 1} == {'a': 0, 'b': 2} + E - {'a': 0, 'b': 1} + E ? ^ + E + {'a': 0, 'b': 2} + E ? ^ + + failure_demo.py:69: AssertionError + _________________ TestSpecialisedExplanations.test_eq_set __________________ + + self = + + def test_eq_set(self): + > assert set([0, 10, 11, 12]) == set([0, 20, 21]) + E assert set([0, 10, 11, 12]) == set([0, 20, 21]) + E Extra items in the left set: + E 10 + E 11 + E 12 + E Extra items in the right set: + E 20 + E 21 + + failure_demo.py:72: AssertionError + _____________ TestSpecialisedExplanations.test_eq_longer_list ______________ + + self = + + def test_eq_longer_list(self): + > assert [1,2] == [1,2,3] + E assert [1, 2] == [1, 2, 3] + E Right contains more items, first extra item: 3 + + failure_demo.py:75: AssertionError + _________________ TestSpecialisedExplanations.test_in_list _________________ + + self = + + def test_in_list(self): + > assert 1 in [0, 2, 3, 4, 5] + E assert 1 in [0, 2, 3, 4, 5] + + failure_demo.py:78: AssertionError + ______________________________ test_attribute ______________________________ + + def test_attribute(): + class Foo(object): + b = 1 + i = Foo() + > assert i.b == 2 + E assert 1 == 2 + E + where 1 = .b + + failure_demo.py:85: AssertionError + _________________________ test_attribute_instance __________________________ + + def test_attribute_instance(): + class Foo(object): + b = 1 + > assert Foo().b == 2 + E assert 1 == 2 + E + where 1 = .b + E + where = () + + failure_demo.py:91: AssertionError + __________________________ test_attribute_failure __________________________ + + def test_attribute_failure(): + class Foo(object): + def _get_b(self): + raise Exception('Failed to get attrib') + b = property(_get_b) + i = Foo() + > assert i.b == 2 + + failure_demo.py:100: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + self = + + def _get_b(self): + > raise Exception('Failed to get attrib') + E Exception: Failed to get attrib + + failure_demo.py:97: Exception + _________________________ test_attribute_multiple __________________________ + + def test_attribute_multiple(): + class Foo(object): + b = 1 + class Bar(object): + b = 2 + > assert Foo().b == Bar().b + E assert 1 == 2 + E + where 1 = .b + E + where = () + E + and 2 = .b + E + where = () + + failure_demo.py:108: AssertionError + __________________________ TestRaises.test_raises __________________________ + + self = + + def test_raises(self): + s = 'qwe' + > raises(TypeError, "int(s)") + + failure_demo.py:117: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + > int(s) + E ValueError: invalid literal for int() with base 10: 'qwe' + + <0-codegen /home/hpk/p/pytest/_pytest/python.py:819>:1: ValueError + ______________________ TestRaises.test_raises_doesnt _______________________ + + self = + + def test_raises_doesnt(self): + > raises(IOError, "int('3')") + E Failed: DID NOT RAISE + + failure_demo.py:120: Failed + __________________________ TestRaises.test_raise ___________________________ + + self = + + def test_raise(self): + > raise ValueError("demo error") + E ValueError: demo error + + failure_demo.py:123: ValueError + ________________________ TestRaises.test_tupleerror ________________________ + + self = + + def test_tupleerror(self): + > a,b = [1] + E ValueError: need more than 1 value to unpack + + failure_demo.py:126: ValueError + ______ TestRaises.test_reinterpret_fails_with_print_for_the_fun_of_it ______ + + self = + + def test_reinterpret_fails_with_print_for_the_fun_of_it(self): + l = [1,2,3] + print ("l is %r" % l) + > a,b = l.pop() + E TypeError: 'int' object is not iterable + + failure_demo.py:131: TypeError + ----------------------------- Captured stdout ------------------------------ + l is [1, 2, 3] + ________________________ TestRaises.test_some_error ________________________ + + self = + + def test_some_error(self): + > if namenotexi: + E NameError: global name 'namenotexi' is not defined + + failure_demo.py:134: NameError + ____________________ test_dynamic_compile_shows_nicely _____________________ + + 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') + py.builtin.exec_(code, module.__dict__) + py.std.sys.modules[name] = module + > module.foo() + + failure_demo.py:149: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + def foo(): + > assert 1 == 0 + E assert 1 == 0 + + <2-codegen 'abc-123' /home/hpk/p/pytest/doc/example/assertion/failure_demo.py:146>:2: AssertionError + ____________________ TestMoreErrors.test_complex_error _____________________ + + self = + + def test_complex_error(self): + def f(): + return 44 + def g(): + return 43 + > somefunc(f(), g()) + + failure_demo.py:159: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + x = 44, y = 43 + + def somefunc(x,y): + > otherfunc(x,y) + + failure_demo.py:8: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + a = 44, b = 43 + + def otherfunc(a,b): + > assert a==b + E assert 44 == 43 + + failure_demo.py:5: AssertionError + ___________________ TestMoreErrors.test_z1_unpack_error ____________________ + + self = + + def test_z1_unpack_error(self): + l = [] + > a,b = l + E ValueError: need more than 0 values to unpack + + failure_demo.py:163: ValueError + ____________________ TestMoreErrors.test_z2_type_error _____________________ + + self = + + def test_z2_type_error(self): + l = 3 + > a,b = l + E TypeError: 'int' object is not iterable + + failure_demo.py:167: TypeError + ______________________ TestMoreErrors.test_startswith ______________________ + + self = + + def test_startswith(self): + s = "123" + g = "456" + > assert s.startswith(g) + E assert ('456') + E + where = '123'.startswith + + failure_demo.py:172: AssertionError + __________________ TestMoreErrors.test_startswith_nested ___________________ + + self = + + def test_startswith_nested(self): + def f(): + return "123" + def g(): + return "456" + > assert f().startswith(g()) + E assert ('456') + E + where = '123'.startswith + E + where '123' = () + E + and '456' = () + + failure_demo.py:179: AssertionError + _____________________ TestMoreErrors.test_global_func ______________________ + + self = + + def test_global_func(self): + > assert isinstance(globf(42), float) + E assert isinstance(43, float) + E + where 43 = globf(42) + + failure_demo.py:182: AssertionError + _______________________ TestMoreErrors.test_instance _______________________ + + self = + + def test_instance(self): + self.x = 6*7 + > assert self.x != 42 + E assert 42 != 42 + E + where 42 = 42 + E + where 42 = .x + + failure_demo.py:186: AssertionError + _______________________ TestMoreErrors.test_compare ________________________ + + self = + + def test_compare(self): + > assert globf(10) < 5 + E assert 11 < 5 + E + where 11 = globf(10) + + failure_demo.py:189: AssertionError + _____________________ TestMoreErrors.test_try_finally ______________________ + + self = + + def test_try_finally(self): + x = 1 + try: + > assert x == 0 + E assert 1 == 0 + + failure_demo.py:194: AssertionError + ======================== 35 failed in 0.19 seconds ========================= --- a/doc/getting-started.txt +++ b/doc/getting-started.txt @@ -3,6 +3,8 @@ Installation and Getting Started **Compatibility**: Python 2.4-3.2, Jython, PyPy on Unix/Posix and Windows +.. _`getstarted`: + Installation ---------------------------------------- @@ -18,6 +20,8 @@ To check your installation has installed If you get an error checkout :ref:`installation issues`. +.. _`simpletest`: + Our first test run ---------------------------------------------------------- @@ -55,16 +59,16 @@ py.test found the ``test_answer`` functi .. note:: You can simply use the ``assert`` statement for coding expectations because - intermediate values will be presented to you. This is much easier than - learning all the `the JUnit legacy methods`_ which are even inconsistent - with Python's own coding guidelines (but consistent with - Java-style naming). + intermediate values will be presented to you. This is arguably easier than + learning all the `the JUnit legacy methods`_. - There is only one seldomly hit caveat to using asserts: if your - assertion expression fails and has side effects then re-evaluating - it for presenting intermediate values can go wrong. It's easy to fix: - compute the value ahead of the assert and then do the - assertion or use the assert "message" syntax:: + However, there remains one caveat to using simple asserts: your + assertion expression should better be side-effect free. Because + after an assertion failed py.test will re-evaluate the expression + in order to present intermediate values. You will get a nice warning + and you can easily fix it: compute the value ahead of the assert and + then do the assertion. Or maybe just use the assert "explicit message" + syntax:: assert expr, "message" # show "message" if expr is not True --- a/doc/example/assertion/failure_demo.py +++ b/doc/example/assertion/failure_demo.py @@ -37,6 +37,120 @@ class TestFailing(object): return 42 assert not f() +class TestSpecialisedExplanations(object): + def test_eq_text(self): + assert 'spam' == 'eggs' + + def test_eq_similar_text(self): + assert 'foo 1 bar' == 'foo 2 bar' + + def test_eq_multiline_text(self): + assert 'foo\nspam\nbar' == 'foo\neggs\nbar' + + def test_eq_long_text(self): + a = '1'*100 + 'a' + '2'*100 + b = '1'*100 + 'b' + '2'*100 + assert a == b + + def test_eq_long_text_multiline(self): + a = '1\n'*100 + 'a' + '2\n'*100 + b = '1\n'*100 + 'b' + '2\n'*100 + assert a == b + + def test_eq_list(self): + assert [0, 1, 2] == [0, 1, 3] + + def test_eq_list_long(self): + a = [0]*100 + [1] + [3]*100 + b = [0]*100 + [2] + [3]*100 + assert a == b + + def test_eq_dict(self): + assert {'a': 0, 'b': 1} == {'a': 0, 'b': 2} + + def test_eq_set(self): + assert set([0, 10, 11, 12]) == set([0, 20, 21]) + + def test_eq_longer_list(self): + assert [1,2] == [1,2,3] + + def test_in_list(self): + assert 1 in [0, 2, 3, 4, 5] + + +def test_attribute(): + class Foo(object): + b = 1 + i = Foo() + assert i.b == 2 + + +def test_attribute_instance(): + class Foo(object): + b = 1 + assert Foo().b == 2 + + +def test_attribute_failure(): + class Foo(object): + def _get_b(self): + raise Exception('Failed to get attrib') + b = property(_get_b) + i = Foo() + assert i.b == 2 + + +def test_attribute_multiple(): + class Foo(object): + b = 1 + class Bar(object): + b = 2 + assert Foo().b == Bar().b + + +def globf(x): + return x+1 + +class TestRaises: + 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 %r" % l) + a,b = l.pop() + + def test_some_error(self): + if namenotexi: + pass + + def func1(self): + assert 41 == 42 + + +# 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') + py.builtin.exec_(code, module.__dict__) + py.std.sys.modules[name] = module + module.foo() + + + +class TestMoreErrors: def test_complex_error(self): def f(): return 44 @@ -81,113 +195,3 @@ class TestFailing(object): 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 %r" % l) - a,b = l.pop() - - def test_some_error(self): - if namenotexi: - pass - - def func1(self): - assert 41 == 42 - - -# 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') - py.builtin.exec_(code, module.__dict__) - py.std.sys.modules[name] = module - module.foo() - - -class TestSpecialisedExplanations(object): - def test_eq_text(self): - assert 'spam' == 'eggs' - - def test_eq_similar_text(self): - assert 'foo 1 bar' == 'foo 2 bar' - - def test_eq_multiline_text(self): - assert 'foo\nspam\nbar' == 'foo\neggs\nbar' - - def test_eq_long_text(self): - a = '1'*100 + 'a' + '2'*100 - b = '1'*100 + 'b' + '2'*100 - assert a == b - - def test_eq_long_text_multiline(self): - a = '1\n'*100 + 'a' + '2\n'*100 - b = '1\n'*100 + 'b' + '2\n'*100 - assert a == b - - def test_eq_list(self): - assert [0, 1, 2] == [0, 1, 3] - - def test_eq_list_long(self): - a = [0]*100 + [1] + [3]*100 - b = [0]*100 + [2] + [3]*100 - assert a == b - - def test_eq_dict(self): - assert {'a': 0, 'b': 1} == {'a': 0, 'b': 2} - - def test_eq_set(self): - assert set([0, 10, 11, 12]) == set([0, 20, 21]) - - def test_eq_longer_list(self): - assert [1,2] == [1,2,3] - - def test_in_list(self): - assert 1 in [0, 2, 3, 4, 5] - - -def test_attribute(): - class Foo(object): - b = 1 - i = Foo() - assert i.b == 2 - - -def test_attribute_instance(): - class Foo(object): - b = 1 - assert Foo().b == 2 - - -def test_attribute_failure(): - class Foo(object): - def _get_b(self): - raise Exception('Failed to get attrib') - b = property(_get_b) - i = Foo() - assert i.b == 2 - - -def test_attribute_multiple(): - class Foo(object): - b = 1 - class Bar(object): - b = 2 - assert Foo().b == Bar().b - - -def globf(x): - return x+1 --- a/doc/changelog.txt +++ b/doc/changelog.txt @@ -1,3 +1,5 @@ + +.. _changelog: Changelog history ================================= --- a/doc/announce/release-1.3.1.txt +++ /dev/null @@ -1,104 +0,0 @@ -py.test/pylib 1.3.1: new py.test.xfail, --maxfail, better reporting -=========================================================================== - -The pylib/py.test 1.3.1 release brings: - -- the new imperative ``py.test.xfail()`` helper in order to have a test or - setup function result in an "expected failure" -- a new option ``--maxfail=NUM`` to stop the test run after some failures -- markers/decorators are now applicable to test classes (>=Python2.6) -- improved reporting, shorter tracebacks in several cases -- some simplified internals, more compatibility with Jython and PyPy -- bug fixes and various refinements - -See the below CHANGELOG entry below for more details and -http://pylib.org/install.html for installation instructions. - -If you used older versions of py.test you should be able to upgrade -to 1.3.1 without changes to your test source code. - -py.test is an automated testing tool working with Python2, -Python3, Jython and PyPy versions on all major operating systems. It -offers a no-boilerplate testing approach and has inspired other testing -tools and enhancements in the standard Python library for more than five -years. It has a simple and extensive plugin architecture, configurable -reporting and provides unique ways to make it fit to your testing -process and needs. - -See http://pytest.org for more info. - -cheers and have fun, - -holger krekel - -Changes between 1.3.0 and 1.3.1 -================================================== - -New features -++++++++++++++++++ - -- issue91: introduce new py.test.xfail(reason) helper - to imperatively mark a test as expected to fail. Can - be used from within setup and test functions. This is - useful especially for parametrized tests when certain - configurations are expected-to-fail. In this case the - declarative approach with the @py.test.mark.xfail cannot - be used as it would mark all configurations as xfail. - -- issue102: introduce new --maxfail=NUM option to stop - test runs after NUM failures. This is a generalization - of the '-x' or '--exitfirst' option which is now equivalent - to '--maxfail=1'. Both '-x' and '--maxfail' will - now also print a line near the end indicating the Interruption. - -- issue89: allow py.test.mark decorators to be used on classes - (class decorators were introduced with python2.6) and - also allow to have multiple markers applied at class/module level - by specifying a list. - -- improve and refine letter reporting in the progress bar: - . pass - f failed test - s skipped tests (reminder: use for dependency/platform mismatch only) - x xfailed test (test that was expected to fail) - X xpassed test (test that was expected to fail but passed) - - You can use any combination of 'fsxX' with the '-r' extended - reporting option. The xfail/xpass results will show up as - skipped tests in the junitxml output - which also fixes - issue99. - -- make py.test.cmdline.main() return the exitstatus instead of raising - SystemExit and also allow it to be called multiple times. This of - course requires that your application and tests are properly teared - down and don't have global state. - -Fixes / Maintenance -++++++++++++++++++++++ - -- improved traceback presentation: - - improved and unified reporting for "--tb=short" option - - Errors during test module imports are much shorter, (using --tb=short style) - - raises shows shorter more relevant tracebacks - - --fulltrace now more systematically makes traces longer / inhibits cutting - -- improve support for raises and other dynamically compiled code by - manipulating python's linecache.cache instead of the previous - rather hacky way of creating custom code objects. This makes - it seemlessly work on Jython and PyPy where it previously didn't. - -- fix issue96: make capturing more resilient against Control-C - interruptions (involved somewhat substantial refactoring - to the underlying capturing functionality to avoid race - conditions). - -- fix chaining of conditional skipif/xfail decorators - so it works now - as expected to use multiple @py.test.mark.skipif(condition) decorators, - including specific reporting which of the conditions lead to skipping. - -- fix issue95: late-import zlib so that it's not required - for general py.test startup. - -- fix issue94: make reporting more robust against bogus source code - (and internally be more careful when presenting unexpected byte sequences) - --- a/doc/xunit_setup.txt +++ b/doc/xunit_setup.txt @@ -1,3 +1,5 @@ +.. _xunitsetup: + ==================================== extended xUnit style setup fixtures ==================================== --- a/doc/example/index.txt +++ b/doc/example/index.txt @@ -4,12 +4,13 @@ Usages and Examples =========================================== -This is a (growing) list of examples. :ref:`Contact ` us if you -need more examples or have questions. +Here is a (growing) list of examples. :ref:`Contact ` us if you +need more examples or have questions. Also take a look at the :ref:`comprehensive documentation ` which contains many example snippets as well. .. toctree:: :maxdepth: 2 + reportingdemo.txt simple.txt pythoncollection.txt mysetup.txt --- a/_pytest/helpconfig.py +++ b/_pytest/helpconfig.py @@ -40,7 +40,8 @@ def showhelp(config): tw.line() tw.line() #tw.sep( "=", "config file settings") - tw.line("setup.cfg or tox.ini options to be put into [pytest] section:") + tw.line("[pytest] ini-options in the next " + "pytest.ini|tox.ini|setup.cfg file:") tw.line() for name in config._parser._ininames: --- a/doc/announce/release-1.3.2.txt +++ /dev/null @@ -1,720 +0,0 @@ -py.test/pylib 1.3.2: API and reporting refinements, many fixes -=========================================================================== - -The pylib/py.test 1.3.2 release brings many bug fixes and some new -features. It was refined for and tested against the recently released -Python2.7 and remains compatibile to the usual armada of interpreters -(Python2.4 through to Python3.1.2, Jython and PyPy). Note that for using -distributed testing features you'll need to upgrade to the jointly released -pytest-xdist-1.4 because of some internal refactorings. - -See http://pytest.org for general documentation and below for -a detailed CHANGELOG. - -cheers & particular thanks to Benjamin Peterson, Ronny Pfannschmidt -and all issue and patch contributors, - -holger krekel - -Changes between 1.3.1 and 1.3.2 -================================================== - -New features -++++++++++++++++++ - -- fix issue103: introduce py.test.raises as context manager, examples:: - - with py.test.raises(ZeroDivisionError): - x = 0 - 1 / x - - with py.test.raises(RuntimeError) as excinfo: - call_something() - - # you may do extra checks on excinfo.value|type|traceback here - - (thanks Ronny Pfannschmidt) - -- Funcarg factories can now dynamically apply a marker to a - test invocation. This is for example useful if a factory - provides parameters to a test which are expected-to-fail:: - - def pytest_funcarg__arg(request): - request.applymarker(py.test.mark.xfail(reason="flaky config")) - ... - - def test_function(arg): - ... - -- improved error reporting on collection and import errors. This makes - use of a more general mechanism, namely that for custom test item/collect - nodes ``node.repr_failure(excinfo)`` is now uniformly called so that you can - override it to return a string error representation of your choice - which is going to be reported as a (red) string. - -- introduce '--junitprefix=STR' option to prepend a prefix - to all reports in the junitxml file. - -Bug fixes / Maintenance -++++++++++++++++++++++++++ - -- make tests and the ``pytest_recwarn`` plugin in particular fully compatible - to Python2.7 (if you use the ``recwarn`` funcarg warnings will be enabled so that - you can properly check for their existence in a cross-python manner). -- refine --pdb: ignore xfailed tests, unify its TB-reporting and - don't display failures again at the end. -- fix assertion interpretation with the ** operator (thanks Benjamin Peterson) -- fix issue105 assignment on the same line as a failing assertion (thanks Benjamin Peterson) -- fix issue104 proper escaping for test names in junitxml plugin (thanks anonymous) -- fix issue57 -f|--looponfail to work with xpassing tests (thanks Ronny) -- fix issue92 collectonly reporter and --pastebin (thanks Benjamin Peterson) -- fix py.code.compile(source) to generate unique filenames -- fix assertion re-interp problems on PyPy, by defering code - compilation to the (overridable) Frame.eval class. (thanks Amaury Forgeot) -- fix py.path.local.pyimport() to work with directories -- streamline py.path.local.mkdtemp implementation and usage -- don't print empty lines when showing junitxml-filename -- add optional boolean ignore_errors parameter to py.path.local.remove -- fix terminal writing on win32/python2.4 -- py.process.cmdexec() now tries harder to return properly encoded unicode objects - on all python versions -- install plain py.test/py.which scripts also for Jython, this helps to - get canonical script paths in virtualenv situations -- make path.bestrelpath(path) return ".", note that when calling - X.bestrelpath the assumption is that X is a directory. -- make initial conftest discovery ignore "--" prefixed arguments -- fix resultlog plugin when used in an multicpu/multihost xdist situation - (thanks Jakub Gustak) -- perform distributed testing related reporting in the xdist-plugin - rather than having dist-related code in the generic py.test - distribution -- fix homedir detection on Windows -- ship distribute_setup.py version 0.6.13 - -Changes between 1.3.0 and 1.3.1 -================================================== - -New features -++++++++++++++++++ - -- issue91: introduce new py.test.xfail(reason) helper - to imperatively mark a test as expected to fail. Can - be used from within setup and test functions. This is - useful especially for parametrized tests when certain - configurations are expected-to-fail. In this case the - declarative approach with the @py.test.mark.xfail cannot - be used as it would mark all configurations as xfail. - -- issue102: introduce new --maxfail=NUM option to stop - test runs after NUM failures. This is a generalization - of the '-x' or '--exitfirst' option which is now equivalent - to '--maxfail=1'. Both '-x' and '--maxfail' will - now also print a line near the end indicating the Interruption. - -- issue89: allow py.test.mark decorators to be used on classes - (class decorators were introduced with python2.6) and - also allow to have multiple markers applied at class/module level - by specifying a list. - -- improve and refine letter reporting in the progress bar: - . pass - f failed test - s skipped tests (reminder: use for dependency/platform mismatch only) - x xfailed test (test that was expected to fail) - X xpassed test (test that was expected to fail but passed) - - You can use any combination of 'fsxX' with the '-r' extended - reporting option. The xfail/xpass results will show up as - skipped tests in the junitxml output - which also fixes - issue99. - -- make py.test.cmdline.main() return the exitstatus instead of raising - SystemExit and also allow it to be called multiple times. This of - course requires that your application and tests are properly teared - down and don't have global state. - -Fixes / Maintenance -++++++++++++++++++++++ - -- improved traceback presentation: - - improved and unified reporting for "--tb=short" option - - Errors during test module imports are much shorter, (using --tb=short style) - - raises shows shorter more relevant tracebacks - - --fulltrace now more systematically makes traces longer / inhibits cutting - -- improve support for raises and other dynamically compiled code by - manipulating python's linecache.cache instead of the previous - rather hacky way of creating custom code objects. This makes - it seemlessly work on Jython and PyPy where it previously didn't. - -- fix issue96: make capturing more resilient against Control-C - interruptions (involved somewhat substantial refactoring - to the underlying capturing functionality to avoid race - conditions). - -- fix chaining of conditional skipif/xfail decorators - so it works now - as expected to use multiple @py.test.mark.skipif(condition) decorators, - including specific reporting which of the conditions lead to skipping. - -- fix issue95: late-import zlib so that it's not required - for general py.test startup. - -- fix issue94: make reporting more robust against bogus source code - (and internally be more careful when presenting unexpected byte sequences) - - -Changes between 1.2.1 and 1.3.0 -================================================== - -- deprecate --report option in favour of a new shorter and easier to - remember -r option: it takes a string argument consisting of any - combination of 'xfsX' characters. They relate to the single chars - you see during the dotted progress printing and will print an extra line - per test at the end of the test run. This extra line indicates the exact - position or test ID that you directly paste to the py.test cmdline in order - to re-run a particular test. - -- allow external plugins to register new hooks via the new - pytest_addhooks(pluginmanager) hook. The new release of - the pytest-xdist plugin for distributed and looponfailing - testing requires this feature. - -- add a new pytest_ignore_collect(path, config) hook to allow projects and - plugins to define exclusion behaviour for their directory structure - - for example you may define in a conftest.py this method:: - - def pytest_ignore_collect(path): - return path.check(link=1) - - to prevent even a collection try of any tests in symlinked dirs. - -- new pytest_pycollect_makemodule(path, parent) hook for - allowing customization of the Module collection object for a - matching test module. - -- extend and refine xfail mechanism: - ``@py.test.mark.xfail(run=False)`` do not run the decorated test - ``@py.test.mark.xfail(reason="...")`` prints the reason string in xfail summaries - specifiying ``--runxfail`` on command line virtually ignores xfail markers - -- expose (previously internal) commonly useful methods: - py.io.get_terminal_with() -> return terminal width - py.io.ansi_print(...) -> print colored/bold text on linux/win32 - py.io.saferepr(obj) -> return limited representation string - -- expose test outcome related exceptions as py.test.skip.Exception, - py.test.raises.Exception etc., useful mostly for plugins - doing special outcome interpretation/tweaking - -- (issue85) fix junitxml plugin to handle tests with non-ascii output - -- fix/refine python3 compatibility (thanks Benjamin Peterson) - -- fixes for making the jython/win32 combination work, note however: - jython2.5.1/win32 does not provide a command line launcher, see - http://bugs.jython.org/issue1491 . See pylib install documentation - for how to work around. - -- fixes for handling of unicode exception values and unprintable objects - -- (issue87) fix unboundlocal error in assertionold code - -- (issue86) improve documentation for looponfailing - -- refine IO capturing: stdin-redirect pseudo-file now has a NOP close() method - -- ship distribute_setup.py version 0.6.10 - -- added links to the new capturelog and coverage plugins - - -Changes between 1.2.1 and 1.2.0 -===================================== - -- refined usage and options for "py.cleanup":: - - py.cleanup # remove "*.pyc" and "*$py.class" (jython) files - py.cleanup -e .swp -e .cache # also remove files with these extensions - py.cleanup -s # remove "build" and "dist" directory next to setup.py files - py.cleanup -d # also remove empty directories - py.cleanup -a # synonym for "-s -d -e 'pip-log.txt'" - py.cleanup -n # dry run, only show what would be removed - -- add a new option "py.test --funcargs" which shows available funcargs - and their help strings (docstrings on their respective factory function) - for a given test path - -- display a short and concise traceback if a funcarg lookup fails - -- early-load "conftest.py" files in non-dot first-level sub directories. - allows to conveniently keep and access test-related options in a ``test`` - subdir and still add command line options. - -- fix issue67: new super-short traceback-printing option: "--tb=line" will print a single line for each failing (python) test indicating its filename, lineno and the failure value - -- fix issue78: always call python-level teardown functions even if the - according setup failed. This includes refinements for calling setup_module/class functions - which will now only be called once instead of the previous behaviour where they'd be called - multiple times if they raise an exception (including a Skipped exception). Any exception - will be re-corded and associated with all tests in the according module/class scope. - -- fix issue63: assume <40 columns to be a bogus terminal width, default to 80 - -- fix pdb debugging to be in the correct frame on raises-related errors - -- update apipkg.py to fix an issue where recursive imports might - unnecessarily break importing - -- fix plugin links - -Changes between 1.2 and 1.1.1 -===================================== - -- moved dist/looponfailing from py.test core into a new - separately released pytest-xdist plugin. - -- new junitxml plugin: --junitxml=path will generate a junit style xml file - which is processable e.g. by the Hudson CI system. - -- new option: --genscript=path will generate a standalone py.test script - which will not need any libraries installed. thanks to Ralf Schmitt. - -- new option: --ignore will prevent specified path from collection. - Can be specified multiple times. - -- new option: --confcutdir=dir will make py.test only consider conftest - files that are relative to the specified dir. - -- new funcarg: "pytestconfig" is the pytest config object for access - to command line args and can now be easily used in a test. - -- install 'py.test' and `py.which` with a ``-$VERSION`` suffix to - disambiguate between Python3, python2.X, Jython and PyPy installed versions. - -- new "pytestconfig" funcarg allows access to test config object - -- new "pytest_report_header" hook can return additional lines - to be displayed at the header of a test run. - -- (experimental) allow "py.test path::name1::name2::..." for pointing - to a test within a test collection directly. This might eventually - evolve as a full substitute to "-k" specifications. - -- streamlined plugin loading: order is now as documented in - customize.html: setuptools, ENV, commandline, conftest. - also setuptools entry point names are turned to canonical namees ("pytest_*") - -- automatically skip tests that need 'capfd' but have no os.dup - -- allow pytest_generate_tests to be defined in classes as well - -- deprecate usage of 'disabled' attribute in favour of pytestmark -- deprecate definition of Directory, Module, Class and Function nodes - in conftest.py files. Use pytest collect hooks instead. - -- collection/item node specific runtest/collect hooks are only called exactly - on matching conftest.py files, i.e. ones which are exactly below - the filesystem path of an item - -- change: the first pytest_collect_directory hook to return something - will now prevent further hooks to be called. - -- change: figleaf plugin now requires --figleaf to run. Also - change its long command line options to be a bit shorter (see py.test -h). - -- change: pytest doctest plugin is now enabled by default and has a - new option --doctest-glob to set a pattern for file matches. - -- change: remove internal py._* helper vars, only keep py._pydir - -- robustify capturing to survive if custom pytest_runtest_setup - code failed and prevented the capturing setup code from running. - -- make py.test.* helpers provided by default plugins visible early - - works transparently both for pydoc and for interactive sessions - which will regularly see e.g. py.test.mark and py.test.importorskip. - -- simplify internal plugin manager machinery -- simplify internal collection tree by introducing a RootCollector node - -- fix assert reinterpreation that sees a call containing "keyword=..." - -- fix issue66: invoke pytest_sessionstart and pytest_sessionfinish - hooks on slaves during dist-testing, report module/session teardown - hooks correctly. - -- fix issue65: properly handle dist-testing if no - execnet/py lib installed remotely. - -- skip some install-tests if no execnet is available - -- fix docs, fix internal bin/ script generation - - -Changes between 1.1.1 and 1.1.0 -===================================== - -- introduce automatic plugin registration via 'pytest11' - entrypoints via setuptools' pkg_resources.iter_entry_points - -- fix py.test dist-testing to work with execnet >= 1.0.0b4 - -- re-introduce py.test.cmdline.main() for better backward compatibility - -- svn paths: fix a bug with path.check(versioned=True) for svn paths, - allow '%' in svn paths, make svnwc.update() default to interactive mode - like in 1.0.x and add svnwc.update(interactive=False) to inhibit interaction. - -- refine distributed tarball to contain test and no pyc files - -- try harder to have deprecation warnings for py.compat.* accesses - report a correct location - -Changes between 1.1.0 and 1.0.2 -===================================== - -* adjust and improve docs - -* remove py.rest tool and internal namespace - it was - never really advertised and can still be used with - the old release if needed. If there is interest - it could be revived into its own tool i guess. - -* fix issue48 and issue59: raise an Error if the module - from an imported test file does not seem to come from - the filepath - avoids "same-name" confusion that has - been reported repeatedly - -* merged Ronny's nose-compatibility hacks: now - nose-style setup_module() and setup() functions are - supported - -* introduce generalized py.test.mark function marking - -* reshuffle / refine command line grouping - -* deprecate parser.addgroup in favour of getgroup which creates option group - -* add --report command line option that allows to control showing of skipped/xfailed sections - -* generalized skipping: a new way to mark python functions with skipif or xfail - at function, class and modules level based on platform or sys-module attributes. - -* extend py.test.mark decorator to allow for positional args - -* introduce and test "py.cleanup -d" to remove empty directories - -* fix issue #59 - robustify unittest test collection - -* make bpython/help interaction work by adding an __all__ attribute - to ApiModule, cleanup initpkg - -* use MIT license for pylib, add some contributors - -* remove py.execnet code and substitute all usages with 'execnet' proper - -* fix issue50 - cached_setup now caches more to expectations - for test functions with multiple arguments. - -* merge Jarko's fixes, issue #45 and #46 - -* add the ability to specify a path for py.lookup to search in - -* fix a funcarg cached_setup bug probably only occuring - in distributed testing and "module" scope with teardown. - -* many fixes and changes for making the code base python3 compatible, - many thanks to Benjamin Peterson for helping with this. - -* consolidate builtins implementation to be compatible with >=2.3, - add helpers to ease keeping 2 and 3k compatible code - -* deprecate py.compat.doctest|subprocess|textwrap|optparse - -* deprecate py.magic.autopath, remove py/magic directory - -* move pytest assertion handling to py/code and a pytest_assertion - plugin, add "--no-assert" option, deprecate py.magic namespaces - in favour of (less) py.code ones. - -* consolidate and cleanup py/code classes and files - -* cleanup py/misc, move tests to bin-for-dist - -* introduce delattr/delitem/delenv methods to py.test's monkeypatch funcarg - -* consolidate py.log implementation, remove old approach. - -* introduce py.io.TextIO and py.io.BytesIO for distinguishing between - text/unicode and byte-streams (uses underlying standard lib io.* - if available) - -* make py.unittest_convert helper script available which converts "unittest.py" - style files into the simpler assert/direct-test-classes py.test/nosetests - style. The script was written by Laura Creighton. - -* simplified internal localpath implementation - -Changes between 1.0.1 and 1.0.2 -===================================== - -* fixing packaging issues, triggered by fedora redhat packaging, - also added doc, examples and contrib dirs to the tarball. - -* added a documentation link to the new django plugin. - -Changes between 1.0.0 and 1.0.1 -===================================== - -* added a 'pytest_nose' plugin which handles nose.SkipTest, - nose-style function/method/generator setup/teardown and - tries to report functions correctly. - -* capturing of unicode writes or encoded strings to sys.stdout/err - work better, also terminalwriting was adapted and somewhat - unified between windows and linux. - -* improved documentation layout and content a lot - -* added a "--help-config" option to show conftest.py / ENV-var names for - all longopt cmdline options, and some special conftest.py variables. - renamed 'conf_capture' conftest setting to 'option_capture' accordingly. - -* fix issue #27: better reporting on non-collectable items given on commandline - (e.g. pyc files) - -* fix issue #33: added --version flag (thanks Benjamin Peterson) - -* fix issue #32: adding support for "incomplete" paths to wcpath.status() - -* "Test" prefixed classes are *not* collected by default anymore if they - have an __init__ method - -* monkeypatch setenv() now accepts a "prepend" parameter - -* improved reporting of collection error tracebacks - -* simplified multicall mechanism and plugin architecture, - renamed some internal methods and argnames - -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. - -* perform setup finalization before reporting failures - -* apply modified patches from Andreas Kloeckner to allow - test functions to have no func_code (#22) and to make - "-k" and function keywords work (#20) - -* apply patch from Daniel Peolzleithner (issue #23) - -* resolve issue #18, multiprocessing.Manager() and - redirection clash - -* make __name__ == "__channelexec__" for remote_exec code - -Changes between 1.0.0b1 and 1.0.0b3 -============================================= - -* plugin classes are removed: one now defines - hooks directly in conftest.py or global pytest_*.py - files. - -* added new pytest_namespace(config) hook that allows - to inject helpers directly to the py.test.* namespace. - -* documented and refined many hooks - -* added new style of generative tests via - pytest_generate_tests hook that integrates - well with function arguments. - - -Changes between 0.9.2 and 1.0.0b1 -============================================= - -* introduced new "funcarg" setup method, - see doc/test/funcarg.txt - -* introduced plugin architecuture and many - new py.test plugins, see - doc/test/plugins.txt - -* teardown_method is now guaranteed to get - called after a test method has run. - -* new method: py.test.importorskip(mod,minversion) - will either import or call py.test.skip() - -* completely revised internal py.test architecture - -* new py.process.ForkedFunc object allowing to - fork execution of a function to a sub process - and getting a result back. - -XXX lots of things missing here XXX - -Changes between 0.9.1 and 0.9.2 -=============================== - -* refined installation and metadata, created new setup.py, - now based on setuptools/ez_setup (thanks to Ralf Schmitt - for his support). - -* improved the way of making py.* scripts available in - windows environments, they are now added to the - Scripts directory as ".cmd" files. - -* py.path.svnwc.status() now is more complete and - uses xml output from the 'svn' command if available - (Guido Wesdorp) - -* fix for py.path.svn* to work with svn 1.5 - (Chris Lamb) - -* fix path.relto(otherpath) method on windows to - use normcase for checking if a path is relative. - -* py.test's traceback is better parseable from editors - (follows the filenames:LINENO: MSG convention) - (thanks to Osmo Salomaa) - -* fix to javascript-generation, "py.test --runbrowser" - should work more reliably now - -* removed previously accidentally added - py.test.broken and py.test.notimplemented helpers. - -* there now is a py.__version__ attribute - -Changes between 0.9.0 and 0.9.1 -=============================== - -This is a fairly complete list of changes between 0.9 and 0.9.1, which can -serve as a reference for developers. - -* allowing + signs in py.path.svn urls [39106] -* fixed support for Failed exceptions without excinfo in py.test [39340] -* added support for killing processes for Windows (as well as platforms that - support os.kill) in py.misc.killproc [39655] -* added setup/teardown for generative tests to py.test [40702] -* added detection of FAILED TO LOAD MODULE to py.test [40703, 40738, 40739] -* fixed problem with calling .remove() on wcpaths of non-versioned files in - py.path [44248] -* fixed some import and inheritance issues in py.test [41480, 44648, 44655] -* fail to run greenlet tests when pypy is available, but without stackless - [45294] -* small fixes in rsession tests [45295] -* fixed issue with 2.5 type representations in py.test [45483, 45484] -* made that internal reporting issues displaying is done atomically in py.test - [45518] -* made that non-existing files are igored by the py.lookup script [45519] -* improved exception name creation in py.test [45535] -* made that less threads are used in execnet [merge in 45539] -* removed lock required for atomical reporting issue displaying in py.test - [45545] -* removed globals from execnet [45541, 45547] -* refactored cleanup mechanics, made that setDaemon is set to 1 to make atexit - get called in 2.5 (py.execnet) [45548] -* fixed bug in joining threads in py.execnet's servemain [45549] -* refactored py.test.rsession tests to not rely on exact output format anymore - [45646] -* using repr() on test outcome [45647] -* added 'Reason' classes for py.test.skip() [45648, 45649] -* killed some unnecessary sanity check in py.test.collect [45655] -* avoid using os.tmpfile() in py.io.fdcapture because on Windows it's only - usable by Administrators [45901] -* added support for locking and non-recursive commits to py.path.svnwc [45994] -* locking files in py.execnet to prevent CPython from segfaulting [46010] -* added export() method to py.path.svnurl -* fixed -d -x in py.test [47277] -* fixed argument concatenation problem in py.path.svnwc [49423] -* restore py.test behaviour that it exits with code 1 when there are failures - [49974] -* don't fail on html files that don't have an accompanying .txt file [50606] -* fixed 'utestconvert.py < input' [50645] -* small fix for code indentation in py.code.source [50755] -* fix _docgen.py documentation building [51285] -* improved checks for source representation of code blocks in py.test [51292] -* added support for passing authentication to py.path.svn* objects [52000, - 52001] -* removed sorted() call for py.apigen tests in favour of [].sort() to support - Python 2.3 [52481] --- a/doc/builtin.txt +++ b/doc/builtin.txt @@ -21,7 +21,7 @@ builtin function arguments ----------------------------------------------------- You can ask for available builtin or project-custom -:ref:`function arguments` by typing:: +:ref:`function arguments ` by typing:: $ py.test --funcargs pytestconfig --- a/doc/xdist.txt +++ b/doc/xdist.txt @@ -1,3 +1,6 @@ + +.. _`xdist`: + xdist: pytest distributed testing plugin =============================================================== @@ -38,9 +41,12 @@ a checkout of the `pytest-xdist reposito python setup.py develop + Usage examples --------------------- +.. _`xdistcpu`: + Speed up test runs by sending tests to multiple CPUs +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @@ -69,6 +75,24 @@ If you prefix the --tx option value like then three subprocesses would be created and tests will be load-balanced across these three processes. +.. _looponfailing: + + +Running tests in looponfailing mode ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +For refactoring a project with a medium or large test suite +you can use the looponfailing mode, simply add the ``--f`` option:: + + py.test -f + +and py.test will run your tests, then wait for file changes and re-run the failing test set. Of course you can pass in more options to select tests or test files. File changes are detected by looking at the root directory - you can override this automatic default by an ini-file setting:: + + # content of a pytest.ini, setup.cfg or tox.ini file + [pytest] + looponfailroots = mypkg testdir + +This would lead to only looking for file changes in the respective directories, specified relatively to the ini-file's directory. Sending tests to remote SSH accounts +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --- a/doc/skipping.txt +++ b/doc/skipping.txt @@ -1,3 +1,5 @@ + +.. _`skip and xfail`: skip and xfail mechanisms ===================================================================== @@ -5,9 +7,9 @@ skip and xfail mechanisms You can skip or "xfail" test functions, either by marking functions through a decorator or by calling the ``pytest.skip|xfail`` helpers. A *skip* means that you expect your test to pass unless a certain configuration or condition (e.g. wrong Python interpreter, missing dependency) prevents it to run. And *xfail* means that you expect your test to fail because there is an -implementation problem. Counting and listing *xfailing* tests separately -helps to maintain a list of implementation problems and you can provide -info such as a bug number or a URL to provide a human readable problem context. +implementation problem. py.test counts and lists *xfailing* tests separately +and you can provide info such as a bug number or a URL to provide a +human readable problem context. Usually detailed information about skipped/xfailed tests is not shown to avoid cluttering the output. You can use the ``-r`` option to @@ -16,6 +18,8 @@ test progress:: py.test -rxs # show extra info on skips and xfail tests +(See :ref:`how to change command line options defaults`) + .. _skipif: Skipping a single function --- a/doc/announce/release-0.9.2.txt +++ /dev/null @@ -1,27 +0,0 @@ -py lib 0.9.2: bugfix release -============================= - -Welcome to the 0.9.2 py lib and py.test release - -mainly fixing Windows issues, providing better -packaging and integration with setuptools. - -Here is a quick summary of what the py lib provides: - -* py.test: cross-project testing tool with many advanced features -* py.execnet: ad-hoc code distribution to SSH, Socket and local sub processes -* py.magic.greenlet: micro-threads on standard CPython ("stackless-light") -* py.path: path abstractions over local and subversion files -* rich documentation of py's exported API -* tested against Linux, Win32, OSX, works on python 2.3-2.6 - -See here for more information: - -Pypi pages: http://pypi.python.org/pypi/py/ - -Download/Install: http://codespeak.net/py/0.9.2/download.html - -Documentation/API: http://codespeak.net/py/0.9.2/index.html - -best and have fun, - -holger krekel --- a/doc/assert.txt +++ b/doc/assert.txt @@ -2,6 +2,8 @@ Writing and reporting of assertions in tests ============================================ +.. _`assert with the assert statement`: + assert with the ``assert`` statement --------------------------------------------------------- --- /dev/null +++ b/doc/contents.txt @@ -0,0 +1,33 @@ + +.. _toc: + +Table of Contents +======================== + +.. note:: + version 2.0 introduces :ref:`pytest as the main Python import name ` + +.. toctree:: + :maxdepth: 2 + + overview + apiref + plugins + example/index + talks + develop + announce/index + +.. toctree:: + :hidden: + + changelog.txt + naming20.txt + example/attic + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` --- a/doc/announce/index.txt +++ b/doc/announce/index.txt @@ -7,20 +7,3 @@ Release announcements release-2.0.0 -.. toctree:: - :hidden: - - release-1.3.4 - release-1.3.3 - release-1.3.2 - release-1.3.1 - release-1.3.0 - release-1.2.1 - release-1.2.0 - release-1.1.1 - release-1.1.0 - release-1.0.2 - release-1.0.1 - release-1.0.0 - release-0.9.2 - release-0.9.0 --- a/doc/conf.py +++ b/doc/conf.py @@ -140,6 +140,8 @@ html_sidebars = {'index': 'indexsidebar. # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} +#html_additional_pages = {'index': 'index.html'} + # If false, no module index is generated. #html_domain_indices = True --- a/doc/announce/release-1.3.0.txt +++ /dev/null @@ -1,580 +0,0 @@ -py.test/pylib 1.3.0: new options, per-plugin hooks, fixes ... -=========================================================================== - -The 1.3.0 release introduces new options, bug fixes and improved compatibility -with Python3 and Jython-2.5.1 on Windows. If you already use py-1.2 chances -are you can use py-1.3.0. See the below CHANGELOG for more details and -http://pylib.org/install.html for installation instructions. - -py.test is an advanced automated testing tool working with Python2, -Python3, Jython and PyPy versions on all major operating systems. It -offers a no-boilerplate testing approach and has inspired other testing -tools and enhancements in the standard Python library for more than five -years. It has a simple and extensive plugin architecture, configurable -reporting and provides unique ways to make it fit to your testing -process and needs. - -See http://pytest.org for more info. - -cheers and have fun, - -holger krekel - -Changes between 1.2.1 and 1.3.0 -================================================== - -- deprecate --report option in favour of a new shorter and easier to - remember -r option: it takes a string argument consisting of any - combination of 'xfsX' characters. They relate to the single chars - you see during the dotted progress printing and will print an extra line - per test at the end of the test run. This extra line indicates the exact - position or test ID that you directly paste to the py.test cmdline in order - to re-run a particular test. - -- allow external plugins to register new hooks via the new - pytest_addhooks(pluginmanager) hook. The new release of - the pytest-xdist plugin for distributed and looponfailing - testing requires this feature. - -- add a new pytest_ignore_collect(path, config) hook to allow projects and - plugins to define exclusion behaviour for their directory structure - - for example you may define in a conftest.py this method:: - - def pytest_ignore_collect(path): - return path.check(link=1) - - to prevent even collection of any tests in symlinked dirs. - -- new pytest_pycollect_makemodule(path, parent) hook for - allowing customization of the Module collection object for a - matching test module. - -- extend and refine xfail mechanism:: - - @py.test.mark.xfail(run=False) do not run the decorated test - @py.test.mark.xfail(reason="...") prints the reason string in xfail summaries - - specifiying ``--runxfail`` on command line ignores xfail markers to show - you the underlying traceback. - -- expose (previously internal) commonly useful methods: - py.io.get_terminal_with() -> return terminal width - py.io.ansi_print(...) -> print colored/bold text on linux/win32 - py.io.saferepr(obj) -> return limited representation string - -- expose test outcome related exceptions as py.test.skip.Exception, - py.test.raises.Exception etc., useful mostly for plugins - doing special outcome interpretation/tweaking - -- (issue85) fix junitxml plugin to handle tests with non-ascii output - -- fix/refine python3 compatibility (thanks Benjamin Peterson) - -- fixes for making the jython/win32 combination work, note however: - jython2.5.1/win32 does not provide a command line launcher, see - http://bugs.jython.org/issue1491 . See pylib install documentation - for how to work around. - -- fixes for handling of unicode exception values and unprintable objects - -- (issue87) fix unboundlocal error in assertionold code - -- (issue86) improve documentation for looponfailing - -- refine IO capturing: stdin-redirect pseudo-file now has a NOP close() method - -- ship distribute_setup.py version 0.6.10 - -- added links to the new capturelog and coverage plugins - - -Changes between 1.2.1 and 1.2.0 -===================================== - -- refined usage and options for "py.cleanup":: - - py.cleanup # remove "*.pyc" and "*$py.class" (jython) files - py.cleanup -e .swp -e .cache # also remove files with these extensions - py.cleanup -s # remove "build" and "dist" directory next to setup.py files - py.cleanup -d # also remove empty directories - py.cleanup -a # synonym for "-s -d -e 'pip-log.txt'" - py.cleanup -n # dry run, only show what would be removed - -- add a new option "py.test --funcargs" which shows available funcargs - and their help strings (docstrings on their respective factory function) - for a given test path - -- display a short and concise traceback if a funcarg lookup fails - -- early-load "conftest.py" files in non-dot first-level sub directories. - allows to conveniently keep and access test-related options in a ``test`` - subdir and still add command line options. - -- fix issue67: new super-short traceback-printing option: "--tb=line" will print a single line for each failing (python) test indicating its filename, lineno and the failure value - -- fix issue78: always call python-level teardown functions even if the - according setup failed. This includes refinements for calling setup_module/class functions - which will now only be called once instead of the previous behaviour where they'd be called - multiple times if they raise an exception (including a Skipped exception). Any exception - will be re-corded and associated with all tests in the according module/class scope. - -- fix issue63: assume <40 columns to be a bogus terminal width, default to 80 - -- fix pdb debugging to be in the correct frame on raises-related errors - -- update apipkg.py to fix an issue where recursive imports might - unnecessarily break importing - -- fix plugin links - -Changes between 1.2 and 1.1.1 -===================================== - -- moved dist/looponfailing from py.test core into a new - separately released pytest-xdist plugin. - -- new junitxml plugin: --junitxml=path will generate a junit style xml file - which is processable e.g. by the Hudson CI system. - -- new option: --genscript=path will generate a standalone py.test script - which will not need any libraries installed. thanks to Ralf Schmitt. - -- new option: --ignore will prevent specified path from collection. - Can be specified multiple times. - -- new option: --confcutdir=dir will make py.test only consider conftest - files that are relative to the specified dir. - -- new funcarg: "pytestconfig" is the pytest config object for access - to command line args and can now be easily used in a test. - -- install 'py.test' and `py.which` with a ``-$VERSION`` suffix to - disambiguate between Python3, python2.X, Jython and PyPy installed versions. - -- new "pytestconfig" funcarg allows access to test config object - -- new "pytest_report_header" hook can return additional lines - to be displayed at the header of a test run. - -- (experimental) allow "py.test path::name1::name2::..." for pointing - to a test within a test collection directly. This might eventually - evolve as a full substitute to "-k" specifications. - -- streamlined plugin loading: order is now as documented in - customize.html: setuptools, ENV, commandline, conftest. - also setuptools entry point names are turned to canonical namees ("pytest_*") - -- automatically skip tests that need 'capfd' but have no os.dup - -- allow pytest_generate_tests to be defined in classes as well - -- deprecate usage of 'disabled' attribute in favour of pytestmark -- deprecate definition of Directory, Module, Class and Function nodes - in conftest.py files. Use pytest collect hooks instead. - -- collection/item node specific runtest/collect hooks are only called exactly - on matching conftest.py files, i.e. ones which are exactly below - the filesystem path of an item - -- change: the first pytest_collect_directory hook to return something - will now prevent further hooks to be called. - -- change: figleaf plugin now requires --figleaf to run. Also - change its long command line options to be a bit shorter (see py.test -h). - -- change: pytest doctest plugin is now enabled by default and has a - new option --doctest-glob to set a pattern for file matches. - -- change: remove internal py._* helper vars, only keep py._pydir - -- robustify capturing to survive if custom pytest_runtest_setup - code failed and prevented the capturing setup code from running. - -- make py.test.* helpers provided by default plugins visible early - - works transparently both for pydoc and for interactive sessions - which will regularly see e.g. py.test.mark and py.test.importorskip. - -- simplify internal plugin manager machinery -- simplify internal collection tree by introducing a RootCollector node - -- fix assert reinterpreation that sees a call containing "keyword=..." - -- fix issue66: invoke pytest_sessionstart and pytest_sessionfinish - hooks on slaves during dist-testing, report module/session teardown - hooks correctly. - -- fix issue65: properly handle dist-testing if no - execnet/py lib installed remotely. - -- skip some install-tests if no execnet is available - -- fix docs, fix internal bin/ script generation - - -Changes between 1.1.1 and 1.1.0 -===================================== - -- introduce automatic plugin registration via 'pytest11' - entrypoints via setuptools' pkg_resources.iter_entry_points - -- fix py.test dist-testing to work with execnet >= 1.0.0b4 - -- re-introduce py.test.cmdline.main() for better backward compatibility - -- svn paths: fix a bug with path.check(versioned=True) for svn paths, - allow '%' in svn paths, make svnwc.update() default to interactive mode - like in 1.0.x and add svnwc.update(interactive=False) to inhibit interaction. - -- refine distributed tarball to contain test and no pyc files - -- try harder to have deprecation warnings for py.compat.* accesses - report a correct location - -Changes between 1.1.0 and 1.0.2 -===================================== - -* adjust and improve docs - -* remove py.rest tool and internal namespace - it was - never really advertised and can still be used with - the old release if needed. If there is interest - it could be revived into its own tool i guess. - -* fix issue48 and issue59: raise an Error if the module - from an imported test file does not seem to come from - the filepath - avoids "same-name" confusion that has - been reported repeatedly - -* merged Ronny's nose-compatibility hacks: now - nose-style setup_module() and setup() functions are - supported - -* introduce generalized py.test.mark function marking - -* reshuffle / refine command line grouping - -* deprecate parser.addgroup in favour of getgroup which creates option group - -* add --report command line option that allows to control showing of skipped/xfailed sections - -* generalized skipping: a new way to mark python functions with skipif or xfail - at function, class and modules level based on platform or sys-module attributes. - -* extend py.test.mark decorator to allow for positional args - -* introduce and test "py.cleanup -d" to remove empty directories - -* fix issue #59 - robustify unittest test collection - -* make bpython/help interaction work by adding an __all__ attribute - to ApiModule, cleanup initpkg - -* use MIT license for pylib, add some contributors - -* remove py.execnet code and substitute all usages with 'execnet' proper - -* fix issue50 - cached_setup now caches more to expectations - for test functions with multiple arguments. - -* merge Jarko's fixes, issue #45 and #46 - -* add the ability to specify a path for py.lookup to search in - -* fix a funcarg cached_setup bug probably only occuring - in distributed testing and "module" scope with teardown. - -* many fixes and changes for making the code base python3 compatible, - many thanks to Benjamin Peterson for helping with this. - -* consolidate builtins implementation to be compatible with >=2.3, - add helpers to ease keeping 2 and 3k compatible code - -* deprecate py.compat.doctest|subprocess|textwrap|optparse - -* deprecate py.magic.autopath, remove py/magic directory - -* move pytest assertion handling to py/code and a pytest_assertion - plugin, add "--no-assert" option, deprecate py.magic namespaces - in favour of (less) py.code ones. - -* consolidate and cleanup py/code classes and files - -* cleanup py/misc, move tests to bin-for-dist - -* introduce delattr/delitem/delenv methods to py.test's monkeypatch funcarg - -* consolidate py.log implementation, remove old approach. - -* introduce py.io.TextIO and py.io.BytesIO for distinguishing between - text/unicode and byte-streams (uses underlying standard lib io.* - if available) - -* make py.unittest_convert helper script available which converts "unittest.py" - style files into the simpler assert/direct-test-classes py.test/nosetests - style. The script was written by Laura Creighton. - -* simplified internal localpath implementation - -Changes between 1.0.1 and 1.0.2 -===================================== - -* fixing packaging issues, triggered by fedora redhat packaging, - also added doc, examples and contrib dirs to the tarball. - -* added a documentation link to the new django plugin. - -Changes between 1.0.0 and 1.0.1 -===================================== - -* added a 'pytest_nose' plugin which handles nose.SkipTest, - nose-style function/method/generator setup/teardown and - tries to report functions correctly. - -* capturing of unicode writes or encoded strings to sys.stdout/err - work better, also terminalwriting was adapted and somewhat - unified between windows and linux. - -* improved documentation layout and content a lot - -* added a "--help-config" option to show conftest.py / ENV-var names for - all longopt cmdline options, and some special conftest.py variables. - renamed 'conf_capture' conftest setting to 'option_capture' accordingly. - -* fix issue #27: better reporting on non-collectable items given on commandline - (e.g. pyc files) - -* fix issue #33: added --version flag (thanks Benjamin Peterson) - -* fix issue #32: adding support for "incomplete" paths to wcpath.status() - -* "Test" prefixed classes are *not* collected by default anymore if they - have an __init__ method - -* monkeypatch setenv() now accepts a "prepend" parameter - -* improved reporting of collection error tracebacks - -* simplified multicall mechanism and plugin architecture, - renamed some internal methods and argnames - -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. - -* perform setup finalization before reporting failures - -* apply modified patches from Andreas Kloeckner to allow - test functions to have no func_code (#22) and to make - "-k" and function keywords work (#20) - -* apply patch from Daniel Peolzleithner (issue #23) - -* resolve issue #18, multiprocessing.Manager() and - redirection clash - -* make __name__ == "__channelexec__" for remote_exec code - -Changes between 1.0.0b1 and 1.0.0b3 -============================================= - -* plugin classes are removed: one now defines - hooks directly in conftest.py or global pytest_*.py - files. - -* added new pytest_namespace(config) hook that allows - to inject helpers directly to the py.test.* namespace. - -* documented and refined many hooks - -* added new style of generative tests via - pytest_generate_tests hook that integrates - well with function arguments. - - -Changes between 0.9.2 and 1.0.0b1 -============================================= - -* introduced new "funcarg" setup method, - see doc/test/funcarg.txt - -* introduced plugin architecuture and many - new py.test plugins, see - doc/test/plugins.txt - -* teardown_method is now guaranteed to get - called after a test method has run. - -* new method: py.test.importorskip(mod,minversion) - will either import or call py.test.skip() - -* completely revised internal py.test architecture - -* new py.process.ForkedFunc object allowing to - fork execution of a function to a sub process - and getting a result back. - -XXX lots of things missing here XXX - -Changes between 0.9.1 and 0.9.2 -=============================== - -* refined installation and metadata, created new setup.py, - now based on setuptools/ez_setup (thanks to Ralf Schmitt - for his support). - -* improved the way of making py.* scripts available in - windows environments, they are now added to the - Scripts directory as ".cmd" files. - -* py.path.svnwc.status() now is more complete and - uses xml output from the 'svn' command if available - (Guido Wesdorp) - -* fix for py.path.svn* to work with svn 1.5 - (Chris Lamb) - -* fix path.relto(otherpath) method on windows to - use normcase for checking if a path is relative. - -* py.test's traceback is better parseable from editors - (follows the filenames:LINENO: MSG convention) - (thanks to Osmo Salomaa) - -* fix to javascript-generation, "py.test --runbrowser" - should work more reliably now - -* removed previously accidentally added - py.test.broken and py.test.notimplemented helpers. - -* there now is a py.__version__ attribute - -Changes between 0.9.0 and 0.9.1 -=============================== - -This is a fairly complete list of changes between 0.9 and 0.9.1, which can -serve as a reference for developers. - -* allowing + signs in py.path.svn urls [39106] -* fixed support for Failed exceptions without excinfo in py.test [39340] -* added support for killing processes for Windows (as well as platforms that - support os.kill) in py.misc.killproc [39655] -* added setup/teardown for generative tests to py.test [40702] -* added detection of FAILED TO LOAD MODULE to py.test [40703, 40738, 40739] -* fixed problem with calling .remove() on wcpaths of non-versioned files in - py.path [44248] -* fixed some import and inheritance issues in py.test [41480, 44648, 44655] -* fail to run greenlet tests when pypy is available, but without stackless - [45294] -* small fixes in rsession tests [45295] -* fixed issue with 2.5 type representations in py.test [45483, 45484] -* made that internal reporting issues displaying is done atomically in py.test - [45518] -* made that non-existing files are igored by the py.lookup script [45519] -* improved exception name creation in py.test [45535] -* made that less threads are used in execnet [merge in 45539] -* removed lock required for atomical reporting issue displaying in py.test - [45545] -* removed globals from execnet [45541, 45547] -* refactored cleanup mechanics, made that setDaemon is set to 1 to make atexit - get called in 2.5 (py.execnet) [45548] -* fixed bug in joining threads in py.execnet's servemain [45549] -* refactored py.test.rsession tests to not rely on exact output format anymore - [45646] -* using repr() on test outcome [45647] -* added 'Reason' classes for py.test.skip() [45648, 45649] -* killed some unnecessary sanity check in py.test.collect [45655] -* avoid using os.tmpfile() in py.io.fdcapture because on Windows it's only - usable by Administrators [45901] -* added support for locking and non-recursive commits to py.path.svnwc [45994] -* locking files in py.execnet to prevent CPython from segfaulting [46010] -* added export() method to py.path.svnurl -* fixed -d -x in py.test [47277] -* fixed argument concatenation problem in py.path.svnwc [49423] -* restore py.test behaviour that it exits with code 1 when there are failures - [49974] -* don't fail on html files that don't have an accompanying .txt file [50606] -* fixed 'utestconvert.py < input' [50645] -* small fix for code indentation in py.code.source [50755] -* fix _docgen.py documentation building [51285] -* improved checks for source representation of code blocks in py.test [51292] -* added support for passing authentication to py.path.svn* objects [52000, - 52001] -* removed sorted() call for py.apigen tests in favour of [].sort() to support - Python 2.3 [52481] --- a/doc/announce/release-1.1.1.txt +++ /dev/null @@ -1,48 +0,0 @@ -py.test/pylib 1.1.1: bugfix release, setuptools plugin registration --------------------------------------------------------------------------------- - -This is a compatibility fixing release of pylib/py.test to work -better with previous 1.0.x test code bases. It also contains fixes -and changes to work with `execnet>=1.0.0`_ to provide distributed -testing and looponfailing testing modes. py-1.1.1 also introduces -a new mechanism for registering plugins via setuptools. - -What is pylib/py.test? ------------------------ - -py.test is an advanced automated testing tool working with -Python2, Python3 and Jython versions on all major operating -systems. It has an extensive plugin architecture and can run many -existing common Python test suites without modification. Moreover, -it offers some unique features not found in other -testing tools. See http://pytest.org for more info. - -The pylib also contains a localpath and svnpath implementation -and some developer-oriented command line tools. See -http://pylib.org for more info. - -thanks to all who helped and gave feedback, -have fun, - -holger (http://twitter.com/hpk42) - -.. _`execnet>=1.0.0`: http://codespeak.net/execnet - -Changes between 1.1.1 and 1.1.0 -===================================== - -- introduce automatic plugin registration via 'pytest11' - entrypoints via setuptools' pkg_resources.iter_entry_points - -- fix py.test dist-testing to work with execnet >= 1.0.0b4 - -- re-introduce py.test.cmdline.main() for better backward compatibility - -- svn paths: fix a bug with path.check(versioned=True) for svn paths, - allow '%' in svn paths, make svnwc.update() default to interactive mode - like in 1.0.x and add svnwc.update(interactive=False) to inhibit interaction. - -- refine distributed tarball to contain test and no pyc files - -- try harder to have deprecation warnings for py.compat.* accesses - report a correct location From commits-noreply at bitbucket.org Thu Nov 25 14:46:36 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 07:46:36 -0600 (CST) Subject: [py-svn] py commit 8d9ddabb8c3f: fix assertion source finding raising some more Message-ID: <20101125134636.CC6BF1E12AF@bitbucket02.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project py # URL http://bitbucket.org/hpk42/py/overview # User holger krekel # Date 1290692265 -3600 # Node ID 8d9ddabb8c3f60367341ce56344d60b9685a9013 # Parent ceb0875f32dcd662c4ca8991b7bb6a4363bcb4ee fix assertion source finding raising some more --- a/setup.py +++ b/setup.py @@ -9,7 +9,7 @@ def main(): name='py', description='library with cross-python path, ini-parsing, io, code, log facilities', long_description = open('README.txt').read(), - version='1.4.0a3', + version='1.4.0a5', url='http://pylib.org', license='MIT license', platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'], --- a/testing/code/test_assertion.py +++ b/testing/code/test_assertion.py @@ -273,3 +273,32 @@ def test_assert_long_source_2(): s = str(e) assert 're-run' not in s assert 'somet text' in s + +def test_assert_raise_alias(testdir): + testdir.makepyfile(""" + import sys + EX = AssertionError + def test_hello(): + raise EX("hello" + "multi" + "line") + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*def test_hello*", + "*raise EX*", + "*1 failed*", + ]) + + +def test_assert_raise_subclass(): + class SomeEx(AssertionError): + def __init__(self, *args): + super(SomeEx, self).__init__() + try: + raise SomeEx("hello") + except AssertionError: + s = str(exvalue()) + assert 're-run' not in s + assert 'could not determine' in s + --- a/py/_code/assertion.py +++ b/py/_code/assertion.py @@ -65,18 +65,22 @@ class AssertionError(BuiltinAssertionErr try: source = f.code.fullsource if source is not None: - source = source.getstatement(f.lineno, assertion=True) - source = str(source.deindent()).strip() + try: + source = source.getstatement(f.lineno, assertion=True) + except IndexError: + source = None + else: + source = str(source.deindent()).strip() except py.error.ENOENT: source = None # this can also occur during reinterpretation, when the # co_filename is set to "". if source: self.msg = reinterpret(source, f, should_fail=True) - if not self.args: - self.args = (self.msg,) else: - self.msg = None + self.msg = "" + if not self.args: + self.args = (self.msg,) if sys.version_info > (3, 0): AssertionError.__module__ = "builtins" --- a/py/_code/source.py +++ b/py/_code/source.py @@ -118,9 +118,12 @@ class Source(object): from codeop import compile_command for start in range(lineno, -1, -1): if assertion: - if "assert" not in self.lines[start]: + line = self.lines[start] + # the following lines are not fully tested, change with care + if 'super' in line and 'self' in line and '__init__' in line: + raise IndexError("likely a subclass") + if "assert" not in line and "raise" not in line: continue - trylines = self.lines[start:lineno+1] # quick hack to indent the source and get it as a string in one go trylines.insert(0, 'def xxx():') --- a/py/__init__.py +++ b/py/__init__.py @@ -8,7 +8,7 @@ dictionary or an import path. (c) Holger Krekel and others, 2004-2010 """ -__version__ = '1.4.0a3' +__version__ = '1.4.0a5' from py import _apipkg From commits-noreply at bitbucket.org Thu Nov 25 15:55:53 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 08:55:53 -0600 (CST) Subject: [py-svn] pytest commit 64fe9da75233: adding anto's projects Message-ID: <20101125145553.A24B56C1313@bitbucket03.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest # URL http://bitbucket.org/hpk42/pytest/overview # User holger krekel # Date 1290686401 -3600 # Node ID 64fe9da752332c8b36afdbc439e1cf693aa54393 # Parent 8ee073e2945d44af241148a947144965fcbbcda7 adding anto's projects --- a/doc/projects.txt +++ b/doc/projects.txt @@ -1,6 +1,6 @@ .. _projects: -Project Examples +Project examples ========================== Here are some examples of projects using py.test: @@ -11,6 +11,7 @@ Here are some examples of projects using * `PIDA `_ framework for integrated development * `Fom `_ a fluid object mapper for FluidDB * `six `_ Python 2 and 3 compatibility utilities +* `pdb++ `_ a fancier version of PDB * `The Translate Toolkit `_ for localization and conversion * `execnet `_ rapid multi-Python deployment * `py-s3fuse `_ Amazon S3 FUSE based filesystem @@ -20,6 +21,7 @@ Here are some examples of projects using * `pydataportability `_ libraries for managing the open web * `XIST `_ extensible HTML/XML generator * `tiddlyweb `_ optionally headless, extensible RESTful datastore +* `fancycompleter `_ for colorful tab-completion * `Paludis `_ tools for Gentoo Paludis package manager * `Gerald `_ schema comparison tool * `abjad `_ Python API for Formalized Score control @@ -28,8 +30,8 @@ Here are some examples of projects using * `kss plugin timer `_ * many more ... (please send notes via the :ref:`contact`) -Some examples of organisations using py.test ----------------------------------------------- +Some organisations using py.test +----------------------------------- * `Square Kilometre Array `_ * `Tandberg `_ --- a/doc/_templates/indexsidebar.html +++ b/doc/_templates/indexsidebar.html @@ -7,8 +7,8 @@ released versions in the Python Package Index.

{% else %} -

Current: {{ version }} -[Changes]

{{ version }} release +[Changelog]

pytest on PyPI

--- a/doc/assert.txt +++ b/doc/assert.txt @@ -130,6 +130,8 @@ Special comparisons are done for a numbe * comparing long sequences: first failing indices * comparing dicts: different entries +See the :ref:`reporting demo ` for examples. + .. Defining your own comparison ---------------------------------------------- From commits-noreply at bitbucket.org Thu Nov 25 15:55:53 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 08:55:53 -0600 (CST) Subject: [py-svn] pytest commit 8ee073e2945d: fix some more trial/unittest related bits, particularly allow todo/skip items, Message-ID: <20101125145553.925356C1070@bitbucket03.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest # URL http://bitbucket.org/hpk42/pytest/overview # User holger krekel # Date 1290696539 -3600 # Node ID 8ee073e2945d44af241148a947144965fcbbcda7 # Parent 4853ee1ad7d54469c45e9158b05d8320df0669b0 fix some more trial/unittest related bits, particularly allow todo/skip items, now we can run a large fraction of twisted's own test suite, mostly not those that depend on the exact Failure() semantics (e.g. frame objects not being around after gc.collect() but py.test kills them only slightly later anyway) --- a/_pytest/unittest.py +++ b/_pytest/unittest.py @@ -37,6 +37,12 @@ class UnitTestCase(pytest.Class): class TestCaseFunction(pytest.Function): _excinfo = None + def __init__(self, name, parent): + super(TestCaseFunction, self).__init__(name, parent) + if hasattr(self._obj, 'todo'): + getattr(self._obj, 'im_func', self._obj).xfail = \ + pytest.mark.xfail(reason=str(self._obj.todo)) + def setup(self): self._testcase = self.parent.obj(self.name) self._obj = getattr(self._testcase, self.name) @@ -77,6 +83,18 @@ class TestCaseFunction(pytest.Function): self._addexcinfo(rawexcinfo) def addFailure(self, testcase, rawexcinfo): self._addexcinfo(rawexcinfo) + def addSkip(self, testcase, reason): + try: + pytest.skip(reason) + except pytest.skip.Exception: + self._addexcinfo(sys.exc_info()) + def addExpectedFailure(self, testcase, rawexcinfo, reason): + try: + pytest.xfail(str(reason)) + except pytest.xfail.Exception: + self._addexcinfo(sys.exc_info()) + def addUnexpectedSuccess(self, testcase, reason): + pass def addSuccess(self, testcase): pass def stopTest(self, testcase): --- a/testing/test_unittest.py +++ b/testing/test_unittest.py @@ -251,6 +251,17 @@ class TestTrialUnittest: assert 0 def test_hello4(self): pytest.xfail("i2wanto") + def test_trial_skip(self): + pass + test_trial_skip.skip = "trialselfskip" + + def test_trial_todo(self): + assert 0 + test_trial_todo.todo = "mytodo" + + def test_trial_todo_success(self): + pass + test_trial_todo_success.todo = "mytodo" class TC2(unittest.TestCase): def setup_class(cls): @@ -261,15 +272,16 @@ class TestTrialUnittest: result = testdir.runpytest("-rxs") assert result.ret == 0 result.stdout.fnmatch_lines_random([ + "*XFAIL*test_trial_todo*", + "*trialselfskip*", "*skip_in_setup_class*", "*iwanto*", "*i2wanto*", "*sys.version_info*", "*skip_in_method*", - "*3 skipped*2 xfail*", + "*4 skipped*3 xfail*1 xpass*", ]) - @pytest.mark.xfail(reason="fijal needs add checks") def test_trial_error(self, testdir): testdir.makepyfile(""" from twisted.trial.unittest import TestCase @@ -307,7 +319,18 @@ class TestTrialUnittest: # will crash both at test time and at teardown """) result = testdir.runpytest() - assert 0 + result.stdout.fnmatch_lines([ + "*ERRORS*", + "*DelayedCalls*", + "*test_four*", + "*NameError*crash*", + "*test_one*", + "*NameError*crash*", + "*test_three*", + "*DelayedCalls*", + "*test_two*", + "*crash*", + ]) def test_trial_pdb(self, testdir): p = testdir.makepyfile(""" From commits-noreply at bitbucket.org Thu Nov 25 16:36:39 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 09:36:39 -0600 (CST) Subject: [py-svn] pytest commit 83cd00f43c89: some small pre-release updates Message-ID: <20101125153639.496326C1064@bitbucket03.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest # URL http://bitbucket.org/hpk42/pytest/overview # User holger krekel # Date 1290699385 -3600 # Node ID 83cd00f43c899b8754faccf03dd3fafd33992729 # Parent 64fe9da752332c8b36afdbc439e1cf693aa54393 some small pre-release updates --- a/pytest.py +++ b/pytest.py @@ -1,7 +1,7 @@ """ unit and functional testing with Python. """ -__version__ = '2.0.0.dev39' +__version__ = '2.0.0.dev42' __all__ = ['main'] from _pytest.core import main, UsageError, _preloadplugins --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ def main(): name='pytest', description='py.test: simple powerful testing with Python', long_description = long_description, - version='2.0.0.dev39', + version='2.0.0.dev42', url='http://pytest.org', license='MIT license', platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'], --- a/MANIFEST.in +++ b/MANIFEST.in @@ -3,17 +3,5 @@ include README.txt include setup.py include distribute_setup.py include LICENSE -#include conftest.py graft doc graft testing -exclude doc/_build -include testing -#exclude *.orig -#exclude *.orig -exclude *.rej -exclude .hgignore -exclude *.pyc -#recursive-exclude testing *.pyc *.orig *.rej *$py.class -#prune .pyc -#prune .svn -#prune .hg --- a/doc/projects.txt +++ b/doc/projects.txt @@ -11,11 +11,14 @@ Here are some examples of projects using * `PIDA `_ framework for integrated development * `Fom `_ a fluid object mapper for FluidDB * `six `_ Python 2 and 3 compatibility utilities -* `pdb++ `_ a fancier version of PDB +* `pediapress `_ MediaWiki articles +* `mwlib `_ mediawiki parser and utility library * `The Translate Toolkit `_ for localization and conversion * `execnet `_ rapid multi-Python deployment +* `bbfreeze `_ create standalone executables from Python scripts +* `pdb++ `_ a fancier version of PDB * `py-s3fuse `_ Amazon S3 FUSE based filesystem -* `Circuits `_ lightweight Event Driven Framework +* `Circuits `_ lightweight Event Driven Framework * `pygtk-helpers `_ easy interaction with PyGTK * `QuantumCore `_ statusmessage and repoze openid plugin * `pydataportability `_ libraries for managing the open web @@ -39,4 +42,4 @@ Some organisations using py.test * `Open End `_ * `Laboraratory of Bioinformatics `_ * `merlinux `_ -* many more ... (please send a note via the :ref:`contact`) +* many more ... (please be so kind to send a note via :ref:`contact`) From commits-noreply at bitbucket.org Thu Nov 25 16:39:01 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 09:39:01 -0600 (CST) Subject: [py-svn] py commit d8a7846892df: release prep Message-ID: <20101125153901.6E7B01E0404@bitbucket02.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project py # URL http://bitbucket.org/hpk42/py/overview # User holger krekel # Date 1290699394 -3600 # Node ID d8a7846892df17a93ad268f8c86c0c7e5f3fdb78 # Parent 8d9ddabb8c3f60367341ce56344d60b9685a9013 release prep --- a/doc/install.txt +++ b/doc/install.txt @@ -1,6 +1,6 @@ -.. _`pylib`: -.. _`index page`: http://pypi.python.org/pypi/pylib/ +.. _`py`: +.. _`index page`: http://pypi.python.org/pypi/py/ installation info in a nutshell =================================================== @@ -41,14 +41,14 @@ Working from version control or a tarbal To follow development or start experiments, checkout the complete code and documentation source with mercurial_:: - hg clone https://bitbucket.org/hpk42/pylib + hg clone https://bitbucket.org/hpk42/py Development takes place on the 'trunk' branch. You can also go to the python package index and download and unpack a TAR file:: - http://pypi.python.org/pypi/pylib/ + http://pypi.python.org/pypi/py/ activating a checkout with setuptools -------------------------------------------- @@ -76,7 +76,7 @@ Contact and Communication points - `bitbucket issue tracker`_ use this bitbucket issue tracker to report bugs or request features. -.. _`bitbucket issue tracker`: http://bitbucket.org/hpk42/pylib/issues/ +.. _`bitbucket issue tracker`: http://bitbucket.org/hpk42/py/issues/ .. _codespeak: http://codespeak.net/ .. _`py-dev`: --- a/py/__init__.py +++ b/py/__init__.py @@ -8,7 +8,7 @@ dictionary or an import path. (c) Holger Krekel and others, 2004-2010 """ -__version__ = '1.4.0a5' +__version__ = '1.4.0.a7' from py import _apipkg --- a/doc/index.txt +++ b/doc/index.txt @@ -10,9 +10,9 @@ Welcome to py's documentation! .. note:: - py.test now comes from the `pytest distribtion`_ + py.test now comes from the `pytest distribution`_ -.. _`pytest distribution`: http://pypi.python.org/pypi/pytest +.. _`pytest distribution`: http://pytest.org Contents: --- a/MANIFEST.in +++ b/MANIFEST.in @@ -6,11 +6,3 @@ include LICENSE include conftest.py graft doc graft testing -#exclude *.orig -#exclude *.orig -#exclude *.rej -#exclude *.pyc -#recursive-exclude testing *.pyc *.orig *.rej *$py.class -#prune .pyc -#prune .svn -#prune .hg --- a/py/_path/svnwc.py +++ b/py/_path/svnwc.py @@ -138,7 +138,7 @@ class SvnPathBase(common.PathBase): def new(self, **kw): """ create a modified version of this path. A 'rev' argument indicates a new revision. - the following keyword arguments modify various path parts: + the following keyword arguments modify various path parts:: http://host.com/repo/path/file.ext |-----------------------| dirname --- a/setup.py +++ b/setup.py @@ -9,7 +9,7 @@ def main(): name='py', description='library with cross-python path, ini-parsing, io, code, log facilities', long_description = open('README.txt').read(), - version='1.4.0a5', + version='1.4.0.a7', url='http://pylib.org', license='MIT license', platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'], --- a/README.txt +++ b/README.txt @@ -7,6 +7,9 @@ the following tools and modules: * py.code: dynamic code generation and introspection * py.path: uniform local and svn path objects +NOTE: prior to the 1.4 release this distribution used to +contain py.test which is now its own package, see http://pytest.org + For questions and more information please visit http://pylib.org Bugs and issues: http://bitbucket.org/hpk42/pylib/issues/ From commits-noreply at bitbucket.org Thu Nov 25 16:41:29 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 09:41:29 -0600 (CST) Subject: [py-svn] pytest-xdist commit 5f81d2757754: rel preps Message-ID: <20101125154129.F07506C1064@bitbucket03.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest-xdist # URL http://bitbucket.org/hpk42/pytest-xdist/overview # User holger krekel # Date 1290699676 -3600 # Node ID 5f81d275775449132c497cef31d72bc5e1f7eeb8 # Parent 1edfc8649ffcaa06a9d05451361033bb6b2dcbcc rel preps --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup setup( name="pytest-xdist", - version='1.5a10', + version='1.5a11', description='py.test xdist plugin for distributed testing and loop-on-failing modes', long_description=open('README.txt').read(), license='GPLv2 or later', @@ -13,7 +13,7 @@ setup( packages = ['xdist'], entry_points = {'pytest11': ['xdist = xdist.plugin'],}, zip_safe=False, - install_requires = ['execnet>=1.0.7', 'pytest>1.9.9'], + install_requires = ['execnet>=1.0.8', 'pytest>1.9.9'], classifiers=[ 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', --- a/xdist/__init__.py +++ b/xdist/__init__.py @@ -1,2 +1,2 @@ # -__version__ = '1.5a10' +__version__ = '1.5a11' From commits-noreply at bitbucket.org Thu Nov 25 17:09:20 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 10:09:20 -0600 (CST) Subject: [py-svn] py commit 33d061c0c279: super does not work with exceptions in python2.4 Message-ID: <20101125160920.39BD66C1064@bitbucket03.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project py # URL http://bitbucket.org/hpk42/py/overview # User holger krekel # Date 1290701348 -3600 # Node ID 33d061c0c2790378ff0171022516ea2b2c9350ca # Parent d8a7846892df17a93ad268f8c86c0c7e5f3fdb78 super does not work with exceptions in python2.4 --- a/testing/code/test_assertion.py +++ b/testing/code/test_assertion.py @@ -1,4 +1,4 @@ -import py +import pytest, py def exvalue(): return py.std.sys.exc_info()[1] @@ -291,6 +291,7 @@ def test_assert_raise_alias(testdir): ]) + at pytest.mark.skipif("sys.version_info < (2,5)") def test_assert_raise_subclass(): class SomeEx(AssertionError): def __init__(self, *args): From commits-noreply at bitbucket.org Thu Nov 25 18:15:19 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 11:15:19 -0600 (CST) Subject: [py-svn] py commit 5346ab41b059: setting version to 1.4.0 refining release announce Message-ID: <20101125171519.06C876C1070@bitbucket03.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project py # URL http://bitbucket.org/hpk42/py/overview # User holger krekel # Date 1290705284 -3600 # Node ID 5346ab41b059c95a48cbe1e8a7bae96ce6e0da27 # Parent 33d061c0c2790378ff0171022516ea2b2c9350ca setting version to 1.4.0 refining release announce --- a/setup.py +++ b/setup.py @@ -9,7 +9,7 @@ def main(): name='py', description='library with cross-python path, ini-parsing, io, code, log facilities', long_description = open('README.txt').read(), - version='1.4.0.a7', + version='1.4.0', url='http://pylib.org', license='MIT license', platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'], --- a/py/__init__.py +++ b/py/__init__.py @@ -8,7 +8,7 @@ dictionary or an import path. (c) Holger Krekel and others, 2004-2010 """ -__version__ = '1.4.0.a7' +__version__ = '1.4.0' from py import _apipkg --- a/doc/announce/release-1.4.0.txt +++ b/doc/announce/release-1.4.0.txt @@ -4,18 +4,35 @@ py-1.4.0: lib for path, code, io, ... manipulations =========================================================================== -"py" is a small library comprising APIs for filesystem and svn path manipulations, -dynamic code construction and introspection, IO capturing and a Python2/Python3 -compatibility namespace. It runs unmodified on all Python interpreters compatible -to Python2.4 up until Python 3.2. +"py" is a small library comprising APIs for filesystem and svn path +manipulations, dynamic code construction and introspection, IO capturing +and a Python2/Python3 compatibility namespace. It runs unmodified on +all Python interpreters compatible to Python2.4 up until Python 3.2. +The general goal with "py" is to provide stable APIs that are +continously tested against many Python interpreters and thus also to +help transition. The py distribution prior to 1.4.0 used to contain "py.test" which now -comes as its own "pytest" distribution. Also, the "py.cleanup|py.lookup|py.countloc" -etc. helpers are now part of pycmd. This makes "py-1.4.0" a simple library -not installing any command line utilities. The general idea for "py" is to -place high value on providing some basic APIs that are continously tested -against many Python interpreters and thus also to help transition. +comes as its own "pytest" distribution. Also, the +"py.cleanup|py.lookup|py.countloc" etc. helpers are now part of pycmd. +This makes "py-1.4.0" a simple library which does not nstall any command +line utilities anymore. cheers, holger +Changes between 1.3.4 and 1.4.0 +------------------------------------- + +- py.test was moved to a separate "pytest" package. What remains is + a stub hook which will proxy ``import py.test`` to ``pytest``. +- all command line tools ("py.cleanup/lookup/countloc/..." moved + to "pycmd" package) +- removed the old and deprecated "py.magic" namespace +- use apipkg-1.1 and make py.apipkg.initpkg|ApiModule available +- add py.iniconfig module for brain-dead easy ini-config file parsing +- introduce py.builtin.any() +- path objects have a .dirname attribute now (equivalent to + os.path.dirname(path)) +- path.visit() accepts breadthfirst (bf) and sort options +- remove deprecated py.compat namespace --- a/CHANGELOG +++ b/CHANGELOG @@ -1,5 +1,5 @@ -Changes between 1.3.4 and 1.4.0dev0 +Changes between 1.3.4 and 1.4.0 ================================================== - py.test was moved to a separate "pytest" package. What remains is From commits-noreply at bitbucket.org Thu Nov 25 18:15:19 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 11:15:19 -0600 (CST) Subject: [py-svn] py commit f10f6036eee5: Added tag 1.4.0 for changeset 5346ab41b059 Message-ID: <20101125171519.126716C1313@bitbucket03.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project py # URL http://bitbucket.org/hpk42/py/overview # User holger krekel # Date 1290705290 -3600 # Node ID f10f6036eee5ba4470ec2855755d7e0dba54940e # Parent 5346ab41b059c95a48cbe1e8a7bae96ce6e0da27 Added tag 1.4.0 for changeset 5346ab41b059 --- a/.hgtags +++ b/.hgtags @@ -31,3 +31,4 @@ c59d3fa8681a5b5966b8375b16fccd64a3a8dbeb 79ef6377705184c55633d456832eea318fedcf61 1.3.4 79ef6377705184c55633d456832eea318fedcf61 1.3.4 90fffd35373e9f125af233f78b19416f0938d841 1.3.4 +5346ab41b059c95a48cbe1e8a7bae96ce6e0da27 1.4.0 From commits-noreply at bitbucket.org Thu Nov 25 20:07:04 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 13:07:04 -0600 (CST) Subject: [py-svn] pytest commit 57f312d11228: last changes, preparing 2.0.0 Message-ID: <20101125190704.959C26C1414@bitbucket03.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest # URL http://bitbucket.org/hpk42/pytest/overview # User holger krekel # Date 1290712002 -3600 # Node ID 57f312d1122860af1b0642541d6082b540322777 # Parent 83cd00f43c899b8754faccf03dd3fafd33992729 last changes, preparing 2.0.0 --- a/testing/test_capture.py +++ b/testing/test_capture.py @@ -77,6 +77,7 @@ class TestCaptureManager: finally: capouter.reset() + at pytest.mark.xfail("hasattr(sys, 'pypy_version_info')") @pytest.mark.multi(method=['fd', 'sys']) def test_capturing_unicode(testdir, method): if sys.version_info >= (3,0): --- a/doc/assert.txt +++ b/doc/assert.txt @@ -84,6 +84,8 @@ asserts that the given ``ExpectedExcepti provide you with helpful output in case of failures such as *no exception* or *wrong exception*. +.. _newreport: + Making use of context-sensitive comparisons ------------------------------------------------- @@ -130,7 +132,7 @@ Special comparisons are done for a numbe * comparing long sequences: first failing indices * comparing dicts: different entries -See the :ref:`reporting demo ` for examples. +See the :ref:`reporting demo ` for many more examples. .. Defining your own comparison --- a/doc/example/reportingdemo.txt +++ b/doc/example/reportingdemo.txt @@ -7,7 +7,9 @@ Demo of Python failure reports with py.t Here is a nice run of several tens of failures and how py.test presents things (unfortunately not showing the nice colors here in the HTML that you -get on the terminal - we are working on that):: +get on the terminal - we are working on that): + +.. code-block:: python assertion $ py.test failure_demo.py =========================== test session starts ============================ --- a/pytest.py +++ b/pytest.py @@ -1,7 +1,7 @@ """ unit and functional testing with Python. """ -__version__ = '2.0.0.dev42' +__version__ = '2.0.0' __all__ = ['main'] from _pytest.core import main, UsageError, _preloadplugins --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ def main(): name='pytest', description='py.test: simple powerful testing with Python', long_description = long_description, - version='2.0.0.dev42', + version='2.0.0', url='http://pytest.org', license='MIT license', platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'], --- a/_pytest/terminal.py +++ b/_pytest/terminal.py @@ -257,6 +257,9 @@ class TerminalReporter: self.write_sep("=", "test session starts", bold=True) verinfo = ".".join(map(str, sys.version_info[:3])) msg = "platform %s -- Python %s" % (sys.platform, verinfo) + if hasattr(sys, 'pypy_version_info'): + verinfo = ".".join(map(str, sys.pypy_version_info[:3])) + msg += "[pypy-%s]" % verinfo msg += " -- pytest-%s" % (py.test.__version__) if self.verbosity > 0 or self.config.option.debug or \ getattr(self.config.option, 'pastebin', None): --- a/doc/announce/release-2.0.0.txt +++ b/doc/announce/release-2.0.0.txt @@ -41,7 +41,7 @@ New Features - new and better reporting information in assert expressions if comparing lists, sequences or strings. - see http://pytest.org/2.0.0/assert.html for details. + see http://pytest.org/2.0.0/assert.html#newreport - new configuration through ini-files (setup.cfg or tox.ini recognized), for example:: From commits-noreply at bitbucket.org Thu Nov 25 20:12:12 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 13:12:12 -0600 (CST) Subject: [py-svn] pytest-xdist commit cd44a941c833: upping version to 1.5 Message-ID: <20101125191212.031996C140B@bitbucket03.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest-xdist # URL http://bitbucket.org/hpk42/pytest-xdist/overview # User holger krekel # Date 1290712319 -3600 # Node ID cd44a941c833c098e4899fe3d42a96703754d0d5 # Parent 5f81d275775449132c497cef31d72bc5e1f7eeb8 upping version to 1.5 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup setup( name="pytest-xdist", - version='1.5a11', + version='1.5', description='py.test xdist plugin for distributed testing and loop-on-failing modes', long_description=open('README.txt').read(), license='GPLv2 or later', --- a/xdist/__init__.py +++ b/xdist/__init__.py @@ -1,2 +1,2 @@ # -__version__ = '1.5a11' +__version__ = '1.5' --- a/CHANGELOG +++ b/CHANGELOG @@ -1,7 +1,7 @@ -1.5a1 +1.5 ------------------------- -- adapt to pytest-2.0 changes, rsyncdirs and rsyncignore can now +- adapt to and require pytest-2.0 changes, rsyncdirs and rsyncignore can now only be specified in [pytest] sections of ini files, see "py.test -h" for details. - major internal refactoring to match the pytest-2.0 event refactoring From commits-noreply at bitbucket.org Thu Nov 25 21:03:59 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 14:03:59 -0600 (CST) Subject: [py-svn] pytest-xdist commit 94be523cbf10: Added tag 1.5 for changeset cd44a941c833 Message-ID: <20101125200359.C01251E0404@bitbucket02.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest-xdist # URL http://bitbucket.org/hpk42/pytest-xdist/overview # User holger krekel # Date 1290715410 -3600 # Node ID 94be523cbf10d0df4ae903ba9b575b4ed6c5725a # Parent cd44a941c833c098e4899fe3d42a96703754d0d5 Added tag 1.5 for changeset cd44a941c833 --- a/.hgtags +++ b/.hgtags @@ -5,3 +5,4 @@ e6c4ce20db4bf65086ff55807a3c306cad7ca393 e6c4ce20db4bf65086ff55807a3c306cad7ca393 1.3 eaf8b1cb7c312883598677231be5bbeea3b5c127 1.3 a423748bf17ee778a37853225210257699cad9c1 1.4 +cd44a941c833c098e4899fe3d42a96703754d0d5 1.5 From commits-noreply at bitbucket.org Thu Nov 25 21:04:02 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 14:04:02 -0600 (CST) Subject: [py-svn] pytest commit 06e3242d34b2: Added tag 2.0.0 for changeset e9e127acd6f0 Message-ID: <20101125200402.D2BF4241972@bitbucket01.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest # URL http://bitbucket.org/hpk42/pytest/overview # User holger krekel # Date 1290715388 -3600 # Node ID 06e3242d34b290b20ea336f7d220da45bd2759eb # Parent e9e127acd6f0497324ef7f40cfb997cad4c4cd17 Added tag 2.0.0 for changeset e9e127acd6f0 --- a/.hgtags +++ b/.hgtags @@ -31,3 +31,4 @@ c59d3fa8681a5b5966b8375b16fccd64a3a8dbeb 79ef6377705184c55633d456832eea318fedcf61 1.3.4 79ef6377705184c55633d456832eea318fedcf61 1.3.4 90fffd35373e9f125af233f78b19416f0938d841 1.3.4 +e9e127acd6f0497324ef7f40cfb997cad4c4cd17 2.0.0 From commits-noreply at bitbucket.org Thu Nov 25 21:04:02 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 14:04:02 -0600 (CST) Subject: [py-svn] pytest commit e9e127acd6f0: fix trove classifier Message-ID: <20101125200402.E1DCE2419B7@bitbucket01.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest # URL http://bitbucket.org/hpk42/pytest/overview # User holger krekel # Date 1290715329 -3600 # Node ID e9e127acd6f0497324ef7f40cfb997cad4c4cd17 # Parent 57f312d1122860af1b0642541d6082b540322777 fix trove classifier --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ def main(): author_email='holger at merlinux.eu', entry_points= make_entry_points(), install_requires=['py>=1.4.0a2'], - classifiers=['Development Status :: 5 - Production', + classifiers=['Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', 'Operating System :: POSIX', From commits-noreply at bitbucket.org Fri Nov 26 03:55:00 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Thu, 25 Nov 2010 20:55:00 -0600 (CST) Subject: [py-svn] pytest commit 66a7de5f7a3e: need double colon here Message-ID: <20101126025500.7BCBE6C140B@bitbucket03.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest # URL http://bitbucket.org/hpk42/pytest/overview # User Benjamin Peterson # Date 1290740132 21600 # Node ID 66a7de5f7a3e6778cf0424423dbfde94d4297576 # Parent 06e3242d34b290b20ea336f7d220da45bd2759eb need double colon here --- a/doc/assert.txt +++ b/doc/assert.txt @@ -49,8 +49,8 @@ line:: assert f.read() != '...' -This might fail but when re-interpretation comes along it might pass. -You can rewrite this (and any other expression with side effects) easily, though: +This might fail but when re-interpretation comes along it might pass. You can +rewrite this (and any other expression with side effects) easily, though:: content = f.read() assert content != '...' From commits-noreply at bitbucket.org Fri Nov 26 15:43:09 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Fri, 26 Nov 2010 08:43:09 -0600 (CST) Subject: [py-svn] pytest commit 2e4c9cdd531a: regenerating examples Message-ID: <20101126144309.B8D142410BD@bitbucket01.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest # URL http://bitbucket.org/hpk42/pytest/overview # User holger krekel # Date 1290774416 -3600 # Node ID 2e4c9cdd531abbc69a90cd8615ea0d72ab479e58 # Parent 66a7de5f7a3e6778cf0424423dbfde94d4297576 regenerating examples --- a/doc/Makefile +++ b/doc/Makefile @@ -15,7 +15,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctree .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest regen: - COLUMNS=76 regendoc --update *.txt */*.txt + PYTHONDONTWRITEBYTECODE=1 COLUMNS=76 regendoc --update *.txt */*.txt help: @echo "Please use \`make ' where is one of" --- a/doc/unittest.txt +++ b/doc/unittest.txt @@ -24,8 +24,8 @@ Running it yields:: $ py.test test_unittest.py =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_unittest.py + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 1 items test_unittest.py F @@ -56,7 +56,7 @@ Running it yields:: /usr/lib/python2.6/unittest.py:350: AssertionError ----------------------------- Captured stdout ------------------------------ hello - ========================= 1 failed in 0.02 seconds ========================= + ========================= 1 failed in 0.03 seconds ========================= .. _`unittest.py style`: http://docs.python.org/library/unittest.html --- a/doc/projects.txt +++ b/doc/projects.txt @@ -15,9 +15,12 @@ Here are some examples of projects using * `mwlib `_ mediawiki parser and utility library * `The Translate Toolkit `_ for localization and conversion * `execnet `_ rapid multi-Python deployment +* `Pacha `_ configuration management in five minutes * `bbfreeze `_ create standalone executables from Python scripts * `pdb++ `_ a fancier version of PDB * `py-s3fuse `_ Amazon S3 FUSE based filesystem +* `waskr `_ WSGI Stats Middleware +* `guachi `_ global persistent configs for Python modules * `Circuits `_ lightweight Event Driven Framework * `pygtk-helpers `_ easy interaction with PyGTK * `QuantumCore `_ statusmessage and repoze openid plugin --- a/doc/example/simple.txt +++ b/doc/example/simple.txt @@ -7,6 +7,8 @@ basic patterns and examples pass different values to a test function, depending on command line options ---------------------------------------------------------------------------- +.. regendoc:wipe + Suppose we want to write a test that depends on a command line option. Here is a basic pattern how to achieve this:: @@ -32,7 +34,8 @@ provide the ``cmdopt`` through a :ref:`f Let's run this without supplying our new command line option:: - $ py.test -q + $ py.test -q test_sample.py + collecting ... collected 1 items F ================================= FAILURES ================================= _______________________________ test_answer ________________________________ @@ -55,6 +58,7 @@ Let's run this without supplying our new And now with supplying a command line option:: $ py.test -q --cmdopt=type2 + collecting ... collected 1 items F ================================= FAILURES ================================= _______________________________ test_answer ________________________________ @@ -83,6 +87,8 @@ on real-life examples. generating parameters combinations, depending on command line ---------------------------------------------------------------------------- +.. regendoc:wipe + Let's say we want to execute a test with different parameters and the parameter range shall be determined by a command line argument. Let's first write a simple computation test:: @@ -112,13 +118,15 @@ Now we add a test configuration like thi This means that we only run 2 tests if we do not pass ``--all``:: $ py.test -q test_compute.py + collecting ... collected 2 items .. 2 passed in 0.01 seconds We run only two computations, so we see two dots. let's run the full monty:: - $ py.test -q --all test_compute.py + $ py.test -q --all + collecting ... collected 5 items ....F ================================= FAILURES ================================= _____________________________ test_compute[4] ______________________________ @@ -141,6 +149,8 @@ we'll get an error on the last one. control skipping of tests according to command line option -------------------------------------------------------------- +.. regendoc:wipe + Here is a ``conftest.py`` file adding a ``--runslow`` command line option to control skipping of ``slow`` marked tests:: @@ -171,32 +181,33 @@ We can now write a test module like this and when running it will see a skipped "slow" test:: - $ py.test test_module.py -rs # "-rs" means report details on the little 's' + $ py.test -rs # "-rs" means report details on the little 's' =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_module.py + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 2 items test_module.py .s ========================= short test summary info ========================== - SKIP [1] /tmp/doc-exec-104/conftest.py:9: need --runslow option to run + SKIP [1] /tmp/doc-exec-479/conftest.py:9: need --runslow option to run =================== 1 passed, 1 skipped in 0.02 seconds ==================== Or run it including the ``slow`` marked test:: - $ py.test test_module.py --runslow + $ py.test --runslow =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_module.py + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 2 items test_module.py .. ========================= 2 passed in 0.01 seconds ========================= - writing well integrated assertion helpers -------------------------------------------------- +.. regendoc:wipe + If you have a test helper function called from a test you can use the ``pytest.fail`` marker to fail a test with a certain message. The test support function will not show up in the traceback if you @@ -218,7 +229,8 @@ of tracebacks: the ``checkconfig`` funct unless the ``--fulltrace`` command line option is specified. Let's run our little function:: - $ py.test -q + $ py.test -q test_checkconfig.py + collecting ... collected 1 items F ================================= FAILURES ================================= ______________________________ test_something ______________________________ @@ -230,16 +242,17 @@ Let's run our little function:: test_checkconfig.py:8: Failed 1 failed in 0.02 seconds - Detect if running from within a py.test run -------------------------------------------------------------- +.. regendoc:wipe + Usually it is a bad idea to make application code behave differently if called from a test. But if you absolutely must find out if your application code is running from a test you can do something like this:: - # content of conftest.py in your testing directory + # content of conftest.py def pytest_configure(config): import sys --- a/doc/monkeypatch.txt +++ b/doc/monkeypatch.txt @@ -39,8 +39,8 @@ will be undone. .. background check: $ py.test =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: /tmp/doc-exec-75 + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 0 items ============================= in 0.00 seconds ============================= --- a/doc/doctest.txt +++ b/doc/doctest.txt @@ -15,11 +15,11 @@ python test modules):: py.test --doctest-modules You can make these changes permanent in your project by -putting them into a conftest.py file like this:: +putting them into a pytest.ini file like this:: - # content of conftest.py - option_doctestmodules = True - option_doctestglob = "*.rst" + # content of pytest.ini + [pytest] + addopts = --doctest-modules If you then have a text file like this:: @@ -35,7 +35,7 @@ and another like this:: # content of mymodule.py def something(): """ a doctest in a docstring - >>> something() + >>> something() 42 """ return 42 @@ -44,7 +44,9 @@ then you can just invoke ``py.test`` wit $ py.test =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: /tmp/doc-exec-66 + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 1 items - ============================= in 0.00 seconds ============================= + mymodule.py . + + ========================= 1 passed in 0.03 seconds ========================= --- a/doc/funcargs.txt +++ b/doc/funcargs.txt @@ -45,8 +45,8 @@ Running the test looks like this:: $ py.test test_simplefactory.py =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_simplefactory.py + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 1 items test_simplefactory.py F @@ -150,8 +150,8 @@ Running this:: $ py.test test_example.py =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_example.py + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 10 items test_example.py .........F @@ -188,8 +188,8 @@ If you want to select only the run with $ py.test -v -k 7 test_example.py # or -k test_func[7] =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 -- /home/hpk/venv/0/bin/python - test path 1: test_example.py + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 -- /home/hpk/venv/0/bin/python + collecting ... collected 10 items test_example.py:6: test_func[7] PASSED --- a/doc/builtin.txt +++ b/doc/builtin.txt @@ -30,25 +30,25 @@ You can ask for available builtin or pro 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 captures writes to file descriptors 1 and 2 and makes snapshotted ``(out, err)`` string tuples available via the ``capsys.readouterr()`` method. If the underlying platform does not have ``os.dup`` (e.g. Jython) tests using this funcarg will automatically skip. - + tmpdir return a temporary directory path object unique to each test function invocation, created as a sub directory of the base temporary directory. The returned object is a `py.path.local`_ path object. - + monkeypatch The returned ``monkeypatch`` funcarg provides these helper methods to modify objects, dictionaries or os.environ:: - + monkeypatch.setattr(obj, name, value, raising=True) monkeypatch.delattr(obj, name, raising=True) monkeypatch.setitem(mapping, name, value) @@ -56,15 +56,15 @@ You can ask for available builtin or pro monkeypatch.setenv(name, value, prepend=False) monkeypatch.delenv(name, value, raising=True) monkeypatch.syspath_prepend(path) - + All modifications will be undone when the requesting test function finished its execution. The ``raising`` parameter determines if a KeyError or AttributeError will be raised if the set/deletion operation has no target. - + recwarn Return a WarningsRecorder instance that provides these methods: - + * ``pop(category=None)``: return last warning matching the category. * ``clear()``: clear list of warnings - + --- a/doc/mark.txt +++ b/doc/mark.txt @@ -88,8 +88,8 @@ You can use the ``-k`` command line opti $ py.test -k webtest # running with the above defined examples yields =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: /tmp/doc-exec-74 + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 4 items test_mark.py .. test_mark_classlevel.py .. @@ -100,8 +100,8 @@ And you can also run all tests except th $ py.test -k-webtest =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: /tmp/doc-exec-74 + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 4 items ===================== 4 tests deselected by '-webtest' ===================== ======================= 4 deselected in 0.01 seconds ======================= @@ -110,8 +110,8 @@ Or to only select the class:: $ py.test -kTestClass =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: /tmp/doc-exec-74 + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 4 items test_mark_classlevel.py .. --- a/doc/example/parametrize.txt +++ b/doc/example/parametrize.txt @@ -41,11 +41,12 @@ Running it means we are two tests for ea the respective settings:: $ py.test -q + collecting ... collected 4 items F..F ================================= FAILURES ================================= _________________________ TestClass.test_equals[0] _________________________ - self = , a = 1, b = 2 + self = , a = 1, b = 2 def test_equals(self, a, b): > assert a == b @@ -54,7 +55,7 @@ the respective settings:: test_parametrize.py:17: AssertionError ______________________ TestClass.test_zerodivision[1] ______________________ - self = , a = 3, b = 2 + self = , a = 3, b = 2 def test_zerodivision(self, a, b): > pytest.raises(ZeroDivisionError, "a/b") @@ -97,11 +98,12 @@ for parametrizing test methods:: Running it gives similar results as before:: $ py.test -q test_parametrize2.py + collecting ... collected 4 items F..F ================================= FAILURES ================================= _________________________ TestClass.test_equals[0] _________________________ - self = , a = 1, b = 2 + self = , a = 1, b = 2 @params([dict(a=1, b=2), dict(a=3, b=3), ]) def test_equals(self, a, b): @@ -111,7 +113,7 @@ Running it gives similar results as befo test_parametrize2.py:19: AssertionError ______________________ TestClass.test_zerodivision[1] ______________________ - self = , a = 3, b = 2 + self = , a = 3, b = 2 @params([dict(a=1, b=0), dict(a=3, b=2)]) def test_zerodivision(self, a, b): @@ -138,5 +140,6 @@ with different sets of arguments for its Running it (with Python-2.4 through to Python2.7 installed):: . $ py.test -q multipython.py + collecting ... collected 75 items ....s....s....s....ssssss....s....s....s....ssssss....s....s....s....ssssss - 48 passed, 27 skipped in 2.55 seconds + 48 passed, 27 skipped in 2.74 seconds --- a/doc/getting-started.txt +++ b/doc/getting-started.txt @@ -16,7 +16,7 @@ Installation options:: To check your installation has installed the correct version:: $ py.test --version - This is py.test version 2.0.0.dev30, imported from /home/hpk/p/pytest/pytest.py + This is py.test version 2.0.0, imported from /home/hpk/p/pytest/pytest.pyc If you get an error checkout :ref:`installation issues`. @@ -38,19 +38,19 @@ That's it. You can execute the test func $ py.test =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: /tmp/doc-exec-70 - + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 1 items + test_sample.py F - + ================================= FAILURES ================================= _______________________________ test_answer ________________________________ - + def test_answer(): > assert func(3) == 5 E assert 4 == 5 E + where 4 = func(3) - + test_sample.py:5: AssertionError ========================= 1 failed in 0.02 seconds ========================= @@ -58,9 +58,10 @@ py.test found the ``test_answer`` functi .. note:: - You can simply use the ``assert`` statement for coding expectations because - intermediate values will be presented to you. This is arguably easier than - learning all the `the JUnit legacy methods`_. + You can simply use the ``assert`` statement for asserting + expectations because intermediate values will be presented to you. + This is arguably easier than learning all the `the JUnit legacy + methods`_. However, there remains one caveat to using simple asserts: your assertion expression should better be side-effect free. Because @@ -94,6 +95,7 @@ use the ``raises`` helper:: Running it with, this time in "quiet" reporting mode:: $ py.test -q test_sysexit.py + collecting ... collected 1 items . 1 passed in 0.00 seconds @@ -121,17 +123,18 @@ There is no need to subclass anything. run the module by passing its filename:: $ py.test -q test_class.py + collecting ... collected 2 items .F ================================= FAILURES ================================= ____________________________ TestClass.test_two ____________________________ - - self = - + + self = + def test_two(self): x = "hello" > assert hasattr(x, 'check') E assert hasattr('hello', 'check') - + test_class.py:8: AssertionError 1 failed, 1 passed in 0.02 seconds @@ -157,21 +160,22 @@ py.test will lookup and call a factory t before performing the test function call. Let's just run it:: $ py.test -q test_tmpdir.py + collecting ... collected 1 items F ================================= FAILURES ================================= _____________________________ test_needsfiles ______________________________ - - tmpdir = local('/tmp/pytest-122/test_needsfiles0') - + + tmpdir = local('/tmp/pytest-7/test_needsfiles0') + def test_needsfiles(tmpdir): print tmpdir > assert 0 E assert 0 - + test_tmpdir.py:3: AssertionError ----------------------------- Captured stdout ------------------------------ - /tmp/pytest-122/test_needsfiles0 - 1 failed in 0.05 seconds + /tmp/pytest-7/test_needsfiles0 + 1 failed in 0.04 seconds Before the test runs, a unique-per-test-invocation temporary directory was created. More info at :ref:`tmpdir handling`. --- a/doc/assert.txt +++ b/doc/assert.txt @@ -23,21 +23,21 @@ assertion fails you will see the value o $ py.test test_assert1.py =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_assert1.py - + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 1 items + test_assert1.py F - + ================================= FAILURES ================================= ______________________________ test_function _______________________________ - + def test_function(): > assert f() == 4 E assert 3 == 4 E + where 3 = f() - + test_assert1.py:5: AssertionError - ========================= 1 failed in 0.03 seconds ========================= + ========================= 1 failed in 0.02 seconds ========================= Reporting details about the failing assertion is achieved by re-evaluating the assert expression and recording intermediate values. @@ -105,14 +105,14 @@ if you run this module:: $ py.test test_assert2.py =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_assert2.py - + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 1 items + test_assert2.py F - + ================================= FAILURES ================================= ___________________________ test_set_comparison ____________________________ - + def test_set_comparison(): set1 = set("1308") set2 = set("8035") @@ -122,7 +122,7 @@ if you run this module:: E '1' E Extra items in the right set: E '5' - + test_assert2.py:5: AssertionError ========================= 1 failed in 0.02 seconds ========================= --- a/doc/example/mysetup.txt +++ b/doc/example/mysetup.txt @@ -49,15 +49,15 @@ You can now run the test:: $ py.test test_sample.py =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_sample.py + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 1 items test_sample.py F ================================= FAILURES ================================= _______________________________ test_answer ________________________________ - mysetup = + mysetup = def test_answer(mysetup): app = mysetup.myapp() @@ -122,12 +122,12 @@ Running it yields:: $ py.test test_ssh.py -rs =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_ssh.py + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 1 items test_ssh.py s ========================= short test summary info ========================== - SKIP [1] /tmp/doc-exec-107/conftest.py:22: specify ssh host with --ssh + SKIP [1] /tmp/doc-exec-474/conftest.py:22: specify ssh host with --ssh ======================== 1 skipped in 0.02 seconds ========================= --- a/doc/skipping.txt +++ b/doc/skipping.txt @@ -121,14 +121,14 @@ Running it with the report-on-xfail opti example $ py.test -rx xfail_demo.py =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev31 - test path 1: xfail_demo.py + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 5 items xfail_demo.py xxxxx ========================= short test summary info ========================== XFAIL xfail_demo.py::test_hello XFAIL xfail_demo.py::test_hello2 - reason: [NOTRUN] + reason: [NOTRUN] XFAIL xfail_demo.py::test_hello3 condition: hasattr(os, 'sep') XFAIL xfail_demo.py::test_hello4 --- a/doc/example/nonpython.txt +++ b/doc/example/nonpython.txt @@ -27,8 +27,8 @@ now execute the test specification:: nonpython $ py.test test_simple.yml =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_simple.yml + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 2 items test_simple.yml .F @@ -37,9 +37,7 @@ now execute the test specification:: usecase execution failed spec failed: 'some': 'other' no further details known at this point. - ========================= short test summary info ========================== - FAIL test_simple.yml::hello - ==================== 1 failed, 1 passed in 0.06 seconds ==================== + ==================== 1 failed, 1 passed in 0.03 seconds ==================== You get one dot for the passing ``sub1: sub1`` check and one failure. Obviously in the above ``conftest.py`` you'll want to implement a more @@ -58,8 +56,8 @@ reporting in ``verbose`` mode:: nonpython $ py.test -v =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 -- /home/hpk/venv/0/bin/python - test path 1: /home/hpk/p/pytest/doc/example/nonpython + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 -- /home/hpk/venv/0/bin/python + collecting ... collected 2 items test_simple.yml:1: usecase: ok PASSED test_simple.yml:1: usecase: hello FAILED @@ -69,9 +67,7 @@ reporting in ``verbose`` mode:: usecase execution failed spec failed: 'some': 'other' no further details known at this point. - ========================= short test summary info ========================== - FAIL test_simple.yml::hello - ==================== 1 failed, 1 passed in 0.06 seconds ==================== + ==================== 1 failed, 1 passed in 0.03 seconds ==================== While developing your custom test collection and execution it's also interesting to just look at the collection tree:: --- a/doc/example/reportingdemo.txt +++ b/doc/example/reportingdemo.txt @@ -13,9 +13,8 @@ get on the terminal - we are working on assertion $ py.test failure_demo.py =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev38 - collecting ... - collected 35 items + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 35 items failure_demo.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF @@ -31,7 +30,7 @@ get on the terminal - we are working on failure_demo.py:15: AssertionError _________________________ TestFailing.test_simple __________________________ - self = + self = def test_simple(self): def f(): @@ -41,21 +40,21 @@ get on the terminal - we are working on > assert f() == g() E assert 42 == 43 - E + where 42 = () - E + and 43 = () + E + where 42 = () + E + and 43 = () failure_demo.py:28: AssertionError ____________________ TestFailing.test_simple_multiline _____________________ - self = + self = def test_simple_multiline(self): otherfunc_multi( 42, > 6*9) - failure_demo.py:33: - _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + failure_demo.py:33: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ a = 42, b = 54 @@ -67,19 +66,19 @@ get on the terminal - we are working on failure_demo.py:12: AssertionError ___________________________ TestFailing.test_not ___________________________ - self = + self = def test_not(self): def f(): return 42 > assert not f() E assert not 42 - E + where 42 = () + E + where 42 = () failure_demo.py:38: AssertionError _________________ TestSpecialisedExplanations.test_eq_text _________________ - self = + self = def test_eq_text(self): > assert 'spam' == 'eggs' @@ -90,7 +89,7 @@ get on the terminal - we are working on failure_demo.py:42: AssertionError _____________ TestSpecialisedExplanations.test_eq_similar_text _____________ - self = + self = def test_eq_similar_text(self): > assert 'foo 1 bar' == 'foo 2 bar' @@ -103,7 +102,7 @@ get on the terminal - we are working on failure_demo.py:45: AssertionError ____________ TestSpecialisedExplanations.test_eq_multiline_text ____________ - self = + self = def test_eq_multiline_text(self): > assert 'foo\nspam\nbar' == 'foo\neggs\nbar' @@ -116,7 +115,7 @@ get on the terminal - we are working on failure_demo.py:48: AssertionError ______________ TestSpecialisedExplanations.test_eq_long_text _______________ - self = + self = def test_eq_long_text(self): a = '1'*100 + 'a' + '2'*100 @@ -133,7 +132,7 @@ get on the terminal - we are working on failure_demo.py:53: AssertionError _________ TestSpecialisedExplanations.test_eq_long_text_multiline __________ - self = + self = def test_eq_long_text_multiline(self): a = '1\n'*100 + 'a' + '2\n'*100 @@ -157,7 +156,7 @@ get on the terminal - we are working on failure_demo.py:58: AssertionError _________________ TestSpecialisedExplanations.test_eq_list _________________ - self = + self = def test_eq_list(self): > assert [0, 1, 2] == [0, 1, 3] @@ -167,7 +166,7 @@ get on the terminal - we are working on failure_demo.py:61: AssertionError ______________ TestSpecialisedExplanations.test_eq_list_long _______________ - self = + self = def test_eq_list_long(self): a = [0]*100 + [1] + [3]*100 @@ -179,7 +178,7 @@ get on the terminal - we are working on failure_demo.py:66: AssertionError _________________ TestSpecialisedExplanations.test_eq_dict _________________ - self = + self = def test_eq_dict(self): > assert {'a': 0, 'b': 1} == {'a': 0, 'b': 2} @@ -192,7 +191,7 @@ get on the terminal - we are working on failure_demo.py:69: AssertionError _________________ TestSpecialisedExplanations.test_eq_set __________________ - self = + self = def test_eq_set(self): > assert set([0, 10, 11, 12]) == set([0, 20, 21]) @@ -208,7 +207,7 @@ get on the terminal - we are working on failure_demo.py:72: AssertionError _____________ TestSpecialisedExplanations.test_eq_longer_list ______________ - self = + self = def test_eq_longer_list(self): > assert [1,2] == [1,2,3] @@ -218,7 +217,7 @@ get on the terminal - we are working on failure_demo.py:75: AssertionError _________________ TestSpecialisedExplanations.test_in_list _________________ - self = + self = def test_in_list(self): > assert 1 in [0, 2, 3, 4, 5] @@ -233,7 +232,7 @@ get on the terminal - we are working on i = Foo() > assert i.b == 2 E assert 1 == 2 - E + where 1 = .b + E + where 1 = .b failure_demo.py:85: AssertionError _________________________ test_attribute_instance __________________________ @@ -243,8 +242,8 @@ get on the terminal - we are working on b = 1 > assert Foo().b == 2 E assert 1 == 2 - E + where 1 = .b - E + where = () + E + where 1 = .b + E + where = () failure_demo.py:91: AssertionError __________________________ test_attribute_failure __________________________ @@ -257,10 +256,10 @@ get on the terminal - we are working on i = Foo() > assert i.b == 2 - failure_demo.py:100: - _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + failure_demo.py:100: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ - self = + self = def _get_b(self): > raise Exception('Failed to get attrib') @@ -276,22 +275,22 @@ get on the terminal - we are working on b = 2 > assert Foo().b == Bar().b E assert 1 == 2 - E + where 1 = .b - E + where = () - E + and 2 = .b - E + where = () + E + where 1 = .b + E + where = () + E + and 2 = .b + E + where = () failure_demo.py:108: AssertionError __________________________ TestRaises.test_raises __________________________ - self = + self = def test_raises(self): s = 'qwe' > raises(TypeError, "int(s)") - failure_demo.py:117: - _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + failure_demo.py:117: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ > int(s) E ValueError: invalid literal for int() with base 10: 'qwe' @@ -299,7 +298,7 @@ get on the terminal - we are working on <0-codegen /home/hpk/p/pytest/_pytest/python.py:819>:1: ValueError ______________________ TestRaises.test_raises_doesnt _______________________ - self = + self = def test_raises_doesnt(self): > raises(IOError, "int('3')") @@ -308,7 +307,7 @@ get on the terminal - we are working on failure_demo.py:120: Failed __________________________ TestRaises.test_raise ___________________________ - self = + self = def test_raise(self): > raise ValueError("demo error") @@ -317,7 +316,7 @@ get on the terminal - we are working on failure_demo.py:123: ValueError ________________________ TestRaises.test_tupleerror ________________________ - self = + self = def test_tupleerror(self): > a,b = [1] @@ -326,7 +325,7 @@ get on the terminal - we are working on failure_demo.py:126: ValueError ______ TestRaises.test_reinterpret_fails_with_print_for_the_fun_of_it ______ - self = + self = def test_reinterpret_fails_with_print_for_the_fun_of_it(self): l = [1,2,3] @@ -339,7 +338,7 @@ get on the terminal - we are working on l is [1, 2, 3] ________________________ TestRaises.test_some_error ________________________ - self = + self = def test_some_error(self): > if namenotexi: @@ -357,8 +356,8 @@ get on the terminal - we are working on py.std.sys.modules[name] = module > module.foo() - failure_demo.py:149: - _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + failure_demo.py:149: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ def foo(): > assert 1 == 0 @@ -367,7 +366,7 @@ get on the terminal - we are working on <2-codegen 'abc-123' /home/hpk/p/pytest/doc/example/assertion/failure_demo.py:146>:2: AssertionError ____________________ TestMoreErrors.test_complex_error _____________________ - self = + self = def test_complex_error(self): def f(): @@ -376,16 +375,16 @@ get on the terminal - we are working on return 43 > somefunc(f(), g()) - failure_demo.py:159: - _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + failure_demo.py:159: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ x = 44, y = 43 def somefunc(x,y): > otherfunc(x,y) - failure_demo.py:8: - _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + failure_demo.py:8: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ a = 44, b = 43 @@ -396,7 +395,7 @@ get on the terminal - we are working on failure_demo.py:5: AssertionError ___________________ TestMoreErrors.test_z1_unpack_error ____________________ - self = + self = def test_z1_unpack_error(self): l = [] @@ -406,7 +405,7 @@ get on the terminal - we are working on failure_demo.py:163: ValueError ____________________ TestMoreErrors.test_z2_type_error _____________________ - self = + self = def test_z2_type_error(self): l = 3 @@ -416,19 +415,19 @@ get on the terminal - we are working on failure_demo.py:167: TypeError ______________________ TestMoreErrors.test_startswith ______________________ - self = + self = def test_startswith(self): s = "123" g = "456" > assert s.startswith(g) - E assert ('456') - E + where = '123'.startswith + E assert ('456') + E + where = '123'.startswith failure_demo.py:172: AssertionError __________________ TestMoreErrors.test_startswith_nested ___________________ - self = + self = def test_startswith_nested(self): def f(): @@ -436,15 +435,15 @@ get on the terminal - we are working on def g(): return "456" > assert f().startswith(g()) - E assert ('456') - E + where = '123'.startswith - E + where '123' = () - E + and '456' = () + E assert ('456') + E + where = '123'.startswith + E + where '123' = () + E + and '456' = () failure_demo.py:179: AssertionError _____________________ TestMoreErrors.test_global_func ______________________ - self = + self = def test_global_func(self): > assert isinstance(globf(42), float) @@ -454,19 +453,19 @@ get on the terminal - we are working on failure_demo.py:182: AssertionError _______________________ TestMoreErrors.test_instance _______________________ - self = + self = def test_instance(self): self.x = 6*7 > assert self.x != 42 E assert 42 != 42 E + where 42 = 42 - E + where 42 = .x + E + where 42 = .x failure_demo.py:186: AssertionError _______________________ TestMoreErrors.test_compare ________________________ - self = + self = def test_compare(self): > assert globf(10) < 5 @@ -476,7 +475,7 @@ get on the terminal - we are working on failure_demo.py:189: AssertionError _____________________ TestMoreErrors.test_try_finally ______________________ - self = + self = def test_try_finally(self): x = 1 --- a/doc/tmpdir.txt +++ b/doc/tmpdir.txt @@ -28,15 +28,15 @@ Running this would result in a passed te $ py.test test_tmpdir.py =========================== test session starts ============================ - platform linux2 -- Python 2.6.5 -- pytest-2.0.0.dev30 - test path 1: test_tmpdir.py + platform linux2 -- Python 2.6.5 -- pytest-2.0.0 + collecting ... collected 1 items test_tmpdir.py F ================================= FAILURES ================================= _____________________________ test_create_file _____________________________ - tmpdir = local('/tmp/pytest-123/test_create_file0') + tmpdir = local('/tmp/pytest-8/test_create_file0') def test_create_file(tmpdir): p = tmpdir.mkdir("sub").join("hello.txt") @@ -47,7 +47,7 @@ Running this would result in a passed te E assert 0 test_tmpdir.py:7: AssertionError - ========================= 1 failed in 0.02 seconds ========================= + ========================= 1 failed in 0.04 seconds ========================= .. _`base temporary directory`: From commits-noreply at bitbucket.org Fri Nov 26 15:43:09 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Fri, 26 Nov 2010 08:43:09 -0600 (CST) Subject: [py-svn] pytest commit 026cb4b8eebd: bumping version to a dev version, run tests by using python PyPI by default Message-ID: <20101126144309.CD323241972@bitbucket01.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project pytest # URL http://bitbucket.org/hpk42/pytest/overview # User holger krekel # Date 1290775020 -3600 # Node ID 026cb4b8eebd6b30617475bf9ccdba76999ad86a # Parent 2e4c9cdd531abbc69a90cd8615ea0d72ab479e58 bumping version to a dev version, run tests by using python PyPI by default --- a/doc/Makefile +++ b/doc/Makefile @@ -40,7 +40,7 @@ clean: -rm -rf $(BUILDDIR)/* install: clean html - rsync -avz _build/html/ code:www-pytest/2.0.0 + rsync -avz _build/html/ code:www-pytest/ html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html --- a/tox.ini +++ b/tox.ini @@ -2,20 +2,20 @@ distshare={homedir}/.tox/distshare envlist=py26,py27,py31,py32,py27-xdist,py25,py24 indexserver= - default = http://pypi.testrun.org - pypi = http://pypi.python.org/simple + default = http://pypi.python.org/simple + testrun = http://pypi.testrun.org [testenv] changedir=testing commands= py.test -rfsxX --junitxml={envlogdir}/junit-{envname}.xml [] deps= - :pypi:pexpect - :pypi:nose + pexpect + nose [testenv:genscript] changedir=. commands= py.test --genscript=pytest1 -deps=py>=1.4.0a2 +deps=py>=1.4.0 [testenv:py27-xdist] changedir=. @@ -28,7 +28,7 @@ commands= [testenv:trial] changedir=. basepython=python2.6 -deps=:pypi:twisted +deps=twisted commands= py.test -rsxf \ --junitxml={envlogdir}/junit-{envname}.xml [testing/test_unittest.py] @@ -41,14 +41,14 @@ deps= [testenv:doc] basepython=python changedir=doc -deps=:pypi:sphinx +deps=sphinx pytest commands= make html [testenv:py31] -deps=py>=1.4.0a2 +deps=py>=1.4.0 [testenv:py31-xdist] deps=pytest-xdist @@ -57,7 +57,7 @@ commands= --junitxml={envlogdir}/junit-{envname}.xml [] [testenv:py32] -deps=py>=1.4.0a2 +deps=py>=1.4.0 [testenv:pypy] basepython=pypy-c --- a/CHANGELOG +++ b/CHANGELOG @@ -1,4 +1,9 @@ -Changes between 1.3.4 and 2.0.0dev0 +Changes between 2.0.0 and 2.0.1.dev1 +---------------------------------------------- + +- refinements to terminal output + +Changes between 1.3.4 and 2.0.0 ---------------------------------------------- - pytest-2.0 is now its own package and depends on pylib-2.0 --- a/doc/conf.py +++ b/doc/conf.py @@ -49,7 +49,7 @@ copyright = u'2010, holger krekel et ali # built documents. # # The short X.Y version. -version = '2.0.0' +version = '2.0' # The full version, including alpha/beta/rc tags. import py, pytest assert py.path.local().relto(py.path.local(pytest.__file__).dirpath().dirpath()) --- a/_pytest/terminal.py +++ b/_pytest/terminal.py @@ -136,6 +136,9 @@ class TerminalReporter: self._tw.line() self.currentfspath = None + def write(self, content, **markup): + self._tw.write(content, **markup) + def write_line(self, line, **markup): line = str(line) self.ensure_newline() @@ -215,7 +218,7 @@ class TerminalReporter: def pytest_collection(self): if not self.hasmarkup: - self.write_line("collecting ...", bold=True) + self.write("collecting ... ", bold=True) def pytest_collectreport(self, report): if report.failed: --- a/pytest.py +++ b/pytest.py @@ -1,7 +1,7 @@ """ unit and functional testing with Python. """ -__version__ = '2.0.0' +__version__ = '2.0.1.dev1' __all__ = ['main'] from _pytest.core import main, UsageError, _preloadplugins --- a/setup.py +++ b/setup.py @@ -22,14 +22,14 @@ def main(): name='pytest', description='py.test: simple powerful testing with Python', long_description = long_description, - version='2.0.0', + version='2.0.1.dev1', url='http://pytest.org', license='MIT license', platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'], author='holger krekel, Guido Wesdorp, Carl Friedrich Bolz, Armin Rigo, Maciej Fijalkowski & others', author_email='holger at merlinux.eu', entry_points= make_entry_points(), - install_requires=['py>=1.4.0a2'], + install_requires=['py>=1.4.0'], classifiers=['Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', From commits-noreply at bitbucket.org Mon Nov 29 16:58:03 2010 From: commits-noreply at bitbucket.org (commits-noreply at bitbucket.org) Date: Mon, 29 Nov 2010 09:58:03 -0600 (CST) Subject: [py-svn] py commit 9265aa1ddd34: fixed and sent release announcement Message-ID: <20101129155803.256E11E12DB@bitbucket02.managed.contegix.com> # HG changeset patch -- Bitbucket.org # Project py # URL http://bitbucket.org/hpk42/py/overview # User holger krekel # Date 1291046273 -3600 # Node ID 9265aa1ddd34db756f6dc6d2de0ca7a5a0622032 # Parent f10f6036eee5ba4470ec2855755d7e0dba54940e fixed and sent release announcement --- a/doc/Makefile +++ b/doc/Makefile @@ -37,7 +37,7 @@ clean: -rm -rf $(BUILDDIR)/* install: clean html - rsync -avz _build/html/ code:www-pylib/1.4.0 + rsync -avz _build/html/ code:www-pylib/ html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html --- a/doc/install.txt +++ b/doc/install.txt @@ -17,7 +17,7 @@ installation info in a nutshell **hg repository**: https://bitbucket.org/hpk42/py -easy install +easy install or pip ``py`` ----------------------------- Both `Distribute`_ and setuptools_ provide the ``easy_install`` --- a/doc/announce/release-1.4.0.txt +++ b/doc/announce/release-1.4.0.txt @@ -1,22 +1,31 @@ .. _`release-1.4.0`: -py-1.4.0: lib for path, code, io, ... manipulations +py-1.4.0: cross-python lib for path, code, io, ... manipulations =========================================================================== "py" is a small library comprising APIs for filesystem and svn path -manipulations, dynamic code construction and introspection, IO capturing -and a Python2/Python3 compatibility namespace. It runs unmodified on -all Python interpreters compatible to Python2.4 up until Python 3.2. -The general goal with "py" is to provide stable APIs that are -continously tested against many Python interpreters and thus also to -help transition. +manipulations, dynamic code construction and introspection, a Py2/Py3 +compatibility namespace ("py.builtin"), IO capturing, terminal colored printing +(on windows and linux), ini-file parsing and a lazy import mechanism. +It runs unmodified on all Python interpreters compatible to Python2.4 up +until Python 3.2. The general goal with "py" is to provide stable APIs +for some common tasks that are continously tested against many Python +interpreters and thus also to help transition. Here are some docs: -The py distribution prior to 1.4.0 used to contain "py.test" which now -comes as its own "pytest" distribution. Also, the -"py.cleanup|py.lookup|py.countloc" etc. helpers are now part of pycmd. -This makes "py-1.4.0" a simple library which does not nstall any command -line utilities anymore. + http://pylib.org + +NOTE: The prior py-1.3.X versions contained "py.test" which now comes +as its own separate "pytest" distribution and was just released +as "pytest-2.0.0", see here for the revamped docs: + + http://pytest.org + +And "py.cleanup|py.lookup|py.countloc" etc. helpers are now part of +the pycmd distribution, see http://pypi.python.org/pypi/pycmd + +This makes "py-1.4.0" a simple library which does not install +any command line utilities anymore. cheers, holger --- /dev/null +++ b/doc/_templates/layout.html @@ -0,0 +1,18 @@ +{% extends "!layout.html" %} + +{% block footer %} +{{ super() }} + +{% endblock %}