See also
In general, pytest is invoked with the command pytest (see below for other ways to invoke pytest). This will execute all tests in all files whose names follow the form test_*.py or *_test.pyin the current directory and its subdirectories. More generally, pytest follows standard test discovery rules.
Specifying which tests to run¶
Pytest supports several ways to run and select tests from the command-line.
Run tests in a module
You've written some unit tests for your Python app. There are dozens of us, dozens! You don't always remember to run your tests, or worse, your colleagues don't always remember to run them. Wouldn't it be nice to automatically run unit tests on every commit to GitHub? What about on every pull request? You can do this with GitHub. May 19, 2021 Set permanent options for the py.test run (like addopts or pep8ignore) in the pytest section of pytest.ini or tox.ini or put them in the tool:pytest section of setup.cfg. See pytest issue 567. Optionally, set test=pytest in the aliases section of setup.cfg to cause python setup.py test to invoke pytest. Python Test Explorer for Visual Studio Code. This extension allows you to run your Python Unittest, Pytest or Testplan tests with the Test Explorer UI. Getting started. Install the extension. Write and run Python code using our online compiler (interpreter). You can use Python Shell like IDLE, and take inputs from the user in our Python compiler.
Run tests in a directory
Run tests by keyword expressions
This will run tests which contain names that match the given string expression (case-insensitive),which can include Python operators that use filenames, class names and function names as variables.The example above will run TestMyClass.test_something but not TestMyClass.test_method_simple.
Run tests by node ids
Each collected test is assigned a unique nodeid which consist of the module filename followedby specifiers like class names, function names and parameters from parametrization, separated by :: characters.
To run a specific test within a module:
Another example specifying a test method in the command line:
Run tests by marker expressions
Will run all tests which are decorated with the @pytest.mark.slow decorator.
For more information see marks.
Run tests from packages
This will import pkg.testing and use its filesystem location to find and run tests from.
Getting help on version, option names, environment variables¶
Profiling test execution duration¶
To get a list of the slowest 10 test durations over 1.0s long:
By default, pytest will not show test durations that are too small (<0.005s) unless -vv is passed on the command-line.
Managing loading of plugins¶
Early loading plugins¶
You can early-load plugins (internal and external) explicitly in the command-line with the -p option:
The option receives a name parameter, which can be:
A full module dotted name, for example
myproject.plugins. This dotted name must be importable.The entry-point name of a plugin. This is the name passed to
setuptoolswhen the plugin isregistered. For example to early-load the pytest-cov plugin you can use:
Disabling plugins¶
To disable loading specific plugins at invocation time, use the -p optiontogether with the prefix no:.
Example: to disable loading the plugin doctest, which is responsible forexecuting doctest tests from text files, invoke pytest like this:
Other ways of calling pytest¶
Calling pytest through python-mpytest¶
You can invoke testing through the Python interpreter from the command line:
This is almost equivalent to invoking the command line script pytest[...]directly, except that calling via python will also add the current directory to sys.path.
Python Interpreter
Calling pytest from Python code¶
You can invoke pytest from Python code directly:
Python Test Runner Function
this acts as if you would call “pytest” from the command line.It will not raise SystemExit but return the exit code instead.You can pass in options and arguments:
You can specify additional plugins to pytest.main:
Running it will show that MyPlugin was added and itshook was invoked:
Note
Xml Test Runner Python
Calling pytest.main() will result in importing your tests and any modulesthat they import. Due to the caching mechanism of python’s import system,making subsequent calls to pytest.main() from the same process will notreflect changes to those files between the calls. For this reason, makingmultiple calls to pytest.main() from the same process (in order to re-runtests, for example) is not recommended.