add "alwayscopy" config option to instruct virtualenv to always copy
files instead of symlinking. Thanks Igor Duarte Cardoso (igordcard).
pass setenv variables to setup.py during a usedevelop install.
Thanks Eli Collins (eli-collins).
replace all references to testrun.org with readthedocs ones.
Thanks Oliver Bestwalter (obestwalter).
fix 323 by avoiding virtualenv14 is not used on py32
(although we don't officially support py32).
Thanks Jason R. Coombs (jaraco).
add Python 3.6 to envlist and CI.
Thanks Andrii Soldatenko (andriisoldatenko).
fix glob resolution from TOX_TESTENV_PASSENV env variable
Thanks Allan Feldman (a-feld).
2.5.0
slightly backward incompatible: fix issue310: the {posargs} substitution
now properly preserves the tox command line positional arguments. Positional
arguments with spaces are now properly handled.
NOTE: if your tox invocation previously used extra quoting for positional arguments to
work around issue310, you need to remove the quoting. Example:
tox -- "'some string'" has to now be written simply as
tox -- "some string"
thanks holger krekel. You can set minversion = 2.5.0 in the [tox]
section of tox.ini to make sure people using your tox.ini use the correct version.
fix 359: add COMSPEC to default passenv on windows. Thanks
anthrotype.
add support for py36 and py37 and add py36-dev and py37(nightly) to
travis builds of tox. Thanks John Vandenberg.
fix 348: add py2 and py3 as default environments pointing to
"python2" and "python3" basepython executables. Also fix 347 by
updating the list of default envs in the tox basic example.
Thanks Tobias McNulty.
make "-h" and "--help-ini" options work even if there is no tox.ini,
thanks holger krekel.
add {:} substitution, which is replaced with os-specific path
separator, thanks Lukasz Rogalski.
fix 305: downloadcache test env config is now ignored as pip-8
does caching by default. Thanks holger krekel.
output from install command in verbose (-vv) mode is now printed to console instead of
being redirected to file, thanks Lukasz Rogalski
fix 399. Make sure {envtmpdir} is created if it doesn't exist at the
start of a testenvironment run. Thanks Manuel Jacob.
fix 316: Lack of commands key in ini file is now treated as an error.
Reported virtualenv status is 'nothing to do' instead of 'commands
succeeded', with relevant error message displayed. Thanks Lukasz Rogalski.
2.4.1
fix issue380: properly perform substitution again. Thanks Ian
Cordasco.
2.4.0
remove PYTHONPATH from environment during the install phase because a
tox-run should not have hidden dependencies and the test commands will also
not see a PYTHONPATH. If this causes unforeseen problems it may be
reverted in a bugfix release. Thanks Jason R. Coombs.
fix issue352: prevent a configuration where envdir==toxinidir and
refine docs to warn people about changing "envdir". Thanks Oliver Bestwalter and holger krekel.
fix issue375, fix issue330: warn against tox-setup.py integration as
"setup.py test" should really just test with the current interpreter. Thanks Ronny Pfannschmidt.
fix issue302: allow cross-testenv substitution where we substitute
with {x,y} generative syntax. Thanks Andrew Pashkin.
fix issue212: allow escaping curly brace chars "{" and "}" if you need the
chars "{" and "}" to appear in your commands or other ini values.
Thanks John Vandenberg.
addresses issue66: add --workdir option to override where tox stores its ".tox" directory
and all of the virtualenv environment. Thanks Danring.
introduce per-venv list_dependencies_command which defaults
to "pip freeze" to obtain the list of installed packages.
Thanks Ted Shaw, Holger Krekel.
close issue66: add documentation to jenkins page on how to avoid
"too long shebang" lines when calling pip from tox. Note that we
can not use "python -m pip install X" by default because the latter
adds the CWD and pip will think X is installed if it is there.
"pip install X" does not do that.
new list_dependencies_command to influence how tox determines
which dependencies are installed in a testenv.
(experimental) New feature: When a search for a config file fails, tox tries loading
setup.cfg with a section prefix of "tox".
fix issue275: Introduce hooks tox_runtest_pre``` and tox_runtest_post`` which run before and after the tests of a venv,
respectively. Thanks to Matthew Schinckel and itxaka serrano.
fix issue317: evaluate minversion before tox config is parsed completely.
Thanks Sachi King for the PR.
added the "extras" environment option to specify the extras to use when doing the
sdist or develop install. Contributed by Alex Grönholm.
use pytest-catchlog instead of pytest-capturelog (latter is not
maintained, uses deprecated pytest API)
2.3.2
fix issue314: fix command invocation with .py scripts on windows.
fix issue279: allow cross-section substitution when the value contains
posargs. Thanks Sachi King for the PR.
2.3.1
fix issue294: re-allow cross-section substitution for setenv.
2.3.0
DEPRECATE use of "indexservers" in tox.ini. It complicates
the internal code and it is recommended to rather use the
devpi system for managing indexes for pip.
fix issue285: make setenv processing fully lazy to fix regressions
of tox-2.2.X and so that we can now have testenv attributes like
"basepython" depend on environment variables that are set in
a setenv section. Thanks Nelfin for some tests and initial
work on a PR.
allow "" in commands. This is slightly incompatible with commands
sections that used a comment after a "\" line continuation.
Thanks David Stanek for the PR.
fix issue289: fix build_sphinx target, thanks Barry Warsaw.
fix issue252: allow environment names with special characters.
Thanks Julien Castets for initial PR and patience.
introduce experimental tox_testenv_create(venv, action) and
tox_testenv_install_deps(venv, action) hooks to allow
plugins to do additional work on creation or installing
deps. These hooks are experimental mainly because of
the involved "venv" and session objects whose current public
API is not fully guranteed.
internal: push some optional object creation into tests because
tox core doesn't need it.
2.2.1
fix bug where {envdir} substitution could not be used in setenv
if that env value is then used in {basepython}. Thanks Florian Bruhin.
2.2.0
fix issue265 and add LD_LIBRARY_PATH to passenv on linux by default
because otherwise the python interpreter might not start up in
certain configurations (redhat software collections). Thanks David Riddle.
fix issue246: fix regression in config parsing by reordering
such that {envbindir} can be used again in tox.ini. Thanks Olli Walsh.
fix issue99: the {env:...} substitution now properly uses environment
settings from the setenv section. Thanks Itxaka Serrano.
fix issue281: make --force-dep work when urls are present in
dependency configs. Thanks Glyph Lefkowitz for reporting.
fix issue174: add new ignore_outcome testenv attribute which
can be set to True in which case it will produce a warning instead
of an error on a failed testenv command outcome.
Thanks Rebecka Gulliksson for the PR.
fix issue280: properly skip missing interpreter if
{envsitepackagesdir} is present in commands. Thanks BB:ceridwenv
2.1.1
fix platform skipping for detox
report skipped platforms as skips in the summary
2.1.0
fix issue258, fix issue248, fix issue253: for non-test commands
(installation, venv creation) we pass in the full invocation environment.
remove experimental --set-home option which was hardly used and
hackily implemented (if people want home-directory isolation we should
figure out a better way to do it, possibly through a plugin)
fix issue259: passenv is now a line-list which allows to intersperse
comments. Thanks stefano-m.
allow envlist to be a multi-line list, to intersperse comments
and have long envlist settings split more naturally. Thanks Andre Caron.
introduce a TOX_TESTENV_PASSENV setting which is honored
when constructing the set of environment variables for test environments.
Thanks Marc Abramowitz for pushing in this direction.
2.0.2
fix issue247: tox now passes the LANG variable from the tox invocation
environment to the test environment by default.
add SYSTEMDRIVE into default passenv on windows to allow pip6 to work.
Thanks Michael Krause.
2.0.1
fix wheel packaging to properly require argparse on py26.
2.0.0
(new) introduce environment variable isolation:
tox now only passes the PATH and PIP_INDEX_URL variable from the tox
invocation environment to the test environment and on Windows
also SYSTEMROOT, PATHEXT, TEMP and TMP whereas
on unix additionally TMPDIR is passed. If you need to pass
through further environment variables you can use the new passenv setting,
a space-separated list of environment variable names. Each name
can make use of fnmatch-style glob patterns. All environment
variables which exist in the tox-invocation environment will be copied
to the test environment.
a new --help-ini option shows all possible testenv settings and
their defaults.
(new) introduce a way to specify on which platform a testenvironment is to
execute: the new per-venv "platform" setting allows to specify
a regular expression which is matched against sys.platform.
If platform is set and doesn't match the platform spec in the test
environment the test environment is ignored, no setup or tests are attempted.
(new) add per-venv "ignore_errors" setting, which defaults to False.
If True, a non-zero exit code from one command will be ignored and
further commands will be executed (which was the default behavior in tox <
2.0). If False (the default), then a non-zero exit code from one command
will abort execution of commands for that environment.
show and store in json the version dependency information for each venv
remove the long-deprecated "distribute" option as it has no effect these days.
fix issue233: avoid hanging with tox-setuptools integration example. Thanks simonb.
fix issue120: allow substitution for the commands section. Thanks
Volodymyr Vitvitski.
fix issue235: fix AttributeError with --installpkg. Thanks
Volodymyr Vitvitski.
tox has now somewhat pep8 clean code, thanks to Volodymyr Vitvitski.
fix issue240: allow to specify empty argument list without it being
rewritten to ".". Thanks Daniel Hahler.
introduce experimental (not much documented yet) plugin system
based on pytest's externalized "pluggy" system.
See tox/hookspecs.py for the current hooks.
introduce parser.add_testenv_attribute() to register an ini-variable
for testenv sections. Can be used from plugins through the
tox_add_option hook.
rename internal files -- tox offers no external API except for the
experimental plugin hooks, use tox internals at your own risk.
DEPRECATE distshare in documentation
1.9.2
backout ability that --force-dep substitutes name/versions in
requirement files due to various issues.
This fixes issue228, fixes issue230, fixes issue231
which popped up with 1.9.1.
1.9.1
use a file instead of a pipe for command output in "--result-json".
Fixes some termination issues with python2.6.
allow --force-dep to override dependencies in "-r" requirements
files. Thanks Sontek for the PR.
fix issue227: use "-m virtualenv" instead of "-mvirtualenv" to make
it work with pyrun. Thanks Marc-Andre Lemburg.
1.9.0
fix issue193: Remove --pre from the default install_command; by
default tox will now only install final releases from PyPI for unpinned
dependencies. Use pip_pre = true in a testenv or the --pre
command-line option to restore the previous behavior.
fix issue199: fill resultlog structure ahead of virtualenv creation
refine determination if we run from Jenkins, thanks Borge Lanes.
echo output to stdout when --report-json is used
fix issue11: add a skip_install per-testenv setting which
prevents the installation of a package. Thanks Julian Krause.
fix issue124: ignore command exit codes; when a command has a "-" prefix,
tox will ignore the exit code of that command
fix issue198: fix broken envlist settings, e.g. {py26,py27}{-lint,}
fix issue191: lessen factor-use checks
1.8.1
fix issue190: allow setenv to be empty.
allow escaping curly braces with "\". Thanks Marc Abramowitz for the PR.
allow "." names in environment names such that "py27-django1.7" is a
valid environment name. Thanks Alex Gaynor and Alex Schepanovski.
report subprocess exit code when execution fails. Thanks Marius
Gedminas.
1.8.0
new multi-dimensional configuration support. Many thanks to
Alexander Schepanovski for the complete PR with docs.
And to Mike Bayer and others for testing and feedback.
fix issue148: remove "__PYVENV_LAUNCHER__" from os.environ when starting
subprocesses. Thanks Steven Myint.
fix issue152: set VIRTUAL_ENV when running test commands,
thanks Florian Ludwig.
better report if we can't get version_info from an interpreter
executable. Thanks Floris Bruynooghe.
1.7.2
fix issue150: parse {posargs} more like we used to do it pre 1.7.0.
The 1.7.0 behaviour broke a lot of OpenStack projects.
See PR85 and the issue discussions for (far) more details, hopefully
resulting in a more refined behaviour in the 1.8 series.
And thanks to Clark Boylan for the PR.
fix issue59: add a config variable skip-missing-interpreters as well as
command line option --skip-missing-interpreters which won't fail the
build if Python interpreters listed in tox.ini are missing. Thanks
Alexandre Conrad for PR104.
fix issue164: better traceback info in case of failing test commands.
Thanks Marc Abramowitz for PR92.
support optional env variable substitution, thanks Morgan Fainberg
for PR86.
limit python hashseed to 1024 on Windows to prevent possible
memory errors. Thanks March Schlaich for the PR90.
1.7.1
fix issue162: don't list python 2.5 as compatibiliy/supported
fix issue158 and fix issue155: windows/virtualenv properly works now:
call virtualenv through "python -m virtualenv" with the same
interpreter which invoked tox. Thanks Chris Withers, Ionel Maries Cristian.
1.7.0
don't lookup "pip-script" anymore but rather just "pip" on windows
as this is a pip implementation detail and changed with pip-1.5.
It might mean that tox-1.7 is not able to install a different pip
version into a virtualenv anymore.
drop Python2.5 compatibility because it became too hard due
to the setuptools-2.0 dropping support. tox now has no
support for creating python2.5 based environments anymore
and all internal special-handling has been removed.
merged PR81: new option --force-dep which allows to
override tox.ini specified dependencies in setuptools-style.
For example "--force-dep 'django<1.6'" will make sure
that any environment using "django" as a dependency will
get the latest 1.5 release. Thanks Bruno Oliveria for
the complete PR.
merged PR125: tox now sets "PYTHONHASHSEED" to a random value
and offers a "--hashseed" option to repeat a test run with a specific seed.
You can also use --hashsheed=noset to instruct tox to leave the value
alone. Thanks Chris Jerdonek for all the work behind this.
fix issue132: removing zip_safe setting (so it defaults to false)
to allow installation of tox
via easy_install/eggs. Thanks Jenisys.
fix issue126: depend on virtualenv>=1.11.2 so that we can rely
(hopefully) on a pip version which supports --pre. (tox by default
uses to --pre). also merged in PR84 so that we now call "virtualenv"
directly instead of looking up interpreters. Thanks Ionel Maries Cristian.
This also fixes issue140.
fix issue130: you can now set install_command=easy_install {opts} {packages}
and expect it to work for repeated tox runs (previously it only worked
when always recreating). Thanks jenisys for precise reporting.
fix issue129: tox now uses Popen(..., universal_newlines=True) to force
creation of unicode stdout/stderr streams. fixes a problem on specific
platform configs when creating virtualenvs with Python3.3. Thanks
Jorgen Schäfer or investigation and solution sketch.
fix issue128: enable full substitution in install_command,
thanks for the PR to Ronald Evers
rework and simplify "commands" parsing and in particular posargs
substitutions to avoid various win32/posix related quoting issues.
make sure that the --installpkg option trumps any usedevelop settings
in tox.ini or
introduce --no-network to tox's own test suite to skip tests
requiring networks
introduce --sitepackages to force sitepackages=True in all
environments.
fix issue105 -- don't depend on an existing HOME directory from tox tests.
1.6.1
fix issue119: {envsitepackagesdir} is now correctly computed and has
a better test to prevent regression.
fix issue116: make 1.6 introduced behaviour of changing to a
per-env HOME directory during install activities dependent
on "--set-home" for now. Should re-establish the old behaviour
when no option is given.
fix issue118: correctly have two tests use realpath(). Thanks Barry
Warsaw.
fix test runs on environments without a home directory
(in this case we use toxinidir as the homedir)
fix issue117: python2.5 fix: don't use --insecure option because
its very existence depends on presence of "ssl". If you
want to support python2.5/pip1.3.1 based test environments you need
to install ssl and/or use PIP_INSECURE=1 through setenv. section.
fix issue102: change to {toxinidir} when installing dependencies.
this allows to use relative path like in "-rrequirements.txt".
1.6.0
fix issue35: add new EXPERIMENTAL "install_command" testenv-option to
configure the installation command with options for dep/pkg install.
Thanks Carl Meyer for the PR and docs.
fix issue91: python2.5 support by vendoring the virtualenv-1.9.1
script and forcing pip<1.4. Also the default [py25] environment
modifies the default installer_command (new config option)
to use pip without the "--pre" option which was introduced
with pip-1.4 and is now required if you want to install non-stable
releases. (tox defaults to install with "--pre" everywhere).
during installation of dependencies HOME is now set to a pseudo
location ({envtmpdir}/pseudo-home). If an index url was specified
a .pydistutils.cfg file will be written with an index_url setting
so that packages defining setup_requires dependencies will not
silently use your HOME-directory settings or https://pypi.python.org.
fix issue1: empty setup files are properly detected, thanks Anthon van
der Neuth
remove toxbootstrap.py for now because it is broken.
fix issue109 and fix issue111: multiple "-e" options are now combined
(previously the last one would win). Thanks Anthon van der Neut.
add --result-json option to write out detailed per-venv information
into a json report file to be used by upstream tools.
add new config options usedevelop and skipsdist as well as a
command line option --develop to install the package-under-test in develop mode.
thanks Monty Tailor for the PR.
always unset PYTHONDONTWRITEBYTE because newer setuptools doesn't like it
if a HOMEDIR cannot be determined, use the toxinidir.
refactor interpreter information detection to live in new
tox/interpreters.py file, tests in tests/test_interpreters.py.
1.5.0
fix issue104: use setuptools by default, instead of distribute,
now that setuptools has distribute merged.
make sure test commands are searched first in the virtualenv
re-fix issue2 - add whitelist_externals to be used in [testenv*]
sections, allowing to avoid warnings for commands such as make,
used from the commands value.
fix issue97 - allow substitutions to reference from other sections
(thanks Krisztian Fekete)
fix issue92 - fix {envsitepackagesdir} to actually work again
show (test) command that is being executed, thanks
Lukasz Balcerzak
re-license tox to MIT license
depend on virtualenv-1.9.1
rename README.txt to README.rst to make bitbucket happier
1.4.3
use pip-script.py instead of pip.exe on win32 to avoid the lock exe
file on execution issue (thanks Philip Thiem)
introduce -l|--listenv option to list configured environments
(thanks Lukasz Balcerzak)
fix downloadcache determination to work according to docs: Only
make pip use a download cache if PIP_DOWNLOAD_CACHE or a
downloadcache=PATH testenv setting is present. (The ENV setting
takes precedence)
fix issue84 - pypy on windows creates a bin not a scripts venv directory
(thanks Lukasz Balcerzak)
experimentally introduce --installpkg=PATH option to install a package
rather than create/install an sdist package. This will still require
and use tox.ini and tests from the current working dir (and not from the
remote package).
substitute {envsitepackagesdir} with the package installation
directory (closes 72) (thanks g2p)
issue 70 remove PYTHONDONTWRITEBYTECODE workaround now that
virtualenv behaves properly (thanks g2p)
merged tox-quickstart command, contributed by Marc Abramowitz, which
generates a default tox.ini after asking a few questions
fix 48 - win32 detection of pypy and other interpreters that are on PATH
(thanks Gustavo Picon)
fix grouping of index servers, it is now done by name instead of
indexserver url, allowing to use it to separate dependencies
into groups even if using the same default indexserver.
look for "tox.ini" files in parent dirs of current dir (closes 34)
the "py" environment now by default uses the current interpreter
(sys.executable) make tox' own setup.py test execute tests with it
(closes 46)
change tests to not rely on os.path.expanduser (closes 60),
also make mock session return args[1:] for more precise checking (closes 61)
thanks to Barry Warsaw for both.
1.4.2
fix some tests which fail if /tmp is a symlink to some other place
"python setup.py test" now runs tox tests via tox :)
also added an example on how to do it for your project.
1.4.1
fix issue41 better quoting on windows - you can now use "<" and ">" in
deps specifications, thanks Chris Withers for reporting
1.4
fix issue26 - no warnings on absolute or relative specified paths for commands
fix issue33 - commentchars are ignored in key-value settings allowing
for specifying commands like: python -c "import sys ; print sys"
which would formerly raise irritating errors because the ";"
was considered a comment
tweak and improve reporting
refactor reporting and virtualenv manipulation
to be more accessible from 3rd party tools
support value substitution from other sections
with the {[section]key} syntax
fix issue29 - correctly point to pytest explanation
for importing modules fully qualified
fix issue32 - use --system-site-packages and don't pass --no-site-packages
add python3.3 to the default env list, so early adopters can test
drop python2.4 support (you can still have your tests run on
fix the links/checkout howtos in the docs
python-2.4, just tox itself requires 2.5 or higher.
1.3
fix: allow to specify wildcard filesystem paths when
specifying dependencies such that tox searches for
the highest version
fix issue issue21: clear PIP_REQUIRES_VIRTUALENV which avoids
pip installing to the wrong environment, thanks to bb's streeter
make the install step honour a testenv's setenv setting
(thanks Ralf Schmitt)
1.2
remove the virtualenv.py that was distributed with tox and depend
on >=virtualenv-1.6.4 (possible now since the latter fixes a few bugs
that the inlining tried to work around)
fix issue10: work around UnicodeDecodeError when invoking pip (thanks
Marc Abramowitz)
fix a problem with parsing {posargs} in tox commands (spotted by goodwill)
fix the warning check for commands to be installed in testenvironment
(thanks Michael Foord for reporting)
1.1
fix issue5 - don't require argparse for python versions that have it
fix issue6 - recreate virtualenv if installing dependencies failed
fix issue3 - fix example on frontpage
fix issue2 - warn if a test command does not come from the test
environment
fixed/enhanced: except for initial install always call "-U
--no-deps" for installing the sdist package to ensure that a package
gets upgraded even if its version number did not change. (reported on
TIP mailing list and IRC)
inline virtualenv.py (1.6.1) script to avoid a number of issues,
particularly failing to install python3 environments from a python2
virtualenv installation.
rework and enhance docs for display on readthedocs.org
fix issue7: introduce a "minversion" directive such that tox
bails out if it does not have the correct version.
fix issue24: introduce a way to set environment variables for
for test commands (thanks Chris Rose)
fix issue22: require virtualenv-1.6.1, obsoleting virtualenv5 (thanks Jannis Leidel)
and making things work with pypy-1.5 and python3 more seamlessly
toxbootstrap.py (used by jenkins build slaves) now follows the latest release of virtualenv
fix issue20: document format of URLs for specifying dependencies
fix issue19: substitute Hudson for Jenkins everywhere following the renaming
of the project. NOTE: if you used the special [tox:hudson]
section it will now need to be named [tox:jenkins].
fix issue 23 / apply some ReST fixes
change the positional argument specifier to use {posargs:} syntax and
fix issues 15 and 10 by refining the argument parsing method (Chris Rose)
remove use of inipkg lazy importing logic -
the namespace/imports are anyway very small with tox.
fix a fspath related assertion to work with debian installs which uses
symlinks
show path of the underlying virtualenv invocation and bootstrap
virtualenv.py into a working subdir
added a CONTRIBUTORS file
0.9
fix pip-installation mixups by always unsetting PIP_RESPECT_VIRTUALENV
(thanks Armin Ronacher)
issue1: Add a toxbootstrap.py script for tox, thanks to Sridhar
Ratnakumar
added support for working with different and multiple PyPI indexservers.
new option: -r|--recreate to force recreation of virtualenv
depend on py>=1.4.0 which does not contain or install the py.test
anymore which is now a separate distribution "pytest".
show logfile content if there is an error (makes CI output
more readable)
0.8
work around a virtualenv limitation which crashes if
PYTHONDONTWRITEBYTECODE is set.
run pip/easy installs from the environment log directory, avoids
naming clashes between env names and dependencies (thanks ronny)
require a more recent version of py lib
refactor and refine config detection to work from a single file
and to detect the case where a python installation overwrote
an old one and resulted in a new executable. This invalidates
the existing virtualenvironment now.
change all internal source to strip trailing whitespaces
0.7
use virtualenv5 (my own fork of virtualenv3) for now to create python3
environments, fixes a couple of issues and makes tox more likely to
work with Python3 (on non-windows environments)
add sitepackages option for testenv sections so that environments
can be created with access to globals (default is not to have access,
i.e. create environments with --no-site-packages.
addressing issue4: always prepend venv-path to PATH variable when calling subprocesses
fix issue2: exit with proper non-zero return code if there were
errors or test failures.
added unittest2 examples contributed by Michael Foord
only allow 'True' or 'False' for boolean config values
(lowercase / uppercase is irrelevant)
recreate virtualenv on changed configurations
0.6
fix OSX related bugs that could cause the caller's environment to get
screwed (sorry). tox was using the same file as virtualenv for tracking
the Python executable dependency and there also was confusion wrt links.
this should be fixed now.
fix long description, thanks Michael Foord
0.5
initial release
pytest -> 3.0.7
3.0.7
==================
Fix issue in assertion rewriting breaking due to modules silently discarding
other modules when importing fails
Notably, importing the anydbm module is fixed. (2248).
Thanks pfhayes for the PR.
junitxml: Fix problematic case where system-out tag occured twice per testcase
element in the XML report. Thanks kkoukiou_ for the PR.
Fix regression, pytest now skips unittest correctly if run with --pdb
(2137). Thanks to gst for the report and mbyt_ for the PR.
Ignore exceptions raised from descriptors (e.g. properties) during Python test collection (2234).
Thanks to bluetech.
--override-ini now correctly overrides some fundamental options like python_files (2238).
Thanks sirex for the report and nicoddemus_ for the PR.
Replace raise StopIteration usages in the code by simple returns to finish generators, in accordance to PEP-479 (2160).
Thanks tgoodlet for the report and nicoddemus for the PR.
Fix internal errors when an unprintable AssertionError is raised inside a test.
Thanks omerhadari_ for the PR.
Skipping plugin now also works with test items generated by custom collectors (2231).
Thanks to vidartf.
Fix trailing whitespace in console output if no .ini file presented (2281). Thanks fbjorn for the PR.
Conditionless xfail markers no longer rely on the underlying test item
being an instance of PyobjMixin, and can therefore apply to tests not
collected by the built-in python test collector. Thanks barneygale_ for the
PR.
pytest no longer generates PendingDeprecationWarning from its own operations, which was introduced by mistake in version 3.0.5 (2118).
Thanks to nicoddemus for the report and RonnyPfannschmidt_ for the PR.
pytest no longer recognizes coroutine functions as yield tests (2129).
Thanks to malinoff for the PR.
Plugins loaded by the PYTEST_PLUGINS environment variable are now automatically
considered for assertion rewriting (2185).
Thanks nicoddemus for the PR.
Improve error message when pytest.warns fails (2150). The type(s) of the
expected warnings and the list of caught warnings is added to the
error message. Thanks lesteve for the PR.
Fix pytester internal plugin to work correctly with latest versions of
zope.interface (1989). Thanks nicoddemus for the PR.
Assert statements of the pytester plugin again benefit from assertion rewriting (1920).
Thanks RonnyPfannschmidt for the report and nicoddemus_ for the PR.
Specifying tests with colons like test_foo.py::test_bar for tests in
subdirectories with ini configuration files now uses the correct ini file
(2148). Thanks pelme.
Fail testdir.runpytest().assert_outcomes() explicitly if the pytest
terminal output it relies on is missing. Thanks to eli-b_ for the PR.
Add warning when not passing option=value correctly to -o/--override-ini (2105).
Also improved the help documentation. Thanks to mbukatov for the report and
lwm_ for the PR.
Now --confcutdir and --junit-xml are properly validated if they are directories
and filenames, respectively (2089 and 2078). Thanks to lwm_ for the PR.
Add hint to error message hinting possible missing __init__.py (478). Thanks DuncanBetts.
More accurately describe when fixture finalization occurs in documentation (687). Thanks DuncanBetts.
Provide :ref: targets for recwarn.rst so we can use intersphinx referencing.
Thanks to dupuy for the report and lwm for the PR.
In Python 2, use a simple +- ASCII string in the string representation of pytest.approx (for example "4 +- 4.0e-06")
because it is brittle to handle that in different contexts and representations internally in pytest
which can result in bugs such as 2111. In Python 3, the representation still uses ± (for example 4 ± 4.0e-06).
Thanks kerrick-lyft for the report and nicoddemus_ for the PR.
Using item.Function, item.Module, etc., is now issuing deprecation warnings, prefer
pytest.Function, pytest.Module, etc., instead (2034).
Thanks nmundar for the PR.
Fix error message using approx with complex numbers (2082).
Thanks adler-j for the report and nicoddemus_ for the PR.
Fixed false-positives warnings from assertion rewrite hook for modules imported more than
once by the pytest_plugins mechanism.
Thanks nicoddemus_ for the PR.
Remove an internal cache which could cause hooks from conftest.py files in
sub-directories to be called in other directories incorrectly (2016).
Thanks d-b-w for the report and nicoddemus_ for the PR.
Remove internal code meant to support earlier Python 3 versions that produced the side effect
of leaving None in sys.modules when expressions were evaluated by pytest (for example passing a condition
as a string to pytest.mark.skipif)(2103).
Thanks jaraco for the report and nicoddemus_ for the PR.
Cope gracefully with a .pyc file with no matching .py file (2038). Thanks
nedbat.
Import errors when collecting test modules now display the full traceback (1976).
Thanks cwitty for the report and nicoddemus_ for the PR.
Fix confusing command-line help message for custom options with two or more metavar properties (2004).
Thanks okulynyak and davehunt for the report and nicoddemus for the PR.
When loading plugins, import errors which contain non-ascii messages are now properly handled in Python 2 (1998).
Thanks nicoddemus for the PR.
Fixed cyclic reference when pytest.raises is used in context-manager form (1965_). Also as a
result of this fix, sys.exc_info() is left empty in both context-manager and function call usages.
Previously, sys.exc_info would contain the exception caught by the context manager,
even when the expected exception occurred.
Thanks MSeifert04_ for the report and the PR.
Fixed false-positives warnings from assertion rewrite hook for modules that were rewritten but
were later marked explicitly by pytest.register_assert_rewrite
or implicitly as a plugin (2005).
Thanks RonnyPfannschmidt for the report and nicoddemus_ for the PR.
Report teardown output on test failure (442).
Thanks matclab for the PR.
Fix teardown error message in generated xUnit XML.
Thanks gdyuldin_ for the PR.
Properly handle exceptions in multiprocessing tasks (1984).
Thanks adborden for the report and nicoddemus_ for the PR.
Clean up unittest TestCase objects after tests are complete (1649_).
Thanks d_b_w_ for the report and PR.
Improve error message when passing non-string ids to pytest.mark.parametrize (1857).
Thanks okken for the report and nicoddemus_ for the PR.
Add buffer attribute to stdin stub class pytest.capture.DontReadFromInput
Thanks joguSD_ for the PR.
Fix UnicodeEncodeError when string comparison with unicode has failed. (1864)
Thanks AiOO for the PR.
pytest_plugins is now handled correctly if defined as a string (as opposed as
a sequence of strings) when modules are considered for assertion rewriting.
Due to this bug, much more modules were being rewritten than necessary
if a test suite uses pytest_plugins to load internal plugins (1888).
Thanks jaraco for the report and nicoddemus for the PR (1891).
Do not call tearDown and cleanups when running tests from
unittest.TestCase subclasses with --pdb
enabled. This allows proper post mortem debugging for all applications
which have significant logic in their tearDown machinery (1890). Thanks
mbyt for the PR.
Fix use of deprecated getfuncargvalue method in the internal doctest plugin.
Thanks ViviCoder for the report (1898).
Fix regression when importorskip is used at module level (1822).
Thanks jaraco and The-Compiler for the report and nicoddemus for the PR.
Fix parametrization scope when session fixtures are used in conjunction
with normal parameters in the same call (1832).
Thanks The-Compiler for the report, Kingdread and nicoddemus for the PR.
Fix internal error when parametrizing tests or fixtures using an empty ids argument (1849).
Thanks OPpuolitaival for the report and nicoddemus_ for the PR.
Fix loader error when running pytest embedded in a zipfile.
Thanks mbachry_ for the PR.
A number of incompatible changes were made in this release, with the intent of removing features deprecated for a long
time or change existing behaviors in order to make them less surprising/more useful.
Reinterpretation mode has now been removed. Only plain and rewrite
mode are available, consequently the --assert=reinterp option is
no longer available. This also means files imported from plugins or
conftest.py will not benefit from improved assertions by
default, you should use pytest.register_assert_rewrite() to
explicitly turn on assertion rewriting for those files. Thanks
flub_ for the PR.
The following deprecated commandline options were removed:
--genscript: no longer supported;
--no-assert: use --assert=plain instead;
--nomagic: use --assert=plain instead;
--report: use -r instead;
Thanks to RedBeardCode for the PR (1664).
ImportErrors in plugins now are a fatal error instead of issuing a
pytest warning (1479). Thanks to The-Compiler for the PR.
Removed support code for Python 3 versions < 3.3 (1627_).
Removed all py.test-X* entry points. The versioned, suffixed entry points
were never documented and a leftover from a pre-virtualenv era. These entry
points also created broken entry points in wheels, so removing them also
removes a source of confusion for users (1632).
Thanks obestwalter for the PR.
pytest.skip() now raises an error when used to decorate a test function,
as opposed to its original intent (to imperatively skip a test inside a test function). Previously
this usage would cause the entire module to be skipped (607).
Thanks omarkohl for the complete PR (1519_).
Exit tests if a collection error occurs. A poll indicated most users will hit CTRL-C
anyway as soon as they see collection errors, so pytest might as well make that the default behavior (1421).
A --continue-on-collection-errors option has been added to restore the previous behaviour.
Thanks olegpidsadnyi and omarkohl for the complete PR (1628).
Renamed the pytest pdb module (plugin) into debugging to avoid clashes with the builtin pdb module.
Raise a helpful failure message when requesting a parametrized fixture at runtime,
e.g. with request.getfixturevalue. Previously these parameters were simply
never defined, so a fixture decorated like pytest.fixture(params=[0, 1, 2])
only ran once (460).
Thanks to nikratio for the bug report, RedBeardCode and tomviner for the PR.
_pytest.monkeypatch.monkeypatch class has been renamed to _pytest.monkeypatch.MonkeyPatch
so it doesn't conflict with the monkeypatch fixture.
--exitfirst / -x can now be overridden by a following --maxfail=N
and is just a synonym for --maxfail=1.
New Features
Support nose-style __test__ attribute on methods of classes,
including unittest-style Classes. If set to False, the test will not be
collected.
New doctest_namespace fixture for injecting names into the
namespace in which doctests run.
Thanks milliams for the complete PR (1428).
New --doctest-report option available to change the output format of diffs
when running (failing) doctests (implements 1749).
Thanks hartym for the PR.
New name argument to pytest.fixture decorator which allows a custom name
for a fixture (to solve the funcarg-shadowing-fixture problem).
Thanks novas0x2a for the complete PR (1444).
New approx() function for easily comparing floating-point numbers in
tests.
Thanks kalekundert for the complete PR (1441).
Ability to add global properties in the final xunit output file by accessing
the internal junitxml plugin (experimental).
Thanks tareqalayan for the complete PR 1454).
New ExceptionInfo.match() method to match a regular expression on the
string representation of an exception (372).
Thanks omarkohl for the complete PR (1502_).
__tracebackhide__ can now also be set to a callable which then can decide
whether to filter the traceback based on the ExceptionInfo object passed
to it. Thanks The-Compiler for the complete PR (1526).
New pytest_make_parametrize_id(config, val) hook which can be used by plugins to provide
friendly strings for custom types.
Thanks palaviv_ for the PR.
capsys and capfd now have a disabled() context-manager method, which
can be used to temporarily disable capture within a test.
Thanks nicoddemus_ for the PR.
New cli flag --fixtures-per-test: shows which fixtures are being used
for each selected test item. Features doc strings of fixtures by default.
Can also show where fixtures are defined if combined with -v.
Thanks hackebrot_ for the PR.
Introduce pytest command as recommended entry point. Note that py.test
still works and is not scheduled for removal. Closes proposal
1629. Thanks obestwalter and davehunt for the complete PR
(1633).
New cli flags:
--setup-plan: performs normal collection and reports
the potential setup and teardown and does not execute any fixtures and tests;
--setup-only: performs normal collection, executes setup and teardown of
fixtures and reports them;
--setup-show: performs normal test execution and additionally shows
setup and teardown of fixtures;
--keep-duplicates: py.test now ignores duplicated paths given in the command
line. To retain the previous behavior where the same test could be run multiple
times by specifying it in the command-line multiple times, pass the --keep-duplicates
argument (1609_);
Thanks d6e, kvas-it, sallner, ioggstream and omarkohl_ for the PRs.
New CLI flag --override-ini/-o: overrides values from the ini file.
For example: "-o xfail_strict=True"'.
Thanks blueyed and fengxx for the PR.
pytest_fixture_post_finalizer(fixturedef): called after the fixture's
finalizer and has access to the fixture's result cache.
Thanks d6e, sallner.
Issue warnings for asserts whose test is a tuple literal. Such asserts will
never fail because tuples are always truthy and are usually a mistake
(see 1562). Thanks kvas-it, for the PR.
Allow passing a custom debugger class (e.g. --pdbcls=IPython.core.debugger:Pdb).
Thanks to anntzer_ for the PR.
Changes
Plugins now benefit from assertion rewriting. Thanks
sober7, nicoddemus and flub_ for the PR.
Change report.outcome for xpassed tests to "passed" in non-strict
mode and "failed" in strict mode. Thanks to hackebrot for the PR
(1795) and gprasad84 for report (1546).
Tests marked with xfail(strict=False) (the default) now appear in
JUnitXML reports as passing tests instead of skipped.
Thanks to hackebrot for the PR (1795).
Highlight path of the file location in the error report to make it easier to copy/paste.
Thanks suzaku for the PR (1778).
Fixtures marked with pytest.fixture can now use yield statements exactly like
those marked with the pytest.yield_fixture decorator. This change renders
pytest.yield_fixture deprecated and makes pytest.fixture with yield statements
the preferred way to write teardown code (1461).
Thanks csaftoiu for bringing this to attention and nicoddemus_ for the PR.
Explicitly passed parametrize ids do not get escaped to ascii (1351).
Thanks ceridwen for the PR.
Fixtures are now sorted in the error message displayed when an unknown
fixture is declared in a test function.
Thanks nicoddemus_ for the PR.
pytest_terminal_summary hook now receives the exitstatus
of the test session as argument. Thanks blueyed for the PR (1809).
Parametrize ids can accept None as specific test id, in which case the
automatically generated id for that argument will be used.
Thanks palaviv for the complete PR (1468).
The parameter to xunit-style setup/teardown methods (setup_method,
setup_module, etc.) is now optional and may be omitted.
Thanks okken for bringing this to attention and nicoddemus for the PR.
Improved automatic id generation selection in case of duplicate ids in
parametrize.
Thanks palaviv for the complete PR (1474).
Now pytest warnings summary is shown up by default. Added a new flag
--disable-pytest-warnings to explicitly disable the warnings summary (1668_).
Make ImportError during collection more explicit by reminding
the user to check the name of the test module/package(s) (1426).
Thanks omarkohl for the complete PR (1520_).
Add build/ and dist/ to the default --norecursedirs list. Thanks
mikofski for the report and tomviner for the PR (1544_).
pytest.raises in the context manager form accepts a custom
message to raise when no exception occurred.
Thanks palaviv for the complete PR (1616).
conftest.py files now benefit from assertion rewriting; previously it
was only available for test modules. Thanks flub, sober7 and
nicoddemus for the PR (1619).
Text documents without any doctests no longer appear as "skipped".
Thanks graingert for reporting and providing a full PR (1580).
Ensure that a module within a namespace package can be found when it
is specified on the command line together with the --pyargs
option. Thanks to taschini for the PR (1597).
Always include full assertion explanation during assertion rewriting. The previous behaviour was hiding
sub-expressions that happened to be False, assuming this was redundant information.
Thanks bagerard for reporting (1503). Thanks to davehunt and
tomviner for the PR.
OptionGroup.addoption() now checks if option names were already
added before, to make it easier to track down issues like 1618_.
Before, you only got exceptions later from argparse library,
giving no clue about the actual reason for double-added options.
yield-based tests are considered deprecated and will be removed in pytest-4.0.
Thanks nicoddemus_ for the PR.
[pytest] sections in setup.cfg files should now be named [tool:pytest]
to avoid conflicts with other distutils commands (see 567). [pytest] sections in
pytest.ini or tox.ini files are supported and unchanged.
Thanks nicoddemus for the PR.
Using pytest_funcarg__ prefix to declare fixtures is considered deprecated and will be
removed in pytest-4.0 (1684).
Thanks nicoddemus for the PR.
Passing a command-line string to pytest.main() is considered deprecated and scheduled
for removal in pytest-4.0. It is recommended to pass a list of arguments instead (1723_).
Rename getfuncargvalue to getfixturevalue. getfuncargvalue is
still present but is now considered deprecated. Thanks to RedBeardCode and tomviner
for the PR (1626_).
optparse type usage now triggers DeprecationWarnings (1740_).
Refined logic for determining the rootdir, considering only valid
paths which fixes a number of issues: 1594, 1435 and 1471.
Updated the documentation according to current behavior. Thanks to
blueyed, davehunt and matthiasha for the PR.
Always include full assertion explanation. The previous behaviour was hiding
sub-expressions that happened to be False, assuming this was redundant information.
Thanks bagerard for reporting (1503). Thanks to davehunt and
tomviner for PR.
Better message in case of not using parametrized variable (see 1539).
Thanks to tramwaj29 for the PR.
Updated docstrings with a more uniform style.
Add stderr write for pytest.exit(msg) during startup. Previously the message was never shown.
Thanks BeyondEvil for reporting 1210. Thanks to JonathonSonesen and
tomviner for the PR.
No longer display the incorrect test deselection reason (1372).
Thanks ronnypfannschmidt for the PR.
The --resultlog command line option has been deprecated: it is little used
and there are more modern and better alternatives (see 830).
Thanks nicoddemus for the PR.
Improve error message with fixture lookup errors: add an 'E' to the first
line and '>' to the rest. Fixes 717. Thanks blueyed for reporting and
a PR, eolo999 for the initial PR and tomviner for his guidance during
EuroPython2016 sprint.
Bug Fixes
Parametrize now correctly handles duplicated test ids.
Fix internal error issue when the method argument is missing for
teardown_method() (1605_).
Fix exception visualization in case the current working directory (CWD) gets
deleted during testing (1235). Thanks bukzor for reporting. PR by
marscher_.
Improve test output for logical expression with brackets (925).
Thanks DRMacIver for reporting and RedBeardCode_ for the PR.
Create correct diff for strings ending with newlines (1553).
Thanks Vogtinator for reporting and RedBeardCode and
tomviner for the PR.
ConftestImportFailure now shows the traceback making it easier to
identify bugs in conftest.py files (1516). Thanks txomon for
the PR.
Text documents without any doctests no longer appear as "skipped".
Thanks graingert for reporting and providing a full PR (1580).
Fixed collection of classes with custom __new__ method.
Fixes 1579. Thanks to Stranger6667 for the PR.
Fixed scope overriding inside metafunc.parametrize (634).
Thanks to Stranger6667 for the PR.
Fixed the total tests tally in junit xml output (1798).
Thanks to cryporchild for the PR.
Fixed off-by-one error with lines from request.node.warn.
Thanks to blueyed_ for the PR.
Updates
Here's a list of all the updates bundled in this pull request. I've added some links to make it easier for you to find all the information you need.
Changelogs
tox -> 2.6.0
pytest -> 3.0.7