Fix docs (tox -e regen, plus pre-commit)

LoggingPlugin: Support to customize log_file from hook

.coveragerc

@@ -1,4 +1,9 @@
 [run]
-source = _pytest,testing
+source = pytest,_pytest,testing/
 parallel = 1
 branch = 1
+
+[paths]
+source = src/
+  .tox/*/lib/python*/site-packages/
+  .tox\*\Lib\site-packages\

.gitattributes

@@ -1 +1 @@
-CHANGELOG    merge=union
+*.bat  text eol=crlf

.github/PULL_REQUEST_TEMPLATE.md

@@ -3,7 +3,7 @@ Thanks for submitting a PR, your contribution is really appreciated!
 Here's a quick checklist that should be present in PRs (you can delete this text from the final description, this is
 just a guideline):
 
-- [ ] Create a new changelog file in the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](/changelog/README.rst) for details.
+- [ ] Create a new changelog file in the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](https://github.com/pytest-dev/pytest/blob/master/changelog/README.rst) for details.
 - [ ] Target the `master` branch for bug fixes, documentation updates and trivial changes.
 - [ ] Target the `features` branch for new features and removals/deprecations.
 - [ ] Include documentation when adding new features.

.github/config.yml

@@ -0,0 +1,2 @@
+rtd:
+  project: pytest

.gitignore

@@ -24,6 +24,7 @@ src/_pytest/_version.py
 .eggs/
 
 doc/*/_build
+doc/*/.doctrees
 build/
 dist/
 *.egg-info
@@ -35,9 +36,15 @@ env/
 .cache
 .pytest_cache
 .coverage
+.coverage.*
+coverage.xml
 .ropeproject
 .idea
 .hypothesis
 .pydevproject
 .project
 .settings
+.vscode
+
+# generated by pip
+pip-wheel-metadata/

.pre-commit-config.yaml

@@ -1,32 +1,43 @@
 exclude: doc/en/example/py2py3/test_py2.py
 repos:
 -   repo: https://github.com/ambv/black
-    rev: 18.6b4
+    rev: 18.9b0
     hooks:
     -   id: black
         args: [--safe, --quiet]
         language_version: python3
 -   repo: https://github.com/asottile/blacken-docs
-    rev: v0.2.0
+    rev: v0.3.0
     hooks:
     -   id: blacken-docs
-        additional_dependencies: [black==18.6b4]
+        additional_dependencies: [black==18.9b0]
         language_version: python3
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v1.3.0
+    rev: v2.1.0
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
     -   id: check-yaml
     -   id: debug-statements
         exclude: _pytest/debugging.py
-    -   id: flake8
--   repo: https://github.com/asottile/pyupgrade
-    rev: v1.2.0
+        language_version: python3
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.0
     hooks:
-    - id: pyupgrade
+    -   id: flake8
+        language_version: python3
+-   repo: https://github.com/asottile/reorder_python_imports
+    rev: v1.3.5
+    hooks:
+    -   id: reorder-python-imports
+        args: ['--application-directories=.:src']
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v1.11.1
+    hooks:
+    -   id: pyupgrade
+        args: [--keep-percent-format]
 -   repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.0.0
+    rev: v1.2.0
     hooks:
     -   id: rst-backticks
 -   repo: local
@@ -38,7 +49,22 @@ repos:
         language: python
         additional_dependencies: [pygments, restructuredtext_lint]
     -   id: changelogs-rst
-        name: changelog files must end in .rst
-        entry: ./scripts/fail
-        language: script
-        files: 'changelog/.*(?<!\.rst)$'
+        name: changelog filenames
+        language: fail
+        entry: 'changelog files must be named ####.(feature|bugfix|doc|deprecation|removal|vendor|trivial).rst'
+        exclude: changelog/(\d+\.(feature|bugfix|doc|deprecation|removal|vendor|trivial).rst|README.rst|_template.rst)
+        files: ^changelog/
+    -   id: py-deprecated
+        name: py library is deprecated
+        language: pygrep
+        entry: >
+            (?x)\bpy\.(
+                _code\.|
+                builtin\.|
+                code\.|
+                io\.(BytesIO|saferepr)|
+                path\.local\.sysfind|
+                process\.|
+                std\.
+            )
+        types: [python]

.travis.yml

@@ -1,5 +1,5 @@
-sudo: false
 language: python
+dist: xenial
 stages:
 - baseline
 - name: test
@@ -7,40 +7,39 @@ stages:
 - name: deploy
   if: repo = pytest-dev/pytest AND tag IS present
 python:
-  - '3.6'
+  - '3.7'
 install:
   - pip install --upgrade --pre tox
 env:
   matrix:
-    # note: please use "tox --listenvs" to populate the build matrix below
-    # please remove the linting env in all cases
-    - TOXENV=py27-pexpect
-    - TOXENV=py27-xdist
-    - TOXENV=py27-trial
-    - TOXENV=py27-numpy
-    - TOXENV=py27-pluggymaster
-    - TOXENV=py36-pexpect
-    - TOXENV=py36-xdist
-    - TOXENV=py36-trial
-    - TOXENV=py36-numpy
-    - TOXENV=py36-pluggymaster
+    - TOXENV=py27
+    # Specialized factors for py27.
     - TOXENV=py27-nobyte
-    - TOXENV=doctesting
-    - TOXENV=docs PYTEST_NO_COVERAGE=1
+    - TOXENV=py27-xdist
+    - TOXENV=py27-pluggymaster
+    # Specialized factors for py37.
+    - TOXENV=py37-pexpect,py37-trial,py37-numpy
+    - TOXENV=py37-pluggymaster
+    - TOXENV=py37-freeze PYTEST_NO_COVERAGE=1
+
+matrix:
+  allow_failures:
+    - python: '3.8-dev'
+      env: TOXENV=py38-xdist
 
 jobs:
   include:
     # Coverage tracking is slow with pypy, skip it.
     - env: TOXENV=pypy PYTEST_NO_COVERAGE=1
       python: 'pypy-5.4'
-    - env: TOXENV=py35
+      dist: trusty
+    - env: TOXENV=py34-xdist
+      python: '3.4'
+    - env: TOXENV=py35-xdist
       python: '3.5'
-    - env: TOXENV=py36-freeze PYTEST_NO_COVERAGE=1
+    - env: TOXENV=py36-xdist
       python: '3.6'
     - env: TOXENV=py37
-      python: '3.7'
-      sudo: required
-      dist: xenial
     - &test-macos
       language: generic
       os: osx
@@ -48,24 +47,29 @@ jobs:
       sudo: required
       install:
         - python -m pip install --pre tox
-      env: TOXENV=py27
+      env: TOXENV=py27-xdist
     - <<: *test-macos
-      env: TOXENV=py37
+      env: TOXENV=py37-xdist
       before_install:
         - brew update
         - brew upgrade python
         - brew unlink python
         - brew link python
 
+    # Jobs only run via Travis cron jobs (currently daily).
+    - env: TOXENV=py38-xdist
+      python: '3.8-dev'
+      if: type = cron
+
     - stage: baseline
-      env: TOXENV=py27
-    - env: TOXENV=py34
-    - env: TOXENV=py36
-    - env: TOXENV=linting PYTEST_NO_COVERAGE=1
+      env: TOXENV=py27-pexpect,py27-trial,py27-numpy
+    - env: TOXENV=py37-xdist
+    - env: TOXENV=linting,docs,doctesting
+      python: '3.7'
 
     - stage: deploy
       python: '3.6'
-      env:
+      env: PYTEST_NO_COVERAGE=1
       install: pip install -U setuptools setuptools_scm
       script: skip
       deploy:
@@ -82,7 +86,9 @@ jobs:
 before_script:
   - |
     if [[ "$PYTEST_NO_COVERAGE" != 1 ]]; then
-      export _PYTEST_TOX_COVERAGE_RUN="env COVERAGE_FILE=$PWD/.coverage COVERAGE_PROCESS_START=$PWD/.coveragerc coverage run --source {envsitepackagesdir}/_pytest/,$PWD/testing -m"
+      export COVERAGE_FILE="$PWD/.coverage"
+      export COVERAGE_PROCESS_START="$PWD/.coveragerc"
+      export _PYTEST_TOX_COVERAGE_RUN="coverage run -m"
       export _PYTEST_TOX_EXTRA_DEP=coverage-enable-subprocess
     fi
 
@@ -92,17 +98,12 @@ after_success:
   - |
     if [[ "$PYTEST_NO_COVERAGE" != 1 ]]; then
       set -e
-      pip install codecov
+      # Add last TOXENV to $PATH.
+      PATH="$PWD/.tox/${TOXENV##*,}/bin:$PATH"
       coverage combine
-      coverage xml
-      coverage report -m
-      codecov --required -X gcov pycov search -f coverage.xml --flags ${TOXENV//-/ }
-
-      # Coveralls does not support merged reports.
-      if [[ "$TOXENV" = py37 ]]; then
-        pip install coveralls
-        coveralls
-      fi
+      coverage xml --ignore-errors
+      coverage report -m --ignore-errors
+      bash <(curl -s https://codecov.io/bash) -Z -X gcov -X coveragepy -X search -X xcode -X gcovout -X fix -f coverage.xml -F "${TOXENV//-/,},linux"
     fi
 
 notifications:

AUTHORS

@@ -6,20 +6,29 @@ Contributors include::
 Aaron Coleman
 Abdeali JK
 Abhijeet Kasurde
+Adam Johnson
+Adam Uhlir
 Ahn Ki-Wook
 Alan Velasco
 Alexander Johnson
 Alexei Kozlenok
+Allan Feldman
+Aly Sivji
 Anatoly Bubenkoff
 Anders Hovmöller
+Andras Mitzki
 Andras Tim
+Andrea Cimatoribus
 Andreas Zeidler
+Andrey Paramonov
 Andrzej Ostrowski
 Andy Freeland
 Anthon van der Neut
 Anthony Shaw
 Anthony Sottile
+Anton Lodder
 Antony Lee
+Arel Cordero
 Armin Rigo
 Aron Coyle
 Aron Curzon
@@ -43,9 +52,11 @@ Charles Cloud
 Charnjit SiNGH (CCSJ)
 Chris Lamb
 Christian Boelsen
+Christian Fetzer
 Christian Theunert
 Christian Tismer
 Christopher Gilling
+Christopher Dignam
 CrazyMerlyn
 Cyrus Maden
 Dhiren Serai
@@ -57,6 +68,7 @@ Danielle Jenkins
 Dave Hunt
 David Díaz-Barquero
 David Mohr
+David Szotten
 David Vierra
 Daw-Ran Liou
 Denis Kirisov
@@ -73,6 +85,7 @@ Endre Galaczi
 Eric Hunsberger
 Eric Siegerman
 Erik M. Bray
+Fabien Zarifian
 Fabio Zadrozny
 Feng Ma
 Florian Bruhin
@@ -93,6 +106,7 @@ Hui Wang (coldnight)
 Ian Bicking
 Ian Lesperance
 Ionuț Turturică
+Iwan Briquemont
 Jaap Broekhuizen
 Jan Balster
 Janne Vanhala
@@ -109,6 +123,7 @@ Jonas Obrist
 Jordan Guymon
 Jordan Moldow
 Jordan Speicher
+Joseph Hunkeler
 Joshua Bronson
 Jurko Gospodnetić
 Justyna Janczyszyn
@@ -118,6 +133,8 @@ Katerina Koukiou
 Kevin Cox
 Kodi B. Arfer
 Kostis Anagnostopoulos
+Kristoffer Nordström
+Kyle Altendorf
 Lawrence Mitchell
 Lee Kamentsky
 Lev Maximov
@@ -152,11 +169,15 @@ Michael Droettboom
 Michael Seifert
 Michal Wajszczuk
 Mihai Capotă
+Mike Hoyle (hoylemd)
 Mike Lundy
 Miro Hrončok
 Nathaniel Waisbrot
 Ned Batchelder
 Neven Mundar
+Nicholas Devenish
+Nicholas Murphy
+Niclas Olofsson
 Nicolas Delaby
 Oleg Pidsadnyi
 Oleg Sushchenko
@@ -164,6 +185,7 @@ Oliver Bestwalter
 Omar Kohl
 Omer Hadari
 Ondřej Súkup
+Oscar Benjamin
 Patrick Hayes
 Paweł Adamczak
 Pedro Algarvio
@@ -178,6 +200,7 @@ Raphael Pierzina
 Raquel Alegre
 Ravi Chandra
 Roberto Polli
+Roland Puntaier
 Romain Dorgueil
 Roman Bolshakov
 Ronny Pfannschmidt
@@ -197,6 +220,7 @@ Stefan Zimmermann
 Stefano Taschini
 Steffen Allner
 Stephan Obermann
+Sven-Hendrik Haase
 Tadek Teleżyński
 Tarcisio Fischer
 Tareq Alayan
@@ -206,6 +230,7 @@ Thomas Hisch
 Tim Strazny
 Tom Dalton
 Tom Viner
+Tomer Keren
 Trevor Bekolay
 Tyler Goodlet
 Tzu-ping Chung
@@ -222,6 +247,5 @@ Wim Glenn
 Wouter van Ackooy
 Xuan Luong
 Xuecong Liao
+Zac Hatfield-Dodds
 Zoltán Máté
-Roland Puntaier
-Allan Feldman

CONTRIBUTING.rst

@@ -169,7 +169,7 @@ Short version
 #. Follow **PEP-8** for naming and `black <https://github.com/ambv/black>`_ for formatting.
 #. Tests are run using ``tox``::
 
-    tox -e linting,py27,py36
+    tox -e linting,py27,py37
 
    The test environments above are usually enough to cover most cases locally.
 
@@ -237,12 +237,12 @@ Here is a simple overview, with pytest-specific bits:
 
 #. Run all the tests
 
-   You need to have Python 2.7 and 3.6 available in your system.  Now
+   You need to have Python 2.7 and 3.7 available in your system.  Now
    running tests is as simple as issuing this command::
 
-    $ tox -e linting,py27,py36
+    $ tox -e linting,py27,py37
 
-   This command will run tests via the "tox" tool against Python 2.7 and 3.6
+   This command will run tests via the "tox" tool against Python 2.7 and 3.7
    and also perform "lint" coding-style checks.
 
 #. You can now edit your local working copy and run the tests again as necessary. Please follow PEP-8 for naming.
@@ -252,9 +252,9 @@ Here is a simple overview, with pytest-specific bits:
 
     $ tox -e py27 -- --pdb
 
-   Or to only run tests in a particular test module on Python 3.6::
+   Or to only run tests in a particular test module on Python 3.7::
 
-    $ tox -e py36 -- testing/test_config.py
+    $ tox -e py37 -- testing/test_config.py
 
 
    When committing, ``pre-commit`` will re-format the files if necessary.
@@ -280,6 +280,47 @@ Here is a simple overview, with pytest-specific bits:
     base: features        # if it's a feature
 
 
+Writing Tests
+----------------------------
+
+Writing tests for plugins or for pytest itself is often done using the `testdir fixture <https://docs.pytest.org/en/latest/reference.html#testdir>`_, as a "black-box" test.
+
+For example, to ensure a simple test passes you can write:
+
+.. code-block:: python
+
+    def test_true_assertion(testdir):
+        testdir.makepyfile(
+            """
+            def test_foo():
+                assert True
+        """
+        )
+        result = testdir.runpytest()
+        result.assert_outcomes(failed=0, passed=1)
+
+
+Alternatively, it is possible to make checks based on the actual output of the termal using
+*glob-like* expressions:
+
+.. code-block:: python
+
+    def test_true_assertion(testdir):
+        testdir.makepyfile(
+            """
+            def test_foo():
+                assert False
+        """
+        )
+        result = testdir.runpytest()
+        result.stdout.fnmatch_lines(["*assert False*", "*1 failed*"])
+
+When choosing a file where to write a new test, take a look at the existing files and see if there's
+one file which looks like a good fit. For example, a regression test about a bug in the ``--lf`` option
+should go into ``test_cacheprovider.py``, given that this option is implemented in ``cacheprovider.py``.
+If in doubt, go ahead and open a PR with your best guess and we can discuss this over the code.
+
+
 Joining the Development Team
 ----------------------------
 

HOWTORELEASE.rst

@@ -46,5 +46,3 @@ taking a lot of time to make a new one.
    * testing-in-python@lists.idyll.org (only major/minor releases)
 
    And announce it on `Twitter <https://twitter.com/>`_ with the ``#pytest`` hashtag.
-
-#. After a minor/major release, merge ``release-X.Y.Z`` into ``master`` and push (or open a PR).

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2004-2017 Holger Krekel and others
+Copyright (c) 2004-2019 Holger Krekel and others
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.rst

@@ -15,8 +15,9 @@
 .. image:: https://img.shields.io/pypi/pyversions/pytest.svg
     :target: https://pypi.org/project/pytest/
 
-.. image:: https://img.shields.io/coveralls/pytest-dev/pytest/master.svg
-    :target: https://coveralls.io/r/pytest-dev/pytest
+.. image:: https://codecov.io/gh/pytest-dev/pytest/branch/master/graph/badge.svg
+    :target: https://codecov.io/gh/pytest-dev/pytest
+    :alt: Code coverage Status
 
 .. image:: https://travis-ci.org/pytest-dev/pytest.svg?branch=master
     :target: https://travis-ci.org/pytest-dev/pytest
@@ -25,7 +26,7 @@
     :target: https://ci.appveyor.com/project/pytestbot/pytest
 
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-  :target: https://github.com/ambv/black
+    :target: https://github.com/ambv/black
 
 .. image:: https://www.codetriage.com/pytest-dev/pytest/badges/users.svg
     :target: https://www.codetriage.com/pytest-dev/pytest
@@ -110,7 +111,7 @@ Consult the `Changelog <https://docs.pytest.org/en/latest/changelog.html>`__ pag
 License
 -------
 
-Copyright Holger Krekel and others, 2004-2018.
+Copyright Holger Krekel and others, 2004-2019.
 
 Distributed under the terms of the `MIT`_ license, pytest is free and open source software.
 

appveyor.yml

@@ -1,35 +1,24 @@
 environment:
-  COVERALLS_REPO_TOKEN:
-    secure: 2NJ5Ct55cHJ9WEg3xbSqCuv0rdgzzb6pnzOIG5OkMbTndw3wOBrXntWFoQrXiMFi
-    # this is pytest's token in coveralls.io, encrypted
-    # using pytestbot account as detailed here:
-    # https://www.appveyor.com/docs/build-configuration#secure-variables
-
   matrix:
-  # coveralls is not in the default env list
-  - TOXENV: "coveralls"
-  # note: please use "tox --listenvs" to populate the build matrix below
-  - TOXENV: "linting"
-  - TOXENV: "py27"
-  - TOXENV: "py34"
-  - TOXENV: "py35"
-  - TOXENV: "py36"
-  - TOXENV: "py37"
-  - TOXENV: "pypy"
-  - TOXENV: "py27-pexpect"
+  - TOXENV: "py37-xdist"
   - TOXENV: "py27-xdist"
-  - TOXENV: "py27-trial"
-  - TOXENV: "py27-numpy"
-  - TOXENV: "py27-pluggymaster"
-  - TOXENV: "py36-pexpect"
+  - TOXENV: "linting,docs,doctesting"
+  - TOXENV: "py34-xdist"
+  - TOXENV: "py35-xdist"
   - TOXENV: "py36-xdist"
-  - TOXENV: "py36-trial"
-  - TOXENV: "py36-numpy"
-  - TOXENV: "py36-pluggymaster"
-  - TOXENV: "py27-nobyte"
-  - TOXENV: "doctesting"
-  - TOXENV: "py36-freeze"
-  - TOXENV: "docs"
+  - TOXENV: "pypy"
+    PYTEST_NO_COVERAGE: "1"
+  # Specialized factors for py27.
+  - TOXENV: "py27-trial,py27-numpy,py27-nobyte"
+  - TOXENV: "py27-pluggymaster"
+  # Specialized factors for py37.
+  - TOXENV: "py37-trial,py37-numpy"
+  - TOXENV: "py37-pluggymaster"
+  - TOXENV: "py37-freeze"
+    PYTEST_NO_COVERAGE: "1"
+
+matrix:
+  fast_finish: true
 
 install:
   - echo Installed Pythons
@@ -37,12 +26,19 @@ install:
 
   - if "%TOXENV%" == "pypy" call scripts\install-pypy.bat
 
+  - C:\Python36\python -m pip install --upgrade pip
   - C:\Python36\python -m pip install --upgrade --pre tox
 
 build: false  # Not a C# project, build stuff at the test step instead.
 
+before_test:
+  - call scripts\prepare-coverage.bat
+
 test_script:
-  - call scripts\call-tox.bat
+  - C:\Python36\python -m tox
+
+on_success:
+  - call scripts\upload-coverage.bat
 
 cache:
   - '%LOCALAPPDATA%\pip\cache'

azure-pipelines.yml

@@ -0,0 +1,45 @@
+trigger:
+- master
+- features
+
+variables:
+  PYTEST_ADDOPTS: "--junitxml=build/test-results/$(tox.env).xml"
+
+jobs:
+
+- job: 'Test'
+  pool:
+    vmImage: "vs2017-win2016"
+  strategy:
+    matrix:
+      py27:
+        python.version: '2.7'
+        tox.env: 'py27'
+      py35:
+        python.version: '3.5'
+        tox.env: 'py35'
+      py36:
+        python.version: '3.6'
+        tox.env: 'py36'
+      py37:
+        python.version: '3.7'
+        tox.env: 'py37'
+    maxParallel: 4
+
+  steps:
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '$(python.version)'
+      architecture: 'x64'
+
+  - script: python -m pip install --upgrade pip && pip install tox
+    displayName: 'Install tox'
+
+  - script: python -m tox -e $(tox.env)
+    displayName: 'Run tests'
+
+  - task: PublishTestResults@2
+    inputs:
+      testResultsFiles: 'build/test-results/$(tox.env).xml'
+      testRunTitle: '$(tox.env)'
+    condition: succeededOrFailed()

bench/bench_argcomplete.py

@@ -1,10 +1,7 @@
-
-
 # 10000 iterations, just for relative comparison
 #                      2.7.5     3.3.2
 # FilesCompleter       75.1109   69.2116
 # FastFilesCompleter    0.7383    1.0760
-
 import timeit
 
 imports = [

bench/manyparam.py

@@ -1,4 +1,3 @@
-
 import pytest
 
 

bench/skip.py

@@ -1,4 +1,5 @@
 from six.moves import range
+
 import pytest
 
 

changelog/3251.feture.rst

@@ -1 +0,0 @@
-Warnings are now captured and displayed during test collection.

changelog/README.rst

@@ -14,7 +14,8 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
 * ``feature``: new user facing features, like new command-line options and new behavior.
 * ``bugfix``: fixes a reported bug.
 * ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
-* ``removal``: feature deprecation or removal.
+* ``deprecation``: feature deprecation.
+* ``removal``: feature removal.
 * ``vendor``: changes in packages vendored in pytest.
 * ``trivial``: fixing a small typo or internal change that might be noteworthy.
 

doc/en/Makefile

@@ -39,7 +39,7 @@ clean:
 	-rm -rf $(BUILDDIR)/*
 
 regen:
-	PYTHONDONTWRITEBYTECODE=1 PYTEST_ADDOPT=-pno:hypothesis COLUMNS=76 regendoc --update *.rst */*.rst ${REGENDOC_ARGS}
+	PYTHONDONTWRITEBYTECODE=1 PYTEST_ADDOPTS=-pno:hypothesis COLUMNS=76 regendoc --update *.rst */*.rst ${REGENDOC_ARGS}
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

doc/en/_themes/flask_theme_support.py

@@ -1,19 +1,17 @@
 # flasky extensions.  flasky pygments style based on tango style
 from pygments.style import Style
-from pygments.token import (
-    Keyword,
-    Name,
-    Comment,
-    String,
-    Error,
-    Number,
-    Operator,
-    Generic,
-    Whitespace,
-    Punctuation,
-    Other,
-    Literal,
-)
+from pygments.token import Comment
+from pygments.token import Error
+from pygments.token import Generic
+from pygments.token import Keyword
+from pygments.token import Literal
+from pygments.token import Name
+from pygments.token import Number
+from pygments.token import Operator
+from pygments.token import Other
+from pygments.token import Punctuation
+from pygments.token import String
+from pygments.token import Whitespace
 
 
 class FlaskyStyle(Style):

doc/en/announce/index.rst

@@ -6,6 +6,22 @@ Release announcements
    :maxdepth: 2
 
 
+   release-4.3.0
+   release-4.2.1
+   release-4.2.0
+   release-4.1.1
+   release-4.1.0
+   release-4.0.2
+   release-4.0.1
+   release-4.0.0
+   release-3.10.1
+   release-3.10.0
+   release-3.9.3
+   release-3.9.2
+   release-3.9.1
+   release-3.9.0
+   release-3.8.2
+   release-3.8.1
    release-3.8.0
    release-3.7.4
    release-3.7.3

doc/en/announce/release-3.10.0.rst

@@ -0,0 +1,43 @@
+pytest-3.10.0
+=======================================
+
+The pytest team is proud to announce the 3.10.0 release!
+
+pytest is a mature Python testing tool with more than a 2000 tests
+against itself, passing on many different interpreters and platforms.
+
+This release contains a number of bugs fixes and improvements, so users are encouraged
+to take a look at the CHANGELOG:
+
+    https://docs.pytest.org/en/latest/changelog.html
+
+For complete documentation, please visit:
+
+    https://docs.pytest.org/en/latest/
+
+As usual, you can upgrade from pypi via:
+
+    pip install -U pytest
+
+Thanks to all who contributed to this release, among them:
+
+* Anders Hovmöller
+* Andreu Vallbona Plazas
+* Ankit Goel
+* Anthony Sottile
+* Bernardo Gomes
+* Brianna Laugher
+* Bruno Oliveira
+* Daniel Hahler
+* David Szotten
+* Mick Koch
+* Niclas Olofsson
+* Palash Chatterjee
+* Ronny Pfannschmidt
+* Sven-Hendrik Haase
+* Ville Skyttä
+* William Jamir Silva
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-3.10.1.rst

@@ -0,0 +1,24 @@
+pytest-3.10.1
+=======================================
+
+pytest 3.10.1 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Anthony Sottile
+* Boris Feld
+* Bruno Oliveira
+* Daniel Hahler
+* Fabien ZARIFIAN
+* Jon Dufresne
+* Ronny Pfannschmidt
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-3.6.3.rst

@@ -20,8 +20,7 @@ Thanks to all who contributed to this release, among them:
 * Ondřej Súkup
 * Ronny Pfannschmidt
 * T.E.A de Souza
-* Victor
-* victor
+* Victor Maryama
 
 
 Happy testing,

doc/en/announce/release-3.7.3.rst

@@ -22,10 +22,9 @@ Thanks to all who contributed to this release, among them:
 * Ronny Pfannschmidt
 * Sankt Petersbug
 * Tyler Richard
-* Victor
+* Victor Maryama
 * Vlad Shcherbina
 * turturica
-* victor
 * wim glenn
 
 

doc/en/announce/release-3.8.1.rst

@@ -0,0 +1,25 @@
+pytest-3.8.1
+=======================================
+
+pytest 3.8.1 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Ankit Goel
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* Maximilian Albert
+* Ronny Pfannschmidt
+* William Jamir Silva
+* wim glenn
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-3.8.2.rst

@@ -0,0 +1,28 @@
+pytest-3.8.2
+=======================================
+
+pytest 3.8.2 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Ankit Goel
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* Denis Otkidach
+* Harry Percival
+* Jeffrey Rackauckas
+* Jose Carlos Menezes
+* Ronny Pfannschmidt
+* Zac-HD
+* iwanb
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-3.9.0.rst

@@ -0,0 +1,43 @@
+pytest-3.9.0
+=======================================
+
+The pytest team is proud to announce the 3.9.0 release!
+
+pytest is a mature Python testing tool with more than a 2000 tests
+against itself, passing on many different interpreters and platforms.
+
+This release contains a number of bugs fixes and improvements, so users are encouraged
+to take a look at the CHANGELOG:
+
+    https://docs.pytest.org/en/latest/changelog.html
+
+For complete documentation, please visit:
+
+    https://docs.pytest.org/en/latest/
+
+As usual, you can upgrade from pypi via:
+
+    pip install -U pytest
+
+Thanks to all who contributed to this release, among them:
+
+* Andrea Cimatoribus
+* Ankit Goel
+* Anthony Sottile
+* Ben Eyal
+* Bruno Oliveira
+* Daniel Hahler
+* Jeffrey Rackauckas
+* Jose Carlos Menezes
+* Kyle Altendorf
+* Niklas JQ
+* Palash Chatterjee
+* Ronny Pfannschmidt
+* Thomas Hess
+* Thomas Hisch
+* Tomer Keren
+* Victor Maryama
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-3.9.1.rst

@@ -0,0 +1,20 @@
+pytest-3.9.1
+=======================================
+
+pytest 3.9.1 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Bruno Oliveira
+* Ronny Pfannschmidt
+* Thomas Hisch
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-3.9.2.rst

@@ -0,0 +1,23 @@
+pytest-3.9.2
+=======================================
+
+pytest 3.9.2 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Ankit Goel
+* Anthony Sottile
+* Bruno Oliveira
+* Ronny Pfannschmidt
+* Vincent Barbaresi
+* ykantor
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-3.9.3.rst

@@ -0,0 +1,24 @@
+pytest-3.9.3
+=======================================
+
+pytest 3.9.3 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Andreas Profous
+* Ankit Goel
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* Jon Dufresne
+* Ronny Pfannschmidt
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.0.0.rst

@@ -0,0 +1,30 @@
+pytest-4.0.0
+=======================================
+
+The pytest team is proud to announce the 4.0.0 release!
+
+pytest is a mature Python testing tool with more than a 2000 tests
+against itself, passing on many different interpreters and platforms.
+
+This release contains a number of bugs fixes and improvements, so users are encouraged
+to take a look at the CHANGELOG:
+
+    https://docs.pytest.org/en/latest/changelog.html
+
+For complete documentation, please visit:
+
+    https://docs.pytest.org/en/latest/
+
+As usual, you can upgrade from pypi via:
+
+    pip install -U pytest
+
+Thanks to all who contributed to this release, among them:
+
+* Bruno Oliveira
+* Daniel Hahler
+* Ronny Pfannschmidt
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-4.0.1.rst

@@ -0,0 +1,23 @@
+pytest-4.0.1
+=======================================
+
+pytest 4.0.1 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* Michael D. Hoyle
+* Ronny Pfannschmidt
+* Slam
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.0.2.rst

@@ -0,0 +1,24 @@
+pytest-4.0.2
+=======================================
+
+pytest 4.0.2 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* Pedro Algarvio
+* Ronny Pfannschmidt
+* Tomer Keren
+* Yash Todi
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.1.0.rst

@@ -0,0 +1,44 @@
+pytest-4.1.0
+=======================================
+
+The pytest team is proud to announce the 4.1.0 release!
+
+pytest is a mature Python testing tool with more than a 2000 tests
+against itself, passing on many different interpreters and platforms.
+
+This release contains a number of bugs fixes and improvements, so users are encouraged
+to take a look at the CHANGELOG:
+
+    https://docs.pytest.org/en/latest/changelog.html
+
+For complete documentation, please visit:
+
+    https://docs.pytest.org/en/latest/
+
+As usual, you can upgrade from pypi via:
+
+    pip install -U pytest
+
+Thanks to all who contributed to this release, among them:
+
+* Adam Johnson
+* Aly Sivji
+* Andrey Paramonov
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* David Vo
+* Hyunchel Kim
+* Jeffrey Rackauckas
+* Kanguros
+* Nicholas Devenish
+* Pedro Algarvio
+* Randy Barlow
+* Ronny Pfannschmidt
+* Tomer Keren
+* feuillemorte
+* wim glenn
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-4.1.1.rst

@@ -0,0 +1,27 @@
+pytest-4.1.1
+=======================================
+
+pytest 4.1.1 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Anthony Sottile
+* Anton Lodder
+* Bruno Oliveira
+* Daniel Hahler
+* David Vo
+* Oscar Benjamin
+* Ronny Pfannschmidt
+* Victor Maryama
+* Yoav Caspi
+* dmitry.dygalo
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.2.0.rst

@@ -0,0 +1,37 @@
+pytest-4.2.0
+=======================================
+
+The pytest team is proud to announce the 4.2.0 release!
+
+pytest is a mature Python testing tool with more than a 2000 tests
+against itself, passing on many different interpreters and platforms.
+
+This release contains a number of bugs fixes and improvements, so users are encouraged
+to take a look at the CHANGELOG:
+
+    https://docs.pytest.org/en/latest/changelog.html
+
+For complete documentation, please visit:
+
+    https://docs.pytest.org/en/latest/
+
+As usual, you can upgrade from pypi via:
+
+    pip install -U pytest
+
+Thanks to all who contributed to this release, among them:
+
+* Adam Uhlir
+* Anthony Sottile
+* Bruno Oliveira
+* Christopher Dignam
+* Daniel Hahler
+* Joseph Hunkeler
+* Kristoffer Nordstroem
+* Ronny Pfannschmidt
+* Thomas Hisch
+* wim glenn
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-4.2.1.rst

@@ -0,0 +1,30 @@
+pytest-4.2.1
+=======================================
+
+pytest 4.2.1 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/latest/changelog.html.
+
+Thanks to all who contributed to this release, among them:
+
+* Anthony Sottile
+* Arel Cordero
+* Bruno Oliveira
+* Daniel Hahler
+* Holger Kohr
+* Kevin J. Foley
+* Nick Murphy
+* Paweł Stradomski
+* Raphael Pierzina
+* Ronny Pfannschmidt
+* Sam Brightman
+* Thomas Hisch
+* Zac Hatfield-Dodds
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.3.0.rst

@@ -0,0 +1,36 @@
+pytest-4.3.0
+=======================================
+
+The pytest team is proud to announce the 4.3.0 release!
+
+pytest is a mature Python testing tool with more than a 2000 tests
+against itself, passing on many different interpreters and platforms.
+
+This release contains a number of bugs fixes and improvements, so users are encouraged
+to take a look at the CHANGELOG:
+
+    https://docs.pytest.org/en/latest/changelog.html
+
+For complete documentation, please visit:
+
+    https://docs.pytest.org/en/latest/
+
+As usual, you can upgrade from pypi via:
+
+    pip install -U pytest
+
+Thanks to all who contributed to this release, among them:
+
+* Andras Mitzki
+* Anthony Sottile
+* Bruno Oliveira
+* Christian Fetzer
+* Daniel Hahler
+* Grygorii Iermolenko
+* R. Alex Matevish
+* Ronny Pfannschmidt
+* cclauss
+
+
+Happy testing,
+The Pytest Development Team

doc/en/assert.rst

@@ -22,11 +22,14 @@ following::
         assert f() == 4
 
 to assert that your function returns a certain value. If this assertion fails
-you will see the return value of the function call::
+you will see the return value of the function call:
+
+.. code-block:: pytest
 
     $ pytest test_assert1.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 1 item
 
@@ -85,24 +88,30 @@ and if you need to have access to the actual exception info you may use::
 the actual exception raised.  The main attributes of interest are
 ``.type``, ``.value`` and ``.traceback``.
 
-.. versionchanged:: 3.0
+You can pass a ``match`` keyword parameter to the context-manager to test
+that a regular expression matches on the string representation of an exception
+(similar to the ``TestCase.assertRaisesRegexp`` method from ``unittest``)::
 
-In the context manager form you may use the keyword argument
-``message`` to specify a custom failure message::
+    import pytest
 
-     >>> with raises(ZeroDivisionError, message="Expecting ZeroDivisionError"):
-     ...     pass
-     ... Failed: Expecting ZeroDivisionError
+    def myfunc():
+        raise ValueError("Exception 123 raised")
 
-If you want to write test code that works on Python 2.4 as well,
-you may also use two other ways to test for an expected exception::
+    def test_match():
+        with pytest.raises(ValueError, match=r'.* 123 .*'):
+            myfunc()
+
+The regexp parameter of the ``match`` method is matched with the ``re.search``
+function, so in the above example ``match='123'`` would have worked as
+well.
+
+There's an alternate form of the ``pytest.raises`` function where you pass
+a function that will be executed with the given ``*args`` and ``**kwargs`` and
+assert that the given exception is raised::
 
     pytest.raises(ExpectedException, func, *args, **kwargs)
-    pytest.raises(ExpectedException, "func(*args, **kwargs)")
 
-both of which execute the specified function with args and kwargs and
-asserts that the given ``ExpectedException`` is raised.  The reporter will
-provide you with helpful output in case of failures such as *no
+The reporter will provide you with helpful output in case of failures such as *no
 exception* or *wrong exception*.
 
 Note that it is also possible to specify a "raises" argument to
@@ -119,23 +128,6 @@ exceptions your own code is deliberately raising, whereas using
 like documenting unfixed bugs (where the test describes what "should" happen)
 or bugs in dependencies.
 
-Also, the context manager form accepts a ``match`` keyword parameter to test
-that a regular expression matches on the string representation of an exception
-(like the ``TestCase.assertRaisesRegexp`` method from ``unittest``)::
-
-    import pytest
-
-    def myfunc():
-        raise ValueError("Exception 123 raised")
-
-    def test_match():
-        with pytest.raises(ValueError, match=r'.* 123 .*'):
-            myfunc()
-
-The regexp parameter of the ``match`` method is matched with the ``re.search``
-function. So in the above example ``match='123'`` would have worked as
-well.
-
 
 .. _`assertwarns`:
 
@@ -165,11 +157,14 @@ when it encounters comparisons.  For example::
         set2 = set("8035")
         assert set1 == set2
 
-if you run this module::
+if you run this module:
+
+.. code-block:: pytest
 
     $ pytest test_assert2.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 1 item
 
@@ -200,8 +195,8 @@ Special comparisons are done for a number of cases:
 
 See the :ref:`reporting demo <tbreportdemo>` for many more examples.
 
-Defining your own assertion comparison
-----------------------------------------------
+Defining your own explanation for failed assertions
+---------------------------------------------------
 
 It is possible to add your own detailed explanations by implementing
 the ``pytest_assertrepr_compare`` hook.
@@ -235,7 +230,9 @@ now, given this test module::
        assert f1 == f2
 
 you can run the test module and get the custom output defined in
-the conftest file::
+the conftest file:
+
+.. code-block:: pytest
 
    $ pytest -q test_foocompare.py
    F                                                                    [100%]
@@ -264,8 +261,12 @@ Advanced assertion introspection
 Reporting details about a failing assertion is achieved by rewriting assert
 statements before they are run.  Rewritten assert statements put introspection
 information into the assertion failure message.  ``pytest`` only rewrites test
-modules directly discovered by its test collection process, so asserts in
-supporting modules which are not themselves test modules will not be rewritten.
+modules directly discovered by its test collection process, so **asserts in
+supporting modules which are not themselves test modules will not be rewritten**.
+
+You can manually enable assertion rewriting for an imported module by calling
+`register_assert_rewrite <https://docs.pytest.org/en/latest/writing_plugins.html#assertion-rewriting>`_
+before you import it (a good place to do that is in ``conftest.py``).
 
 .. note::
 

doc/en/backwards-compatibility.rst

@@ -7,14 +7,16 @@ Keeping backwards compatibility has a very high priority in the pytest project.
 
 With the pytest 3.0 release we introduced a clear communication scheme for when we will actually remove the old busted joint and politely ask you to use the new hotness instead, while giving you enough time to adjust your tests or raise concerns if there are valid reasons to keep deprecated functionality around.
 
-To communicate changes we are already issuing deprecation warnings, but they are not displayed by default. In pytest 3.0 we changed the default setting so that pytest deprecation warnings are displayed if not explicitly silenced (with ``--disable-pytest-warnings``).
+To communicate changes we issue deprecation warnings using a custom warning hierarchy (see :ref:`internal-warnings`). These warnings may be suppressed using the standard means: ``-W`` command-line flag or ``filterwarnings`` ini options (see :ref:`warnings`), but we suggest to use these sparingly and temporarily, and heed the warnings when possible.
 
-We will only remove deprecated functionality in major releases (e.g. if we deprecate something in 3.0 we will remove it in 4.0), and keep it around for at least two minor releases (e.g. if we deprecate something in 3.9 and 4.0 is the next release, we will not remove it in 4.0 but in 5.0).
+We will only start the removal of deprecated functionality in major releases (e.g. if we deprecate something in 3.0 we will start to remove it in 4.0), and keep it around for at least two minor releases (e.g. if we deprecate something in 3.9 and 4.0 is the next release, we start to remove it in 5.0, not in 4.0).
+
+When the deprecation expires (e.g. 4.0 is released), we won't remove the deprecated functionality immediately, but will use the standard warning filters to turn them into **errors** by default. This approach makes it explicit that removal is imminent, and still gives you time to turn the deprecated feature into a warning instead of an error so it can be dealt with in your own time. In the next minor release (e.g. 4.1), the feature will be effectively removed.
 
 
 Deprecation Roadmap
 -------------------
 
-We track deprecation and removal of features using milestones and the `deprecation <https://github.com/pytest-dev/pytest/issues?q=label%3A%22type%3A+deprecation%22>`_ and `removal <https://github.com/pytest-dev/pytest/labels/type%3A%20removal>`_ labels on GitHub.
+Features currently deprecated and removed in previous releases can be found in :ref:`deprecations`.
 
-Following our deprecation policy, after starting issuing deprecation warnings we keep features for *at least* two minor versions before considering removal.
+We track future deprecation and removal of features using milestones and the `deprecation <https://github.com/pytest-dev/pytest/issues?q=label%3A%22type%3A+deprecation%22>`_ and `removal <https://github.com/pytest-dev/pytest/labels/type%3A%20removal>`_ labels on GitHub.

doc/en/builtin.rst

@@ -12,7 +12,9 @@ For information on plugin hooks and objects, see :ref:`plugins`.
 
 For information on the ``pytest.mark`` mechanism, see :ref:`mark`.
 
-For information about fixtures, see :ref:`fixtures`. To see a complete list of available fixtures (add ``-v`` to also see fixtures with leading ``_``), type ::
+For information about fixtures, see :ref:`fixtures`. To see a complete list of available fixtures (add ``-v`` to also see fixtures with leading ``_``), type :
+
+.. code-block:: pytest
 
     $ pytest -q --fixtures
     cache
@@ -66,8 +68,6 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
 
             def test_function(record_property):
                 record_property("example_key", 1)
-    record_xml_property
-        (Deprecated) use record_property.
     record_xml_attribute
         Add extra xml attributes to the tag for the calling test.
         The fixture is callable with ``(name, value)``, with value being
@@ -75,7 +75,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
     caplog
         Access and control log capturing.
 
-        Captured logs are available through the following methods::
+        Captured logs are available through the following properties/methods::
 
         * caplog.text            -> string containing formatted log output
         * caplog.records         -> list of logging.LogRecord instances
@@ -104,7 +104,9 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
         See http://docs.python.org/library/warnings.html for information
         on warning categories.
     tmpdir_factory
-        Return a TempdirFactory instance for the test session.
+        Return a :class:`_pytest.tmpdir.TempdirFactory` instance for the test session.
+    tmp_path_factory
+        Return a :class:`_pytest.tmpdir.TempPathFactory` instance for the test session.
     tmpdir
         Return a temporary directory path object
         which is unique to each test function invocation,
@@ -113,6 +115,16 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
         path object.
 
         .. _`py.path.local`: https://py.readthedocs.io/en/latest/path.html
+    tmp_path
+        Return a temporary directory path object
+        which is unique to each test function invocation,
+        created as a sub directory of the base temporary
+        directory.  The returned object is a :class:`pathlib.Path`
+        object.
+
+        .. note::
+
+            in python < 3.6 this is a pathlib2.Path
 
     no tests ran in 0.12 seconds
 

doc/en/cache.rst

@@ -43,7 +43,9 @@ First, let's create 50 test invocation of which only 2 fail::
         if i in (17, 25):
            pytest.fail("bad luck")
 
-If you run this for the first time you will see two failures::
+If you run this for the first time you will see two failures:
+
+.. code-block:: pytest
 
     $ pytest -q
     .................F.......F........................                   [100%]
@@ -72,13 +74,16 @@ If you run this for the first time you will see two failures::
     test_50.py:6: Failed
     2 failed, 48 passed in 0.12 seconds
 
-If you then run it with ``--lf``::
+If you then run it with ``--lf``:
+
+.. code-block:: pytest
 
     $ pytest --lf
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 50 items / 48 deselected
+    collected 50 items / 48 deselected / 2 selected
     run-last-failure: rerun previous 2 failures
 
     test_50.py FF                                                        [100%]
@@ -113,11 +118,14 @@ not been run ("deselected").
 
 Now, if you run with the ``--ff`` option, all tests will be run but the first
 previous failures will be executed first (as can be seen from the series
-of ``FF`` and dots)::
+of ``FF`` and dots):
+
+.. code-block:: pytest
 
     $ pytest --ff
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 50 items
     run-last-failure: rerun previous 2 failures first
@@ -179,11 +187,14 @@ across pytest invocations::
     import pytest
     import time
 
+    def expensive_computation():
+        print("running expensive computation...")
+
     @pytest.fixture
     def mydata(request):
         val = request.config.cache.get("example/value", None)
         if val is None:
-            time.sleep(9*0.6) # expensive computation :)
+            expensive_computation()
             val = 42
             request.config.cache.set("example/value", val)
         return val
@@ -191,8 +202,9 @@ across pytest invocations::
     def test_function(mydata):
         assert mydata == 23
 
-If you run this command once, it will take a while because
-of the sleep::
+If you run this command for the first time, you can see the print statement:
+
+.. code-block:: pytest
 
     $ pytest -q
     F                                                                    [100%]
@@ -204,12 +216,18 @@ of the sleep::
         def test_function(mydata):
     >       assert mydata == 23
     E       assert 42 == 23
+    E         -42
+    E         +23
 
-    test_caching.py:14: AssertionError
+    test_caching.py:17: AssertionError
+    -------------------------- Captured stdout setup ---------------------------
+    running expensive computation...
     1 failed in 0.12 seconds
 
 If you run it a second time the value will be retrieved from
-the cache and this will be quick::
+the cache and nothing will be printed:
+
+.. code-block:: pytest
 
     $ pytest -q
     F                                                                    [100%]
@@ -221,8 +239,10 @@ the cache and this will be quick::
         def test_function(mydata):
     >       assert mydata == 23
     E       assert 42 == 23
+    E         -42
+    E         +23
 
-    test_caching.py:14: AssertionError
+    test_caching.py:17: AssertionError
     1 failed in 0.12 seconds
 
 See the :ref:`cache-api` for more details.
@@ -232,18 +252,28 @@ Inspecting Cache content
 -------------------------------
 
 You can always peek at the content of the cache using the
-``--cache-show`` command line option::
+``--cache-show`` command line option:
+
+.. code-block:: pytest
 
     $ pytest --cache-show
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    cachedir: $REGENDOC_TMPDIR/.pytest_cache
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     ------------------------------- cache values -------------------------------
     cache/lastfailed contains:
-      {'test_caching.py::test_function': True}
+      {'test_50.py::test_num[17]': True,
+       'test_50.py::test_num[25]': True,
+       'test_assert1.py::test_function': True,
+       'test_assert2.py::test_set_comparison': True,
+       'test_caching.py::test_function': True,
+       'test_foocompare.py::test_compare': True}
     cache/nodeids contains:
       ['test_caching.py::test_function']
+    cache/stepwise contains:
+      []
     example/value contains:
       42
 
@@ -260,3 +290,9 @@ by adding the ``--cache-clear`` option like this::
 This is recommended for invocations from Continuous Integration
 servers where isolation and correctness is more important
 than speed.
+
+
+Stepwise
+--------
+
+As an alternative to ``--lf -x``, especially for cases where you expect a large part of the test suite will fail, ``--sw``, ``--stepwise`` allows you to fix them one at a time. The test suite will run until the first failure and then stop. At the next invocation, tests will continue from the last failing test and then run until the next failing test. You may use the ``--stepwise-skip`` option to ignore one failing test and stop the test execution on the second failing test instead. This is useful if you get stuck on a failing test and just want to ignore it until later.

doc/en/capture.rst

@@ -52,7 +52,7 @@ is that you can use print statements for debugging::
     # content of test_module.py
 
     def setup_function(function):
-        print ("setting up %s" % function)
+        print("setting up %s" % function)
 
     def test_func1():
         assert True
@@ -61,11 +61,14 @@ is that you can use print statements for debugging::
         assert False
 
 and running this module will show you precisely the output
-of the failing function and hide the other one::
+of the failing function and hide the other one:
+
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 2 items
 

doc/en/conf.py

@@ -10,17 +10,15 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
 # The short X.Y version.
-
+import datetime
 import os
 import sys
-import datetime
 
 from _pytest import __version__ as version
 
@@ -42,11 +40,13 @@ todo_include_todos = 1
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
+    "pygments_pytest",
     "sphinx.ext.autodoc",
-    "sphinx.ext.todo",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
     "sphinx.ext.viewcode",
+    "sphinx_removed_in",
     "sphinxcontrib_trio",
 ]
 
@@ -65,7 +65,7 @@ master_doc = "contents"
 # General information about the project.
 project = u"pytest"
 year = datetime.datetime.utcnow().year
-copyright = u"2015–2018 , holger krekel and pytest-dev team"
+copyright = u"2015–2019 , holger krekel and pytest-dev team"
 
 
 # The language for content autogenerated by Sphinx. Refer to documentation

doc/en/contents.rst

@@ -33,12 +33,15 @@ Full pytest documentation
    reference
 
    goodpractices
+   flaky
    pythonpath
    customize
    example/index
    bash-completion
 
    backwards-compatibility
+   deprecations
+   py27-py34-deprecation
    historical-notes
    license
    contributing

doc/en/customize.rst

@@ -32,7 +32,7 @@ Here's a summary what ``pytest`` uses ``rootdir`` for:
   class name, function name and parametrization (if any).
 
 * Is used by plugins as a stable location to store project/test run specific information;
-  for example, the internal :ref:`cache <cache>` plugin creates a ``.cache`` subdirectory
+  for example, the internal :ref:`cache <cache>` plugin creates a ``.pytest_cache`` subdirectory
   in ``rootdir`` to store its cross-test run state.
 
 Important to emphasize that ``rootdir`` is **NOT** used to modify ``sys.path``/``PYTHONPATH`` or

doc/en/deprecations.rst

@@ -0,0 +1,532 @@
+.. _deprecations:
+
+Deprecations and Removals
+=========================
+
+This page lists all pytest features that are currently deprecated or have been removed in past major releases.
+The objective is to give users a clear rationale why a certain feature has been removed, and what alternatives
+should be used instead.
+
+.. contents::
+    :depth: 3
+    :local:
+
+
+Deprecated Features
+-------------------
+
+Below is a complete list of all pytest features which are considered deprecated. Using those features will issue
+:class:`_pytest.warning_types.PytestWarning` or subclasses, which can be filtered using
+:ref:`standard warning filters <warnings>`.
+
+``"message"`` parameter of ``pytest.raises``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. deprecated:: 4.1
+
+It is a common mistake to think this parameter will match the exception message, while in fact
+it only serves to provide a custom message in case the ``pytest.raises`` check fails. To prevent
+users from making this mistake, and because it is believed to be little used, pytest is
+deprecating it without providing an alternative for the moment.
+
+If you have a valid use case for this parameter, consider that to obtain the same results
+you can just call ``pytest.fail`` manually at the end of the ``with`` statement.
+
+For example:
+
+.. code-block:: python
+
+    with pytest.raises(TimeoutError, message="Client got unexpected message"):
+        wait_for(websocket.recv(), 0.5)
+
+
+Becomes:
+
+.. code-block:: python
+
+    with pytest.raises(TimeoutError):
+        wait_for(websocket.recv(), 0.5)
+        pytest.fail("Client got unexpected message")
+
+
+If you still have concerns about this deprecation and future removal, please comment on
+`issue #3974 <https://github.com/pytest-dev/pytest/issues/3974>`__.
+
+
+``pytest.config`` global
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. deprecated:: 4.1
+
+The ``pytest.config`` global object is deprecated.  Instead use
+``request.config`` (via the ``request`` fixture) or if you are a plugin author
+use the ``pytest_configure(config)`` hook.
+
+.. _raises-warns-exec:
+
+``raises`` / ``warns`` with a string as the second argument
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. deprecated:: 4.1
+
+Use the context manager form of these instead.  When necessary, invoke ``exec``
+directly.
+
+Example:
+
+.. code-block:: python
+
+    pytest.raises(ZeroDivisionError, "1 / 0")
+    pytest.raises(SyntaxError, "a $ b")
+
+    pytest.warns(DeprecationWarning, "my_function()")
+    pytest.warns(SyntaxWarning, "assert(1, 2)")
+
+Becomes:
+
+.. code-block:: python
+
+    with pytest.raises(ZeroDivisionError):
+        1 / 0
+    with pytest.raises(SyntaxError):
+        exec("a $ b")  # exec is required for invalid syntax
+
+    with pytest.warns(DeprecationWarning):
+        my_function()
+    with pytest.warns(SyntaxWarning):
+        exec("assert(1, 2)")  # exec is used to avoid a top-level warning
+
+
+
+
+
+
+Result log (``--result-log``)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. deprecated:: 3.0
+
+The ``--resultlog`` command line option has been deprecated: it is little used
+and there are more modern and better alternatives, for example `pytest-tap <https://tappy.readthedocs.io/en/latest/>`_.
+
+This feature will be effectively removed in pytest 4.0 as the team intends to include a better alternative in the core.
+
+If you have any concerns, please don't hesitate to `open an issue <https://github.com/pytest-dev/pytest/issues>`__.
+
+Removed Features
+----------------
+
+As stated in our :ref:`backwards-compatibility` policy, deprecated features are removed only in major releases after
+an appropriate period of deprecation has passed.
+
+Using ``Class`` in custom Collectors
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+Using objects named ``"Class"`` as a way to customize the type of nodes that are collected in ``Collector``
+subclasses has been deprecated. Users instead should use ``pytest_pycollect_makeitem`` to customize node types during
+collection.
+
+This issue should affect only advanced plugins who create new collection types, so if you see this warning
+message please contact the authors so they can change the code.
+
+
+marks in ``pytest.mark.parametrize``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+Applying marks to values of a ``pytest.mark.parametrize`` call is now deprecated. For example:
+
+.. code-block:: python
+
+    @pytest.mark.parametrize(
+        "a, b",
+        [
+            (3, 9),
+            pytest.mark.xfail(reason="flaky")(6, 36),
+            (10, 100),
+            (20, 200),
+            (40, 400),
+            (50, 500),
+        ],
+    )
+    def test_foo(a, b):
+        ...
+
+This code applies the ``pytest.mark.xfail(reason="flaky")`` mark to the ``(6, 36)`` value of the above parametrization
+call.
+
+This was considered hard to read and understand, and also its implementation presented problems to the code preventing
+further internal improvements in the marks architecture.
+
+To update the code, use ``pytest.param``:
+
+.. code-block:: python
+
+    @pytest.mark.parametrize(
+        "a, b",
+        [
+            (3, 9),
+            pytest.param(6, 36, marks=pytest.mark.xfail(reason="flaky")),
+            (10, 100),
+            (20, 200),
+            (40, 400),
+            (50, 500),
+        ],
+    )
+    def test_foo(a, b):
+        ...
+
+
+``pytest_funcarg__`` prefix
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+In very early pytest versions fixtures could be defined using the ``pytest_funcarg__`` prefix:
+
+.. code-block:: python
+
+    def pytest_funcarg__data():
+        return SomeData()
+
+Switch over to the ``@pytest.fixture`` decorator:
+
+.. code-block:: python
+
+    @pytest.fixture
+    def data():
+        return SomeData()
+
+
+
+[pytest] section in setup.cfg files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+``[pytest]`` sections in ``setup.cfg`` files should now be named ``[tool:pytest]``
+to avoid conflicts with other distutils commands.
+
+
+Metafunc.addcall
+~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+:meth:`_pytest.python.Metafunc.addcall` was a precursor to the current parametrized mechanism. Users should use
+:meth:`_pytest.python.Metafunc.parametrize` instead.
+
+Example:
+
+.. code-block:: python
+
+    def pytest_generate_tests(metafunc):
+        metafunc.addcall({"i": 1}, id="1")
+        metafunc.addcall({"i": 2}, id="2")
+
+Becomes:
+
+.. code-block:: python
+
+    def pytest_generate_tests(metafunc):
+        metafunc.parametrize("i", [1, 2], ids=["1", "2"])
+
+
+``cached_setup``
+~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+``request.cached_setup`` was the precursor of the setup/teardown mechanism available to fixtures.
+
+Example:
+
+.. code-block:: python
+
+    @pytest.fixture
+    def db_session():
+        return request.cached_setup(
+            setup=Session.create, teardown=lambda session: session.close(), scope="module"
+        )
+
+This should be updated to make use of standard fixture mechanisms:
+
+.. code-block:: python
+
+    @pytest.fixture(scope="module")
+    def db_session():
+        session = Session.create()
+        yield session
+        session.close()
+
+
+You can consult `funcarg comparison section in the docs <https://docs.pytest.org/en/latest/funcarg_compare.html>`_ for
+more information.
+
+
+pytest_plugins in non-top-level conftest files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+Defining ``pytest_plugins`` is now deprecated in non-top-level conftest.py
+files because they will activate referenced plugins *globally*, which is surprising because for all other pytest
+features ``conftest.py`` files are only *active* for tests at or below it.
+
+
+``Config.warn`` and ``Node.warn``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+Those methods were part of the internal pytest warnings system, but since ``3.8`` pytest is using the builtin warning
+system for its own warnings, so those two functions are now deprecated.
+
+``Config.warn`` should be replaced by calls to the standard ``warnings.warn``, example:
+
+.. code-block:: python
+
+    config.warn("C1", "some warning")
+
+Becomes:
+
+.. code-block:: python
+
+    warnings.warn(pytest.PytestWarning("some warning"))
+
+``Node.warn`` now supports two signatures:
+
+* ``node.warn(PytestWarning("some message"))``: is now the **recommended** way to call this function.
+  The warning instance must be a PytestWarning or subclass.
+
+* ``node.warn("CI", "some message")``: this code/message form has been **removed** and should be converted to the warning instance form above.
+
+record_xml_property
+~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+The ``record_xml_property`` fixture is now deprecated in favor of the more generic ``record_property``, which
+can be used by other consumers (for example ``pytest-html``) to obtain custom information about the test run.
+
+This is just a matter of renaming the fixture as the API is the same:
+
+.. code-block:: python
+
+    def test_foo(record_xml_property):
+        ...
+
+Change to:
+
+.. code-block:: python
+
+    def test_foo(record_property):
+        ...
+
+
+Passing command-line string to ``pytest.main()``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+Passing a command-line string to ``pytest.main()`` is deprecated:
+
+.. code-block:: python
+
+    pytest.main("-v -s")
+
+Pass a list instead:
+
+.. code-block:: python
+
+    pytest.main(["-v", "-s"])
+
+
+By passing a string, users expect that pytest will interpret that command-line using the shell rules they are working
+on (for example ``bash`` or ``Powershell``), but this is very hard/impossible to do in a portable way.
+
+
+Calling fixtures directly
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+Calling a fixture function directly, as opposed to request them in a test function, is deprecated.
+
+For example:
+
+.. code-block:: python
+
+    @pytest.fixture
+    def cell():
+        return ...
+
+
+    @pytest.fixture
+    def full_cell():
+        cell = cell()
+        cell.make_full()
+        return cell
+
+This is a great source of confusion to new users, which will often call the fixture functions and request them from test functions interchangeably, which breaks the fixture resolution model.
+
+In those cases just request the function directly in the dependent fixture:
+
+.. code-block:: python
+
+    @pytest.fixture
+    def cell():
+        return ...
+
+
+    @pytest.fixture
+    def full_cell(cell):
+        cell.make_full()
+        return cell
+
+Alternatively if the fixture function is called multiple times inside a test (making it hard to apply the above pattern) or
+if you would like to make minimal changes to the code, you can create a fixture which calls the original function together
+with the ``name`` parameter:
+
+.. code-block:: python
+
+    def cell():
+        return ...
+
+
+    @pytest.fixture(name="cell")
+    def cell_fixture():
+        return cell()
+
+
+``yield`` tests
+~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+pytest supported ``yield``-style tests, where a test function actually ``yield`` functions and values
+that are then turned into proper test methods. Example:
+
+.. code-block:: python
+
+    def check(x, y):
+        assert x ** x == y
+
+
+    def test_squared():
+        yield check, 2, 4
+        yield check, 3, 9
+
+This would result into two actual test functions being generated.
+
+This form of test function doesn't support fixtures properly, and users should switch to ``pytest.mark.parametrize``:
+
+.. code-block:: python
+
+    @pytest.mark.parametrize("x, y", [(2, 4), (3, 9)])
+    def test_squared(x, y):
+        assert x ** x == y
+
+Internal classes accessed through ``Node``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+Access of ``Module``, ``Function``, ``Class``, ``Instance``, ``File`` and ``Item`` through ``Node`` instances now issue
+this warning::
+
+    usage of Function.Module is deprecated, please use pytest.Module instead
+
+Users should just ``import pytest`` and access those objects using the ``pytest`` module.
+
+This has been documented as deprecated for years, but only now we are actually emitting deprecation warnings.
+
+``Node.get_marker``
+~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+As part of a large :ref:`marker-revamp`, :meth:`_pytest.nodes.Node.get_marker` is deprecated. See
+:ref:`the documentation <update marker code>` on tips on how to update your code.
+
+
+``somefunction.markname``
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+As part of a large :ref:`marker-revamp` we already deprecated using ``MarkInfo``
+the only correct way to get markers of an element is via ``node.iter_markers(name)``.
+
+
+``pytest_namespace``
+~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 4.0
+
+This hook is deprecated because it greatly complicates the pytest internals regarding configuration and initialization, making some
+bug fixes and refactorings impossible.
+
+Example of usage:
+
+.. code-block:: python
+
+    class MySymbol:
+        ...
+
+
+    def pytest_namespace():
+        return {"my_symbol": MySymbol()}
+
+
+Plugin authors relying on this hook should instead require that users now import the plugin modules directly (with an appropriate public API).
+
+As a stopgap measure, plugin authors may still inject their names into pytest's namespace, usually during ``pytest_configure``:
+
+.. code-block:: python
+
+    import pytest
+
+
+    def pytest_configure():
+        pytest.my_symbol = MySymbol()
+
+
+
+
+Reinterpretation mode (``--assert=reinterp``)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 3.0
+
+Reinterpretation mode has now been removed and 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.
+
+Removed command-line options
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 3.0
+
+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;
+
+py.test-X* entry points
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 3.0
+
+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.

doc/en/doctest.rst

@@ -58,11 +58,14 @@ and another like this::
         """
         return 42
 
-then you can just invoke ``pytest`` without command line options::
+then you can just invoke ``pytest`` without command line options:
+
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 1 item
 
@@ -152,6 +155,9 @@ which can then be used in your doctests directly::
         """
         pass
 
+Note that like the normal ``conftest.py``, the fixtures are discovered in the directory tree conftest is in.
+Meaning that if you put your doctest with your source code, the relevant conftest.py needs to be in the same directory tree.
+Fixtures will not be discovered in a sibling directory tree!
 
 Output format
 -------------

doc/en/example/assertion/failure_demo.py

@@ -1,7 +1,9 @@
-from pytest import raises
-import _pytest._code
 import six
 
+import _pytest._code
+import pytest
+from pytest import raises
+
 
 def otherfunc(a, b):
     assert a == b
@@ -15,15 +17,11 @@ def otherfunc_multi(a, b):
     assert a == b
 
 
+@pytest.mark.parametrize("param1, param2", [(3, 6)])
 def test_generative(param1, param2):
     assert param1 * 2 < param2
 
 
-def pytest_generate_tests(metafunc):
-    if "param1" in metafunc.fixturenames:
-        metafunc.addcall(funcargs=dict(param1=3, param2=6))
-
-
 class TestFailing(object):
     def test_simple(self):
         def f():
@@ -100,6 +98,30 @@ class TestSpecialisedExplanations(object):
         text = "head " * 50 + "f" * 70 + "tail " * 20
         assert "f" * 70 not in text
 
+    def test_eq_dataclass(self):
+        from dataclasses import dataclass
+
+        @dataclass
+        class Foo(object):
+            a: int
+            b: str
+
+        left = Foo(1, "b")
+        right = Foo(1, "c")
+        assert left == right
+
+    def test_eq_attrs(self):
+        import attr
+
+        @attr.s
+        class Foo(object):
+            a = attr.ib()
+            b = attr.ib()
+
+        left = Foo(1, "b")
+        right = Foo(1, "c")
+        assert left == right
+
 
 def test_attribute():
     class Foo(object):
@@ -143,11 +165,11 @@ def globf(x):
 
 class TestRaises(object):
     def test_raises(self):
-        s = "qwe"  # NOQA
-        raises(TypeError, "int(s)")
+        s = "qwe"
+        raises(TypeError, int, s)
 
     def test_raises_doesnt(self):
-        raises(IOError, "int('3')")
+        raises(IOError, int, "3")
 
     def test_raise(self):
         raise ValueError("demo error")
@@ -247,7 +269,7 @@ class TestCustomAssertMsg(object):
         b = 2
         assert (
             A.a == b
-        ), "A.a appears not to be b\n" "or does not appear to be b\none of those"
+        ), "A.a appears not to be b\nor does not appear to be b\none of those"
 
     def test_custom_repr(self):
         class JSON(object):

doc/en/example/assertion/global_testmodule_config/conftest.py

@@ -1,6 +1,7 @@
-import pytest
 import py
 
+import pytest
+
 mydir = py.path.local(__file__).dirpath()
 
 

doc/en/example/assertion/global_testmodule_config/test_hello_world.py

@@ -1,4 +1,3 @@
-
 hello = "world"
 
 

doc/en/example/assertion/test_failures.py

@@ -1,4 +1,3 @@
-
 import py
 
 failure_demo = py.path.local(__file__).dirpath("failure_demo.py")
@@ -10,5 +9,5 @@ def test_failure_demo_fails_properly(testdir):
     failure_demo.copy(target)
     failure_demo.copy(testdir.tmpdir.join(failure_demo.basename))
     result = testdir.runpytest(target, syspathinsert=True)
-    result.stdout.fnmatch_lines(["*42 failed*"])
+    result.stdout.fnmatch_lines(["*44 failed*"])
     assert result.ret != 0

doc/en/example/attic.rst

@@ -24,10 +24,10 @@ example: specifying and selecting acceptance tests
                 pytest.skip("specify -A to run acceptance tests")
             self.tmpdir = request.config.mktemp(request.function.__name__, numbered=True)
 
-        def run(self, cmd):
+        def run(self, *cmd):
             """ called by test code to execute an acceptance test. """
             self.tmpdir.chdir()
-            return py.process.cmdexec(cmd)
+            return subprocess.check_output(cmd).decode()
 
 
 and the actual test function example:
@@ -36,7 +36,7 @@ and the actual test function example:
 
     def test_some_acceptance_aspect(accept):
         accept.tmpdir.mkdir("somesub")
-        result = accept.run("ls -la")
+        result = accept.run("ls", "-la")
         assert "somesub" in result
 
 If you run this test without specifying a command line option

doc/en/example/costlysetup/conftest.py

@@ -1,4 +1,3 @@
-
 import pytest
 
 

doc/en/example/markers.rst

@@ -27,27 +27,31 @@ You can "mark" a test function with custom metadata like this::
 
 .. versionadded:: 2.2
 
-You can then restrict a test run to only run tests marked with ``webtest``::
+You can then restrict a test run to only run tests marked with ``webtest``:
+
+.. code-block:: pytest
 
     $ pytest -v -m webtest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 4 items / 3 deselected
+    collecting ... collected 4 items / 3 deselected / 1 selected
 
     test_server.py::test_send_http PASSED                                [100%]
 
     ================== 1 passed, 3 deselected in 0.12 seconds ==================
 
-Or the inverse, running all tests except the webtest ones::
+Or the inverse, running all tests except the webtest ones:
+
+.. code-block:: pytest
 
     $ pytest -v -m "not webtest"
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 4 items / 1 deselected
+    collecting ... collected 4 items / 1 deselected / 3 selected
 
     test_server.py::test_something_quick PASSED                          [ 33%]
     test_server.py::test_another PASSED                                  [ 66%]
@@ -60,12 +64,14 @@ Selecting tests based on their node ID
 
 You can provide one or more :ref:`node IDs <node-id>` as positional
 arguments to select only specified tests. This makes it easy to select
-tests based on their module, class, method, or function name::
+tests based on their module, class, method, or function name:
+
+.. code-block:: pytest
 
     $ pytest -v test_server.py::TestClass::test_method
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collecting ... collected 1 item
 
@@ -73,12 +79,14 @@ tests based on their module, class, method, or function name::
 
     ========================= 1 passed in 0.12 seconds =========================
 
-You can also select on the class::
+You can also select on the class:
+
+.. code-block:: pytest
 
     $ pytest -v test_server.py::TestClass
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collecting ... collected 1 item
 
@@ -86,19 +94,21 @@ You can also select on the class::
 
     ========================= 1 passed in 0.12 seconds =========================
 
-Or select multiple nodes::
+Or select multiple nodes:
 
-  $ pytest -v test_server.py::TestClass test_server.py::test_send_http
-  =========================== test session starts ============================
-  platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-  cachedir: .pytest_cache
-  rootdir: $REGENDOC_TMPDIR, inifile:
-  collecting ... collected 2 items
+.. code-block:: pytest
 
-  test_server.py::TestClass::test_method PASSED                        [ 50%]
-  test_server.py::test_send_http PASSED                                [100%]
+    $ pytest -v test_server.py::TestClass test_server.py::test_send_http
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR, inifile:
+    collecting ... collected 2 items
 
-  ========================= 2 passed in 0.12 seconds =========================
+    test_server.py::TestClass::test_method PASSED                        [ 50%]
+    test_server.py::test_send_http PASSED                                [100%]
+
+    ========================= 2 passed in 0.12 seconds =========================
 
 .. _node-id:
 
@@ -124,27 +134,31 @@ Using ``-k expr`` to select tests based on their name
 You can use the ``-k`` command line option to specify an expression
 which implements a substring match on the test names instead of the
 exact match on markers that ``-m`` provides.  This makes it easy to
-select tests based on their names::
+select tests based on their names:
+
+.. code-block:: pytest
 
     $ pytest -v -k http  # running with the above defined example module
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 4 items / 3 deselected
+    collecting ... collected 4 items / 3 deselected / 1 selected
 
     test_server.py::test_send_http PASSED                                [100%]
 
     ================== 1 passed, 3 deselected in 0.12 seconds ==================
 
-And you can also run all tests except the ones that match the keyword::
+And you can also run all tests except the ones that match the keyword:
+
+.. code-block:: pytest
 
     $ pytest -k "not send_http" -v
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 4 items / 1 deselected
+    collecting ... collected 4 items / 1 deselected / 3 selected
 
     test_server.py::test_something_quick PASSED                          [ 33%]
     test_server.py::test_another PASSED                                  [ 66%]
@@ -152,14 +166,16 @@ And you can also run all tests except the ones that match the keyword::
 
     ================== 3 passed, 1 deselected in 0.12 seconds ==================
 
-Or to select "http" and "quick" tests::
+Or to select "http" and "quick" tests:
+
+.. code-block:: pytest
 
     $ pytest -k "http or quick" -v
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 4 items / 2 deselected
+    collecting ... collected 4 items / 2 deselected / 2 selected
 
     test_server.py::test_send_http PASSED                                [ 50%]
     test_server.py::test_something_quick PASSED                          [100%]
@@ -271,8 +287,12 @@ You can also set a module level marker::
     import pytest
     pytestmark = pytest.mark.webtest
 
-in which case it will be applied to all functions and
-methods defined in the module.
+or multiple markers::
+
+    pytestmark = [pytest.mark.webtest, pytest.mark.slowtest]
+
+in which case markers will be applied (in left-to-right order) to
+all functions and methods defined in the module.
 
 .. _`marking individual tests when using parametrize`:
 
@@ -288,7 +308,7 @@ apply a marker to an individual test instance::
     @pytest.mark.foo
     @pytest.mark.parametrize(("n", "expected"), [
         (1, 2),
-        pytest.mark.bar((1, 3)),
+        pytest.param((1, 3), marks=pytest.mark.bar),
         (2, 3),
     ])
     def test_increment(n, expected):
@@ -298,15 +318,6 @@ In this example the mark "foo" will apply to each of the three
 tests, whereas the "bar" mark is only applied to the second test.
 Skip and xfail marks can also be applied in this way, see :ref:`skip/xfail with parametrize`.
 
-.. note::
-
-    If the data you are parametrizing happen to be single callables, you need to be careful
-    when marking these items. ``pytest.mark.xfail(my_func)`` won't work because it's also the
-    signature of a function being decorated. To resolve this ambiguity, you need to pass a
-    reason argument:
-    ``pytest.mark.xfail(func_bar, reason="Issue#7")``.
-
-
 .. _`adding a custom marker from a plugin`:
 
 Custom marker and command line option to control test runs
@@ -347,11 +358,14 @@ A test file using this local plugin::
         pass
 
 and an example invocations specifying a different environment than what
-the test needs::
+the test needs:
+
+.. code-block:: pytest
 
     $ pytest -E stage2
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 1 item
 
@@ -359,11 +373,14 @@ the test needs::
 
     ======================== 1 skipped in 0.12 seconds =========================
 
-and here is one that specifies exactly the environment needed::
+and here is one that specifies exactly the environment needed:
+
+.. code-block:: pytest
 
     $ pytest -E stage1
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 1 item
 
@@ -424,7 +441,9 @@ However, if there is a callable as the single positional argument with no keywor
     def test_with_args():
         pass
 
-The output is as follows::
+The output is as follows:
+
+.. code-block:: pytest
 
     $ pytest -q -s
     Mark(name='my_marker', args=(<function hello_world at 0xdeadbeef>,), kwargs={})
@@ -462,10 +481,12 @@ test function.  From a conftest file we can read it like this::
 
     def pytest_runtest_setup(item):
         for mark in item.iter_markers(name='glob'):
-            print ("glob args=%s kwargs=%s" %(mark.args, mark.kwargs))
+            print("glob args=%s kwargs=%s" % (mark.args, mark.kwargs))
             sys.stdout.flush()
 
-Let's run this without capturing output and see what we get::
+Let's run this without capturing output and see what we get:
+
+.. code-block:: pytest
 
     $ pytest -q -s
     glob args=('function',) kwargs={'x': 3}
@@ -520,27 +541,33 @@ Let's do a little test file to show how this looks like::
     def test_runs_everywhere():
         pass
 
-then you will see two tests skipped and two executed tests as expected::
+then you will see two tests skipped and two executed tests as expected:
+
+.. code-block:: pytest
 
     $ pytest -rs # this option reports skip reasons
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 4 items
 
     test_plat.py s.s.                                                    [100%]
     ========================= short test summary info ==========================
-    SKIP [2] $REGENDOC_TMPDIR/conftest.py:12: cannot run on platform linux
+    SKIPPED [2] $REGENDOC_TMPDIR/conftest.py:12: cannot run on platform linux
 
     =================== 2 passed, 2 skipped in 0.12 seconds ====================
 
-Note that if you specify a platform via the marker-command line option like this::
+Note that if you specify a platform via the marker-command line option like this:
+
+.. code-block:: pytest
 
     $ pytest -m linux
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 4 items / 3 deselected
+    collected 4 items / 3 deselected / 1 selected
 
     test_plat.py .                                                       [100%]
 
@@ -585,48 +612,54 @@ We want to dynamically define two markers and can do it in a
             elif "event" in item.nodeid:
                 item.add_marker(pytest.mark.event)
 
-We can now use the ``-m option`` to select one set::
+We can now use the ``-m option`` to select one set:
 
-  $ pytest -m interface --tb=short
-  =========================== test session starts ============================
-  platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
-  rootdir: $REGENDOC_TMPDIR, inifile:
-  collected 4 items / 2 deselected
+.. code-block:: pytest
 
-  test_module.py FF                                                    [100%]
+    $ pytest -m interface --tb=short
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR, inifile:
+    collected 4 items / 2 deselected / 2 selected
 
-  ================================= FAILURES =================================
-  __________________________ test_interface_simple ___________________________
-  test_module.py:3: in test_interface_simple
-      assert 0
-  E   assert 0
-  __________________________ test_interface_complex __________________________
-  test_module.py:6: in test_interface_complex
-      assert 0
-  E   assert 0
-  ================== 2 failed, 2 deselected in 0.12 seconds ==================
+    test_module.py FF                                                    [100%]
 
-or to select both "event" and "interface" tests::
+    ================================= FAILURES =================================
+    __________________________ test_interface_simple ___________________________
+    test_module.py:3: in test_interface_simple
+        assert 0
+    E   assert 0
+    __________________________ test_interface_complex __________________________
+    test_module.py:6: in test_interface_complex
+        assert 0
+    E   assert 0
+    ================== 2 failed, 2 deselected in 0.12 seconds ==================
 
-  $ pytest -m "interface or event" --tb=short
-  =========================== test session starts ============================
-  platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
-  rootdir: $REGENDOC_TMPDIR, inifile:
-  collected 4 items / 1 deselected
+or to select both "event" and "interface" tests:
 
-  test_module.py FFF                                                   [100%]
+.. code-block:: pytest
 
-  ================================= FAILURES =================================
-  __________________________ test_interface_simple ___________________________
-  test_module.py:3: in test_interface_simple
-      assert 0
-  E   assert 0
-  __________________________ test_interface_complex __________________________
-  test_module.py:6: in test_interface_complex
-      assert 0
-  E   assert 0
-  ____________________________ test_event_simple _____________________________
-  test_module.py:9: in test_event_simple
-      assert 0
-  E   assert 0
-  ================== 3 failed, 1 deselected in 0.12 seconds ==================
+    $ pytest -m "interface or event" --tb=short
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR, inifile:
+    collected 4 items / 1 deselected / 3 selected
+
+    test_module.py FFF                                                   [100%]
+
+    ================================= FAILURES =================================
+    __________________________ test_interface_simple ___________________________
+    test_module.py:3: in test_interface_simple
+        assert 0
+    E   assert 0
+    __________________________ test_interface_complex __________________________
+    test_module.py:6: in test_interface_complex
+        assert 0
+    E   assert 0
+    ____________________________ test_event_simple _____________________________
+    test_module.py:9: in test_event_simple
+        assert 0
+    E   assert 0
+    ================== 3 failed, 1 deselected in 0.12 seconds ==================

doc/en/example/multipython.py

@@ -2,9 +2,10 @@
 module containing a parametrized tests testing cross-python
 serialization via the pickle module.
 """
+import distutils.spawn
+import subprocess
 import textwrap
 
-import py
 import pytest
 
 pythonlist = ["python2.7", "python3.4", "python3.5"]
@@ -23,7 +24,7 @@ def python2(request, python1):
 
 class Python(object):
     def __init__(self, version, picklefile):
-        self.pythonpath = py.path.local.sysfind(version)
+        self.pythonpath = distutils.spawn.find_executable(version)
         if not self.pythonpath:
             pytest.skip("{!r} not found".format(version))
         self.picklefile = picklefile
@@ -32,7 +33,7 @@ class Python(object):
         dumpfile = self.picklefile.dirpath("dump.py")
         dumpfile.write(
             textwrap.dedent(
-                """\
+                r"""
                 import pickle
                 f = open({!r}, 'wb')
                 s = pickle.dump({!r}, f, protocol=2)
@@ -42,13 +43,13 @@ class Python(object):
                 )
             )
         )
-        py.process.cmdexec("{} {}".format(self.pythonpath, dumpfile))
+        subprocess.check_call((self.pythonpath, str(dumpfile)))
 
     def load_and_is_true(self, expression):
         loadfile = self.picklefile.dirpath("load.py")
         loadfile.write(
             textwrap.dedent(
-                """\
+                r"""
                 import pickle
                 f = open({!r}, 'rb')
                 obj = pickle.load(f)
@@ -62,7 +63,7 @@ class Python(object):
             )
         )
         print(loadfile)
-        py.process.cmdexec("{} {}".format(self.pythonpath, loadfile))
+        subprocess.check_call((self.pythonpath, str(loadfile)))
 
 
 @pytest.mark.parametrize("obj", [42, {}, {1: 3}])

doc/en/example/nonpython.rst

@@ -23,11 +23,14 @@ You can create a simple example file:
     :literal:
 
 and if you installed `PyYAML`_ or a compatible YAML-parser you can
-now execute the test specification::
+now execute the test specification:
+
+.. code-block:: pytest
 
     nonpython $ pytest test_simple.yml
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR/nonpython, inifile:
     collected 2 items
 
@@ -55,12 +58,14 @@ your own domain specific testing language this way.
     will be reported as a (red) string.
 
 ``reportinfo()`` is used for representing the test location and is also
-consulted when reporting in ``verbose`` mode::
+consulted when reporting in ``verbose`` mode:
+
+.. code-block:: pytest
 
     nonpython $ pytest -v
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR/nonpython, inifile:
     collecting ... collected 2 items
 
@@ -77,16 +82,19 @@ consulted when reporting in ``verbose`` mode::
 .. regendoc:wipe
 
 While developing your custom test collection and execution it's also
-interesting to just look at the collection tree::
+interesting to just look at the collection tree:
+
+.. code-block:: pytest
 
     nonpython $ pytest --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR/nonpython, inifile:
     collected 2 items
-    <Package '$REGENDOC_TMPDIR/nonpython'>
-      <YamlFile 'test_simple.yml'>
-        <YamlItem 'hello'>
-        <YamlItem 'ok'>
+    <Package $REGENDOC_TMPDIR/nonpython>
+      <YamlFile test_simple.yml>
+        <YamlItem hello>
+        <YamlItem ok>
 
     ======================= no tests ran in 0.12 seconds =======================

doc/en/example/nonpython/conftest.py

@@ -1,5 +1,4 @@
 # content of conftest.py
-
 import pytest
 
 

doc/en/example/parametrize.rst

@@ -42,14 +42,18 @@ Now we add a test configuration like this::
                 end = 2
             metafunc.parametrize("param1", range(end))
 
-This means that we only run 2 tests if we do not pass ``--all``::
+This means that we only run 2 tests if we do not pass ``--all``:
+
+.. code-block:: pytest
 
     $ pytest -q test_compute.py
     ..                                                                   [100%]
     2 passed in 0.12 seconds
 
 We run only two computations, so we see two dots.
-let's run the full monty::
+let's run the full monty:
+
+.. code-block:: pytest
 
     $ pytest -q --all
     ....F                                                                [100%]
@@ -134,23 +138,25 @@ used as the test IDs. These are succinct, but can be a pain to maintain.
 In ``test_timedistance_v2``, we specified ``ids`` as a function that can generate a
 string representation to make part of the test ID. So our ``datetime`` values use the
 label generated by ``idfn``, but because we didn't generate a label for ``timedelta``
-objects, they are still using the default pytest representation::
+objects, they are still using the default pytest representation:
 
+.. code-block:: pytest
 
     $ pytest test_time.py --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 8 items
-    <Module 'test_time.py'>
-      <Function 'test_timedistance_v0[a0-b0-expected0]'>
-      <Function 'test_timedistance_v0[a1-b1-expected1]'>
-      <Function 'test_timedistance_v1[forward]'>
-      <Function 'test_timedistance_v1[backward]'>
-      <Function 'test_timedistance_v2[20011212-20011211-expected0]'>
-      <Function 'test_timedistance_v2[20011211-20011212-expected1]'>
-      <Function 'test_timedistance_v3[forward]'>
-      <Function 'test_timedistance_v3[backward]'>
+    <Module test_time.py>
+      <Function test_timedistance_v0[a0-b0-expected0]>
+      <Function test_timedistance_v0[a1-b1-expected1]>
+      <Function test_timedistance_v1[forward]>
+      <Function test_timedistance_v1[backward]>
+      <Function test_timedistance_v2[20011212-20011211-expected0]>
+      <Function test_timedistance_v2[20011211-20011212-expected1]>
+      <Function test_timedistance_v3[forward]>
+      <Function test_timedistance_v3[backward]>
 
     ======================= no tests ran in 0.12 seconds =======================
 
@@ -191,11 +197,14 @@ only have to work a bit to construct the correct arguments for pytest's
         def test_demo2(self, attribute):
             assert isinstance(attribute, str)
 
-this is a fully self-contained example which you can run with::
+this is a fully self-contained example which you can run with:
+
+.. code-block:: pytest
 
     $ pytest test_scenarios.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 4 items
 
@@ -203,21 +212,22 @@ this is a fully self-contained example which you can run with::
 
     ========================= 4 passed in 0.12 seconds =========================
 
-If you just collect tests you'll also nicely see 'advanced' and 'basic' as variants for the test function::
+If you just collect tests you'll also nicely see 'advanced' and 'basic' as variants for the test function:
 
+.. code-block:: pytest
 
     $ pytest --collect-only test_scenarios.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 4 items
-    <Module 'test_scenarios.py'>
-      <Class 'TestSampleWithScenarios'>
-        <Instance '()'>
-          <Function 'test_demo1[basic]'>
-          <Function 'test_demo2[basic]'>
-          <Function 'test_demo1[advanced]'>
-          <Function 'test_demo2[advanced]'>
+    <Module test_scenarios.py>
+      <Class TestSampleWithScenarios>
+          <Function test_demo1[basic]>
+          <Function test_demo2[basic]>
+          <Function test_demo1[advanced]>
+          <Function test_demo2[advanced]>
 
     ======================= no tests ran in 0.12 seconds =======================
 
@@ -269,20 +279,25 @@ creates a database object for the actual test invocations::
         else:
             raise ValueError("invalid internal test config")
 
-Let's first see how it looks like at collection time::
+Let's first see how it looks like at collection time:
+
+.. code-block:: pytest
 
     $ pytest test_backends.py --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 2 items
-    <Module 'test_backends.py'>
-      <Function 'test_db_initialized[d1]'>
-      <Function 'test_db_initialized[d2]'>
+    <Module test_backends.py>
+      <Function test_db_initialized[d1]>
+      <Function test_db_initialized[d2]>
 
     ======================= no tests ran in 0.12 seconds =======================
 
-And then when we run the test::
+And then when we run the test:
+
+.. code-block:: pytest
 
     $ pytest -q test_backends.py
     .F                                                                   [100%]
@@ -330,15 +345,18 @@ will be passed to respective fixture function::
         assert x == 'aaa'
         assert y == 'b'
 
-The result of this test will be successful::
+The result of this test will be successful:
+
+.. code-block:: pytest
 
     $ pytest test_indirect_list.py --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 1 item
-    <Module 'test_indirect_list.py'>
-      <Function 'test_indirect[a-b]'>
+    <Module test_indirect_list.py>
+      <Function test_indirect[a-b]>
 
     ======================= no tests ran in 0.12 seconds =======================
 
@@ -375,10 +393,13 @@ parametrizer`_ but in a lot less code::
             assert a == b
 
         def test_zerodivision(self, a, b):
-            pytest.raises(ZeroDivisionError, "a/b")
+            with pytest.raises(ZeroDivisionError):
+                a / b
 
 Our test generator looks up a class-level definition which specifies which
-argument sets to use for each test function.  Let's run it::
+argument sets to use for each test function.  Let's run it:
+
+.. code-block:: pytest
 
     $ pytest -q
     F..                                                                  [100%]
@@ -390,6 +411,8 @@ argument sets to use for each test function.  Let's run it::
         def test_equals(self, a, b):
     >       assert a == b
     E       assert 1 == 2
+    E         -1
+    E         +2
 
     test_parametrize.py:18: AssertionError
     1 failed, 2 passed in 0.12 seconds
@@ -408,13 +431,13 @@ is to be run with different sets of arguments for its three arguments:
 
 .. literalinclude:: multipython.py
 
-Running it results in some skips if we don't have all the python interpreters installed and otherwise runs all combinations (5 interpreters times 5 interpreters times 3 objects to serialize/deserialize)::
+Running it results in some skips if we don't have all the python interpreters installed and otherwise runs all combinations (5 interpreters times 5 interpreters times 3 objects to serialize/deserialize):
+
+.. code-block:: pytest
 
    . $ pytest -rs -q multipython.py
-   ...sss...sssssssss...sss...                                          [100%]
-   ========================= short test summary info ==========================
-   SKIP [15] $REGENDOC_TMPDIR/CWD/multipython.py:29: 'python3.4' not found
-   12 passed, 15 skipped in 0.12 seconds
+   ...........................                                          [100%]
+   27 passed in 0.12 seconds
 
 Indirect parametrization of optional implementations/imports
 --------------------------------------------------------------------
@@ -457,17 +480,20 @@ And finally a little test module::
         assert round(basemod.func1(), 3) == round(optmod.func1(), 3)
 
 
-If you run this with reporting for skips enabled::
+If you run this with reporting for skips enabled:
+
+.. code-block:: pytest
 
     $ pytest -rs test_module.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 2 items
 
     test_module.py .s                                                    [100%]
     ========================= short test summary info ==========================
-    SKIP [1] $REGENDOC_TMPDIR/conftest.py:11: could not import 'opt2'
+    SKIPPED [1] $REGENDOC_TMPDIR/conftest.py:11: could not import 'opt2'
 
     =================== 1 passed, 1 skipped in 0.12 seconds ====================
 
@@ -512,21 +538,22 @@ we mark the rest three parametrized tests with the custom marker ``basic``,
 and for the fourth test we also use the built-in mark ``xfail`` to indicate this
 test is expected to fail. For explicitness, we set test ids for some tests.
 
-Then run ``pytest`` with verbose mode and with only the ``basic`` marker::
+Then run ``pytest`` with verbose mode and with only the ``basic`` marker:
 
-    pytest -v -m basic
-    ============================================ test session starts =============================================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+.. code-block:: pytest
+
+    $ pytest -v -m basic
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 4 items
+    collecting ... collected 17 items / 14 deselected / 3 selected
 
-    test_pytest_param_example.py::test_eval[1+7-8] PASSED
-    test_pytest_param_example.py::test_eval[basic_2+4] PASSED
-    test_pytest_param_example.py::test_eval[basic_6*9] xfail
-    ========================================== short test summary info ===========================================
-    XFAIL test_pytest_param_example.py::test_eval[basic_6*9]
+    test_pytest_param_example.py::test_eval[1+7-8] PASSED                [ 33%]
+    test_pytest_param_example.py::test_eval[basic_2+4] PASSED            [ 66%]
+    test_pytest_param_example.py::test_eval[basic_6*9] XFAIL             [100%]
 
-    ============================================= 1 tests deselected =============================================
+    ============ 2 passed, 14 deselected, 1 xfailed in 0.12 seconds ============
 
 As the result:
 
@@ -536,3 +563,50 @@ As the result:
 - The test ``test_eval[1+7-8]`` passed, but the name is autogenerated and confusing.
 - The test ``test_eval[basic_2+4]`` passed.
 - The test ``test_eval[basic_6*9]`` was expected to fail and did fail.
+
+.. _`parametrizing_conditional_raising`:
+
+Parametrizing conditional raising
+--------------------------------------------------------------------
+
+Use :func:`pytest.raises` with the
+:ref:`pytest.mark.parametrize ref` decorator to write parametrized tests
+in which some tests raise exceptions and others do not.
+
+It is helpful to define a no-op context manager ``does_not_raise`` to serve
+as a complement to ``raises``. For example::
+
+    from contextlib import contextmanager
+    import pytest
+
+    @contextmanager
+    def does_not_raise():
+        yield
+
+
+    @pytest.mark.parametrize('example_input,expectation', [
+        (3, does_not_raise()),
+        (2, does_not_raise()),
+        (1, does_not_raise()),
+        (0, pytest.raises(ZeroDivisionError)),
+    ])
+    def test_division(example_input, expectation):
+        """Test how much I know division."""
+        with expectation:
+            assert (6 / example_input) is not None
+
+In the example above, the first three test cases should run unexceptionally,
+while the fourth should raise ``ZeroDivisionError``.
+
+If you're only supporting Python 3.7+, you can simply use ``nullcontext``
+to define ``does_not_raise``::
+
+    from contextlib import nullcontext as does_not_raise
+
+Or, if you're supporting Python 3.3+ you can use::
+
+    from contextlib import ExitStack as does_not_raise
+
+Or, if desired, you can ``pip install contextlib2`` and use::
+
+    from contextlib2 import ExitStack as does_not_raise

doc/en/example/py2py3/conftest.py

@@ -1,4 +1,5 @@
 import sys
+
 import pytest
 
 py3 = sys.version_info[0] >= 3

doc/en/example/py2py3/test_py2.py

@@ -1,6 +1,5 @@
-
 def test_exception_syntax():
     try:
-        0/0
+        0 / 0
     except ZeroDivisionError, e:
-        pass
+        assert e

doc/en/example/py2py3/test_py3.py

@@ -2,4 +2,4 @@ def test_exception_syntax():
     try:
         0 / 0
     except ZeroDivisionError as e:
-        pass
+        assert e

doc/en/example/pythoncollection.rst

@@ -24,20 +24,25 @@ by passing the ``--ignore=path`` option on the cli. ``pytest`` allows multiple
             '-- test_world_03.py
 
 Now if you invoke ``pytest`` with ``--ignore=tests/foobar/test_foobar_03.py --ignore=tests/hello/``,
-you will see that ``pytest`` only collects test-modules, which do not match the patterns specified::
+you will see that ``pytest`` only collects test-modules, which do not match the patterns specified:
 
-    ========= test session starts ==========
-    platform darwin -- Python 2.7.10, pytest-2.8.2, py-1.4.30, pluggy-0.3.1
+.. code-block:: pytest
+
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 5 items
 
-    tests/example/test_example_01.py .
-    tests/example/test_example_02.py .
-    tests/example/test_example_03.py .
-    tests/foobar/test_foobar_01.py .
-    tests/foobar/test_foobar_02.py .
+    tests/example/test_example_01.py .                                   [ 20%]
+    tests/example/test_example_02.py .                                   [ 40%]
+    tests/example/test_example_03.py .                                   [ 60%]
+    tests/foobar/test_foobar_01.py .                                     [ 80%]
+    tests/foobar/test_foobar_02.py .                                     [100%]
 
-    ======= 5 passed in 0.02 seconds =======
+    ========================= 5 passed in 0.02 seconds =========================
+
+The ``--ignore-glob`` option allows to ignore test file paths based on Unix shell-style wildcards.
+If you want to exclude test-modules that end with ``_01.py``, execute ``pytest`` with ``--ignore-glob='*_01.py'``.
 
 Deselect tests during test collection
 -------------------------------------
@@ -123,18 +128,20 @@ that match ``*_check``. For example, if we have::
         def complex_check(self):
             pass
 
-The test collection would look like this::
+The test collection would look like this:
+
+.. code-block:: pytest
 
     $ pytest --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 2 items
-    <Module 'check_myapp.py'>
-      <Class 'CheckMyApp'>
-        <Instance '()'>
-          <Function 'simple_check'>
-          <Function 'complex_check'>
+    <Module check_myapp.py>
+      <Class CheckMyApp>
+          <Function simple_check>
+          <Function complex_check>
 
     ======================= no tests ran in 0.12 seconds =======================
 
@@ -177,19 +184,21 @@ treat it as a filesystem path.
 Finding out what is collected
 -----------------------------------------------
 
-You can always peek at the collection tree without running tests like this::
+You can always peek at the collection tree without running tests like this:
+
+.. code-block:: pytest
 
     . $ pytest --collect-only pythoncollection.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 3 items
-    <Module 'CWD/pythoncollection.py'>
-      <Function 'test_function'>
-      <Class 'TestClass'>
-        <Instance '()'>
-          <Function 'test_method'>
-          <Function 'test_anothermethod'>
+    <Module CWD/pythoncollection.py>
+      <Function test_function>
+      <Class TestClass>
+          <Function test_method>
+          <Function test_anothermethod>
 
     ======================= no tests ran in 0.12 seconds =======================
 
@@ -233,7 +242,9 @@ and a ``setup.py`` dummy file like this::
     0/0  # will raise exception if imported
 
 If you run with a Python 2 interpreter then you will find the one test and will
-leave out the ``setup.py`` file::
+leave out the ``setup.py`` file:
+
+.. code-block:: pytest
 
     #$ pytest --collect-only
     ====== test session starts ======
@@ -246,12 +257,29 @@ leave out the ``setup.py`` file::
     ====== no tests ran in 0.04 seconds ======
 
 If you run with a Python 3 interpreter both the one test and the ``setup.py``
-file will be left out::
+file will be left out:
+
+.. code-block:: pytest
 
     $ pytest --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 0 items
 
     ======================= no tests ran in 0.12 seconds =======================
+
+It's also possible to ignore files based on Unix shell-style wildcards by adding
+patterns to ``collect_ignore_glob``.
+
+The following example ``conftest.py`` ignores the file ``setup.py`` and in
+addition all files that end with ``*_py2.py`` when executed with a Python 3
+interpreter::
+
+    # content of conftest.py
+    import sys
+
+    collect_ignore = ["setup.py"]
+    if sys.version_info[0] > 2:
+        collect_ignore_glob = ["*_py2.py"]

doc/en/example/reportingdemo.rst

@@ -7,26 +7,30 @@ Demo of Python failure reports with pytest
 Here is a nice run of several tens of failures
 and how ``pytest`` presents things (unfortunately
 not showing the nice colors here in the HTML that you
-get on the terminal - we are working on that)::
+get on the terminal - we are working on that):
+
+.. code-block:: pytest
 
     assertion $ pytest failure_demo.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR/assertion, inifile:
-    collected 42 items
+    collected 44 items
 
-    failure_demo.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF           [100%]
+    failure_demo.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF         [100%]
 
     ================================= FAILURES =================================
-    ____________________________ test_generative[0] ____________________________
+    ___________________________ test_generative[3-6] ___________________________
 
     param1 = 3, param2 = 6
 
+        @pytest.mark.parametrize("param1, param2", [(3, 6)])
         def test_generative(param1, param2):
     >       assert param1 * 2 < param2
     E       assert (3 * 2) < 6
 
-    failure_demo.py:19: AssertionError
+    failure_demo.py:22: AssertionError
     _________________________ TestFailing.test_simple __________________________
 
     self = <failure_demo.TestFailing object at 0xdeadbeef>
@@ -43,7 +47,7 @@ get on the terminal - we are working on that)::
     E        +  where 42 = <function TestFailing.test_simple.<locals>.f at 0xdeadbeef>()
     E        +  and   43 = <function TestFailing.test_simple.<locals>.g at 0xdeadbeef>()
 
-    failure_demo.py:35: AssertionError
+    failure_demo.py:33: AssertionError
     ____________________ TestFailing.test_simple_multiline _____________________
 
     self = <failure_demo.TestFailing object at 0xdeadbeef>
@@ -51,7 +55,7 @@ get on the terminal - we are working on that)::
         def test_simple_multiline(self):
     >       otherfunc_multi(42, 6 * 9)
 
-    failure_demo.py:38:
+    failure_demo.py:36:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
     a = 42, b = 54
@@ -60,7 +64,7 @@ get on the terminal - we are working on that)::
     >       assert a == b
     E       assert 42 == 54
 
-    failure_demo.py:15: AssertionError
+    failure_demo.py:17: AssertionError
     ___________________________ TestFailing.test_not ___________________________
 
     self = <failure_demo.TestFailing object at 0xdeadbeef>
@@ -73,7 +77,7 @@ get on the terminal - we are working on that)::
     E       assert not 42
     E        +  where 42 = <function TestFailing.test_not.<locals>.f at 0xdeadbeef>()
 
-    failure_demo.py:44: AssertionError
+    failure_demo.py:42: AssertionError
     _________________ TestSpecialisedExplanations.test_eq_text _________________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -84,7 +88,7 @@ get on the terminal - we are working on that)::
     E         - spam
     E         + eggs
 
-    failure_demo.py:49: AssertionError
+    failure_demo.py:47: AssertionError
     _____________ TestSpecialisedExplanations.test_eq_similar_text _____________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -97,7 +101,7 @@ get on the terminal - we are working on that)::
     E         + foo 2 bar
     E         ?     ^
 
-    failure_demo.py:52: AssertionError
+    failure_demo.py:50: AssertionError
     ____________ TestSpecialisedExplanations.test_eq_multiline_text ____________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -110,7 +114,7 @@ get on the terminal - we are working on that)::
     E         + eggs
     E           bar
 
-    failure_demo.py:55: AssertionError
+    failure_demo.py:53: AssertionError
     ______________ TestSpecialisedExplanations.test_eq_long_text _______________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -127,7 +131,7 @@ get on the terminal - we are working on that)::
     E         + 1111111111b222222222
     E         ?           ^
 
-    failure_demo.py:60: AssertionError
+    failure_demo.py:58: AssertionError
     _________ TestSpecialisedExplanations.test_eq_long_text_multiline __________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -147,7 +151,7 @@ get on the terminal - we are working on that)::
     E
     E         ...Full output truncated (7 lines hidden), use '-vv' to show
 
-    failure_demo.py:65: AssertionError
+    failure_demo.py:63: AssertionError
     _________________ TestSpecialisedExplanations.test_eq_list _________________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -158,7 +162,7 @@ get on the terminal - we are working on that)::
     E         At index 2 diff: 2 != 3
     E         Use -v to get the full diff
 
-    failure_demo.py:68: AssertionError
+    failure_demo.py:66: AssertionError
     ______________ TestSpecialisedExplanations.test_eq_list_long _______________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -171,7 +175,7 @@ get on the terminal - we are working on that)::
     E         At index 100 diff: 1 != 2
     E         Use -v to get the full diff
 
-    failure_demo.py:73: AssertionError
+    failure_demo.py:71: AssertionError
     _________________ TestSpecialisedExplanations.test_eq_dict _________________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -189,7 +193,7 @@ get on the terminal - we are working on that)::
     E
     E         ...Full output truncated (2 lines hidden), use '-vv' to show
 
-    failure_demo.py:76: AssertionError
+    failure_demo.py:74: AssertionError
     _________________ TestSpecialisedExplanations.test_eq_set __________________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -207,7 +211,7 @@ get on the terminal - we are working on that)::
     E
     E         ...Full output truncated (2 lines hidden), use '-vv' to show
 
-    failure_demo.py:79: AssertionError
+    failure_demo.py:77: AssertionError
     _____________ TestSpecialisedExplanations.test_eq_longer_list ______________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -218,7 +222,7 @@ get on the terminal - we are working on that)::
     E         Right contains more items, first extra item: 3
     E         Use -v to get the full diff
 
-    failure_demo.py:82: AssertionError
+    failure_demo.py:80: AssertionError
     _________________ TestSpecialisedExplanations.test_in_list _________________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -227,7 +231,7 @@ get on the terminal - we are working on that)::
     >       assert 1 in [0, 2, 3, 4, 5]
     E       assert 1 in [0, 2, 3, 4, 5]
 
-    failure_demo.py:85: AssertionError
+    failure_demo.py:83: AssertionError
     __________ TestSpecialisedExplanations.test_not_in_text_multiline __________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -246,7 +250,7 @@ get on the terminal - we are working on that)::
     E
     E         ...Full output truncated (2 lines hidden), use '-vv' to show
 
-    failure_demo.py:89: AssertionError
+    failure_demo.py:87: AssertionError
     ___________ TestSpecialisedExplanations.test_not_in_text_single ____________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -259,7 +263,7 @@ get on the terminal - we are working on that)::
     E           single foo line
     E         ?        +++
 
-    failure_demo.py:93: AssertionError
+    failure_demo.py:91: AssertionError
     _________ TestSpecialisedExplanations.test_not_in_text_single_long _________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -272,7 +276,7 @@ get on the terminal - we are working on that)::
     E           head head foo tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail
     E         ?           +++
 
-    failure_demo.py:97: AssertionError
+    failure_demo.py:95: AssertionError
     ______ TestSpecialisedExplanations.test_not_in_text_single_long_term _______
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -285,7 +289,49 @@ get on the terminal - we are working on that)::
     E           head head fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffftail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail
     E         ?           ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-    failure_demo.py:101: AssertionError
+    failure_demo.py:99: AssertionError
+    ______________ TestSpecialisedExplanations.test_eq_dataclass _______________
+
+    self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
+
+        def test_eq_dataclass(self):
+            from dataclasses import dataclass
+
+            @dataclass
+            class Foo(object):
+                a: int
+                b: str
+
+            left = Foo(1, "b")
+            right = Foo(1, "c")
+    >       assert left == right
+    E       AssertionError: assert TestSpecialis...oo(a=1, b='b') == TestSpecialise...oo(a=1, b='c')
+    E         Omitting 1 identical items, use -vv to show
+    E         Differing attributes:
+    E         b: 'b' != 'c'
+
+    failure_demo.py:111: AssertionError
+    ________________ TestSpecialisedExplanations.test_eq_attrs _________________
+
+    self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
+
+        def test_eq_attrs(self):
+            import attr
+
+            @attr.s
+            class Foo(object):
+                a = attr.ib()
+                b = attr.ib()
+
+            left = Foo(1, "b")
+            right = Foo(1, "c")
+    >       assert left == right
+    E       AssertionError: assert Foo(a=1, b='b') == Foo(a=1, b='c')
+    E         Omitting 1 identical items, use -vv to show
+    E         Differing attributes:
+    E         b: 'b' != 'c'
+
+    failure_demo.py:123: AssertionError
     ______________________________ test_attribute ______________________________
 
         def test_attribute():
@@ -297,7 +343,7 @@ get on the terminal - we are working on that)::
     E       assert 1 == 2
     E        +  where 1 = <failure_demo.test_attribute.<locals>.Foo object at 0xdeadbeef>.b
 
-    failure_demo.py:109: AssertionError
+    failure_demo.py:131: AssertionError
     _________________________ test_attribute_instance __________________________
 
         def test_attribute_instance():
@@ -309,7 +355,7 @@ get on the terminal - we are working on that)::
     E        +  where 1 = <failure_demo.test_attribute_instance.<locals>.Foo object at 0xdeadbeef>.b
     E        +    where <failure_demo.test_attribute_instance.<locals>.Foo object at 0xdeadbeef> = <class 'failure_demo.test_attribute_instance.<locals>.Foo'>()
 
-    failure_demo.py:116: AssertionError
+    failure_demo.py:138: AssertionError
     __________________________ test_attribute_failure __________________________
 
         def test_attribute_failure():
@@ -322,7 +368,7 @@ get on the terminal - we are working on that)::
             i = Foo()
     >       assert i.b == 2
 
-    failure_demo.py:127:
+    failure_demo.py:149:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
     self = <failure_demo.test_attribute_failure.<locals>.Foo object at 0xdeadbeef>
@@ -331,7 +377,7 @@ get on the terminal - we are working on that)::
     >       raise Exception("Failed to get attrib")
     E       Exception: Failed to get attrib
 
-    failure_demo.py:122: Exception
+    failure_demo.py:144: Exception
     _________________________ test_attribute_multiple __________________________
 
         def test_attribute_multiple():
@@ -348,31 +394,26 @@ get on the terminal - we are working on that)::
     E        +  and   2 = <failure_demo.test_attribute_multiple.<locals>.Bar object at 0xdeadbeef>.b
     E        +    where <failure_demo.test_attribute_multiple.<locals>.Bar object at 0xdeadbeef> = <class 'failure_demo.test_attribute_multiple.<locals>.Bar'>()
 
-    failure_demo.py:137: AssertionError
+    failure_demo.py:159: AssertionError
     __________________________ TestRaises.test_raises __________________________
 
     self = <failure_demo.TestRaises object at 0xdeadbeef>
 
         def test_raises(self):
-            s = "qwe"  # NOQA
-    >       raises(TypeError, "int(s)")
+            s = "qwe"
+    >       raises(TypeError, int, s)
+    E       ValueError: invalid literal for int() with base 10: 'qwe'
 
-    failure_demo.py:147:
-    _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
-
-    >   int(s)
-    E   ValueError: invalid literal for int() with base 10: 'qwe'
-
-    <0-codegen $PYTHON_PREFIX/lib/python3.6/site-packages/_pytest/python_api.py:682>:1: ValueError
+    failure_demo.py:169: ValueError
     ______________________ TestRaises.test_raises_doesnt _______________________
 
     self = <failure_demo.TestRaises object at 0xdeadbeef>
 
         def test_raises_doesnt(self):
-    >       raises(IOError, "int('3')")
+    >       raises(IOError, int, "3")
     E       Failed: DID NOT RAISE <class 'OSError'>
 
-    failure_demo.py:150: Failed
+    failure_demo.py:172: Failed
     __________________________ TestRaises.test_raise ___________________________
 
     self = <failure_demo.TestRaises object at 0xdeadbeef>
@@ -381,7 +422,7 @@ get on the terminal - we are working on that)::
     >       raise ValueError("demo error")
     E       ValueError: demo error
 
-    failure_demo.py:153: ValueError
+    failure_demo.py:175: ValueError
     ________________________ TestRaises.test_tupleerror ________________________
 
     self = <failure_demo.TestRaises object at 0xdeadbeef>
@@ -390,7 +431,7 @@ get on the terminal - we are working on that)::
     >       a, b = [1]  # NOQA
     E       ValueError: not enough values to unpack (expected 2, got 1)
 
-    failure_demo.py:156: ValueError
+    failure_demo.py:178: ValueError
     ______ TestRaises.test_reinterpret_fails_with_print_for_the_fun_of_it ______
 
     self = <failure_demo.TestRaises object at 0xdeadbeef>
@@ -401,7 +442,7 @@ get on the terminal - we are working on that)::
     >       a, b = items.pop()
     E       TypeError: 'int' object is not iterable
 
-    failure_demo.py:161: TypeError
+    failure_demo.py:183: TypeError
     --------------------------- Captured stdout call ---------------------------
     items is [1, 2, 3]
     ________________________ TestRaises.test_some_error ________________________
@@ -412,7 +453,7 @@ get on the terminal - we are working on that)::
     >       if namenotexi:  # NOQA
     E       NameError: name 'namenotexi' is not defined
 
-    failure_demo.py:164: NameError
+    failure_demo.py:186: NameError
     ____________________ test_dynamic_compile_shows_nicely _____________________
 
         def test_dynamic_compile_shows_nicely():
@@ -427,14 +468,14 @@ get on the terminal - we are working on that)::
             sys.modules[name] = module
     >       module.foo()
 
-    failure_demo.py:182:
+    failure_demo.py:204:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
         def foo():
     >    assert 1 == 0
     E    AssertionError
 
-    <2-codegen 'abc-123' $REGENDOC_TMPDIR/assertion/failure_demo.py:179>:2: AssertionError
+    <0-codegen 'abc-123' $REGENDOC_TMPDIR/assertion/failure_demo.py:201>:2: AssertionError
     ____________________ TestMoreErrors.test_complex_error _____________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -448,9 +489,9 @@ get on the terminal - we are working on that)::
 
     >       somefunc(f(), g())
 
-    failure_demo.py:193:
+    failure_demo.py:215:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
-    failure_demo.py:11: in somefunc
+    failure_demo.py:13: in somefunc
         otherfunc(x, y)
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
@@ -460,7 +501,7 @@ get on the terminal - we are working on that)::
     >       assert a == b
     E       assert 44 == 43
 
-    failure_demo.py:7: AssertionError
+    failure_demo.py:9: AssertionError
     ___________________ TestMoreErrors.test_z1_unpack_error ____________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -470,7 +511,7 @@ get on the terminal - we are working on that)::
     >       a, b = items
     E       ValueError: not enough values to unpack (expected 2, got 0)
 
-    failure_demo.py:197: ValueError
+    failure_demo.py:219: ValueError
     ____________________ TestMoreErrors.test_z2_type_error _____________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -480,7 +521,7 @@ get on the terminal - we are working on that)::
     >       a, b = items
     E       TypeError: 'int' object is not iterable
 
-    failure_demo.py:201: TypeError
+    failure_demo.py:223: TypeError
     ______________________ TestMoreErrors.test_startswith ______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -493,7 +534,7 @@ get on the terminal - we are working on that)::
     E        +  where False = <built-in method startswith of str object at 0xdeadbeef>('456')
     E        +    where <built-in method startswith of str object at 0xdeadbeef> = '123'.startswith
 
-    failure_demo.py:206: AssertionError
+    failure_demo.py:228: AssertionError
     __________________ TestMoreErrors.test_startswith_nested ___________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -512,7 +553,7 @@ get on the terminal - we are working on that)::
     E        +      where '123' = <function TestMoreErrors.test_startswith_nested.<locals>.f at 0xdeadbeef>()
     E        +    and   '456' = <function TestMoreErrors.test_startswith_nested.<locals>.g at 0xdeadbeef>()
 
-    failure_demo.py:215: AssertionError
+    failure_demo.py:237: AssertionError
     _____________________ TestMoreErrors.test_global_func ______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -523,7 +564,7 @@ get on the terminal - we are working on that)::
     E        +  where False = isinstance(43, float)
     E        +    where 43 = globf(42)
 
-    failure_demo.py:218: AssertionError
+    failure_demo.py:240: AssertionError
     _______________________ TestMoreErrors.test_instance _______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -534,7 +575,7 @@ get on the terminal - we are working on that)::
     E       assert 42 != 42
     E        +  where 42 = <failure_demo.TestMoreErrors object at 0xdeadbeef>.x
 
-    failure_demo.py:222: AssertionError
+    failure_demo.py:244: AssertionError
     _______________________ TestMoreErrors.test_compare ________________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -544,7 +585,7 @@ get on the terminal - we are working on that)::
     E       assert 11 < 5
     E        +  where 11 = globf(10)
 
-    failure_demo.py:225: AssertionError
+    failure_demo.py:247: AssertionError
     _____________________ TestMoreErrors.test_try_finally ______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -555,7 +596,7 @@ get on the terminal - we are working on that)::
     >           assert x == 0
     E           assert 1 == 0
 
-    failure_demo.py:230: AssertionError
+    failure_demo.py:252: AssertionError
     ___________________ TestCustomAssertMsg.test_single_line ___________________
 
     self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef>
@@ -570,7 +611,7 @@ get on the terminal - we are working on that)::
     E       assert 1 == 2
     E        +  where 1 = <class 'failure_demo.TestCustomAssertMsg.test_single_line.<locals>.A'>.a
 
-    failure_demo.py:241: AssertionError
+    failure_demo.py:263: AssertionError
     ____________________ TestCustomAssertMsg.test_multiline ____________________
 
     self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef>
@@ -582,14 +623,14 @@ get on the terminal - we are working on that)::
             b = 2
     >       assert (
                 A.a == b
-            ), "A.a appears not to be b\n" "or does not appear to be b\none of those"
+            ), "A.a appears not to be b\nor does not appear to be b\none of those"
     E       AssertionError: A.a appears not to be b
     E         or does not appear to be b
     E         one of those
     E       assert 1 == 2
     E        +  where 1 = <class 'failure_demo.TestCustomAssertMsg.test_multiline.<locals>.A'>.a
 
-    failure_demo.py:248: AssertionError
+    failure_demo.py:270: AssertionError
     ___________________ TestCustomAssertMsg.test_custom_repr ___________________
 
     self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef>
@@ -611,11 +652,5 @@ get on the terminal - we are working on that)::
     E       assert 1 == 2
     E        +  where 1 = This is JSON\n{\n  'foo': 'bar'\n}.a
 
-    failure_demo.py:261: AssertionError
-    ============================= warnings summary =============================
-    $REGENDOC_TMPDIR/assertion/failure_demo.py:24: RemovedInPytest4Warning: Metafunc.addcall is deprecated and scheduled to be removed in pytest 4.0.
-    Please use Metafunc.parametrize instead.
-      metafunc.addcall(funcargs=dict(param1=3, param2=6))
-
-    -- Docs: https://docs.pytest.org/en/latest/warnings.html
-    ================== 42 failed, 1 warnings in 0.12 seconds ===================
+    failure_demo.py:283: AssertionError
+    ======================== 44 failed in 0.12 seconds =========================

doc/en/example/simple.rst

@@ -43,7 +43,9 @@ provide the ``cmdopt`` through a :ref:`fixture function <fixture function>`:
     def cmdopt(request):
         return request.config.getoption("--cmdopt")
 
-Let's run this without supplying our new option::
+Let's run this without supplying our new option:
+
+.. code-block:: pytest
 
     $ pytest -q test_sample.py
     F                                                                    [100%]
@@ -65,7 +67,9 @@ Let's run this without supplying our new option::
     first
     1 failed in 0.12 seconds
 
-And now with supplying a command line option::
+And now with supplying a command line option:
+
+.. code-block:: pytest
 
     $ pytest -q --cmdopt=type2
     F                                                                    [100%]
@@ -117,11 +121,14 @@ the command line arguments before they get processed:
 If you have the `xdist plugin <https://pypi.org/project/pytest-xdist/>`_ installed
 you will now always perform test runs using a number
 of subprocesses close to your CPU. Running in an empty
-directory with the above conftest.py::
+directory with the above conftest.py:
+
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 0 items
 
@@ -175,25 +182,31 @@ We can now write a test module like this:
     def test_func_slow():
         pass
 
-and when running it will see a skipped "slow" test::
+and when running it will see a skipped "slow" test:
+
+.. code-block:: pytest
 
     $ pytest -rs    # "-rs" means report details on the little 's'
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 2 items
 
     test_module.py .s                                                    [100%]
     ========================= short test summary info ==========================
-    SKIP [1] test_module.py:8: need --runslow option to run
+    SKIPPED [1] test_module.py:8: need --runslow option to run
 
     =================== 1 passed, 1 skipped in 0.12 seconds ====================
 
-Or run it including the ``slow`` marked test::
+Or run it including the ``slow`` marked test:
+
+.. code-block:: pytest
 
     $ pytest --runslow
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 2 items
 
@@ -230,7 +243,9 @@ Example:
 The ``__tracebackhide__`` setting influences ``pytest`` showing
 of tracebacks: the ``checkconfig`` function will not be shown
 unless the ``--full-trace`` command line option is specified.
-Let's run our little function::
+Let's run our little function:
+
+.. code-block:: pytest
 
     $ pytest -q test_checkconfig.py
     F                                                                    [100%]
@@ -327,11 +342,14 @@ It's easy to present extra information in a ``pytest`` run:
     def pytest_report_header(config):
         return "project deps: mylib-1.1"
 
-which will add the string to the test header accordingly::
+which will add the string to the test header accordingly:
+
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     project deps: mylib-1.1
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 0 items
@@ -353,12 +371,14 @@ display more information if applicable:
         if config.getoption("verbose") > 0:
             return ["info1: did you know that ...", "did you?"]
 
-which will add info only when run with "--v"::
+which will add info only when run with "--v":
+
+.. code-block:: pytest
 
     $ pytest -v
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     info1: did you know that ...
     did you?
     rootdir: $REGENDOC_TMPDIR, inifile:
@@ -366,11 +386,14 @@ which will add info only when run with "--v"::
 
     ======================= no tests ran in 0.12 seconds =======================
 
-and nothing when run plainly::
+and nothing when run plainly:
+
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 0 items
 
@@ -403,11 +426,14 @@ out which tests are the slowest. Let's make an artificial test suite:
     def test_funcslow2():
         time.sleep(0.3)
 
-Now we can profile which test functions execute the slowest::
+Now we can profile which test functions execute the slowest:
+
+.. code-block:: pytest
 
     $ pytest --durations=3
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 3 items
 
@@ -475,11 +501,14 @@ tests in a class.  Here is a test module example:
     def test_normal():
         pass
 
-If we run this::
+If we run this:
+
+.. code-block:: pytest
 
     $ pytest -rx
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 4 items
 
@@ -496,7 +525,7 @@ If we run this::
 
     test_step.py:11: AssertionError
     ========================= short test summary info ==========================
-    XFAIL test_step.py::TestUserHandling::()::test_deletion
+    XFAIL test_step.py::TestUserHandling::test_deletion
       reason: previous test failed (test_modification)
     ============== 1 failed, 2 passed, 1 xfailed in 0.12 seconds ===============
 
@@ -556,11 +585,14 @@ the ``db`` fixture:
     def test_root(db):  # no db here, will error out
         pass
 
-We can run this::
+We can run this:
+
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 7 items
 
@@ -574,7 +606,7 @@ We can run this::
     file $REGENDOC_TMPDIR/b/test_error.py, line 1
       def test_root(db):  # no db here, will error out
     E       fixture 'db' not found
-    >       available fixtures: cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, monkeypatch, pytestconfig, record_property, record_xml_attribute, record_xml_property, recwarn, tmpdir, tmpdir_factory
+    >       available fixtures: cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, monkeypatch, pytestconfig, record_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
     >       use 'pytest --fixtures [testpath]' for help on them.
 
     $REGENDOC_TMPDIR/b/test_error.py:1
@@ -667,11 +699,14 @@ if you then have failing tests:
     def test_fail2():
         assert 0
 
-and run them::
+and run them:
+
+.. code-block:: pytest
 
     $ pytest test_module.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 2 items
 
@@ -766,11 +801,14 @@ if you then have failing tests:
     def test_fail2():
         assert 0
 
-and run it::
+and run it:
+
+.. code-block:: pytest
 
     $ pytest -s test_module.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 3 items
 
@@ -852,6 +890,8 @@ In that order.
     can be changed between releases (even bug fixes) so it shouldn't be relied on for scripting
     or automation.
 
+.. _freezing-pytest:
+
 Freezing pytest
 ---------------
 

doc/en/example/special.rst

@@ -13,7 +13,7 @@ calls it::
 
     @pytest.fixture(scope="session", autouse=True)
     def callattr_ahead_of_alltests(request):
-        print ("callattr_ahead_of_alltests called")
+        print("callattr_ahead_of_alltests called")
         seen = set([None])
         session = request.node
         for item in session.items:
@@ -31,20 +31,20 @@ will be called ahead of running any tests::
     class TestHello(object):
         @classmethod
         def callme(cls):
-            print ("callme called!")
+            print("callme called!")
 
         def test_method1(self):
-            print ("test_method1 called")
+            print("test_method1 called")
 
         def test_method2(self):
-            print ("test_method1 called")
+            print("test_method1 called")
 
     class TestOther(object):
         @classmethod
         def callme(cls):
-            print ("callme other called")
+            print("callme other called")
         def test_other(self):
-            print ("test other")
+            print("test other")
 
     # works with unittest as well ...
     import unittest
@@ -52,12 +52,14 @@ will be called ahead of running any tests::
     class SomeTest(unittest.TestCase):
         @classmethod
         def callme(self):
-            print ("SomeTest callme called")
+            print("SomeTest callme called")
 
         def test_unit1(self):
-            print ("test_unit1 method called")
+            print("test_unit1 method called")
 
-If you run this without output capturing::
+If you run this without output capturing:
+
+.. code-block:: pytest
 
     $ pytest -q -s test_module.py
     callattr_ahead_of_alltests called

doc/en/fixture.rst

@@ -66,11 +66,14 @@ using it::
 
 Here, the ``test_ehlo`` needs the ``smtp_connection`` fixture value.  pytest
 will discover and call the :py:func:`@pytest.fixture <_pytest.python.fixture>`
-marked ``smtp_connection`` fixture function.  Running the test looks like this::
+marked ``smtp_connection`` fixture function.  Running the test looks like this:
+
+.. code-block:: pytest
 
     $ pytest test_smtpsimple.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 1 item
 
@@ -153,7 +156,7 @@ This makes use of the automatic caching mechanisms of pytest.
 
 Another good approach is by adding the data files in the ``tests`` folder.
 There are also community plugins available to help managing this aspect of
-testing, e.g. `pytest-datadir <https://github.com/gabrielcnr/pytest-datadir>`__
+testing, e.g. `pytest-datadir <https://pypi.org/project/pytest-datadir/>`__
 and `pytest-datafiles <https://pypi.org/project/pytest-datafiles/>`__.
 
 .. _smtpshared:
@@ -171,6 +174,7 @@ to cause the decorated ``smtp_connection`` fixture function to only be invoked
 once per test *module* (the default is to invoke once per test *function*).
 Multiple test functions in a test module will thus
 each receive the same ``smtp_connection`` fixture instance, thus saving time.
+Possible values for ``scope`` are: ``function``, ``class``, ``module``, ``package`` or ``session``.
 
 The next example puts the fixture function into a separate ``conftest.py`` file
 so that tests from multiple test modules in the directory can
@@ -203,11 +207,14 @@ located)::
         assert 0  # for demo purposes
 
 We deliberately insert failing ``assert 0`` statements in order to
-inspect what is going on and can now run the tests::
+inspect what is going on and can now run the tests:
+
+.. code-block:: pytest
 
     $ pytest test_module.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 2 items
 
@@ -258,6 +265,11 @@ instance, you can simply declare it:
 
 Finally, the ``class`` scope will invoke the fixture once per test *class*.
 
+.. note::
+
+    Pytest will only cache one instance of a fixture at a time.
+    This means that when using a parametrized fixture, pytest may invoke a fixture more than once in the given scope.
+
 
 ``package`` scope (experimental)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -454,7 +466,7 @@ read an optional server URL from the test module which uses our fixture::
         server = getattr(request.module, "smtpserver", "smtp.gmail.com")
         smtp_connection = smtplib.SMTP(server, 587, timeout=5)
         yield smtp_connection
-        print ("finalizing %s (%s)" % (smtp_connection, server))
+        print("finalizing %s (%s)" % (smtp_connection, server))
         smtp_connection.close()
 
 We use the ``request.module`` attribute to optionally obtain an
@@ -476,7 +488,9 @@ server URL in its module namespace::
     def test_showhelo(smtp_connection):
         assert 0, smtp_connection.helo()
 
-Running it::
+Running it:
+
+.. code-block:: pytest
 
     $ pytest -qq --tb=short test_anothersmtp.py
     F                                                                    [100%]
@@ -578,7 +592,9 @@ The main change is the declaration of ``params`` with
 :py:func:`@pytest.fixture <_pytest.python.fixture>`, a list of values
 for each of which the fixture function will execute and can access
 a value via ``request.param``.  No test function code needs to change.
-So let's just do another run::
+So let's just do another run:
+
+.. code-block:: pytest
 
     $ pytest -q test_module.py
     FFFF                                                                 [100%]
@@ -614,7 +630,7 @@ So let's just do another run::
             response, msg = smtp_connection.ehlo()
             assert response == 250
     >       assert b"smtp.gmail.com" in msg
-    E       AssertionError: assert b'smtp.gmail.com' in b'mail.python.org\nPIPELINING\nSIZE 51200000\nETRN\nSTARTTLS\nAUTH DIGEST-MD5 NTLM CRAM-MD5\nENHANCEDSTATUSCODES\n8BITMIME\nDSN\nSMTPUTF8'
+    E       AssertionError: assert b'smtp.gmail.com' in b'mail.python.org\nPIPELINING\nSIZE 51200000\nETRN\nSTARTTLS\nAUTH DIGEST-MD5 NTLM CRAM-MD5\nENHANCEDSTATUSCODES\n8BITMIME\nDSN\nSMTPUTF8\nCHUNKING'
 
     test_module.py:5: AssertionError
     -------------------------- Captured stdout setup ---------------------------
@@ -680,26 +696,29 @@ a function which will be called with the fixture value and then
 has to return a string to use.  In the latter case if the function
 return ``None`` then pytest's auto-generated ID will be used.
 
-Running the above tests results in the following test IDs being used::
+Running the above tests results in the following test IDs being used:
+
+.. code-block:: pytest
 
    $ pytest --collect-only
    =========================== test session starts ============================
-   platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+   platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+   cachedir: $PYTHON_PREFIX/.pytest_cache
    rootdir: $REGENDOC_TMPDIR, inifile:
    collected 10 items
-   <Module 'test_anothersmtp.py'>
-     <Function 'test_showhelo[smtp.gmail.com]'>
-     <Function 'test_showhelo[mail.python.org]'>
-   <Module 'test_ids.py'>
-     <Function 'test_a[spam]'>
-     <Function 'test_a[ham]'>
-     <Function 'test_b[eggs]'>
-     <Function 'test_b[1]'>
-   <Module 'test_module.py'>
-     <Function 'test_ehlo[smtp.gmail.com]'>
-     <Function 'test_noop[smtp.gmail.com]'>
-     <Function 'test_ehlo[mail.python.org]'>
-     <Function 'test_noop[mail.python.org]'>
+   <Module test_anothersmtp.py>
+     <Function test_showhelo[smtp.gmail.com]>
+     <Function test_showhelo[mail.python.org]>
+   <Module test_ids.py>
+     <Function test_a[spam]>
+     <Function test_a[ham]>
+     <Function test_b[eggs]>
+     <Function test_b[1]>
+   <Module test_module.py>
+     <Function test_ehlo[smtp.gmail.com]>
+     <Function test_noop[smtp.gmail.com]>
+     <Function test_ehlo[mail.python.org]>
+     <Function test_noop[mail.python.org]>
 
    ======================= no tests ran in 0.12 seconds =======================
 
@@ -722,12 +741,14 @@ Example::
     def test_data(data_set):
         pass
 
-Running this test will *skip* the invocation of ``data_set`` with value ``2``::
+Running this test will *skip* the invocation of ``data_set`` with value ``2``:
+
+.. code-block:: pytest
 
     $ pytest test_fixture_marks.py -v
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collecting ... collected 3 items
 
@@ -765,12 +786,14 @@ and instantiate an object ``app`` where we stick the already defined
         assert app.smtp_connection
 
 Here we declare an ``app`` fixture which receives the previously defined
-``smtp_connection`` fixture and instantiates an ``App`` object with it.  Let's run it::
+``smtp_connection`` fixture and instantiates an ``App`` object with it.  Let's run it:
+
+.. code-block:: pytest
 
     $ pytest -v test_appsetup.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collecting ... collected 2 items
 
@@ -784,7 +807,7 @@ different ``App`` instances and respective smtp servers.  There is no
 need for the ``app`` fixture to be aware of the ``smtp_connection``
 parametrization because pytest will fully analyse the fixture dependency graph.
 
-Note, that the ``app`` fixture has a scope of ``module`` and uses a
+Note that the ``app`` fixture has a scope of ``module`` and uses a
 module-scoped ``smtp_connection`` fixture.  The example would still work if
 ``smtp_connection`` was cached on a ``session`` scope: it is fine for fixtures to use
 "broader" scoped fixtures but not the other way round:
@@ -815,31 +838,33 @@ to show the setup/teardown flow::
     @pytest.fixture(scope="module", params=["mod1", "mod2"])
     def modarg(request):
         param = request.param
-        print ("  SETUP modarg %s" % param)
+        print("  SETUP modarg %s" % param)
         yield param
-        print ("  TEARDOWN modarg %s" % param)
+        print("  TEARDOWN modarg %s" % param)
 
     @pytest.fixture(scope="function", params=[1,2])
     def otherarg(request):
         param = request.param
-        print ("  SETUP otherarg %s" % param)
+        print("  SETUP otherarg %s" % param)
         yield param
-        print ("  TEARDOWN otherarg %s" % param)
+        print("  TEARDOWN otherarg %s" % param)
 
     def test_0(otherarg):
-        print ("  RUN test0 with otherarg %s" % otherarg)
+        print("  RUN test0 with otherarg %s" % otherarg)
     def test_1(modarg):
-        print ("  RUN test1 with modarg %s" % modarg)
+        print("  RUN test1 with modarg %s" % modarg)
     def test_2(otherarg, modarg):
-        print ("  RUN test2 with otherarg %s and modarg %s" % (otherarg, modarg))
+        print("  RUN test2 with otherarg %s and modarg %s" % (otherarg, modarg))
 
 
-Let's run the tests in verbose mode and with looking at the print-output::
+Let's run the tests in verbose mode and with looking at the print-output:
+
+.. code-block:: pytest
 
     $ pytest -v -s test_module.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collecting ... collected 8 items
 
@@ -936,7 +961,9 @@ and declare its use in a test module via a ``usefixtures`` marker::
 Due to the ``usefixtures`` marker, the ``cleandir`` fixture
 will be required for the execution of each test method, just as if
 you specified a "cleandir" function argument to each of them.  Let's run it
-to verify our fixture is activated and the tests pass::
+to verify our fixture is activated and the tests pass:
+
+.. code-block:: pytest
 
     $ pytest -q
     ..                                                                   [100%]
@@ -1035,7 +1062,9 @@ which implies that all test methods in the class will use this fixture
 without a need to state it in the test function signature or with a
 class-level ``usefixtures`` decorator.
 
-If we run it, we get two passing tests::
+If we run it, we get two passing tests:
+
+.. code-block:: pytest
 
     $ pytest -q
     ..                                                                   [100%]

doc/en/flaky.rst

@@ -0,0 +1,125 @@
+
+Flaky tests
+-----------
+
+A "flaky" test is one that exhibits intermittent or sporadic failure, that seems to have non-deterministic behaviour. Sometimes it passes, sometimes it fails, and it's not clear why. This page discusses pytest features that can help and other general strategies for identifying, fixing or mitigating them.
+
+Why flaky tests are a problem
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Flaky tests are particularly troublesome when a continuous integration (CI) server is being used, so that all tests must pass before a new code change can be merged. If the test result is not a reliable signal -- that a test failure means the code change broke the test -- developers can become mistrustful of the test results, which can lead to overlooking genuine failures. It is also a source of wasted time as developers must re-run test suites and investigate spurious failures.
+
+
+Potential root causes
+^^^^^^^^^^^^^^^^^^^^^
+
+System state
+~~~~~~~~~~~~
+
+Broadly speaking, a flaky test indicates that the test relies on some system state that is not being appropriately controlled - the test environment is not sufficiently isolated. Higher level tests are more likely to be flaky as they rely on more state.
+
+Flaky tests sometimes appear when a test suite is run in parallel (such as use of pytest-xdist). This can indicate a test is reliant on test ordering.
+
+-  Perhaps a different test is failing to clean up after itself and leaving behind data which causes the flaky test to fail.
+- The flaky test is reliant on data from a previous test that doesn't clean up after itself, and in parallel runs that previous test is not always present
+- Tests that modify global state typically cannot be run in parallel.
+
+
+Overly strict assertion
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Overly strict assertions can cause problems with floating point comparison as well as timing issues. `pytest.approx <https://docs.pytest.org/en/latest/reference.html#pytest-approx>`_ is useful here.
+
+
+Pytest features
+^^^^^^^^^^^^^^^
+
+Xfail strict
+~~~~~~~~~~~~
+
+:ref:`pytest.mark.xfail ref` with ``strict=False`` can be used to mark a test so that its failure does not cause the whole build to break. This could be considered like a manual quarantine, and is rather dangerous to use permanently.
+
+
+PYTEST_CURRENT_TEST
+~~~~~~~~~~~~~~~~~~~
+
+:ref:`pytest current test env` may be useful for figuring out "which test got stuck".
+
+
+Plugins
+~~~~~~~
+
+Rerunning any failed tests can mitigate the negative effects of flaky tests by giving them additional chances to pass, so that the overall build does not fail. Several pytest plugins support this:
+
+* `flaky <https://github.com/box/flaky>`_
+* `pytest-flakefinder <https://github.com/dropbox/pytest-flakefinder>`_ - `blog post <https://blogs.dropbox.com/tech/2016/03/open-sourcing-pytest-tools/>`_
+* `pytest-rerunfailures <https://github.com/pytest-dev/pytest-rerunfailures>`_
+* `pytest-replay <https://github.com/ESSS/pytest-replay>`_: This plugin helps to reproduce locally crashes or flaky tests observed during CI runs.
+
+Plugins to deliberately randomize tests can help expose tests with state problems:
+
+* `pytest-random-order <https://github.com/jbasko/pytest-random-order>`_
+* `pytest-randomly <https://github.com/pytest-dev/pytest-randomly>`_
+
+
+Other general strategies
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Split up test suites
+~~~~~~~~~~~~~~~~~~~~
+
+It can be common to split a single test suite into two, such as unit vs integration, and only use the unit test suite as a CI gate. This also helps keep build times manageable as high level tests tend to be slower. However, it means it does become possible for code that breaks the build to be merged, so extra vigilance is needed for monitoring the integration test results.
+
+
+Video/screenshot on failure
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For UI tests these are important for understanding what the state of the UI was when the test failed. pytest-splinter can be used with plugins like pytest-bdd and can `save a screenshot on test failure <https://pytest-splinter.readthedocs.io/en/latest/#automatic-screenshots-on-test-failure>`_, which can help to isolate the cause.
+
+
+Delete or rewrite the test
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If the functionality is covered by other tests, perhaps the test can be removed. If not, perhaps it can be rewritten at a lower level which will remove the flakiness or make its source more apparent.
+
+
+Quarantine
+~~~~~~~~~~
+
+Mark Lapierre discusses the `Pros and Cons of Quarantined Tests <https://dev.to/mlapierre/pros-and-cons-of-quarantined-tests-2emj>`_ in a post from 2018.
+
+
+
+CI tools that rerun on failure
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Azure Pipelines (the Azure cloud CI/CD tool, formerly Visual Studio Team Services or VSTS) has a feature to `identify flaky tests <https://docs.microsoft.com/en-us/azure/devops/release-notes/2017/dec-11-vsts#identify-flaky-tests>`_ and rerun failed tests.
+
+
+
+Research
+^^^^^^^^
+
+This is a limited list, please submit an issue or pull request to expand it!
+
+* Gao, Zebao, Yalan Liang, Myra B. Cohen, Atif M. Memon, and Zhen Wang. "Making system user interactive tests repeatable: When and what should we control?." In *Software Engineering (ICSE), 2015 IEEE/ACM 37th IEEE International Conference on*, vol. 1, pp. 55-65. IEEE, 2015.  `PDF <http://www.cs.umd.edu/~atif/pubs/gao-icse15.pdf>`__
+* Palomba, Fabio, and Andy Zaidman. "Does refactoring of test smells induce fixing flaky tests?." In *Software Maintenance and Evolution (ICSME), 2017 IEEE International Conference on*, pp. 1-12. IEEE, 2017. `PDF in Google Drive <https://drive.google.com/file/d/10HdcCQiuQVgW3yYUJD-TSTq1NbYEprl0/view>`__
+*  Bell, Jonathan, Owolabi Legunsen, Michael Hilton, Lamyaa Eloussi, Tifany Yung, and Darko Marinov. "DeFlaker: Automatically detecting flaky tests." In *Proceedings of the 2018 International Conference on Software Engineering*. 2018. `PDF <https://www.jonbell.net/icse18-deflaker.pdf>`__
+
+
+Resources
+^^^^^^^^^
+
+* `Eradicating Non-Determinism in Tests <https://martinfowler.com/articles/nonDeterminism.html>`_ by Martin Fowler, 2011
+* `No more flaky tests on the Go team <https://www.thoughtworks.com/insights/blog/no-more-flaky-tests-go-team>`_ by Pavan Sudarshan, 2012
+* `The Build That Cried Broken: Building Trust in your Continuous Integration Tests <https://www.youtube.com/embed/VotJqV4n8ig>`_ talk (video) by `Angie Jones <http://angiejones.tech/>`_ at SeleniumConf Austin 2017
+* `Test and Code Podcast: Flaky Tests and How to Deal with Them <https://testandcode.com/50>`_ by Brian Okken and Anthony Shaw, 2018
+* Microsoft:
+
+  * `How we approach testing VSTS to enable continuous delivery <https://blogs.msdn.microsoft.com/bharry/2017/06/28/testing-in-a-cloud-delivery-cadence/>`_ by Brian Harry MS, 2017
+  * `Eliminating Flaky Tests <https://docs.microsoft.com/en-us/azure/devops/learn/devops-at-microsoft/eliminating-flaky-tests>`_ blog and talk (video) by Munil Shah, 2017
+
+* Google:
+
+  * `Flaky Tests at Google and How We Mitigate Them <https://testing.googleblog.com/2016/05/flaky-tests-at-google-and-how-we.html>`_ by John Micco, 2016
+  * `Where do Google's flaky tests come from? <https://docs.google.com/document/d/1mZ0-Kc97DI_F3tf_GBW_NB_aqka-P1jVOsFfufxqUUM/edit#heading=h.ec0r4fypsleh>`_  by Jeff Listfield, 2017

doc/en/funcarg_compare.rst

@@ -26,9 +26,9 @@ a per-session Database object::
     # content of conftest.py
     class Database(object):
         def __init__(self):
-            print ("database instance created")
+            print("database instance created")
         def destroy(self):
-            print ("database instance destroyed")
+            print("database instance destroyed")
 
     def pytest_funcarg__db(request):
         return request.cached_setup(setup=DataBase,

doc/en/getting-started.rst

@@ -1,15 +1,12 @@
 Installation and Getting Started
 ===================================
 
-**Pythons**: Python 2.7, 3.4, 3.5, 3.6, Jython, PyPy-2.3
+**Pythons**: Python 2.7, 3.4, 3.5, 3.6, 3.7, Jython, PyPy-2.3
 
 **Platforms**: Unix/Posix and Windows
 
 **PyPI package name**: `pytest <https://pypi.org/project/pytest/>`_
 
-**Dependencies**: `py <https://pypi.org/project/py/>`_,
-`colorama (Windows) <https://pypi.org/project/colorama/>`_,
-
 **Documentation as PDF**: `download latest <https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf>`_
 
 ``pytest`` is a framework that makes building simple and scalable tests easy. Tests are expressive and readable—no boilerplate code required. Get started in minutes with a small unit test or complex functional test for your application or library.
@@ -27,7 +24,7 @@ Install ``pytest``
 2. Check that you installed the correct version::
 
     $ pytest --version
-    This is pytest version 3.x.y, imported from $PYTHON_PREFIX/lib/python3.6/site-packages/pytest.py
+    This is pytest version 4.x.y, imported from $PYTHON_PREFIX/lib/python3.6/site-packages/pytest.py
 
 .. _`simpletest`:
 
@@ -43,11 +40,14 @@ Create a simple test function with just four lines of code::
     def test_answer():
         assert func(3) == 5
 
-That’s it. You can now execute the test function::
+That’s it. You can now execute the test function:
+
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 1 item
 
@@ -90,7 +90,9 @@ Use the ``raises`` helper to assert that some code raises an exception::
         with pytest.raises(SystemExit):
             f()
 
-Execute the test function with “quiet” reporting mode::
+Execute the test function with “quiet” reporting mode:
+
+.. code-block:: pytest
 
     $ pytest -q test_sysexit.py
     .                                                                    [100%]
@@ -111,7 +113,9 @@ Once you develop multiple tests, you may want to group them into a class. pytest
             x = "hello"
             assert hasattr(x, 'check')
 
-``pytest`` discovers all tests following its :ref:`Conventions for Python test discovery <test discovery>`, so it finds both ``test_`` prefixed functions. There is no need to subclass anything. We can simply run the module by passing its filename::
+``pytest`` discovers all tests following its :ref:`Conventions for Python test discovery <test discovery>`, so it finds both ``test_`` prefixed functions. There is no need to subclass anything. We can simply run the module by passing its filename:
+
+.. code-block:: pytest
 
     $ pytest -q test_class.py
     .F                                                                   [100%]
@@ -138,10 +142,12 @@ Request a unique temporary directory for functional tests
 
     # content of test_tmpdir.py
     def test_needsfiles(tmpdir):
-        print (tmpdir)
+        print(tmpdir)
         assert 0
 
-List the name ``tmpdir`` in the test function signature and ``pytest`` will lookup and call a fixture factory to create the resource before performing the test function call. Before the test runs, ``pytest`` creates a unique-per-test-invocation temporary directory::
+List the name ``tmpdir`` in the test function signature and ``pytest`` will lookup and call a fixture factory to create the resource before performing the test function call. Before the test runs, ``pytest`` creates a unique-per-test-invocation temporary directory:
+
+.. code-block:: pytest
 
     $ pytest -q test_tmpdir.py
     F                                                                    [100%]
@@ -151,7 +157,7 @@ List the name ``tmpdir`` in the test function signature and ``pytest`` will look
     tmpdir = local('PYTEST_TMPDIR/test_needsfiles0')
 
         def test_needsfiles(tmpdir):
-            print (tmpdir)
+            print(tmpdir)
     >       assert 0
     E       assert 0
 

doc/en/goodpractices.rst

@@ -72,8 +72,18 @@ to keep tests separate from actual application code (often a good idea)::
         test_view.py
         ...
 
-This way your tests can run easily against an installed version
-of ``mypkg``.
+This has the following benefits:
+
+* Your tests can run against an installed version after executing ``pip install .``.
+* Your tests can run against the local copy with an editable install after executing ``pip install --editable .``.
+* If you don't have a ``setup.py`` file and are relying on the fact that Python by default puts the current
+  directory in ``sys.path`` to import your package, you can execute ``python -m pytest`` to execute the tests against the
+  local copy directly, without using ``pip``.
+
+.. note::
+
+    See :ref:`pythonpath` for more information about the difference between calling ``pytest`` and
+    ``python -m pytest``.
 
 Note that using this scheme your test files must have **unique names**, because
 ``pytest`` will import them as *top-level* modules since there are no packages

doc/en/historical-notes.rst

@@ -175,3 +175,13 @@ Previous to version 2.4 to set a break point in code one needed to use ``pytest.
 This is no longer needed and one can use the native ``import pdb;pdb.set_trace()`` call directly.
 
 For more details see :ref:`breakpoints`.
+
+"compat" properties
+-------------------
+
+.. deprecated:: 3.9
+
+Access of ``Module``, ``Function``, ``Class``, ``Instance``, ``File`` and ``Item`` through ``Node`` instances have long
+been documented as deprecated, but started to emit warnings from pytest ``3.9`` and onward.
+
+Users should just ``import pytest`` and access those objects using the ``pytest`` module.

doc/en/index.rst

@@ -22,11 +22,14 @@ An example of a simple test:
         assert inc(3) == 5
 
 
-To execute it::
+To execute it:
+
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 1 item
 

doc/en/logging.rst

@@ -198,6 +198,9 @@ option names are:
 * ``log_file_format``
 * ``log_file_date_format``
 
+You can call ``set_log_path()`` to customize the log_file path dynamically. This functionality
+is considered **experimental**.
+
 .. _log_release_notes:
 
 Release notes

doc/en/mark.rst

@@ -52,6 +52,8 @@ should add ``--strict`` to ``addopts``:
         serial
 
 
+.. _marker-revamp:
+
 Marker revamp and iteration
 ---------------------------
 
@@ -154,4 +156,4 @@ More details can be found in the `original PR <https://github.com/pytest-dev/pyt
 .. note::
 
     in a future major relase of pytest we will introduce class based markers,
-    at which points markers will no longer be limited to instances of :py:class:`Mark`
+    at which point markers will no longer be limited to instances of :py:class:`Mark`

doc/en/parametrize.rst

@@ -50,11 +50,14 @@ to an expected output::
 
 Here, the ``@parametrize`` decorator defines three different ``(test_input,expected)``
 tuples so that the ``test_eval`` function will run three times using
-them in turn::
+them in turn:
+
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 3 items
 
@@ -99,11 +102,14 @@ for example with the builtin ``mark.xfail``::
     def test_eval(test_input, expected):
         assert eval(test_input) == expected
 
-Let's run this::
+Let's run this:
+
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 3 items
 
@@ -114,6 +120,10 @@ Let's run this::
 The one parameter set which caused a failure previously now
 shows up as an "xfailed (expected to fail)" test.
 
+In case the values provided to ``parametrize`` result in an empty list - for
+example, if they're dynamically generated by some function - the behaviour of
+pytest is defined by the :confval:`empty_parameter_set_mark` option.
+
 To get all combinations of multiple parametrized arguments you can stack
 ``parametrize`` decorators::
 
@@ -168,7 +178,9 @@ If we now pass two stringinput values, our test will run twice::
     ..                                                                   [100%]
     2 passed in 0.12 seconds
 
-Let's also run with a stringinput that will lead to a failing test::
+Let's also run with a stringinput that will lead to a failing test:
+
+.. code-block:: pytest
 
     $ pytest -q --stringinput="!" test_strings.py
     F                                                                    [100%]
@@ -190,12 +202,14 @@ As expected our test function fails.
 
 If you don't specify a stringinput it will be skipped because
 ``metafunc.parametrize()`` will be called with an empty parameter
-list::
+list:
+
+.. code-block:: pytest
 
     $ pytest -q -rs test_strings.py
     s                                                                    [100%]
     ========================= short test summary info ==========================
-    SKIP [1] test_strings.py: got empty parameter set ['stringinput'], function test_valid_string at $REGENDOC_TMPDIR/test_strings.py:1
+    SKIPPED [1] test_strings.py: got empty parameter set ['stringinput'], function test_valid_string at $REGENDOC_TMPDIR/test_strings.py:1
     1 skipped in 0.12 seconds
 
 Note that when calling ``metafunc.parametrize`` multiple times with different parameter sets, all parameter names across

doc/en/plugins.rst

@@ -59,9 +59,9 @@ To see a complete list of all plugins with their latest testing
 status against different pytest and Python versions, please visit
 `plugincompat <http://plugincompat.herokuapp.com/>`_.
 
-You may also discover more plugins through a `pytest- pypi.python.org search`_.
+You may also discover more plugins through a `pytest- pypi.org search`_.
 
-.. _`pytest- pypi.python.org search`: https://pypi.org/search/?q=pytest-
+.. _`pytest- pypi.org search`: https://pypi.org/search/?q=pytest-
 
 
 .. _`available installable plugins`:
@@ -69,23 +69,26 @@ You may also discover more plugins through a `pytest- pypi.python.org search`_.
 Requiring/Loading plugins in a test module or conftest file
 -----------------------------------------------------------
 
-You can require plugins in a test module or a conftest file like this::
+You can require plugins in a test module or a conftest file like this:
 
-    pytest_plugins = "myapp.testsupport.myplugin",
+.. code-block:: python
+
+    pytest_plugins = ("myapp.testsupport.myplugin",)
 
 When the test module or conftest plugin is loaded the specified plugins
 will be loaded as well.
 
-    pytest_plugins = "myapp.testsupport.myplugin"
-
-which will import the specified module as a ``pytest`` plugin.
-
 .. note::
     Requiring plugins using a ``pytest_plugins`` variable in non-root
     ``conftest.py`` files is deprecated. See
     :ref:`full explanation <requiring plugins in non-root conftests>`
     in the Writing plugins section.
 
+.. note::
+   The name ``pytest_plugins`` is reserved and should not be used as a
+   name for a custom plugin module.
+
+
 .. _`findpluginname`:
 
 Finding out which plugins are active

doc/en/proposals/parametrize_with_fixtures.rst

@@ -75,7 +75,7 @@ Issues
 ------
 
 * By using ``request.getfuncargvalue()`` we rely on actual fixture function
-  execution to know what fixtures are involved, due to it's dynamic nature
+  execution to know what fixtures are involved, due to its dynamic nature
 * More importantly, ``request.getfuncargvalue()`` cannot be combined with
   parametrized fixtures, such as ``extra_context``
 * This is very inconvenient if you wish to extend an existing test suite by

doc/en/py27-py34-deprecation.rst

@@ -0,0 +1,22 @@
+Python 2.7 and 3.4 support plan
+===============================
+
+Python 2.7 EOL is fast approaching, with
+upstream support `ending in 2020 <https://legacy.python.org/dev/peps/pep-0373/#id4>`__.
+Python 3.4's last release is scheduled for
+`March 2019 <https://www.python.org/dev/peps/pep-0429/#release-schedule>`__. pytest is one of
+the participating projects of the https://python3statement.org.
+
+We plan to drop support for Python 2.7 and 3.4 at the same time with the release of **pytest 5.0**,
+scheduled to be released by **mid-2019**. Thanks to the `python_requires <https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires>`__ ``setuptools`` option,
+Python 2.7 and Python 3.4 users using a modern ``pip`` version
+will install the last compatible pytest ``4.X`` version automatically even if ``5.0`` or later
+are available on PyPI.
+
+During the period **from mid-2019 and 2020**, the pytest core team plans to make
+bug-fix releases of the pytest ``4.X`` series by back-porting patches to the ``4.x-maintenance``
+branch.
+
+**After 2020**, the core team will no longer actively back port-patches, but the ``4.x-maintenance``
+branch will continue to exist so the community itself can contribute patches. The
+core team will be happy to accept those patches and make new ``4.X`` releases **until mid-2020**.

doc/en/reference.rst

@@ -84,6 +84,12 @@ pytest.warns
 .. autofunction:: pytest.warns(expected_warning: Exception, [match])
     :with:
 
+pytest.freeze_includes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Tutorial**: :ref:`freezing-pytest`.
+
+.. autofunction:: pytest.freeze_includes
 
 .. _`marks ref`:
 
@@ -111,6 +117,7 @@ Add warning filters to marked test items.
         A *warning specification string*, which is composed of contents of the tuple ``(action, message, category, module, lineno)``
         as specified in `The Warnings filter <https://docs.python.org/3/library/warnings.html#warning-filter>`_ section of
         the Python documentation, separated by ``":"``. Optional fields can be omitted.
+        Module names passed for filtering are not regex-escaped.
 
         For example:
 
@@ -172,7 +179,7 @@ Mark a test function as using the given fixture names.
 
 .. warning::
 
-    This mark can be used with *test functions* only, having no affect when applied
+    This mark has no effect when applied
     to a **fixture** function.
 
 .. py:function:: pytest.mark.usefixtures(*names)
@@ -611,7 +618,6 @@ Session related reporting hooks:
 .. autofunction:: pytest_terminal_summary
 .. autofunction:: pytest_fixture_setup
 .. autofunction:: pytest_fixture_post_finalizer
-.. autofunction:: pytest_logwarning
 .. autofunction:: pytest_warning_captured
 
 And here is the central hook for reporting about
@@ -718,13 +724,6 @@ MarkGenerator
     :members:
 
 
-MarkInfo
-~~~~~~~~
-
-.. autoclass:: _pytest.mark.MarkInfo
-    :members:
-
-
 Mark
 ~~~~
 
@@ -798,6 +797,33 @@ Special Variables
 pytest treats some global variables in a special manner when defined in a test module.
 
 
+collect_ignore
+~~~~~~~~~~~~~~
+
+**Tutorial**: :ref:`customizing-test-collection`
+
+Can be declared in *conftest.py files* to exclude test directories or modules.
+Needs to be ``list[str]``.
+
+.. code-block:: python
+
+  collect_ignore = ["setup.py"]
+
+
+collect_ignore_glob
+~~~~~~~~~~~~~~~~~~~
+
+**Tutorial**: :ref:`customizing-test-collection`
+
+Can be declared in *conftest.py files* to exclude test directories or modules
+with Unix shell-style wildcards. Needs to be ``list[str]`` where ``str`` can
+contain glob patterns.
+
+.. code-block:: python
+
+  collect_ignore_glob = ["*_ignore.py"]
+
+
 pytest_plugins
 ~~~~~~~~~~~~~~
 
@@ -890,6 +916,12 @@ Here is a list of builtin configuration options that may be written in a ``pytes
 file, usually located at the root of your repository. All options must be under a ``[pytest]`` section
 (``[tool:pytest]`` for ``setup.cfg`` files).
 
+.. warning::
+    Usage of ``setup.cfg`` is not recommended unless for very simple use cases. ``.cfg``
+    files use a different parser than ``pytest.ini`` and ``tox.ini`` which might cause hard to track
+    down problems.
+    When possible, it is recommended to use the latter files to hold your pytest configuration.
+
 Configuration file options may be overwritten in the command-line by using ``-o/--override``, which can also be
 passed multiple times. The expected format is ``name=value``. For example::
 
@@ -976,6 +1008,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
     * ``skip`` skips tests with an empty parameterset (default)
     * ``xfail`` marks tests with an empty parameterset as xfail(run=False)
+    * ``fail_at_collect`` raises an exception if parametrize collects an empty parameter set
 
     .. code-block:: ini
 
@@ -1009,6 +1042,20 @@ passed multiple times. The expected format is ``name=value``. For example::
    This tells pytest to ignore deprecation warnings and turn all other warnings
    into errors. For more information please refer to :ref:`warnings`.
 
+.. confval:: junit_family
+
+    .. versionadded:: 4.2
+
+    Configures the format of the generated JUnit XML file. The possible options are:
+
+    * ``xunit1`` (or ``legacy``): produces old style output, compatible with the xunit 1.0 format. **This is the default**.
+    * ``xunit2``: produces `xunit 2.0 style output <https://github.com/jenkinsci/xunit-plugin/blob/xunit-2.3.2/src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd>`__,
+        which should be more compatible with latest Jenkins versions.
+
+    .. code-block:: ini
+
+        [pytest]
+        junit_family = xunit2
 
 .. confval:: junit_suite_name
 
@@ -1256,15 +1303,25 @@ passed multiple times. The expected format is ``name=value``. For example::
 
    One or more Glob-style file patterns determining which python files
    are considered as test modules. Search for multiple glob patterns by
-   adding a space between patterns::
+   adding a space between patterns:
 
    .. code-block:: ini
 
         [pytest]
         python_files = test_*.py check_*.py example_*.py
 
-   By default, pytest will consider any file matching with ``test_*.py``
-   and ``*_test.py`` globs as a test module.
+   Or one per line:
+
+   .. code-block:: ini
+
+        [pytest]
+        python_files =
+            test_*.py
+            check_*.py
+            example_*.py
+
+   By default, files matching ``test_*.py`` and ``*_test.py`` will be considered
+   test modules.
 
 
 .. confval:: python_functions

doc/en/requirements.txt

@@ -1,4 +1,4 @@
-# pinning sphinx to 1.4.* due to search issues with rtd:
-# https://github.com/rtfd/readthedocs-sphinx-ext/issues/25
-sphinx ==1.4.*
+pygments-pytest>=1.1.0
+sphinx>=1.8.2
 sphinxcontrib-trio
+sphinx-removed-in>=0.1.3

doc/en/skipping.rst

@@ -58,18 +58,20 @@ by calling the ``pytest.skip(reason)`` function:
         if not valid_config():
             pytest.skip("unsupported configuration")
 
+The imperative method is useful when it is not possible to evaluate the skip condition
+during import time.
+
 It is also possible to skip the whole module using
 ``pytest.skip(reason, allow_module_level=True)`` at the module level:
 
 .. code-block:: python
 
+    import sys
     import pytest
 
-    if not pytest.config.getoption("--custom-flag"):
-        pytest.skip("--custom-flag is missing, skipping tests", allow_module_level=True)
+    if not sys.platform.startswith("win"):
+        pytest.skip("skipping windows-only tests", allow_module_level=True)
 
-The imperative method is useful when it is not possible to evaluate the skip condition
-during import time.
 
 **Reference**: :ref:`pytest.mark.skip ref`
 
@@ -321,11 +323,14 @@ Here is a simple test file with the several usages:
 
 .. literalinclude:: example/xfail_demo.py
 
-Running it with the report-on-xfail option gives this output::
+Running it with the report-on-xfail option gives this output:
+
+.. code-block:: pytest
 
     example $ pytest -rx xfail_demo.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR/example, inifile:
     collected 7 items
 

doc/en/talks.rst

@@ -23,6 +23,11 @@ Books
 Talks and blog postings
 ---------------------------------------------
 
+- pytest: recommendations, basic packages for testing in Python and Django, Andreu Vallbona, PyconES 2017 (`slides in english <http://talks.apsl.io/testing-pycones-2017/>`_, `video in spanish <https://www.youtube.com/watch?v=K20GeR-lXDk>`_)
+
+- `pytest advanced, Andrew Svetlov (Russian, PyCon Russia, 2016)
+  <https://www.youtube.com/watch?v=7KgihdKTWY4>`_.
+
 - `Pythonic testing, Igor Starikov (Russian, PyNsk, November 2016)
   <https://www.youtube.com/watch?v=_92nfdd5nK8>`_.
 

doc/en/tmpdir.rst

@@ -5,6 +5,79 @@
 Temporary directories and files
 ================================================
 
+The ``tmp_path`` fixture
+------------------------
+
+.. versionadded:: 3.9
+
+
+You can use the ``tmp_path`` fixture which will
+provide a temporary directory unique to the test invocation,
+created in the `base temporary directory`_.
+
+``tmp_path`` is a ``pathlib/pathlib2.Path`` object. Here is an example test usage:
+
+.. code-block:: python
+
+    # content of test_tmp_path.py
+    import os
+
+    CONTENT = u"content"
+
+
+    def test_create_file(tmp_path):
+        d = tmp_path / "sub"
+        d.mkdir()
+        p = d / "hello.txt"
+        p.write_text(CONTENT)
+        assert p.read_text() == CONTENT
+        assert len(list(tmp_path.iterdir())) == 1
+        assert 0
+
+Running this would result in a passed test except for the last
+``assert 0`` line which we use to look at values:
+
+.. code-block:: pytest
+
+    $ pytest test_tmp_path.py
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR, inifile:
+    collected 1 item
+
+    test_tmp_path.py F                                                   [100%]
+
+    ================================= FAILURES =================================
+    _____________________________ test_create_file _____________________________
+
+    tmp_path = PosixPath('PYTEST_TMPDIR/test_create_file0')
+
+        def test_create_file(tmp_path):
+            d = tmp_path / "sub"
+            d.mkdir()
+            p = d / "hello.txt"
+            p.write_text(CONTENT)
+            assert p.read_text() == CONTENT
+            assert len(list(tmp_path.iterdir())) == 1
+    >       assert 0
+    E       assert 0
+
+    test_tmp_path.py:13: AssertionError
+    ========================= 1 failed in 0.12 seconds =========================
+
+The ``tmp_path_factory`` fixture
+--------------------------------
+
+.. versionadded:: 3.9
+
+
+The ``tmp_path_factory`` is a session-scoped fixture which can be used
+to create arbitrary temporary directories from any other fixture or test.
+
+It is intended to replace ``tmpdir_factory``, and returns :class:`pathlib.Path` instances.
+
+
 The 'tmpdir' fixture
 --------------------
 
@@ -25,11 +98,14 @@ and more.  Here is an example test usage::
         assert 0
 
 Running this would result in a passed test except for the last
-``assert 0`` line which we use to look at values::
+``assert 0`` line which we use to look at values:
+
+.. code-block:: pytest
 
     $ pytest test_tmpdir.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 1 item
 

doc/en/unittest.rst

@@ -22,16 +22,15 @@ Almost all ``unittest`` features are supported:
 
 * ``@unittest.skip`` style decorators;
 * ``setUp/tearDown``;
-* ``setUpClass/tearDownClass()``;
+* ``setUpClass/tearDownClass``;
+* ``setUpModule/tearDownModule``;
 
 .. _`load_tests protocol`: https://docs.python.org/3/library/unittest.html#load-tests-protocol
-.. _`setUpModule/tearDownModule`: https://docs.python.org/3/library/unittest.html#setupmodule-and-teardownmodule
 .. _`subtests`: https://docs.python.org/3/library/unittest.html#distinguishing-test-iterations-using-subtests
 
 Up to this point pytest does not have support for the following features:
 
 * `load_tests protocol`_;
-* `setUpModule/tearDownModule`_;
 * `subtests`_;
 
 Benefits out of the box
@@ -123,11 +122,14 @@ fixture definition::
 The ``@pytest.mark.usefixtures("db_class")`` class-decorator makes sure that
 the pytest fixture function ``db_class`` is called once per class.
 Due to the deliberately failing assert statements, we can take a look at
-the ``self.db`` values in the traceback::
+the ``self.db`` values in the traceback:
+
+.. code-block:: pytest
 
     $ pytest test_unittest_db.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 2 items
 
@@ -200,7 +202,9 @@ used for all methods of the class where it is defined.  This is a
 shortcut for using a ``@pytest.mark.usefixtures("initdir")`` marker
 on the class like in the previous example.
 
-Running this test module ...::
+Running this test module ...:
+
+.. code-block:: pytest
 
     $ pytest -q test_unittest_cleandir.py
     .                                                                    [100%]

doc/en/usage.rst

@@ -147,18 +147,83 @@ Detailed summary report
 
 .. versionadded:: 2.9
 
-The ``-r`` flag can be used to display test results summary at the end of the test session,
+The ``-r`` flag can be used to display a "short test summary info" at the end of the test session,
 making it easy in large test suites to get a clear picture of all failures, skips, xfails, etc.
 
-Example::
+Example:
+
+.. code-block:: python
+
+    # content of test_example.py
+    import pytest
+
+
+    @pytest.fixture
+    def error_fixture():
+        assert 0
+
+
+    def test_ok():
+        print("ok")
+
+
+    def test_fail():
+        assert 0
+
+
+    def test_error(error_fixture):
+        pass
+
+
+    def test_skip():
+        pytest.skip("skipping this test")
+
+
+    def test_xfail():
+        pytest.xfail("xfailing this test")
+
+
+    @pytest.mark.xfail(reason="always xfail")
+    def test_xpass():
+        pass
+
+
+.. code-block:: pytest
 
     $ pytest -ra
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 0 items
+    collected 6 items
 
-    ======================= no tests ran in 0.12 seconds =======================
+    test_example.py .FEsxX                                               [100%]
+
+    ================================== ERRORS ==================================
+    _______________________ ERROR at setup of test_error _______________________
+
+        @pytest.fixture
+        def error_fixture():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:6: AssertionError
+    ================================= FAILURES =================================
+    ________________________________ test_fail _________________________________
+
+        def test_fail():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:14: AssertionError
+    ========================= short test summary info ==========================
+    SKIPPED [1] $REGENDOC_TMPDIR/test_example.py:23: skipping this test
+    XFAIL test_example.py::test_xfail
+      reason: xfailing this test
+    XPASS test_example.py::test_xpass always xfail
+    ERROR test_example.py::test_error
+    FAILED test_example.py::test_fail
+     1 failed, 1 passed, 1 skipped, 1 xfailed, 1 xpassed, 1 error in 0.12 seconds
 
 The ``-r`` options accepts a number of characters after it, with ``a`` used above meaning "all except passes".
 
@@ -173,15 +238,79 @@ Here is the full list of available characters that can be used:
  - ``P`` - passed with output
  - ``a`` - all except ``pP``
 
-More than one character can be used, so for example to only see failed and skipped tests, you can execute::
+More than one character can be used, so for example to only see failed and skipped tests, you can execute:
+
+.. code-block:: pytest
 
     $ pytest -rfs
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 0 items
+    collected 6 items
 
-    ======================= no tests ran in 0.12 seconds =======================
+    test_example.py .FEsxX                                               [100%]
+
+    ================================== ERRORS ==================================
+    _______________________ ERROR at setup of test_error _______________________
+
+        @pytest.fixture
+        def error_fixture():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:6: AssertionError
+    ================================= FAILURES =================================
+    ________________________________ test_fail _________________________________
+
+        def test_fail():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:14: AssertionError
+    ========================= short test summary info ==========================
+    FAILED test_example.py::test_fail
+    SKIPPED [1] $REGENDOC_TMPDIR/test_example.py:23: skipping this test
+     1 failed, 1 passed, 1 skipped, 1 xfailed, 1 xpassed, 1 error in 0.12 seconds
+
+Using ``p`` lists the passing tests, whilst ``P`` adds an extra section "PASSES" with those tests that passed but had
+captured output:
+
+.. code-block:: pytest
+
+    $ pytest -rpP
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR, inifile:
+    collected 6 items
+
+    test_example.py .FEsxX                                               [100%]
+
+    ================================== ERRORS ==================================
+    _______________________ ERROR at setup of test_error _______________________
+
+        @pytest.fixture
+        def error_fixture():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:6: AssertionError
+    ================================= FAILURES =================================
+    ________________________________ test_fail _________________________________
+
+        def test_fail():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:14: AssertionError
+    ========================= short test summary info ==========================
+    PASSED test_example.py::test_ok
+    ================================== PASSES ==================================
+    _________________________________ test_ok __________________________________
+    --------------------------- Captured stdout call ---------------------------
+    ok
+     1 failed, 1 passed, 1 skipped, 1 xfailed, 1 xpassed, 1 error in 0.12 seconds
 
 .. _pdb-option:
 
@@ -255,8 +384,8 @@ Pytest supports the use of ``breakpoint()`` with the following behaviours:
 
  - When ``breakpoint()`` is called and ``PYTHONBREAKPOINT`` is set to the default value, pytest will use the custom internal PDB trace UI instead of the system default ``Pdb``.
  - When tests are complete, the system will default back to the system ``Pdb`` trace UI.
- - If ``--pdb`` is called on execution of pytest, the custom internal Pdb trace UI is used on ``bothbreakpoint()`` and failed tests/unhandled exceptions.
- - If ``--pdbcls`` is used, the custom class debugger will be executed when a test fails (as expected within existing behaviour), but also when ``breakpoint()`` is called from within a test, the custom class debugger will be instantiated.
+ - With ``--pdb`` passed to pytest, the custom internal Pdb trace UI is used with both ``breakpoint()`` and failed tests/unhandled exceptions.
+ - ``--pdbcls`` can be used to specify a custom debugger class.
 
 .. _durations:
 
@@ -269,6 +398,7 @@ To get a list of the slowest 10 test durations::
 
     pytest --durations=10
 
+By default, pytest will not show test durations that are too small (<0.01s) unless ``-vv`` is passed on the command-line.
 
 Creating JUnitXML format files
 ----------------------------------------------------
@@ -289,6 +419,20 @@ To set the name of the root test suite xml item, you can configure the ``junit_s
     [pytest]
     junit_suite_name = my_suite
 
+.. versionadded:: 4.0
+
+JUnit XML specification seems to indicate that ``"time"`` attribute
+should report total test execution times, including setup and teardown
+(`1 <http://windyroad.com.au/dl/Open%20Source/JUnit.xsd>`_, `2
+<https://www.ibm.com/support/knowledgecenter/en/SSQ2R2_14.1.0/com.ibm.rsar.analysis.codereview.cobol.doc/topics/cac_useresults_junit.html>`_).
+It is the default pytest behavior. To report just call durations
+instead, configure the ``junit_duration_report`` option like this:
+
+.. code-block:: ini
+
+    [pytest]
+    junit_duration_report = call
+
 .. _record_property example:
 
 record_property
@@ -478,14 +622,10 @@ Creating resultlog format files
 
 .. deprecated:: 3.0
 
-    This option is rarely used and is scheduled for removal in 4.0.
+    This option is rarely used and is scheduled for removal in 5.0.
 
-    An alternative for users which still need similar functionality is to use the
-    `pytest-tap <https://pypi.org/project/pytest-tap/>`_ plugin which provides
-    a stream of test data.
-
-    If you have any concerns, please don't hesitate to
-    `open an issue <https://github.com/pytest-dev/pytest/issues>`_.
+    See `the deprecation docs <https://docs.pytest.org/en/latest/deprecations.html#result-log-result-log>`__
+    for more information.
 
 To create plain-text machine-readable result files you can issue::
 
@@ -556,8 +696,25 @@ Running it will show that ``MyPlugin`` was added and its
 hook was invoked::
 
     $ python myinvoke.py
-    .                                                                    [100%]*** test run reporting finishing
+    .FEsxX.                                                              [100%]*** test run reporting finishing
 
+    ================================== ERRORS ==================================
+    _______________________ ERROR at setup of test_error _______________________
+
+        @pytest.fixture
+        def error_fixture():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:6: AssertionError
+    ================================= FAILURES =================================
+    ________________________________ test_fail _________________________________
+
+        def test_fail():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:14: AssertionError
 
 .. note::
 

doc/en/warnings.rst

@@ -18,25 +18,31 @@ and displays them at the end of the session::
     def test_one():
         assert api_v1() == 1
 
-Running pytest now produces this output::
+Running pytest now produces this output:
+
+.. code-block:: pytest
 
     $ pytest test_show_warnings.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 1 item
 
     test_show_warnings.py .                                              [100%]
 
     ============================= warnings summary =============================
-    $REGENDOC_TMPDIR/test_show_warnings.py:4: UserWarning: api v1, should use functions from v2
-      warnings.warn(UserWarning("api v1, should use functions from v2"))
+    test_show_warnings.py::test_one
+      $REGENDOC_TMPDIR/test_show_warnings.py:4: UserWarning: api v1, should use functions from v2
+        warnings.warn(UserWarning("api v1, should use functions from v2"))
 
     -- Docs: https://docs.pytest.org/en/latest/warnings.html
     =================== 1 passed, 1 warnings in 0.12 seconds ===================
 
 The ``-W`` flag can be passed to control which warnings will be displayed or even turn
-them into errors::
+them into errors:
+
+.. code-block:: pytest
 
     $ pytest -q test_show_warnings.py -W error::UserWarning
     F                                                                    [100%]
@@ -75,54 +81,6 @@ Both ``-W`` command-line option and ``filterwarnings`` ini option are based on P
 `-W option`_ and `warnings.simplefilter`_, so please refer to those sections in the Python
 documentation for other examples and advanced usage.
 
-Disabling warning summary
--------------------------
-
-Although not recommended, you can use the ``--disable-warnings`` command-line option to suppress the
-warning summary entirely from the test run output.
-
-Disabling warning capture entirely
-----------------------------------
-
-This plugin is enabled by default but can be disabled entirely in your ``pytest.ini`` file with:
-
-    .. code-block:: ini
-
-        [pytest]
-        addopts = -p no:warnings
-
-Or passing ``-p no:warnings`` in the command-line. This might be useful if your test suites handles warnings
-using an external system.
-
-
-.. _`deprecation-warnings`:
-
-DeprecationWarning and PendingDeprecationWarning
-------------------------------------------------
-
-.. versionadded:: 3.8
-
-By default pytest will display ``DeprecationWarning`` and ``PendingDeprecationWarning`` if no other warning filters
-are configured.
-
-To disable showing ``DeprecationWarning`` and ``PendingDeprecationWarning`` warnings, you might define any warnings
-filter either in the command-line or in the ini file, or you can use:
-
-.. code-block:: ini
-
-    [pytest]
-    filterwarnings =
-        ignore::DeprecationWarning
-        ignore::PendingDeprecationWarning
-
-.. note::
-    This makes pytest more compliant with `PEP-0506 <https://www.python.org/dev/peps/pep-0565/#recommended-filter-settings-for-test-runners>`_ which suggests that those warnings should
-    be shown by default by test runners, but pytest doesn't follow ``PEP-0506`` completely because resetting all
-    warning filters like suggested in the PEP will break existing test suites that configure warning filters themselves
-    by calling ``warnings.simplefilter`` (see issue `#2430 <https://github.com/pytest-dev/pytest/issues/2430>`_
-    for an example of that).
-
-
 .. _`filterwarnings`:
 
 ``@pytest.mark.filterwarnings``
@@ -161,24 +119,6 @@ decorator or to all tests in a module by setting the ``pytestmark`` variable:
     pytestmark = pytest.mark.filterwarnings("error")
 
 
-.. note::
-
-    Except for these features, pytest does not change the python warning filter; it only captures
-    and displays the warnings which are issued with respect to the currently configured filter,
-    including changes to the filter made by test functions or by the system under test.
-
-.. note::
-
-    ``DeprecationWarning`` and ``PendingDeprecationWarning`` are hidden by the standard library
-    by default so you have to explicitly configure them to be displayed in your ``pytest.ini``:
-
-    .. code-block:: ini
-
-        [pytest]
-        filterwarnings =
-            once::DeprecationWarning
-            once::PendingDeprecationWarning
-
 
 *Credits go to Florian Schulze for the reference implementation in the* `pytest-warnings`_
 *plugin.*
@@ -187,6 +127,102 @@ decorator or to all tests in a module by setting the ``pytestmark`` variable:
 .. _warnings.simplefilter: https://docs.python.org/3/library/warnings.html#warnings.simplefilter
 .. _`pytest-warnings`: https://github.com/fschulze/pytest-warnings
 
+Disabling warnings summary
+--------------------------
+
+Although not recommended, you can use the ``--disable-warnings`` command-line option to suppress the
+warning summary entirely from the test run output.
+
+Disabling warning capture entirely
+----------------------------------
+
+This plugin is enabled by default but can be disabled entirely in your ``pytest.ini`` file with:
+
+    .. code-block:: ini
+
+        [pytest]
+        addopts = -p no:warnings
+
+Or passing ``-p no:warnings`` in the command-line. This might be useful if your test suites handles warnings
+using an external system.
+
+
+.. _`deprecation-warnings`:
+
+DeprecationWarning and PendingDeprecationWarning
+------------------------------------------------
+
+.. versionadded:: 3.8
+.. versionchanged:: 3.9
+
+By default pytest will display ``DeprecationWarning`` and ``PendingDeprecationWarning`` warnings from
+user code and third-party libraries, as recommended by `PEP-0565 <https://www.python.org/dev/peps/pep-0565>`_.
+This helps users keep their code modern and avoid breakages when deprecated warnings are effectively removed.
+
+Sometimes it is useful to hide some specific deprecation warnings that happen in code that you have no control over
+(such as third-party libraries), in which case you might use the warning filters options (ini or marks) to ignore
+those warnings.
+
+For example:
+
+.. code-block:: ini
+
+    [pytest]
+    filterwarnings =
+        ignore:.*U.*mode is deprecated:DeprecationWarning
+
+
+This will ignore all warnings of type ``DeprecationWarning`` where the start of the message matches
+the regular expression ``".*U.*mode is deprecated"``.
+
+.. note::
+    If warnings are configured at the interpreter level, using
+    the `PYTHONWARNINGS <https://docs.python.org/3/using/cmdline.html#envvar-PYTHONWARNINGS>`_ environment variable or the
+    ``-W`` command-line option, pytest will not configure any filters by default.
+
+    Also pytest doesn't follow ``PEP-0506`` suggestion of resetting all warning filters because
+    it might break test suites that configure warning filters themselves
+    by calling ``warnings.simplefilter`` (see issue `#2430 <https://github.com/pytest-dev/pytest/issues/2430>`_
+    for an example of that).
+
+
+.. _`ensuring a function triggers a deprecation warning`:
+
+.. _ensuring_function_triggers:
+
+Ensuring code triggers a deprecation warning
+--------------------------------------------
+
+You can also call a global helper for checking
+that a certain function call triggers a ``DeprecationWarning`` or
+``PendingDeprecationWarning``::
+
+    import pytest
+
+    def test_global():
+        pytest.deprecated_call(myfunction, 17)
+
+By default, ``DeprecationWarning`` and ``PendingDeprecationWarning`` will not be
+caught when using ``pytest.warns`` or ``recwarn`` because default Python warnings filters hide
+them. If you wish to record them in your own code, use the
+command ``warnings.simplefilter('always')``::
+
+    import warnings
+    import pytest
+
+    def test_deprecation(recwarn):
+        warnings.simplefilter('always')
+        warnings.warn("deprecated", DeprecationWarning)
+        assert len(recwarn) == 1
+        assert recwarn.pop(DeprecationWarning)
+
+You can also use it as a contextmanager::
+
+    def test_global():
+        with pytest.deprecated_call():
+            myobject.deprecated_method()
+
+
 
 .. _`asserting warnings`:
 
@@ -197,7 +233,7 @@ decorator or to all tests in a module by setting the ``pytestmark`` variable:
 .. _warns:
 
 Asserting warnings with the warns function
------------------------------------------------
+------------------------------------------
 
 .. versionadded:: 2.8
 
@@ -255,7 +291,7 @@ Alternatively, you can examine raised warnings in detail using the
 .. _recwarn:
 
 Recording warnings
-------------------------
+------------------
 
 You can record raised warnings either using ``pytest.warns`` or with
 the ``recwarn`` fixture.
@@ -293,42 +329,28 @@ warnings, or index into it to get a particular recorded warning.
 
 Full API: :class:`WarningsRecorder`.
 
-.. _`ensuring a function triggers a deprecation warning`:
+.. _custom_failure_messages:
 
-.. _ensuring_function_triggers:
+Custom failure messages
+-----------------------
 
-Ensuring a function triggers a deprecation warning
--------------------------------------------------------
+Recording warnings provides an opportunity to produce custom test
+failure messages for when no warnings are issued or other conditions
+are met.
 
-You can also call a global helper for checking
-that a certain function call triggers a ``DeprecationWarning`` or
-``PendingDeprecationWarning``::
+.. code-block:: python
 
-    import pytest
+    def test():
+        with pytest.warns(Warning) as record:
+            f()
+            if not record:
+                pytest.fail("Expected a warning!")
 
-    def test_global():
-        pytest.deprecated_call(myfunction, 17)
-
-By default, ``DeprecationWarning`` and ``PendingDeprecationWarning`` will not be
-caught when using ``pytest.warns`` or ``recwarn`` because default Python warnings filters hide
-them. If you wish to record them in your own code, use the
-command ``warnings.simplefilter('always')``::
-
-    import warnings
-    import pytest
-
-    def test_deprecation(recwarn):
-        warnings.simplefilter('always')
-        warnings.warn("deprecated", DeprecationWarning)
-        assert len(recwarn) == 1
-        assert recwarn.pop(DeprecationWarning)
-
-You can also use it as a contextmanager::
-
-    def test_global():
-        with pytest.deprecated_call():
-            myobject.deprecated_method()
+If no warnings are issued when calling ``f``, then ``not record`` will
+evaluate to ``True``.  You can then call ``pytest.fail`` with a
+custom error message.
 
+.. _internal-warnings:
 
 Internal pytest warnings
 ------------------------
@@ -350,22 +372,22 @@ defines an ``__init__`` constructor, as this prevents the class from being insta
         def test_foo(self):
             assert 1 == 1
 
-::
+.. code-block:: pytest
 
     $ pytest test_pytest_warnings.py -q
 
     ============================= warnings summary =============================
-    $REGENDOC_TMPDIR/test_pytest_warnings.py:1: PytestWarning: cannot collect test class 'Test' because it has a __init__ constructor
-      class Test:
+    test_pytest_warnings.py:1
+      $REGENDOC_TMPDIR/test_pytest_warnings.py:1: PytestWarning: cannot collect test class 'Test' because it has a __init__ constructor
+        class Test:
 
     -- Docs: https://docs.pytest.org/en/latest/warnings.html
     1 warnings in 0.12 seconds
 
 These warnings might be filtered using the same builtin mechanisms used to filter other types of warnings.
 
-Following our :ref:`backwards-compatibility`, deprecated features will be kept *at least* two minor releases. After that,
-they will changed so they by default raise errors instead of just warnings, so users can adapt to it on their own time
-if not having done so until now. In a later release the deprecated feature will be removed completely.
+Please read our :ref:`backwards-compatibility` to learn how we proceed about deprecating and eventually removing
+features.
 
 The following warning types ares used by pytest and are part of the public API:
 

doc/en/writing_plugins.rst

@@ -73,7 +73,7 @@ sub directory but not for other directories::
     a/conftest.py:
         def pytest_runtest_setup(item):
             # called for running each test in 'a' directory
-            print ("setting up", item)
+            print("setting up", item)
 
     a/test_sub.py:
         def test_sub():
@@ -386,40 +386,43 @@ return a result object, with which we can assert the tests' outcomes.
         result.assert_outcomes(passed=4)
 
 
-additionally it is possible to copy examples for a example folder before running pytest on it
+additionally it is possible to copy examples for an example folder before running pytest on it
 
-.. code:: ini
+.. code-block:: ini
 
   # content of pytest.ini
   [pytest]
   pytester_example_dir = .
 
 
-.. code:: python
+.. code-block:: python
 
     # content of test_example.py
 
 
     def test_plugin(testdir):
-      testdir.copy_example("test_example.py")
-      testdir.runpytest("-k", "test_example")
+        testdir.copy_example("test_example.py")
+        testdir.runpytest("-k", "test_example")
+
 
     def test_example():
-      pass
+        pass
 
-.. code::
+.. code-block:: pytest
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 2 items
 
     test_example.py ..                                                   [100%]
 
     ============================= warnings summary =============================
-    $REGENDOC_TMPDIR/test_example.py:4: PytestExperimentalApiWarning: testdir.copy_example is an experimental api that may change over time
-      testdir.copy_example("test_example.py")
+    test_example.py::test_plugin
+      $REGENDOC_TMPDIR/test_example.py:4: PytestExperimentalApiWarning: testdir.copy_example is an experimental api that may change over time
+        testdir.copy_example("test_example.py")
 
     -- Docs: https://docs.pytest.org/en/latest/warnings.html
     =================== 2 passed, 1 warnings in 0.12 seconds ===================

doc/en/xunit_setup.rst

@@ -93,7 +93,15 @@ Remarks:
 
 * It is possible for setup/teardown pairs to be invoked multiple times
   per testing process.
+
 * teardown functions are not called if the corresponding setup function existed
   and failed/was skipped.
 
+* Prior to pytest-4.2, xunit-style functions did not obey the scope rules of fixtures, so
+  it was possible, for example, for a ``setup_method`` to be called before a
+  session-scoped autouse fixture.
+
+  Now the xunit-style functions are integrated with the fixture mechanism and obey the proper
+  scope rules of fixtures involved in the call.
+
 .. _`unittest.py module`: http://docs.python.org/library/unittest.html

extra/get_issues.py

@@ -1,4 +1,5 @@
 import json
+
 import py
 import requests
 
@@ -64,9 +65,9 @@ def report(issues):
         print(title)
         # print()
         # lines = body.split("\n")
-        # print ("\n".join(lines[:3]))
+        # print("\n".join(lines[:3]))
         # if len(lines) > 3 or len(body) > 240:
-        #    print ("...")
+        #    print("...")
     print("\n\nFound %s open issues" % len(issues))
 
 

pyproject.toml

@@ -1,9 +1,11 @@
 [build-system]
 requires = [
-  "setuptools",
+  # sync with setup.py until we discard non-pep-517/518
+  "setuptools>=40.0",
   "setuptools-scm",
   "wheel",
 ]
+build-backend = "setuptools.build_meta"
 
 [tool.towncrier]
 package = "pytest"
@@ -15,7 +17,12 @@ template = "changelog/_template.rst"
 
   [[tool.towncrier.type]]
   directory = "removal"
-  name = "Deprecations and Removals"
+  name = "Removals"
+  showcontent = true
+
+  [[tool.towncrier.type]]
+  directory = "deprecation"
+  name = "Deprecations"
   showcontent = true
 
   [[tool.towncrier.type]]

scripts/appveyor-retry.cmd

@@ -0,0 +1,21 @@
+@echo off
+rem Source: https://github.com/appveyor/ci/blob/master/scripts/appveyor-retry.cmd
+rem initiate the retry number
+set retryNumber=0
+set maxRetries=3
+
+:RUN
+%*
+set LastErrorLevel=%ERRORLEVEL%
+IF %LastErrorLevel% == 0 GOTO :EOF
+set /a retryNumber=%retryNumber%+1
+IF %reTryNumber% == %maxRetries% (GOTO :FAILED)
+
+:RETRY
+set /a retryNumberDisp=%retryNumber%+1
+@echo Command "%*" failed with exit code %LastErrorLevel%. Retrying %retryNumberDisp% of %maxRetries%
+GOTO :RUN
+
+: FAILED
+@echo Sorry, we tried running command for %maxRetries% times and all attempts were unsuccessful!
+EXIT /B %LastErrorLevel%

scripts/call-tox.bat

@@ -1,8 +0,0 @@
-REM skip "coveralls" run in PRs or forks
-if "%TOXENV%" == "coveralls" (
-    if not defined COVERALLS_REPO_TOKEN (
-        echo skipping coveralls run because COVERALLS_REPO_TOKEN is not defined
-        exit /b 0
-    )
-)
-C:\Python36\python -m tox

scripts/fail

@@ -1,7 +0,0 @@
-#!/usr/bin/env python
-"""Used by .pre-commit-config.yaml"""
-import sys
-
-if __name__ == "__main__":
-    print(" ".join(sys.argv[1:]))
-    sys.exit(1)

scripts/prepare-coverage.bat

@@ -0,0 +1,10 @@
+REM scripts called by AppVeyor to setup the environment variables to enable coverage
+if not defined PYTEST_NO_COVERAGE (
+    set "COVERAGE_FILE=%CD%\.coverage"
+    set "COVERAGE_PROCESS_START=%CD%\.coveragerc"
+    set "_PYTEST_TOX_COVERAGE_RUN=coverage run -m"
+    set "_PYTEST_TOX_EXTRA_DEP=coverage-enable-subprocess"
+    echo Coverage setup completed
+) else (
+    echo Skipping coverage setup, PYTEST_NO_COVERAGE is set
+)

scripts/release.py

@@ -2,9 +2,13 @@
 Invoke development tasks.
 """
 import argparse
-from colorama import init, Fore
 from pathlib import Path
-from subprocess import check_output, check_call, call
+from subprocess import call
+from subprocess import check_call
+from subprocess import check_output
+
+from colorama import Fore
+from colorama import init
 
 
 def announce(version):

scripts/upload-coverage.bat

@@ -0,0 +1,11 @@
+REM script called by AppVeyor to combine and upload coverage information to codecov
+if not defined PYTEST_NO_COVERAGE (
+    echo Prepare to upload coverage information
+    C:\Python36\Scripts\pip install codecov
+    C:\Python36\Scripts\coverage combine
+    C:\Python36\Scripts\coverage xml --ignore-errors
+    C:\Python36\Scripts\coverage report -m --ignore-errors
+    scripts\appveyor-retry C:\Python36\Scripts\codecov --required -X gcov pycov search -f coverage.xml --flags %TOXENV:-= % windows
+) else (
+    echo Skipping coverage upload, PYTEST_NO_COVERAGE is set
+)