Small fixes in the CHANGELOG for 5.3.0

Remove check for os.symlink, always there in py3+

.coveragerc

@@ -16,3 +16,11 @@ source = src/
   */lib/python*/site-packages/
   */pypy*/site-packages/
   *\Lib\site-packages\
+
+[report]
+skip_covered = True
+show_missing = True
+exclude_lines =
+    \#\s*pragma: no cover
+    ^\s*raise NotImplementedError\b
+    ^\s*return NotImplemented\b

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# info:
+# * https://help.github.com/en/articles/displaying-a-sponsor-button-in-your-repository
+# * https://tidelift.com/subscription/how-to-connect-tidelift-with-github
+tidelift: pypi/pytest
+open_collective: pytest

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,16 +1,15 @@
 <!--
 Thanks for submitting a PR, your contribution is really appreciated!
 
-Here's a quick checklist that should be present in PRs.
-(please delete this text from the final description, this is just a guideline)
--->
+Here is a quick checklist that should be present in PRs.
 
-- [ ] 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.
+- [ ] Target the `features` branch for new features, improvements, and removals/deprecations.
 - [ ] Include documentation when adding new features.
 - [ ] Include new tests or update existing tests when applicable.
 
-Unless your change is trivial or a small documentation fix (e.g.,  a typo or reword of a small section) please:
+Unless your change is trivial or a small documentation fix (e.g., a typo or reword of a small section) please:
 
-- [ ] Add yourself to `AUTHORS` in alphabetical order;
+- [ ] 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.
+- [ ] Add yourself to `AUTHORS` in alphabetical order.
+-->

.gitignore

@@ -35,6 +35,7 @@ env/
 .tox
 .cache
 .pytest_cache
+.mypy_cache
 .coverage
 .coverage.*
 coverage.xml

.pre-commit-config.yaml

@@ -1,22 +1,22 @@
 exclude: doc/en/example/py2py3/test_py2.py
 repos:
--   repo: https://github.com/python/black
-    rev: 19.3b0
+-   repo: https://github.com/psf/black
+    rev: 19.10b0
     hooks:
     -   id: black
         args: [--safe, --quiet]
-        language_version: python3
 -   repo: https://github.com/asottile/blacken-docs
-    rev: v0.5.0
+    rev: v1.0.0
     hooks:
     -   id: blacken-docs
         additional_dependencies: [black==19.3b0]
-        language_version: python3
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.1.0
+    rev: v2.2.3
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
+    -   id: fix-encoding-pragma
+        args: [--remove]
     -   id: check-yaml
     -   id: debug-statements
         exclude: _pytest/debugging.py
@@ -26,33 +26,40 @@ repos:
     hooks:
     -   id: flake8
         language_version: python3
+        additional_dependencies: [flake8-typing-imports==1.3.0]
 -   repo: https://github.com/asottile/reorder_python_imports
     rev: v1.4.0
     hooks:
     -   id: reorder-python-imports
-        args: ['--application-directories=.:src']
+        args: ['--application-directories=.:src', --py3-plus]
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v1.15.0
+    rev: v1.18.0
     hooks:
     -   id: pyupgrade
-        args: [--keep-percent-format]
+        args: [--py3-plus]
 -   repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.3.0
+    rev: v1.4.0
     hooks:
     -   id: rst-backticks
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.740
+    hooks:
+    -   id: mypy
+        files: ^(src/|testing/)
+        args: []
 -   repo: local
     hooks:
     -   id: rst
         name: rst
         entry: rst-lint --encoding utf-8
-        files: ^(CHANGELOG.rst|HOWTORELEASE.rst|README.rst|changelog/.*)$
+        files: ^(CHANGELOG.rst|HOWTORELEASE.rst|README.rst|TIDELIFT.rst|changelog/.*)$
         language: python
         additional_dependencies: [pygments, restructuredtext_lint]
     -   id: changelogs-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)
+        exclude: changelog/(\d+\.(feature|improvement|bugfix|doc|deprecation|removal|vendor|trivial).rst|README.rst|_template.rst)
         files: ^changelog/
     -   id: py-deprecated
         name: py library is deprecated

.travis.yml

@@ -13,27 +13,23 @@ env:
   global:
     - PYTEST_ADDOPTS=-vv
 
+# setuptools-scm needs all tags in order to obtain a proper version
+git:
+  depth: false
+
 install:
   - python -m pip install --upgrade --pre tox
 
 jobs:
   include:
     # OSX tests - first (in test stage), since they are the slower ones.
-    - &test-macos
-      # NOTE: (tests with) pexpect appear to be buggy on Travis,
-      #       at least with coverage.
-      #       Log: https://travis-ci.org/pytest-dev/pytest/jobs/500358864
-      os: osx
+    # Coverage for:
+    # - osx
+    # - verbose=1
+    - os: osx
       osx_image: xcode10.1
       language: generic
-      # Coverage for:
-      # - py2 with symlink in test_cmdline_python_package_symlink.
-      env: TOXENV=py27-xdist PYTEST_COVERAGE=1
-      before_install:
-        - python -V
-        - test $(python -c 'import sys; print("%d%d" % sys.version_info[0:2])') = 27
-    - <<: *test-macos
-      env: TOXENV=py37-xdist
+      env: TOXENV=py37-xdist PYTEST_COVERAGE=1 PYTEST_ADDOPTS=-v
       before_install:
         - which python3
         - python3 -V
@@ -41,55 +37,33 @@ jobs:
         - python -V
         - test $(python -c 'import sys; print("%d%d" % sys.version_info[0:2])') = 37
 
-    # Full run of latest (major) supported versions, without xdist.
-    - env: TOXENV=py27
-      python: '2.7'
-    - env: TOXENV=py37
-      python: '3.7'
-
-    # Coverage tracking is slow with pypy, skip it.
-    - env: TOXENV=pypy-xdist
-      python: 'pypy'
-    - env: TOXENV=pypy3-xdist
-      python: 'pypy3'
-
-    - env: TOXENV=py34-xdist
-      python: '3.4'
-    - env: TOXENV=py35-xdist
-      python: '3.5'
-
+    # Full run of latest supported version, without xdist.
     # Coverage for:
     # - pytester's LsofFdLeakChecker
     # - TestArgComplete (linux only)
     # - numpy
-    # Empty PYTEST_ADDOPTS to run this non-verbose.
-    - env: TOXENV=py37-lsof-numpy-xdist PYTEST_COVERAGE=1 PYTEST_ADDOPTS=
+    # - old attrs
+    # - verbose=0
+    # - test_sys_breakpoint_interception (via pexpect).
+    - env: TOXENV=py37-lsof-numpy-oldattrs-pexpect-twisted PYTEST_COVERAGE=1 PYTEST_ADDOPTS=
+      python: '3.7'
 
-    # Specialized factors for py27.
-    - env: TOXENV=py27-nobyte-numpy-xdist
-      python: '2.7'
-    - env: TOXENV=py27-pluggymaster-xdist
-      python: '2.7'
+    # Coverage tracking is slow with pypy, skip it.
+    - env: TOXENV=pypy3-xdist
+      python: 'pypy3'
+
+    - env: TOXENV=py35-xdist
+      python: '3.5'
 
     # Specialized factors for py37.
-    # Coverage for:
-    # - test_sys_breakpoint_interception (via pexpect).
-    - env: TOXENV=py37-pexpect,py37-twisted PYTEST_COVERAGE=1
     - env: TOXENV=py37-pluggymaster-xdist
     - env: TOXENV=py37-freeze
 
-    # Jobs only run via Travis cron jobs (currently daily).
     - env: TOXENV=py38-xdist
-      python: '3.8-dev'
-      if: type = cron
+      python: '3.8'
 
     - stage: baseline
-    # Coverage for:
-    # - _pytest.unittest._handle_skip (via pexpect).
-      env: TOXENV=py27-pexpect,py27-twisted PYTEST_COVERAGE=1
-      python: '2.7'
-    # Use py36 here for faster baseline.
-    - env: TOXENV=py36-xdist
+      env: TOXENV=py36-xdist
       python: '3.6'
     - env: TOXENV=linting,docs,doctesting PYTEST_COVERAGE=1
       cache:
@@ -98,8 +72,17 @@ jobs:
 
     - stage: deploy
       python: '3.6'
-      install: pip install -U setuptools setuptools_scm
+      install: pip install -U setuptools setuptools_scm tox
       script: skip
+      # token to upload github release notes: GH_RELEASE_NOTES_TOKEN
+      env:
+        - secure: "OjOeL7/0JUDkV00SsTs732e8vQjHynpbG9FKTNtZZJ+1Zn4Cib+hAlwmlBnvVukML0X60YpcfjnC4quDOIGLPsh5zeXnvJmYtAIIUNQXjWz8NhcGYrhyzuP1rqV22U68RTCdmOq3lMYU/W2acwHP7T49PwJtOiUM5kF120UAQ0Zi5EmkqkIvH8oM5mO9Dlver+/U7Htpz9rhKrHBXQNCMZI6yj2aUyukqB2PN2fjAlDbCF//+FmvYw9NjT4GeFOSkTCf4ER9yfqs7yglRfwiLtOCZ2qKQhWZNsSJDB89rxIRXWavJUjJKeY2EW2/NkomYJDpqJLIF4JeFRw/HhA47CYPeo6BJqyyNV+0CovL1frpWfi9UQw2cMbgFUkUIUk3F6DD59PHNIOX2R/HX56dQsw7WKl3QuHlCOkICXYg8F7Ta684IoKjeTX03/6QNOkURfDBwfGszY0FpbxrjCSWKom6RyZdyidnESaxv9RzjcIRZVh1rp8KMrwS1OrwRSdG0zjlsPr49hWMenN/8fKgcHTV4/r1Tj6mip0dorSRCrgUNIeRBKgmui6FS8642ab5JNKOxMteVPVR2sFuhjOQ0Jy+PmvceYY9ZMWc3+/B/KVh0dZ3hwvLGZep/vxDS2PwCA5/xw31714vT5LxidKo8yECjBynMU/wUTTS695D3NY="
+      addons:
+        apt:
+          packages:
+            # required by publish_gh_release_notes
+            - pandoc
+      after_deploy: tox -e publish_gh_release_notes
       deploy:
         provider: pypi
         user: nicoddemus
@@ -111,11 +94,6 @@ jobs:
           tags: true
           repo: pytest-dev/pytest
 
-matrix:
-  allow_failures:
-    - python: '3.8-dev'
-      env: TOXENV=py38-xdist
-
 before_script:
   - |
     # Do not (re-)upload coverage with cron runs.
@@ -130,18 +108,12 @@ before_script:
       export _PYTEST_TOX_EXTRA_DEP=coverage-enable-subprocess
     fi
 
-script: tox --recreate
+script: tox
 
 after_success:
   - |
     if [[ "$PYTEST_COVERAGE" = 1 ]]; then
-      set -e
-      # Add last TOXENV to $PATH.
-      PATH="$PWD/.tox/${TOXENV##*,}/bin:$PATH"
-      coverage combine
-      coverage xml
-      coverage report -m
-      bash <(curl -s https://codecov.io/bash) -Z -X gcov -X coveragepy -X search -X xcode -X gcovout -X fix -f coverage.xml -n $TOXENV-$TRAVIS_OS_NAME
+      env CODECOV_NAME="$TOXENV-$TRAVIS_OS_NAME" scripts/report-coverage.sh
     fi
 
 notifications:
@@ -153,3 +125,10 @@ notifications:
     skip_join: true
   email:
     - pytest-commit@python.org
+
+branches:
+  only:
+    - master
+    - features
+    - 4.6-maintenance
+    - /^\d+(\.\d+)+$/

AUTHORS

@@ -9,11 +9,13 @@ Abhijeet Kasurde
 Adam Johnson
 Adam Uhlir
 Ahn Ki-Wook
+Akiomi Kamakura
 Alan Velasco
 Alexander Johnson
 Alexei Kozlenok
 Allan Feldman
 Aly Sivji
+Amir Elkess
 Anatoly Bubenkoff
 Anders Hovmöller
 Andras Mitzki
@@ -21,6 +23,7 @@ Andras Tim
 Andrea Cimatoribus
 Andreas Zeidler
 Andrey Paramonov
+Andrzej Klajnert
 Andrzej Ostrowski
 Andy Freeland
 Anthon van der Neut
@@ -53,6 +56,7 @@ Charnjit SiNGH (CCSJ)
 Chris Lamb
 Christian Boelsen
 Christian Fetzer
+Christian Neumüller
 Christian Theunert
 Christian Tismer
 Christopher Gilling
@@ -66,9 +70,11 @@ Daniel Hahler
 Daniel Nuri
 Daniel Wandschneider
 Danielle Jenkins
+Daniil Galiev
 Dave Hunt
 David Díaz-Barquero
 David Mohr
+David Paul Röthlisberger
 David Szotten
 David Vierra
 Daw-Ran Liou
@@ -86,16 +92,19 @@ Endre Galaczi
 Eric Hunsberger
 Eric Siegerman
 Erik M. Bray
+Evan Kepner
 Fabien Zarifian
 Fabio Zadrozny
 Feng Ma
 Florian Bruhin
 Floris Bruynooghe
 Gabriel Reis
+Gene Wood
 George Kussumoto
 Georgy Dyuldin
 Graham Horler
 Greg Price
+Gregory Lee
 Grig Gheorghiu
 Grigorii Eremeev (budulianin)
 Guido Wesdorp
@@ -126,6 +135,7 @@ Jordan Guymon
 Jordan Moldow
 Jordan Speicher
 Joseph Hunkeler
+Josh Karpel
 Joshua Bronson
 Jurko Gospodnetić
 Justyna Janczyszyn
@@ -133,6 +143,7 @@ Kale Kundert
 Katarzyna Jachim
 Katerina Koukiou
 Kevin Cox
+Kevin J. Foley
 Kodi B. Arfer
 Kostis Anagnostopoulos
 Kristoffer Nordström
@@ -152,6 +163,7 @@ Manuel Krebber
 Marc Schlaich
 Marcelo Duarte Trevisani
 Marcin Bachry
+Marco Gorelli
 Mark Abramowitz
 Markus Unterwaditzer
 Martijn Faassen
@@ -168,6 +180,8 @@ mbyt
 Michael Aquilina
 Michael Birtwell
 Michael Droettboom
+Michael Goerz
+Michael Krebs
 Michael Seifert
 Michal Wajszczuk
 Mihai Capotă
@@ -194,14 +208,17 @@ Paweł Adamczak
 Pedro Algarvio
 Pieter Mulder
 Piotr Banaszkiewicz
+Pulkit Goyal
 Punyashloka Biswal
 Quentin Pradet
 Ralf Schmitt
+Ralph Giles
 Ran Benita
 Raphael Castaneda
 Raphael Pierzina
 Raquel Alegre
 Ravi Chandra
+Robert Holt
 Roberto Polli
 Roland Puntaier
 Romain Dorgueil
@@ -211,6 +228,7 @@ Ross Lawley
 Russel Winder
 Ryan Wooden
 Samuel Dion-Girardeau
+Samuel Searles-Bryant
 Samuele Pedroni
 Sankt Petersbug
 Segev Finer
@@ -231,6 +249,7 @@ Tareq Alayan
 Ted Xiao
 Thomas Grainger
 Thomas Hisch
+Tim Hoffmann
 Tim Strazny
 Tom Dalton
 Tom Viner
@@ -246,11 +265,14 @@ Virgil Dupras
 Vitaly Lashmanov
 Vlad Dragos
 Volodymyr Piskun
+Wei Lin
 Wil Cooley
 William Lee
 Wim Glenn
 Wouter van Ackooy
+Xixi Zhao
 Xuan Luong
 Xuecong Liao
+Yoav Caspi
 Zac Hatfield-Dodds
 Zoltán Máté

CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at coc@pytest.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+The coc@pytest.org address is routed to the following people who can also be
+contacted individually:
+
+- Brianna Laugher ([@pfctdayelise](https://github.com/pfctdayelise)): brianna@laugher.id.au
+- Bruno Oliveira ([@nicoddemus](https://github.com/nicoddemus)): nicoddemus@gmail.com
+- Florian Bruhin ([@the-compiler](https://github.com/the-compiler)): pytest@the-compiler.org
+- Ronny Pfannschmidt ([@RonnyPfannschmidt](https://github.com/RonnyPfannschmidt)): ich@ronnypfannschmidt.de
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.rst

@@ -5,8 +5,9 @@ Contribution getting started
 Contributions are highly welcomed and appreciated.  Every little help counts,
 so do not hesitate!
 
-.. contents:: Contribution links
+.. contents::
    :depth: 2
+   :backlinks: none
 
 
 .. _submitfeedback:
@@ -166,14 +167,14 @@ Short version
 #. Enable and install `pre-commit <https://pre-commit.com>`_ to ensure style-guides and code checks are followed.
 #. Target ``master`` for bugfixes and doc changes.
 #. Target ``features`` for new features or functionality changes.
-#. Follow **PEP-8** for naming and `black <https://github.com/python/black>`_ for formatting.
+#. Follow **PEP-8** for naming and `black <https://github.com/psf/black>`_ for formatting.
 #. Tests are run using ``tox``::
 
-    tox -e linting,py27,py37
+    tox -e linting,py37
 
    The test environments above are usually enough to cover most cases locally.
 
-#. Write a ``changelog`` entry: ``changelog/2574.bugfix``, use issue id number
+#. Write a ``changelog`` entry: ``changelog/2574.bugfix.rst``, use issue id number
    and one of ``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or
    ``trivial`` for the issue type.
 #. Unless your change is a trivial or a documentation fix (e.g., a typo or reword of a small section) please
@@ -217,7 +218,9 @@ Here is a simple overview, with pytest-specific bits:
    If you need some help with Git, follow this quick start
    guide: https://git.wiki.kernel.org/index.php/QuickStart
 
-#. Install `pre-commit <https://pre-commit.com>`_ and its hook on the pytest repo::
+#. Install `pre-commit <https://pre-commit.com>`_ and its hook on the pytest repo:
+
+   **Note: pre-commit must be installed as admin, as it will not function otherwise**::
 
      $ pip install --user pre-commit
      $ pre-commit install
@@ -237,20 +240,20 @@ Here is a simple overview, with pytest-specific bits:
 
 #. Run all the tests
 
-   You need to have Python 2.7 and 3.7 available in your system.  Now
+   You need to have Python 3.7 available in your system.  Now
    running tests is as simple as issuing this command::
 
-    $ tox -e linting,py27,py37
+    $ tox -e linting,py37
 
-   This command will run tests via the "tox" tool against Python 2.7 and 3.7
+   This command will run tests via the "tox" tool against Python 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.
 
-   You can pass different options to ``tox``. For example, to run tests on Python 2.7 and pass options to pytest
+   You can pass different options to ``tox``. For example, to run tests on Python 3.7 and pass options to pytest
    (e.g. enter pdb on failure) to pytest you can do::
 
-    $ tox -e py27 -- --pdb
+    $ tox -e py37 -- --pdb
 
    Or to only run tests in a particular test module on Python 3.7::
 
@@ -264,9 +267,10 @@ Here is a simple overview, with pytest-specific bits:
     $ git commit -a -m "<commit message>"
     $ git push -u
 
-#. Create a new changelog entry in ``changelog``. The file should be named ``<issueid>.<type>``,
+#. Create a new changelog entry in ``changelog``. The file should be named ``<issueid>.<type>.rst``,
    where *issueid* is the number of the issue related to the change and *type* is one of
-   ``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or ``trivial``.
+   ``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or ``trivial``. You may not create a
+   changelog entry if the change doesn't affect the documented behaviour of Pytest.
 
 #. Add yourself to ``AUTHORS`` file if not there yet, in alphabetical order.
 

HOWTORELEASE.rst

@@ -12,6 +12,8 @@ taking a lot of time to make a new one.
 
 #. Create a branch ``release-X.Y.Z`` with the version for the release.
 
+   * **maintenance releases**: from ``4.6-maintenance``;
+
    * **patch releases**: from the latest ``master``;
 
    * **minor releases**: from the latest ``features``; then merge with the latest ``master``;
@@ -24,7 +26,8 @@ taking a lot of time to make a new one.
 
    This will generate a commit with all the changes ready for pushing.
 
-#. Open a PR for this branch targeting ``master``.
+#. Open a PR for this branch targeting ``master`` (or ``4.6-maintenance`` for
+   maintenance releases).
 
 #. After all tests pass and the PR has been approved, publish to PyPI by pushing the tag::
 
@@ -33,7 +36,16 @@ taking a lot of time to make a new one.
 
    Wait for the deploy to complete, then make sure it is `available on PyPI <https://pypi.org/project/pytest>`_.
 
-#. Merge the PR into ``master``.
+#. Merge the PR.
+
+#. If this is a maintenance release, cherry-pick the CHANGELOG / announce
+   files to the ``master`` branch::
+
+       git fetch --all --prune
+       git checkout origin/master -b cherry-pick-maintenance-release
+       git cherry-pick --no-commit -m1 origin/4.6-maintenance
+       git checkout origin/master -- changelog
+       git commit  # no arguments
 
 #. Send an email announcement with the contents from::
 

OPENCOLLECTIVE.rst

@@ -0,0 +1,44 @@
+==============
+OpenCollective
+==============
+
+pytest has a collective setup at `OpenCollective`_. This document describes how the core team manages
+OpenCollective-related activities.
+
+What is it
+==========
+
+Open Collective is an online funding platform for open and transparent communities.
+It provides tools to raise money and share your finances in full transparency.
+
+It is the platform of choice for individuals and companies that want to make one-time or
+monthly donations directly to the project.
+
+Funds
+=====
+
+The OpenCollective funds donated to pytest will be used to fund overall maintenance,
+local sprints, merchandising (stickers to distribute in conferences for example), and future
+gatherings of pytest developers (sprints).
+
+`Core contributors`_ which are contributing on a continuous basis are free to submit invoices
+to bill maintenance hours using the platform. How much each contributor should request is still an
+open question, but we should use common sense and trust in the contributors, most of which know
+themselves in-person. A good rule of thumb is to bill the same amount as monthly payments
+contributors which participate in the `Tidelift`_ subscription. If in doubt, just ask.
+
+Admins
+======
+
+A few people have admin access to the OpenCollective dashboard to make changes. Those people
+are part of the `@pytest-dev/opencollective-admins`_ team.
+
+`Core contributors`_ interested in helping out with OpenCollective maintenance are welcome! We don't
+expect much work here other than the occasional approval of expenses from other core contributors.
+Just drop a line to one of the `@pytest-dev/opencollective-admins`_ or use the mailing list.
+
+
+.. _`OpenCollective`: https://opencollective.com/pytest
+.. _`Tidelift`: https://tidelift.com
+.. _`core contributors`: https://github.com/orgs/pytest-dev/teams/core/members
+.. _`@pytest-dev/opencollective-admins`: https://github.com/orgs/pytest-dev/teams/opencollective-admins/members

README.rst

@@ -26,7 +26,7 @@
     :target: https://dev.azure.com/pytest-dev/pytest
 
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/python/black
+    :target: https://github.com/psf/black
 
 .. image:: https://www.codetriage.com/pytest-dev/pytest/badges/users.svg
     :target: https://www.codetriage.com/pytest-dev/pytest
@@ -85,7 +85,7 @@ Features
 - Can run `unittest <https://docs.pytest.org/en/latest/unittest.html>`_ (or trial),
   `nose <https://docs.pytest.org/en/latest/nose.html>`_ test suites out of the box;
 
-- Python 2.7, Python 3.4+, PyPy 2.3, Jython 2.5 (untested);
+- Python 3.5+ and PyPy3;
 
 - Rich plugin architecture, with over 315+ `external plugins <http://plugincompat.herokuapp.com>`_ and thriving community;
 
@@ -108,6 +108,40 @@ Changelog
 Consult the `Changelog <https://docs.pytest.org/en/latest/changelog.html>`__ page for fixes and enhancements of each version.
 
 
+Support pytest
+--------------
+
+`Open Collective`_ is an online funding platform for open and transparent communities.
+It provide tools to raise money and share your finances in full transparency.
+
+It is the platform of choice for individuals and companies that want to make one-time or
+monthly donations directly to the project.
+
+See more datails in the `pytest collective`_.
+
+.. _Open Collective: https://opencollective.com
+.. _pytest collective: https://opencollective.com/pytest
+
+
+pytest for enterprise
+---------------------
+
+Available as part of the Tidelift Subscription.
+
+The maintainers of pytest and thousands of other packages are working with Tidelift to deliver commercial support and
+maintenance for the open source dependencies you use to build your applications.
+Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use.
+
+`Learn more. <https://tidelift.com/subscription/pkg/pypi-pytest?utm_source=pypi-pytest&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`_
+
+Security
+^^^^^^^^
+
+pytest has never been associated with a security vunerability, but in any case, to report a
+security vulnerability please use the `Tidelift security contact <https://tidelift.com/security>`_.
+Tidelift will coordinate the fix and disclosure.
+
+
 License
 -------
 

TIDELIFT.rst

@@ -0,0 +1,60 @@
+========
+Tidelift
+========
+
+pytest is a member of `Tidelift`_. This document describes how the core team manages
+Tidelift-related activities.
+
+What is it
+==========
+
+Tidelift aims to make Open Source sustainable by offering subscriptions to companies which rely
+on Open Source packages. This subscription allows it to pay maintainers of those Open Source
+packages to aid sustainability of the work.
+
+It is the perfect platform for companies that want to support Open Source packages and at the same
+time obtain assurances regarding maintenance, quality and security.
+
+Funds
+=====
+
+It was decided in the `mailing list`_ that the Tidelift contribution will be split evenly between
+members of the `contributors team`_ interested in receiving funding.
+
+The current list of contributors receiving funding are:
+
+* `@asottile`_
+* `@blueyed`_
+* `@nicoddemus`_
+
+Contributors interested in receiving a part of the funds just need to submit a PR adding their
+name to the list. Contributors that want to stop receiving the funds should also submit a PR
+in the same way.
+
+The PR should mention `@pytest-dev/tidelift-admins`_ so appropriate changes
+can be made in the Tidelift platform.
+
+After the PR has been accepted and merged, the contributor should register in the `Tidelift`_
+platform and follow the instructions there, including signing an `agreement`_.
+
+Admins
+======
+
+A few people have admin access to the Tidelift dashboard to make changes. Those people
+are part of the `@pytest-dev/tidelift-admins`_ team.
+
+`Core contributors`_ interested in helping out with Tidelift maintenance are welcome! We don't
+expect much work here other than the occasional adding/removal of a contributor from receiving
+funds. Just drop a line to one of the `@pytest-dev/tidelift-admins`_ or use the mailing list.
+
+
+.. _`Tidelift`: https://tidelift.com
+.. _`mailing list`: https://mail.python.org/pipermail/pytest-dev/2019-May/004716.html
+.. _`contributors team`: https://github.com/orgs/pytest-dev/teams/contributors
+.. _`core contributors`: https://github.com/orgs/pytest-dev/teams/core/members
+.. _`@pytest-dev/tidelift-admins`: https://github.com/orgs/pytest-dev/teams/tidelift-admins/members
+.. _`agreement`: https://tidelift.com/docs/lifting/agreement
+
+.. _`@asottile`: https://github.com/asottile
+.. _`@blueyed`: https://github.com/blueyed
+.. _`@nicoddemus`: https://github.com/nicoddemus

azure-pipelines.yml

@@ -4,10 +4,6 @@ trigger:
 
 variables:
   PYTEST_ADDOPTS: "--junitxml=build/test-results/$(tox.env).xml -vv"
-  python.needs_vc: False
-  python.exe: "python"
-  COVERAGE_FILE: "$(Build.Repository.LocalPath)/.coverage"
-  COVERAGE_PROCESS_START: "$(Build.Repository.LocalPath)/.coveragerc"
   PYTEST_COVERAGE: '0'
 
 jobs:
@@ -17,46 +13,10 @@ jobs:
     vmImage: "vs2017-win2016"
   strategy:
     matrix:
-      py27:
-        python.version: '2.7'
-        tox.env: 'py27'
-      py27-nobyte-lsof-numpy:
-        python.version: '2.7'
-        tox.env: 'py27-lsof-nobyte-numpy'
-        # Coverage for:
-        # - test_supports_breakpoint_module_global
-        # - test_terminal_reporter_writer_attr (without xdist)
-        # - "if write" branch in _pytest.assertion.rewrite
-        # - numpy
-        # - pytester's LsofFdLeakChecker (being skipped)
-        PYTEST_COVERAGE: '1'
-      py27-twisted:
-        python.version: '2.7'
-        tox.env: 'py27-twisted'
-        python.needs_vc: True
-      py27-pluggymaster-xdist:
-        python.version: '2.7'
-        tox.env: 'py27-pluggymaster-xdist'
-        # Coverage for:
-        # - except-IOError in _attempt_to_close_capture_file for py2.
-        #   Also seen with py27-nobyte (using xdist), and py27-xdist.
-        #   But no exception with py27-pexpect,py27-twisted,py27-numpy.
-        PYTEST_COVERAGE: '1'
-      pypy:
-        python.version: 'pypy2'
-        tox.env: 'pypy'
-        python.exe: 'pypy'
-      # NOTE: pypy3 fails to install pip currently due to an internal error.
+      # -- pypy3 disabled for now: #5279 --
       # pypy3:
       #   python.version: 'pypy3'
       #   tox.env: 'pypy3'
-      #   python.exe: 'pypy3'
-      py34-xdist:
-        python.version: '3.4'
-        tox.env: 'py34-xdist'
-        # Coverage for:
-        # - _pytest.compat._bytes_to_ascii
-        PYTEST_COVERAGE: '1'
       py35-xdist:
         python.version: '3.5'
         tox.env: 'py35-xdist'
@@ -68,7 +28,7 @@ jobs:
         tox.env: 'py36-xdist'
       py37:
         python.version: '3.7'
-        tox.env: 'py37'
+        tox.env: 'py37-twisted-numpy'
         # Coverage for:
         # - _py36_windowsconsoleio_workaround (with py36+)
         # - test_request_garbage (no xdist)
@@ -76,9 +36,6 @@ jobs:
       py37-linting/docs/doctesting:
         python.version: '3.7'
         tox.env: 'linting,docs,doctesting'
-      py37-twisted/numpy:
-        python.version: '3.7'
-        tox.env: 'py37-twisted,py37-numpy'
       py37-pluggymaster-xdist:
         python.version: '3.7'
         tox.env: 'py37-pluggymaster-xdist'
@@ -90,16 +47,17 @@ jobs:
       versionSpec: '$(python.version)'
       architecture: 'x64'
 
-  - script: choco install vcpython27
-    condition: eq(variables['python.needs_vc'], True)
-    displayName: 'Install VC for py27'
-
-  - script: $(python.exe) -m pip install --upgrade pip && $(python.exe) -m pip install tox
+  - script: python -m pip install --upgrade pip && python -m pip install tox
     displayName: 'Install tox'
 
-  - script: |
-      call scripts/setup-coverage-vars.bat || goto :eof
-      $(python.exe) -m tox -e $(tox.env)
+  - bash: |
+      if [[ "$PYTEST_COVERAGE" == "1" ]]; then
+        export _PYTEST_TOX_COVERAGE_RUN="coverage run -m"
+        export _PYTEST_TOX_EXTRA_DEP=coverage-enable-subprocess
+        export COVERAGE_FILE="$PWD/.coverage"
+        export COVERAGE_PROCESS_START="$PWD/.coveragerc"
+      fi
+      python -m tox -e $(tox.env)
     displayName: 'Run tests'
 
   - task: PublishTestResults@2
@@ -108,10 +66,12 @@ jobs:
       testRunTitle: '$(tox.env)'
     condition: succeededOrFailed()
 
-  - script: call scripts\upload-coverage.bat
-    displayName: 'Report and upload coverage'
-    condition: eq(variables['PYTEST_COVERAGE'], '1')
+  - bash: |
+      if [[ "$PYTEST_COVERAGE" == 1 ]]; then
+        scripts/report-coverage.sh
+      fi
     env:
-      PYTHON: $(python.exe)
+      CODECOV_NAME: $(tox.env)
       CODECOV_TOKEN: $(CODECOV_TOKEN)
-      PYTEST_CODECOV_NAME: $(tox.env)
+    displayName: Report and upload coverage
+    condition: eq(variables['PYTEST_COVERAGE'], '1')

bench/bench.py

@@ -6,7 +6,7 @@ if __name__ == "__main__":
     import pstats
 
     script = sys.argv[1:] if len(sys.argv) > 1 else ["empty.py"]
-    stats = cProfile.run("pytest.cmdline.main(%r)" % script, "prof")
+    cProfile.run("pytest.cmdline.main(%r)" % script, "prof")
     p = pstats.Stats("prof")
     p.strip_dirs()
     p.sort_stats("cumulative")

bench/skip.py

@@ -1,5 +1,3 @@
-from six.moves import range
-
 import pytest
 
 SKIP = True

changelog/README.rst

@@ -12,6 +12,7 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
 ``<ISSUE>`` is an issue number, and ``<TYPE>`` is one of:
 
 * ``feature``: new user facing features, like new command-line options and new behavior.
+* ``improvement``: improvement of existing functionality, usually without requiring user intervention (for example, new fields being written in ``--junitxml``, improved colors in terminal, etc).
 * ``bugfix``: fixes a reported bug.
 * ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
 * ``deprecation``: feature deprecation.

codecov.yml

@@ -0,0 +1,7 @@
+coverage:
+  status:
+    project: true
+    patch: true
+    changes: true
+
+comment: off

doc/5934.feature.rst

@@ -0,0 +1 @@
+``repr`` of ``ExceptionInfo`` objects has been improved to honor the ``__repr__`` method of the underlying exception.

doc/en/Makefile

@@ -16,7 +16,7 @@ REGENDOC_ARGS := \
 	--normalize "/[ \t]+\n/\n/" \
 	--normalize "~\$$REGENDOC_TMPDIR~/home/sweet/project~" \
 	--normalize "~/path/to/example~/home/sweet/project~" \
-	--normalize "/in \d+.\d+ seconds/in 0.12 seconds/" \
+	--normalize "/in \d.\d\ds/in 0.12s/" \
 	--normalize "@/tmp/pytest-of-.*/pytest-\d+@PYTEST_TMPDIR@" \
 	--normalize "@pytest-(\d+)\\.[^ ,]+@pytest-\1.x.y@" \
 	--normalize "@(This is pytest version )(\d+)\\.[^ ,]+@\1\2.x.y@" \
@@ -43,7 +43,7 @@ clean:
 
 regen: REGENDOC_FILES:=*.rst */*.rst
 regen:
-	PYTHONDONTWRITEBYTECODE=1 PYTEST_ADDOPTS=-pno:hypothesis COLUMNS=76 regendoc --update ${REGENDOC_FILES} ${REGENDOC_ARGS}
+	PYTHONDONTWRITEBYTECODE=1 PYTEST_ADDOPTS="-pno:hypothesis -Wignore::pytest.PytestUnknownMarkWarning" COLUMNS=76 regendoc --update ${REGENDOC_FILES} ${REGENDOC_ARGS}
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

doc/en/_templates/globaltoc.html

@@ -4,12 +4,15 @@
   <li><a href="{{ pathto('index') }}">Home</a></li>
   <li><a href="{{ pathto('getting-started') }}">Install</a></li>
   <li><a href="{{ pathto('contents') }}">Contents</a></li>
-  <li><a href="{{ pathto('reference') }}">Reference</a></li>
+  <li><a href="{{ pathto('reference') }}">API Reference</a></li>
   <li><a href="{{ pathto('example/index') }}">Examples</a></li>
   <li><a href="{{ pathto('customize') }}">Customize</a></li>
   <li><a href="{{ pathto('changelog') }}">Changelog</a></li>
   <li><a href="{{ pathto('contributing') }}">Contributing</a></li>
   <li><a href="{{ pathto('backwards-compatibility') }}">Backwards Compatibility</a></li>
+  <li><a href="{{ pathto('py27-py34-deprecation') }}">Python 2.7 and 3.4 Support</a></li>
+  <li><a href="{{ pathto('sponsor') }}">Sponsor</a></li>
+  <li><a href="{{ pathto('tidelift') }}">pytest for Enterprise</a></li>
   <li><a href="{{ pathto('license') }}">License</a></li>
   <li><a href="{{ pathto('contact') }}">Contact Channels</a></li>
 </ul>

doc/en/_themes/flask/layout.html

@@ -16,7 +16,7 @@
 {%- block footer %}
   <div class="footer">
     &copy; Copyright {{ copyright }}.
-    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.
   </div>
   {% if pagename == 'index' %}
   </div>

doc/en/_themes/flask/slim_searchbox.html

@@ -0,0 +1,15 @@
+{#
+    basic/searchbox.html with heading removed.
+#}
+{%- if pagename != "search" and builder != "singlehtml" %}
+<div id="searchbox" style="display: none" role="search">
+  <div class="searchformwrapper">
+    <form class="search" action="{{ pathto('search') }}" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel"
+        placeholder="Search"/>
+      <input type="submit" value="{{ _('Go') }}" />
+    </form>
+  </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+{%- endif %}

doc/en/_themes/flask/static/flasky.css_t

@@ -8,11 +8,12 @@
 
 {% set page_width = '1020px' %}
 {% set sidebar_width = '220px' %}
-/* orange of logo is #d67c29 but we use black for links for now */
-{% set link_color = '#000' %}
-{% set link_hover_color = '#000' %}
+/* muted version of green logo color #C9D22A */
+{% set link_color = '#606413' %}
+/* blue logo color */
+{% set link_hover_color = '#009de0' %}
 {% set base_font = 'sans-serif' %}
-{% set header_font = 'serif' %}
+{% set header_font = 'sans-serif' %}
 
 @import url("basic.css");
 
@@ -20,7 +21,7 @@
 
 body {
     font-family: {{ base_font }};
-    font-size: 17px;
+    font-size: 16px;
     background-color: white;
     color: #000;
     margin: 0;
@@ -78,13 +79,13 @@ div.related {
 }
 
 div.sphinxsidebar a {
-    color: #444;
     text-decoration: none;
-    border-bottom: 1px dotted #999;
+    border-bottom: none;
 }
 
 div.sphinxsidebar a:hover {
-    border-bottom: 1px solid #999;
+    color: {{ link_hover_color }};
+    border-bottom: 1px solid {{ link_hover_color }};
 }
 
 div.sphinxsidebar {
@@ -106,14 +107,14 @@ div.sphinxsidebar h3,
 div.sphinxsidebar h4 {
     font-family: {{ header_font }};
     color: #444;
-    font-size: 24px;
+    font-size: 21px;
     font-weight: normal;
-    margin: 0 0 5px 0;
+    margin: 16px 0 0 0;
     padding: 0;
 }
 
 div.sphinxsidebar h4 {
-    font-size: 20px;
+    font-size: 18px;
 }
 
 div.sphinxsidebar h3 a {
@@ -205,10 +206,22 @@ div.body p, div.body dd, div.body li {
     line-height: 1.4em;
 }
 
+ul.simple li {
+    margin-bottom: 0.5em;
+}
+
+div.topic ul.simple li {
+    margin-bottom: 0;
+}
+
+div.topic li > p:first-child {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
 div.admonition {
     background: #fafafa;
-    margin: 20px -30px;
-    padding: 10px 30px;
+    padding: 10px 20px;
     border-top: 1px solid #ccc;
     border-bottom: 1px solid #ccc;
 }
@@ -217,11 +230,6 @@ div.admonition tt.xref, div.admonition a tt {
     border-bottom: 1px solid #fafafa;
 }
 
-dd div.admonition {
-    margin-left: -60px;
-    padding-left: 60px;
-}
-
 div.admonition p.admonition-title {
     font-family: {{ header_font }};
     font-weight: normal;
@@ -231,7 +239,7 @@ div.admonition p.admonition-title {
     line-height: 1;
 }
 
-div.admonition p.last {
+div.admonition :last-child {
     margin-bottom: 0;
 }
 
@@ -243,7 +251,7 @@ dt:target, .highlight {
     background: #FAF3E8;
 }
 
-div.note {
+div.note, div.warning {
     background-color: #eee;
     border: 1px solid #ccc;
 }
@@ -257,6 +265,11 @@ div.topic {
     background-color: #eee;
 }
 
+div.topic a {
+    text-decoration: none;
+    border-bottom: none;
+}
+
 p.admonition-title {
     display: inline;
 }
@@ -358,21 +371,10 @@ ul, ol {
 
 pre {
     background: #eee;
-    padding: 7px 30px;
-    margin: 15px -30px;
+    padding: 7px 12px;
     line-height: 1.3em;
 }
 
-dl pre, blockquote pre, li pre {
-    margin-left: -60px;
-    padding-left: 60px;
-}
-
-dl dl pre {
-    margin-left: -90px;
-    padding-left: 90px;
-}
-
 tt {
     background-color: #ecf0f3;
     color: #222;
@@ -393,6 +395,20 @@ a.reference:hover {
     border-bottom: 1px solid {{ link_hover_color }};
 }
 
+li.toctree-l1 a.reference,
+li.toctree-l2 a.reference,
+li.toctree-l3 a.reference,
+li.toctree-l4 a.reference {
+    border-bottom: none;
+}
+
+li.toctree-l1 a.reference:hover,
+li.toctree-l2 a.reference:hover,
+li.toctree-l3 a.reference:hover,
+li.toctree-l4 a.reference:hover {
+    border-bottom: 1px solid {{ link_hover_color }};
+}
+
 a.footnote-reference {
     text-decoration: none;
     font-size: 0.7em;
@@ -408,6 +424,56 @@ a:hover tt {
     background: #EEE;
 }
 
+#reference div.section h2 {
+    /* separate code elements in the reference section */
+    border-top: 2px solid #ccc;
+    padding-top: 0.5em;
+}
+
+#reference div.section h3 {
+    /* separate code elements in the reference section */
+    border-top: 1px solid #ccc;
+    padding-top: 0.5em;
+}
+
+dl.class, dl.function {
+    margin-top: 1em;
+    margin-bottom: 1em;
+}
+
+dl.class > dd {
+    border-left: 3px solid #ccc;
+    margin-left: 0px;
+    padding-left: 30px;
+}
+
+dl.field-list {
+    flex-direction: column;
+}
+
+dl.field-list dd {
+    padding-left: 4em;
+    border-left: 3px solid #ccc;
+    margin-bottom: 0.5em;
+}
+
+dl.field-list dd > ul {
+    list-style: none;
+    padding-left: 0px;
+}
+
+dl.field-list dd > ul > li li :first-child {
+    text-indent: 0;
+}
+
+dl.field-list dd > ul > li :first-child {
+    text-indent: -2em;
+    padding-left: 0px;
+}
+
+dl.field-list dd > p:first-child {
+    text-indent: -2em;
+}
 
 @media screen and (max-width: 870px) {
 

doc/en/adopt.rst

@@ -24,11 +24,9 @@ The ideal pytest helper
  - feels confident in using pytest (e.g. has explored command line options, knows how to write parametrized tests, has an idea about conftest contents)
  - does not need to be an expert in every aspect!
 
-`Pytest helpers, sign up here`_! (preferably in February, hard deadline 22 March)
+Pytest helpers, sign up here! (preferably in February, hard deadline 22 March)
 
 
-.. _`Pytest helpers, sign up here`: http://goo.gl/forms/nxqAhqWt1P
-
 
 The ideal partner project
 -----------------------------------------
@@ -40,11 +38,9 @@ The ideal partner project
  - has the support of the core development team, in trying out pytest adoption
  - has no tests... or 100% test coverage... or somewhere in between!
 
-`Partner projects, sign up here`_! (by 22 March)
+Partner projects, sign up here! (by 22 March)
 
 
-.. _`Partner projects, sign up here`:  http://goo.gl/forms/ZGyqlHiwk3
-
 
 What does it mean to "adopt pytest"?
 -----------------------------------------
@@ -68,11 +64,11 @@ Progressive success might look like:
 It may be after the month is up, the partner project decides that pytest is not right for it. That's okay - hopefully the pytest team will also learn something about its weaknesses or deficiencies.
 
 .. _`nose and unittest`: faq.html#how-does-pytest-relate-to-nose-and-unittest
-.. _assert: asserts.html
+.. _assert: assert.html
 .. _pycmd: https://bitbucket.org/hpk42/pycmd/overview
 .. _`setUp/tearDown methods`: xunit_setup.html
 .. _fixtures: fixture.html
-.. _markers: markers.html
+.. _markers: mark.html
 .. _distributed: xdist.html
 
 

doc/en/announce/index.rst

@@ -6,6 +6,25 @@ Release announcements
    :maxdepth: 2
 
 
+   release-5.3.0
+   release-5.2.4
+   release-5.2.3
+   release-5.2.2
+   release-5.2.1
+   release-5.2.0
+   release-5.1.3
+   release-5.1.2
+   release-5.1.1
+   release-5.1.0
+   release-5.0.1
+   release-5.0.0
+   release-4.6.5
+   release-4.6.4
+   release-4.6.3
+   release-4.6.2
+   release-4.6.1
+   release-4.6.0
+   release-4.5.0
    release-4.4.2
    release-4.4.1
    release-4.4.0

doc/en/announce/release-2.1.0.rst

@@ -12,7 +12,7 @@ courtesy of Benjamin Peterson.  You can now safely use ``assert``
 statements in test modules without having to worry about side effects
 or python optimization ("-OO") options.  This is achieved by rewriting
 assert statements in test modules upon import, using a PEP302 hook.
-See http://pytest.org/assert.html#advanced-assertion-introspection for
+See https://docs.pytest.org/en/latest/assert.html for
 detailed information.  The work has been partly sponsored by my company,
 merlinux GmbH.
 

doc/en/announce/release-2.9.0.rst

@@ -75,7 +75,7 @@ The py.test Development Team
 
 **Changes**
 
-* **Important**: `py.code <https://pylib.readthedocs.io/en/latest/code.html>`_ has been
+* **Important**: `py.code <https://pylib.readthedocs.io/en/stable/code.html>`_ has been
   merged into the ``pytest`` repository as ``pytest._code``. This decision
   was made because ``py.code`` had very few uses outside ``pytest`` and the
   fact that it was in a different repository made it difficult to fix bugs on
@@ -88,7 +88,7 @@ The py.test Development Team
   **experimental**, so you definitely should not import it explicitly!
 
   Please note that the original ``py.code`` is still available in
-  `pylib <https://pylib.readthedocs.io>`_.
+  `pylib <https://pylib.readthedocs.io/en/stable/>`_.
 
 * ``pytest_enter_pdb`` now optionally receives the pytest config object.
   Thanks `@nicoddemus`_ for the PR.

doc/en/announce/release-2.9.2.rst

@@ -66,8 +66,8 @@ The py.test Development Team
 
 .. _#510: https://github.com/pytest-dev/pytest/issues/510
 .. _#1506: https://github.com/pytest-dev/pytest/pull/1506
-.. _#1496: https://github.com/pytest-dev/pytest/issue/1496
-.. _#1524: https://github.com/pytest-dev/pytest/issue/1524
+.. _#1496: https://github.com/pytest-dev/pytest/issues/1496
+.. _#1524: https://github.com/pytest-dev/pytest/pull/1524
 
 .. _@astraw38: https://github.com/astraw38
 .. _@hackebrot: https://github.com/hackebrot

doc/en/announce/release-3.8.2.rst

@@ -20,7 +20,7 @@ Thanks to all who contributed to this release, among them:
 * Jeffrey Rackauckas
 * Jose Carlos Menezes
 * Ronny Pfannschmidt
-* Zac-HD
+* Zac Hatfield-Dodds
 * iwanb
 
 

doc/en/announce/release-4.3.1.rst

@@ -21,7 +21,6 @@ Thanks to all who contributed to this release, among them:
 * Kyle Altendorf
 * Stephan Hoyer
 * Zac Hatfield-Dodds
-* Zac-HD
 * songbowen
 
 

doc/en/announce/release-4.5.0.rst

@@ -0,0 +1,34 @@
+pytest-4.5.0
+=======================================
+
+The pytest team is proud to announce the 4.5.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:
+
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* Floris Bruynooghe
+* Pulkit Goyal
+* Samuel Searles-Bryant
+* Zac Hatfield-Dodds
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-4.6.0.rst

@@ -0,0 +1,43 @@
+pytest-4.6.0
+=======================================
+
+The pytest team is proud to announce the 4.6.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:
+
+* Akiomi Kamakura
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* David Röthlisberger
+* Evan Kepner
+* Jeffrey Rackauckas
+* MyComputer
+* Nikita Krokosh
+* Raul Tambre
+* Thomas Hisch
+* Tim Hoffmann
+* Tomer Keren
+* Victor Maryama
+* danielx123
+* oleg-yegorov
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-4.6.1.rst

@@ -0,0 +1,19 @@
+pytest-4.6.1
+=======================================
+
+pytest 4.6.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
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.6.2.rst

@@ -0,0 +1,18 @@
+pytest-4.6.2
+=======================================
+
+pytest 4.6.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
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.6.3.rst

@@ -0,0 +1,21 @@
+pytest-4.6.3
+=======================================
+
+pytest 4.6.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:
+
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* Dirk Thomas
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.6.4.rst

@@ -0,0 +1,22 @@
+pytest-4.6.4
+=======================================
+
+pytest 4.6.4 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
+* Thomas Grainger
+* Zac Hatfield-Dodds
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.6.5.rst

@@ -0,0 +1,21 @@
+pytest-4.6.5
+=======================================
+
+pytest 4.6.5 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
+* Thomas Grainger
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-5.0.0.rst

@@ -0,0 +1,46 @@
+pytest-5.0.0
+=======================================
+
+The pytest team is proud to announce the 5.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:
+
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* Dirk Thomas
+* Evan Kepner
+* Florian Bruhin
+* Hugo
+* Kevin J. Foley
+* Pulkit Goyal
+* Ralph Giles
+* Ronny Pfannschmidt
+* Thomas Grainger
+* Thomas Hisch
+* Tim Gates
+* Victor Maryama
+* Yuri Apollov
+* Zac Hatfield-Dodds
+* curiousjazz77
+* patriksevallius
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-5.0.1.rst

@@ -0,0 +1,25 @@
+pytest-5.0.1
+=======================================
+
+pytest 5.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:
+
+* AmirElkess
+* Andreu Vallbona Plazas
+* Anthony Sottile
+* Bruno Oliveira
+* Florian Bruhin
+* Michael Moore
+* Niklas Meinzer
+* Thomas Grainger
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-5.1.0.rst

@@ -0,0 +1,56 @@
+pytest-5.1.0
+=======================================
+
+The pytest team is proud to announce the 5.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:
+
+* Albert Tugushev
+* Alexey Zankevich
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* David Röthlisberger
+* Florian Bruhin
+* Ilya Stepin
+* Jon Dufresne
+* Kaiqi
+* Max R
+* Miro Hrončok
+* Oliver Bestwalter
+* Ran Benita
+* Ronny Pfannschmidt
+* Samuel Searles-Bryant
+* Semen Zhydenko
+* Steffen Schroeder
+* Thomas Grainger
+* Tim Hoffmann
+* William Woodall
+* Wojtek Erbetowski
+* Xixi Zhao
+* Yash Todi
+* boris
+* dmitry.dygalo
+* helloocc
+* martbln
+* mei-li
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-5.1.1.rst

@@ -0,0 +1,24 @@
+pytest-5.1.1
+=======================================
+
+pytest 5.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
+* Bruno Oliveira
+* Daniel Hahler
+* Florian Bruhin
+* Hugo van Kemenade
+* Ran Benita
+* Ronny Pfannschmidt
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-5.1.2.rst

@@ -0,0 +1,23 @@
+pytest-5.1.2
+=======================================
+
+pytest 5.1.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:
+
+* Andrzej Klajnert
+* Anthony Sottile
+* Bruno Oliveira
+* Christian Neumüller
+* Robert Holt
+* linchiwei123
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-5.1.3.rst

@@ -0,0 +1,23 @@
+pytest-5.1.3
+=======================================
+
+pytest 5.1.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:
+
+* Anthony Sottile
+* Bruno Oliveira
+* Christian Neumüller
+* Daniel Hahler
+* Gene Wood
+* Hugo
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-5.2.0.rst

@@ -0,0 +1,35 @@
+pytest-5.2.0
+=======================================
+
+The pytest team is proud to announce the 5.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:
+
+* Andrzej Klajnert
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* James Cooke
+* Michael Goerz
+* Ran Benita
+* Tomáš Chvátal
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-5.2.1.rst

@@ -0,0 +1,23 @@
+pytest-5.2.1
+=======================================
+
+pytest 5.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
+* Bruno Oliveira
+* Florian Bruhin
+* Hynek Schlawack
+* Kevin J. Foley
+* tadashigaki
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-5.2.2.rst

@@ -0,0 +1,29 @@
+pytest-5.2.2
+=======================================
+
+pytest 5.2.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:
+
+* Albert Tugushev
+* Andrzej Klajnert
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* Florian Bruhin
+* Nattaphoom Chaipreecha
+* Oliver Bestwalter
+* Philipp Loose
+* Ran Benita
+* Victor Maryama
+* Yoav Caspi
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-5.2.3.rst

@@ -0,0 +1,28 @@
+pytest-5.2.3
+=======================================
+
+pytest 5.2.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:
+
+* Anthony Sottile
+* Brett Cannon
+* Bruno Oliveira
+* Daniel Hahler
+* Daniil Galiev
+* David Szotten
+* Florian Bruhin
+* Patrick Harmon
+* Ran Benita
+* Zac Hatfield-Dodds
+* Zak Hassan
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-5.2.4.rst

@@ -0,0 +1,22 @@
+pytest-5.2.4
+=======================================
+
+pytest 5.2.4 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
+* Hugo
+* Michael Shields
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-5.3.0.rst

@@ -0,0 +1,45 @@
+pytest-5.3.0
+=======================================
+
+The pytest team is proud to announce the 5.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:
+
+* AnjoMan
+* Anthony Sottile
+* Anton Lodder
+* Bruno Oliveira
+* Daniel Hahler
+* Gregory Lee
+* Josh Karpel
+* JoshKarpel
+* Joshua Storck
+* Kale Kundert
+* MarcoGorelli
+* Michael Krebs
+* NNRepos
+* Ran Benita
+* TH3CHARLie
+* Tibor Arpas
+* Zac Hatfield-Dodds
+* 林玮
+
+
+Happy testing,
+The Pytest Development Team

doc/en/assert.rst

@@ -31,7 +31,7 @@ you will see the return value of the function call:
 
     $ pytest test_assert1.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 1 item
@@ -47,7 +47,7 @@ you will see the return value of the function call:
     E        +  where 3 = f()
 
     test_assert1.py:6: AssertionError
-    ========================= 1 failed in 0.12 seconds =========================
+    ============================ 1 failed in 0.12s =============================
 
 ``pytest`` has support for showing the values of the most common subexpressions
 including calls, attributes, comparisons, and binary and unary
@@ -186,7 +186,7 @@ if you run this module:
 
     $ pytest test_assert2.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 1 item
@@ -208,7 +208,7 @@ if you run this module:
     E         Use -v to get the full diff
 
     test_assert2.py:6: AssertionError
-    ========================= 1 failed in 0.12 seconds =========================
+    ============================ 1 failed in 0.12s =============================
 
 Special comparisons are done for a number of cases:
 
@@ -238,14 +238,17 @@ file which provides an alternative explanation for ``Foo`` objects:
 
    def pytest_assertrepr_compare(op, left, right):
        if isinstance(left, Foo) and isinstance(right, Foo) and op == "==":
-           return ["Comparing Foo instances:", "   vals: %s != %s" % (left.val, right.val)]
+           return [
+               "Comparing Foo instances:",
+               "   vals: {} != {}".format(left.val, right.val),
+           ]
 
 now, given this test module:
 
 .. code-block:: python
 
    # content of test_foocompare.py
-   class Foo(object):
+   class Foo:
        def __init__(self, val):
            self.val = val
 
@@ -276,7 +279,7 @@ the conftest file:
    E            vals: 1 != 2
 
    test_foocompare.py:12: AssertionError
-   1 failed in 0.12 seconds
+   1 failed in 0.12s
 
 .. _assert-details:
 .. _`assert introspection`:

doc/en/builtin.rst

@@ -27,33 +27,39 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
         name of your plugin or application to avoid clashes with other cache users.
 
         Values can be any object handled by the json stdlib module.
+
     capsys
         Enable text capturing of writes to ``sys.stdout`` and ``sys.stderr``.
 
         The captured output is made available via ``capsys.readouterr()`` method
         calls, which return a ``(out, err)`` namedtuple.
         ``out`` and ``err`` will be ``text`` objects.
+
     capsysbinary
         Enable bytes capturing of writes to ``sys.stdout`` and ``sys.stderr``.
 
         The captured output is made available via ``capsysbinary.readouterr()``
         method calls, which return a ``(out, err)`` namedtuple.
         ``out`` and ``err`` will be ``bytes`` objects.
+
     capfd
         Enable text capturing of writes to file descriptors ``1`` and ``2``.
 
         The captured output is made available via ``capfd.readouterr()`` method
         calls, which return a ``(out, err)`` namedtuple.
         ``out`` and ``err`` will be ``text`` objects.
+
     capfdbinary
         Enable bytes capturing of writes to file descriptors ``1`` and ``2``.
 
         The captured output is made available via ``capfd.readouterr()`` method
         calls, which return a ``(out, err)`` namedtuple.
         ``out`` and ``err`` will be ``byte`` objects.
-    doctest_namespace
+
+    doctest_namespace [session scope]
         Fixture that returns a :py:class:`dict` that will be injected into the namespace of doctests.
-    pytestconfig
+
+    pytestconfig [session scope]
         Session-scoped fixture that returns the :class:`_pytest.config.Config` object.
 
         Example::
@@ -61,6 +67,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
             def test_foo(pytestconfig):
                 if pytestconfig.getoption("verbose") > 0:
                     ...
+
     record_property
         Add an extra properties the calling test.
         User properties become part of the test report and are available to the
@@ -72,19 +79,37 @@ 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_attribute
         Add extra xml attributes to the tag for the calling test.
         The fixture is callable with ``(name, value)``, with value being
         automatically xml-encoded
+
+    record_testsuite_property [session scope]
+        Records a new ``<property>`` tag as child of the root ``<testsuite>``. This is suitable to
+        writing global information regarding the entire test suite, and is compatible with ``xunit2`` JUnit family.
+
+        This is a ``session``-scoped fixture which is called with ``(name, value)``. Example:
+
+        .. code-block:: python
+
+            def test_foo(record_testsuite_property):
+                record_testsuite_property("ARCH", "PPC")
+                record_testsuite_property("STORAGE_TYPE", "CEPH")
+
+        ``name`` must be a string, ``value`` will be converted to a string and properly xml-escaped.
+
     caplog
         Access and control log capturing.
 
         Captured logs are available through the following properties/methods::
 
+        * caplog.messages        -> list of format-interpolated log messages
         * caplog.text            -> string containing formatted log output
         * caplog.records         -> list of logging.LogRecord instances
         * caplog.record_tuples   -> list of (logger_name, level, message) tuples
         * caplog.clear()         -> clear captured records and formatted log output string
+
     monkeypatch
         The returned ``monkeypatch`` fixture provides these
         helper methods to modify objects, dictionaries or os.environ::
@@ -102,15 +127,19 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
         test function or fixture has finished. The ``raising``
         parameter determines if a KeyError or AttributeError
         will be raised if the set/deletion operation has no target.
+
     recwarn
         Return a :class:`WarningsRecorder` instance that records all warnings emitted by test functions.
 
         See http://docs.python.org/library/warnings.html for information
         on warning categories.
-    tmpdir_factory
+
+    tmpdir_factory [session scope]
         Return a :class:`_pytest.tmpdir.TempdirFactory` instance for the test session.
-    tmp_path_factory
+
+    tmp_path_factory [session scope]
         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,
@@ -119,6 +148,7 @@ 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,
@@ -130,9 +160,13 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
 
             in python < 3.6 this is a pathlib2.Path
 
-    no tests ran in 0.12 seconds
 
-You can also interactively ask for help, e.g. by typing on the Python interactive prompt something like::
+    no tests ran in 0.12s
+
+You can also interactively ask for help, e.g. by typing on the Python interactive prompt something like:
+
+.. code-block:: python
 
     import pytest
+
     help(pytest)

doc/en/cache.rst

@@ -33,15 +33,18 @@ Other plugins may access the `config.cache`_ object to set/get
 Rerunning only failures or failures first
 -----------------------------------------------
 
-First, let's create 50 test invocation of which only 2 fail::
+First, let's create 50 test invocation of which only 2 fail:
+
+.. code-block:: python
 
     # content of test_50.py
     import pytest
 
+
     @pytest.mark.parametrize("i", range(50))
     def test_num(i):
         if i in (17, 25):
-           pytest.fail("bad luck")
+            pytest.fail("bad luck")
 
 If you run this for the first time you will see two failures:
 
@@ -57,10 +60,10 @@ If you run this for the first time you will see two failures:
         @pytest.mark.parametrize("i", range(50))
         def test_num(i):
             if i in (17, 25):
-    >          pytest.fail("bad luck")
-    E          Failed: bad luck
+    >           pytest.fail("bad luck")
+    E           Failed: bad luck
 
-    test_50.py:6: Failed
+    test_50.py:7: Failed
     _______________________________ test_num[25] _______________________________
 
     i = 25
@@ -68,11 +71,11 @@ If you run this for the first time you will see two failures:
         @pytest.mark.parametrize("i", range(50))
         def test_num(i):
             if i in (17, 25):
-    >          pytest.fail("bad luck")
-    E          Failed: bad luck
+    >           pytest.fail("bad luck")
+    E           Failed: bad luck
 
-    test_50.py:6: Failed
-    2 failed, 48 passed in 0.12 seconds
+    test_50.py:7: Failed
+    2 failed, 48 passed in 0.12s
 
 If you then run it with ``--lf``:
 
@@ -80,7 +83,7 @@ If you then run it with ``--lf``:
 
     $ pytest --lf
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 50 items / 48 deselected / 2 selected
@@ -96,10 +99,10 @@ If you then run it with ``--lf``:
         @pytest.mark.parametrize("i", range(50))
         def test_num(i):
             if i in (17, 25):
-    >          pytest.fail("bad luck")
-    E          Failed: bad luck
+    >           pytest.fail("bad luck")
+    E           Failed: bad luck
 
-    test_50.py:6: Failed
+    test_50.py:7: Failed
     _______________________________ test_num[25] _______________________________
 
     i = 25
@@ -107,14 +110,14 @@ If you then run it with ``--lf``:
         @pytest.mark.parametrize("i", range(50))
         def test_num(i):
             if i in (17, 25):
-    >          pytest.fail("bad luck")
-    E          Failed: bad luck
+    >           pytest.fail("bad luck")
+    E           Failed: bad luck
 
-    test_50.py:6: Failed
-    ================= 2 failed, 48 deselected in 0.12 seconds ==================
+    test_50.py:7: Failed
+    ===================== 2 failed, 48 deselected in 0.12s =====================
 
-You have run only the two failing test from the last run, while 48 tests have
-not been run ("deselected").
+You have run only the two failing tests from the last run, while the 48 passing
+tests have 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
@@ -124,7 +127,7 @@ of ``FF`` and dots):
 
     $ pytest --ff
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 50 items
@@ -140,10 +143,10 @@ of ``FF`` and dots):
         @pytest.mark.parametrize("i", range(50))
         def test_num(i):
             if i in (17, 25):
-    >          pytest.fail("bad luck")
-    E          Failed: bad luck
+    >           pytest.fail("bad luck")
+    E           Failed: bad luck
 
-    test_50.py:6: Failed
+    test_50.py:7: Failed
     _______________________________ test_num[25] _______________________________
 
     i = 25
@@ -151,11 +154,11 @@ of ``FF`` and dots):
         @pytest.mark.parametrize("i", range(50))
         def test_num(i):
             if i in (17, 25):
-    >          pytest.fail("bad luck")
-    E          Failed: bad luck
+    >           pytest.fail("bad luck")
+    E           Failed: bad luck
 
-    test_50.py:6: Failed
-    =================== 2 failed, 48 passed in 0.12 seconds ====================
+    test_50.py:7: Failed
+    ======================= 2 failed, 48 passed in 0.12s =======================
 
 .. _`config.cache`:
 
@@ -183,15 +186,19 @@ The new config.cache object
 Plugins or conftest.py support code can get a cached value using the
 pytest ``config`` object.  Here is a basic example plugin which
 implements a :ref:`fixture` which re-uses previously created state
-across pytest invocations::
+across pytest invocations:
+
+.. code-block:: python
 
     # content of test_caching.py
     import pytest
     import time
 
+
     def expensive_computation():
         print("running expensive computation...")
 
+
     @pytest.fixture
     def mydata(request):
         val = request.config.cache.get("example/value", None)
@@ -201,6 +208,7 @@ across pytest invocations::
             request.config.cache.set("example/value", val)
         return val
 
+
     def test_function(mydata):
         assert mydata == 23
 
@@ -219,12 +227,12 @@ If you run this command for the first time, you can see the print statement:
     >       assert mydata == 23
     E       assert 42 == 23
 
-    test_caching.py:17: AssertionError
+    test_caching.py:20: AssertionError
     -------------------------- Captured stdout setup ---------------------------
     running expensive computation...
-    1 failed in 0.12 seconds
+    1 failed in 0.12s
 
-If you run it a second time the value will be retrieved from
+If you run it a second time, the value will be retrieved from
 the cache and nothing will be printed:
 
 .. code-block:: pytest
@@ -240,14 +248,14 @@ the cache and nothing will be printed:
     >       assert mydata == 23
     E       assert 42 == 23
 
-    test_caching.py:17: AssertionError
-    1 failed in 0.12 seconds
+    test_caching.py:20: AssertionError
+    1 failed in 0.12s
 
 See the :ref:`cache-api` for more details.
 
 
 Inspecting Cache content
--------------------------------
+------------------------
 
 You can always peek at the content of the cache using the
 ``--cache-show`` command line option:
@@ -256,11 +264,11 @@ You can always peek at the content of the cache using the
 
     $ pytest --cache-show
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     cachedir: $PYTHON_PREFIX/.pytest_cache
-    ------------------------------- cache values -------------------------------
+    --------------------------- cache values for '*' ---------------------------
     cache/lastfailed contains:
       {'test_50.py::test_num[17]': True,
        'test_50.py::test_num[25]': True,
@@ -269,16 +277,86 @@ You can always peek at the content of the cache using the
        'test_caching.py::test_function': True,
        'test_foocompare.py::test_compare': True}
     cache/nodeids contains:
-      ['test_caching.py::test_function']
+      ['test_assert1.py::test_function',
+       'test_assert2.py::test_set_comparison',
+       'test_foocompare.py::test_compare',
+       'test_50.py::test_num[0]',
+       'test_50.py::test_num[1]',
+       'test_50.py::test_num[2]',
+       'test_50.py::test_num[3]',
+       'test_50.py::test_num[4]',
+       'test_50.py::test_num[5]',
+       'test_50.py::test_num[6]',
+       'test_50.py::test_num[7]',
+       'test_50.py::test_num[8]',
+       'test_50.py::test_num[9]',
+       'test_50.py::test_num[10]',
+       'test_50.py::test_num[11]',
+       'test_50.py::test_num[12]',
+       'test_50.py::test_num[13]',
+       'test_50.py::test_num[14]',
+       'test_50.py::test_num[15]',
+       'test_50.py::test_num[16]',
+       'test_50.py::test_num[17]',
+       'test_50.py::test_num[18]',
+       'test_50.py::test_num[19]',
+       'test_50.py::test_num[20]',
+       'test_50.py::test_num[21]',
+       'test_50.py::test_num[22]',
+       'test_50.py::test_num[23]',
+       'test_50.py::test_num[24]',
+       'test_50.py::test_num[25]',
+       'test_50.py::test_num[26]',
+       'test_50.py::test_num[27]',
+       'test_50.py::test_num[28]',
+       'test_50.py::test_num[29]',
+       'test_50.py::test_num[30]',
+       'test_50.py::test_num[31]',
+       'test_50.py::test_num[32]',
+       'test_50.py::test_num[33]',
+       'test_50.py::test_num[34]',
+       'test_50.py::test_num[35]',
+       'test_50.py::test_num[36]',
+       'test_50.py::test_num[37]',
+       'test_50.py::test_num[38]',
+       'test_50.py::test_num[39]',
+       'test_50.py::test_num[40]',
+       'test_50.py::test_num[41]',
+       'test_50.py::test_num[42]',
+       'test_50.py::test_num[43]',
+       'test_50.py::test_num[44]',
+       'test_50.py::test_num[45]',
+       'test_50.py::test_num[46]',
+       'test_50.py::test_num[47]',
+       'test_50.py::test_num[48]',
+       'test_50.py::test_num[49]',
+       'test_caching.py::test_function']
     cache/stepwise contains:
       []
     example/value contains:
       42
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
+
+``--cache-show`` takes an optional argument to specify a glob pattern for
+filtering:
+
+.. code-block:: pytest
+
+    $ pytest --cache-show example/*
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    ----------------------- cache values for 'example/*' -----------------------
+    example/value contains:
+      42
+
+    ========================== no tests ran in 0.12s ===========================
 
 Clearing Cache content
--------------------------------
+----------------------
 
 You can instruct pytest to clear all cache files and values
 by adding the ``--cache-clear`` option like this:

doc/en/capture.rst

@@ -49,16 +49,21 @@ Using print statements for debugging
 ---------------------------------------------------
 
 One primary benefit of the default capturing of stdout/stderr output
-is that you can use print statements for debugging::
+is that you can use print statements for debugging:
+
+.. code-block:: python
 
     # content of test_module.py
 
+
     def setup_function(function):
-        print("setting up %s" % function)
+        print("setting up", function)
+
 
     def test_func1():
         assert True
 
+
     def test_func2():
         assert False
 
@@ -69,7 +74,7 @@ of the failing function and hide the other one:
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 2 items
@@ -83,10 +88,10 @@ of the failing function and hide the other one:
     >       assert False
     E       assert False
 
-    test_module.py:9: AssertionError
+    test_module.py:12: AssertionError
     -------------------------- Captured stdout setup ---------------------------
     setting up <function test_func2 at 0xdeadbeef>
-    ==================== 1 failed, 1 passed in 0.12 seconds ====================
+    ======================= 1 failed, 1 passed in 0.12s ========================
 
 Accessing captured output from a test function
 ---------------------------------------------------

doc/en/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # pytest documentation build configuration file, created by
 # sphinx-quickstart on Fri Oct  8 17:54:28 2010.
@@ -16,7 +15,6 @@
 #
 # The full version, including alpha/beta/rc tags.
 # The short X.Y version.
-import datetime
 import os
 import sys
 
@@ -63,9 +61,8 @@ source_suffix = ".rst"
 master_doc = "contents"
 
 # General information about the project.
-project = u"pytest"
-year = datetime.datetime.utcnow().year
-copyright = u"2015–2019 , holger krekel and pytest-dev team"
+project = "pytest"
+copyright = "2015–2019, holger krekel and pytest-dev team"
 
 
 # The language for content autogenerated by Sphinx. Refer to documentation
@@ -168,18 +165,18 @@ html_favicon = "img/pytest1favi.ico"
 
 html_sidebars = {
     "index": [
+        "slim_searchbox.html",
         "sidebarintro.html",
         "globaltoc.html",
         "links.html",
         "sourcelink.html",
-        "searchbox.html",
     ],
     "**": [
+        "slim_searchbox.html",
         "globaltoc.html",
         "relations.html",
         "links.html",
         "sourcelink.html",
-        "searchbox.html",
     ],
 }
 
@@ -233,8 +230,8 @@ latex_documents = [
     (
         "contents",
         "pytest.tex",
-        u"pytest Documentation",
-        u"holger krekel, trainer and consultant, http://merlinux.eu",
+        "pytest Documentation",
+        "holger krekel, trainer and consultant, http://merlinux.eu",
         "manual",
     )
 ]
@@ -266,16 +263,16 @@ latex_domain_indices = False
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [("usage", "pytest", u"pytest usage", [u"holger krekel at merlinux eu"], 1)]
+man_pages = [("usage", "pytest", "pytest usage", ["holger krekel at merlinux eu"], 1)]
 
 
 # -- Options for Epub output ---------------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = u"pytest"
-epub_author = u"holger krekel at merlinux eu"
-epub_publisher = u"holger krekel at merlinux eu"
-epub_copyright = u"2013, holger krekel et alii"
+epub_title = "pytest"
+epub_author = "holger krekel at merlinux eu"
+epub_publisher = "holger krekel at merlinux eu"
+epub_copyright = "2013, holger krekel et alii"
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.

doc/en/contents.rst

@@ -38,18 +38,24 @@ Full pytest documentation
    customize
    example/index
    bash-completion
+   faq
 
    backwards-compatibility
    deprecations
    py27-py34-deprecation
-   historical-notes
-   license
+
    contributing
    development_guide
+
+   sponsor
+   tidelift
+   license
+   contact
+
+   historical-notes
    talks
    projects
-   faq
-   contact
+
 
 .. only:: html
 

doc/en/customize.rst

@@ -107,8 +107,8 @@ check for ini-files as follows:
 
     # first look for pytest.ini files
     path/pytest.ini
-    path/setup.cfg  # must also contain [tool:pytest] section to match
     path/tox.ini    # must also contain [pytest] section to match
+    path/setup.cfg  # must also contain [tool:pytest] section to match
     pytest.ini
     ... # all the way down to the root
 
@@ -134,10 +134,13 @@ progress output, you can write it into a configuration file:
 .. code-block:: ini
 
     # content of pytest.ini or tox.ini
-    # setup.cfg files should use [tool:pytest] section instead
     [pytest]
     addopts = -ra -q
 
+    # content of setup.cfg
+    [tool:pytest]
+    addopts = -ra -q
+
 Alternatively, you can set a ``PYTEST_ADDOPTS`` environment variable to add command
 line options while the environment is in use:
 

doc/en/deprecations.rst

@@ -19,12 +19,83 @@ Below is a complete list of all pytest features which are considered deprecated.
 :class:`_pytest.warning_types.PytestWarning` or subclasses, which can be filtered using
 :ref:`standard warning filters <warnings>`.
 
+``junit_family`` default value change to "xunit2"
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. deprecated:: 5.2
+
+The default value of ``junit_family`` option will change to ``xunit2`` in pytest 6.0, given
+that this is the version supported by default in modern tools that manipulate this type of file.
+
+In order to smooth the transition, pytest will issue a warning in case the ``--junitxml`` option
+is given in the command line but ``junit_family`` is not explicitly configured in ``pytest.ini``::
+
+    PytestDeprecationWarning: The 'junit_family' default value will change to 'xunit2' in pytest 6.0.
+      Add 'junit_family=legacy' to your pytest.ini file to silence this warning and make your suite compatible.
+
+In order to silence this warning, users just need to configure the ``junit_family`` option explicitly:
+
+.. code-block:: ini
+
+    [pytest]
+    junit_family=legacy
+
+
+``funcargnames`` alias for ``fixturenames``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. deprecated:: 5.0
+
+The ``FixtureRequest``, ``Metafunc``, and ``Function`` classes track the names of
+their associated fixtures, with the aptly-named ``fixturenames`` attribute.
+
+Prior to pytest 2.3, this attribute was named ``funcargnames``, and we have kept
+that as an alias since.  It is finally due for removal, as it is often confusing
+in places where we or plugin authors must distinguish between fixture names and
+names supplied by non-fixture things such as ``pytest.mark.parametrize``.
+
+
+Result log (``--result-log``)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. deprecated:: 4.0
+
+The ``--result-log`` option produces a stream of test reports which can be
+analysed at runtime, but it uses a custom format which requires users to implement their own
+parser.
+
+The  `pytest-reportlog <https://github.com/pytest-dev/pytest-reportlog>`__ plugin provides a ``--report-log`` option, a more standard and extensible alternative, producing
+one JSON object per-line, and should cover the same use cases. Please try it out and provide feedback.
+
+The plan is remove the ``--result-log`` option in pytest 6.0 if ``pytest-reportlog`` proves satisfactory
+to all users and is deemed stable. The ``pytest-reportlog`` plugin might even be merged into the core
+at some point, depending on the plans for the plugins and number of users using it.
+
+
+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.
+
+
+``pytest.config`` global
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 5.0
+
+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. Note that many hooks can also access
+the ``config`` object indirectly, through ``session.config`` or ``item.config`` for example.
+
+
 .. _`raises message deprecated`:
 
 ``"message"`` parameter of ``pytest.raises``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. deprecated:: 4.1
+.. versionremoved:: 5.0
 
 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
@@ -55,22 +126,12 @@ If you still have concerns about this deprecation and future removal, please com
 `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. Note that many hooks can also access
-the ``config`` object indirectly, through ``session.config`` or ``item.config`` for example.
-
 .. _raises-warns-exec:
 
 ``raises`` / ``warns`` with a string as the second argument
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. deprecated:: 4.1
+.. versionremoved:: 5.0
 
 Use the context manager form of these instead.  When necessary, invoke ``exec``
 directly.
@@ -102,26 +163,6 @@ Becomes:
 
 
 
-
-
-Result log (``--result-log``)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-
-
-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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -439,7 +480,9 @@ Internal classes accessed through ``Node``
 .. versionremoved:: 4.0
 
 Access of ``Module``, ``Function``, ``Class``, ``Instance``, ``File`` and ``Item`` through ``Node`` instances now issue
-this warning::
+this warning:
+
+.. code-block:: text
 
     usage of Function.Module is deprecated, please use pytest.Module instead
 

doc/en/doctest.rst

@@ -29,14 +29,14 @@ then you can just invoke ``pytest`` directly:
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_example.txt .                                                   [100%]
 
-    ========================= 1 passed in 0.12 seconds =========================
+    ============================ 1 passed in 0.12s =============================
 
 By default, pytest will collect ``test*.txt`` files looking for doctest directives, but you
 can pass additional globs using the ``--doctest-glob`` option (multi-allowed).
@@ -58,7 +58,7 @@ and functions, including from test modules:
 
     $ pytest --doctest-modules
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 2 items
@@ -66,7 +66,7 @@ and functions, including from test modules:
     mymodule.py .                                                        [ 50%]
     test_example.txt .                                                   [100%]
 
-    ========================= 2 passed in 0.12 seconds =========================
+    ============================ 2 passed in 0.12s =============================
 
 You can make these changes permanent in your project by
 putting them into a pytest.ini file like this:
@@ -103,7 +103,7 @@ that will be used for those doctest files using the
 Using 'doctest' options
 -----------------------
 
-The standard ``doctest`` module provides some `options <https://docs.python.org/3/library/doctest.html#option-flags>`__
+Python's standard ``doctest`` module provides some `options <https://docs.python.org/3/library/doctest.html#option-flags>`__
 to configure the strictness of doctest tests. In pytest, you can enable those flags using the
 configuration file.
 
@@ -115,23 +115,52 @@ lengthy exception stack traces you can just write:
     [pytest]
     doctest_optionflags= NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL
 
-pytest also introduces new options to allow doctests to run in Python 2 and
-Python 3 unchanged:
-
-* ``ALLOW_UNICODE``: when enabled, the ``u`` prefix is stripped from unicode
-  strings in expected doctest output.
-
-* ``ALLOW_BYTES``: when enabled, the ``b`` prefix is stripped from byte strings
-  in expected doctest output.
-
 Alternatively, options can be enabled by an inline comment in the doc test
 itself:
 
 .. code-block:: rst
 
-    # content of example.rst
-    >>> get_unicode_greeting()  # doctest: +ALLOW_UNICODE
-    'Hello'
+    >>> something_that_raises()  # doctest: +IGNORE_EXCEPTION_DETAIL
+    Traceback (most recent call last):
+    ValueError: ...
+
+pytest also introduces new options:
+
+* ``ALLOW_UNICODE``: when enabled, the ``u`` prefix is stripped from unicode
+  strings in expected doctest output. This allows doctests to run in Python 2
+  and Python 3 unchanged.
+
+* ``ALLOW_BYTES``: similarly, the ``b`` prefix is stripped from byte strings
+  in expected doctest output.
+
+* ``NUMBER``: when enabled, floating-point numbers only need to match as far as
+  the precision you have written in the expected doctest output. For example,
+  the following output would only need to match to 2 decimal places::
+
+      >>> math.pi
+      3.14
+
+  If you wrote ``3.1416`` then the actual output would need to match to 4
+  decimal places; and so on.
+
+  This avoids false positives caused by limited floating-point precision, like
+  this::
+
+      Expected:
+          0.233
+      Got:
+          0.23300000000000001
+
+  ``NUMBER`` also supports lists of floating-point numbers -- in fact, it
+  matches floating-point numbers appearing anywhere in the output, even inside
+  a string! This means that it may not be appropriate to enable globally in
+  ``doctest_optionflags`` in your configuration file.
+
+  .. versionadded:: 5.1
+
+
+Continue on failure
+-------------------
 
 By default, pytest would report only the first failure for a given doctest. If
 you want to continue the test even when you have failures, do:
@@ -191,15 +220,21 @@ namespace in which your doctests run. It is intended to be used within
 your own fixtures to provide the tests that use them with context.
 
 ``doctest_namespace`` is a standard ``dict`` object into which you
-place the objects you want to appear in the doctest namespace::
+place the objects you want to appear in the doctest namespace:
+
+.. code-block:: python
 
     # content of conftest.py
     import numpy
+
+
     @pytest.fixture(autouse=True)
     def add_np(doctest_namespace):
-        doctest_namespace['np'] = numpy
+        doctest_namespace["np"] = numpy
 
-which can then be used in your doctests directly::
+which can then be used in your doctests directly:
+
+.. code-block:: python
 
     # content of numpy.py
     def arange():
@@ -219,7 +254,9 @@ Skipping tests dynamically
 
 .. versionadded:: 4.4
 
-You can use ``pytest.skip`` to dynamically skip doctests. For example::
+You can use ``pytest.skip`` to dynamically skip doctests. For example:
+
+.. code-block:: text
 
     >>> import sys, pytest
     >>> if sys.platform.startswith('win'):

doc/en/example/assertion/failure_demo.py

@@ -20,7 +20,7 @@ def test_generative(param1, param2):
     assert param1 * 2 < param2
 
 
-class TestFailing(object):
+class TestFailing:
     def test_simple(self):
         def f():
             return 42
@@ -40,7 +40,7 @@ class TestFailing(object):
         assert not f()
 
 
-class TestSpecialisedExplanations(object):
+class TestSpecialisedExplanations:
     def test_eq_text(self):
         assert "spam" == "eggs"
 
@@ -100,7 +100,7 @@ class TestSpecialisedExplanations(object):
         from dataclasses import dataclass
 
         @dataclass
-        class Foo(object):
+        class Foo:
             a: int
             b: str
 
@@ -112,7 +112,7 @@ class TestSpecialisedExplanations(object):
         import attr
 
         @attr.s
-        class Foo(object):
+        class Foo:
             a = attr.ib()
             b = attr.ib()
 
@@ -122,7 +122,7 @@ class TestSpecialisedExplanations(object):
 
 
 def test_attribute():
-    class Foo(object):
+    class Foo:
         b = 1
 
     i = Foo()
@@ -130,14 +130,14 @@ def test_attribute():
 
 
 def test_attribute_instance():
-    class Foo(object):
+    class Foo:
         b = 1
 
     assert Foo().b == 2
 
 
 def test_attribute_failure():
-    class Foo(object):
+    class Foo:
         def _get_b(self):
             raise Exception("Failed to get attrib")
 
@@ -148,10 +148,10 @@ def test_attribute_failure():
 
 
 def test_attribute_multiple():
-    class Foo(object):
+    class Foo:
         b = 1
 
-    class Bar(object):
+    class Bar:
         b = 2
 
     assert Foo().b == Bar().b
@@ -161,7 +161,7 @@ def globf(x):
     return x + 1
 
 
-class TestRaises(object):
+class TestRaises:
     def test_raises(self):
         s = "qwe"
         raises(TypeError, int, s)
@@ -177,7 +177,7 @@ class TestRaises(object):
 
     def test_reinterpret_fails_with_print_for_the_fun_of_it(self):
         items = [1, 2, 3]
-        print("items is %r" % items)
+        print("items is {!r}".format(items))
         a, b = items.pop()
 
     def test_some_error(self):
@@ -190,19 +190,20 @@ class TestRaises(object):
 
 # thanks to Matthew Scott for this test
 def test_dynamic_compile_shows_nicely():
-    import imp
+    import importlib.util
     import sys
 
     src = "def foo():\n assert 1 == 0\n"
     name = "abc-123"
-    module = imp.new_module(name)
+    spec = importlib.util.spec_from_loader(name, loader=None)
+    module = importlib.util.module_from_spec(spec)
     code = _pytest._code.compile(src, name, "exec")
     exec(code, module.__dict__)
     sys.modules[name] = module
     module.foo()
 
 
-class TestMoreErrors(object):
+class TestMoreErrors:
     def test_complex_error(self):
         def f():
             return 44
@@ -252,16 +253,16 @@ class TestMoreErrors(object):
             x = 0
 
 
-class TestCustomAssertMsg(object):
+class TestCustomAssertMsg:
     def test_single_line(self):
-        class A(object):
+        class A:
             a = 1
 
         b = 2
         assert A.a == b, "A.a appears not to be b"
 
     def test_multiline(self):
-        class A(object):
+        class A:
             a = 1
 
         b = 2
@@ -270,7 +271,7 @@ class TestCustomAssertMsg(object):
         ), "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):
+        class JSON:
             a = 1
 
             def __repr__(self):

doc/en/example/assertion/test_setup_flow_example.py

@@ -2,7 +2,7 @@ def setup_module(module):
     module.TestStateFullThing.classcount = 0
 
 
-class TestStateFullThing(object):
+class TestStateFullThing:
     def setup_class(cls):
         cls.classcount += 1
 

doc/en/example/attic.rst

@@ -18,7 +18,7 @@ example: specifying and selecting acceptance tests
         return AcceptFixture(request)
 
 
-    class AcceptFixture(object):
+    class AcceptFixture:
         def __init__(self, request):
             if not request.config.getoption("acceptance"):
                 pytest.skip("specify -A to run acceptance tests")
@@ -65,7 +65,7 @@ extend the `accept example`_ by putting this in our test module:
         return arg
 
 
-    class TestSpecialAcceptance(object):
+    class TestSpecialAcceptance:
         def test_sometest(self, accept):
             assert accept.tmpdir.join("special").check()
 

doc/en/example/costlysetup/conftest.py

@@ -1,14 +1,14 @@
 import pytest
 
 
-@pytest.fixture("session")
+@pytest.fixture(scope="session")
 def setup(request):
     setup = CostlySetup()
     yield setup
     setup.finalize()
 
 
-class CostlySetup(object):
+class CostlySetup:
     def __init__(self):
         import time
 

doc/en/example/fixtures/test_fixtures_order.py

@@ -0,0 +1,38 @@
+import pytest
+
+# fixtures documentation order example
+order = []
+
+
+@pytest.fixture(scope="session")
+def s1():
+    order.append("s1")
+
+
+@pytest.fixture(scope="module")
+def m1():
+    order.append("m1")
+
+
+@pytest.fixture
+def f1(f3):
+    order.append("f1")
+
+
+@pytest.fixture
+def f3():
+    order.append("f3")
+
+
+@pytest.fixture(autouse=True)
+def a1():
+    order.append("a1")
+
+
+@pytest.fixture
+def f2():
+    order.append("f2")
+
+
+def test_order(f1, m1, f2, s1):
+    assert order == ["s1", "m1", "a1", "f3", "f1", "f2"]

doc/en/example/markers.rst

@@ -4,7 +4,9 @@
 Working with custom markers
 =================================================
 
-Here are some example using the :ref:`mark` mechanism.
+Here are some examples using the :ref:`mark` mechanism.
+
+.. _`mark run`:
 
 Marking test functions and selecting them for a run
 ----------------------------------------------------
@@ -31,7 +33,7 @@ You can "mark" a test function with custom metadata like this:
         pass
 
 
-    class TestClass(object):
+    class TestClass:
         def test_method(self):
             pass
 
@@ -43,14 +45,14 @@ You can then restrict a test run to only run tests marked with ``webtest``:
 
     $ pytest -v -m webtest
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 4 items / 3 deselected / 1 selected
 
     test_server.py::test_send_http PASSED                                [100%]
 
-    ================== 1 passed, 3 deselected in 0.12 seconds ==================
+    ===================== 1 passed, 3 deselected in 0.12s ======================
 
 Or the inverse, running all tests except the webtest ones:
 
@@ -58,7 +60,7 @@ Or the inverse, running all tests except the webtest ones:
 
     $ pytest -v -m "not webtest"
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 4 items / 1 deselected / 3 selected
@@ -67,7 +69,7 @@ Or the inverse, running all tests except the webtest ones:
     test_server.py::test_another PASSED                                  [ 66%]
     test_server.py::TestClass::test_method PASSED                        [100%]
 
-    ================== 3 passed, 1 deselected in 0.12 seconds ==================
+    ===================== 3 passed, 1 deselected in 0.12s ======================
 
 Selecting tests based on their node ID
 --------------------------------------
@@ -80,14 +82,14 @@ tests based on their module, class, method, or function name:
 
     $ pytest -v test_server.py::TestClass::test_method
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 1 item
 
     test_server.py::TestClass::test_method PASSED                        [100%]
 
-    ========================= 1 passed in 0.12 seconds =========================
+    ============================ 1 passed in 0.12s =============================
 
 You can also select on the class:
 
@@ -95,14 +97,14 @@ You can also select on the class:
 
     $ pytest -v test_server.py::TestClass
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 1 item
 
     test_server.py::TestClass::test_method PASSED                        [100%]
 
-    ========================= 1 passed in 0.12 seconds =========================
+    ============================ 1 passed in 0.12s =============================
 
 Or select multiple nodes:
 
@@ -110,7 +112,7 @@ 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-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 2 items
@@ -118,7 +120,7 @@ Or select multiple nodes:
     test_server.py::TestClass::test_method PASSED                        [ 50%]
     test_server.py::test_send_http PASSED                                [100%]
 
-    ========================= 2 passed in 0.12 seconds =========================
+    ============================ 2 passed in 0.12s =============================
 
 .. _node-id:
 
@@ -150,14 +152,14 @@ select tests based on their names:
 
     $ pytest -v -k http  # running with the above defined example module
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 4 items / 3 deselected / 1 selected
 
     test_server.py::test_send_http PASSED                                [100%]
 
-    ================== 1 passed, 3 deselected in 0.12 seconds ==================
+    ===================== 1 passed, 3 deselected in 0.12s ======================
 
 And you can also run all tests except the ones that match the keyword:
 
@@ -165,7 +167,7 @@ And you can also run all tests except the ones that match the keyword:
 
     $ pytest -k "not send_http" -v
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 4 items / 1 deselected / 3 selected
@@ -174,7 +176,7 @@ And you can also run all tests except the ones that match the keyword:
     test_server.py::test_another PASSED                                  [ 66%]
     test_server.py::TestClass::test_method PASSED                        [100%]
 
-    ================== 3 passed, 1 deselected in 0.12 seconds ==================
+    ===================== 3 passed, 1 deselected in 0.12s ======================
 
 Or to select "http" and "quick" tests:
 
@@ -182,7 +184,7 @@ Or to select "http" and "quick" tests:
 
     $ pytest -k "http or quick" -v
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 4 items / 2 deselected / 2 selected
@@ -190,7 +192,7 @@ Or to select "http" and "quick" tests:
     test_server.py::test_send_http PASSED                                [ 50%]
     test_server.py::test_something_quick PASSED                          [100%]
 
-    ================== 2 passed, 2 deselected in 0.12 seconds ==================
+    ===================== 2 passed, 2 deselected in 0.12s ======================
 
 .. note::
 
@@ -259,7 +261,7 @@ For an example on how to add and work with markers from a plugin, see
     * Asking for existing markers via ``pytest --markers`` gives good output
 
     * Typos in function markers are treated as an error if you use
-      the ``--strict`` option.
+      the ``--strict-markers`` option.
 
 .. _`scoped-marking`:
 
@@ -276,7 +278,7 @@ its test methods:
 
 
     @pytest.mark.webtest
-    class TestClass(object):
+    class TestClass:
         def test_startup(self):
             pass
 
@@ -286,15 +288,14 @@ its test methods:
 This is equivalent to directly applying the decorator to the
 two test functions.
 
-To remain backward-compatible with Python 2.4 you can also set a
-``pytestmark`` attribute on a TestClass like this:
+Due to legacy reasons, it is possible to set the ``pytestmark`` attribute on a TestClass like this:
 
 .. code-block:: python
 
     import pytest
 
 
-    class TestClass(object):
+    class TestClass:
         pytestmark = pytest.mark.webtest
 
 or if you need to use multiple markers you can use a list:
@@ -304,7 +305,7 @@ or if you need to use multiple markers you can use a list:
     import pytest
 
 
-    class TestClass(object):
+    class TestClass:
         pytestmark = [pytest.mark.webtest, pytest.mark.slowtest]
 
 You can also set a module level marker::
@@ -335,7 +336,7 @@ apply a marker to an individual test instance:
 
     @pytest.mark.foo
     @pytest.mark.parametrize(
-        ("n", "expected"), [(1, 2), pytest.param((1, 3), marks=pytest.mark.bar), (2, 3)]
+        ("n", "expected"), [(1, 2), pytest.param(1, 3, marks=pytest.mark.bar), (2, 3)]
     )
     def test_increment(n, expected):
         assert n + 1 == expected
@@ -383,7 +384,7 @@ specifies via named environments:
         envnames = [mark.args[0] for mark in item.iter_markers(name="env")]
         if envnames:
             if item.config.getoption("-E") not in envnames:
-                pytest.skip("test requires env in %r" % envnames)
+                pytest.skip("test requires env in {!r}".format(envnames))
 
 A test file using this local plugin:
 
@@ -405,14 +406,14 @@ the test needs:
 
     $ pytest -E stage2
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_someenv.py s                                                    [100%]
 
-    ======================== 1 skipped in 0.12 seconds =========================
+    ============================ 1 skipped in 0.12s ============================
 
 and here is one that specifies exactly the environment needed:
 
@@ -420,14 +421,14 @@ and here is one that specifies exactly the environment needed:
 
     $ pytest -E stage1
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_someenv.py .                                                    [100%]
 
-    ========================= 1 passed in 0.12 seconds =========================
+    ============================ 1 passed in 0.12s =============================
 
 The ``--markers`` option always gives you a list of available markers:
 
@@ -498,7 +499,7 @@ The output is as follows:
     $ pytest -q -s
     Mark(name='my_marker', args=(<function hello_world at 0xdeadbeef>,), kwargs={})
     .
-    1 passed in 0.12 seconds
+    1 passed in 0.12s
 
 We can see that the custom marker has its argument set extended with the function ``hello_world``. This is the key difference between creating a custom marker as a callable, which invokes ``__call__`` behind the scenes, and using ``with_args``.
 
@@ -522,7 +523,7 @@ code you can read over all such settings.  Example:
 
 
     @pytest.mark.glob("class", x=2)
-    class TestClass(object):
+    class TestClass:
         @pytest.mark.glob("function", x=3)
         def test_something(self):
             pass
@@ -538,7 +539,7 @@ 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={} kwargs={}".format(mark.args, mark.kwargs))
             sys.stdout.flush()
 
 Let's run this without capturing output and see what we get:
@@ -550,7 +551,7 @@ Let's run this without capturing output and see what we get:
     glob args=('class',) kwargs={'x': 2}
     glob args=('module',) kwargs={'x': 1}
     .
-    1 passed in 0.12 seconds
+    1 passed in 0.12s
 
 marking platform specific tests with pytest
 --------------------------------------------------------------
@@ -577,7 +578,7 @@ for your particular platform, you could use the following plugin:
         supported_platforms = ALL.intersection(mark.name for mark in item.iter_markers())
         plat = sys.platform
         if supported_platforms and plat not in supported_platforms:
-            pytest.skip("cannot run on platform %s" % (plat))
+            pytest.skip("cannot run on platform {}".format(plat))
 
 then tests will be skipped if they were specified for a different platform.
 Let's do a little test file to show how this looks like:
@@ -613,16 +614,16 @@ then you will see two tests skipped and two executed tests as expected:
 
     $ pytest -rs # this option reports skip reasons
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 4 items
 
     test_plat.py s.s.                                                    [100%]
-    ========================= short test summary info ==========================
-    SKIPPED [2] $REGENDOC_TMPDIR/conftest.py:13: cannot run on platform linux
 
-    =================== 2 passed, 2 skipped in 0.12 seconds ====================
+    ========================= short test summary info ==========================
+    SKIPPED [2] $REGENDOC_TMPDIR/conftest.py:12: cannot run on platform linux
+    ======================= 2 passed, 2 skipped in 0.12s =======================
 
 Note that if you specify a platform via the marker-command line option like this:
 
@@ -630,14 +631,14 @@ Note that if you specify a platform via the marker-command line option like this
 
     $ pytest -m linux
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 4 items / 3 deselected / 1 selected
 
     test_plat.py .                                                       [100%]
 
-    ================== 1 passed, 3 deselected in 0.12 seconds ==================
+    ===================== 1 passed, 3 deselected in 0.12s ======================
 
 then the unmarked-tests will not be run.  It is thus a way to restrict the run to the specific tests.
 
@@ -694,7 +695,7 @@ 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-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 4 items / 2 deselected / 2 selected
@@ -710,7 +711,7 @@ We can now use the ``-m option`` to select one set:
     test_module.py:8: in test_interface_complex
         assert 0
     E   assert 0
-    ================== 2 failed, 2 deselected in 0.12 seconds ==================
+    ===================== 2 failed, 2 deselected in 0.12s ======================
 
 or to select both "event" and "interface" tests:
 
@@ -718,7 +719,7 @@ or to select both "event" and "interface" tests:
 
     $ 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 4 items / 1 deselected / 3 selected
@@ -738,4 +739,4 @@ or to select both "event" and "interface" tests:
     test_module.py:12: in test_event_simple
         assert 0
     E   assert 0
-    ================== 3 failed, 1 deselected in 0.12 seconds ==================
+    ===================== 3 failed, 1 deselected in 0.12s ======================

doc/en/example/multipython.py

@@ -2,13 +2,13 @@
 module containing a parametrized tests testing cross-python
 serialization via the pickle module.
 """
-import distutils.spawn
+import shutil
 import subprocess
 import textwrap
 
 import pytest
 
-pythonlist = ["python2.7", "python3.4", "python3.5"]
+pythonlist = ["python3.5", "python3.6", "python3.7"]
 
 
 @pytest.fixture(params=pythonlist)
@@ -22,9 +22,9 @@ def python2(request, python1):
     return Python(request.param, python1.picklefile)
 
 
-class Python(object):
+class Python:
     def __init__(self, version, picklefile):
-        self.pythonpath = distutils.spawn.find_executable(version)
+        self.pythonpath = shutil.which(version)
         if not self.pythonpath:
             pytest.skip("{!r} not found".format(version))
         self.picklefile = picklefile
@@ -69,4 +69,4 @@ class Python(object):
 @pytest.mark.parametrize("obj", [42, {}, {1: 3}])
 def test_basic_objects(python1, python2, obj):
     python1.dumps(obj)
-    python2.load_and_is_true("obj == %s" % obj)
+    python2.load_and_is_true("obj == {}".format(obj))

doc/en/example/nonpython.rst

@@ -12,14 +12,14 @@ A basic example for specifying tests in Yaml files
 .. _`pytest-yamlwsgi`: http://bitbucket.org/aafshar/pytest-yamlwsgi/src/tip/pytest_yamlwsgi.py
 .. _`PyYAML`: https://pypi.org/project/PyYAML/
 
-Here is an example ``conftest.py`` (extracted from Ali Afshnars special purpose `pytest-yamlwsgi`_ plugin).   This ``conftest.py`` will  collect ``test*.yml`` files and will execute the yaml-formatted content as custom tests:
+Here is an example ``conftest.py`` (extracted from Ali Afshnars special purpose `pytest-yamlwsgi`_ plugin).   This ``conftest.py`` will  collect ``test*.yaml`` files and will execute the yaml-formatted content as custom tests:
 
 .. include:: nonpython/conftest.py
     :literal:
 
 You can create a simple example file:
 
-.. include:: nonpython/test_simple.yml
+.. include:: nonpython/test_simple.yaml
     :literal:
 
 and if you installed `PyYAML`_ or a compatible YAML-parser you can
@@ -27,21 +27,21 @@ now execute the test specification:
 
 .. code-block:: pytest
 
-    nonpython $ pytest test_simple.yml
+    nonpython $ pytest test_simple.yaml
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR/nonpython
     collected 2 items
 
-    test_simple.yml F.                                                   [100%]
+    test_simple.yaml F.                                                  [100%]
 
     ================================= FAILURES =================================
     ______________________________ usecase: hello ______________________________
     usecase execution failed
        spec failed: 'some': 'other'
        no further details known at this point.
-    ==================== 1 failed, 1 passed in 0.12 seconds ====================
+    ======================= 1 failed, 1 passed in 0.12s ========================
 
 .. regendoc:wipe
 
@@ -64,20 +64,20 @@ consulted when reporting in ``verbose`` mode:
 
     nonpython $ pytest -v
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR/nonpython
     collecting ... collected 2 items
 
-    test_simple.yml::hello FAILED                                        [ 50%]
-    test_simple.yml::ok PASSED                                           [100%]
+    test_simple.yaml::hello FAILED                                       [ 50%]
+    test_simple.yaml::ok PASSED                                          [100%]
 
     ================================= FAILURES =================================
     ______________________________ usecase: hello ______________________________
     usecase execution failed
        spec failed: 'some': 'other'
        no further details known at this point.
-    ==================== 1 failed, 1 passed in 0.12 seconds ====================
+    ======================= 1 failed, 1 passed in 0.12s ========================
 
 .. regendoc:wipe
 
@@ -88,13 +88,13 @@ interesting to just look at the collection tree:
 
     nonpython $ pytest --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR/nonpython
     collected 2 items
     <Package $REGENDOC_TMPDIR/nonpython>
-      <YamlFile test_simple.yml>
+      <YamlFile test_simple.yaml>
         <YamlItem hello>
         <YamlItem ok>
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================

doc/en/example/nonpython/conftest.py

@@ -3,7 +3,7 @@ import pytest
 
 
 def pytest_collect_file(parent, path):
-    if path.ext == ".yml" and path.basename.startswith("test"):
+    if path.ext == ".yaml" and path.basename.startswith("test"):
         return YamlFile(path, parent)
 
 
@@ -18,7 +18,7 @@ class YamlFile(pytest.File):
 
 class YamlItem(pytest.Item):
     def __init__(self, name, parent, spec):
-        super(YamlItem, self).__init__(name, parent)
+        super().__init__(name, parent)
         self.spec = spec
 
     def runtest(self):
@@ -33,13 +33,13 @@ class YamlItem(pytest.Item):
             return "\n".join(
                 [
                     "usecase execution failed",
-                    "   spec failed: %r: %r" % excinfo.value.args[1:3],
+                    "   spec failed: {1!r}: {2!r}".format(*excinfo.value.args),
                     "   no further details known at this point.",
                 ]
             )
 
     def reportinfo(self):
-        return self.fspath, 0, "usecase: %s" % self.name
+        return self.fspath, 0, "usecase: {}".format(self.name)
 
 
 class YamlException(Exception):

doc/en/example/nonpython/test_simple.yaml

@@ -1,4 +1,4 @@
-# test_simple.yml
+# test_simple.yaml
 ok:
     sub1: sub1
 

doc/en/example/parametrize.rst

@@ -19,24 +19,30 @@ Generating parameters combinations, depending on command line
 
 Let's say we want to execute a test with different computation
 parameters and the parameter range shall be determined by a command
-line argument.  Let's first write a simple (do-nothing) computation test::
+line argument.  Let's first write a simple (do-nothing) computation test:
+
+.. code-block:: python
 
     # content of test_compute.py
 
+
     def test_compute(param1):
         assert param1 < 4
 
-Now we add a test configuration like this::
+Now we add a test configuration like this:
+
+.. code-block:: python
 
     # content of conftest.py
 
+
     def pytest_addoption(parser):
-        parser.addoption("--all", action="store_true",
-            help="run all combinations")
+        parser.addoption("--all", action="store_true", help="run all combinations")
+
 
     def pytest_generate_tests(metafunc):
-        if 'param1' in metafunc.fixturenames:
-            if metafunc.config.getoption('all'):
+        if "param1" in metafunc.fixturenames:
+            if metafunc.config.getoption("all"):
                 end = 5
             else:
                 end = 2
@@ -48,7 +54,7 @@ This means that we only run 2 tests if we do not pass ``--all``:
 
     $ pytest -q test_compute.py
     ..                                                                   [100%]
-    2 passed in 0.12 seconds
+    2 passed in 0.12s
 
 We run only two computations, so we see two dots.
 let's run the full monty:
@@ -66,8 +72,8 @@ let's run the full monty:
     >       assert param1 < 4
     E       assert 4 < 4
 
-    test_compute.py:3: AssertionError
-    1 failed, 4 passed in 0.12 seconds
+    test_compute.py:4: AssertionError
+    1 failed, 4 passed in 0.12s
 
 As expected when running the full range of ``param1`` values
 we'll get an error on the last one.
@@ -83,7 +89,9 @@ Running pytest with ``--collect-only`` will show the generated IDs.
 
 Numbers, strings, booleans and None will have their usual string representation
 used in the test ID. For other objects, pytest will make a string based on
-the argument name::
+the argument name:
+
+.. code-block:: python
 
     # content of test_time.py
 
@@ -112,7 +120,7 @@ the argument name::
     def idfn(val):
         if isinstance(val, (datetime,)):
             # note this wouldn't show any hours/minutes/seconds
-            return val.strftime('%Y%m%d')
+            return val.strftime("%Y%m%d")
 
 
     @pytest.mark.parametrize("a,b,expected", testdata, ids=idfn)
@@ -120,12 +128,18 @@ the argument name::
         diff = a - b
         assert diff == expected
 
-    @pytest.mark.parametrize("a,b,expected", [
-        pytest.param(datetime(2001, 12, 12), datetime(2001, 12, 11),
-                     timedelta(1), id='forward'),
-        pytest.param(datetime(2001, 12, 11), datetime(2001, 12, 12),
-                     timedelta(-1), id='backward'),
-    ])
+
+    @pytest.mark.parametrize(
+        "a,b,expected",
+        [
+            pytest.param(
+                datetime(2001, 12, 12), datetime(2001, 12, 11), timedelta(1), id="forward"
+            ),
+            pytest.param(
+                datetime(2001, 12, 11), datetime(2001, 12, 12), timedelta(-1), id="backward"
+            ),
+        ],
+    )
     def test_timedistance_v3(a, b, expected):
         diff = a - b
         assert diff == expected
@@ -144,7 +158,7 @@ objects, they are still using the default pytest representation:
 
     $ pytest test_time.py --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 8 items
@@ -158,7 +172,7 @@ objects, they are still using the default pytest representation:
       <Function test_timedistance_v3[forward]>
       <Function test_timedistance_v3[backward]>
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
 
 In ``test_timedistance_v3``, we used ``pytest.param`` to specify the test IDs
 together with the actual data, instead of listing them separately.
@@ -171,10 +185,13 @@ A quick port of "testscenarios"
 Here is a quick port to run tests configured with `test scenarios`_,
 an add-on from Robert Collins for the standard unittest framework. We
 only have to work a bit to construct the correct arguments for pytest's
-:py:func:`Metafunc.parametrize`::
+:py:func:`Metafunc.parametrize`:
+
+.. code-block:: python
 
     # content of test_scenarios.py
 
+
     def pytest_generate_tests(metafunc):
         idlist = []
         argvalues = []
@@ -182,13 +199,15 @@ only have to work a bit to construct the correct arguments for pytest's
             idlist.append(scenario[0])
             items = scenario[1].items()
             argnames = [x[0] for x in items]
-            argvalues.append(([x[1] for x in items]))
+            argvalues.append([x[1] for x in items])
         metafunc.parametrize(argnames, argvalues, ids=idlist, scope="class")
 
-    scenario1 = ('basic', {'attribute': 'value'})
-    scenario2 = ('advanced', {'attribute': 'value2'})
 
-    class TestSampleWithScenarios(object):
+    scenario1 = ("basic", {"attribute": "value"})
+    scenario2 = ("advanced", {"attribute": "value2"})
+
+
+    class TestSampleWithScenarios:
         scenarios = [scenario1, scenario2]
 
         def test_demo1(self, attribute):
@@ -203,14 +222,14 @@ this is a fully self-contained example which you can run with:
 
     $ pytest test_scenarios.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 4 items
 
     test_scenarios.py ....                                               [100%]
 
-    ========================= 4 passed in 0.12 seconds =========================
+    ============================ 4 passed in 0.12s =============================
 
 If you just collect tests you'll also nicely see 'advanced' and 'basic' as variants for the test function:
 
@@ -218,7 +237,7 @@ If you just collect tests you'll also nicely see 'advanced' and 'basic' as varia
 
     $ pytest --collect-only test_scenarios.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 4 items
@@ -229,7 +248,7 @@ If you just collect tests you'll also nicely see 'advanced' and 'basic' as varia
           <Function test_demo1[advanced]>
           <Function test_demo2[advanced]>
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
 
 Note that we told ``metafunc.parametrize()`` that your scenario values
 should be considered class-scoped.  With pytest-2.3 this leads to a
@@ -243,12 +262,16 @@ Deferring the setup of parametrized resources
 The parametrization of test functions happens at collection
 time.  It is a good idea to setup expensive resources like DB
 connections or subprocess only when the actual test is run.
-Here is a simple example how you can achieve that, first
-the actual test requiring a ``db`` object::
+Here is a simple example how you can achieve that. This test
+requires a ``db`` object fixture:
+
+.. code-block:: python
 
     # content of test_backends.py
 
     import pytest
+
+
     def test_db_initialized(db):
         # a dummy test
         if db.__class__.__name__ == "DB2":
@@ -256,20 +279,27 @@ the actual test requiring a ``db`` object::
 
 We can now add a test configuration that generates two invocations of
 the ``test_db_initialized`` function and also implements a factory that
-creates a database object for the actual test invocations::
+creates a database object for the actual test invocations:
+
+.. code-block:: python
 
     # content of conftest.py
     import pytest
 
-    def pytest_generate_tests(metafunc):
-        if 'db' in metafunc.fixturenames:
-            metafunc.parametrize("db", ['d1', 'd2'], indirect=True)
 
-    class DB1(object):
+    def pytest_generate_tests(metafunc):
+        if "db" in metafunc.fixturenames:
+            metafunc.parametrize("db", ["d1", "d2"], indirect=True)
+
+
+    class DB1:
         "one database object"
-    class DB2(object):
+
+
+    class DB2:
         "alternative database object"
 
+
     @pytest.fixture
     def db(request):
         if request.param == "d1":
@@ -285,7 +315,7 @@ Let's first see how it looks like at collection time:
 
     $ pytest test_backends.py --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 2 items
@@ -293,7 +323,7 @@ Let's first see how it looks like at collection time:
       <Function test_db_initialized[d1]>
       <Function test_db_initialized[d2]>
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
 
 And then when we run the test:
 
@@ -312,8 +342,8 @@ And then when we run the test:
     >           pytest.fail("deliberately failing for demo purposes")
     E           Failed: deliberately failing for demo purposes
 
-    test_backends.py:6: Failed
-    1 failed, 1 passed in 0.12 seconds
+    test_backends.py:8: Failed
+    1 failed, 1 passed in 0.12s
 
 The first invocation with ``db == "DB1"`` passed while the second with ``db == "DB2"`` failed.  Our ``db`` fixture function has instantiated each of the DB values during the setup phase while the ``pytest_generate_tests`` generated two according calls to the ``test_db_initialized`` during the collection phase.
 
@@ -327,23 +357,29 @@ parameter on particular arguments. It can be done by passing list or tuple of
 arguments' names to ``indirect``. In the example below there is a function ``test_indirect`` which uses
 two fixtures: ``x`` and ``y``. Here we give to indirect the list, which contains the name of the
 fixture ``x``. The indirect parameter will be applied to this argument only, and the value ``a``
-will be passed to respective fixture function::
+will be passed to respective fixture function:
+
+.. code-block:: python
 
     # content of test_indirect_list.py
 
     import pytest
-    @pytest.fixture(scope='function')
+
+
+    @pytest.fixture(scope="function")
     def x(request):
         return request.param * 3
 
-    @pytest.fixture(scope='function')
+
+    @pytest.fixture(scope="function")
     def y(request):
         return request.param * 2
 
-    @pytest.mark.parametrize('x, y', [('a', 'b')], indirect=['x'])
-    def test_indirect(x,y):
-        assert x == 'aaa'
-        assert y == 'b'
+
+    @pytest.mark.parametrize("x, y", [("a", "b")], indirect=["x"])
+    def test_indirect(x, y):
+        assert x == "aaa"
+        assert y == "b"
 
 The result of this test will be successful:
 
@@ -351,14 +387,14 @@ The result of this test will be successful:
 
     $ pytest test_indirect_list.py --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 1 item
     <Module test_indirect_list.py>
       <Function test_indirect[a-b]>
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
 
 .. regendoc:wipe
 
@@ -370,23 +406,28 @@ Parametrizing test methods through per-class configuration
 
 Here is an example ``pytest_generate_tests`` function implementing a
 parametrization scheme similar to Michael Foord's `unittest
-parametrizer`_ but in a lot less code::
+parametrizer`_ but in a lot less code:
+
+.. code-block:: python
 
     # content of ./test_parametrize.py
     import pytest
 
+
     def pytest_generate_tests(metafunc):
         # called once per each test function
         funcarglist = metafunc.cls.params[metafunc.function.__name__]
         argnames = sorted(funcarglist[0])
-        metafunc.parametrize(argnames, [[funcargs[name] for name in argnames]
-                for funcargs in funcarglist])
+        metafunc.parametrize(
+            argnames, [[funcargs[name] for name in argnames] for funcargs in funcarglist]
+        )
 
-    class TestClass(object):
+
+    class TestClass:
         # a map specifying multiple argument sets for a test method
         params = {
-            'test_equals': [dict(a=1, b=2), dict(a=3, b=3), ],
-            'test_zerodivision': [dict(a=1, b=0), ],
+            "test_equals": [dict(a=1, b=2), dict(a=3, b=3)],
+            "test_zerodivision": [dict(a=1, b=0)],
         }
 
         def test_equals(self, a, b):
@@ -412,8 +453,8 @@ argument sets to use for each test function.  Let's run it:
     >       assert a == b
     E       assert 1 == 2
 
-    test_parametrize.py:18: AssertionError
-    1 failed, 2 passed in 0.12 seconds
+    test_parametrize.py:21: AssertionError
+    1 failed, 2 passed in 0.12s
 
 Indirect parametrization with multiple fixtures
 --------------------------------------------------------------
@@ -429,15 +470,16 @@ 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 (3 interpreters times 3 interpreters times 3 objects to serialize/deserialize):
 
 .. code-block:: pytest
 
    . $ pytest -rs -q multipython.py
-   ...sss...sssssssss...sss...                                          [100%]
+   ssssssssssss...ssssssssssss                                          [100%]
    ========================= short test summary info ==========================
-   SKIPPED [15] $REGENDOC_TMPDIR/CWD/multipython.py:30: 'python3.4' not found
-   12 passed, 15 skipped in 0.12 seconds
+   SKIPPED [12] $REGENDOC_TMPDIR/CWD/multipython.py:29: 'python3.5' not found
+   SKIPPED [12] $REGENDOC_TMPDIR/CWD/multipython.py:29: 'python3.7' not found
+   3 passed, 24 skipped in 0.12s
 
 Indirect parametrization of optional implementations/imports
 --------------------------------------------------------------------
@@ -446,36 +488,47 @@ If you want to compare the outcomes of several implementations of a given
 API, you can write test functions that receive the already imported implementations
 and get skipped in case the implementation is not importable/available.  Let's
 say we have a "base" implementation and the other (possibly optimized ones)
-need to provide similar results::
+need to provide similar results:
+
+.. code-block:: python
 
     # content of conftest.py
 
     import pytest
 
+
     @pytest.fixture(scope="session")
     def basemod(request):
         return pytest.importorskip("base")
 
+
     @pytest.fixture(scope="session", params=["opt1", "opt2"])
     def optmod(request):
         return pytest.importorskip(request.param)
 
-And then a base implementation of a simple function::
+And then a base implementation of a simple function:
+
+.. code-block:: python
 
     # content of base.py
     def func1():
         return 1
 
-And an optimized version::
+And an optimized version:
+
+.. code-block:: python
 
     # content of opt1.py
     def func1():
         return 1.0001
 
-And finally a little test module::
+And finally a little test module:
+
+.. code-block:: python
 
     # content of test_module.py
 
+
     def test_func1(basemod, optmod):
         assert round(basemod.func1(), 3) == round(optmod.func1(), 3)
 
@@ -486,16 +539,16 @@ If you run this with reporting for skips enabled:
 
     $ pytest -rs test_module.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 2 items
 
     test_module.py .s                                                    [100%]
-    ========================= short test summary info ==========================
-    SKIPPED [1] $REGENDOC_TMPDIR/conftest.py:11: could not import 'opt2'
 
-    =================== 1 passed, 1 skipped in 0.12 seconds ====================
+    ========================= short test summary info ==========================
+    SKIPPED [1] $REGENDOC_TMPDIR/conftest.py:12: could not import 'opt2': No module named 'opt2'
+    ======================= 1 passed, 1 skipped in 0.12s =======================
 
 You'll see that we don't have an ``opt2`` module and thus the second test run
 of our ``test_func1`` was skipped.  A few notes:
@@ -548,16 +601,16 @@ 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-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
-    collecting ... collected 17 items / 14 deselected / 3 selected
+    collecting ... collected 18 items / 15 deselected / 3 selected
 
     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%]
 
-    ============ 2 passed, 14 deselected, 1 xfailed in 0.12 seconds ============
+    =============== 2 passed, 15 deselected, 1 xfailed in 0.12s ================
 
 As the result:
 
@@ -578,22 +631,28 @@ Use :func:`pytest.raises` with the
 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::
+as a complement to ``raises``. For example:
+
+.. code-block:: python
 
     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)),
-    ])
+    @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:
@@ -603,14 +662,20 @@ 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``::
+to define ``does_not_raise``:
+
+.. code-block:: python
 
     from contextlib import nullcontext as does_not_raise
 
-Or, if you're supporting Python 3.3+ you can use::
+Or, if you're supporting Python 3.3+ you can use:
+
+.. code-block:: python
 
     from contextlib import ExitStack as does_not_raise
 
-Or, if desired, you can ``pip install contextlib2`` and use::
+Or, if desired, you can ``pip install contextlib2`` and use:
 
-    from contextlib2 import ExitStack as does_not_raise
+.. code-block:: python
+
+    from contextlib2 import nullcontext as does_not_raise

doc/en/example/pythoncollection.py

@@ -6,7 +6,7 @@ def test_function():
     pass
 
 
-class TestClass(object):
+class TestClass:
     def test_method(self):
         pass
 

doc/en/example/pythoncollection.rst

@@ -31,7 +31,7 @@ you will see that ``pytest`` only collects test-modules, which do not match the
 .. code-block:: pytest
 
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     rootdir: $REGENDOC_TMPDIR, inifile:
     collected 5 items
 
@@ -131,12 +131,15 @@ Here is an example:
 
 This would make ``pytest`` look for tests in files that match the ``check_*
 .py`` glob-pattern, ``Check`` prefixes in classes, and functions and methods
-that match ``*_check``. For example, if we have::
+that match ``*_check``. For example, if we have:
+
+.. code-block:: python
 
     # content of check_myapp.py
-    class CheckMyApp(object):
+    class CheckMyApp:
         def simple_check(self):
             pass
+
         def complex_check(self):
             pass
 
@@ -146,7 +149,7 @@ The test collection would look like this:
 
     $ pytest --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 2 items
@@ -155,7 +158,7 @@ The test collection would look like this:
           <Function simple_check>
           <Function complex_check>
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
 
 You can check for multiple glob patterns by adding a space between the patterns:
 
@@ -208,7 +211,7 @@ You can always peek at the collection tree without running tests like this:
 
     . $ pytest --collect-only pythoncollection.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 3 items
@@ -218,7 +221,7 @@ You can always peek at the collection tree without running tests like this:
           <Function test_method>
           <Function test_anothermethod>
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
 
 .. _customizing-test-collection:
 
@@ -238,7 +241,9 @@ You can easily instruct ``pytest`` to discover tests from every Python file:
 However, many projects will have a ``setup.py`` which they don't want to be
 imported. Moreover, there may files only importable by a specific python
 version. For such cases you can dynamically define files to be ignored by
-listing them in a ``conftest.py`` file::
+listing them in a ``conftest.py`` file:
+
+.. code-block:: python
 
     # content of conftest.py
     import sys
@@ -247,7 +252,9 @@ listing them in a ``conftest.py`` file::
     if sys.version_info[0] > 2:
         collect_ignore.append("pkg/module_py2.py")
 
-and then if you have a module file like this::
+and then if you have a module file like this:
+
+.. code-block:: python
 
     # content of pkg/module_py2.py
     def test_only_on_python2():
@@ -256,10 +263,12 @@ and then if you have a module file like this::
         except Exception, e:
             pass
 
-and a ``setup.py`` dummy file like this::
+and a ``setup.py`` dummy file like this:
+
+.. code-block:: python
 
     # content of setup.py
-    0/0  # will raise exception if imported
+    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:
@@ -283,19 +292,21 @@ file will be left out:
 
     $ pytest --collect-only
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.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 =======================
+    ========================== no tests ran in 0.12s ===========================
 
 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::
+interpreter:
+
+.. code-block:: python
 
     # content of conftest.py
     import sys

doc/en/example/reportingdemo.rst

@@ -9,7 +9,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
 
     assertion $ pytest failure_demo.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR/assertion
     collected 44 items
@@ -119,7 +119,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
             a = "1" * 100 + "a" + "2" * 100
             b = "1" * 100 + "b" + "2" * 100
     >       assert a == b
-    E       AssertionError: assert '111111111111...2222222222222' == '1111111111111...2222222222222'
+    E       AssertionError: assert '111111111111...2222222222222' == '111111111111...2222222222222'
     E         Skipping 90 identical leading characters in diff, use -v to show
     E         Skipping 91 identical trailing characters in diff, use -v to show
     E         - 1111111111a222222222
@@ -136,7 +136,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
             a = "1\n" * 100 + "a" + "2\n" * 100
             b = "1\n" * 100 + "b" + "2\n" * 100
     >       assert a == b
-    E       AssertionError: assert '1\n1\n1\n1\n...n2\n2\n2\n2\n' == '1\n1\n1\n1\n1...n2\n2\n2\n2\n'
+    E       AssertionError: assert '1\n1\n1\n1\n...n2\n2\n2\n2\n' == '1\n1\n1\n1\n...n2\n2\n2\n2\n'
     E         Skipping 190 identical leading characters in diff, use -v to show
     E         Skipping 191 identical trailing characters in diff, use -v to show
     E           1
@@ -182,9 +182,9 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     E         Omitting 1 identical items, use -vv to show
     E         Differing items:
     E         {'b': 1} != {'b': 2}
-    E         Left contains more items:
+    E         Left contains 1 more item:
     E         {'c': 0}
-    E         Right contains more items:
+    E         Right contains 1 more item:
     E         {'d': 0}...
     E
     E         ...Full output truncated (2 lines hidden), use '-vv' to show
@@ -215,7 +215,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
         def test_eq_longer_list(self):
     >       assert [1, 2] == [1, 2, 3]
     E       assert [1, 2] == [1, 2, 3]
-    E         Right contains more items, first extra item: 3
+    E         Right contains one more item: 3
     E         Use -v to get the full diff
 
     failure_demo.py:78: AssertionError
@@ -235,7 +235,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
         def test_not_in_text_multiline(self):
             text = "some multiline\ntext\nwhich\nincludes foo\nand a\ntail"
     >       assert "foo" not in text
-    E       AssertionError: assert 'foo' not in 'some multiline\ntext\nw...ncludes foo\nand a\ntail'
+    E       AssertionError: assert 'foo' not in 'some multil...nand a\ntail'
     E         'foo' is contained here:
     E           some multiline
     E           text
@@ -267,7 +267,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
         def test_not_in_text_single_long(self):
             text = "head " * 50 + "foo " + "tail " * 20
     >       assert "foo" not in text
-    E       AssertionError: assert 'foo' not in 'head head head head hea...ail tail tail tail tail '
+    E       AssertionError: assert 'foo' not in 'head head h...l tail tail '
     E         'foo' is contained here:
     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         ?           +++
@@ -280,7 +280,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
         def test_not_in_text_single_long_term(self):
             text = "head " * 50 + "f" * 70 + "tail " * 20
     >       assert "f" * 70 not in text
-    E       AssertionError: assert 'fffffffffff...ffffffffffff' not in 'head head he...l tail tail '
+    E       AssertionError: assert 'fffffffffff...ffffffffffff' not in 'head head h...l tail tail '
     E         'ffffffffffffffffff...fffffffffffffffffff' is contained here:
     E           head head fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffftail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail
     E         ?           ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -294,14 +294,14 @@ Here is a nice run of several failures and how ``pytest`` presents things:
             from dataclasses import dataclass
 
             @dataclass
-            class Foo(object):
+            class Foo:
                 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       AssertionError: assert TestSpecialis...oo(a=1, b='b') == TestSpecialis...oo(a=1, b='c')
     E         Omitting 1 identical items, use -vv to show
     E         Differing attributes:
     E         b: 'b' != 'c'
@@ -315,7 +315,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
             import attr
 
             @attr.s
-            class Foo(object):
+            class Foo:
                 a = attr.ib()
                 b = attr.ib()
 
@@ -331,7 +331,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     ______________________________ test_attribute ______________________________
 
         def test_attribute():
-            class Foo(object):
+            class Foo:
                 b = 1
 
             i = Foo()
@@ -343,7 +343,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     _________________________ test_attribute_instance __________________________
 
         def test_attribute_instance():
-            class Foo(object):
+            class Foo:
                 b = 1
 
     >       assert Foo().b == 2
@@ -355,7 +355,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     __________________________ test_attribute_failure __________________________
 
         def test_attribute_failure():
-            class Foo(object):
+            class Foo:
                 def _get_b(self):
                     raise Exception("Failed to get attrib")
 
@@ -377,10 +377,10 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     _________________________ test_attribute_multiple __________________________
 
         def test_attribute_multiple():
-            class Foo(object):
+            class Foo:
                 b = 1
 
-            class Bar(object):
+            class Bar:
                 b = 2
 
     >       assert Foo().b == Bar().b
@@ -434,7 +434,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
 
         def test_reinterpret_fails_with_print_for_the_fun_of_it(self):
             items = [1, 2, 3]
-            print("items is %r" % items)
+            print("items is {!r}".format(items))
     >       a, b = items.pop()
     E       TypeError: 'int' object is not iterable
 
@@ -453,25 +453,26 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     ____________________ test_dynamic_compile_shows_nicely _____________________
 
         def test_dynamic_compile_shows_nicely():
-            import imp
+            import importlib.util
             import sys
 
             src = "def foo():\n assert 1 == 0\n"
             name = "abc-123"
-            module = imp.new_module(name)
+            spec = importlib.util.spec_from_loader(name, loader=None)
+            module = importlib.util.module_from_spec(spec)
             code = _pytest._code.compile(src, name, "exec")
             exec(code, module.__dict__)
             sys.modules[name] = module
     >       module.foo()
 
-    failure_demo.py:202:
+    failure_demo.py:203:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
         def foo():
     >    assert 1 == 0
     E    AssertionError
 
-    <0-codegen 'abc-123' $REGENDOC_TMPDIR/assertion/failure_demo.py:199>:2: AssertionError
+    <0-codegen 'abc-123' $REGENDOC_TMPDIR/assertion/failure_demo.py:200>:2: AssertionError
     ____________________ TestMoreErrors.test_complex_error _____________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -485,7 +486,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
 
     >       somefunc(f(), g())
 
-    failure_demo.py:213:
+    failure_demo.py:214:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
     failure_demo.py:11: in somefunc
         otherfunc(x, y)
@@ -507,7 +508,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     >       a, b = items
     E       ValueError: not enough values to unpack (expected 2, got 0)
 
-    failure_demo.py:217: ValueError
+    failure_demo.py:218: ValueError
     ____________________ TestMoreErrors.test_z2_type_error _____________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -517,7 +518,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     >       a, b = items
     E       TypeError: 'int' object is not iterable
 
-    failure_demo.py:221: TypeError
+    failure_demo.py:222: TypeError
     ______________________ TestMoreErrors.test_startswith ______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -530,7 +531,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     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:226: AssertionError
+    failure_demo.py:227: AssertionError
     __________________ TestMoreErrors.test_startswith_nested ___________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -549,7 +550,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     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:235: AssertionError
+    failure_demo.py:236: AssertionError
     _____________________ TestMoreErrors.test_global_func ______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -560,7 +561,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     E        +  where False = isinstance(43, float)
     E        +    where 43 = globf(42)
 
-    failure_demo.py:238: AssertionError
+    failure_demo.py:239: AssertionError
     _______________________ TestMoreErrors.test_instance _______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -571,7 +572,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     E       assert 42 != 42
     E        +  where 42 = <failure_demo.TestMoreErrors object at 0xdeadbeef>.x
 
-    failure_demo.py:242: AssertionError
+    failure_demo.py:243: AssertionError
     _______________________ TestMoreErrors.test_compare ________________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -581,7 +582,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     E       assert 11 < 5
     E        +  where 11 = globf(10)
 
-    failure_demo.py:245: AssertionError
+    failure_demo.py:246: AssertionError
     _____________________ TestMoreErrors.test_try_finally ______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -592,13 +593,13 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     >           assert x == 0
     E           assert 1 == 0
 
-    failure_demo.py:250: AssertionError
+    failure_demo.py:251: AssertionError
     ___________________ TestCustomAssertMsg.test_single_line ___________________
 
     self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef>
 
         def test_single_line(self):
-            class A(object):
+            class A:
                 a = 1
 
             b = 2
@@ -607,13 +608,13 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     E       assert 1 == 2
     E        +  where 1 = <class 'failure_demo.TestCustomAssertMsg.test_single_line.<locals>.A'>.a
 
-    failure_demo.py:261: AssertionError
+    failure_demo.py:262: AssertionError
     ____________________ TestCustomAssertMsg.test_multiline ____________________
 
     self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef>
 
         def test_multiline(self):
-            class A(object):
+            class A:
                 a = 1
 
             b = 2
@@ -626,13 +627,13 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     E       assert 1 == 2
     E        +  where 1 = <class 'failure_demo.TestCustomAssertMsg.test_multiline.<locals>.A'>.a
 
-    failure_demo.py:268: AssertionError
+    failure_demo.py:269: AssertionError
     ___________________ TestCustomAssertMsg.test_custom_repr ___________________
 
     self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef>
 
         def test_custom_repr(self):
-            class JSON(object):
+            class JSON:
                 a = 1
 
                 def __repr__(self):
@@ -648,5 +649,5 @@ Here is a nice run of several failures and how ``pytest`` presents things:
     E       assert 1 == 2
     E        +  where 1 = This is JSON\n{\n  'foo': 'bar'\n}.a
 
-    failure_demo.py:281: AssertionError
-    ======================== 44 failed in 0.12 seconds =========================
+    failure_demo.py:282: AssertionError
+    ============================ 44 failed in 0.12s ============================

doc/en/example/simple.rst

@@ -65,7 +65,7 @@ Let's run this without supplying our new option:
     test_sample.py:6: AssertionError
     --------------------------- Captured stdout call ---------------------------
     first
-    1 failed in 0.12 seconds
+    1 failed in 0.12s
 
 And now with supplying a command line option:
 
@@ -89,7 +89,7 @@ And now with supplying a command line option:
     test_sample.py:6: AssertionError
     --------------------------- Captured stdout call ---------------------------
     second
-    1 failed in 0.12 seconds
+    1 failed in 0.12s
 
 You can see that the command line option arrived in our test.  This
 completes the basic pattern.  However, one often rather wants to process
@@ -127,12 +127,12 @@ directory with the above conftest.py:
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 0 items
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
 
 .. _`excontrolskip`:
 
@@ -157,6 +157,10 @@ line option to control skipping of ``pytest.mark.slow`` marked tests:
         )
 
 
+    def pytest_configure(config):
+        config.addinivalue_line("markers", "slow: mark test as slow to run")
+
+
     def pytest_collection_modifyitems(config, items):
         if config.getoption("--runslow"):
             # --runslow given in cli: do not skip slow tests
@@ -188,16 +192,16 @@ and when running it will see a skipped "slow" test:
 
     $ pytest -rs    # "-rs" means report details on the little 's'
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 2 items
 
     test_module.py .s                                                    [100%]
+
     ========================= short test summary info ==========================
     SKIPPED [1] test_module.py:8: need --runslow option to run
-
-    =================== 1 passed, 1 skipped in 0.12 seconds ====================
+    ======================= 1 passed, 1 skipped in 0.12s =======================
 
 Or run it including the ``slow`` marked test:
 
@@ -205,14 +209,14 @@ Or run it including the ``slow`` marked test:
 
     $ pytest --runslow
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 2 items
 
     test_module.py ..                                                    [100%]
 
-    ========================= 2 passed in 0.12 seconds =========================
+    ============================ 2 passed in 0.12s =============================
 
 Writing well integrated assertion helpers
 --------------------------------------------------
@@ -234,7 +238,7 @@ Example:
     def checkconfig(x):
         __tracebackhide__ = True
         if not hasattr(x, "config"):
-            pytest.fail("not configured: %s" % (x,))
+            pytest.fail("not configured: {}".format(x))
 
 
     def test_something():
@@ -257,7 +261,7 @@ Let's run our little function:
     E       Failed: not configured: 42
 
     test_checkconfig.py:11: Failed
-    1 failed in 0.12 seconds
+    1 failed in 0.12s
 
 If you only want to hide certain exceptions, you can set ``__tracebackhide__``
 to a callable which gets the ``ExceptionInfo`` object. You can for example use
@@ -276,7 +280,7 @@ this to make sure unexpected exception types aren't hidden:
     def checkconfig(x):
         __tracebackhide__ = operator.methodcaller("errisinstance", ConfigException)
         if not hasattr(x, "config"):
-            raise ConfigException("not configured: %s" % (x,))
+            raise ConfigException("not configured: {}".format(x))
 
 
     def test_something():
@@ -296,36 +300,33 @@ behave differently if called from a test.  But if you
 absolutely must find out if your application code is
 running from a test you can do something like this:
 
+.. code-block:: python
+
+    # content of your_module.py
+
+
+    _called_from_test = False
+
 .. code-block:: python
 
     # content of conftest.py
 
 
     def pytest_configure(config):
-        import sys
+        your_module._called_from_test = True
 
-        sys._called_from_test = True
-
-
-    def pytest_unconfigure(config):
-        import sys
-
-        del sys._called_from_test
-
-and then check for the ``sys._called_from_test`` flag:
+and then check for the ``your_module._called_from_test`` flag:
 
 .. code-block:: python
 
-    if hasattr(sys, "_called_from_test"):
+    if your_module._called_from_test:
         # called from within a test run
         ...
     else:
         # called "normally"
         ...
 
-accordingly in your application.  It's also a good idea
-to use your own application module rather than ``sys``
-for handling flag.
+accordingly in your application.
 
 Adding info to test report header
 --------------------------------------------------------------
@@ -348,13 +349,13 @@ which will add the string to the test header accordingly:
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     project deps: mylib-1.1
     rootdir: $REGENDOC_TMPDIR
     collected 0 items
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
 
 .. regendoc:wipe
 
@@ -377,14 +378,14 @@ which will add info only when run with "--v":
 
     $ pytest -v
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.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
     collecting ... collected 0 items
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
 
 and nothing when run plainly:
 
@@ -392,12 +393,12 @@ and nothing when run plainly:
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 0 items
 
-    ======================= no tests ran in 0.12 seconds =======================
+    ========================== no tests ran in 0.12s ===========================
 
 profiling test duration
 --------------------------
@@ -432,7 +433,7 @@ Now we can profile which test functions execute the slowest:
 
     $ pytest --durations=3
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 3 items
@@ -442,8 +443,8 @@ Now we can profile which test functions execute the slowest:
     ========================= slowest 3 test durations =========================
     0.30s call     test_some_are_slow.py::test_funcslow2
     0.20s call     test_some_are_slow.py::test_funcslow1
-    0.10s call     test_some_are_slow.py::test_funcfast
-    ========================= 3 passed in 0.12 seconds =========================
+    0.11s call     test_some_are_slow.py::test_funcfast
+    ============================ 3 passed in 0.12s =============================
 
 incremental testing - test steps
 ---------------------------------------------------
@@ -474,7 +475,7 @@ an ``incremental`` marker which is to be used on classes:
         if "incremental" in item.keywords:
             previousfailed = getattr(item.parent, "_previousfailed", None)
             if previousfailed is not None:
-                pytest.xfail("previous test failed (%s)" % previousfailed.name)
+                pytest.xfail("previous test failed ({})".format(previousfailed.name))
 
 These two hook implementations work together to abort incremental-marked
 tests in a class.  Here is a test module example:
@@ -487,7 +488,7 @@ tests in a class.  Here is a test module example:
 
 
     @pytest.mark.incremental
-    class TestUserHandling(object):
+    class TestUserHandling:
         def test_login(self):
             pass
 
@@ -507,7 +508,7 @@ If we run this:
 
     $ pytest -rx
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 4 items
@@ -527,7 +528,7 @@ If we run this:
     ========================= short test summary info ==========================
     XFAIL test_step.py::TestUserHandling::test_deletion
       reason: previous test failed (test_modification)
-    ============== 1 failed, 2 passed, 1 xfailed in 0.12 seconds ===============
+    ================== 1 failed, 2 passed, 1 xfailed in 0.12s ==================
 
 We'll see that ``test_deletion`` was not executed because ``test_modification``
 failed.  It is reported as an "expected failure".
@@ -552,7 +553,7 @@ Here is an example for making a ``db`` fixture available in a directory:
     import pytest
 
 
-    class DB(object):
+    class DB:
         pass
 
 
@@ -591,7 +592,7 @@ We can run this:
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 7 items
@@ -606,7 +607,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, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
+    >       available fixtures: cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, monkeypatch, pytestconfig, record_property, record_testsuite_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
@@ -640,7 +641,7 @@ We can run this:
     E       assert 0
 
     a/test_db2.py:2: AssertionError
-    ========== 3 failed, 2 passed, 1 xfailed, 1 error in 0.12 seconds ==========
+    ============= 3 failed, 2 passed, 1 xfailed, 1 error in 0.12s ==============
 
 The two test modules in the ``a`` directory see the same ``db`` fixture instance
 while the one test in the sister-directory ``b`` doesn't see it.  We could of course
@@ -680,7 +681,7 @@ case we just write some information out to a ``failures`` file:
             with open("failures", mode) as f:
                 # let's also access a fixture for the fun of it
                 if "tmpdir" in item.fixturenames:
-                    extra = " (%s)" % item.funcargs["tmpdir"]
+                    extra = " ({})".format(item.funcargs["tmpdir"])
                 else:
                     extra = ""
 
@@ -705,7 +706,7 @@ and run them:
 
     $ pytest test_module.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 2 items
@@ -729,7 +730,7 @@ and run them:
     E       assert 0
 
     test_module.py:6: AssertionError
-    ========================= 2 failed in 0.12 seconds =========================
+    ============================ 2 failed in 0.12s =============================
 
 you will have a "failures" file which contains the failing test ids:
 
@@ -809,7 +810,7 @@ and run it:
 
     $ pytest -s test_module.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 3 items
@@ -844,7 +845,7 @@ and run it:
     E       assert 0
 
     test_module.py:19: AssertionError
-    ==================== 2 failed, 1 error in 0.12 seconds =====================
+    ======================== 2 failed, 1 error in 0.12s ========================
 
 You'll see that the fixture finalizers could use the precise reporting
 information.

doc/en/example/special.rst

@@ -5,30 +5,36 @@ A session-scoped fixture effectively has access to all
 collected test items.  Here is an example of a fixture
 function which walks all collected tests and looks
 if their test class defines a ``callme`` method and
-calls it::
+calls it:
+
+.. code-block:: python
 
     # content of conftest.py
 
     import pytest
 
+
     @pytest.fixture(scope="session", autouse=True)
     def callattr_ahead_of_alltests(request):
         print("callattr_ahead_of_alltests called")
-        seen = set([None])
+        seen = {None}
         session = request.node
         for item in session.items:
             cls = item.getparent(pytest.Class)
             if cls not in seen:
                 if hasattr(cls.obj, "callme"):
-                   cls.obj.callme()
+                    cls.obj.callme()
                 seen.add(cls)
 
 test classes may now define a ``callme`` method which
-will be called ahead of running any tests::
+will be called ahead of running any tests:
+
+.. code-block:: python
 
     # content of test_module.py
 
-    class TestHello(object):
+
+    class TestHello:
         @classmethod
         def callme(cls):
             print("callme called!")
@@ -39,16 +45,20 @@ will be called ahead of running any tests::
         def test_method2(self):
             print("test_method1 called")
 
-    class TestOther(object):
+
+    class TestOther:
         @classmethod
         def callme(cls):
             print("callme other called")
+
         def test_other(self):
             print("test other")
 
+
     # works with unittest as well ...
     import unittest
 
+
     class SomeTest(unittest.TestCase):
         @classmethod
         def callme(self):
@@ -71,4 +81,4 @@ If you run this without output capturing:
     .test other
     .test_unit1 method called
     .
-    4 passed in 0.12 seconds
+    4 passed in 0.12s

doc/en/existingtestsuite.rst

@@ -15,7 +15,9 @@ Running an existing test suite with pytest
 Say you want to contribute to an existing repository somewhere.
 After pulling the code into your development space using some
 flavor of version control and (optionally) setting up a virtualenv
-you will want to run::
+you will want to run:
+
+.. code-block:: bash
 
     cd <repository>
     pip install -e .  # Environment dependent alternatives include

doc/en/fixture.rst

@@ -49,20 +49,25 @@ argument. For each argument name, a fixture function with that name provides
 the fixture object.  Fixture functions are registered by marking them with
 :py:func:`@pytest.fixture <_pytest.python.fixture>`.  Let's look at a simple
 self-contained test module containing a fixture and a test function
-using it::
+using it:
+
+.. code-block:: python
 
     # content of ./test_smtpsimple.py
     import pytest
 
+
     @pytest.fixture
     def smtp_connection():
         import smtplib
+
         return smtplib.SMTP("smtp.gmail.com", 587, timeout=5)
 
+
     def test_ehlo(smtp_connection):
         response, msg = smtp_connection.ehlo()
         assert response == 250
-        assert 0 # for demo purposes
+        assert 0  # for demo purposes
 
 Here, the ``test_ehlo`` needs the ``smtp_connection`` fixture value.  pytest
 will discover and call the :py:func:`@pytest.fixture <_pytest.python.fixture>`
@@ -72,7 +77,7 @@ marked ``smtp_connection`` fixture function.  Running the test looks like this:
 
     $ pytest test_smtpsimple.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 1 item
@@ -87,11 +92,11 @@ marked ``smtp_connection`` fixture function.  Running the test looks like this:
         def test_ehlo(smtp_connection):
             response, msg = smtp_connection.ehlo()
             assert response == 250
-    >       assert 0 # for demo purposes
+    >       assert 0  # for demo purposes
     E       assert 0
 
-    test_smtpsimple.py:11: AssertionError
-    ========================= 1 failed in 0.12 seconds =========================
+    test_smtpsimple.py:14: AssertionError
+    ============================ 1 failed in 0.12s =============================
 
 In the failure traceback we see that the test function was called with a
 ``smtp_connection`` argument, the ``smtplib.SMTP()`` instance created by the fixture
@@ -180,12 +185,15 @@ Possible values for ``scope`` are: ``function``, ``class``, ``module``, ``packag
 
 The next example puts the fixture function into a separate ``conftest.py`` file
 so that tests from multiple test modules in the directory can
-access the fixture function::
+access the fixture function:
+
+.. code-block:: python
 
     # content of conftest.py
     import pytest
     import smtplib
 
+
     @pytest.fixture(scope="module")
     def smtp_connection():
         return smtplib.SMTP("smtp.gmail.com", 587, timeout=5)
@@ -193,16 +201,20 @@ access the fixture function::
 The name of the fixture again is ``smtp_connection`` and you can access its
 result by listing the name ``smtp_connection`` as an input parameter in any
 test or fixture function (in or below the directory where ``conftest.py`` is
-located)::
+located):
+
+.. code-block:: python
 
     # content of test_module.py
 
+
     def test_ehlo(smtp_connection):
         response, msg = smtp_connection.ehlo()
         assert response == 250
         assert b"smtp.gmail.com" in msg
         assert 0  # for demo purposes
 
+
     def test_noop(smtp_connection):
         response, msg = smtp_connection.noop()
         assert response == 250
@@ -215,7 +227,7 @@ inspect what is going on and can now run the tests:
 
     $ pytest test_module.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 2 items
@@ -234,7 +246,7 @@ inspect what is going on and can now run the tests:
     >       assert 0  # for demo purposes
     E       assert 0
 
-    test_module.py:6: AssertionError
+    test_module.py:7: AssertionError
     ________________________________ test_noop _________________________________
 
     smtp_connection = <smtplib.SMTP object at 0xdeadbeef>
@@ -245,8 +257,8 @@ inspect what is going on and can now run the tests:
     >       assert 0  # for demo purposes
     E       assert 0
 
-    test_module.py:11: AssertionError
-    ========================= 2 failed in 0.12 seconds =========================
+    test_module.py:13: AssertionError
+    ============================ 2 failed in 0.12s =============================
 
 You see the two ``assert 0`` failing and more importantly you can also see
 that the same (module-scoped) ``smtp_connection`` object was passed into the
@@ -289,51 +301,59 @@ are finalized when the last test of a *package* finishes.
     Use this new feature sparingly and please make sure to report any issues you find.
 
 
-Higher-scoped fixtures are instantiated first
----------------------------------------------
+.. _dynamic scope:
+
+Dynamic scope
+^^^^^^^^^^^^^
+
+.. versionadded:: 5.2
+
+In some cases, you might want to change the scope of the fixture without changing the code.
+To do that, pass a callable to ``scope``. The callable must return a string with a valid scope
+and will be executed only once - during the fixture definition. It will be called with two
+keyword arguments - ``fixture_name`` as a string and ``config`` with a configuration object.
+
+This can be especially useful when dealing with fixtures that need time for setup, like spawning
+a docker container. You can use the command-line argument to control the scope of the spawned
+containers for different environments. See the example below.
+
+.. code-block:: python
+
+    def determine_scope(fixture_name, config):
+        if config.getoption("--keep-containers"):
+            return "session"
+        return "function"
+
+
+    @pytest.fixture(scope=determine_scope)
+    def docker_container():
+        yield spawn_container()
+
+
+
+Order: Higher-scoped fixtures are instantiated first
+----------------------------------------------------
 
 
 
 Within a function request for features, fixture of higher-scopes (such as ``session``) are instantiated first than
 lower-scoped fixtures (such as ``function`` or ``class``). The relative order of fixtures of same scope follows
-the declared order in the test function and honours dependencies between fixtures.
+the declared order in the test function and honours dependencies between fixtures. Autouse fixtures will be
+instantiated before explicitly used fixtures.
 
 Consider the code below:
 
-.. code-block:: python
+.. literalinclude:: example/fixtures/test_fixtures_order.py
 
-    @pytest.fixture(scope="session")
-    def s1():
-        pass
-
-
-    @pytest.fixture(scope="module")
-    def m1():
-        pass
-
-
-    @pytest.fixture
-    def f1(tmpdir):
-        pass
-
-
-    @pytest.fixture
-    def f2():
-        pass
-
-
-    def test_foo(f1, m1, f2, s1):
-        ...
-
-
-The fixtures requested by ``test_foo`` will be instantiated in the following order:
+The fixtures requested by ``test_order`` will be instantiated in the following order:
 
 1. ``s1``: is the highest-scoped fixture (``session``).
 2. ``m1``: is the second highest-scoped fixture (``module``).
-3. ``tmpdir``: is a ``function``-scoped fixture, required by ``f1``: it needs to be instantiated at this point
-   because it is a dependency of ``f1``.
-4. ``f1``: is the first ``function``-scoped fixture in ``test_foo`` parameter list.
-5. ``f2``: is the last ``function``-scoped fixture in ``test_foo`` parameter list.
+3. ``a1``: is a ``function``-scoped ``autouse`` fixture: it will be instantiated before other fixtures
+   within the same scope.
+4. ``f3``: is a ``function``-scoped fixture, required by ``f1``: it needs to be instantiated at this point
+5. ``f1``: is the first ``function``-scoped fixture in ``test_order`` parameter list.
+6. ``f2``: is the last ``function``-scoped fixture in ``test_order`` parameter list.
 
 
 .. _`finalization`:
@@ -371,7 +391,7 @@ Let's execute it:
     $ pytest -s -q --tb=no
     FFteardown smtp
 
-    2 failed in 0.12 seconds
+    2 failed in 0.12s
 
 We see that the ``smtp_connection`` instance is finalized after the two
 tests finished execution.  Note that if we decorated our fixture
@@ -400,6 +420,34 @@ The ``smtp_connection`` connection will be closed after the test finished
 execution because the ``smtp_connection`` object automatically closes when
 the ``with`` statement ends.
 
+Using the contextlib.ExitStack context manager finalizers will always be called
+regardless if the fixture *setup* code raises an exception. This is handy to properly
+close all resources created by a fixture even if one of them fails to be created/acquired:
+
+.. code-block:: python
+
+    # content of test_yield3.py
+
+    import contextlib
+
+    import pytest
+
+
+    @contextlib.contextmanager
+    def connect(port):
+        ...  # create connection
+        yield
+        ...  # close connection
+
+
+    @pytest.fixture
+    def equipments():
+        with contextlib.ExitStack() as stack:
+            yield [stack.enter_context(connect(port)) for port in ("C1", "C3", "C28")]
+
+In the example above, if ``"C28"`` fails with an exception, ``"C1"`` and ``"C3"`` will still
+be properly closed.
+
 Note that if an exception happens during the *setup* code (before the ``yield`` keyword), the
 *teardown* code (after the ``yield``) will not be called.
 
@@ -428,27 +476,39 @@ Here's the ``smtp_connection`` fixture changed to use ``addfinalizer`` for clean
         return smtp_connection  # provide the fixture value
 
 
+Here's the ``equipments`` fixture changed to use ``addfinalizer`` for cleanup:
+
+.. code-block:: python
+
+    # content of test_yield3.py
+
+    import contextlib
+    import functools
+
+    import pytest
+
+
+    @contextlib.contextmanager
+    def connect(port):
+        ...  # create connection
+        yield
+        ...  # close connection
+
+
+    @pytest.fixture
+    def equipments(request):
+        r = []
+        for port in ("C1", "C3", "C28"):
+            cm = connect(port)
+            equip = cm.__enter__()
+            request.addfinalizer(functools.partial(cm.__exit__, None, None, None))
+            r.append(equip)
+        return r
+
+
 Both ``yield`` and ``addfinalizer`` methods work similarly by calling their code after the test
-ends, but ``addfinalizer`` has two key differences over ``yield``:
-
-1. It is possible to register multiple finalizer functions.
-
-2. Finalizers will always be called regardless if the fixture *setup* code raises an exception.
-   This is handy to properly close all resources created by a fixture even if one of them
-   fails to be created/acquired::
-
-        @pytest.fixture
-        def equipments(request):
-            r = []
-            for port in ('C1', 'C3', 'C28'):
-                equip = connect(port)
-                request.addfinalizer(equip.disconnect)
-                r.append(equip)
-            return r
-
-   In the example above, if ``"C28"`` fails with an exception, ``"C1"`` and ``"C3"`` will still
-   be properly closed. Of course, if an exception happens before the finalize function is
-   registered then it will not be executed.
+ends. Of course, if an exception happens before the finalize function is registered then it
+will not be executed.
 
 
 .. _`request-context`:
@@ -459,18 +519,21 @@ Fixtures can introspect the requesting test context
 Fixture functions can accept the :py:class:`request <FixtureRequest>` object
 to introspect the "requesting" test function, class or module context.
 Further extending the previous ``smtp_connection`` fixture example, let's
-read an optional server URL from the test module which uses our fixture::
+read an optional server URL from the test module which uses our fixture:
+
+.. code-block:: python
 
     # content of conftest.py
     import pytest
     import smtplib
 
+
     @pytest.fixture(scope="module")
     def smtp_connection(request):
         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 {} ({})".format(smtp_connection, server))
         smtp_connection.close()
 
 We use the ``request.module`` attribute to optionally obtain an
@@ -482,15 +545,18 @@ again, nothing much has changed:
     $ pytest -s -q --tb=no
     FFfinalizing <smtplib.SMTP object at 0xdeadbeef> (smtp.gmail.com)
 
-    2 failed in 0.12 seconds
+    2 failed in 0.12s
 
 Let's quickly create another test module that actually sets the
-server URL in its module namespace::
+server URL in its module namespace:
+
+.. code-block:: python
 
     # content of test_anothersmtp.py
 
     smtpserver = "mail.python.org"  # will be read by smtp fixture
 
+
     def test_showhelo(smtp_connection):
         assert 0, smtp_connection.helo()
 
@@ -502,7 +568,7 @@ Running it:
     F                                                                    [100%]
     ================================= FAILURES =================================
     ______________________________ test_showhelo _______________________________
-    test_anothersmtp.py:5: in test_showhelo
+    test_anothersmtp.py:6: in test_showhelo
         assert 0, smtp_connection.helo()
     E   AssertionError: (250, b'mail.python.org')
     E   assert 0
@@ -522,16 +588,14 @@ of a fixture is needed multiple times in a single test. Instead of returning
 data directly, the fixture instead returns a function which generates the data.
 This function can then be called multiple times in the test.
 
-Factories can have have parameters as needed::
+Factories can have parameters as needed:
+
+.. code-block:: python
 
     @pytest.fixture
     def make_customer_record():
-
         def _make_customer_record(name):
-            return {
-                "name": name,
-                "orders": []
-            }
+            return {"name": name, "orders": []}
 
         return _make_customer_record
 
@@ -541,7 +605,9 @@ Factories can have have parameters as needed::
         customer_2 = make_customer_record("Mike")
         customer_3 = make_customer_record("Meredith")
 
-If the data created by the factory requires managing, the fixture can take care of that::
+If the data created by the factory requires managing, the fixture can take care of that:
+
+.. code-block:: python
 
     @pytest.fixture
     def make_customer_record():
@@ -580,18 +646,20 @@ configured in multiple ways.
 Extending the previous example, we can flag the fixture to create two
 ``smtp_connection`` fixture instances which will cause all tests using the fixture
 to run twice.  The fixture function gets access to each parameter
-through the special :py:class:`request <FixtureRequest>` object::
+through the special :py:class:`request <FixtureRequest>` object:
+
+.. code-block:: python
 
     # content of conftest.py
     import pytest
     import smtplib
 
-    @pytest.fixture(scope="module",
-                    params=["smtp.gmail.com", "mail.python.org"])
+
+    @pytest.fixture(scope="module", params=["smtp.gmail.com", "mail.python.org"])
     def smtp_connection(request):
         smtp_connection = smtplib.SMTP(request.param, 587, timeout=5)
         yield smtp_connection
-        print("finalizing %s" % smtp_connection)
+        print("finalizing {}".format(smtp_connection))
         smtp_connection.close()
 
 The main change is the declaration of ``params`` with
@@ -616,7 +684,7 @@ So let's just do another run:
     >       assert 0  # for demo purposes
     E       assert 0
 
-    test_module.py:6: AssertionError
+    test_module.py:7: AssertionError
     ________________________ test_noop[smtp.gmail.com] _________________________
 
     smtp_connection = <smtplib.SMTP object at 0xdeadbeef>
@@ -627,7 +695,7 @@ So let's just do another run:
     >       assert 0  # for demo purposes
     E       assert 0
 
-    test_module.py:11: AssertionError
+    test_module.py:13: AssertionError
     ________________________ test_ehlo[mail.python.org] ________________________
 
     smtp_connection = <smtplib.SMTP object at 0xdeadbeef>
@@ -638,7 +706,7 @@ So let's just do another run:
     >       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\nCHUNKING'
 
-    test_module.py:5: AssertionError
+    test_module.py:6: AssertionError
     -------------------------- Captured stdout setup ---------------------------
     finalizing <smtplib.SMTP object at 0xdeadbeef>
     ________________________ test_noop[mail.python.org] ________________________
@@ -651,10 +719,10 @@ So let's just do another run:
     >       assert 0  # for demo purposes
     E       assert 0
 
-    test_module.py:11: AssertionError
+    test_module.py:13: AssertionError
     ------------------------- Captured stdout teardown -------------------------
     finalizing <smtplib.SMTP object at 0xdeadbeef>
-    4 failed in 0.12 seconds
+    4 failed in 0.12s
 
 We see that our two test functions each ran twice, against the different
 ``smtp_connection`` instances.  Note also, that with the ``mail.python.org``
@@ -672,28 +740,35 @@ Numbers, strings, booleans and None will have their usual string
 representation used in the test ID. For other objects, pytest will
 make a string based on the argument name.  It is possible to customise
 the string used in a test ID for a certain fixture value by using the
-``ids`` keyword argument::
+``ids`` keyword argument:
+
+.. code-block:: python
 
    # content of test_ids.py
    import pytest
 
+
    @pytest.fixture(params=[0, 1], ids=["spam", "ham"])
    def a(request):
        return request.param
 
+
    def test_a(a):
        pass
 
+
    def idfn(fixture_value):
        if fixture_value == 0:
            return "eggs"
        else:
            return None
 
+
    @pytest.fixture(params=[0, 1], ids=idfn)
    def b(request):
        return request.param
 
+
    def test_b(b):
        pass
 
@@ -708,7 +783,7 @@ Running the above tests results in the following test IDs being used:
 
    $ pytest --collect-only
    =========================== test session starts ============================
-   platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+   platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
    cachedir: $PYTHON_PREFIX/.pytest_cache
    rootdir: $REGENDOC_TMPDIR
    collected 10 items
@@ -726,7 +801,7 @@ Running the above tests results in the following test IDs being used:
      <Function test_ehlo[mail.python.org]>
      <Function test_noop[mail.python.org]>
 
-   ======================= no tests ran in 0.12 seconds =======================
+   ========================== no tests ran in 0.12s ===========================
 
 .. _`fixture-parametrize-marks`:
 
@@ -736,14 +811,19 @@ Using marks with parametrized fixtures
 :func:`pytest.param` can be used to apply marks in values sets of parametrized fixtures in the same way
 that they can be used with :ref:`@pytest.mark.parametrize <@pytest.mark.parametrize>`.
 
-Example::
+Example:
+
+.. code-block:: python
 
     # content of test_fixture_marks.py
     import pytest
+
+
     @pytest.fixture(params=[0, 1, pytest.param(2, marks=pytest.mark.skip)])
     def data_set(request):
         return request.param
 
+
     def test_data(data_set):
         pass
 
@@ -753,7 +833,7 @@ Running this test will *skip* the invocation of ``data_set`` with value ``2``:
 
     $ pytest test_fixture_marks.py -v
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 3 items
@@ -762,7 +842,7 @@ Running this test will *skip* the invocation of ``data_set`` with value ``2``:
     test_fixture_marks.py::test_data[1] PASSED                           [ 66%]
     test_fixture_marks.py::test_data[2] SKIPPED                          [100%]
 
-    =================== 2 passed, 1 skipped in 0.12 seconds ====================
+    ======================= 2 passed, 1 skipped in 0.12s =======================
 
 .. _`interdependent fixtures`:
 
@@ -774,20 +854,25 @@ can use other fixtures themselves.  This contributes to a modular design
 of your fixtures and allows re-use of framework-specific fixtures across
 many projects.  As a simple example, we can extend the previous example
 and instantiate an object ``app`` where we stick the already defined
-``smtp_connection`` resource into it::
+``smtp_connection`` resource into it:
+
+.. code-block:: python
 
     # content of test_appsetup.py
 
     import pytest
 
-    class App(object):
+
+    class App:
         def __init__(self, smtp_connection):
             self.smtp_connection = smtp_connection
 
+
     @pytest.fixture(scope="module")
     def app(smtp_connection):
         return App(smtp_connection)
 
+
     def test_smtp_connection_exists(app):
         assert app.smtp_connection
 
@@ -798,7 +883,7 @@ Here we declare an ``app`` fixture which receives the previously defined
 
     $ pytest -v test_appsetup.py
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 2 items
@@ -806,7 +891,7 @@ Here we declare an ``app`` fixture which receives the previously defined
     test_appsetup.py::test_smtp_connection_exists[smtp.gmail.com] PASSED [ 50%]
     test_appsetup.py::test_smtp_connection_exists[mail.python.org] PASSED [100%]
 
-    ========================= 2 passed in 0.12 seconds =========================
+    ============================ 2 passed in 0.12s =============================
 
 Due to the parametrization of ``smtp_connection``, the test will run twice with two
 different ``App`` instances and respective smtp servers.  There is no
@@ -836,31 +921,40 @@ this eases testing of applications which create and use global state.
 
 The following example uses two parametrized fixtures, one of which is
 scoped on a per-module basis, and all the functions perform ``print`` calls
-to show the setup/teardown flow::
+to show the setup/teardown flow:
+
+.. code-block:: python
 
     # content of test_module.py
     import pytest
 
+
     @pytest.fixture(scope="module", params=["mod1", "mod2"])
     def modarg(request):
         param = request.param
-        print("  SETUP modarg %s" % param)
+        print("  SETUP modarg", param)
         yield param
-        print("  TEARDOWN modarg %s" % param)
+        print("  TEARDOWN modarg", param)
 
-    @pytest.fixture(scope="function", params=[1,2])
+
+    @pytest.fixture(scope="function", params=[1, 2])
     def otherarg(request):
         param = request.param
-        print("  SETUP otherarg %s" % param)
+        print("  SETUP otherarg", param)
         yield param
-        print("  TEARDOWN otherarg %s" % param)
+        print("  TEARDOWN otherarg", param)
+
 
     def test_0(otherarg):
-        print("  RUN test0 with otherarg %s" % otherarg)
+        print("  RUN test0 with otherarg", otherarg)
+
+
     def test_1(modarg):
-        print("  RUN test1 with modarg %s" % modarg)
+        print("  RUN test1 with modarg", modarg)
+
+
     def test_2(otherarg, modarg):
-        print("  RUN test2 with otherarg %s and modarg %s" % (otherarg, modarg))
+        print("  RUN test2 with otherarg {} and modarg {}".format(otherarg, modarg))
 
 
 Let's run the tests in verbose mode and with looking at the print-output:
@@ -869,7 +963,7 @@ Let's run the tests in verbose mode and with looking at the print-output:
 
     $ pytest -v -s test_module.py
     =========================== 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
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collecting ... collected 8 items
@@ -907,7 +1001,7 @@ Let's run the tests in verbose mode and with looking at the print-output:
       TEARDOWN modarg mod2
 
 
-    ========================= 8 passed in 0.12 seconds =========================
+    ============================ 8 passed in 0.12s =============================
 
 You can see that the parametrized module-scoped ``modarg`` resource caused an
 ordering of test execution that lead to the fewest possible "active" resources.
@@ -935,7 +1029,9 @@ current working directory but otherwise do not care for the concrete
 directory.  Here is how you can use the standard `tempfile
 <http://docs.python.org/library/tempfile.html>`_ and pytest fixtures to
 achieve it.  We separate the creation of the fixture into a conftest.py
-file::
+file:
+
+.. code-block:: python
 
     # content of conftest.py
 
@@ -943,19 +1039,23 @@ file::
     import tempfile
     import os
 
+
     @pytest.fixture()
     def cleandir():
         newpath = tempfile.mkdtemp()
         os.chdir(newpath)
 
-and declare its use in a test module via a ``usefixtures`` marker::
+and declare its use in a test module via a ``usefixtures`` marker:
+
+.. code-block:: python
 
     # content of test_setenv.py
     import os
     import pytest
 
+
     @pytest.mark.usefixtures("cleandir")
-    class TestDirectoryInit(object):
+    class TestDirectoryInit:
         def test_cwd_starts_empty(self):
             assert os.listdir(os.getcwd()) == []
             with open("myfile", "w") as f:
@@ -973,7 +1073,7 @@ to verify our fixture is activated and the tests pass:
 
     $ pytest -q
     ..                                                                   [100%]
-    2 passed in 0.12 seconds
+    2 passed in 0.12s
 
 You can specify multiple fixtures like this:
 
@@ -1032,25 +1132,32 @@ without declaring a function argument explicitly or a `usefixtures`_ decorator.
 As a practical example, suppose we have a database fixture which has a
 begin/rollback/commit architecture and we want to automatically surround
 each test method by a transaction and a rollback.  Here is a dummy
-self-contained implementation of this idea::
+self-contained implementation of this idea:
+
+.. code-block:: python
 
     # content of test_db_transact.py
 
     import pytest
 
-    class DB(object):
+
+    class DB:
         def __init__(self):
             self.intransaction = []
+
         def begin(self, name):
             self.intransaction.append(name)
+
         def rollback(self):
             self.intransaction.pop()
 
+
     @pytest.fixture(scope="module")
     def db():
         return DB()
 
-    class TestClass(object):
+
+    class TestClass:
         @pytest.fixture(autouse=True)
         def transact(self, request, db):
             db.begin(request.function.__name__)
@@ -1074,7 +1181,7 @@ If we run it, we get two passing tests:
 
     $ pytest -q
     ..                                                                   [100%]
-    2 passed in 0.12 seconds
+    2 passed in 0.12s
 
 Here is how autouse fixtures work in other scopes:
 
@@ -1098,7 +1205,9 @@ Here is how autouse fixtures work in other scopes:
 Note that the above ``transact`` fixture may very well be a fixture that
 you want to make available in your project without having it generally
 active.  The canonical way to do that is to put the transact definition
-into a conftest.py file **without** using ``autouse``::
+into a conftest.py file **without** using ``autouse``:
+
+.. code-block:: python
 
     # content of conftest.py
     @pytest.fixture
@@ -1107,10 +1216,12 @@ into a conftest.py file **without** using ``autouse``::
         yield
         db.rollback()
 
-and then e.g. have a TestClass using it by declaring the need::
+and then e.g. have a TestClass using it by declaring the need:
+
+.. code-block:: python
 
     @pytest.mark.usefixtures("transact")
-    class TestClass(object):
+    class TestClass:
         def test_method1(self):
             ...
 
@@ -1179,6 +1290,8 @@ Given the tests file structure is:
 
         conftest.py
             # content of tests/conftest.py
+            import pytest
+
             @pytest.fixture
             def username():
                 return 'username'

doc/en/flaky.rst

@@ -122,4 +122,4 @@ Resources
 * 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
+  * `Where do Google's flaky tests come from? <https://testing.googleblog.com/2017/04/where-do-our-flaky-tests-come-from.html>`_  by Jeff Listfield, 2017

doc/en/funcarg_compare.rst

@@ -21,19 +21,23 @@ funcarg for a test function is required.  If a factory wants to
 re-use a resource across different scopes, it often used
 the ``request.cached_setup()`` helper to manage caching of
 resources.  Here is a basic example how we could implement
-a per-session Database object::
+a per-session Database object:
+
+.. code-block:: python
 
     # content of conftest.py
-    class Database(object):
+    class Database:
         def __init__(self):
             print("database instance created")
+
         def destroy(self):
             print("database instance destroyed")
 
+
     def pytest_funcarg__db(request):
-        return request.cached_setup(setup=DataBase,
-                                    teardown=lambda db: db.destroy,
-                                    scope="session")
+        return request.cached_setup(
+            setup=DataBase, teardown=lambda db: db.destroy, scope="session"
+        )
 
 There are several limitations and difficulties with this approach:
 
@@ -68,7 +72,9 @@ Direct scoping of fixture/funcarg factories
 
 Instead of calling cached_setup() with a cache scope, you can use the
 :ref:`@pytest.fixture <pytest.fixture>` decorator and directly state
-the scope::
+the scope:
+
+.. code-block:: python
 
     @pytest.fixture(scope="session")
     def db(request):
@@ -90,11 +96,13 @@ Previously, funcarg factories could not directly cause parametrization.
 You needed to specify a ``@parametrize`` decorator on your test function
 or implement a ``pytest_generate_tests`` hook to perform
 parametrization, i.e. calling a test multiple times with different value
-sets.  pytest-2.3 introduces a decorator for use on the factory itself::
+sets.  pytest-2.3 introduces a decorator for use on the factory itself:
+
+.. code-block:: python
 
     @pytest.fixture(params=["mysql", "pg"])
     def db(request):
-        ... # use request.param
+        ...  # use request.param
 
 Here the factory will be invoked twice (with the respective "mysql"
 and "pg" values set as ``request.param`` attributes) and all of
@@ -107,7 +115,9 @@ allow to re-use already written factories because effectively
 parametrized via
 :py:func:`~_pytest.python.Metafunc.parametrize(indirect=True)` calls.
 
-Of course it's perfectly fine to combine parametrization and scoping::
+Of course it's perfectly fine to combine parametrization and scoping:
+
+.. code-block:: python
 
     @pytest.fixture(scope="session", params=["mysql", "pg"])
     def db(request):
@@ -128,7 +138,9 @@ No ``pytest_funcarg__`` prefix when using @fixture decorator
 
 When using the ``@fixture`` decorator the name of the function
 denotes the name under which the resource can be accessed as a function
-argument::
+argument:
+
+.. code-block:: python
 
     @pytest.fixture()
     def db(request):
@@ -137,7 +149,9 @@ argument::
 The name under which the funcarg resource can be requested is ``db``.
 
 You can still use the "old" non-decorator way of specifying funcarg factories
-aka::
+aka:
+
+.. code-block:: python
 
     def pytest_funcarg__db(request):
         ...

doc/en/getting-started.rst

@@ -1,9 +1,9 @@
 Installation and Getting Started
 ===================================
 
-**Pythons**: Python 2.7, 3.4, 3.5, 3.6, 3.7, Jython, PyPy-2.3
+**Pythons**: Python 3.5, 3.6, 3.7, PyPy3
 
-**Platforms**: Unix/Posix and Windows
+**Platforms**: Linux and Windows
 
 **PyPI package name**: `pytest <https://pypi.org/project/pytest/>`_
 
@@ -28,19 +28,22 @@ Install ``pytest``
 .. code-block:: bash
 
     $ pytest --version
-    This is pytest version 4.x.y, imported from $PYTHON_PREFIX/lib/python3.6/site-packages/pytest.py
+    This is pytest version 5.x.y, imported from $PYTHON_PREFIX/lib/python3.6/site-packages/pytest.py
 
 .. _`simpletest`:
 
 Create your first test
 ----------------------------------------------------------
 
-Create a simple test function with just four lines of code::
+Create a simple test function with just four lines of code:
+
+.. code-block:: python
 
     # content of test_sample.py
     def func(x):
         return x + 1
 
+
     def test_answer():
         assert func(3) == 5
 
@@ -50,7 +53,7 @@ That’s it. You can now execute the test function:
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 1 item
@@ -65,8 +68,8 @@ That’s it. You can now execute the test function:
     E       assert 4 == 5
     E        +  where 4 = func(3)
 
-    test_sample.py:5: AssertionError
-    ========================= 1 failed in 0.12 seconds =========================
+    test_sample.py:6: AssertionError
+    ============================ 1 failed in 0.12s =============================
 
 This test returns a failure report because ``func(3)`` does not return ``5``.
 
@@ -83,13 +86,18 @@ Run multiple tests
 Assert that a certain exception is raised
 --------------------------------------------------------------
 
-Use the :ref:`raises <assertraises>` helper to assert that some code raises an exception::
+Use the :ref:`raises <assertraises>` helper to assert that some code raises an exception:
+
+.. code-block:: python
 
     # content of test_sysexit.py
     import pytest
+
+
     def f():
         raise SystemExit(1)
 
+
     def test_mytest():
         with pytest.raises(SystemExit):
             f()
@@ -100,22 +108,24 @@ Execute the test function with “quiet” reporting mode:
 
     $ pytest -q test_sysexit.py
     .                                                                    [100%]
-    1 passed in 0.12 seconds
+    1 passed in 0.12s
 
 Group multiple tests in a class
 --------------------------------------------------------------
 
-Once you develop multiple tests, you may want to group them into a class. pytest makes it easy to create a class containing more than one test::
+Once you develop multiple tests, you may want to group them into a class. pytest makes it easy to create a class containing more than one test:
+
+.. code-block:: python
 
     # content of test_class.py
-    class TestClass(object):
+    class TestClass:
         def test_one(self):
             x = "this"
-            assert 'h' in x
+            assert "h" in x
 
         def test_two(self):
             x = "hello"
-            assert hasattr(x, 'check')
+            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:
 
@@ -130,19 +140,21 @@ Once you develop multiple tests, you may want to group them into a class. pytest
 
         def test_two(self):
             x = "hello"
-    >       assert hasattr(x, 'check')
+    >       assert hasattr(x, "check")
     E       AssertionError: assert False
     E        +  where False = hasattr('hello', 'check')
 
     test_class.py:8: AssertionError
-    1 failed, 1 passed in 0.12 seconds
+    1 failed, 1 passed in 0.12s
 
 The first test passed and the second failed. You can easily see the intermediate values in the assertion to help you understand the reason for the failure.
 
 Request a unique temporary directory for functional tests
 --------------------------------------------------------------
 
-``pytest`` provides `Builtin fixtures/function arguments <https://docs.pytest.org/en/latest/builtin.html#builtinfixtures>`_ to request arbitrary resources, like a unique temporary directory::
+``pytest`` provides `Builtin fixtures/function arguments <https://docs.pytest.org/en/latest/builtin.html>`_ to request arbitrary resources, like a unique temporary directory:
+
+.. code-block:: python
 
     # content of test_tmpdir.py
     def test_needsfiles(tmpdir):
@@ -168,7 +180,7 @@ List the name ``tmpdir`` in the test function signature and ``pytest`` will look
     test_tmpdir.py:3: AssertionError
     --------------------------- Captured stdout call ---------------------------
     PYTEST_TMPDIR/test_needsfiles0
-    1 failed in 0.12 seconds
+    1 failed in 0.12s
 
 More info on tmpdir handling is available at :ref:`Temporary directories and files <tmpdir handling>`.
 

doc/en/goodpractices.rst

@@ -7,19 +7,22 @@ Good Integration Practices
 Install package with pip
 -------------------------------------------------
 
-For development, we recommend you use venv_ for virtual environments
-(or virtualenv_ for Python 2.7) and
+For development, we recommend you use venv_ for virtual environments and
 pip_ for installing your application and any dependencies,
 as well as the ``pytest`` package itself.
 This ensures your code and dependencies are isolated from your system Python installation.
 
-Next, place a ``setup.py`` file in the root of your package with the following minimum content::
+Next, place a ``setup.py`` file in the root of your package with the following minimum content:
+
+.. code-block:: python
 
     from setuptools import setup, find_packages
 
     setup(name="PACKAGENAME", packages=find_packages())
 
-Where ``PACKAGENAME`` is the name of your package. You can then install your package in "editable" mode by running from the same directory::
+Where ``PACKAGENAME`` is the name of your package. You can then install your package in "editable" mode by running from the same directory:
+
+.. code-block:: bash
 
      pip install -e .
 
@@ -61,7 +64,9 @@ Tests outside application code
 
 Putting tests into an extra directory outside your actual application code
 might be useful if you have many functional tests or for other reasons want
-to keep tests separate from actual application code (often a good idea)::
+to keep tests separate from actual application code (often a good idea):
+
+.. code-block:: text
 
     setup.py
     mypkg/
@@ -83,7 +88,7 @@ This has the following benefits:
 
 .. note::
 
-    See :ref:`pythonpath` for more information about the difference between calling ``pytest`` and
+    See :ref:`pytest vs python -m pytest` 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
@@ -93,7 +98,9 @@ be imported as ``test_app`` and ``test_view`` top-level modules by adding ``test
 ``sys.path``.
 
 If you need to have test modules with the same name, you might add ``__init__.py`` files to your
-``tests`` folder and subfolders, changing them to packages::
+``tests`` folder and subfolders, changing them to packages:
+
+.. code-block:: text
 
     setup.py
     mypkg/
@@ -115,7 +122,9 @@ This is problematic if you are using a tool like `tox`_ to test your package in
 because you want to test the *installed* version of your package, not the local code from the repository.
 
 In this situation, it is **strongly** suggested to use a ``src`` layout where application root package resides in a
-sub-directory of your root::
+sub-directory of your root:
+
+.. code-block:: text
 
     setup.py
     src/
@@ -141,7 +150,9 @@ Tests as part of application code
 
 Inlining test directories into your application package
 is useful if you have direct relation between tests and application modules and
-want to distribute them along with your application::
+want to distribute them along with your application:
+
+.. code-block:: text
 
     setup.py
     mypkg/
@@ -154,7 +165,9 @@ want to distribute them along with your application::
             test_view.py
             ...
 
-In this scheme, it is easy to run your tests using the ``--pyargs`` option::
+In this scheme, it is easy to run your tests using the ``--pyargs`` option:
+
+.. code-block:: bash
 
     pytest --pyargs mypkg
 
@@ -220,101 +233,4 @@ against your source code checkout, helping to detect packaging
 glitches.
 
 
-Integrating with setuptools / ``python setup.py test`` / ``pytest-runner``
---------------------------------------------------------------------------
-
-You can integrate test runs into your setuptools based project
-with the `pytest-runner <https://pypi.org/project/pytest-runner/>`_ plugin.
-
-Add this to ``setup.py`` file:
-
-.. code-block:: python
-
-    from setuptools import setup
-
-    setup(
-        # ...,
-        setup_requires=["pytest-runner", ...],
-        tests_require=["pytest", ...],
-        # ...,
-    )
-
-
-And create an alias into ``setup.cfg`` file:
-
-
-.. code-block:: ini
-
-    [aliases]
-    test=pytest
-
-If you now type::
-
-    python setup.py test
-
-this will execute your tests using ``pytest-runner``. As this is a
-standalone version of ``pytest`` no prior installation whatsoever is
-required for calling the test command. You can also pass additional
-arguments to pytest such as your test directory or other
-options using ``--addopts``.
-
-You can also specify other pytest-ini options in your ``setup.cfg`` file
-by putting them into a ``[tool:pytest]`` section:
-
-.. code-block:: ini
-
-    [tool:pytest]
-    addopts = --verbose
-    python_files = testing/*/*.py
-
-
-Manual Integration
-^^^^^^^^^^^^^^^^^^
-
-If for some reason you don't want/can't use ``pytest-runner``, you can write
-your own setuptools Test command for invoking pytest.
-
-.. code-block:: python
-
-    import sys
-
-    from setuptools.command.test import test as TestCommand
-
-
-    class PyTest(TestCommand):
-        user_options = [("pytest-args=", "a", "Arguments to pass to pytest")]
-
-        def initialize_options(self):
-            TestCommand.initialize_options(self)
-            self.pytest_args = ""
-
-        def run_tests(self):
-            import shlex
-
-            # import here, cause outside the eggs aren't loaded
-            import pytest
-
-            errno = pytest.main(shlex.split(self.pytest_args))
-            sys.exit(errno)
-
-
-    setup(
-        # ...,
-        tests_require=["pytest"],
-        cmdclass={"pytest": PyTest},
-    )
-
-Now if you run::
-
-    python setup.py test
-
-this will download ``pytest`` if needed and then run your tests
-as you would expect it to. You can pass a single string of arguments
-using the ``--pytest-args`` or ``-a`` command-line option. For example::
-
-    python setup.py test -a "--durations=5"
-
-is equivalent to running ``pytest --durations=5``.
-
-
 .. include:: links.inc

doc/en/historical-notes.rst

@@ -4,6 +4,117 @@ Historical Notes
 This page lists features or behavior from previous versions of pytest which have changed over the years. They are
 kept here as a historical note so users looking at old code can find documentation related to them.
 
+
+.. _marker-revamp:
+
+Marker revamp and iteration
+---------------------------
+
+.. versionchanged:: 3.6
+
+pytest's marker implementation traditionally worked by simply updating the ``__dict__`` attribute of functions to cumulatively add markers. As a result, markers would unintentionally be passed along class hierarchies in surprising ways. Further, the API for retrieving them was inconsistent, as markers from parameterization would be stored differently than markers applied using the ``@pytest.mark`` decorator and markers added via ``node.add_marker``.
+
+This state of things made it technically next to impossible to use data from markers correctly without having a deep understanding of the internals, leading to subtle and hard to understand bugs in more advanced usages.
+
+Depending on how a marker got declared/changed one would get either a ``MarkerInfo`` which might contain markers from sibling classes,
+``MarkDecorators`` when marks came from parameterization or from a ``node.add_marker`` call, discarding prior marks. Also ``MarkerInfo`` acts like a single mark, when it in fact represents a merged view on multiple marks with the same name.
+
+On top of that markers were not accessible in the same way for modules, classes, and functions/methods.
+In fact, markers were only accessible in functions, even if they were declared on classes/modules.
+
+A new API to access markers has been introduced in pytest 3.6 in order to solve the problems with
+the initial design, providing the :func:`_pytest.nodes.Node.iter_markers` method to iterate over
+markers in a consistent manner and reworking the internals, which solved a great deal of problems
+with the initial design.
+
+
+.. _update marker code:
+
+Updating code
+~~~~~~~~~~~~~
+
+The old ``Node.get_marker(name)`` function is considered deprecated because it returns an internal ``MarkerInfo`` object
+which contains the merged name, ``*args`` and ``**kwargs`` of all the markers which apply to that node.
+
+In general there are two scenarios on how markers should be handled:
+
+1. Marks overwrite each other. Order matters but you only want to think of your mark as a single item. E.g.
+``log_level('info')`` at a module level can be overwritten by ``log_level('debug')`` for a specific test.
+
+    In this case, use ``Node.get_closest_marker(name)``:
+
+    .. code-block:: python
+
+        # replace this:
+        marker = item.get_marker("log_level")
+        if marker:
+            level = marker.args[0]
+
+        # by this:
+        marker = item.get_closest_marker("log_level")
+        if marker:
+            level = marker.args[0]
+
+2. Marks compose in an additive manner. E.g. ``skipif(condition)`` marks mean you just want to evaluate all of them,
+order doesn't even matter. You probably want to think of your marks as a set here.
+
+   In this case iterate over each mark and handle their ``*args`` and ``**kwargs`` individually.
+
+   .. code-block:: python
+
+        # replace this
+        skipif = item.get_marker("skipif")
+        if skipif:
+            for condition in skipif.args:
+                # eval condition
+                ...
+
+        # by this:
+        for skipif in item.iter_markers("skipif"):
+            condition = skipif.args[0]
+            # eval condition
+
+
+If you are unsure or have any questions, please consider opening
+`an issue <https://github.com/pytest-dev/pytest/issues>`_.
+
+Related issues
+~~~~~~~~~~~~~~
+
+Here is a non-exhaustive list of issues fixed by the new implementation:
+
+* Marks don't pick up nested classes (`#199 <https://github.com/pytest-dev/pytest/issues/199>`_).
+
+* Markers stain on all related classes (`#568 <https://github.com/pytest-dev/pytest/issues/568>`_).
+
+* Combining marks - args and kwargs calculation (`#2897 <https://github.com/pytest-dev/pytest/issues/2897>`_).
+
+* ``request.node.get_marker('name')`` returns ``None`` for markers applied in classes (`#902 <https://github.com/pytest-dev/pytest/issues/902>`_).
+
+* Marks applied in parametrize are stored as markdecorator (`#2400 <https://github.com/pytest-dev/pytest/issues/2400>`_).
+
+* Fix marker interaction in a backward incompatible way (`#1670 <https://github.com/pytest-dev/pytest/issues/1670>`_).
+
+* Refactor marks to get rid of the current "marks transfer" mechanism (`#2363 <https://github.com/pytest-dev/pytest/issues/2363>`_).
+
+* Introduce FunctionDefinition node, use it in generate_tests (`#2522 <https://github.com/pytest-dev/pytest/issues/2522>`_).
+
+* Remove named marker attributes and collect markers in items (`#891 <https://github.com/pytest-dev/pytest/issues/891>`_).
+
+* skipif mark from parametrize hides module level skipif mark (`#1540 <https://github.com/pytest-dev/pytest/issues/1540>`_).
+
+* skipif + parametrize not skipping tests (`#1296 <https://github.com/pytest-dev/pytest/issues/1296>`_).
+
+* Marker transfer incompatible with inheritance (`#535 <https://github.com/pytest-dev/pytest/issues/535>`_).
+
+More details can be found in the `original PR <https://github.com/pytest-dev/pytest/pull/3317>`_.
+
+.. note::
+
+    in a future major relase of pytest we will introduce class based markers,
+    at which point markers will no longer be limited to instances of :py:class:`Mark`.
+
+
 cache plugin integrated into the core
 -------------------------------------
 

doc/en/index.rst

@@ -28,7 +28,7 @@ To execute it:
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 1 item
@@ -44,7 +44,7 @@ To execute it:
     E        +  where 4 = inc(3)
 
     test_sample.py:6: AssertionError
-    ========================= 1 failed in 0.12 seconds =========================
+    ============================ 1 failed in 0.12s =============================
 
 Due to ``pytest``'s detailed assertion introspection, only plain ``assert`` statements are used.
 See :ref:`Getting Started <getstarted>` for more examples.
@@ -61,7 +61,7 @@ Features
 
 - Can run :ref:`unittest <unittest>` (including trial) and :ref:`nose <noseintegration>` test suites out of the box;
 
-- Python 2.7, Python 3.4+, PyPy 2.3, Jython 2.5 (untested);
+- Python 3.5+ and PyPy 3;
 
 - Rich plugin architecture, with over 315+ `external plugins <http://plugincompat.herokuapp.com>`_ and thriving community;
 
@@ -83,6 +83,39 @@ Changelog
 
 Consult the :ref:`Changelog <changelog>` page for fixes and enhancements of each version.
 
+Support pytest
+--------------
+
+`Open Collective`_ is an online funding platform for open and transparent communities.
+It provide tools to raise money and share your finances in full transparency.
+
+It is the platform of choice for individuals and companies that want to make one-time or
+monthly donations directly to the project.
+
+See more datails in the `pytest collective`_.
+
+.. _Open Collective: https://opencollective.com
+.. _pytest collective: https://opencollective.com/pytest
+
+
+pytest for enterprise
+---------------------
+
+Available as part of the Tidelift Subscription.
+
+The maintainers of pytest and thousands of other packages are working with Tidelift to deliver commercial support and
+maintenance for the open source dependencies you use to build your applications.
+Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use.
+
+`Learn more. <https://tidelift.com/subscription/pkg/pypi-pytest?utm_source=pypi-pytest&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`_
+
+Security
+^^^^^^^^
+
+pytest has never been associated with a security vunerability, but in any case, to report a
+security vulnerability please use the `Tidelift security contact <https://tidelift.com/security>`_.
+Tidelift will coordinate the fix and disclosure.
+
 
 License
 -------

doc/en/license.rst

@@ -9,7 +9,7 @@ Distributed under the terms of the `MIT`_ license, pytest is free and open sourc
 
     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

doc/en/links.inc

@@ -14,7 +14,7 @@
 .. _`distribute docs`:
 .. _`distribute`: https://pypi.org/project/distribute/
 .. _`pip`: https://pypi.org/project/pip/
-.. _`venv`: https://docs.python.org/3/library/venv.html/
+.. _`venv`: https://docs.python.org/3/library/venv.html
 .. _`virtualenv`: https://pypi.org/project/virtualenv/
 .. _hudson: http://hudson-ci.org/
 .. _jenkins: http://jenkins-ci.org/

doc/en/logging.rst

@@ -70,7 +70,9 @@ caplog fixture
 ^^^^^^^^^^^^^^
 
 Inside tests it is possible to change the log level for the captured log
-messages.  This is supported by the ``caplog`` fixture::
+messages.  This is supported by the ``caplog`` fixture:
+
+.. code-block:: python
 
     def test_foo(caplog):
         caplog.set_level(logging.INFO)
@@ -78,59 +80,69 @@ messages.  This is supported by the ``caplog`` fixture::
 
 By default the level is set on the root logger,
 however as a convenience it is also possible to set the log level of any
-logger::
+logger:
+
+.. code-block:: python
 
     def test_foo(caplog):
-        caplog.set_level(logging.CRITICAL, logger='root.baz')
+        caplog.set_level(logging.CRITICAL, logger="root.baz")
         pass
 
 The log levels set are restored automatically at the end of the test.
 
 It is also possible to use a context manager to temporarily change the log
-level inside a ``with`` block::
+level inside a ``with`` block:
+
+.. code-block:: python
 
     def test_bar(caplog):
         with caplog.at_level(logging.INFO):
             pass
 
 Again, by default the level of the root logger is affected but the level of any
-logger can be changed instead with::
+logger can be changed instead with:
+
+.. code-block:: python
 
     def test_bar(caplog):
-        with caplog.at_level(logging.CRITICAL, logger='root.baz'):
+        with caplog.at_level(logging.CRITICAL, logger="root.baz"):
             pass
 
 Lastly all the logs sent to the logger during the test run are made available on
 the fixture in the form of both the ``logging.LogRecord`` instances and the final log text.
-This is useful for when you want to assert on the contents of a message::
+This is useful for when you want to assert on the contents of a message:
+
+.. code-block:: python
 
     def test_baz(caplog):
         func_under_test()
         for record in caplog.records:
-            assert record.levelname != 'CRITICAL'
-        assert 'wally' not in caplog.text
+            assert record.levelname != "CRITICAL"
+        assert "wally" not in caplog.text
 
 For all the available attributes of the log records see the
 ``logging.LogRecord`` class.
 
 You can also resort to ``record_tuples`` if all you want to do is to ensure,
 that certain messages have been logged under a given logger name with a given
-severity and message::
+severity and message:
+
+.. code-block:: python
 
     def test_foo(caplog):
-        logging.getLogger().info('boo %s', 'arg')
+        logging.getLogger().info("boo %s", "arg")
 
-        assert caplog.record_tuples == [
-            ('root', logging.INFO, 'boo arg'),
-        ]
+        assert caplog.record_tuples == [("root", logging.INFO, "boo arg")]
 
-You can call ``caplog.clear()`` to reset the captured log records in a test::
+You can call ``caplog.clear()`` to reset the captured log records in a test:
+
+.. code-block:: python
 
     def test_something_with_clearing_records(caplog):
         some_method_that_creates_log_records()
         caplog.clear()
         your_test_method()
-        assert ['Foo'] == [rec.message for rec in caplog.records]
+        assert ["Foo"] == [rec.message for rec in caplog.records]
 
 
 The ``caplog.records`` attribute contains records from the current stage only, so
@@ -149,7 +161,7 @@ the records for the ``setup`` and ``call`` stages during teardown like so:
         yield window
         for when in ("setup", "call"):
             messages = [
-                x.message for x in caplog.get_records(when) if x.level == logging.WARNING
+                x.message for x in caplog.get_records(when) if x.levelno == logging.WARNING
             ]
             if messages:
                 pytest.fail(

doc/en/mark.rst

@@ -1,9 +1,7 @@
-
 .. _mark:
 
 Marking test functions with attributes
-=================================================================
-
+======================================
 
 By using the ``pytest.mark`` helper you can easily set
 metadata on your test functions. There are
@@ -17,8 +15,10 @@ some builtin markers, for example:
   to the same test function.
 
 It's easy to create custom markers or to apply markers
-to whole test classes or modules. See :ref:`mark examples` for examples
-which also serve as documentation.
+to whole test classes or modules. Those markers can be used by plugins, and also
+are commonly used to :ref:`select tests <mark run>` on the command-line with the ``-m`` option.
+
+See :ref:`mark examples` for examples which also serve as documentation.
 
 .. note::
 
@@ -26,136 +26,53 @@ which also serve as documentation.
     :ref:`fixtures <fixtures>`.
 
 
-Raising errors on unknown marks: --strict
------------------------------------------
+Registering marks
+-----------------
 
-When the ``--strict`` command-line flag is passed, any unknown marks applied
-with the ``@pytest.mark.name_of_the_mark`` decorator will trigger an error.
-Marks defined or added by pytest or by a plugin will not trigger an error.
-
-Marks can be registered in ``pytest.ini`` like this:
+You can register custom marks in your ``pytest.ini`` file like this:
 
 .. code-block:: ini
 
     [pytest]
     markers =
-        slow
+        slow: marks tests as slow (deselect with '-m "not slow"')
         serial
 
-This can be used to prevent users mistyping mark names by accident. Test suites that want to enforce this
-should add ``--strict`` to ``addopts``:
+Note that everything after the ``:`` is an optional description.
+
+Alternatively, you can register new markers programmatically in a
+:ref:`pytest_configure <initialization-hooks>` hook:
+
+.. code-block:: python
+
+    def pytest_configure(config):
+        config.addinivalue_line(
+            "markers", "env(name): mark test to run only on named environment"
+        )
+
+
+Registered marks appear in pytest's help text and do not emit warnings (see the next section). It
+is recommended that third-party plugins always :ref:`register their markers <registering-markers>`.
+
+.. _unknown-marks:
+
+Raising errors on unknown marks
+-------------------------------
+
+Unregistered marks applied with the ``@pytest.mark.name_of_the_mark`` decorator
+will always emit a warning in order to avoid silently doing something
+surprising due to mis-typed names. As described in the previous section, you can disable
+the warning for custom marks by registering them in your ``pytest.ini`` file or
+using a custom ``pytest_configure`` hook.
+
+When the ``--strict-markers`` command-line flag is passed, any unknown marks applied
+with the ``@pytest.mark.name_of_the_mark`` decorator will trigger an error. You can
+enforce this validation in your project by adding ``--strict-markers`` to ``addopts``:
 
 .. code-block:: ini
 
     [pytest]
-    addopts = --strict
+    addopts = --strict-markers
     markers =
-        slow
+        slow: marks tests as slow (deselect with '-m "not slow"')
         serial
-
-
-.. _marker-revamp:
-
-Marker revamp and iteration
----------------------------
-
-
-
-pytest's marker implementation traditionally worked by simply updating the ``__dict__`` attribute of functions to cumulatively add markers. As a result, markers would unintentionally be passed along class hierarchies in surprising ways. Further, the API for retrieving them was inconsistent, as markers from parameterization would be stored differently than markers applied using the ``@pytest.mark`` decorator and markers added via ``node.add_marker``.
-
-This state of things made it technically next to impossible to use data from markers correctly without having a deep understanding of the internals, leading to subtle and hard to understand bugs in more advanced usages.
-
-Depending on how a marker got declared/changed one would get either a ``MarkerInfo`` which might contain markers from sibling classes,
-``MarkDecorators`` when marks came from parameterization or from a ``node.add_marker`` call, discarding prior marks. Also ``MarkerInfo`` acts like a single mark, when it in fact represents a merged view on multiple marks with the same name.
-
-On top of that markers were not accessible the same way for modules, classes, and functions/methods.
-In fact, markers were only accessible in functions, even if they were declared on classes/modules.
-
-A new API to access markers has been introduced in pytest 3.6 in order to solve the problems with the initial design, providing :func:`_pytest.nodes.Node.iter_markers` method to iterate over markers in a consistent manner and reworking the internals, which solved great deal of problems with the initial design.
-
-
-.. _update marker code:
-
-Updating code
-~~~~~~~~~~~~~
-
-The old ``Node.get_marker(name)`` function is considered deprecated because it returns an internal ``MarkerInfo`` object
-which contains the merged name, ``*args`` and ``**kwargs`` of all the markers which apply to that node.
-
-In general there are two scenarios on how markers should be handled:
-
-1. Marks overwrite each other. Order matters but you only want to think of your mark as a single item. E.g.
-``log_level('info')`` at a module level can be overwritten by ``log_level('debug')`` for a specific test.
-
-    In this case, use ``Node.get_closest_marker(name)``:
-
-    .. code-block:: python
-
-        # replace this:
-        marker = item.get_marker("log_level")
-        if marker:
-            level = marker.args[0]
-
-        # by this:
-        marker = item.get_closest_marker("log_level")
-        if marker:
-            level = marker.args[0]
-
-2. Marks compose in an additive manner. E.g. ``skipif(condition)`` marks mean you just want to evaluate all of them,
-order doesn't even matter. You probably want to think of your marks as a set here.
-
-   In this case iterate over each mark and handle their ``*args`` and ``**kwargs`` individually.
-
-   .. code-block:: python
-
-        # replace this
-        skipif = item.get_marker("skipif")
-        if skipif:
-            for condition in skipif.args:
-                # eval condition
-                ...
-
-        # by this:
-        for skipif in item.iter_markers("skipif"):
-            condition = skipif.args[0]
-            # eval condition
-
-
-If you are unsure or have any questions, please consider opening
-`an issue <https://github.com/pytest-dev/pytest/issues>`_.
-
-Related issues
-~~~~~~~~~~~~~~
-
-Here is a non-exhaustive list of issues fixed by the new implementation:
-
-* Marks don't pick up nested classes (`#199 <https://github.com/pytest-dev/pytest/issues/199>`_).
-
-* Markers stain on all related classes (`#568 <https://github.com/pytest-dev/pytest/issues/568>`_).
-
-* Combining marks - args and kwargs calculation (`#2897 <https://github.com/pytest-dev/pytest/issues/2897>`_).
-
-* ``request.node.get_marker('name')`` returns ``None`` for markers applied in classes (`#902 <https://github.com/pytest-dev/pytest/issues/902>`_).
-
-* Marks applied in parametrize are stored as markdecorator (`#2400 <https://github.com/pytest-dev/pytest/issues/2400>`_).
-
-* Fix marker interaction in a backward incompatible way (`#1670 <https://github.com/pytest-dev/pytest/issues/1670>`_).
-
-* Refactor marks to get rid of the current "marks transfer" mechanism (`#2363 <https://github.com/pytest-dev/pytest/issues/2363>`_).
-
-* Introduce FunctionDefinition node, use it in generate_tests (`#2522 <https://github.com/pytest-dev/pytest/issues/2522>`_).
-
-* Remove named marker attributes and collect markers in items (`#891 <https://github.com/pytest-dev/pytest/issues/891>`_).
-
-* skipif mark from parametrize hides module level skipif mark (`#1540 <https://github.com/pytest-dev/pytest/issues/1540>`_).
-
-* skipif + parametrize not skipping tests (`#1296 <https://github.com/pytest-dev/pytest/issues/1296>`_).
-
-* Marker transfer incompatible with inheritance (`#535 <https://github.com/pytest-dev/pytest/issues/535>`_).
-
-More details can be found in the `original PR <https://github.com/pytest-dev/pytest/pull/3317>`_.
-
-.. note::
-
-    in a future major relase of pytest we will introduce class based markers,
-    at which point markers will no longer be limited to instances of :py:class:`Mark`

doc/en/monkeypatch.rst

@@ -8,46 +8,218 @@ Sometimes tests need to invoke functionality which depends
 on global settings or which invokes code which cannot be easily
 tested such as network access.  The ``monkeypatch`` fixture
 helps you to safely set/delete an attribute, dictionary item or
-environment variable or to modify ``sys.path`` for importing.
+environment variable, or to modify ``sys.path`` for importing.
+
+The ``monkeypatch`` fixture provides these helper methods for safely patching and mocking
+functionality in tests:
+
+.. code-block:: python
+
+    monkeypatch.setattr(obj, name, value, raising=True)
+    monkeypatch.delattr(obj, name, raising=True)
+    monkeypatch.setitem(mapping, name, value)
+    monkeypatch.delitem(obj, name, raising=True)
+    monkeypatch.setenv(name, value, prepend=False)
+    monkeypatch.delenv(name, raising=True)
+    monkeypatch.syspath_prepend(path)
+    monkeypatch.chdir(path)
+
+All modifications will be undone after the requesting
+test function or fixture has finished. The ``raising``
+parameter determines if a ``KeyError`` or ``AttributeError``
+will be raised if the target of the set/deletion operation does not exist.
+
+Consider the following scenarios:
+
+1. Modifying the behavior of a function or the property of a class for a test e.g.
+there is an API call or database connection you will not make for a test but you know
+what the expected output should be. Use :py:meth:`monkeypatch.setattr` to patch the
+function or property with your desired testing behavior. This can include your own functions.
+Use :py:meth:`monkeypatch.delattr` to remove the function or property for the test.
+
+2. Modifying the values of dictionaries e.g. you have a global configuration that
+you want to modify for certain test cases. Use :py:meth:`monkeypatch.setitem` to patch the
+dictionary for the test. :py:meth:`monkeypatch.delitem` can be used to remove items.
+
+3. Modifying environment variables for a test e.g. to test program behavior if an
+environment variable is missing, or to set multiple values to a known variable.
+:py:meth:`monkeypatch.setenv` and :py:meth:`monkeypatch.delenv` can be used for
+these patches.
+
+4. Use ``monkeypatch.setenv("PATH", value, prepend=os.pathsep)`` to modify ``$PATH``, and
+:py:meth:`monkeypatch.chdir` to change the context of the current working directory
+during a test.
+
+5. Use :py:meth:`monkeypatch.syspath_prepend` to modify ``sys.path`` which will also
+call :py:meth:`pkg_resources.fixup_namespace_packages` and :py:meth:`importlib.invalidate_caches`.
+
 See the `monkeypatch blog post`_ for some introduction material
 and a discussion of its motivation.
 
 .. _`monkeypatch blog post`: http://tetamap.wordpress.com/2009/03/03/monkeypatching-in-unit-tests-done-right/
 
-
 Simple example: monkeypatching functions
----------------------------------------------------
+----------------------------------------
 
-If you want to pretend that ``os.expanduser`` returns a certain
-directory, you can use the :py:meth:`monkeypatch.setattr` method to
-patch this function before calling into a function which uses it::
+Consider a scenario where you are working with user directories. In the context of
+testing, you do not want your test to depend on the running user. ``monkeypatch``
+can be used to patch functions dependent on the user to always return a
+specific value.
 
-    # content of test_module.py
-    import os.path
-    def getssh(): # pseudo application code
-        return os.path.join(os.path.expanduser("~admin"), '.ssh')
+In this example, :py:meth:`monkeypatch.setattr` is used to patch ``Path.home``
+so that the known testing path ``Path("/abc")`` is always used when the test is run.
+This removes any dependency on the running user for testing purposes.
+:py:meth:`monkeypatch.setattr` must be called before the function which will use
+the patched function is called.
+After the test function finishes the ``Path.home`` modification will be undone.
 
-    def test_mytest(monkeypatch):
-        def mockreturn(path):
-            return '/abc'
-        monkeypatch.setattr(os.path, 'expanduser', mockreturn)
+.. code-block:: python
+
+    # contents of test_module.py with source code and the test
+    from pathlib import Path
+
+
+    def getssh():
+        """Simple function to return expanded homedir ssh path."""
+        return Path.home() / ".ssh"
+
+
+    def test_getssh(monkeypatch):
+        # mocked return function to replace Path.home
+        # always return '/abc'
+        def mockreturn():
+            return Path("/abc")
+
+        # Application of the monkeypatch to replace Path.home
+        # with the behavior of mockreturn defined above.
+        monkeypatch.setattr(Path, "home", mockreturn)
+
+        # Calling getssh() will use mockreturn in place of Path.home
+        # for this test with the monkeypatch.
         x = getssh()
-        assert x == '/abc/.ssh'
+        assert x == Path("/abc/.ssh")
 
-Here our test function monkeypatches ``os.path.expanduser`` and
-then calls into a function that calls it.  After the test function
-finishes the ``os.path.expanduser`` modification will be undone.
-
-example: preventing "requests" from remote operations
+Monkeypatching returned objects: building mock classes
 ------------------------------------------------------
 
-If you want to prevent the "requests" library from performing http
-requests in all your tests, you can do::
+:py:meth:`monkeypatch.setattr` can be used in conjunction with classes to mock returned
+objects from functions instead of values.
+Imagine a simple function to take an API url and return the json response.
 
-    # content of conftest.py
+.. code-block:: python
+
+    # contents of app.py, a simple API retrieval example
+    import requests
+
+
+    def get_json(url):
+        """Takes a URL, and returns the JSON."""
+        r = requests.get(url)
+        return r.json()
+
+We need to mock ``r``, the returned response object for testing purposes.
+The mock of ``r`` needs a ``.json()`` method which returns a dictionary.
+This can be done in our test file by defining a class to represent ``r``.
+
+.. code-block:: python
+
+    # contents of test_app.py, a simple test for our API retrieval
+    # import requests for the purposes of monkeypatching
+    import requests
+
+    # our app.py that includes the get_json() function
+    # this is the previous code block example
+    import app
+
+    # custom class to be the mock return value
+    # will override the requests.Response returned from requests.get
+    class MockResponse:
+
+        # mock json() method always returns a specific testing dictionary
+        @staticmethod
+        def json():
+            return {"mock_key": "mock_response"}
+
+
+    def test_get_json(monkeypatch):
+
+        # Any arguments may be passed and mock_get() will always return our
+        # mocked object, which only has the .json() method.
+        def mock_get(*args, **kwargs):
+            return MockResponse()
+
+        # apply the monkeypatch for requests.get to mock_get
+        monkeypatch.setattr(requests, "get", mock_get)
+
+        # app.get_json, which contains requests.get, uses the monkeypatch
+        result = app.get_json("https://fakeurl")
+        assert result["mock_key"] == "mock_response"
+
+
+``monkeypatch`` applies the mock for ``requests.get`` with our ``mock_get`` function.
+The ``mock_get`` function returns an instance of the ``MockResponse`` class, which
+has a ``json()`` method defined to return a known testing dictionary and does not
+require any outside API connection.
+
+You can build the ``MockResponse`` class with the appropriate degree of complexity for
+the scenario you are testing. For instance, it could include an ``ok`` property that
+always returns ``True``, or return different values from the ``json()`` mocked method
+based on input strings.
+
+This mock can be shared across tests using a ``fixture``:
+
+.. code-block:: python
+
+    # contents of test_app.py, a simple test for our API retrieval
     import pytest
+    import requests
+
+    # app.py that includes the get_json() function
+    import app
+
+    # custom class to be the mock return value of requests.get()
+    class MockResponse:
+        @staticmethod
+        def json():
+            return {"mock_key": "mock_response"}
+
+
+    # monkeypatched requests.get moved to a fixture
+    @pytest.fixture
+    def mock_response(monkeypatch):
+        """Requests.get() mocked to return {'mock_key':'mock_response'}."""
+
+        def mock_get(*args, **kwargs):
+            return MockResponse()
+
+        monkeypatch.setattr(requests, "get", mock_get)
+
+
+    # notice our test uses the custom fixture instead of monkeypatch directly
+    def test_get_json(mock_response):
+        result = app.get_json("https://fakeurl")
+        assert result["mock_key"] == "mock_response"
+
+
+Furthermore, if the mock was designed to be applied to all tests, the ``fixture`` could
+be moved to a ``conftest.py`` file and use the with ``autouse=True`` option.
+
+
+Global patch example: preventing "requests" from remote operations
+------------------------------------------------------------------
+
+If you want to prevent the "requests" library from performing http
+requests in all your tests, you can do:
+
+.. code-block:: python
+
+    # contents of conftest.py
+    import pytest
+
+
     @pytest.fixture(autouse=True)
     def no_requests(monkeypatch):
+        """Remove requests.sessions.Session.request for all tests."""
         monkeypatch.delattr("requests.sessions.Session.request")
 
 This autouse fixture will be executed for each test function and it
@@ -81,6 +253,187 @@ so that any attempts within tests to create http requests will fail.
     See issue `#3290 <https://github.com/pytest-dev/pytest/issues/3290>`_ for details.
 
 
+Monkeypatching environment variables
+------------------------------------
+
+If you are working with environment variables you often need to safely change the values
+or delete them from the system for testing purposes. ``monkeypatch`` provides a mechanism
+to do this using the ``setenv`` and ``delenv`` method. Our example code to test:
+
+.. code-block:: python
+
+    # contents of our original code file e.g. code.py
+    import os
+
+
+    def get_os_user_lower():
+        """Simple retrieval function.
+        Returns lowercase USER or raises EnvironmentError."""
+        username = os.getenv("USER")
+
+        if username is None:
+            raise OSError("USER environment is not set.")
+
+        return username.lower()
+
+There are two potential paths. First, the ``USER`` environment variable is set to a
+value. Second, the ``USER`` environment variable does not exist. Using ``monkeypatch``
+both paths can be safely tested without impacting the running environment:
+
+.. code-block:: python
+
+    # contents of our test file e.g. test_code.py
+    import pytest
+
+
+    def test_upper_to_lower(monkeypatch):
+        """Set the USER env var to assert the behavior."""
+        monkeypatch.setenv("USER", "TestingUser")
+        assert get_os_user_lower() == "testinguser"
+
+
+    def test_raise_exception(monkeypatch):
+        """Remove the USER env var and assert EnvironmentError is raised."""
+        monkeypatch.delenv("USER", raising=False)
+
+        with pytest.raises(OSError):
+            _ = get_os_user_lower()
+
+This behavior can be moved into ``fixture`` structures and shared across tests:
+
+.. code-block:: python
+
+    # contents of our test file e.g. test_code.py
+    import pytest
+
+
+    @pytest.fixture
+    def mock_env_user(monkeypatch):
+        monkeypatch.setenv("USER", "TestingUser")
+
+
+    @pytest.fixture
+    def mock_env_missing(monkeypatch):
+        monkeypatch.delenv("USER", raising=False)
+
+
+    # notice the tests reference the fixtures for mocks
+    def test_upper_to_lower(mock_env_user):
+        assert get_os_user_lower() == "testinguser"
+
+
+    def test_raise_exception(mock_env_missing):
+        with pytest.raises(OSError):
+            _ = get_os_user_lower()
+
+
+Monkeypatching dictionaries
+---------------------------
+
+:py:meth:`monkeypatch.setitem` can be used to safely set the values of dictionaries
+to specific values during tests. Take this simplified connection string example:
+
+.. code-block:: python
+
+    # contents of app.py to generate a simple connection string
+    DEFAULT_CONFIG = {"user": "user1", "database": "db1"}
+
+
+    def create_connection_string(config=None):
+        """Creates a connection string from input or defaults."""
+        config = config or DEFAULT_CONFIG
+        return f"User Id={config['user']}; Location={config['database']};"
+
+For testing purposes we can patch the ``DEFAULT_CONFIG`` dictionary to specific values.
+
+.. code-block:: python
+
+    # contents of test_app.py
+    # app.py with the connection string function (prior code block)
+    import app
+
+
+    def test_connection(monkeypatch):
+
+        # Patch the values of DEFAULT_CONFIG to specific
+        # testing values only for this test.
+        monkeypatch.setitem(app.DEFAULT_CONFIG, "user", "test_user")
+        monkeypatch.setitem(app.DEFAULT_CONFIG, "database", "test_db")
+
+        # expected result based on the mocks
+        expected = "User Id=test_user; Location=test_db;"
+
+        # the test uses the monkeypatched dictionary settings
+        result = app.create_connection_string()
+        assert result == expected
+
+You can use the :py:meth:`monkeypatch.delitem` to remove values.
+
+.. code-block:: python
+
+    # contents of test_app.py
+    import pytest
+
+    # app.py with the connection string function
+    import app
+
+
+    def test_missing_user(monkeypatch):
+
+        # patch the DEFAULT_CONFIG t be missing the 'user' key
+        monkeypatch.delitem(app.DEFAULT_CONFIG, "user", raising=False)
+
+        # Key error expected because a config is not passed, and the
+        # default is now missing the 'user' entry.
+        with pytest.raises(KeyError):
+            _ = app.create_connection_string()
+
+
+The modularity of fixtures gives you the flexibility to define
+separate fixtures for each potential mock and reference them in the needed tests.
+
+.. code-block:: python
+
+    # contents of test_app.py
+    import pytest
+
+    # app.py with the connection string function
+    import app
+
+    # all of the mocks are moved into separated fixtures
+    @pytest.fixture
+    def mock_test_user(monkeypatch):
+        """Set the DEFAULT_CONFIG user to test_user."""
+        monkeypatch.setitem(app.DEFAULT_CONFIG, "user", "test_user")
+
+
+    @pytest.fixture
+    def mock_test_database(monkeypatch):
+        """Set the DEFAULT_CONFIG database to test_db."""
+        monkeypatch.setitem(app.DEFAULT_CONFIG, "database", "test_db")
+
+
+    @pytest.fixture
+    def mock_missing_default_user(monkeypatch):
+        """Remove the user key from DEFAULT_CONFIG"""
+        monkeypatch.delitem(app.DEFAULT_CONFIG, "user", raising=False)
+
+
+    # tests reference only the fixture mocks that are needed
+    def test_connection(mock_test_user, mock_test_database):
+
+        expected = "User Id=test_user; Location=test_db;"
+
+        result = app.create_connection_string()
+        assert result == expected
+
+
+    def test_missing_user(mock_missing_default_user):
+
+        with pytest.raises(KeyError):
+            _ = app.create_connection_string()
+
+
 .. currentmodule:: _pytest.monkeypatch
 
 API Reference

doc/en/nose.rst

@@ -46,7 +46,7 @@ Unsupported idioms / known issues
   <https://github.com/pytest-dev/pytest/issues/377/>`_.
 
 - nose imports test modules with the same import path (e.g.
-  ``tests.test_mod``) but different file system paths
+  ``tests.test_mode``) but different file system paths
   (e.g. ``tests/test_mode.py`` and ``other/tests/test_mode.py``)
   by extending sys.path/import semantics.   pytest does not do that
   but there is discussion in `#268 <https://github.com/pytest-dev/pytest/issues/268>`_ for adding some support.  Note that

doc/en/parametrize.rst

@@ -56,7 +56,7 @@ them in turn:
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 3 items
@@ -75,7 +75,7 @@ them in turn:
     E        +  where 54 = eval('6*9')
 
     test_expectation.py:6: AssertionError
-    ==================== 1 failed, 2 passed in 0.12 seconds ====================
+    ======================= 1 failed, 2 passed in 0.12s ========================
 
 .. note::
 
@@ -121,14 +121,14 @@ Let's run this:
 
     $ pytest
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR
     collected 3 items
 
     test_expectation.py ..x                                              [100%]
 
-    =================== 2 passed, 1 xfailed in 0.12 seconds ====================
+    ======================= 2 passed, 1 xfailed in 0.12s =======================
 
 The one parameter set which caused a failure previously now
 shows up as an "xfailed (expected to fail)" test.
@@ -205,7 +205,7 @@ If we now pass two stringinput values, our test will run twice:
 
     $ pytest -q --stringinput="hello" --stringinput="world" test_strings.py
     ..                                                                   [100%]
-    2 passed in 0.12 seconds
+    2 passed in 0.12s
 
 Let's also run with a stringinput that will lead to a failing test:
 
@@ -225,7 +225,7 @@ Let's also run with a stringinput that will lead to a failing test:
     E        +    where <built-in method isalpha of str object at 0xdeadbeef> = '!'.isalpha
 
     test_strings.py:4: AssertionError
-    1 failed in 0.12 seconds
+    1 failed in 0.12s
 
 As expected our test function fails.
 
@@ -239,7 +239,7 @@ list:
     s                                                                    [100%]
     ========================= short test summary info ==========================
     SKIPPED [1] test_strings.py: got empty parameter set ['stringinput'], function test_valid_string at $REGENDOC_TMPDIR/test_strings.py:2
-    1 skipped in 0.12 seconds
+    1 skipped in 0.12s
 
 Note that when calling ``metafunc.parametrize`` multiple times with different parameter sets, all parameter names across
 those sets cannot be duplicated, otherwise an error will be raised.

doc/en/plugins.rst

@@ -8,7 +8,9 @@ Installing and Using plugins
 This section talks about installing and using third party plugins.
 For writing your own plugins, please refer to :ref:`writing-plugins`.
 
-Installing a third party plugin can be easily done with ``pip``::
+Installing a third party plugin can be easily done with ``pip``:
+
+.. code-block:: bash
 
     pip install pytest-NAME
     pip uninstall pytest-NAME
@@ -95,7 +97,9 @@ Finding out which plugins are active
 ------------------------------------
 
 If you want to find out which plugins are active in your
-environment you can type::
+environment you can type:
+
+.. code-block:: bash
 
     pytest --trace-config
 
@@ -108,7 +112,9 @@ and their names. It will also print local plugins aka
 Deactivating / unregistering a plugin by name
 ---------------------------------------------
 
-You can prevent plugins from loading or unregister them::
+You can prevent plugins from loading or unregister them:
+
+.. code-block:: bash
 
     pytest -p no:NAME
 

doc/en/projects.rst

@@ -28,7 +28,6 @@ Here are some examples of projects using ``pytest`` (please send notes via :ref:
 * `sentry <https://getsentry.com/welcome/>`_, realtime app-maintenance and exception tracking
 * `Astropy <http://www.astropy.org/>`_ and `affiliated packages <http://www.astropy.org/affiliated/index.html>`_
 * `tox <http://testrun.org/tox>`_, virtualenv/Hudson integration tool
-* `PIDA <http://pida.co.uk>`_ framework for integrated development
 * `PyPM <http://code.activestate.com/pypm/>`_ ActiveState's package manager
 * `Fom <http://packages.python.org/Fom/>`_ a fluid object mapper for FluidDB
 * `applib <https://github.com/ActiveState/applib>`_ cross-platform utilities
@@ -37,10 +36,10 @@ Here are some examples of projects using ``pytest`` (please send notes via :ref:
 * `mwlib <https://pypi.org/project/mwlib/>`_ mediawiki parser and utility library
 * `The Translate Toolkit <http://translate.sourceforge.net/wiki/toolkit/index>`_ for localization and conversion
 * `execnet <http://codespeak.net/execnet>`_ rapid multi-Python deployment
-* `pylib <https://py.readthedocs.io>`_ cross-platform path, IO, dynamic code library
-* `Pacha <http://pacha.cafepais.com/>`_ configuration management in five minutes
+* `pylib <https://pylib.readthedocs.io/en/stable/>`_ cross-platform path, IO, dynamic code library
 * `bbfreeze <https://pypi.org/project/bbfreeze/>`_ create standalone executables from Python scripts
-* `pdb++ <http://bitbucket.org/antocuni/pdb>`_ a fancier version of PDB
+* `pdb++ <https://github.com/pdbpp/pdbpp>`_ a fancier version of PDB
+* `pudb <https://github.com/inducer/pudb>`_ full-screen console debugger for python
 * `py-s3fuse <http://code.google.com/p/py-s3fuse/>`_ Amazon S3 FUSE based filesystem
 * `waskr <http://code.google.com/p/waskr/>`_ WSGI Stats Middleware
 * `guachi <http://code.google.com/p/guachi/>`_ global persistent configs for Python modules
@@ -77,7 +76,7 @@ Some organisations using pytest
 * `Tandberg <http://www.tandberg.com/>`_
 * `Shootq <http://web.shootq.com/>`_
 * `Stups department of Heinrich Heine University Duesseldorf <http://www.stups.uni-duesseldorf.de/projects.php>`_
-* `cellzome <http://www.cellzome.com/>`_
+* cellzome
 * `Open End, Gothenborg <http://www.openend.se>`_
 * `Laboratory of Bioinformatics, Warsaw <http://genesilico.pl/>`_
 * `merlinux, Germany <http://merlinux.eu>`_

doc/en/py27-py34-deprecation.rst

@@ -7,16 +7,25 @@ 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,
+The **pytest 4.6** series is the last to support Python 2.7 and 3.4, and was released in
+**June 2019**. **pytest 5.0** and onwards will support only Python 3.5+.
+
+Thanks to the `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
+will install the last pytest ``4.6`` 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.
+While pytest ``5.0`` will be the new mainstream and development version, until **January 2020**
+the pytest core team plans to make bug-fix releases of the pytest ``4.6`` series by
+back-porting patches to the ``4.6-maintenance`` branch that affect Python 2 users.
 
-**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**.
+**After 2020**, the core team will no longer actively backport patches, but the ``4.6-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.6`` releases **until mid-2020**.
+
+.. _`python_requires`: https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
+
+Technical Aspects
+-----------------
+
+The technical aspects of the Python 2.7 and 3.4 support plan (such as when releases will occurr, how to backport fixes, etc) is described in issue `#5275 <https://github.com/pytest-dev/pytest/issues/5275>`__.

doc/en/pythonpath.rst

@@ -22,7 +22,9 @@ Consider this file and directory layout::
              |- test_foo.py
 
 
-When executing::
+When executing:
+
+.. code-block:: bash
 
     pytest root/
 
@@ -54,7 +56,9 @@ Consider this file and directory layout::
              |- test_foo.py
 
 
-When executing::
+When executing:
+
+.. code-block:: bash
 
     pytest root/
 
@@ -68,6 +72,8 @@ imported in the global import namespace.
 
 This is also discussed in details in :ref:`test discovery`.
 
+.. _`pytest vs python -m pytest`:
+
 Invoking ``pytest`` versus ``python -m pytest``
 -----------------------------------------------
 

doc/en/reference.rst

@@ -1,5 +1,5 @@
-Reference
-=========
+API Reference
+=============
 
 This page contains the full reference to pytest's API.
 
@@ -27,6 +27,8 @@ pytest.skip
 
 .. autofunction:: _pytest.outcomes.skip(msg, [allow_module_level=False])
 
+.. _`pytest.importorskip ref`:
+
 pytest.importorskip
 ~~~~~~~~~~~~~~~~~~~
 
@@ -57,7 +59,7 @@ pytest.raises
 
 **Tutorial**: :ref:`assertraises`.
 
-.. autofunction:: pytest.raises(expected_exception: Exception, [match], [message])
+.. autofunction:: pytest.raises(expected_exception: Exception [, *, match])
     :with: excinfo
 
 pytest.deprecated_call
@@ -424,6 +426,14 @@ record_property
 
 .. autofunction:: _pytest.junitxml.record_property()
 
+
+record_testsuite_property
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Tutorial**: :ref:`record_testsuite_property example`.
+
+.. autofunction:: _pytest.junitxml.record_testsuite_property()
+
 caplog
 ~~~~~~
 
@@ -461,9 +471,11 @@ testdir
 This fixture provides a :class:`Testdir` instance useful for black-box testing of test files, making it ideal to
 test plugins.
 
-To use it, include in your top-most ``conftest.py`` file::
+To use it, include in your top-most ``conftest.py`` file:
 
-    pytest_plugins = 'pytester'
+.. code-block:: python
+
+    pytest_plugins = "pytester"
 
 
 
@@ -573,6 +585,8 @@ Bootstrapping hooks called for plugins registered early enough (internal and set
 .. autofunction:: pytest_cmdline_parse
 .. autofunction:: pytest_cmdline_main
 
+.. _`initialization-hooks`:
+
 Initialization hooks
 ~~~~~~~~~~~~~~~~~~~~
 
@@ -655,15 +669,14 @@ Session related reporting hooks:
 .. autofunction:: pytest_fixture_post_finalizer
 .. autofunction:: pytest_warning_captured
 
-And here is the central hook for reporting about
-test execution:
+Central hook for reporting about test execution:
 
 .. autofunction:: pytest_runtest_logreport
 
-You can also use this hook to customize assertion representation for some
-types:
+Assertion related hooks:
 
 .. autofunction:: pytest_assertrepr_compare
+.. autofunction:: pytest_assertion_pass
 
 
 Debugging/Interaction hooks
@@ -717,6 +730,14 @@ ExceptionInfo
 .. autoclass:: _pytest._code.ExceptionInfo
     :members:
 
+
+pytest.ExitCode
+~~~~~~~~~~~~~~~
+
+.. autoclass:: _pytest.main.ExitCode
+    :members:
+
+
 FixtureDef
 ~~~~~~~~~~
 
@@ -941,6 +962,14 @@ PYTEST_CURRENT_TEST
 This is not meant to be set by users, but is set by pytest internally with the name of the current test so other
 processes can inspect it, see :ref:`pytest current test env` for more information.
 
+Exceptions
+----------
+
+UsageError
+~~~~~~~~~~
+
+.. autoclass:: _pytest.config.UsageError()
+
 
 .. _`ini options ref`:
 
@@ -974,7 +1003,9 @@ passed multiple times. The expected format is ``name=value``. For example::
         [pytest]
         addopts = --maxfail=2 -rf  # exit after 2 failures, report fail info
 
-   issuing ``pytest test_hello.py`` actually means::
+   issuing ``pytest test_hello.py`` actually means:
+
+   .. code-block:: bash
 
         pytest --maxfail=2 -rf test_hello.py
 
@@ -1058,6 +1089,23 @@ passed multiple times. The expected format is ``name=value``. For example::
       for more details.
 
 
+.. confval:: faulthandler_timeout
+
+   Dumps the tracebacks of all threads if a test takes longer than ``X`` seconds to run (including
+   fixture setup and teardown). Implemented using the `faulthandler.dump_traceback_later`_ function,
+   so all caveats there apply.
+
+   .. code-block:: ini
+
+        # content of pytest.ini
+        [pytest]
+        faulthandler_timeout=5
+
+   For more information please refer to :ref:`faulthandler`.
+
+.. _`faulthandler.dump_traceback_later`: https://docs.python.org/3/library/faulthandler.html#faulthandler.dump_traceback_later
+
+
 .. confval:: filterwarnings
 
 
@@ -1077,6 +1125,22 @@ 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_duration_report
+
+    .. versionadded:: 4.1
+
+    Configures how durations are recorded into the JUnit XML report:
+
+    * ``total`` (the default): duration times reported include setup, call, and teardown times.
+    * ``call``: duration times reported include only call times, excluding setup and teardown.
+
+    .. code-block:: ini
+
+        [pytest]
+        junit_duration_report = call
+
+
 .. confval:: junit_family
 
     .. versionadded:: 4.2
@@ -1092,10 +1156,35 @@ passed multiple times. The expected format is ``name=value``. For example::
         [pytest]
         junit_family = xunit2
 
+
+.. confval:: junit_logging
+
+    .. versionadded:: 3.5
+
+    Configures if stdout/stderr should be written to the JUnit XML file. Valid values are
+    ``system-out``, ``system-err``, and ``no`` (the default).
+
+    .. code-block:: ini
+
+        [pytest]
+        junit_logging = system-out
+
+
+.. confval:: junit_log_passing_tests
+
+    .. versionadded:: 4.6
+
+    If ``junit_logging != "no"``, configures if the captured output should be written
+    to the JUnit XML file for **passing** tests. Default is ``True``.
+
+    .. code-block:: ini
+
+        [pytest]
+        junit_log_passing_tests = False
+
+
 .. confval:: junit_suite_name
 
-
-
     To set the name of the root test suite xml item, you can configure the ``junit_suite_name`` option in your config file:
 
     .. code-block:: ini
@@ -1103,6 +1192,29 @@ passed multiple times. The expected format is ``name=value``. For example::
         [pytest]
         junit_suite_name = my_suite
 
+.. confval:: log_auto_indent
+
+    Allow selective auto-indentation of multiline log messages.
+
+    Supports command line option ``--log-auto-indent [value]``
+    and config option ``log_auto_indent = [value]`` to set the
+    auto-indentation behavior for all logging.
+
+    ``[value]`` can be:
+        * True or "On" - Dynamically auto-indent multiline log messages
+        * False or "Off" or 0 - Do not auto-indent multiline log messages (the default behavior)
+        * [positive integer] - auto-indent multiline log messages by [value] spaces
+
+    .. code-block:: ini
+
+        [pytest]
+        log_auto_indent = False
+
+    Supports passing kwarg ``extra={"auto_indent": [value]}`` to
+    calls to ``logging.log()`` to specify auto-indentation behavior for
+    a specific entry in the log. ``extra`` kwarg overrides the value specified
+    on the command line or in the config.
+
 
 .. confval:: log_cli_date_format
 
@@ -1261,15 +1373,17 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: markers
 
-    When the ``--strict`` command-line argument is used, only known markers -
-    defined in code by core pytest or some plugin - are allowed.
-    You can list additional markers in this setting to add them to the whitelist.
+    When the ``--strict-markers`` or ``--strict`` command-line arguments are used,
+    only known markers - defined in code by core pytest or some plugin - are allowed.
 
-    You can list one marker name per line, indented from the option name.
+    You can list additional markers in this setting to add them to the whitelist,
+    in which case you probably want to add ``--strict-markers`` to ``addopts``
+    to avoid future regressions:
 
     .. code-block:: ini
 
         [pytest]
+        addopts = --strict-markers
         markers =
             slow
             serial

doc/en/skipping.rst

@@ -145,7 +145,7 @@ You can use the ``skipif`` marker (as any other marker) on classes:
 .. code-block:: python
 
     @pytest.mark.skipif(sys.platform == "win32", reason="does not run on windows")
-    class TestPosixCalls(object):
+    class TestPosixCalls:
         def test_function(self):
             "will not be setup or run under 'win32' platform"
 
@@ -179,14 +179,17 @@ information.
 Skipping on a missing import dependency
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You can use the following helper at module level
-or within a test or test setup function::
+You can skip tests on a missing import by using :ref:`pytest.importorskip ref`
+at module level, within a test, or test setup function.
+
+.. code-block:: python
 
     docutils = pytest.importorskip("docutils")
 
-If ``docutils`` cannot be imported here, this will lead to a
-skip outcome of the test.  You can also skip based on the
-version number of a library::
+If ``docutils`` cannot be imported here, this will lead to a skip outcome of
+the test. You can also skip based on the version number of a library:
+
+.. code-block:: python
 
     docutils = pytest.importorskip("docutils", minversion="0.3")
 
@@ -223,7 +226,9 @@ XFail: mark test functions as expected to fail
 ----------------------------------------------
 
 You can use the ``xfail`` marker to indicate that you
-expect a test to fail::
+expect a test to fail:
+
+.. code-block:: python
 
     @pytest.mark.xfail
     def test_function():
@@ -346,12 +351,13 @@ Running it with the report-on-xfail option gives this output:
 
     example $ pytest -rx xfail_demo.py
     =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
     cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR/example
     collected 7 items
 
     xfail_demo.py xxxxxxx                                                [100%]
+
     ========================= short test summary info ==========================
     XFAIL xfail_demo.py::test_hello
     XFAIL xfail_demo.py::test_hello2
@@ -365,8 +371,7 @@ Running it with the report-on-xfail option gives this output:
     XFAIL xfail_demo.py::test_hello6
       reason: reason
     XFAIL xfail_demo.py::test_hello7
-
-    ======================== 7 xfailed in 0.12 seconds =========================
+    ============================ 7 xfailed in 0.12s ============================
 
 .. _`skip/xfail with parametrize`:
 

doc/en/sponsor.rst

@@ -0,0 +1,26 @@
+Sponsor
+=======
+
+pytest is maintained by a team of volunteers from all around the world in their free time. While
+we work on pytest because we love the project and use it daily at our daily jobs, monetary
+compensation when possible is welcome to justify time away from friends, family and personal time.
+
+Money is also used to fund local sprints, merchandising (stickers to distribute in conferences for example)
+and every few years a large sprint involving all members.
+
+OpenCollective
+--------------
+
+`Open Collective`_ is an online funding platform for open and transparent communities.
+It provide tools to raise money and share your finances in full transparency.
+
+It is the platform of choice for individuals and companies that want to make one-time or
+monthly donations directly to the project.
+
+See more datails in the `pytest collective`_.
+
+
+.. _Tidelift: https://tidelift.com
+.. _Tidelift subscription: https://tidelift.com/subscription/pkg/pypi-pytest
+.. _Open Collective: https://opencollective.com
+.. _pytest collective: https://opencollective.com/pytest

doc/en/talks.rst

@@ -2,13 +2,6 @@
 Talks and Tutorials
 ==========================
 
-..
-   .. sidebar:: Next Open Trainings
-
-      `Professional Testing with Python
-      <http://www.python-academy.com/courses/specialtopics/python_course_testing.html>`_,
-      26-28 April 2017, Leipzig, Germany.
-
 .. _`funcargs`: funcargs.html
 
 Books
@@ -23,6 +16,8 @@ Books
 Talks and blog postings
 ---------------------------------------------
 
+- `pytest: recommendations, basic packages for testing in Python and Django, Andreu Vallbona, PyBCN June 2019 <https://www.slideshare.net/AndreuVallbonaPlazas/pybcn-pytest-recomendaciones-paquetes-bsicos-para-testing-en-python-y-django>`_.
+
 - 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)

doc/en/tidelift.rst

@@ -0,0 +1,45 @@
+pytest for enterprise
+=====================
+
+`Tidelift`_ is working with the maintainers of pytest and thousands of other
+open source projects to deliver commercial support and maintenance for the open source dependencies you use
+to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the
+exact dependencies you use.
+
+`Get more details <https://tidelift.com/subscription/pkg/pypi-pytest?utm_source=pypi-pytest&utm_medium=referral&utm_campaign=enterprise>`_
+
+The Tidelift Subscription is a managed open source subscription for application dependencies covering millions of open source projects across JavaScript, Python, Java, PHP, Ruby, .NET, and more.
+
+Your subscription includes:
+
+* **Security updates**
+
+  - Tidelift's security response team coordinates patches for new breaking security vulnerabilities and alerts immediately through a private channel, so your software supply chain is always secure.
+
+* **Licensing verification and indemnification**
+
+  - Tidelift verifies license information to enable easy policy enforcement and adds intellectual property indemnification to cover creators and users in case something goes wrong. You always have a 100% up-to-date bill of materials for your dependencies to share with your legal team, customers, or partners.
+
+* **Maintenance and code improvement**
+
+  - Tidelift ensures the software you rely on keeps working as long as you need it to work. Your managed dependencies are actively maintained and we recruit additional maintainers where required.
+
+* **Package selection and version guidance**
+
+  - Tidelift helps you choose the best open source packages from the start—and then guide you through updates to stay on the best releases as new issues arise.
+
+* **Roadmap input**
+
+  - Take a seat at the table with the creators behind the software you use. Tidelift's participating maintainers earn more income as their software is used by more subscribers, so they're interested in knowing what you need.
+
+* **Tooling and cloud integration**
+
+  - Tidelift works with GitHub, GitLab, BitBucket, and every cloud platform (and other deployment targets, too).
+
+The end result? All of the capabilities you expect from commercial-grade software, for the full breadth of open
+source you use. That means less time grappling with esoteric open source trivia, and more time building your own
+applications—and your business.
+
+`Request a demo <https://tidelift.com/subscription/request-a-demo?utm_source=pypi-pytest&utm_medium=referral&utm_campaign=enterprise>`_
+
+.. _Tidelift: https://tidelift.com