From 90551c6ce22e7726951c995b9f08d9d5dbd84e20 Mon Sep 17 00:00:00 2001 From: holger krekel Date: Tue, 17 Dec 2013 07:58:49 +0100 Subject: [PATCH] adding a release announcement and some doc fixes --- CHANGELOG | 5 +++- doc/en/_templates/links.html | 2 +- doc/en/announce/index.txt | 1 + doc/en/announce/release-2.5.1.txt | 45 +++++++++++++++++++++++++++++++ doc/en/fixture.txt | 1 + doc/en/goodpractises.txt | 16 +++++------ doc/en/index.txt | 29 +++++++++----------- 7 files changed, 72 insertions(+), 27 deletions(-) create mode 100644 doc/en/announce/release-2.5.1.txt diff --git a/CHANGELOG b/CHANGELOG index e5df87f8c..776c28d55 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,6 +1,8 @@ -Unreleased +2.5.1 ----------------------------------- +- merge new documentation styling PR from Tobias Bieniek. + - fix issue403: allow parametrize of multiple same-name functions within a collection node. Thanks Andreas Kloeckner and Alex Gaynor for reporting and analysis. @@ -16,6 +18,7 @@ Unreleased optparse. Thanks Daniel D. Wright. + 2.5.0 ----------------------------------- diff --git a/doc/en/_templates/links.html b/doc/en/_templates/links.html index 3618d92c4..7fa582faa 100644 --- a/doc/en/_templates/links.html +++ b/doc/en/_templates/links.html @@ -3,7 +3,7 @@
  • The pytest Website
  • pytest @ PyPI
  • pytest @ Bitbucket
    • -
  • Issue Tracker
    • +
  • Issue Tracker
  • PDF Documentation diff --git a/doc/en/announce/index.txt b/doc/en/announce/index.txt index 6d2e24cce..0f0fc47d1 100644 --- a/doc/en/announce/index.txt +++ b/doc/en/announce/index.txt @@ -5,6 +5,7 @@ Release announcements .. toctree:: :maxdepth: 2 + release-2.5.1 release-2.5.0 release-2.4.2 release-2.4.1 diff --git a/doc/en/announce/release-2.5.1.txt b/doc/en/announce/release-2.5.1.txt new file mode 100644 index 000000000..04d8976b3 --- /dev/null +++ b/doc/en/announce/release-2.5.1.txt @@ -0,0 +1,45 @@ +pytest-2.5.1: fixes and new home page styling +=========================================================================== + +pytest-2.5.1, a mature testing tool with more than a 1000 tests +against itself, maintains the "zero-reported-bugs" promise by fixing +the three bugs reported since the last release a few days ago. It also +features a new home page styling implemented by Tobias Bieniek, based on +original work from Armin Ronacher. Check it out: + + http://pytest.org + +If you have anything more to improve styling and docs, +we'd be very happy to merge further pull requests. + +On the coding side, the release also contains a little enhancement to +fixture decorators allowing to directly influence generation of test +ids, thanks to Floris Bruynooghe. Other thanks for helping with +this release also go to Anatoly Bubenkoff and Ronny Pfannschmidt. + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +have fun and a nice remaining time of the year! +holger krekel + +2.5.1 +----------------------------------- + +- merge new documentation styling PR from Tobias Bieniek. + +- fix issue403: allow parametrize of multiple same-name functions within + a collection node. Thanks Andreas Kloeckner and Alex Gaynor for reporting + and analysis. + +- Allow parameterized fixtures to specify the ID of the parameters by + adding an ids argument to pytest.fixture() and pytest.yield_fixture(). + Thanks Floris Bruynooghe. + +- fix issue404 by always using the binary xml escape in the junitxml + plugin. Thanks Ronny Pfannschmidt. + +- fix issue407: fix addoption docstring to point to argparse instead of + optparse. Thanks Daniel D. Wright. + diff --git a/doc/en/fixture.txt b/doc/en/fixture.txt index d4408b2cd..287002120 100644 --- a/doc/en/fixture.txt +++ b/doc/en/fixture.txt @@ -626,6 +626,7 @@ into an ini-file:: usefixtures = cleandir +.. _`autouse`: .. _`autouse fixtures`: autouse fixtures (xUnit setup on steroids) diff --git a/doc/en/goodpractises.txt b/doc/en/goodpractises.txt index edb271be1..5901e55dd 100644 --- a/doc/en/goodpractises.txt +++ b/doc/en/goodpractises.txt @@ -69,7 +69,7 @@ Important notes relating to both schemes: - **avoid "__init__.py" files in your test directories**. This way your tests can run easily against an installed version - of ``mypkg``, independently from if the installed version contains + of ``mypkg``, independently from if the installed package contains the tests or not. - With inlined tests you might put ``__init__.py`` into test @@ -96,16 +96,14 @@ required configurations. .. note:: You can use Python3 namespace packages (PEP420) for your application - but pytest will still perform `package name`_ discovery based on the - presence of ``__init__.py`` files. If you use one of the above - two recommended file system layouts but leave away the ``__init__.py`` - files it should just work on Python3.3 and above. When using + but pytest will still perform `test package name`_ discovery based on the + presence of ``__init__.py`` files. If you use one of the + two recommended file system layouts above but leave away the ``__init__.py`` + files from your directories it should just work on Python3.3 and above. From "inlined tests", however, you will need to use absolute imports for - getting at your application code because the test modules will be - imported directly, without any application context. The latter allows - your tests to run against an installed version of your package. + getting at your application code. -.. _`package name`: +.. _`test package name`: .. note:: diff --git a/doc/en/index.txt b/doc/en/index.txt index 521c4d83e..56aa73d7c 100644 --- a/doc/en/index.txt +++ b/doc/en/index.txt @@ -9,44 +9,43 @@ pytest: helps you write better programs **a mature full-featured Python testing tool** - runs on Posix/Windows, Python 2.5-3.3, PyPy and Jython-2.5.1 + - **zero-reported-bugs** policy with >1000 tests against itself + - **strict backward compatibility policy** for safe pytest upgrades - :ref:`comprehensive online ` and `PDF documentation `_ - - many :ref:`third party plugins ` and - :ref:`builtin helpers ` - - used in :ref:`many projects and organisations `, in test - suites with up to twenty thousand tests - - strict policy of remaining backward compatible across releases + - many :ref:`third party plugins `, + :ref:`builtin helpers `, + - used in :ref:`many small and large projects and organisations ` - comes with many :ref:`tested examples ` **provides easy no-boilerplate testing** - makes it :ref:`easy to get started `, - many :ref:`usage options ` + has many :ref:`usage options ` - :ref:`assert with the assert statement` - helpful :ref:`traceback and failing assertion reporting ` - - allows :ref:`print debugging ` and :ref:`the + - :ref:`print debugging ` and :ref:`the capturing of standard output during test execution ` **scales from simple unit to complex functional testing** - :ref:`modular parametrizeable fixtures ` (new in 2.3, - improved in 2.4) + continously improved) - :ref:`parametrized test functions ` - :ref:`mark` - :ref:`skipping` (improved in 2.4) - - can :ref:`distribute tests to multiple CPUs ` through :ref:`xdist plugin ` - - can :ref:`continuously re-run failing tests ` + - :ref:`distribute tests to multiple CPUs ` through :ref:`xdist plugin ` + - :ref:`continuously re-run failing tests ` - flexible :ref:`Python test discovery` -**integrates many common testing methods**: +**integrates with other testing methods and tools**: - - multi-paradigm: pytest can run many ``nose``, ``unittest.py`` and - ``doctest.py`` style test suites, including running testcases made for + - multi-paradigm: pytest can run ``nose``, ``unittest`` and + ``doctest`` style test suites, including running testcases made for Django and trial - supports :ref:`good integration practises ` - supports extended :ref:`xUnit style setup ` - supports domain-specific :ref:`non-python tests` - supports the generation of testing coverage reports - - `Javascript unit- and functional testing`_ - supports :pep:`8` compliant coding styles in tests **extensive plugin and customization system**: @@ -56,8 +55,6 @@ pytest: helps you write better programs - it is easy to add command line options or customize existing behaviour -.. _`Javascript unit- and functional testing`: http://pypi.python.org/pypi/oejskit - .. _`easy`: http://bruynooghe.blogspot.com/2009/12/skipping-slow-test-by-default-in-pytest.html