From 9a90aaca96ad4d5548e006594cb764759735238c Mon Sep 17 00:00:00 2001 From: holger krekel Date: Wed, 16 Sep 2015 17:15:31 +0200 Subject: [PATCH] improve and integrate docs --- CHANGELOG | 11 +++++++---- doc/en/{cache.txt => cache.rst} | 12 +++++++----- doc/en/contents.rst | 1 + doc/en/index.rst | 1 + 4 files changed, 16 insertions(+), 9 deletions(-) rename doc/en/{cache.txt => cache.rst} (95%) diff --git a/CHANGELOG b/CHANGELOG index dd908d95a..8a09ca076 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,6 +1,13 @@ 2.8.0.dev (compared to 2.7.X) ----------------------------- +- new ``--lf`` and ``-ff`` options to run only the last failing tests or + "failing tests first" from the last run. This functionality is provided + through porting the formerly external pytest-cache plugin into pytest core. + BACKWARD INCOMPAT: if you used pytest-cache's functionality to persist + data between test runs be aware that we don't serialize sets anymore. + Thanks Ronny Pfannschmidt for most of the merging work. + - "-r" option now accepts "a" to include all possible reports, similar to passing "fEsxXw" explicitly (isse960). Thanks Abhijeet Kasurde for the PR. @@ -43,10 +50,6 @@ files and upwards by default (--confcutdir can still be set to override this). Thanks Bruno Oliveira for the PR. -- merge a refined variant of the pytest-cache extension into core - it uses json instead of execnet for the serializer - and deactivates the external cache plugin - - fix issue768: docstrings found in python modules were not setting up session fixtures. Thanks Jason R. Coombs for reporting and Bruno Oliveira for the PR. diff --git a/doc/en/cache.txt b/doc/en/cache.rst similarity index 95% rename from doc/en/cache.txt rename to doc/en/cache.rst index 2d2965048..78afd6bf9 100644 --- a/doc/en/cache.txt +++ b/doc/en/cache.rst @@ -5,9 +5,10 @@ cache: working with cross-testrun state .. warning:: - the external pytest-cache plugin used execnet_ as serializer, - which supported a wider range of builtin objects. - the buitin one however uses json. + The functionality of this core plugin was previosuly distributed + as a third party plugin named ``pytest-cache``. The core plugin + is compatible regarding command line options and API usage except that you + can only store/receive data between test runs that is json-serializable. Usage --------- @@ -201,8 +202,7 @@ the cache and this will be quick:: test_caching.py:12: AssertionError -Consult the `pytest-cache API `_ -for more details. +See the `cache-api`_ for more details. Inspecting Cache content @@ -237,6 +237,8 @@ servers where isolation and correctness is more important than speed. +.. _`cache-api`: + config.cache API ======================================== diff --git a/doc/en/contents.rst b/doc/en/contents.rst index dabfcbecb..7666b5e59 100644 --- a/doc/en/contents.rst +++ b/doc/en/contents.rst @@ -12,6 +12,7 @@ Full pytest documentation overview apiref + cache plugins plugins_index/index example/index diff --git a/doc/en/index.rst b/doc/en/index.rst index 37842f4b5..24beb5b7c 100644 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -32,6 +32,7 @@ pytest: helps you write better programs - :ref:`skipping` (improved in 2.4) - :ref:`distribute tests to multiple CPUs ` through :ref:`xdist plugin ` - :ref:`continuously re-run failing tests ` + - :doc:`cache` - flexible :ref:`Python test discovery` **integrates with other testing methods and tools**: