2010-07-27 03:15:15 +08:00
basic test configuration
2009-08-19 01:04:57 +08:00
===================================
2010-11-01 00:41:58 +08:00
Command line options and configuration file settings
-----------------------------------------------------------------
2009-08-19 01:04:57 +08:00
2010-11-01 00:41:58 +08:00
You can get help on options and configuration options by running::
2009-08-19 01:04:57 +08:00
2010-11-01 00:41:58 +08:00
py.test -h # prints options _and_ config file settings
2009-08-19 01:04:57 +08:00
2010-11-01 00:41:58 +08:00
This will display command line and configuration file settings
which were registered by installed plugins.
2009-08-19 01:04:57 +08:00
2010-11-01 00:41:58 +08:00
how test configuration is read from setup/tox ini-files
2010-10-28 01:35:27 +08:00
--------------------------------------------------------
2010-11-01 00:41:58 +08:00
py.test looks for the first ``[pytest]`` section in either the first ``setup.cfg`` or the first ``tox.ini`` file found upwards from the arguments. Example::
2010-10-28 01:35:27 +08:00
2010-11-01 00:41:58 +08:00
py.test path/to/testdir
2010-10-28 01:35:27 +08:00
2010-11-01 00:41:58 +08:00
will look in the following dirs for a config file::
2010-10-28 01:35:27 +08:00
2010-11-01 00:41:58 +08:00
path/to/testdir/setup.cfg
path/to/setup.cfg
path/setup.cfg
setup.cfg
... # up until root of filesystem
path/to/testdir/tox.ini
path/to/tox.ini
path/tox.ini
... # up until root of filesystem
2010-10-28 01:35:27 +08:00
2010-11-01 00:41:58 +08:00
If no path was provided at all the current working directory is used for the lookup.
2010-10-28 01:35:27 +08:00
2010-11-01 00:41:58 +08:00
builtin configuration file options
----------------------------------------------
2010-10-28 01:35:27 +08:00
2010-11-01 00:41:58 +08:00
.. confval:: minversion = VERSTRING
2010-10-28 01:35:27 +08:00
2010-11-01 00:41:58 +08:00
specifies the minimal pytest version that is needed for this test suite.
2009-08-19 01:04:57 +08:00
2010-11-01 00:41:58 +08:00
minversion = 2.1 # will fail if we run with pytest-2.0
2009-08-19 01:04:57 +08:00
2010-11-01 15:55:14 +08:00
.. confval:: addopts = OPTS
2009-08-19 01:04:57 +08:00
2010-11-01 00:41:58 +08:00
add the specified ``OPTS`` to the set of command line arguments as if they
had been specified by the user. Example: if you have this ini file content::
2009-08-19 01:04:57 +08:00
2010-11-01 00:41:58 +08:00
[pytest]
2010-11-01 15:55:14 +08:00
addopts = --maxfail=2 -rf # exit after 2 failures, report fail info
2009-08-19 01:04:57 +08:00
2010-11-01 00:41:58 +08:00
issuing ``py.test test_hello.py`` actually means::
2009-08-19 21:45:01 +08:00
2010-11-01 00:41:58 +08:00
py.test --maxfail=2 -rf test_hello.py
2009-08-19 01:04:57 +08:00
.. _`function arguments`: funcargs.html
2010-10-14 00:45:07 +08:00