Preparing release version 4.4.2

Require pluggy>=0.11

.coveragerc

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

.github/ISSUE_TEMPLATE.md

@@ -1,8 +1,10 @@
+<!--
 Thanks for submitting an issue!
 
-Here's a quick checklist in what to include:
+Here's a quick checklist for what to provide:
+-->
 
-- [ ] Include a detailed description of the bug or suggestion
-- [ ] `pip list` of the virtual environment you are using
+- [ ] a detailed description of the bug or suggestion
+- [ ] output of `pip list` from the virtual environment you are using
 - [ ] pytest and operating system versions
-- [ ] Minimal example if possible
+- [ ] minimal example if possible

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,9 @@
+<!--
 Thanks for submitting a PR, your contribution is really appreciated!
 
-Here's a quick checklist that should be present in PRs (you can delete this text from the final description, this is
-just a guideline):
+Here's a quick checklist that should be present in PRs.
+(please delete this text from the final description, this is just a guideline)
+-->
 
 - [ ] Create a new changelog file in the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](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.

.github/config.yml

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

.gitignore

@@ -44,3 +44,7 @@ coverage.xml
 .pydevproject
 .project
 .settings
+.vscode
+
+# generated by pip
+pip-wheel-metadata/

.pre-commit-config.yaml

@@ -1,19 +1,19 @@
 exclude: doc/en/example/py2py3/test_py2.py
 repos:
--   repo: https://github.com/ambv/black
-    rev: 18.6b4
+-   repo: https://github.com/python/black
+    rev: 19.3b0
     hooks:
     -   id: black
         args: [--safe, --quiet]
         language_version: python3
 -   repo: https://github.com/asottile/blacken-docs
-    rev: v0.3.0
+    rev: v0.5.0
     hooks:
     -   id: blacken-docs
-        additional_dependencies: [black==18.9b0]
+        additional_dependencies: [black==19.3b0]
         language_version: python3
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.0.0
+    rev: v2.1.0
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
@@ -21,20 +21,23 @@ repos:
     -   id: debug-statements
         exclude: _pytest/debugging.py
         language_version: python3
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.7
+    hooks:
     -   id: flake8
         language_version: python3
 -   repo: https://github.com/asottile/reorder_python_imports
-    rev: v1.3.3
+    rev: v1.4.0
     hooks:
     -   id: reorder-python-imports
         args: ['--application-directories=.:src']
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v1.10.1
+    rev: v1.15.0
     hooks:
     -   id: pyupgrade
         args: [--keep-percent-format]
 -   repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.1.0
+    rev: v1.3.0
     hooks:
     -   id: rst-backticks
 -   repo: local
@@ -51,3 +54,17 @@ repos:
         entry: 'changelog files must be named ####.(feature|bugfix|doc|deprecation|removal|vendor|trivial).rst'
         exclude: changelog/(\d+\.(feature|bugfix|doc|deprecation|removal|vendor|trivial).rst|README.rst|_template.rst)
         files: ^changelog/
+    -   id: py-deprecated
+        name: py library is deprecated
+        language: pygrep
+        entry: >
+            (?x)\bpy\.(
+                _code\.|
+                builtin\.|
+                code\.|
+                io\.(BytesIO|saferepr)|
+                path\.local\.sysfind|
+                process\.|
+                std\.
+            )
+        types: [python]

.travis.yml

@@ -1,4 +1,3 @@
-sudo: false
 language: python
 dist: xenial
 stages:
@@ -7,60 +6,98 @@ stages:
   if: repo = pytest-dev/pytest AND tag IS NOT present
 - name: deploy
   if: repo = pytest-dev/pytest AND tag IS present
-python:
-  - '3.7'
-install:
-  - pip install --upgrade --pre tox
+python: '3.7'
+cache: false
+
 env:
-  matrix:
-    - TOXENV=py27
-    # Specialized factors for py27.
-    - TOXENV=py27-nobyte
-    - TOXENV=py27-xdist
-    - TOXENV=py27-pluggymaster PYTEST_NO_COVERAGE=1
-    # Specialized factors for py37.
-    - TOXENV=py37-pexpect,py37-trial,py37-numpy
-    - TOXENV=py37-pluggymaster PYTEST_NO_COVERAGE=1
-    - TOXENV=py37-freeze PYTEST_NO_COVERAGE=1
+  global:
+    - PYTEST_ADDOPTS=-vv
+
+install:
+  - python -m pip install --upgrade --pre tox
 
 jobs:
   include:
-    # Coverage tracking is slow with pypy, skip it.
-    - env: TOXENV=pypy PYTEST_NO_COVERAGE=1
-      python: 'pypy-5.4'
-      dist: trusty
-    - env: TOXENV=py34
-      python: '3.4'
-    - env: TOXENV=py35
-      python: '3.5'
-    - env: TOXENV=py36
-      python: '3.6'
-    - env: TOXENV=py37
+    # OSX tests - first (in test stage), since they are the slower ones.
     - &test-macos
-      language: generic
+      # 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
-      osx_image: xcode9.4
-      sudo: required
-      install:
-        - python -m pip install --pre tox
-      env: TOXENV=py27
-    - <<: *test-macos
-      env: TOXENV=py37
+      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:
-        - brew update
-        - brew upgrade python
-        - brew unlink python
-        - brew link python
+        - python -V
+        - test $(python -c 'import sys; print("%d%d" % sys.version_info[0:2])') = 27
+    - <<: *test-macos
+      env: TOXENV=py37-xdist
+      before_install:
+        - which python3
+        - python3 -V
+        - ln -sfn "$(which python3)" /usr/local/bin/python
+        - 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'
+
+    # 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=
+
+    # Specialized factors for py27.
+    - env: TOXENV=py27-nobyte-numpy-xdist
+      python: '2.7'
+    - env: TOXENV=py27-pluggymaster-xdist
+      python: '2.7'
+
+    # 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
 
     - stage: baseline
-      env: TOXENV=py27-pexpect,py27-trial,py27-numpy
-    - env: TOXENV=py37-xdist
-    - env: TOXENV=linting,docs,doctesting
-      python: '3.7'
+    # 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
+      python: '3.6'
+    - env: TOXENV=linting,docs,doctesting PYTEST_COVERAGE=1
+      cache:
+        directories:
+          - $HOME/.cache/pre-commit
 
     - stage: deploy
       python: '3.6'
-      env: PYTEST_NO_COVERAGE=1
       install: pip install -U setuptools setuptools_scm
       script: skip
       deploy:
@@ -74,9 +111,19 @@ jobs:
           tags: true
           repo: pytest-dev/pytest
 
+matrix:
+  allow_failures:
+    - python: '3.8-dev'
+      env: TOXENV=py38-xdist
+
 before_script:
   - |
-    if [[ "$PYTEST_NO_COVERAGE" != 1 ]]; then
+    # Do not (re-)upload coverage with cron runs.
+    if [[ "$TRAVIS_EVENT_TYPE" = cron ]]; then
+      PYTEST_COVERAGE=0
+    fi
+  - |
+    if [[ "$PYTEST_COVERAGE" = 1 ]]; then
       export COVERAGE_FILE="$PWD/.coverage"
       export COVERAGE_PROCESS_START="$PWD/.coveragerc"
       export _PYTEST_TOX_COVERAGE_RUN="coverage run -m"
@@ -87,14 +134,14 @@ script: tox --recreate
 
 after_success:
   - |
-    if [[ "$PYTEST_NO_COVERAGE" != 1 ]]; then
+    if [[ "$PYTEST_COVERAGE" = 1 ]]; then
       set -e
       # Add last TOXENV to $PATH.
       PATH="$PWD/.tox/${TOXENV##*,}/bin:$PATH"
       coverage combine
-      coverage xml --ignore-errors
-      coverage report -m --ignore-errors
-      bash <(curl -s https://codecov.io/bash) -Z -X gcov -X coveragepy -X search -X xcode -X gcovout -X fix -f coverage.xml -F "${TOXENV//-/,},linux"
+      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
     fi
 
 notifications:
@@ -106,7 +153,3 @@ notifications:
     skip_join: true
   email:
     - pytest-commit@python.org
-cache:
-    directories:
-        - $HOME/.cache/pip
-        - $HOME/.cache/pre-commit

AUTHORS

@@ -6,22 +6,29 @@ Contributors include::
 Aaron Coleman
 Abdeali JK
 Abhijeet Kasurde
+Adam Johnson
+Adam Uhlir
 Ahn Ki-Wook
 Alan Velasco
 Alexander Johnson
 Alexei Kozlenok
 Allan Feldman
+Aly Sivji
 Anatoly Bubenkoff
 Anders Hovmöller
+Andras Mitzki
 Andras Tim
 Andrea Cimatoribus
 Andreas Zeidler
+Andrey Paramonov
 Andrzej Ostrowski
 Andy Freeland
 Anthon van der Neut
 Anthony Shaw
 Anthony Sottile
+Anton Lodder
 Antony Lee
+Arel Cordero
 Armin Rigo
 Aron Coyle
 Aron Curzon
@@ -45,11 +52,14 @@ Charles Cloud
 Charnjit SiNGH (CCSJ)
 Chris Lamb
 Christian Boelsen
+Christian Fetzer
 Christian Theunert
 Christian Tismer
 Christopher Gilling
+Christopher Dignam
 CrazyMerlyn
 Cyrus Maden
+Damian Skrzypczak
 Dhiren Serai
 Daniel Grana
 Daniel Hahler
@@ -96,6 +106,7 @@ Hugo van Kemenade
 Hui Wang (coldnight)
 Ian Bicking
 Ian Lesperance
+Ilya Konstantinov
 Ionuț Turturică
 Iwan Briquemont
 Jaap Broekhuizen
@@ -114,6 +125,7 @@ Jonas Obrist
 Jordan Guymon
 Jordan Moldow
 Jordan Speicher
+Joseph Hunkeler
 Joshua Bronson
 Jurko Gospodnetić
 Justyna Janczyszyn
@@ -123,6 +135,7 @@ Katerina Koukiou
 Kevin Cox
 Kodi B. Arfer
 Kostis Anagnostopoulos
+Kristoffer Nordström
 Kyle Altendorf
 Lawrence Mitchell
 Lee Kamentsky
@@ -164,14 +177,18 @@ Miro Hrončok
 Nathaniel Waisbrot
 Ned Batchelder
 Neven Mundar
+Nicholas Devenish
+Nicholas Murphy
 Niclas Olofsson
 Nicolas Delaby
+Nikolay Kondratyev
 Oleg Pidsadnyi
 Oleg Sushchenko
 Oliver Bestwalter
 Omar Kohl
 Omer Hadari
 Ondřej Súkup
+Oscar Benjamin
 Patrick Hayes
 Paweł Adamczak
 Pedro Algarvio
@@ -208,6 +225,7 @@ Steffen Allner
 Stephan Obermann
 Sven-Hendrik Haase
 Tadek Teleżyński
+Takafumi Arakaki
 Tarcisio Fischer
 Tareq Alayan
 Ted Xiao
@@ -227,6 +245,7 @@ Vidar T. Fauske
 Virgil Dupras
 Vitaly Lashmanov
 Vlad Dragos
+Volodymyr Piskun
 Wil Cooley
 William Lee
 Wim Glenn

CHANGELOG.rst

@@ -18,6 +18,674 @@ with advance notice in the **Deprecations** section of releases.
 
 .. towncrier release notes start
 
+pytest 4.4.2 (2019-05-08)
+=========================
+
+Bug Fixes
+---------
+
+- `#5089 <https://github.com/pytest-dev/pytest/issues/5089>`_: Fix crash caused by error in ``__repr__`` function with both ``showlocals`` and verbose output enabled.
+
+
+- `#5139 <https://github.com/pytest-dev/pytest/issues/5139>`_: Eliminate core dependency on 'terminal' plugin.
+
+
+- `#5229 <https://github.com/pytest-dev/pytest/issues/5229>`_: Require ``pluggy>=0.11.0`` which reverts a dependency to ``importlib-metadata`` added in ``0.10.0``.
+  The ``importlib-metadata`` package cannot be imported when installed as an egg and causes issues when relying on ``setup.py`` to install test dependencies.
+
+
+
+Improved Documentation
+----------------------
+
+- `#5171 <https://github.com/pytest-dev/pytest/issues/5171>`_: Doc: ``pytest_ignore_collect``, ``pytest_collect_directory``, ``pytest_collect_file`` and ``pytest_pycollect_makemodule`` hooks's 'path' parameter documented type is now ``py.path.local``
+
+
+- `#5188 <https://github.com/pytest-dev/pytest/issues/5188>`_: Improve help for ``--runxfail`` flag.
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#5182 <https://github.com/pytest-dev/pytest/issues/5182>`_: Removed internal and unused ``_pytest.deprecated.MARK_INFO_ATTRIBUTE``.
+
+
+pytest 4.4.1 (2019-04-15)
+=========================
+
+Bug Fixes
+---------
+
+- `#5031 <https://github.com/pytest-dev/pytest/issues/5031>`_: Environment variables are properly restored when using pytester's ``testdir`` fixture.
+
+
+- `#5039 <https://github.com/pytest-dev/pytest/issues/5039>`_: Fix regression with ``--pdbcls``, which stopped working with local modules in 4.0.0.
+
+
+- `#5092 <https://github.com/pytest-dev/pytest/issues/5092>`_: Produce a warning when unknown keywords are passed to ``pytest.param(...)``.
+
+
+- `#5098 <https://github.com/pytest-dev/pytest/issues/5098>`_: Invalidate import caches with ``monkeypatch.syspath_prepend``, which is required with namespace packages being used.
+
+
+pytest 4.4.0 (2019-03-29)
+=========================
+
+Features
+--------
+
+- `#2224 <https://github.com/pytest-dev/pytest/issues/2224>`_: ``async`` test functions are skipped and a warning is emitted when a suitable
+  async plugin is not installed (such as ``pytest-asyncio`` or ``pytest-trio``).
+
+  Previously ``async`` functions would not execute at all but still be marked as "passed".
+
+
+- `#2482 <https://github.com/pytest-dev/pytest/issues/2482>`_: Include new ``disable_test_id_escaping_and_forfeit_all_rights_to_community_support`` option to disable ascii-escaping in parametrized values. This may cause a series of problems and as the name makes clear, use at your own risk.
+
+
+- `#4718 <https://github.com/pytest-dev/pytest/issues/4718>`_: The ``-p`` option can now be used to early-load plugins also by entry-point name, instead of just
+  by module name.
+
+  This makes it possible to early load external plugins like ``pytest-cov`` in the command-line::
+
+      pytest -p pytest_cov
+
+
+- `#4855 <https://github.com/pytest-dev/pytest/issues/4855>`_: The ``--pdbcls`` option handles classes via module attributes now (e.g.
+  ``pdb:pdb.Pdb`` with `pdb++`_), and its validation was improved.
+
+  .. _pdb++: https://pypi.org/project/pdbpp/
+
+
+- `#4875 <https://github.com/pytest-dev/pytest/issues/4875>`_: The `testpaths <https://docs.pytest.org/en/latest/reference.html#confval-testpaths>`__ configuration option is now displayed next
+  to the ``rootdir`` and ``inifile`` lines in the pytest header if the option is in effect, i.e., directories or file names were
+  not explicitly passed in the command line.
+
+  Also, ``inifile`` is only displayed if there's a configuration file, instead of an empty ``inifile:`` string.
+
+
+- `#4911 <https://github.com/pytest-dev/pytest/issues/4911>`_: Doctests can be skipped now dynamically using ``pytest.skip()``.
+
+
+- `#4920 <https://github.com/pytest-dev/pytest/issues/4920>`_: Internal refactorings have been made in order to make the implementation of the
+  `pytest-subtests <https://github.com/pytest-dev/pytest-subtests>`__ plugin
+  possible, which adds unittest sub-test support and a new ``subtests`` fixture as discussed in
+  `#1367 <https://github.com/pytest-dev/pytest/issues/1367>`__.
+
+  For details on the internal refactorings, please see the details on the related PR.
+
+
+- `#4931 <https://github.com/pytest-dev/pytest/issues/4931>`_: pytester's ``LineMatcher`` asserts that the passed lines are a sequence.
+
+
+- `#4936 <https://github.com/pytest-dev/pytest/issues/4936>`_: Handle ``-p plug`` after ``-p no:plug``.
+
+  This can be used to override a blocked plugin (e.g. in "addopts") from the
+  command line etc.
+
+
+- `#4951 <https://github.com/pytest-dev/pytest/issues/4951>`_: Output capturing is handled correctly when only capturing via fixtures (capsys, capfs) with ``pdb.set_trace()``.
+
+
+- `#4956 <https://github.com/pytest-dev/pytest/issues/4956>`_: ``pytester`` sets ``$HOME`` and ``$USERPROFILE`` to the temporary directory during test runs.
+
+  This ensures to not load configuration files from the real user's home directory.
+
+
+- `#4980 <https://github.com/pytest-dev/pytest/issues/4980>`_: Namespace packages are handled better with ``monkeypatch.syspath_prepend`` and ``testdir.syspathinsert`` (via ``pkg_resources.fixup_namespace_packages``).
+
+
+- `#4993 <https://github.com/pytest-dev/pytest/issues/4993>`_: The stepwise plugin reports status information now.
+
+
+- `#5008 <https://github.com/pytest-dev/pytest/issues/5008>`_: If a ``setup.cfg`` file contains ``[tool:pytest]`` and also the no longer supported ``[pytest]`` section, pytest will use ``[tool:pytest]`` ignoring ``[pytest]``. Previously it would unconditionally error out.
+
+  This makes it simpler for plugins to support old pytest versions.
+
+
+
+Bug Fixes
+---------
+
+- `#1895 <https://github.com/pytest-dev/pytest/issues/1895>`_: Fix bug where fixtures requested dynamically via ``request.getfixturevalue()`` might be teardown
+  before the requesting fixture.
+
+
+- `#4851 <https://github.com/pytest-dev/pytest/issues/4851>`_: pytester unsets ``PYTEST_ADDOPTS`` now to not use outer options with ``testdir.runpytest()``.
+
+
+- `#4903 <https://github.com/pytest-dev/pytest/issues/4903>`_: Use the correct modified time for years after 2038 in rewritten ``.pyc`` files.
+
+
+- `#4928 <https://github.com/pytest-dev/pytest/issues/4928>`_: Fix line offsets with ``ScopeMismatch`` errors.
+
+
+- `#4957 <https://github.com/pytest-dev/pytest/issues/4957>`_: ``-p no:plugin`` is handled correctly for default (internal) plugins now, e.g. with ``-p no:capture``.
+
+  Previously they were loaded (imported) always, making e.g. the ``capfd`` fixture available.
+
+
+- `#4968 <https://github.com/pytest-dev/pytest/issues/4968>`_: The pdb ``quit`` command is handled properly when used after the ``debug`` command with `pdb++`_.
+
+  .. _pdb++: https://pypi.org/project/pdbpp/
+
+
+- `#4975 <https://github.com/pytest-dev/pytest/issues/4975>`_: Fix the interpretation of ``-qq`` option where it was being considered as ``-v`` instead.
+
+
+- `#4978 <https://github.com/pytest-dev/pytest/issues/4978>`_: ``outcomes.Exit`` is not swallowed in ``assertrepr_compare`` anymore.
+
+
+- `#4988 <https://github.com/pytest-dev/pytest/issues/4988>`_: Close logging's file handler explicitly when the session finishes.
+
+
+- `#5003 <https://github.com/pytest-dev/pytest/issues/5003>`_: Fix line offset with mark collection error (off by one).
+
+
+
+Improved Documentation
+----------------------
+
+- `#4974 <https://github.com/pytest-dev/pytest/issues/4974>`_: Update docs for ``pytest_cmdline_parse`` hook to note availability liminations
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#4718 <https://github.com/pytest-dev/pytest/issues/4718>`_: ``pluggy>=0.9`` is now required.
+
+
+- `#4815 <https://github.com/pytest-dev/pytest/issues/4815>`_: ``funcsigs>=1.0`` is now required for Python 2.7.
+
+
+- `#4829 <https://github.com/pytest-dev/pytest/issues/4829>`_: Some left-over internal code related to ``yield`` tests has been removed.
+
+
+- `#4890 <https://github.com/pytest-dev/pytest/issues/4890>`_: Remove internally unused ``anypython`` fixture from the pytester plugin.
+
+
+- `#4912 <https://github.com/pytest-dev/pytest/issues/4912>`_: Remove deprecated Sphinx directive, ``add_description_unit()``,
+  pin sphinx-removed-in to >= 0.2.0 to support Sphinx 2.0.
+
+
+- `#4913 <https://github.com/pytest-dev/pytest/issues/4913>`_: Fix pytest tests invocation with custom ``PYTHONPATH``.
+
+
+- `#4965 <https://github.com/pytest-dev/pytest/issues/4965>`_: New ``pytest_report_to_serializable`` and ``pytest_report_from_serializable`` **experimental** hooks.
+
+  These hooks will be used by ``pytest-xdist``, ``pytest-subtests``, and the replacement for
+  resultlog to serialize and customize reports.
+
+  They are experimental, meaning that their details might change or even be removed
+  completely in future patch releases without warning.
+
+  Feedback is welcome from plugin authors and users alike.
+
+
+- `#4987 <https://github.com/pytest-dev/pytest/issues/4987>`_: ``Collector.repr_failure`` respects the ``--tb`` option, but only defaults to ``short`` now (with ``auto``).
+
+
+pytest 4.3.1 (2019-03-11)
+=========================
+
+Bug Fixes
+---------
+
+- `#4810 <https://github.com/pytest-dev/pytest/issues/4810>`_: Logging messages inside ``pytest_runtest_logreport()`` are now properly captured and displayed.
+
+
+- `#4861 <https://github.com/pytest-dev/pytest/issues/4861>`_: Improve validation of contents written to captured output so it behaves the same as when capture is disabled.
+
+
+- `#4898 <https://github.com/pytest-dev/pytest/issues/4898>`_: Fix ``AttributeError: FixtureRequest has no 'confg' attribute`` bug in ``testdir.copy_example``.
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#4768 <https://github.com/pytest-dev/pytest/issues/4768>`_: Avoid pkg_resources import at the top-level.
+
+
+pytest 4.3.0 (2019-02-16)
+=========================
+
+Deprecations
+------------
+
+- `#4724 <https://github.com/pytest-dev/pytest/issues/4724>`_: ``pytest.warns()`` now emits a warning when it receives unknown keyword arguments.
+
+  This will be changed into an error in the future.
+
+
+
+Features
+--------
+
+- `#2753 <https://github.com/pytest-dev/pytest/issues/2753>`_: Usage errors from argparse are mapped to pytest's ``UsageError``.
+
+
+- `#3711 <https://github.com/pytest-dev/pytest/issues/3711>`_: Add the ``--ignore-glob`` parameter to exclude test-modules with Unix shell-style wildcards.
+  Add the ``collect_ignore_glob`` for ``conftest.py`` to exclude test-modules with Unix shell-style wildcards.
+
+
+- `#4698 <https://github.com/pytest-dev/pytest/issues/4698>`_: The warning about Python 2.7 and 3.4 not being supported in pytest 5.0 has been removed.
+
+  In the end it was considered to be more
+  of a nuisance than actual utility and users of those Python versions shouldn't have problems as ``pip`` will not
+  install pytest 5.0 on those interpreters.
+
+
+- `#4707 <https://github.com/pytest-dev/pytest/issues/4707>`_: With the help of new ``set_log_path()`` method there is a way to set ``log_file`` paths from hooks.
+
+
+
+Bug Fixes
+---------
+
+- `#4651 <https://github.com/pytest-dev/pytest/issues/4651>`_: ``--help`` and ``--version`` are handled with ``UsageError``.
+
+
+- `#4782 <https://github.com/pytest-dev/pytest/issues/4782>`_: Fix ``AssertionError`` with collection of broken symlinks with packages.
+
+
+pytest 4.2.1 (2019-02-12)
+=========================
+
+Bug Fixes
+---------
+
+- `#2895 <https://github.com/pytest-dev/pytest/issues/2895>`_: The ``pytest_report_collectionfinish`` hook now is also called with ``--collect-only``.
+
+
+- `#3899 <https://github.com/pytest-dev/pytest/issues/3899>`_: Do not raise ``UsageError`` when an imported package has a ``pytest_plugins.py`` child module.
+
+
+- `#4347 <https://github.com/pytest-dev/pytest/issues/4347>`_: Fix output capturing when using pdb++ with recursive debugging.
+
+
+- `#4592 <https://github.com/pytest-dev/pytest/issues/4592>`_: Fix handling of ``collect_ignore`` via parent ``conftest.py``.
+
+
+- `#4700 <https://github.com/pytest-dev/pytest/issues/4700>`_: Fix regression where ``setUpClass`` would always be called in subclasses even if all tests
+  were skipped by a ``unittest.skip()`` decorator applied in the subclass.
+
+
+- `#4739 <https://github.com/pytest-dev/pytest/issues/4739>`_: Fix ``parametrize(... ids=<function>)`` when the function returns non-strings.
+
+
+- `#4745 <https://github.com/pytest-dev/pytest/issues/4745>`_: Fix/improve collection of args when passing in ``__init__.py`` and a test file.
+
+
+- `#4770 <https://github.com/pytest-dev/pytest/issues/4770>`_: ``more_itertools`` is now constrained to <6.0.0 when required for Python 2.7 compatibility.
+
+
+- `#526 <https://github.com/pytest-dev/pytest/issues/526>`_: Fix "ValueError: Plugin already registered" exceptions when running in build directories that symlink to actual source.
+
+
+
+Improved Documentation
+----------------------
+
+- `#3899 <https://github.com/pytest-dev/pytest/issues/3899>`_: Add note to ``plugins.rst`` that ``pytest_plugins`` should not be used as a name for a user module containing plugins.
+
+
+- `#4324 <https://github.com/pytest-dev/pytest/issues/4324>`_: Document how to use ``raises`` and ``does_not_raise`` to write parametrized tests with conditional raises.
+
+
+- `#4709 <https://github.com/pytest-dev/pytest/issues/4709>`_: Document how to customize test failure messages when using
+  ``pytest.warns``.
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#4741 <https://github.com/pytest-dev/pytest/issues/4741>`_: Some verbosity related attributes of the TerminalReporter plugin are now
+  read only properties.
+
+
+pytest 4.2.0 (2019-01-30)
+=========================
+
+Features
+--------
+
+- `#3094 <https://github.com/pytest-dev/pytest/issues/3094>`_: `Classic xunit-style <https://docs.pytest.org/en/latest/xunit_setup.html>`__ functions and methods
+  now obey the scope of *autouse* fixtures.
+
+  This fixes a number of surprising issues like ``setup_method`` being called before session-scoped
+  autouse fixtures (see `#517 <https://github.com/pytest-dev/pytest/issues/517>`__ for an example).
+
+
+- `#4627 <https://github.com/pytest-dev/pytest/issues/4627>`_: Display a message at the end of the test session when running under Python 2.7 and 3.4 that pytest 5.0 will no longer
+  support those Python versions.
+
+
+- `#4660 <https://github.com/pytest-dev/pytest/issues/4660>`_: The number of *selected* tests now are also displayed when the ``-k`` or ``-m`` flags are used.
+
+
+- `#4688 <https://github.com/pytest-dev/pytest/issues/4688>`_: ``pytest_report_teststatus`` hook now can also receive a ``config`` parameter.
+
+
+- `#4691 <https://github.com/pytest-dev/pytest/issues/4691>`_: ``pytest_terminal_summary`` hook now can also receive a ``config`` parameter.
+
+
+
+Bug Fixes
+---------
+
+- `#3547 <https://github.com/pytest-dev/pytest/issues/3547>`_: ``--junitxml`` can emit XML compatible with Jenkins xUnit.
+  ``junit_family`` INI option accepts ``legacy|xunit1``, which produces old style output, and ``xunit2`` that conforms more strictly to https://github.com/jenkinsci/xunit-plugin/blob/xunit-2.3.2/src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd
+
+
+- `#4280 <https://github.com/pytest-dev/pytest/issues/4280>`_: Improve quitting from pdb, especially with ``--trace``.
+
+  Using ``q[quit]`` after ``pdb.set_trace()`` will quit pytest also.
+
+
+- `#4402 <https://github.com/pytest-dev/pytest/issues/4402>`_: Warning summary now groups warnings by message instead of by test id.
+
+  This makes the output more compact and better conveys the general idea of how much code is
+  actually generating warnings, instead of how many tests call that code.
+
+
+- `#4536 <https://github.com/pytest-dev/pytest/issues/4536>`_: ``monkeypatch.delattr`` handles class descriptors like ``staticmethod``/``classmethod``.
+
+
+- `#4649 <https://github.com/pytest-dev/pytest/issues/4649>`_: Restore marks being considered keywords for keyword expressions.
+
+
+- `#4653 <https://github.com/pytest-dev/pytest/issues/4653>`_: ``tmp_path`` fixture and other related ones provides resolved path (a.k.a real path)
+
+
+- `#4667 <https://github.com/pytest-dev/pytest/issues/4667>`_: ``pytest_terminal_summary`` uses result from ``pytest_report_teststatus`` hook, rather than hardcoded strings.
+
+
+- `#4669 <https://github.com/pytest-dev/pytest/issues/4669>`_: Correctly handle ``unittest.SkipTest`` exception containing non-ascii characters on Python 2.
+
+
+- `#4680 <https://github.com/pytest-dev/pytest/issues/4680>`_: Ensure the ``tmpdir`` and the ``tmp_path`` fixtures are the same folder.
+
+
+- `#4681 <https://github.com/pytest-dev/pytest/issues/4681>`_: Ensure ``tmp_path`` is always a real path.
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#4643 <https://github.com/pytest-dev/pytest/issues/4643>`_: Use ``a.item()`` instead of the deprecated ``np.asscalar(a)`` in ``pytest.approx``.
+
+  ``np.asscalar`` has been `deprecated <https://github.com/numpy/numpy/blob/master/doc/release/1.16.0-notes.rst#new-deprecations>`__ in ``numpy 1.16.``.
+
+
+- `#4657 <https://github.com/pytest-dev/pytest/issues/4657>`_: Copy saferepr from pylib
+
+
+- `#4668 <https://github.com/pytest-dev/pytest/issues/4668>`_: The verbose word for expected failures in the teststatus report changes from ``xfail`` to ``XFAIL`` to be consistent with other test outcomes.
+
+
+pytest 4.1.1 (2019-01-12)
+=========================
+
+Bug Fixes
+---------
+
+- `#2256 <https://github.com/pytest-dev/pytest/issues/2256>`_: Show full repr with ``assert a==b`` and ``-vv``.
+
+
+- `#3456 <https://github.com/pytest-dev/pytest/issues/3456>`_: Extend Doctest-modules to ignore mock objects.
+
+
+- `#4617 <https://github.com/pytest-dev/pytest/issues/4617>`_: Fixed ``pytest.warns`` bug when context manager is reused (e.g. multiple parametrization).
+
+
+- `#4631 <https://github.com/pytest-dev/pytest/issues/4631>`_: Don't rewrite assertion when ``__getattr__`` is broken
+
+
+
+Improved Documentation
+----------------------
+
+- `#3375 <https://github.com/pytest-dev/pytest/issues/3375>`_: Document that using ``setup.cfg`` may crash other tools or cause hard to track down problems because it uses a different parser than ``pytest.ini`` or ``tox.ini`` files.
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#4602 <https://github.com/pytest-dev/pytest/issues/4602>`_: Uninstall ``hypothesis`` in regen tox env.
+
+
+pytest 4.1.0 (2019-01-05)
+=========================
+
+Removals
+--------
+
+- `#2169 <https://github.com/pytest-dev/pytest/issues/2169>`_: ``pytest.mark.parametrize``: in previous versions, errors raised by id functions were suppressed and changed into warnings. Now the exceptions are propagated, along with a pytest message informing the node, parameter value and index where the exception occurred.
+
+
+- `#3078 <https://github.com/pytest-dev/pytest/issues/3078>`_: Remove legacy internal warnings system: ``config.warn``, ``Node.warn``. The ``pytest_logwarning`` now issues a warning when implemented.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#config-warn-and-node-warn>`__ on information on how to update your code.
+
+
+- `#3079 <https://github.com/pytest-dev/pytest/issues/3079>`_: Removed support for yield tests - they are fundamentally broken because they don't support fixtures properly since collection and test execution were separated.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#yield-tests>`__ on information on how to update your code.
+
+
+- `#3082 <https://github.com/pytest-dev/pytest/issues/3082>`_: Removed support for applying marks directly to values in ``@pytest.mark.parametrize``. Use ``pytest.param`` instead.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#marks-in-pytest-mark-parametrize>`__ on information on how to update your code.
+
+
+- `#3083 <https://github.com/pytest-dev/pytest/issues/3083>`_: Removed ``Metafunc.addcall``. This was the predecessor mechanism to ``@pytest.mark.parametrize``.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#metafunc-addcall>`__ on information on how to update your code.
+
+
+- `#3085 <https://github.com/pytest-dev/pytest/issues/3085>`_: Removed support for passing strings to ``pytest.main``. Now, always pass a list of strings instead.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#passing-command-line-string-to-pytest-main>`__ on information on how to update your code.
+
+
+- `#3086 <https://github.com/pytest-dev/pytest/issues/3086>`_: ``[pytest]`` section in **setup.cfg** files is not longer supported, use ``[tool:pytest]`` instead. ``setup.cfg`` files
+  are meant for use with ``distutils``, and a section named ``pytest`` has notoriously been a source of conflicts and bugs.
+
+  Note that for **pytest.ini** and **tox.ini** files the section remains ``[pytest]``.
+
+
+- `#3616 <https://github.com/pytest-dev/pytest/issues/3616>`_: Removed the deprecated compat properties for ``node.Class/Function/Module`` - use ``pytest.Class/Function/Module`` now.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#internal-classes-accessed-through-node>`__ on information on how to update your code.
+
+
+- `#4421 <https://github.com/pytest-dev/pytest/issues/4421>`_: Removed the implementation of the ``pytest_namespace`` hook.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#pytest-namespace>`__ on information on how to update your code.
+
+
+- `#4489 <https://github.com/pytest-dev/pytest/issues/4489>`_: Removed ``request.cached_setup``. This was the predecessor mechanism to modern fixtures.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#cached-setup>`__ on information on how to update your code.
+
+
+- `#4535 <https://github.com/pytest-dev/pytest/issues/4535>`_: Removed the deprecated ``PyCollector.makeitem`` method. This method was made public by mistake a long time ago.
+
+
+- `#4543 <https://github.com/pytest-dev/pytest/issues/4543>`_: Removed support to define fixtures using the ``pytest_funcarg__`` prefix. Use the ``@pytest.fixture`` decorator instead.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#pytest-funcarg-prefix>`__ on information on how to update your code.
+
+
+- `#4545 <https://github.com/pytest-dev/pytest/issues/4545>`_: Calling fixtures directly is now always an error instead of a warning.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#calling-fixtures-directly>`__ on information on how to update your code.
+
+
+- `#4546 <https://github.com/pytest-dev/pytest/issues/4546>`_: Remove ``Node.get_marker(name)`` the return value was not usable for more than a existence check.
+
+  Use ``Node.get_closest_marker(name)`` as a replacement.
+
+
+- `#4547 <https://github.com/pytest-dev/pytest/issues/4547>`_: The deprecated ``record_xml_property`` fixture has been removed, use the more generic ``record_property`` instead.
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#record-xml-property>`__ for more information.
+
+
+- `#4548 <https://github.com/pytest-dev/pytest/issues/4548>`_: An error is now raised if the ``pytest_plugins`` variable is defined in a non-top-level ``conftest.py`` file (i.e., not residing in the ``rootdir``).
+
+  See our `docs <https://docs.pytest.org/en/latest/deprecations.html#pytest-plugins-in-non-top-level-conftest-files>`__ for more information.
+
+
+- `#891 <https://github.com/pytest-dev/pytest/issues/891>`_: Remove ``testfunction.markername`` attributes - use ``Node.iter_markers(name=None)`` to iterate them.
+
+
+
+Deprecations
+------------
+
+- `#3050 <https://github.com/pytest-dev/pytest/issues/3050>`_: Deprecated the ``pytest.config`` global.
+
+  See https://docs.pytest.org/en/latest/deprecations.html#pytest-config-global for rationale.
+
+
+- `#3974 <https://github.com/pytest-dev/pytest/issues/3974>`_: Passing the ``message`` parameter of ``pytest.raises`` now issues a ``DeprecationWarning``.
+
+  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 avoid this
+  mistake and because it is believed to be little used, pytest is deprecating it without providing
+  an alternative for the moment.
+
+  If you have concerns about this, please comment on `issue #3974 <https://github.com/pytest-dev/pytest/issues/3974>`__.
+
+
+- `#4435 <https://github.com/pytest-dev/pytest/issues/4435>`_: Deprecated ``raises(..., 'code(as_a_string)')`` and ``warns(..., 'code(as_a_string)')``.
+
+  See https://docs.pytest.org/en/latest/deprecations.html#raises-warns-exec for rationale and examples.
+
+
+
+Features
+--------
+
+- `#3191 <https://github.com/pytest-dev/pytest/issues/3191>`_: A warning is now issued when assertions are made for ``None``.
+
+  This is a common source of confusion among new users, which write:
+
+  .. code-block:: python
+
+      assert mocked_object.assert_called_with(3, 4, 5, key="value")
+
+  When they should write:
+
+  .. code-block:: python
+
+      mocked_object.assert_called_with(3, 4, 5, key="value")
+
+  Because the ``assert_called_with`` method of mock objects already executes an assertion.
+
+  This warning will not be issued when ``None`` is explicitly checked. An assertion like:
+
+  .. code-block:: python
+
+      assert variable is None
+
+  will not issue the warning.
+
+
+- `#3632 <https://github.com/pytest-dev/pytest/issues/3632>`_: Richer equality comparison introspection on ``AssertionError`` for objects created using `attrs <http://www.attrs.org/en/stable/>`__ or `dataclasses <https://docs.python.org/3/library/dataclasses.html>`_ (Python 3.7+, `backported to 3.6 <https://pypi.org/project/dataclasses>`__).
+
+
+- `#4278 <https://github.com/pytest-dev/pytest/issues/4278>`_: ``CACHEDIR.TAG`` files are now created inside cache directories.
+
+  Those files are part of the `Cache Directory Tagging Standard <http://www.bford.info/cachedir/spec.html>`__, and can
+  be used by backup or synchronization programs to identify pytest's cache directory as such.
+
+
+- `#4292 <https://github.com/pytest-dev/pytest/issues/4292>`_: ``pytest.outcomes.Exit`` is derived from ``SystemExit`` instead of ``KeyboardInterrupt``. This allows us to better handle ``pdb`` exiting.
+
+
+- `#4371 <https://github.com/pytest-dev/pytest/issues/4371>`_: Updated the ``--collect-only`` option to display test descriptions when ran using ``--verbose``.
+
+
+- `#4386 <https://github.com/pytest-dev/pytest/issues/4386>`_: Restructured ``ExceptionInfo`` object construction and ensure incomplete instances have a ``repr``/``str``.
+
+
+- `#4416 <https://github.com/pytest-dev/pytest/issues/4416>`_: pdb: added support for keyword arguments with ``pdb.set_trace``.
+
+  It handles ``header`` similar to Python 3.7 does it, and forwards any
+  other keyword arguments to the ``Pdb`` constructor.
+
+  This allows for ``__import__("pdb").set_trace(skip=["foo.*"])``.
+
+
+- `#4483 <https://github.com/pytest-dev/pytest/issues/4483>`_: Added ini parameter ``junit_duration_report`` to optionally report test call durations, excluding setup and teardown times.
+
+  The JUnit XML specification and the default pytest behavior is to include setup and teardown times in the test duration
+  report. You can include just the call durations instead (excluding setup and teardown) by adding this to your ``pytest.ini`` file:
+
+  .. code-block:: ini
+
+      [pytest]
+      junit_duration_report = call
+
+
+- `#4532 <https://github.com/pytest-dev/pytest/issues/4532>`_: ``-ra`` now will show errors and failures last, instead of as the first items in the summary.
+
+  This makes it easier to obtain a list of errors and failures to run tests selectively.
+
+
+- `#4599 <https://github.com/pytest-dev/pytest/issues/4599>`_: ``pytest.importorskip`` now supports a ``reason`` parameter, which will be shown when the
+  requested module cannot be imported.
+
+
+
+Bug Fixes
+---------
+
+- `#3532 <https://github.com/pytest-dev/pytest/issues/3532>`_: ``-p`` now accepts its argument without a space between the value, for example ``-pmyplugin``.
+
+
+- `#4327 <https://github.com/pytest-dev/pytest/issues/4327>`_: ``approx`` again works with more generic containers, more precisely instances of ``Iterable`` and ``Sized`` instead of more restrictive ``Sequence``.
+
+
+- `#4397 <https://github.com/pytest-dev/pytest/issues/4397>`_: Ensure that node ids are printable.
+
+
+- `#4435 <https://github.com/pytest-dev/pytest/issues/4435>`_: Fixed ``raises(..., 'code(string)')`` frame filename.
+
+
+- `#4458 <https://github.com/pytest-dev/pytest/issues/4458>`_: Display actual test ids in ``--collect-only``.
+
+
+
+Improved Documentation
+----------------------
+
+- `#4557 <https://github.com/pytest-dev/pytest/issues/4557>`_: Markers example documentation page updated to support latest pytest version.
+
+
+- `#4558 <https://github.com/pytest-dev/pytest/issues/4558>`_: Update cache documentation example to correctly show cache hit and miss.
+
+
+- `#4580 <https://github.com/pytest-dev/pytest/issues/4580>`_: Improved detailed summary report documentation.
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#4447 <https://github.com/pytest-dev/pytest/issues/4447>`_: Changed the deprecation type of ``--result-log`` to ``PytestDeprecationWarning``.
+
+  It was decided to remove this feature at the next major revision.
+
+
 pytest 4.0.2 (2018-12-13)
 =========================
 
@@ -1022,7 +1690,7 @@ Features
 - Revamp the internals of the ``pytest.mark`` implementation with correct per
   node handling which fixes a number of long standing bugs caused by the old
   design. This introduces new ``Node.iter_markers(name)`` and
-  ``Node.get_closest_mark(name)`` APIs. Users are **strongly encouraged** to
+  ``Node.get_closest_marker(name)`` APIs. Users are **strongly encouraged** to
   read the `reasons for the revamp in the docs
   <https://docs.pytest.org/en/latest/mark.html#marker-revamp-and-iteration>`_,
   or jump over to details about `updating existing code to use the new APIs
@@ -1757,7 +2425,7 @@ Bug Fixes
 Trivial/Internal Changes
 ------------------------
 
-- pytest now depends on `attrs <https://pypi.org/project/attrs/>`_ for internal
+- pytest now depends on `attrs <https://pypi.org/project/attrs/>`__ for internal
   structures to ease code maintainability. (`#2641
   <https://github.com/pytest-dev/pytest/issues/2641>`_)
 

CONTRIBUTING.rst

@@ -166,7 +166,7 @@ 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/ambv/black>`_ for formatting.
+#. Follow **PEP-8** for naming and `black <https://github.com/python/black>`_ for formatting.
 #. Tests are run using ``tox``::
 
     tox -e linting,py27,py37

LICENSE

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

README.rst

@@ -22,11 +22,11 @@
 .. image:: https://travis-ci.org/pytest-dev/pytest.svg?branch=master
     :target: https://travis-ci.org/pytest-dev/pytest
 
-.. image:: https://ci.appveyor.com/api/projects/status/mrgbjaua7t33pg6b?svg=true
-    :target: https://ci.appveyor.com/project/pytestbot/pytest
+.. image:: https://dev.azure.com/pytest-dev/pytest/_apis/build/status/pytest-CI?branchName=master
+    :target: https://dev.azure.com/pytest-dev/pytest
 
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/ambv/black
+    :target: https://github.com/python/black
 
 .. image:: https://www.codetriage.com/pytest-dev/pytest/badges/users.svg
     :target: https://www.codetriage.com/pytest-dev/pytest
@@ -111,7 +111,7 @@ Consult the `Changelog <https://docs.pytest.org/en/latest/changelog.html>`__ pag
 License
 -------
 
-Copyright Holger Krekel and others, 2004-2018.
+Copyright Holger Krekel and others, 2004-2019.
 
 Distributed under the terms of the `MIT`_ license, pytest is free and open source software.
 

appveyor.yml

@@ -1,53 +0,0 @@
-environment:
-  matrix:
-  - TOXENV: "py37-xdist"
-  - TOXENV: "py27-xdist"
-  - TOXENV: "py27"
-  - TOXENV: "py37"
-  - TOXENV: "linting,docs,doctesting"
-  - TOXENV: "py36"
-  - TOXENV: "py35"
-  - TOXENV: "py34"
-  - TOXENV: "pypy"
-    PYTEST_NO_COVERAGE: "1"
-  # Specialized factors for py27.
-  - TOXENV: "py27-trial,py27-numpy,py27-nobyte"
-  - TOXENV: "py27-pluggymaster"
-    PYTEST_NO_COVERAGE: "1"
-  # Specialized factors for py37.
-  - TOXENV: "py37-trial,py37-numpy"
-  - TOXENV: "py37-pluggymaster"
-    PYTEST_NO_COVERAGE: "1"
-  - TOXENV: "py37-freeze"
-    PYTEST_NO_COVERAGE: "1"
-
-matrix:
-  fast_finish: true
-
-install:
-  - echo Installed Pythons
-  - dir c:\Python*
-
-  - if "%TOXENV%" == "pypy" call scripts\install-pypy.bat
-
-  - C:\Python36\python -m pip install --upgrade pip
-  - C:\Python36\python -m pip install --upgrade --pre tox
-
-build: false  # Not a C# project, build stuff at the test step instead.
-
-before_test:
-  - call scripts\prepare-coverage.bat
-
-test_script:
-  - C:\Python36\python -m tox
-
-on_success:
-  - call scripts\upload-coverage.bat
-
-cache:
-  - '%LOCALAPPDATA%\pip\cache'
-  - '%USERPROFILE%\.cache\pre-commit'
-
-# We don't deploy anything on tags with AppVeyor, we use Travis instead, so we
-# might as well save resources
-skip_tags: true

azure-pipelines.yml

@@ -0,0 +1,117 @@
+trigger:
+- master
+- features
+
+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:
+
+- job: 'Test'
+  pool:
+    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:
+      #   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'
+        # Coverage for:
+        # - test_supports_breakpoint_module_global
+        PYTEST_COVERAGE: '1'
+      py36-xdist:
+        python.version: '3.6'
+        tox.env: 'py36-xdist'
+      py37:
+        python.version: '3.7'
+        tox.env: 'py37'
+        # Coverage for:
+        # - _py36_windowsconsoleio_workaround (with py36+)
+        # - test_request_garbage (no xdist)
+        PYTEST_COVERAGE: '1'
+      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'
+    maxParallel: 10
+
+  steps:
+  - task: UsePythonVersion@0
+    inputs:
+      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
+    displayName: 'Install tox'
+
+  - script: |
+      call scripts/setup-coverage-vars.bat || goto :eof
+      $(python.exe) -m tox -e $(tox.env)
+    displayName: 'Run tests'
+
+  - task: PublishTestResults@2
+    inputs:
+      testResultsFiles: 'build/test-results/$(tox.env).xml'
+      testRunTitle: '$(tox.env)'
+    condition: succeededOrFailed()
+
+  - script: call scripts\upload-coverage.bat
+    displayName: 'Report and upload coverage'
+    condition: eq(variables['PYTEST_COVERAGE'], '1')
+    env:
+      PYTHON: $(python.exe)
+      CODECOV_TOKEN: $(CODECOV_TOKEN)
+      PYTEST_CODECOV_NAME: $(tox.env)

bench/bench.py

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

bench/bench_argcomplete.py

@@ -16,4 +16,4 @@ run = 'fc("/d")'
 
 if __name__ == "__main__":
     print(timeit.timeit(run, setup=setup % imports[0], number=count))
-    print((timeit.timeit(run, setup=setup % imports[1], number=count)))
+    print(timeit.timeit(run, setup=setup % imports[1], number=count))

bench/empty.py

@@ -1,4 +1,2 @@
-import six
-
 for i in range(1000):
-    six.exec_("def test_func_%d(): pass" % i)
+    exec("def test_func_%d(): pass" % i)

bench/skip.py

@@ -2,7 +2,6 @@ from six.moves import range
 
 import pytest
 
-
 SKIP = True
 
 

doc/en/Makefile

@@ -13,6 +13,9 @@ PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
 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 "@/tmp/pytest-of-.*/pytest-\d+@PYTEST_TMPDIR@" \
 	--normalize "@pytest-(\d+)\\.[^ ,]+@pytest-\1.x.y@" \
@@ -38,8 +41,9 @@ help:
 clean:
 	-rm -rf $(BUILDDIR)/*
 
+regen: REGENDOC_FILES:=*.rst */*.rst
 regen:
-	PYTHONDONTWRITEBYTECODE=1 PYTEST_ADDOPT=-pno:hypothesis COLUMNS=76 regendoc --update *.rst */*.rst ${REGENDOC_ARGS}
+	PYTHONDONTWRITEBYTECODE=1 PYTEST_ADDOPTS=-pno:hypothesis COLUMNS=76 regendoc --update ${REGENDOC_FILES} ${REGENDOC_ARGS}
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

doc/en/announce/index.rst

@@ -6,6 +6,15 @@ Release announcements
    :maxdepth: 2
 
 
+   release-4.4.2
+   release-4.4.1
+   release-4.4.0
+   release-4.3.1
+   release-4.3.0
+   release-4.2.1
+   release-4.2.0
+   release-4.1.1
+   release-4.1.0
    release-4.0.2
    release-4.0.1
    release-4.0.0

doc/en/announce/release-4.1.0.rst

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

doc/en/announce/release-4.1.1.rst

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

doc/en/announce/release-4.2.0.rst

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

doc/en/announce/release-4.2.1.rst

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

doc/en/announce/release-4.3.0.rst

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

doc/en/announce/release-4.3.1.rst

@@ -0,0 +1,29 @@
+pytest-4.3.1
+=======================================
+
+pytest 4.3.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:
+
+* Andras Mitzki
+* Anthony Sottile
+* Bruno Oliveira
+* Daniel Hahler
+* Danilo Horta
+* Grygorii Iermolenko
+* Jeff Hale
+* Kyle Altendorf
+* Stephan Hoyer
+* Zac Hatfield-Dodds
+* Zac-HD
+* songbowen
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.4.0.rst

@@ -0,0 +1,39 @@
+pytest-4.4.0
+=======================================
+
+The pytest team is proud to announce the 4.4.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
+* ApaDoctor
+* Bernhard M. Wiedemann
+* Brian Skinn
+* Bruno Oliveira
+* Daniel Hahler
+* Gary Tyler
+* Jeong YunWon
+* Miro Hrončok
+* Takafumi Arakaki
+* henrykironde
+* smheidrich
+
+
+Happy testing,
+The Pytest Development Team

doc/en/announce/release-4.4.1.rst

@@ -0,0 +1,20 @@
+pytest-4.4.1
+=======================================
+
+pytest 4.4.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
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-4.4.2.rst

@@ -0,0 +1,33 @@
+pytest-4.4.2
+=======================================
+
+pytest 4.4.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:
+
+* Allan Lewis
+* Anthony Sottile
+* Bruno Oliveira
+* DamianSkrzypczak
+* Daniel Hahler
+* Don Kirkby
+* Douglas Thor
+* Hugo
+* Ilya Konstantinov
+* Jon Dufresne
+* Matt Cooper
+* Nikolay Kondratyev
+* Ondřej Súkup
+* Peter Schutt
+* Romain Chossart
+* Sitaktif
+
+
+Happy testing,
+The pytest Development Team

doc/en/assert.rst

@@ -12,12 +12,15 @@ Asserting with the ``assert`` statement
 
 ``pytest`` allows you to use the standard python ``assert`` for verifying
 expectations and values in Python tests.  For example, you can write the
-following::
+following:
+
+.. code-block:: python
 
     # content of test_assert1.py
     def f():
         return 3
 
+
     def test_function():
         assert f() == 4
 
@@ -29,7 +32,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_assert1.py F                                                    [100%]
@@ -42,7 +46,7 @@ you will see the return value of the function call:
     E       assert 3 == 4
     E        +  where 3 = f()
 
-    test_assert1.py:5: AssertionError
+    test_assert1.py:6: AssertionError
     ========================= 1 failed in 0.12 seconds =========================
 
 ``pytest`` has support for showing the values of the most common subexpressions
@@ -51,7 +55,9 @@ operators. (See :ref:`tbreportdemo`).  This allows you to use the
 idiomatic python constructs without boilerplate code while not losing
 introspection information.
 
-However, if you specify a message with the assertion like this::
+However, if you specify a message with the assertion like this:
+
+.. code-block:: python
 
     assert a % 2 == 0, "value was odd, should be even"
 
@@ -66,50 +72,71 @@ Assertions about expected exceptions
 ------------------------------------------
 
 In order to write assertions about raised exceptions, you can use
-``pytest.raises`` as a context manager like this::
+``pytest.raises`` as a context manager like this:
+
+.. code-block:: python
 
     import pytest
 
+
     def test_zero_division():
         with pytest.raises(ZeroDivisionError):
             1 / 0
 
-and if you need to have access to the actual exception info you may use::
+and if you need to have access to the actual exception info you may use:
+
+.. code-block:: python
 
     def test_recursion_depth():
         with pytest.raises(RuntimeError) as excinfo:
+
             def f():
                 f()
+
             f()
-        assert 'maximum recursion' in str(excinfo.value)
+        assert "maximum recursion" in str(excinfo.value)
 
 ``excinfo`` is a ``ExceptionInfo`` instance, which is a wrapper around
 the actual exception raised.  The main attributes of interest are
 ``.type``, ``.value`` and ``.traceback``.
 
-.. versionchanged:: 3.0
+You can pass a ``match`` keyword parameter to the context-manager to test
+that a regular expression matches on the string representation of an exception
+(similar to the ``TestCase.assertRaisesRegexp`` method from ``unittest``):
 
-In the context manager form you may use the keyword argument
-``message`` to specify a custom failure message::
+.. code-block:: python
 
-     >>> with raises(ZeroDivisionError, message="Expecting ZeroDivisionError"):
-     ...     pass
-     ... Failed: Expecting ZeroDivisionError
+    import pytest
 
-If you want to write test code that works on Python 2.4 as well,
-you may also use two other ways to test for an expected exception::
+
+    def myfunc():
+        raise ValueError("Exception 123 raised")
+
+
+    def test_match():
+        with pytest.raises(ValueError, match=r".* 123 .*"):
+            myfunc()
+
+The regexp parameter of the ``match`` method is matched with the ``re.search``
+function, so in the above example ``match='123'`` would have worked as
+well.
+
+There's an alternate form of the ``pytest.raises`` function where you pass
+a function that will be executed with the given ``*args`` and ``**kwargs`` and
+assert that the given exception is raised:
+
+.. code-block:: python
 
     pytest.raises(ExpectedException, func, *args, **kwargs)
-    pytest.raises(ExpectedException, "func(*args, **kwargs)")
 
-both of which execute the specified function with args and kwargs and
-asserts that the given ``ExpectedException`` is raised.  The reporter will
-provide you with helpful output in case of failures such as *no
+The reporter will provide you with helpful output in case of failures such as *no
 exception* or *wrong exception*.
 
 Note that it is also possible to specify a "raises" argument to
 ``pytest.mark.xfail``, which checks that the test is failing in a more
-specific way than just having any exception raised::
+specific way than just having any exception raised:
+
+.. code-block:: python
 
     @pytest.mark.xfail(raises=IndexError)
     def test_f():
@@ -121,30 +148,13 @@ exceptions your own code is deliberately raising, whereas using
 like documenting unfixed bugs (where the test describes what "should" happen)
 or bugs in dependencies.
 
-Also, the context manager form accepts a ``match`` keyword parameter to test
-that a regular expression matches on the string representation of an exception
-(like the ``TestCase.assertRaisesRegexp`` method from ``unittest``)::
-
-    import pytest
-
-    def myfunc():
-        raise ValueError("Exception 123 raised")
-
-    def test_match():
-        with pytest.raises(ValueError, match=r'.* 123 .*'):
-            myfunc()
-
-The regexp parameter of the ``match`` method is matched with the ``re.search``
-function. So in the above example ``match='123'`` would have worked as
-well.
-
 
 .. _`assertwarns`:
 
 Assertions about expected warnings
 -----------------------------------------
 
-.. versionadded:: 2.8
+
 
 You can check that code raises a particular warning using
 :ref:`pytest.warns <warns>`.
@@ -155,13 +165,16 @@ You can check that code raises a particular warning using
 Making use of context-sensitive comparisons
 -------------------------------------------------
 
-.. versionadded:: 2.0
+
 
 ``pytest`` has rich support for providing context-sensitive information
-when it encounters comparisons.  For example::
+when it encounters comparisons.  For example:
+
+.. code-block:: python
 
     # content of test_assert2.py
 
+
     def test_set_comparison():
         set1 = set("1308")
         set2 = set("8035")
@@ -174,7 +187,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_assert2.py F                                                    [100%]
@@ -193,7 +207,7 @@ if you run this module:
     E         '5'
     E         Use -v to get the full diff
 
-    test_assert2.py:5: AssertionError
+    test_assert2.py:6: AssertionError
     ========================= 1 failed in 0.12 seconds =========================
 
 Special comparisons are done for a number of cases:
@@ -204,8 +218,8 @@ Special comparisons are done for a number of cases:
 
 See the :ref:`reporting demo <tbreportdemo>` for many more examples.
 
-Defining your own assertion comparison
-----------------------------------------------
+Defining your own explanation for failed assertions
+---------------------------------------------------
 
 It is possible to add your own detailed explanations by implementing
 the ``pytest_assertrepr_compare`` hook.
@@ -214,16 +228,21 @@ the ``pytest_assertrepr_compare`` hook.
    :noindex:
 
 As an example consider adding the following hook in a :ref:`conftest.py <conftest.py>`
-file which provides an alternative explanation for ``Foo`` objects::
+file which provides an alternative explanation for ``Foo`` objects:
+
+.. code-block:: python
 
    # content of conftest.py
    from test_foocompare import Foo
+
+
    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: %s != %s" % (left.val, right.val)]
 
-now, given this test module::
+now, given this test module:
+
+.. code-block:: python
 
    # content of test_foocompare.py
    class Foo(object):
@@ -233,6 +252,7 @@ now, given this test module::
        def __eq__(self, other):
            return self.val == other.val
 
+
    def test_compare():
        f1 = Foo(1)
        f2 = Foo(2)
@@ -255,16 +275,16 @@ the conftest file:
    E       assert Comparing Foo instances:
    E            vals: 1 != 2
 
-   test_foocompare.py:11: AssertionError
+   test_foocompare.py:12: AssertionError
    1 failed in 0.12 seconds
 
 .. _assert-details:
 .. _`assert introspection`:
 
-Advanced assertion introspection
-----------------------------------
+Assertion introspection details
+-------------------------------
+
 
-.. versionadded:: 2.1
 
 
 Reporting details about a failing assertion is achieved by rewriting assert
@@ -275,35 +295,53 @@ supporting modules which are not themselves test modules will not be rewritten**
 
 You can manually enable assertion rewriting for an imported module by calling
 `register_assert_rewrite <https://docs.pytest.org/en/latest/writing_plugins.html#assertion-rewriting>`_
-before you import it (a good place to do that is in ``conftest.py``).
-
-.. note::
-
-   ``pytest`` rewrites test modules on import by using an import
-   hook to write new ``pyc`` files. Most of the time this works transparently.
-   However, if you are messing with import yourself, the import hook may
-   interfere.
-
-   If this is the case you have two options:
-
-   * Disable rewriting for a specific module by adding the string
-     ``PYTEST_DONT_REWRITE`` to its docstring.
-
-   * Disable rewriting for all modules by using ``--assert=plain``.
-
-   Additionally, rewriting will fail silently if it cannot write new ``.pyc`` files,
-   i.e. in a read-only filesystem or a zipfile.
-
+before you import it (a good place to do that is in your root ``conftest.py``).
 
 For further information, Benjamin Peterson wrote up `Behind the scenes of pytest's new assertion rewriting <http://pybites.blogspot.com/2011/07/behind-scenes-of-pytests-new-assertion.html>`_.
 
-.. versionadded:: 2.1
+Assertion rewriting caches files on disk
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``pytest`` will write back the rewritten modules to disk for caching. You can disable
+this behavior (for example to avoid leaving stale ``.pyc`` files around in projects that
+move files around a lot) by adding this to the top of your ``conftest.py`` file:
+
+.. code-block:: python
+
+   import sys
+
+   sys.dont_write_bytecode = True
+
+Note that you still get the benefits of assertion introspection, the only change is that
+the ``.pyc`` files won't be cached on disk.
+
+Additionally, rewriting will silently skip caching if it cannot write new ``.pyc`` files,
+i.e. in a read-only filesystem or a zipfile.
+
+
+Disabling assert rewriting
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``pytest`` rewrites test modules on import by using an import
+hook to write new ``pyc`` files. Most of the time this works transparently.
+However, if you are working with the import machinery yourself, the import hook may
+interfere.
+
+If this is the case you have two options:
+
+* Disable rewriting for a specific module by adding the string
+  ``PYTEST_DONT_REWRITE`` to its docstring.
+
+* Disable rewriting for all modules by using ``--assert=plain``.
+
+
+
    Add assert rewriting as an alternate introspection technique.
 
-.. versionchanged:: 2.1
+
    Introduce the ``--assert`` option. Deprecate ``--no-assert`` and
    ``--nomagic``.
 
-.. versionchanged:: 3.0
+
    Removes the ``--no-assert`` and ``--nomagic`` options.
    Removes the ``--assert=reinterp`` option.

doc/en/bash-completion.rst

@@ -8,18 +8,26 @@ When using bash as your shell, ``pytest`` can use argcomplete
 (https://argcomplete.readthedocs.io/) for auto-completion.
 For this ``argcomplete`` needs to be installed **and** enabled.
 
-Install argcomplete using::
+Install argcomplete using:
 
-        sudo pip install 'argcomplete>=0.5.7'
+.. code-block:: bash
 
-For global activation of all argcomplete enabled python applications run::
+    sudo pip install 'argcomplete>=0.5.7'
+
+For global activation of all argcomplete enabled python applications run:
+
+.. code-block:: bash
 
     sudo activate-global-python-argcomplete
 
-For permanent (but not global) ``pytest`` activation, use::
+For permanent (but not global) ``pytest`` activation, use:
 
-        register-python-argcomplete pytest >> ~/.bashrc
+.. code-block:: bash
 
-For one-time activation of argcomplete for ``pytest`` only, use::
+    register-python-argcomplete pytest >> ~/.bashrc
 
-        eval "$(register-python-argcomplete pytest)"
+For one-time activation of argcomplete for ``pytest`` only, use:
+
+.. code-block:: bash
+
+    eval "$(register-python-argcomplete pytest)"

doc/en/builtin.rst

@@ -28,25 +28,29 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
 
         Values can be any object handled by the json stdlib module.
     capsys
-        Enable capturing of writes to ``sys.stdout`` and ``sys.stderr`` and make
-        captured output available via ``capsys.readouterr()`` method calls
-        which return a ``(out, err)`` namedtuple.  ``out`` and ``err`` will be ``text``
-        objects.
+        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 capturing of writes to ``sys.stdout`` and ``sys.stderr`` and make
-        captured output available via ``capsys.readouterr()`` method calls
-        which return a ``(out, err)`` tuple.  ``out`` and ``err`` will be ``bytes``
-        objects.
+        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 capturing of writes to file descriptors ``1`` and ``2`` and make
-        captured output available via ``capfd.readouterr()`` method calls
-        which return a ``(out, err)`` tuple.  ``out`` and ``err`` will be ``text``
-        objects.
+        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 capturing of write to file descriptors 1 and 2 and make
-        captured output available via ``capfdbinary.readouterr`` method calls
-        which return a ``(out, err)`` tuple.  ``out`` and ``err`` will be
-        ``bytes`` objects.
+        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
         Fixture that returns a :py:class:`dict` that will be injected into the namespace of doctests.
     pytestconfig
@@ -55,7 +59,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
         Example::
 
             def test_foo(pytestconfig):
-                if pytestconfig.getoption("verbose"):
+                if pytestconfig.getoption("verbose") > 0:
                     ...
     record_property
         Add an extra properties the calling test.
@@ -68,8 +72,6 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
 
             def test_function(record_property):
                 record_property("example_key", 1)
-    record_xml_property
-        (Deprecated) use record_property.
     record_xml_attribute
         Add extra xml attributes to the tag for the calling test.
         The fixture is callable with ``(name, value)``, with value being

doc/en/cache.rst

@@ -5,7 +5,7 @@
 Cache: working with cross-testrun state
 =======================================
 
-.. versionadded:: 2.8
+
 
 Usage
 ---------
@@ -81,8 +81,9 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 50 items / 48 deselected
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collected 50 items / 48 deselected / 2 selected
     run-last-failure: rerun previous 2 failures
 
     test_50.py FF                                                        [100%]
@@ -124,7 +125,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 50 items
     run-last-failure: rerun previous 2 failures first
 
@@ -166,7 +168,9 @@ Behavior when no tests failed in the last run
 
 When no tests failed in the last run, or when no cached ``lastfailed`` data was
 found, ``pytest`` can be configured either to run all of the tests or no tests,
-using the ``--last-failed-no-failures`` option, which takes one of the following values::
+using the ``--last-failed-no-failures`` option, which takes one of the following values:
+
+.. code-block:: bash
 
     pytest --last-failed --last-failed-no-failures all    # run all tests (default behavior)
     pytest --last-failed --last-failed-no-failures none   # run no tests and exit
@@ -185,11 +189,14 @@ across pytest invocations::
     import pytest
     import time
 
+    def expensive_computation():
+        print("running expensive computation...")
+
     @pytest.fixture
     def mydata(request):
         val = request.config.cache.get("example/value", None)
         if val is None:
-            time.sleep(9*0.6) # expensive computation :)
+            expensive_computation()
             val = 42
             request.config.cache.set("example/value", val)
         return val
@@ -197,8 +204,7 @@ across pytest invocations::
     def test_function(mydata):
         assert mydata == 23
 
-If you run this command once, it will take a while because
-of the sleep:
+If you run this command for the first time, you can see the print statement:
 
 .. code-block:: pytest
 
@@ -213,11 +219,13 @@ of the sleep:
     >       assert mydata == 23
     E       assert 42 == 23
 
-    test_caching.py:14: AssertionError
+    test_caching.py:17: AssertionError
+    -------------------------- Captured stdout setup ---------------------------
+    running expensive computation...
     1 failed in 0.12 seconds
 
 If you run it a second time the value will be retrieved from
-the cache and this will be quick:
+the cache and nothing will be printed:
 
 .. code-block:: pytest
 
@@ -232,7 +240,7 @@ the cache and this will be quick:
     >       assert mydata == 23
     E       assert 42 == 23
 
-    test_caching.py:14: AssertionError
+    test_caching.py:17: AssertionError
     1 failed in 0.12 seconds
 
 See the :ref:`cache-api` for more details.
@@ -249,11 +257,17 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    cachedir: $REGENDOC_TMPDIR/.pytest_cache
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     ------------------------------- cache values -------------------------------
     cache/lastfailed contains:
-      {'test_caching.py::test_function': True}
+      {'test_50.py::test_num[17]': True,
+       'test_50.py::test_num[25]': True,
+       'test_assert1.py::test_function': True,
+       'test_assert2.py::test_set_comparison': True,
+       'test_caching.py::test_function': True,
+       'test_foocompare.py::test_compare': True}
     cache/nodeids contains:
       ['test_caching.py::test_function']
     cache/stepwise contains:
@@ -267,7 +281,9 @@ Clearing Cache content
 -------------------------------
 
 You can instruct pytest to clear all cache files and values
-by adding the ``--cache-clear`` option like this::
+by adding the ``--cache-clear`` option like this:
+
+.. code-block:: bash
 
     pytest --cache-clear
 

doc/en/capture.rst

@@ -35,7 +35,9 @@ There are two ways in which ``pytest`` can perform capturing:
 
 .. _`disable capturing`:
 
-You can influence output capturing mechanisms from the command line::
+You can influence output capturing mechanisms from the command line:
+
+.. code-block:: bash
 
     pytest -s            # disable all capturing
     pytest --capture=sys # replace sys.stdout/stderr with in-mem files
@@ -68,7 +70,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 2 items
 
     test_module.py .F                                                    [100%]
@@ -118,11 +121,11 @@ same interface but allows to also capture output from
 libraries or subprocesses that directly write to operating
 system level output streams (FD1 and FD2).
 
-.. versionadded:: 3.3
+
 
 The return value from ``readouterr`` changed to a ``namedtuple`` with two attributes, ``out`` and ``err``.
 
-.. versionadded:: 3.3
+
 
 If the code under test writes non-textual data, you can capture this using
 the ``capsysbinary`` fixture which instead returns ``bytes`` from
@@ -130,7 +133,7 @@ the ``readouterr`` method.  The ``capfsysbinary`` fixture is currently only
 available in python 3.
 
 
-.. versionadded:: 3.3
+
 
 If the code under test writes non-textual data, you can capture this using
 the ``capfdbinary`` fixture which instead returns ``bytes`` from
@@ -138,7 +141,7 @@ the ``readouterr`` method.  The ``capfdbinary`` fixture operates on the
 filedescriptor level.
 
 
-.. versionadded:: 3.0
+
 
 To temporarily disable capture within a test, both ``capsys``
 and ``capfd`` have a ``disabled()`` method that can be used

doc/en/conf.py

@@ -42,10 +42,11 @@ todo_include_todos = 1
 extensions = [
     "pygments_pytest",
     "sphinx.ext.autodoc",
-    "sphinx.ext.todo",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
     "sphinx.ext.viewcode",
+    "sphinx_removed_in",
     "sphinxcontrib_trio",
 ]
 
@@ -64,7 +65,7 @@ master_doc = "contents"
 # General information about the project.
 project = u"pytest"
 year = datetime.datetime.utcnow().year
-copyright = u"2015–2018 , holger krekel and pytest-dev team"
+copyright = u"2015–2019 , holger krekel and pytest-dev team"
 
 
 # The language for content autogenerated by Sphinx. Refer to documentation
@@ -334,7 +335,7 @@ intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 def setup(app):
     # from sphinx.ext.autodoc import cut_lines
     # app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
-    app.add_description_unit(
+    app.add_object_type(
         "confval",
         "confval",
         objname="configuration value",

doc/en/contents.rst

@@ -41,6 +41,7 @@ Full pytest documentation
 
    backwards-compatibility
    deprecations
+   py27-py34-deprecation
    historical-notes
    license
    contributing

doc/en/customize.rst

@@ -5,7 +5,9 @@ Command line options and configuration file settings
 -----------------------------------------------------------------
 
 You can get help on command line options and values in INI-style
-configurations files by using the general help option::
+configurations files by using the general help option:
+
+.. code-block:: bash
 
     pytest -h   # prints options _and_ config file settings
 
@@ -18,7 +20,7 @@ which were registered by installed plugins.
 Initialization: determining rootdir and inifile
 -----------------------------------------------
 
-.. versionadded:: 2.7
+
 
 pytest determines a ``rootdir`` for each test run which depends on
 the command line arguments (specified test files, paths) and on
@@ -88,16 +90,20 @@ The ``config`` object will subsequently carry these attributes:
 
 - ``config.inifile``: the determined ini-file, may be ``None``.
 
-The rootdir is used a reference directory for constructing test
+The rootdir is used as a reference directory for constructing test
 addresses ("nodeids") and can be used also by plugins for storing
 per-testrun information.
 
-Example::
+Example:
+
+.. code-block:: bash
 
     pytest path/to/testdir path/other/
 
 will determine the common ancestor as ``path`` and then
-check for ini-files as follows::
+check for ini-files as follows:
+
+.. code-block:: text
 
     # first look for pytest.ini files
     path/pytest.ini
@@ -127,25 +133,33 @@ progress output, you can write it into a configuration file:
 
 .. code-block:: ini
 
-    # content of pytest.ini
-    # (or tox.ini or setup.cfg)
+    # content of pytest.ini or tox.ini
+    # setup.cfg files should use [tool:pytest] section instead
     [pytest]
     addopts = -ra -q
 
 Alternatively, you can set a ``PYTEST_ADDOPTS`` environment variable to add command
-line options while the environment is in use::
+line options while the environment is in use:
+
+.. code-block:: bash
 
     export PYTEST_ADDOPTS="-v"
 
-Here's how the command-line is built in the presence of ``addopts`` or the environment variable::
+Here's how the command-line is built in the presence of ``addopts`` or the environment variable:
+
+.. code-block:: text
 
     <pytest.ini:addopts> $PYTEST_ADDOPTS <extra command-line arguments>
 
-So if the user executes in the command-line::
+So if the user executes in the command-line:
+
+.. code-block:: bash
 
     pytest -m slow
 
-The actual command line executed is::
+The actual command line executed is:
+
+.. code-block:: bash
 
     pytest -ra -q -v -m slow
 

doc/en/deprecations.rst

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

doc/en/doctest.rst

@@ -4,31 +4,69 @@ Doctest integration for modules and test files
 
 By default all files matching the ``test*.txt`` pattern will
 be run through the python standard ``doctest`` module.  You
-can change the pattern by issuing::
+can change the pattern by issuing:
+
+.. code-block:: bash
 
     pytest --doctest-glob='*.rst'
 
-on the command line. Since version ``2.9``, ``--doctest-glob``
-can be given multiple times in the command-line.
+on the command line. ``--doctest-glob`` can be given multiple times in the command-line.
 
-.. versionadded:: 3.1
+If you then have a text file like this:
 
-    You can specify the encoding that will be used for those doctest files
-    using the ``doctest_encoding`` ini option:
+.. code-block:: text
 
-    .. code-block:: ini
+    # content of test_example.txt
 
-        # content of pytest.ini
-        [pytest]
-        doctest_encoding = latin1
+    hello this is a doctest
+    >>> x = 3
+    >>> x
+    3
 
-    The default encoding is UTF-8.
+then you can just invoke ``pytest`` directly:
 
-You can also trigger running of doctests
-from docstrings in all python modules (including regular
-python test modules)::
+.. code-block:: pytest
 
-    pytest --doctest-modules
+    $ pytest
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collected 1 item
+
+    test_example.txt .                                                   [100%]
+
+    ========================= 1 passed in 0.12 seconds =========================
+
+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).
+
+In addition to text files, you can also execute doctests directly from docstrings of your classes
+and functions, including from test modules:
+
+.. code-block:: python
+
+    # content of mymodule.py
+    def something():
+        """ a doctest in a docstring
+        >>> something()
+        42
+        """
+        return 42
+
+.. code-block:: bash
+
+    $ pytest --doctest-modules
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collected 2 items
+
+    mymodule.py .                                                        [ 50%]
+    test_example.txt .                                                   [100%]
+
+    ========================= 2 passed in 0.12 seconds =========================
 
 You can make these changes permanent in your project by
 putting them into a pytest.ini file like this:
@@ -39,52 +77,37 @@ putting them into a pytest.ini file like this:
     [pytest]
     addopts = --doctest-modules
 
-If you then have a text file like this::
+.. note::
 
-    # content of example.rst
+    The builtin pytest doctest supports only ``doctest`` blocks, but if you are looking
+    for more advanced checking over *all* your documentation,
+    including doctests, ``.. codeblock:: python`` Sphinx directive support,
+    and any other examples your documentation may include, you may wish to
+    consider `Sybil <https://sybil.readthedocs.io/en/latest/index.html>`__.
+    It provides pytest integration out of the box.
 
-    hello this is a doctest
-    >>> x = 3
-    >>> x
-    3
 
-and another like this::
+Encoding
+--------
 
-    # content of mymodule.py
-    def something():
-        """ a doctest in a docstring
-        >>> something()
-        42
-        """
-        return 42
+The default encoding is **UTF-8**, but you can specify the encoding
+that will be used for those doctest files using the
+``doctest_encoding`` ini option:
 
-then you can just invoke ``pytest`` without command line options:
+.. code-block:: ini
 
-.. code-block:: pytest
+    # content of pytest.ini
+    [pytest]
+    doctest_encoding = latin1
 
-    $ pytest
-    =========================== test session starts ============================
-    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
-    rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
-    collected 1 item
+Using 'doctest' options
+-----------------------
 
-    mymodule.py .                                                        [100%]
+The 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.
 
-    ========================= 1 passed in 0.12 seconds =========================
-
-It is possible to use fixtures using the ``getfixture`` helper::
-
-    # content of example.rst
-    >>> tmp = getfixture('tmpdir')
-    >>> ...
-    >>>
-
-Also, :ref:`usefixtures` and :ref:`autouse` fixtures are supported
-when executing text doctest files.
-
-The standard ``doctest`` module provides some setting flags to configure the
-strictness of doctest tests. In pytest, you can enable those flags using the
-configuration file. To make pytest ignore trailing whitespaces and ignore
+For example, to make pytest ignore trailing whitespaces and ignore
 lengthy exception stack traces you can just write:
 
 .. code-block:: ini
@@ -101,34 +124,67 @@ Python 3 unchanged:
 * ``ALLOW_BYTES``: when enabled, the ``b`` prefix is stripped from byte strings
   in expected doctest output.
 
-As with any other option flag, these flags can be enabled in ``pytest.ini`` using
-the ``doctest_optionflags`` ini option:
+Alternatively, options can be enabled by an inline comment in the doc test
+itself:
 
-.. code-block:: ini
-
-    [pytest]
-    doctest_optionflags = ALLOW_UNICODE ALLOW_BYTES
-
-
-Alternatively, it 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'
 
-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::
+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:
+
+.. code-block:: bash
 
     pytest --doctest-modules --doctest-continue-on-failure
 
 
+Output format
+-------------
+
+You can change the diff output format on failure for your doctests
+by using one of standard doctest modules format in options
+(see :data:`python:doctest.REPORT_UDIFF`, :data:`python:doctest.REPORT_CDIFF`,
+:data:`python:doctest.REPORT_NDIFF`, :data:`python:doctest.REPORT_ONLY_FIRST_FAILURE`):
+
+.. code-block:: bash
+
+    pytest --doctest-modules --doctest-report none
+    pytest --doctest-modules --doctest-report udiff
+    pytest --doctest-modules --doctest-report cdiff
+    pytest --doctest-modules --doctest-report ndiff
+    pytest --doctest-modules --doctest-report only_first_failure
+
+
+pytest-specific features
+------------------------
+
+Some features are provided to make writing doctests easier or with better integration with
+your existing test suite. Keep in mind however that by using those features you will make
+your doctests incompatible with the standard ``doctests`` module.
+
+Using fixtures
+^^^^^^^^^^^^^^
+
+It is possible to use fixtures using the ``getfixture`` helper:
+
+.. code-block:: text
+
+    # content of example.rst
+    >>> tmp = getfixture('tmpdir')
+    >>> ...
+    >>>
+
+Also, :ref:`usefixtures` and :ref:`autouse` fixtures are supported
+when executing text doctest files.
+
+
 .. _`doctest_namespace`:
 
-The 'doctest_namespace' fixture
--------------------------------
-
-.. versionadded:: 3.0
+'doctest_namespace' fixture
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The ``doctest_namespace`` fixture can be used to inject items into the
 namespace in which your doctests run. It is intended to be used within
@@ -158,18 +214,14 @@ Note that like the normal ``conftest.py``, the fixtures are discovered in the di
 Meaning that if you put your doctest with your source code, the relevant conftest.py needs to be in the same directory tree.
 Fixtures will not be discovered in a sibling directory tree!
 
-Output format
--------------
+Skipping tests dynamically
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. versionadded:: 3.0
+.. versionadded:: 4.4
 
-You can change the diff output format on failure for your doctests
-by using one of standard doctest modules format in options
-(see :data:`python:doctest.REPORT_UDIFF`, :data:`python:doctest.REPORT_CDIFF`,
-:data:`python:doctest.REPORT_NDIFF`, :data:`python:doctest.REPORT_ONLY_FIRST_FAILURE`)::
+You can use ``pytest.skip`` to dynamically skip doctests. For example::
 
-    pytest --doctest-modules --doctest-report none
-    pytest --doctest-modules --doctest-report udiff
-    pytest --doctest-modules --doctest-report cdiff
-    pytest --doctest-modules --doctest-report ndiff
-    pytest --doctest-modules --doctest-report only_first_failure
+    >>> import sys, pytest
+    >>> if sys.platform.startswith('win'):
+    ...     pytest.skip('this doctest does not work on Windows')
+    ...

doc/en/example/assertion/failure_demo.py

@@ -1,5 +1,3 @@
-import six
-
 import _pytest._code
 import pytest
 from pytest import raises
@@ -98,6 +96,30 @@ class TestSpecialisedExplanations(object):
         text = "head " * 50 + "f" * 70 + "tail " * 20
         assert "f" * 70 not in text
 
+    def test_eq_dataclass(self):
+        from dataclasses import dataclass
+
+        @dataclass
+        class Foo(object):
+            a: int
+            b: str
+
+        left = Foo(1, "b")
+        right = Foo(1, "c")
+        assert left == right
+
+    def test_eq_attrs(self):
+        import attr
+
+        @attr.s
+        class Foo(object):
+            a = attr.ib()
+            b = attr.ib()
+
+        left = Foo(1, "b")
+        right = Foo(1, "c")
+        assert left == right
+
 
 def test_attribute():
     class Foo(object):
@@ -141,11 +163,11 @@ def globf(x):
 
 class TestRaises(object):
     def test_raises(self):
-        s = "qwe"  # NOQA
-        raises(TypeError, "int(s)")
+        s = "qwe"
+        raises(TypeError, int, s)
 
     def test_raises_doesnt(self):
-        raises(IOError, "int('3')")
+        raises(IOError, int, "3")
 
     def test_raise(self):
         raise ValueError("demo error")
@@ -175,7 +197,7 @@ def test_dynamic_compile_shows_nicely():
     name = "abc-123"
     module = imp.new_module(name)
     code = _pytest._code.compile(src, name, "exec")
-    six.exec_(code, module.__dict__)
+    exec(code, module.__dict__)
     sys.modules[name] = module
     module.foo()
 

doc/en/example/assertion/test_failures.py

@@ -9,5 +9,5 @@ def test_failure_demo_fails_properly(testdir):
     failure_demo.copy(target)
     failure_demo.copy(testdir.tmpdir.join(failure_demo.basename))
     result = testdir.runpytest(target, syspathinsert=True)
-    result.stdout.fnmatch_lines(["*42 failed*"])
+    result.stdout.fnmatch_lines(["*44 failed*"])
     assert result.ret != 0

doc/en/example/attic.rst

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

doc/en/example/markers.rst

@@ -9,23 +9,33 @@ Here are some example using the :ref:`mark` mechanism.
 Marking test functions and selecting them for a run
 ----------------------------------------------------
 
-You can "mark" a test function with custom metadata like this::
+You can "mark" a test function with custom metadata like this:
+
+.. code-block:: python
 
     # content of test_server.py
 
     import pytest
+
+
     @pytest.mark.webtest
     def test_send_http():
-        pass # perform some webtest test for your app
+        pass  # perform some webtest test for your app
+
+
     def test_something_quick():
         pass
+
+
     def test_another():
         pass
+
+
     class TestClass(object):
         def test_method(self):
             pass
 
-.. versionadded:: 2.2
+
 
 You can then restrict a test run to only run tests marked with ``webtest``:
 
@@ -33,10 +43,10 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 4 items / 3 deselected
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collecting ... collected 4 items / 3 deselected / 1 selected
 
     test_server.py::test_send_http PASSED                                [100%]
 
@@ -48,10 +58,10 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 4 items / 1 deselected
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collecting ... collected 4 items / 1 deselected / 3 selected
 
     test_server.py::test_something_quick PASSED                          [ 33%]
     test_server.py::test_another PASSED                                  [ 66%]
@@ -70,9 +80,9 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collecting ... collected 1 item
 
     test_server.py::TestClass::test_method PASSED                        [100%]
@@ -85,9 +95,9 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collecting ... collected 1 item
 
     test_server.py::TestClass::test_method PASSED                        [100%]
@@ -100,9 +110,9 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collecting ... collected 2 items
 
     test_server.py::TestClass::test_method PASSED                        [ 50%]
@@ -140,10 +150,10 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 4 items / 3 deselected
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collecting ... collected 4 items / 3 deselected / 1 selected
 
     test_server.py::test_send_http PASSED                                [100%]
 
@@ -155,10 +165,10 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 4 items / 1 deselected
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collecting ... collected 4 items / 1 deselected / 3 selected
 
     test_server.py::test_something_quick PASSED                          [ 33%]
     test_server.py::test_another PASSED                                  [ 66%]
@@ -172,10 +182,10 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 4 items / 2 deselected
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collecting ... collected 4 items / 2 deselected / 2 selected
 
     test_server.py::test_send_http PASSED                                [ 50%]
     test_server.py::test_something_quick PASSED                          [100%]
@@ -200,18 +210,22 @@ Or to select "http" and "quick" tests:
 Registering markers
 -------------------------------------
 
-.. versionadded:: 2.2
+
 
 .. ini-syntax for custom markers:
 
-Registering markers for your test suite is simple::
+Registering markers for your test suite is simple:
+
+.. code-block:: ini
 
     # content of pytest.ini
     [pytest]
     markers =
         webtest: mark a test as a webtest.
 
-You can ask which markers exist for your test suite - the list includes our just defined ``webtest`` markers::
+You can ask which markers exist for your test suite - the list includes our just defined ``webtest`` markers:
+
+.. code-block:: pytest
 
     $ pytest --markers
     @pytest.mark.webtest: mark a test as a webtest.
@@ -253,14 +267,19 @@ Marking whole classes or modules
 ----------------------------------------------------
 
 You may use ``pytest.mark`` decorators with classes to apply markers to all of
-its test methods::
+its test methods:
+
+.. code-block:: python
 
     # content of test_mark_classlevel.py
     import pytest
+
+
     @pytest.mark.webtest
     class TestClass(object):
         def test_startup(self):
             pass
+
         def test_startup_and_more(self):
             pass
 
@@ -268,17 +287,23 @@ 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::
+``pytestmark`` attribute on a TestClass like this:
+
+.. code-block:: python
 
     import pytest
 
+
     class TestClass(object):
         pytestmark = pytest.mark.webtest
 
-or if you need to use multiple markers you can use a list::
+or if you need to use multiple markers you can use a list:
+
+.. code-block:: python
 
     import pytest
 
+
     class TestClass(object):
         pytestmark = [pytest.mark.webtest, pytest.mark.slowtest]
 
@@ -301,32 +326,24 @@ Marking individual tests when using parametrize
 
 When using parametrize, applying a mark will make it apply
 to each individual test. However it is also possible to
-apply a marker to an individual test instance::
+apply a marker to an individual test instance:
+
+.. code-block:: python
 
     import pytest
 
+
     @pytest.mark.foo
-    @pytest.mark.parametrize(("n", "expected"), [
-        (1, 2),
-        pytest.mark.bar((1, 3)),
-        (2, 3),
-    ])
+    @pytest.mark.parametrize(
+        ("n", "expected"), [(1, 2), pytest.param((1, 3), marks=pytest.mark.bar), (2, 3)]
+    )
     def test_increment(n, expected):
-         assert n + 1 == expected
+        assert n + 1 == expected
 
 In this example the mark "foo" will apply to each of the three
 tests, whereas the "bar" mark is only applied to the second test.
 Skip and xfail marks can also be applied in this way, see :ref:`skip/xfail with parametrize`.
 
-.. note::
-
-    If the data you are parametrizing happen to be single callables, you need to be careful
-    when marking these items. ``pytest.mark.xfail(my_func)`` won't work because it's also the
-    signature of a function being decorated. To resolve this ambiguity, you need to pass a
-    reason argument:
-    ``pytest.mark.xfail(func_bar, reason="Issue#7")``.
-
-
 .. _`adding a custom marker from a plugin`:
 
 Custom marker and command line option to control test runs
@@ -337,31 +354,46 @@ Custom marker and command line option to control test runs
 Plugins can provide custom markers and implement specific behaviour
 based on it. This is a self-contained example which adds a command
 line option and a parametrized test function marker to run tests
-specifies via named environments::
+specifies via named environments:
+
+.. code-block:: python
 
     # content of conftest.py
 
     import pytest
+
+
     def pytest_addoption(parser):
-        parser.addoption("-E", action="store", metavar="NAME",
-            help="only run tests matching the environment NAME.")
+        parser.addoption(
+            "-E",
+            action="store",
+            metavar="NAME",
+            help="only run tests matching the environment NAME.",
+        )
+
 
     def pytest_configure(config):
         # register an additional marker
-        config.addinivalue_line("markers",
-            "env(name): mark test to run only on named environment")
+        config.addinivalue_line(
+            "markers", "env(name): mark test to run only on named environment"
+        )
+
 
     def pytest_runtest_setup(item):
-        envnames = [mark.args[0] for mark in item.iter_markers(name='env')]
+        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)
 
-A test file using this local plugin::
+A test file using this local plugin:
+
+.. code-block:: python
 
     # content of test_someenv.py
 
     import pytest
+
+
     @pytest.mark.env("stage1")
     def test_basic_db_operation():
         pass
@@ -374,7 +406,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_someenv.py s                                                    [100%]
@@ -388,14 +421,17 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_someenv.py .                                                    [100%]
 
     ========================= 1 passed in 0.12 seconds =========================
 
-The ``--markers`` option always gives you a list of available markers::
+The ``--markers`` option always gives you a list of available markers:
+
+.. code-block:: pytest
 
     $ pytest --markers
     @pytest.mark.env(name): mark test to run only on named environment
@@ -424,25 +460,32 @@ Passing a callable to custom markers
 
 .. regendoc:wipe
 
-Below is the config file that will be used in the next examples::
+Below is the config file that will be used in the next examples:
+
+.. code-block:: python
 
     # content of conftest.py
     import sys
 
+
     def pytest_runtest_setup(item):
-        for marker in item.iter_markers(name='my_marker'):
+        for marker in item.iter_markers(name="my_marker"):
             print(marker)
             sys.stdout.flush()
 
 A custom marker can have its argument set, i.e. ``args`` and ``kwargs`` properties, defined by either invoking it as a callable or using ``pytest.mark.MARKER_NAME.with_args``. These two methods achieve the same effect most of the time.
 
-However, if there is a callable as the single positional argument with no keyword arguments, using the ``pytest.mark.MARKER_NAME(c)`` will not pass ``c`` as a positional argument but decorate ``c`` with the custom marker (see :ref:`MarkDecorator <mark>`). Fortunately, ``pytest.mark.MARKER_NAME.with_args`` comes to the rescue::
+However, if there is a callable as the single positional argument with no keyword arguments, using the ``pytest.mark.MARKER_NAME(c)`` will not pass ``c`` as a positional argument but decorate ``c`` with the custom marker (see :ref:`MarkDecorator <mark>`). Fortunately, ``pytest.mark.MARKER_NAME.with_args`` comes to the rescue:
+
+.. code-block:: python
 
     # content of test_custom_marker.py
     import pytest
 
+
     def hello_world(*args, **kwargs):
-        return 'Hello World'
+        return "Hello World"
+
 
     @pytest.mark.my_marker.with_args(hello_world)
     def test_with_args():
@@ -468,12 +511,16 @@ Reading markers which were set from multiple places
 .. regendoc:wipe
 
 If you are heavily using markers in your test suite you may encounter the case where a marker is applied several times to a test function.  From plugin
-code you can read over all such settings.  Example::
+code you can read over all such settings.  Example:
+
+.. code-block:: python
 
     # content of test_mark_three_times.py
     import pytest
+
     pytestmark = pytest.mark.glob("module", x=1)
 
+
     @pytest.mark.glob("class", x=2)
     class TestClass(object):
         @pytest.mark.glob("function", x=3)
@@ -481,13 +528,16 @@ code you can read over all such settings.  Example::
             pass
 
 Here we have the marker "glob" applied three times to the same
-test function.  From a conftest file we can read it like this::
+test function.  From a conftest file we can read it like this:
+
+.. code-block:: python
 
     # content of conftest.py
     import sys
 
+
     def pytest_runtest_setup(item):
-        for mark in item.iter_markers(name='glob'):
+        for mark in item.iter_markers(name="glob"):
             print("glob args=%s kwargs=%s" % (mark.args, mark.kwargs))
             sys.stdout.flush()
 
@@ -511,7 +561,9 @@ Consider you have a test suite which marks tests for particular platforms,
 namely ``pytest.mark.darwin``, ``pytest.mark.win32`` etc. and you
 also have tests that run on all platforms and have no specific
 marker.  If you now want to have a way to only run the tests
-for your particular platform, you could use the following plugin::
+for your particular platform, you could use the following plugin:
+
+.. code-block:: python
 
     # content of conftest.py
     #
@@ -520,6 +572,7 @@ for your particular platform, you could use the following plugin::
 
     ALL = set("darwin linux win32".split())
 
+
     def pytest_runtest_setup(item):
         supported_platforms = ALL.intersection(mark.name for mark in item.iter_markers())
         plat = sys.platform
@@ -527,24 +580,30 @@ for your particular platform, you could use the following plugin::
             pytest.skip("cannot run on platform %s" % (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::
+Let's do a little test file to show how this looks like:
+
+.. code-block:: python
 
     # content of test_plat.py
 
     import pytest
 
+
     @pytest.mark.darwin
     def test_if_apple_is_evil():
         pass
 
+
     @pytest.mark.linux
     def test_if_linux_works():
         pass
 
+
     @pytest.mark.win32
     def test_if_win32_crashes():
         pass
 
+
     def test_runs_everywhere():
         pass
 
@@ -555,12 +614,13 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 4 items
 
     test_plat.py s.s.                                                    [100%]
     ========================= short test summary info ==========================
-    SKIP [2] $REGENDOC_TMPDIR/conftest.py:12: cannot run on platform linux
+    SKIPPED [2] $REGENDOC_TMPDIR/conftest.py:13: cannot run on platform linux
 
     =================== 2 passed, 2 skipped in 0.12 seconds ====================
 
@@ -571,8 +631,9 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 4 items / 3 deselected
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collected 4 items / 3 deselected / 1 selected
 
     test_plat.py .                                                       [100%]
 
@@ -588,28 +649,38 @@ Automatically adding markers based on test names
 If you a test suite where test function names indicate a certain
 type of test, you can implement a hook that automatically defines
 markers so that you can use the ``-m`` option with it. Let's look
-at this test module::
+at this test module:
+
+.. code-block:: python
 
     # content of test_module.py
 
+
     def test_interface_simple():
         assert 0
 
+
     def test_interface_complex():
         assert 0
 
+
     def test_event_simple():
         assert 0
 
+
     def test_something_else():
         assert 0
 
 We want to dynamically define two markers and can do it in a
-``conftest.py`` plugin::
+``conftest.py`` plugin:
+
+.. code-block:: python
 
     # content of conftest.py
 
     import pytest
+
+
     def pytest_collection_modifyitems(items):
         for item in items:
             if "interface" in item.nodeid:
@@ -624,18 +695,19 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 4 items / 2 deselected
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collected 4 items / 2 deselected / 2 selected
 
     test_module.py FF                                                    [100%]
 
     ================================= FAILURES =================================
     __________________________ test_interface_simple ___________________________
-    test_module.py:3: in test_interface_simple
+    test_module.py:4: in test_interface_simple
         assert 0
     E   assert 0
     __________________________ test_interface_complex __________________________
-    test_module.py:6: in test_interface_complex
+    test_module.py:8: in test_interface_complex
         assert 0
     E   assert 0
     ================== 2 failed, 2 deselected in 0.12 seconds ==================
@@ -647,22 +719,23 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 4 items / 1 deselected
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collected 4 items / 1 deselected / 3 selected
 
     test_module.py FFF                                                   [100%]
 
     ================================= FAILURES =================================
     __________________________ test_interface_simple ___________________________
-    test_module.py:3: in test_interface_simple
+    test_module.py:4: in test_interface_simple
         assert 0
     E   assert 0
     __________________________ test_interface_complex __________________________
-    test_module.py:6: in test_interface_complex
+    test_module.py:8: in test_interface_complex
         assert 0
     E   assert 0
     ____________________________ test_event_simple _____________________________
-    test_module.py:9: in test_event_simple
+    test_module.py:12: in test_event_simple
         assert 0
     E   assert 0
     ================== 3 failed, 1 deselected in 0.12 seconds ==================

doc/en/example/multipython.py

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

doc/en/example/nonpython.rst

@@ -30,7 +30,8 @@ now execute the test specification:
     nonpython $ pytest test_simple.yml
     =========================== test session starts ============================
     platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
-    rootdir: $REGENDOC_TMPDIR/nonpython, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR/nonpython
     collected 2 items
 
     test_simple.yml F.                                                   [100%]
@@ -63,9 +64,9 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR/nonpython, inifile:
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR/nonpython
     collecting ... collected 2 items
 
     test_simple.yml::hello FAILED                                        [ 50%]
@@ -88,11 +89,12 @@ 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
-    rootdir: $REGENDOC_TMPDIR/nonpython, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR/nonpython
     collected 2 items
-    <Package '$REGENDOC_TMPDIR/nonpython'>
-      <YamlFile 'test_simple.yml'>
-        <YamlItem 'hello'>
-        <YamlItem 'ok'>
+    <Package $REGENDOC_TMPDIR/nonpython>
+      <YamlFile test_simple.yml>
+        <YamlItem hello>
+        <YamlItem ok>
 
     ======================= no tests ran in 0.12 seconds =======================

doc/en/example/parametrize.rst

@@ -145,17 +145,18 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 8 items
-    <Module 'test_time.py'>
-      <Function 'test_timedistance_v0[a0-b0-expected0]'>
-      <Function 'test_timedistance_v0[a1-b1-expected1]'>
-      <Function 'test_timedistance_v1[forward]'>
-      <Function 'test_timedistance_v1[backward]'>
-      <Function 'test_timedistance_v2[20011212-20011211-expected0]'>
-      <Function 'test_timedistance_v2[20011211-20011212-expected1]'>
-      <Function 'test_timedistance_v3[forward]'>
-      <Function 'test_timedistance_v3[backward]'>
+    <Module test_time.py>
+      <Function test_timedistance_v0[a0-b0-expected0]>
+      <Function test_timedistance_v0[a1-b1-expected1]>
+      <Function test_timedistance_v1[forward]>
+      <Function test_timedistance_v1[backward]>
+      <Function test_timedistance_v2[20011212-20011211-expected0]>
+      <Function test_timedistance_v2[20011211-20011212-expected1]>
+      <Function test_timedistance_v3[forward]>
+      <Function test_timedistance_v3[backward]>
 
     ======================= no tests ran in 0.12 seconds =======================
 
@@ -203,7 +204,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 4 items
 
     test_scenarios.py ....                                               [100%]
@@ -217,14 +219,15 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 4 items
-    <Module 'test_scenarios.py'>
-      <Class 'TestSampleWithScenarios'>
-          <Function 'test_demo1[basic]'>
-          <Function 'test_demo2[basic]'>
-          <Function 'test_demo1[advanced]'>
-          <Function 'test_demo2[advanced]'>
+    <Module test_scenarios.py>
+      <Class TestSampleWithScenarios>
+          <Function test_demo1[basic]>
+          <Function test_demo2[basic]>
+          <Function test_demo1[advanced]>
+          <Function test_demo2[advanced]>
 
     ======================= no tests ran in 0.12 seconds =======================
 
@@ -283,11 +286,12 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 2 items
-    <Module 'test_backends.py'>
-      <Function 'test_db_initialized[d1]'>
-      <Function 'test_db_initialized[d2]'>
+    <Module test_backends.py>
+      <Function test_db_initialized[d1]>
+      <Function test_db_initialized[d2]>
 
     ======================= no tests ran in 0.12 seconds =======================
 
@@ -348,10 +352,11 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
-    <Module 'test_indirect_list.py'>
-      <Function 'test_indirect[a-b]'>
+    <Module test_indirect_list.py>
+      <Function test_indirect[a-b]>
 
     ======================= no tests ran in 0.12 seconds =======================
 
@@ -388,7 +393,8 @@ parametrizer`_ but in a lot less code::
             assert a == b
 
         def test_zerodivision(self, a, b):
-            pytest.raises(ZeroDivisionError, "a/b")
+            with pytest.raises(ZeroDivisionError):
+                a / b
 
 Our test generator looks up a class-level definition which specifies which
 argument sets to use for each test function.  Let's run it:
@@ -430,7 +436,7 @@ Running it results in some skips if we don't have all the python interpreters in
    . $ pytest -rs -q multipython.py
    ...sss...sssssssss...sss...                                          [100%]
    ========================= short test summary info ==========================
-   SKIP [15] $REGENDOC_TMPDIR/CWD/multipython.py:30: 'python3.4' not found
+   SKIPPED [15] $REGENDOC_TMPDIR/CWD/multipython.py:30: 'python3.4' not found
    12 passed, 15 skipped in 0.12 seconds
 
 Indirect parametrization of optional implementations/imports
@@ -481,12 +487,13 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 2 items
 
     test_module.py .s                                                    [100%]
     ========================= short test summary info ==========================
-    SKIP [1] $REGENDOC_TMPDIR/conftest.py:11: could not import 'opt2'
+    SKIPPED [1] $REGENDOC_TMPDIR/conftest.py:11: could not import 'opt2'
 
     =================== 1 passed, 1 skipped in 0.12 seconds ====================
 
@@ -508,21 +515,25 @@ Set marks or test ID for individual parametrized test
 --------------------------------------------------------------------
 
 Use ``pytest.param`` to apply marks or set test ID to individual parametrized test.
-For example::
+For example:
+
+.. code-block:: python
 
     # content of test_pytest_param_example.py
     import pytest
-    @pytest.mark.parametrize('test_input,expected', [
-        ('3+5', 8),
-        pytest.param('1+7', 8,
-                     marks=pytest.mark.basic),
-        pytest.param('2+4', 6,
-                     marks=pytest.mark.basic,
-                     id='basic_2+4'),
-        pytest.param('6*9', 42,
-                     marks=[pytest.mark.basic, pytest.mark.xfail],
-                     id='basic_6*9'),
-    ])
+
+
+    @pytest.mark.parametrize(
+        "test_input,expected",
+        [
+            ("3+5", 8),
+            pytest.param("1+7", 8, marks=pytest.mark.basic),
+            pytest.param("2+4", 6, marks=pytest.mark.basic, id="basic_2+4"),
+            pytest.param(
+                "6*9", 42, marks=[pytest.mark.basic, pytest.mark.xfail], id="basic_6*9"
+            ),
+        ],
+    )
     def test_eval(test_input, expected):
         assert eval(test_input) == expected
 
@@ -537,14 +548,14 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collecting ... collected 17 items / 14 deselected
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collecting ... collected 17 items / 14 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%]
+    test_pytest_param_example.py::test_eval[basic_6*9] XFAIL             [100%]
 
     ============ 2 passed, 14 deselected, 1 xfailed in 0.12 seconds ============
 
@@ -556,3 +567,50 @@ As the result:
 - The test ``test_eval[1+7-8]`` passed, but the name is autogenerated and confusing.
 - The test ``test_eval[basic_2+4]`` passed.
 - The test ``test_eval[basic_6*9]`` was expected to fail and did fail.
+
+.. _`parametrizing_conditional_raising`:
+
+Parametrizing conditional raising
+--------------------------------------------------------------------
+
+Use :func:`pytest.raises` with the
+:ref:`pytest.mark.parametrize ref` decorator to write parametrized tests
+in which some tests raise exceptions and others do not.
+
+It is helpful to define a no-op context manager ``does_not_raise`` to serve
+as a complement to ``raises``. For example::
+
+    from contextlib import contextmanager
+    import pytest
+
+    @contextmanager
+    def does_not_raise():
+        yield
+
+
+    @pytest.mark.parametrize('example_input,expectation', [
+        (3, does_not_raise()),
+        (2, does_not_raise()),
+        (1, does_not_raise()),
+        (0, pytest.raises(ZeroDivisionError)),
+    ])
+    def test_division(example_input, expectation):
+        """Test how much I know division."""
+        with expectation:
+            assert (6 / example_input) is not None
+
+In the example above, the first three test cases should run unexceptionally,
+while the fourth should raise ``ZeroDivisionError``.
+
+If you're only supporting Python 3.7+, you can simply use ``nullcontext``
+to define ``does_not_raise``::
+
+    from contextlib import nullcontext as does_not_raise
+
+Or, if you're supporting Python 3.3+ you can use::
+
+    from contextlib import ExitStack as does_not_raise
+
+Or, if desired, you can ``pip install contextlib2`` and use::
+
+    from contextlib2 import ExitStack as does_not_raise

doc/en/example/pythoncollection.rst

@@ -6,7 +6,9 @@ Ignore paths during test collection
 
 You can easily ignore certain test directories and modules during collection
 by passing the ``--ignore=path`` option on the cli. ``pytest`` allows multiple
-``--ignore`` options. Example::
+``--ignore`` options. Example:
+
+.. code-block:: text
 
     tests/
     |-- example
@@ -41,6 +43,9 @@ you will see that ``pytest`` only collects test-modules, which do not match the
 
     ========================= 5 passed in 0.02 seconds =========================
 
+The ``--ignore-glob`` option allows to ignore test file paths based on Unix shell-style wildcards.
+If you want to exclude test-modules that end with ``_01.py``, execute ``pytest`` with ``--ignore-glob='*_01.py'``.
+
 Deselect tests during test collection
 -------------------------------------
 
@@ -54,7 +59,9 @@ Keeping duplicate paths specified from command line
 ----------------------------------------------------
 
 Default behavior of ``pytest`` is to ignore duplicate paths specified from the command line.
-Example::
+Example:
+
+.. code-block:: pytest
 
     pytest path_a path_a
 
@@ -65,7 +72,9 @@ Example::
 Just collect tests once.
 
 To collect duplicate tests, use the ``--keep-duplicates`` option on the cli.
-Example::
+Example:
+
+.. code-block:: pytest
 
     pytest --keep-duplicates path_a path_a
 
@@ -75,7 +84,9 @@ Example::
 
 As the collector just works on directories, if you specify twice a single test file, ``pytest`` will
 still collect it twice, no matter if the ``--keep-duplicates`` is not specified.
-Example::
+Example:
+
+.. code-block:: pytest
 
     pytest test_a.py test_a.py
 
@@ -87,7 +98,9 @@ Example::
 Changing directory recursion
 -----------------------------------------------------
 
-You can set the :confval:`norecursedirs` option in an ini-file, for example your ``pytest.ini`` in the project root directory::
+You can set the :confval:`norecursedirs` option in an ini-file, for example your ``pytest.ini`` in the project root directory:
+
+.. code-block:: ini
 
     # content of pytest.ini
     [pytest]
@@ -103,7 +116,9 @@ Changing naming conventions
 You can configure different naming conventions by setting
 the :confval:`python_files`, :confval:`python_classes` and
 :confval:`python_functions` configuration options.
-Here is an example::
+Here is an example:
+
+.. code-block:: ini
 
     # content of pytest.ini
     # Example 1: have pytest look for "check" instead of "test"
@@ -132,16 +147,19 @@ 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
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 2 items
-    <Module 'check_myapp.py'>
-      <Class 'CheckMyApp'>
-          <Function 'simple_check'>
-          <Function 'complex_check'>
+    <Module check_myapp.py>
+      <Class CheckMyApp>
+          <Function simple_check>
+          <Function complex_check>
 
     ======================= no tests ran in 0.12 seconds =======================
 
-You can check for multiple glob patterns by adding a space between the patterns::
+You can check for multiple glob patterns by adding a space between the patterns:
+
+.. code-block:: ini
 
     # Example 2: have pytest look for files with "test" and "example"
     # content of pytest.ini, tox.ini, or setup.cfg file (replace "pytest"
@@ -161,13 +179,17 @@ Interpreting cmdline arguments as Python packages
 You can use the ``--pyargs`` option to make ``pytest`` try
 interpreting arguments as python package names, deriving
 their file system path and then running the test. For
-example if you have unittest2 installed you can type::
+example if you have unittest2 installed you can type:
+
+.. code-block:: bash
 
     pytest --pyargs unittest2.test.test_skipping -q
 
 which would run the respective test module.  Like with
 other options, through an ini-file and the :confval:`addopts` option you
-can make this change more permanently::
+can make this change more permanently:
+
+.. code-block:: ini
 
     # content of pytest.ini
     [pytest]
@@ -187,13 +209,14 @@ 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
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 3 items
-    <Module 'CWD/pythoncollection.py'>
-      <Function 'test_function'>
-      <Class 'TestClass'>
-          <Function 'test_method'>
-          <Function 'test_anothermethod'>
+    <Module CWD/pythoncollection.py>
+      <Function test_function>
+      <Class TestClass>
+          <Function test_method>
+          <Function test_anothermethod>
 
     ======================= no tests ran in 0.12 seconds =======================
 
@@ -204,7 +227,9 @@ Customizing test collection
 
 .. regendoc:wipe
 
-You can easily instruct ``pytest`` to discover tests from every Python file::
+You can easily instruct ``pytest`` to discover tests from every Python file:
+
+.. code-block:: ini
 
     # content of pytest.ini
     [pytest]
@@ -259,7 +284,22 @@ 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
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 0 items
 
     ======================= no tests ran in 0.12 seconds =======================
+
+It's also possible to ignore files based on Unix shell-style wildcards by adding
+patterns to ``collect_ignore_glob``.
+
+The following example ``conftest.py`` ignores the file ``setup.py`` and in
+addition all files that end with ``*_py2.py`` when executed with a Python 3
+interpreter::
+
+    # content of conftest.py
+    import sys
+
+    collect_ignore = ["setup.py"]
+    if sys.version_info[0] > 2:
+        collect_ignore_glob = ["*_py2.py"]

doc/en/example/reportingdemo.rst

@@ -1,23 +1,20 @@
-
 .. _`tbreportdemo`:
 
 Demo of Python failure reports with pytest
-==================================================
+==========================================
 
-Here is a nice run of several tens of failures
-and how ``pytest`` presents things (unfortunately
-not showing the nice colors here in the HTML that you
-get on the terminal - we are working on that):
+Here is a nice run of several failures and how ``pytest`` presents things:
 
 .. code-block:: pytest
 
     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
-    rootdir: $REGENDOC_TMPDIR/assertion, inifile:
-    collected 42 items
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR/assertion
+    collected 44 items
 
-    failure_demo.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF           [100%]
+    failure_demo.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF         [100%]
 
     ================================= FAILURES =================================
     ___________________________ test_generative[3-6] ___________________________
@@ -29,7 +26,7 @@ get on the terminal - we are working on that):
     >       assert param1 * 2 < param2
     E       assert (3 * 2) < 6
 
-    failure_demo.py:22: AssertionError
+    failure_demo.py:20: AssertionError
     _________________________ TestFailing.test_simple __________________________
 
     self = <failure_demo.TestFailing object at 0xdeadbeef>
@@ -46,7 +43,7 @@ get on the terminal - we are working on that):
     E        +  where 42 = <function TestFailing.test_simple.<locals>.f at 0xdeadbeef>()
     E        +  and   43 = <function TestFailing.test_simple.<locals>.g at 0xdeadbeef>()
 
-    failure_demo.py:33: AssertionError
+    failure_demo.py:31: AssertionError
     ____________________ TestFailing.test_simple_multiline _____________________
 
     self = <failure_demo.TestFailing object at 0xdeadbeef>
@@ -54,7 +51,7 @@ get on the terminal - we are working on that):
         def test_simple_multiline(self):
     >       otherfunc_multi(42, 6 * 9)
 
-    failure_demo.py:36:
+    failure_demo.py:34:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
     a = 42, b = 54
@@ -63,7 +60,7 @@ get on the terminal - we are working on that):
     >       assert a == b
     E       assert 42 == 54
 
-    failure_demo.py:17: AssertionError
+    failure_demo.py:15: AssertionError
     ___________________________ TestFailing.test_not ___________________________
 
     self = <failure_demo.TestFailing object at 0xdeadbeef>
@@ -76,7 +73,7 @@ get on the terminal - we are working on that):
     E       assert not 42
     E        +  where 42 = <function TestFailing.test_not.<locals>.f at 0xdeadbeef>()
 
-    failure_demo.py:42: AssertionError
+    failure_demo.py:40: AssertionError
     _________________ TestSpecialisedExplanations.test_eq_text _________________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -87,7 +84,7 @@ get on the terminal - we are working on that):
     E         - spam
     E         + eggs
 
-    failure_demo.py:47: AssertionError
+    failure_demo.py:45: AssertionError
     _____________ TestSpecialisedExplanations.test_eq_similar_text _____________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -100,7 +97,7 @@ get on the terminal - we are working on that):
     E         + foo 2 bar
     E         ?     ^
 
-    failure_demo.py:50: AssertionError
+    failure_demo.py:48: AssertionError
     ____________ TestSpecialisedExplanations.test_eq_multiline_text ____________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -113,7 +110,7 @@ get on the terminal - we are working on that):
     E         + eggs
     E           bar
 
-    failure_demo.py:53: AssertionError
+    failure_demo.py:51: AssertionError
     ______________ TestSpecialisedExplanations.test_eq_long_text _______________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -130,7 +127,7 @@ get on the terminal - we are working on that):
     E         + 1111111111b222222222
     E         ?           ^
 
-    failure_demo.py:58: AssertionError
+    failure_demo.py:56: AssertionError
     _________ TestSpecialisedExplanations.test_eq_long_text_multiline __________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -150,7 +147,7 @@ get on the terminal - we are working on that):
     E
     E         ...Full output truncated (7 lines hidden), use '-vv' to show
 
-    failure_demo.py:63: AssertionError
+    failure_demo.py:61: AssertionError
     _________________ TestSpecialisedExplanations.test_eq_list _________________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -161,7 +158,7 @@ get on the terminal - we are working on that):
     E         At index 2 diff: 2 != 3
     E         Use -v to get the full diff
 
-    failure_demo.py:66: AssertionError
+    failure_demo.py:64: AssertionError
     ______________ TestSpecialisedExplanations.test_eq_list_long _______________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -174,7 +171,7 @@ get on the terminal - we are working on that):
     E         At index 100 diff: 1 != 2
     E         Use -v to get the full diff
 
-    failure_demo.py:71: AssertionError
+    failure_demo.py:69: AssertionError
     _________________ TestSpecialisedExplanations.test_eq_dict _________________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -192,7 +189,7 @@ get on the terminal - we are working on that):
     E
     E         ...Full output truncated (2 lines hidden), use '-vv' to show
 
-    failure_demo.py:74: AssertionError
+    failure_demo.py:72: AssertionError
     _________________ TestSpecialisedExplanations.test_eq_set __________________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -210,7 +207,7 @@ get on the terminal - we are working on that):
     E
     E         ...Full output truncated (2 lines hidden), use '-vv' to show
 
-    failure_demo.py:77: AssertionError
+    failure_demo.py:75: AssertionError
     _____________ TestSpecialisedExplanations.test_eq_longer_list ______________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -221,7 +218,7 @@ get on the terminal - we are working on that):
     E         Right contains more items, first extra item: 3
     E         Use -v to get the full diff
 
-    failure_demo.py:80: AssertionError
+    failure_demo.py:78: AssertionError
     _________________ TestSpecialisedExplanations.test_in_list _________________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -230,7 +227,7 @@ get on the terminal - we are working on that):
     >       assert 1 in [0, 2, 3, 4, 5]
     E       assert 1 in [0, 2, 3, 4, 5]
 
-    failure_demo.py:83: AssertionError
+    failure_demo.py:81: AssertionError
     __________ TestSpecialisedExplanations.test_not_in_text_multiline __________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -249,7 +246,7 @@ get on the terminal - we are working on that):
     E
     E         ...Full output truncated (2 lines hidden), use '-vv' to show
 
-    failure_demo.py:87: AssertionError
+    failure_demo.py:85: AssertionError
     ___________ TestSpecialisedExplanations.test_not_in_text_single ____________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -262,7 +259,7 @@ get on the terminal - we are working on that):
     E           single foo line
     E         ?        +++
 
-    failure_demo.py:91: AssertionError
+    failure_demo.py:89: AssertionError
     _________ TestSpecialisedExplanations.test_not_in_text_single_long _________
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -275,7 +272,7 @@ get on the terminal - we are working on that):
     E           head head foo tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail
     E         ?           +++
 
-    failure_demo.py:95: AssertionError
+    failure_demo.py:93: AssertionError
     ______ TestSpecialisedExplanations.test_not_in_text_single_long_term _______
 
     self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
@@ -288,7 +285,49 @@ get on the terminal - we are working on that):
     E           head head fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffftail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail
     E         ?           ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-    failure_demo.py:99: AssertionError
+    failure_demo.py:97: AssertionError
+    ______________ TestSpecialisedExplanations.test_eq_dataclass _______________
+
+    self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
+
+        def test_eq_dataclass(self):
+            from dataclasses import dataclass
+
+            @dataclass
+            class Foo(object):
+                a: int
+                b: str
+
+            left = Foo(1, "b")
+            right = Foo(1, "c")
+    >       assert left == right
+    E       AssertionError: assert TestSpecialis...oo(a=1, b='b') == TestSpecialise...oo(a=1, b='c')
+    E         Omitting 1 identical items, use -vv to show
+    E         Differing attributes:
+    E         b: 'b' != 'c'
+
+    failure_demo.py:109: AssertionError
+    ________________ TestSpecialisedExplanations.test_eq_attrs _________________
+
+    self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef>
+
+        def test_eq_attrs(self):
+            import attr
+
+            @attr.s
+            class Foo(object):
+                a = attr.ib()
+                b = attr.ib()
+
+            left = Foo(1, "b")
+            right = Foo(1, "c")
+    >       assert left == right
+    E       AssertionError: assert Foo(a=1, b='b') == Foo(a=1, b='c')
+    E         Omitting 1 identical items, use -vv to show
+    E         Differing attributes:
+    E         b: 'b' != 'c'
+
+    failure_demo.py:121: AssertionError
     ______________________________ test_attribute ______________________________
 
         def test_attribute():
@@ -300,7 +339,7 @@ get on the terminal - we are working on that):
     E       assert 1 == 2
     E        +  where 1 = <failure_demo.test_attribute.<locals>.Foo object at 0xdeadbeef>.b
 
-    failure_demo.py:107: AssertionError
+    failure_demo.py:129: AssertionError
     _________________________ test_attribute_instance __________________________
 
         def test_attribute_instance():
@@ -312,7 +351,7 @@ get on the terminal - we are working on that):
     E        +  where 1 = <failure_demo.test_attribute_instance.<locals>.Foo object at 0xdeadbeef>.b
     E        +    where <failure_demo.test_attribute_instance.<locals>.Foo object at 0xdeadbeef> = <class 'failure_demo.test_attribute_instance.<locals>.Foo'>()
 
-    failure_demo.py:114: AssertionError
+    failure_demo.py:136: AssertionError
     __________________________ test_attribute_failure __________________________
 
         def test_attribute_failure():
@@ -325,7 +364,7 @@ get on the terminal - we are working on that):
             i = Foo()
     >       assert i.b == 2
 
-    failure_demo.py:125:
+    failure_demo.py:147:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
     self = <failure_demo.test_attribute_failure.<locals>.Foo object at 0xdeadbeef>
@@ -334,7 +373,7 @@ get on the terminal - we are working on that):
     >       raise Exception("Failed to get attrib")
     E       Exception: Failed to get attrib
 
-    failure_demo.py:120: Exception
+    failure_demo.py:142: Exception
     _________________________ test_attribute_multiple __________________________
 
         def test_attribute_multiple():
@@ -351,31 +390,26 @@ get on the terminal - we are working on that):
     E        +  and   2 = <failure_demo.test_attribute_multiple.<locals>.Bar object at 0xdeadbeef>.b
     E        +    where <failure_demo.test_attribute_multiple.<locals>.Bar object at 0xdeadbeef> = <class 'failure_demo.test_attribute_multiple.<locals>.Bar'>()
 
-    failure_demo.py:135: AssertionError
+    failure_demo.py:157: AssertionError
     __________________________ TestRaises.test_raises __________________________
 
     self = <failure_demo.TestRaises object at 0xdeadbeef>
 
         def test_raises(self):
-            s = "qwe"  # NOQA
-    >       raises(TypeError, "int(s)")
+            s = "qwe"
+    >       raises(TypeError, int, s)
+    E       ValueError: invalid literal for int() with base 10: 'qwe'
 
-    failure_demo.py:145:
-    _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
-
-    >   int(s)
-    E   ValueError: invalid literal for int() with base 10: 'qwe'
-
-    <0-codegen $REGENDOC_TMPDIR/assertion/failure_demo.py:145>:1: ValueError
+    failure_demo.py:167: ValueError
     ______________________ TestRaises.test_raises_doesnt _______________________
 
     self = <failure_demo.TestRaises object at 0xdeadbeef>
 
         def test_raises_doesnt(self):
-    >       raises(IOError, "int('3')")
+    >       raises(IOError, int, "3")
     E       Failed: DID NOT RAISE <class 'OSError'>
 
-    failure_demo.py:148: Failed
+    failure_demo.py:170: Failed
     __________________________ TestRaises.test_raise ___________________________
 
     self = <failure_demo.TestRaises object at 0xdeadbeef>
@@ -384,7 +418,7 @@ get on the terminal - we are working on that):
     >       raise ValueError("demo error")
     E       ValueError: demo error
 
-    failure_demo.py:151: ValueError
+    failure_demo.py:173: ValueError
     ________________________ TestRaises.test_tupleerror ________________________
 
     self = <failure_demo.TestRaises object at 0xdeadbeef>
@@ -393,7 +427,7 @@ get on the terminal - we are working on that):
     >       a, b = [1]  # NOQA
     E       ValueError: not enough values to unpack (expected 2, got 1)
 
-    failure_demo.py:154: ValueError
+    failure_demo.py:176: ValueError
     ______ TestRaises.test_reinterpret_fails_with_print_for_the_fun_of_it ______
 
     self = <failure_demo.TestRaises object at 0xdeadbeef>
@@ -404,7 +438,7 @@ get on the terminal - we are working on that):
     >       a, b = items.pop()
     E       TypeError: 'int' object is not iterable
 
-    failure_demo.py:159: TypeError
+    failure_demo.py:181: TypeError
     --------------------------- Captured stdout call ---------------------------
     items is [1, 2, 3]
     ________________________ TestRaises.test_some_error ________________________
@@ -415,7 +449,7 @@ get on the terminal - we are working on that):
     >       if namenotexi:  # NOQA
     E       NameError: name 'namenotexi' is not defined
 
-    failure_demo.py:162: NameError
+    failure_demo.py:184: NameError
     ____________________ test_dynamic_compile_shows_nicely _____________________
 
         def test_dynamic_compile_shows_nicely():
@@ -426,18 +460,18 @@ get on the terminal - we are working on that):
             name = "abc-123"
             module = imp.new_module(name)
             code = _pytest._code.compile(src, name, "exec")
-            six.exec_(code, module.__dict__)
+            exec(code, module.__dict__)
             sys.modules[name] = module
     >       module.foo()
 
-    failure_demo.py:180:
+    failure_demo.py:202:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
         def foo():
     >    assert 1 == 0
     E    AssertionError
 
-    <2-codegen 'abc-123' $REGENDOC_TMPDIR/assertion/failure_demo.py:177>:2: AssertionError
+    <0-codegen 'abc-123' $REGENDOC_TMPDIR/assertion/failure_demo.py:199>:2: AssertionError
     ____________________ TestMoreErrors.test_complex_error _____________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -451,9 +485,9 @@ get on the terminal - we are working on that):
 
     >       somefunc(f(), g())
 
-    failure_demo.py:191:
+    failure_demo.py:213:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
-    failure_demo.py:13: in somefunc
+    failure_demo.py:11: in somefunc
         otherfunc(x, y)
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
@@ -463,7 +497,7 @@ get on the terminal - we are working on that):
     >       assert a == b
     E       assert 44 == 43
 
-    failure_demo.py:9: AssertionError
+    failure_demo.py:7: AssertionError
     ___________________ TestMoreErrors.test_z1_unpack_error ____________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -473,7 +507,7 @@ get on the terminal - we are working on that):
     >       a, b = items
     E       ValueError: not enough values to unpack (expected 2, got 0)
 
-    failure_demo.py:195: ValueError
+    failure_demo.py:217: ValueError
     ____________________ TestMoreErrors.test_z2_type_error _____________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -483,7 +517,7 @@ get on the terminal - we are working on that):
     >       a, b = items
     E       TypeError: 'int' object is not iterable
 
-    failure_demo.py:199: TypeError
+    failure_demo.py:221: TypeError
     ______________________ TestMoreErrors.test_startswith ______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -496,7 +530,7 @@ get on the terminal - we are working on that):
     E        +  where False = <built-in method startswith of str object at 0xdeadbeef>('456')
     E        +    where <built-in method startswith of str object at 0xdeadbeef> = '123'.startswith
 
-    failure_demo.py:204: AssertionError
+    failure_demo.py:226: AssertionError
     __________________ TestMoreErrors.test_startswith_nested ___________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -515,7 +549,7 @@ get on the terminal - we are working on that):
     E        +      where '123' = <function TestMoreErrors.test_startswith_nested.<locals>.f at 0xdeadbeef>()
     E        +    and   '456' = <function TestMoreErrors.test_startswith_nested.<locals>.g at 0xdeadbeef>()
 
-    failure_demo.py:213: AssertionError
+    failure_demo.py:235: AssertionError
     _____________________ TestMoreErrors.test_global_func ______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -526,7 +560,7 @@ get on the terminal - we are working on that):
     E        +  where False = isinstance(43, float)
     E        +    where 43 = globf(42)
 
-    failure_demo.py:216: AssertionError
+    failure_demo.py:238: AssertionError
     _______________________ TestMoreErrors.test_instance _______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -537,7 +571,7 @@ get on the terminal - we are working on that):
     E       assert 42 != 42
     E        +  where 42 = <failure_demo.TestMoreErrors object at 0xdeadbeef>.x
 
-    failure_demo.py:220: AssertionError
+    failure_demo.py:242: AssertionError
     _______________________ TestMoreErrors.test_compare ________________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -547,7 +581,7 @@ get on the terminal - we are working on that):
     E       assert 11 < 5
     E        +  where 11 = globf(10)
 
-    failure_demo.py:223: AssertionError
+    failure_demo.py:245: AssertionError
     _____________________ TestMoreErrors.test_try_finally ______________________
 
     self = <failure_demo.TestMoreErrors object at 0xdeadbeef>
@@ -558,7 +592,7 @@ get on the terminal - we are working on that):
     >           assert x == 0
     E           assert 1 == 0
 
-    failure_demo.py:228: AssertionError
+    failure_demo.py:250: AssertionError
     ___________________ TestCustomAssertMsg.test_single_line ___________________
 
     self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef>
@@ -573,7 +607,7 @@ get on the terminal - we are working on that):
     E       assert 1 == 2
     E        +  where 1 = <class 'failure_demo.TestCustomAssertMsg.test_single_line.<locals>.A'>.a
 
-    failure_demo.py:239: AssertionError
+    failure_demo.py:261: AssertionError
     ____________________ TestCustomAssertMsg.test_multiline ____________________
 
     self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef>
@@ -592,7 +626,7 @@ get on the terminal - we are working on that):
     E       assert 1 == 2
     E        +  where 1 = <class 'failure_demo.TestCustomAssertMsg.test_multiline.<locals>.A'>.a
 
-    failure_demo.py:246: AssertionError
+    failure_demo.py:268: AssertionError
     ___________________ TestCustomAssertMsg.test_custom_repr ___________________
 
     self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef>
@@ -614,5 +648,5 @@ get on the terminal - we are working on that):
     E       assert 1 == 2
     E        +  where 1 = This is JSON\n{\n  'foo': 'bar'\n}.a
 
-    failure_demo.py:259: AssertionError
-    ======================== 42 failed in 0.12 seconds =========================
+    failure_demo.py:281: AssertionError
+    ======================== 44 failed in 0.12 seconds =========================

doc/en/example/simple.rst

@@ -107,7 +107,7 @@ the command line arguments before they get processed:
 
 .. code-block:: python
 
-    # content of conftest.py
+    # setuptools plugin
     import sys
 
 
@@ -128,7 +128,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 0 items
 
     ======================= no tests ran in 0.12 seconds =======================
@@ -188,12 +189,13 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 2 items
 
     test_module.py .s                                                    [100%]
     ========================= short test summary info ==========================
-    SKIP [1] test_module.py:8: need --runslow option to run
+    SKIPPED [1] test_module.py:8: need --runslow option to run
 
     =================== 1 passed, 1 skipped in 0.12 seconds ====================
 
@@ -204,7 +206,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 2 items
 
     test_module.py ..                                                    [100%]
@@ -346,8 +349,9 @@ 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
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     project deps: mylib-1.1
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    rootdir: $REGENDOC_TMPDIR
     collected 0 items
 
     ======================= no tests ran in 0.12 seconds =======================
@@ -373,11 +377,11 @@ 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/python3.6
-    cachedir: .pytest_cache
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     info1: did you know that ...
     did you?
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    rootdir: $REGENDOC_TMPDIR
     collecting ... collected 0 items
 
     ======================= no tests ran in 0.12 seconds =======================
@@ -389,7 +393,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 0 items
 
     ======================= no tests ran in 0.12 seconds =======================
@@ -428,7 +433,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 3 items
 
     test_some_are_slow.py ...                                            [100%]
@@ -502,7 +508,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 4 items
 
     test_step.py .Fx.                                                    [100%]
@@ -585,7 +592,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 7 items
 
     test_step.py .Fx.                                                    [ 57%]
@@ -598,7 +606,7 @@ We can run this:
     file $REGENDOC_TMPDIR/b/test_error.py, line 1
       def test_root(db):  # no db here, will error out
     E       fixture 'db' not found
-    >       available fixtures: cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, monkeypatch, pytestconfig, record_property, record_xml_attribute, record_xml_property, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
+    >       available fixtures: cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, monkeypatch, pytestconfig, record_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
     >       use 'pytest --fixtures [testpath]' for help on them.
 
     $REGENDOC_TMPDIR/b/test_error.py:1
@@ -698,7 +706,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 2 items
 
     test_module.py FF                                                    [100%]
@@ -722,7 +731,9 @@ and run them:
     test_module.py:6: AssertionError
     ========================= 2 failed in 0.12 seconds =========================
 
-you will have a "failures" file which contains the failing test ids::
+you will have a "failures" file which contains the failing test ids:
+
+.. code-block:: bash
 
     $ cat failures
     test_module.py::test_fail1 (PYTEST_TMPDIR/test_fail10)
@@ -799,7 +810,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 3 items
 
     test_module.py Esetting up a test failed! test_module.py::test_setup_fails
@@ -842,7 +854,7 @@ information.
 ``PYTEST_CURRENT_TEST`` environment variable
 --------------------------------------------
 
-.. versionadded:: 3.2
+
 
 Sometimes a test session might get stuck and there might be no easy way to figure out
 which test got stuck, for example if pytest was run in quiet mode (``-q``) or you don't have access to the console
@@ -925,6 +937,8 @@ like ``pytest-timeout`` they must be imported explicitly and passed on to pytest
 
 
 This allows you to execute tests using the frozen
-application with standard ``pytest`` command-line options::
+application with standard ``pytest`` command-line options:
+
+.. code-block:: bash
 
     ./app_main --pytest --verbose --tb=long --junitxml=results.xml test-suite/

doc/en/fixture.rst

@@ -7,7 +7,7 @@ pytest fixtures: explicit, modular, scalable
 
 .. currentmodule:: _pytest.python
 
-.. versionadded:: 2.0/2.3/2.4
+
 
 .. _`xUnit`: http://en.wikipedia.org/wiki/XUnit
 .. _`purpose of test fixtures`: http://en.wikipedia.org/wiki/Test_fixture#Software
@@ -73,7 +73,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_smtpsimple.py F                                                 [100%]
@@ -113,7 +114,9 @@ with a list of available function arguments.
 
 .. note::
 
-    You can always issue ::
+    You can always issue:
+
+    .. code-block:: bash
 
         pytest --fixtures test_simplefactory.py
 
@@ -213,7 +216,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 2 items
 
     test_module.py FF                                                    [100%]
@@ -272,7 +276,7 @@ Finally, the ``class`` scope will invoke the fixture once per test *class*.
 ``package`` scope (experimental)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. versionadded:: 3.7
+
 
 In pytest 3.7 the ``package`` scope has been introduced. Package-scoped fixtures
 are finalized when the last test of a *package* finishes.
@@ -288,7 +292,7 @@ are finalized when the last test of a *package* finishes.
 Higher-scoped fixtures are instantiated first
 ---------------------------------------------
 
-.. versionadded:: 3.5
+
 
 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
@@ -360,7 +364,9 @@ The ``print`` and ``smtp.close()`` statements will execute when the last test in
 the module has finished execution, regardless of the exception status of the
 tests.
 
-Let's execute it::
+Let's execute it:
+
+.. code-block:: pytest
 
     $ pytest -s -q --tb=no
     FFteardown smtp
@@ -469,7 +475,9 @@ read an optional server URL from the test module which uses our fixture::
 
 We use the ``request.module`` attribute to optionally obtain an
 ``smtpserver`` attribute from the test module.  If we just execute
-again, nothing much has changed::
+again, nothing much has changed:
+
+.. code-block:: pytest
 
     $ pytest -s -q --tb=no
     FFfinalizing <smtplib.SMTP object at 0xdeadbeef> (smtp.gmail.com)
@@ -628,7 +636,7 @@ So let's just do another run:
             response, msg = smtp_connection.ehlo()
             assert response == 250
     >       assert b"smtp.gmail.com" in msg
-    E       AssertionError: assert b'smtp.gmail.com' in b'mail.python.org\nPIPELINING\nSIZE 51200000\nETRN\nSTARTTLS\nAUTH DIGEST-MD5 NTLM CRAM-MD5\nENHANCEDSTATUSCODES\n8BITMIME\nDSN\nSMTPUTF8'
+    E       AssertionError: assert b'smtp.gmail.com' in b'mail.python.org\nPIPELINING\nSIZE 51200000\nETRN\nSTARTTLS\nAUTH DIGEST-MD5 NTLM CRAM-MD5\nENHANCEDSTATUSCODES\n8BITMIME\nDSN\nSMTPUTF8\nCHUNKING'
 
     test_module.py:5: AssertionError
     -------------------------- Captured stdout setup ---------------------------
@@ -701,21 +709,22 @@ 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
-   rootdir: $REGENDOC_TMPDIR, inifile:
+   cachedir: $PYTHON_PREFIX/.pytest_cache
+   rootdir: $REGENDOC_TMPDIR
    collected 10 items
-   <Module 'test_anothersmtp.py'>
-     <Function 'test_showhelo[smtp.gmail.com]'>
-     <Function 'test_showhelo[mail.python.org]'>
-   <Module 'test_ids.py'>
-     <Function 'test_a[spam]'>
-     <Function 'test_a[ham]'>
-     <Function 'test_b[eggs]'>
-     <Function 'test_b[1]'>
-   <Module 'test_module.py'>
-     <Function 'test_ehlo[smtp.gmail.com]'>
-     <Function 'test_noop[smtp.gmail.com]'>
-     <Function 'test_ehlo[mail.python.org]'>
-     <Function 'test_noop[mail.python.org]'>
+   <Module test_anothersmtp.py>
+     <Function test_showhelo[smtp.gmail.com]>
+     <Function test_showhelo[mail.python.org]>
+   <Module test_ids.py>
+     <Function test_a[spam]>
+     <Function test_a[ham]>
+     <Function test_b[eggs]>
+     <Function test_b[1]>
+   <Module test_module.py>
+     <Function test_ehlo[smtp.gmail.com]>
+     <Function test_noop[smtp.gmail.com]>
+     <Function test_ehlo[mail.python.org]>
+     <Function test_noop[mail.python.org]>
 
    ======================= no tests ran in 0.12 seconds =======================
 
@@ -744,9 +753,9 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collecting ... collected 3 items
 
     test_fixture_marks.py::test_data[0] PASSED                           [ 33%]
@@ -789,9 +798,9 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collecting ... collected 2 items
 
     test_appsetup.py::test_smtp_connection_exists[smtp.gmail.com] PASSED [ 50%]
@@ -804,7 +813,7 @@ different ``App`` instances and respective smtp servers.  There is no
 need for the ``app`` fixture to be aware of the ``smtp_connection``
 parametrization because pytest will fully analyse the fixture dependency graph.
 
-Note, that the ``app`` fixture has a scope of ``module`` and uses a
+Note that the ``app`` fixture has a scope of ``module`` and uses a
 module-scoped ``smtp_connection`` fixture.  The example would still work if
 ``smtp_connection`` was cached on a ``session`` scope: it is fine for fixtures to use
 "broader" scoped fixtures but not the other way round:
@@ -860,9 +869,9 @@ 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/python3.6
-    cachedir: .pytest_cache
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collecting ... collected 8 items
 
     test_module.py::test_0[1]   SETUP otherarg 1

doc/en/getting-started.rst

@@ -7,9 +7,6 @@ Installation and Getting Started
 
 **PyPI package name**: `pytest <https://pypi.org/project/pytest/>`_
 
-**Dependencies**: `py <https://pypi.org/project/py/>`_,
-`colorama (Windows) <https://pypi.org/project/colorama/>`_,
-
 **Documentation as PDF**: `download latest <https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf>`_
 
 ``pytest`` is a framework that makes building simple and scalable tests easy. Tests are expressive and readable—no boilerplate code required. Get started in minutes with a small unit test or complex functional test for your application or library.
@@ -20,11 +17,15 @@ Installation and Getting Started
 Install ``pytest``
 ----------------------------------------
 
-1. Run the following command in your command line::
+1. Run the following command in your command line:
+
+.. code-block:: bash
 
     pip install -U pytest
 
-2. Check that you installed the correct version::
+2. Check that you installed the correct version:
+
+.. code-block:: bash
 
     $ pytest --version
     This is pytest version 4.x.y, imported from $PYTHON_PREFIX/lib/python3.6/site-packages/pytest.py
@@ -50,7 +51,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_sample.py F                                                     [100%]
@@ -81,7 +83,7 @@ Run multiple tests
 Assert that a certain exception is raised
 --------------------------------------------------------------
 
-Use the ``raises`` helper to assert that some code raises an exception::
+Use the :ref:`raises <assertraises>` helper to assert that some code raises an exception::
 
     # content of test_sysexit.py
     import pytest
@@ -170,7 +172,9 @@ List the name ``tmpdir`` in the test function signature and ``pytest`` will look
 
 More info on tmpdir handling is available at :ref:`Temporary directories and files <tmpdir handling>`.
 
-Find out what kind of builtin :ref:`pytest fixtures <fixtures>` exist with the command::
+Find out what kind of builtin :ref:`pytest fixtures <fixtures>` exist with the command:
+
+.. code-block:: bash
 
     pytest --fixtures   # shows builtin and custom fixtures
 

doc/en/goodpractices.rst

@@ -7,12 +7,13 @@ Good Integration Practices
 Install package with pip
 -------------------------------------------------
 
-For development, we recommend to use virtualenv_ 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 the system Python installation.
+For development, we recommend you use venv_ for virtual environments
+(or virtualenv_ for Python 2.7) 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.
 
-First you need to 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::
 
     from setuptools import setup, find_packages
 
@@ -41,8 +42,8 @@ Conventions for Python test discovery
 * In those directories, search for ``test_*.py`` or ``*_test.py`` files, imported by their `test package name`_.
 * From those files, collect test items:
 
-  * ``test_`` prefixed test functions or methods outside of class
-  * ``test_`` prefixed test functions or methods inside ``Test`` prefixed test classes (without an ``__init__`` method)
+  * ``test`` prefixed test functions or methods outside of class
+  * ``test`` prefixed test functions or methods inside ``Test`` prefixed test classes (without an ``__init__`` method)
 
 For examples of how to customize your test discovery :doc:`example/pythoncollection`.
 
@@ -72,8 +73,18 @@ to keep tests separate from actual application code (often a good idea)::
         test_view.py
         ...
 
-This way your tests can run easily against an installed version
-of ``mypkg``.
+This has the following benefits:
+
+* Your tests can run against an installed version after executing ``pip install .``.
+* Your tests can run against the local copy with an editable install after executing ``pip install --editable .``.
+* If you don't have a ``setup.py`` file and are relying on the fact that Python by default puts the current
+  directory in ``sys.path`` to import your package, you can execute ``python -m pytest`` to execute the tests against the
+  local copy directly, without using ``pip``.
+
+.. note::
+
+    See :ref:`pythonpath` for more information about the difference between calling ``pytest`` and
+    ``python -m pytest``.
 
 Note that using this scheme your test files must have **unique names**, because
 ``pytest`` will import them as *top-level* modules since there are no packages

doc/en/historical-notes.rst

@@ -7,7 +7,7 @@ kept here as a historical note so users looking at old code can find documentati
 cache plugin integrated into the core
 -------------------------------------
 
-.. versionadded:: 2.8
+
 
 The functionality of the :ref:`core cache <cache>` plugin was previously distributed
 as a third party plugin named ``pytest-cache``.  The core plugin
@@ -18,7 +18,7 @@ can only store/receive data between test runs that is json-serializable.
 funcargs and ``pytest_funcarg__``
 ---------------------------------
 
-.. versionchanged:: 2.3
+
 
 In versions prior to 2.3 there was no ``@pytest.fixture`` marker
 and you had to use a magic ``pytest_funcarg__NAME`` prefix
@@ -30,7 +30,7 @@ functions.
 ``@pytest.yield_fixture`` decorator
 -----------------------------------
 
-.. versionchanged:: 2.10
+
 
 Prior to version 2.10, in order to use a ``yield`` statement to execute teardown code one
 had to mark a fixture using the ``yield_fixture`` marker. From 2.10 onward, normal
@@ -41,7 +41,7 @@ and considered deprecated.
 ``[pytest]`` header in ``setup.cfg``
 ------------------------------------
 
-.. versionchanged:: 3.0
+
 
 Prior to 3.0, the supported section name was ``[pytest]``. Due to how
 this may collide with some distutils commands, the recommended
@@ -54,17 +54,19 @@ name is ``[pytest]``.
 Applying marks to ``@pytest.mark.parametrize`` parameters
 ---------------------------------------------------------
 
-.. versionchanged:: 3.1
+
 
 Prior to version 3.1 the supported mechanism for marking values
-used the syntax::
+used the syntax:
+
+.. code-block:: python
 
     import pytest
-    @pytest.mark.parametrize("test_input,expected", [
-        ("3+5", 8),
-        ("2+4", 6),
-        pytest.mark.xfail(("6*9", 42),),
-    ])
+
+
+    @pytest.mark.parametrize(
+        "test_input,expected", [("3+5", 8), ("2+4", 6), pytest.mark.xfail(("6*9", 42))]
+    )
     def test_eval(test_input, expected):
         assert eval(test_input) == expected
 
@@ -78,7 +80,7 @@ The old syntax is planned to be removed in pytest-4.0.
 ``@pytest.mark.parametrize`` argument names as a tuple
 ------------------------------------------------------
 
-.. versionchanged:: 2.4
+
 
 In versions prior to 2.4 one needed to specify the argument
 names as a tuple.  This remains valid but the simpler ``"name1,name2,..."``
@@ -89,7 +91,7 @@ it's easier to write and produces less line noise.
 setup: is now an "autouse fixture"
 ----------------------------------
 
-.. versionchanged:: 2.3
+
 
 During development prior to the pytest-2.3 release the name
 ``pytest.setup`` was used but before the release it was renamed
@@ -102,12 +104,16 @@ namely :ref:`autouse fixtures`
 Conditions as strings instead of booleans
 -----------------------------------------
 
-.. versionchanged:: 2.4
+
 
 Prior to pytest-2.4 the only way to specify skipif/xfail conditions was
-to use strings::
+to use strings:
+
+.. code-block:: python
 
     import sys
+
+
     @pytest.mark.skipif("sys.version_info >= (3,3)")
     def test_function():
         ...
@@ -139,17 +145,20 @@ dictionary which is constructed as follows:
   expression is applied.
 
 The pytest ``config`` object allows you to skip based on a test
-configuration value which you might have added::
+configuration value which you might have added:
+
+.. code-block:: python
 
     @pytest.mark.skipif("not config.getvalue('db')")
-    def test_function(...):
+    def test_function():
         ...
 
-The equivalent with "boolean conditions" is::
+The equivalent with "boolean conditions" is:
 
-    @pytest.mark.skipif(not pytest.config.getvalue("db"),
-                        reason="--db was not specified")
-    def test_function(...):
+.. code-block:: python
+
+    @pytest.mark.skipif(not pytest.config.getvalue("db"), reason="--db was not specified")
+    def test_function():
         pass
 
 .. note::
@@ -162,14 +171,18 @@ The equivalent with "boolean conditions" is::
 ``pytest.set_trace()``
 ----------------------
 
-.. versionchanged:: 2.4
 
-Previous to version 2.4 to set a break point in code one needed to use ``pytest.set_trace()``::
+
+Previous to version 2.4 to set a break point in code one needed to use ``pytest.set_trace()``:
+
+.. code-block:: python
 
     import pytest
+
+
     def test_function():
         ...
-        pytest.set_trace()    # invoke PDB debugger and tracing
+        pytest.set_trace()  # invoke PDB debugger and tracing
 
 
 This is no longer needed and one can use the native ``import pdb;pdb.set_trace()`` call directly.
@@ -179,7 +192,7 @@ For more details see :ref:`breakpoints`.
 "compat" properties
 -------------------
 
-.. deprecated:: 3.9
+
 
 Access of ``Module``, ``Function``, ``Class``, ``Instance``, ``File`` and ``Item`` through ``Node`` instances have long
 been documented as deprecated, but started to emit warnings from pytest ``3.9`` and onward.

doc/en/index.rst

@@ -29,7 +29,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_sample.py F                                                     [100%]

doc/en/license.rst

@@ -5,7 +5,7 @@ License
 
 Distributed under the terms of the `MIT`_ license, pytest is free and open source software.
 
-::
+.. code-block:: text
 
     The MIT License (MIT)
 

doc/en/links.inc

@@ -14,6 +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/
 .. _`virtualenv`: https://pypi.org/project/virtualenv/
 .. _hudson: http://hudson-ci.org/
 .. _jenkins: http://jenkins-ci.org/

doc/en/logging.rst

@@ -3,17 +3,21 @@
 Logging
 -------
 
-.. versionadded:: 3.3
-.. versionchanged:: 3.4
+
+
 
 pytest captures log messages of level ``WARNING`` or above automatically and displays them in their own section
 for each failed test in the same manner as captured stdout and stderr.
 
-Running without options::
+Running without options:
+
+.. code-block:: bash
 
     pytest
 
-Shows failed tests like so::
+Shows failed tests like so:
+
+.. code-block:: pytest
 
     ----------------------- Captured stdlog call ----------------------
     test_reporting.py    26 WARNING  text going to logger
@@ -27,12 +31,16 @@ By default each captured log message shows the module, line number, log level
 and message.
 
 If desired the log and date format can be specified to
-anything that the logging module supports by passing specific formatting options::
+anything that the logging module supports by passing specific formatting options:
+
+.. code-block:: bash
 
     pytest --log-format="%(asctime)s %(levelname)s %(message)s" \
             --log-date-format="%Y-%m-%d %H:%M:%S"
 
-Shows failed tests like so::
+Shows failed tests like so:
+
+.. code-block:: pytest
 
     ----------------------- Captured stdlog call ----------------------
     2010-04-10 14:48:44 WARNING text going to logger
@@ -51,7 +59,9 @@ These options can also be customized through ``pytest.ini`` file:
     log_date_format = %Y-%m-%d %H:%M:%S
 
 Further it is possible to disable reporting of captured content (stdout,
-stderr and logs) on failed tests completely with::
+stderr and logs) on failed tests completely with:
+
+.. code-block:: bash
 
     pytest --show-capture=no
 
@@ -133,7 +143,6 @@ the records for the ``setup`` and ``call`` stages during teardown like so:
 
 .. code-block:: python
 
-
     @pytest.fixture
     def window(caplog):
         window = create_window()
@@ -198,6 +207,9 @@ option names are:
 * ``log_file_format``
 * ``log_file_date_format``
 
+You can call ``set_log_path()`` to customize the log_file path dynamically. This functionality
+is considered **experimental**.
+
 .. _log_release_notes:
 
 Release notes

doc/en/mark.rst

@@ -29,9 +29,11 @@ which also serve as documentation.
 Raising errors on unknown marks: --strict
 -----------------------------------------
 
-When the ``--strict`` command-line flag is passed, any marks not registered in the ``pytest.ini`` file will trigger an error.
+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 like this:
+Marks can be registered in ``pytest.ini`` like this:
 
 .. code-block:: ini
 
@@ -57,7 +59,7 @@ should add ``--strict`` to ``addopts``:
 Marker revamp and iteration
 ---------------------------
 
-.. versionadded:: 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``.
 

doc/en/nose.rst

@@ -12,7 +12,9 @@ Running tests written for nose
 Usage
 -------------
 
-After :ref:`installation` type::
+After :ref:`installation` type:
+
+.. code-block:: bash
 
     python setup.py develop  # make sure tests can import our package
     pytest  # instead of 'nosetests'

doc/en/parametrize.rst

@@ -29,22 +29,22 @@ pytest enables test parametrization at several levels:
 
 .. regendoc: wipe
 
-.. versionadded:: 2.2
-.. versionchanged:: 2.4
+
+
     Several improvements.
 
 The builtin :ref:`pytest.mark.parametrize ref` decorator enables
 parametrization of arguments for a test function.  Here is a typical example
 of a test function that implements checking that a certain input leads
-to an expected output::
+to an expected output:
+
+.. code-block:: python
 
     # content of test_expectation.py
     import pytest
-    @pytest.mark.parametrize("test_input,expected", [
-        ("3+5", 8),
-        ("2+4", 6),
-        ("6*9", 42),
-    ])
+
+
+    @pytest.mark.parametrize("test_input,expected", [("3+5", 8), ("2+4", 6), ("6*9", 42)])
     def test_eval(test_input, expected):
         assert eval(test_input) == expected
 
@@ -57,7 +57,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 3 items
 
     test_expectation.py ..F                                              [100%]
@@ -67,19 +68,30 @@ them in turn:
 
     test_input = '6*9', expected = 42
 
-        @pytest.mark.parametrize("test_input,expected", [
-            ("3+5", 8),
-            ("2+4", 6),
-            ("6*9", 42),
-        ])
+        @pytest.mark.parametrize("test_input,expected", [("3+5", 8), ("2+4", 6), ("6*9", 42)])
         def test_eval(test_input, expected):
     >       assert eval(test_input) == expected
     E       AssertionError: assert 54 == 42
     E        +  where 54 = eval('6*9')
 
-    test_expectation.py:8: AssertionError
+    test_expectation.py:6: AssertionError
     ==================== 1 failed, 2 passed in 0.12 seconds ====================
 
+.. note::
+
+    pytest by default escapes any non-ascii characters used in unicode strings
+    for the parametrization because it has several downsides.
+    If however you would like to use unicode strings in parametrization and see them in the terminal as is (non-escaped), use this option in your ``pytest.ini``:
+
+    .. code-block:: ini
+
+        [pytest]
+        disable_test_id_escaping_and_forfeit_all_rights_to_community_support = True
+
+    Keep in mind however that this might cause unwanted side effects and
+    even bugs depending on the OS used and plugins currently installed, so use it at your own risk.
+
+
 As designed in this example, only one pair of input/output values fails
 the simple test function.  And as usual with test function arguments,
 you can see the ``input`` and ``output`` values in the traceback.
@@ -88,16 +100,18 @@ Note that you could also use the parametrize marker on a class or a module
 (see :ref:`mark`) which would invoke several functions with the argument sets.
 
 It is also possible to mark individual test instances within parametrize,
-for example with the builtin ``mark.xfail``::
+for example with the builtin ``mark.xfail``:
+
+.. code-block:: python
 
     # content of test_expectation.py
     import pytest
-    @pytest.mark.parametrize("test_input,expected", [
-        ("3+5", 8),
-        ("2+4", 6),
-        pytest.param("6*9", 42,
-                     marks=pytest.mark.xfail),
-    ])
+
+
+    @pytest.mark.parametrize(
+        "test_input,expected",
+        [("3+5", 8), ("2+4", 6), pytest.param("6*9", 42, marks=pytest.mark.xfail)],
+    )
     def test_eval(test_input, expected):
         assert eval(test_input) == expected
 
@@ -108,7 +122,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 3 items
 
     test_expectation.py ..x                                              [100%]
@@ -123,9 +138,13 @@ example, if they're dynamically generated by some function - the behaviour of
 pytest is defined by the :confval:`empty_parameter_set_mark` option.
 
 To get all combinations of multiple parametrized arguments you can stack
-``parametrize`` decorators::
+``parametrize`` decorators:
+
+.. code-block:: python
 
     import pytest
+
+
     @pytest.mark.parametrize("x", [0, 1])
     @pytest.mark.parametrize("y", [2, 3])
     def test_foo(x, y):
@@ -149,28 +168,40 @@ parametrization.
 
 For example, let's say we want to run a test taking string inputs which
 we want to set via a new ``pytest`` command line option.  Let's first write
-a simple test accepting a ``stringinput`` fixture function argument::
+a simple test accepting a ``stringinput`` fixture function argument:
+
+.. code-block:: python
 
     # content of test_strings.py
 
+
     def test_valid_string(stringinput):
         assert stringinput.isalpha()
 
 Now we add a ``conftest.py`` file containing the addition of a
-command line option and the parametrization of our test function::
+command line option and the parametrization of our test function:
+
+.. code-block:: python
 
     # content of conftest.py
 
+
     def pytest_addoption(parser):
-        parser.addoption("--stringinput", action="append", default=[],
-            help="list of stringinputs to pass to test functions")
+        parser.addoption(
+            "--stringinput",
+            action="append",
+            default=[],
+            help="list of stringinputs to pass to test functions",
+        )
+
 
     def pytest_generate_tests(metafunc):
-        if 'stringinput' in metafunc.fixturenames:
-            metafunc.parametrize("stringinput",
-                                 metafunc.config.getoption('stringinput'))
+        if "stringinput" in metafunc.fixturenames:
+            metafunc.parametrize("stringinput", metafunc.config.getoption("stringinput"))
 
-If we now pass two stringinput values, our test will run twice::
+If we now pass two stringinput values, our test will run twice:
+
+.. code-block:: pytest
 
     $ pytest -q --stringinput="hello" --stringinput="world" test_strings.py
     ..                                                                   [100%]
@@ -193,7 +224,7 @@ Let's also run with a stringinput that will lead to a failing test:
     E        +  where False = <built-in method isalpha of str object at 0xdeadbeef>()
     E        +    where <built-in method isalpha of str object at 0xdeadbeef> = '!'.isalpha
 
-    test_strings.py:3: AssertionError
+    test_strings.py:4: AssertionError
     1 failed in 0.12 seconds
 
 As expected our test function fails.
@@ -207,7 +238,7 @@ list:
     $ pytest -q -rs test_strings.py
     s                                                                    [100%]
     ========================= short test summary info ==========================
-    SKIP [1] test_strings.py: got empty parameter set ['stringinput'], function test_valid_string at $REGENDOC_TMPDIR/test_strings.py:1
+    SKIPPED [1] test_strings.py: got empty parameter set ['stringinput'], function test_valid_string at $REGENDOC_TMPDIR/test_strings.py:2
     1 skipped in 0.12 seconds
 
 Note that when calling ``metafunc.parametrize`` multiple times with different parameter sets, all parameter names across

doc/en/plugins.rst

@@ -27,7 +27,7 @@ Here is a little annotated list for some popular plugins:
   for `twisted <http://twistedmatrix.com>`_ apps, starting a reactor and
   processing deferreds from test functions.
 
-* `pytest-cov <https://pypi.org/project/pytest-cov/>`_:
+* `pytest-cov <https://pypi.org/project/pytest-cov/>`__:
   coverage reporting, compatible with distributed testing
 
 * `pytest-xdist <https://pypi.org/project/pytest-xdist/>`_:
@@ -84,6 +84,11 @@ will be loaded as well.
     :ref:`full explanation <requiring plugins in non-root conftests>`
     in the Writing plugins section.
 
+.. note::
+   The name ``pytest_plugins`` is reserved and should not be used as a
+   name for a custom plugin module.
+
+
 .. _`findpluginname`:
 
 Finding out which plugins are active

doc/en/py27-py34-deprecation.rst

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

doc/en/reference.rst

@@ -1,4 +1,3 @@
-
 Reference
 =========
 
@@ -49,7 +48,7 @@ pytest.main
 .. autofunction:: _pytest.config.main
 
 pytest.param
-~~~~~~~~~~~~~
+~~~~~~~~~~~~
 
 .. autofunction:: pytest.param(*values, [id], [marks])
 
@@ -199,16 +198,18 @@ Marks a test function as *expected to fail*.
 .. py:function:: pytest.mark.xfail(condition=None, *, reason=None, raises=None, run=True, strict=False)
 
     :type condition: bool or str
-    :param condition: ``True/False`` if the condition should be marked as xfail or a :ref:`condition string <string conditions>`.
+    :param condition:
+        Condition for marking the test function as xfail (``True/False`` or a
+        :ref:`condition string <string conditions>`).
     :keyword str reason: Reason why the test function is marked as xfail.
     :keyword Exception raises: Exception subclass expected to be raised by the test function; other exceptions will fail the test.
     :keyword bool run:
         If the test function should actually be executed. If ``False``, the function will always xfail and will
-        not be executed (useful a function is segfaulting).
+        not be executed (useful if a function is segfaulting).
     :keyword bool strict:
         * If ``False`` (the default) the function will be shown in the terminal output as ``xfailed`` if it fails
           and as ``xpass`` if it passes. In both cases this will not cause the test suite to fail as a whole. This
-          is particularly useful to mark *flaky* tests (tests that random at fail) to be tackled later.
+          is particularly useful to mark *flaky* tests (tests that fail at random) to be tackled later.
         * If ``True``, the function will be shown in the terminal output as ``xfailed`` if it fails, but if it
           unexpectedly passes then it will **fail** the test suite. This is particularly useful to mark functions
           that are always failing and there should be a clear indication if they unexpectedly start to pass (for example
@@ -499,6 +500,32 @@ Each recorded warning is an instance of :class:`warnings.WarningMessage`.
     differently; see :ref:`ensuring_function_triggers`.
 
 
+tmp_path
+~~~~~~~~
+
+**Tutorial**: :doc:`tmpdir`
+
+.. currentmodule:: _pytest.tmpdir
+
+.. autofunction:: tmp_path()
+    :no-auto-options:
+
+
+tmp_path_factory
+~~~~~~~~~~~~~~~~
+
+**Tutorial**: :ref:`tmp_path_factory example`
+
+.. _`tmp_path_factory factory api`:
+
+``tmp_path_factory`` instances have the following methods:
+
+.. currentmodule:: _pytest.tmpdir
+
+.. automethod:: TempPathFactory.mktemp
+.. automethod:: TempPathFactory.getbasetemp
+
+
 tmpdir
 ~~~~~~
 
@@ -558,6 +585,8 @@ Initialization hooks called for plugins and ``conftest.py`` files.
 .. autofunction:: pytest_sessionstart
 .. autofunction:: pytest_sessionfinish
 
+.. autofunction:: pytest_plugin_registered
+
 Test running hooks
 ~~~~~~~~~~~~~~~~~~
 
@@ -581,6 +610,8 @@ into interactive debugging when a test failure occurs.
 The :py:mod:`_pytest.terminal` reported specifically uses
 the reporting hook to print information about a test run.
 
+.. autofunction:: pytest_pyfunc_call
+
 Collection hooks
 ~~~~~~~~~~~~~~~~
 
@@ -590,6 +621,7 @@ Collection hooks
 .. autofunction:: pytest_ignore_collect
 .. autofunction:: pytest_collect_directory
 .. autofunction:: pytest_collect_file
+.. autofunction:: pytest_pycollect_makemodule
 
 For influencing the collection of objects in Python modules
 you can use the following hook:
@@ -603,12 +635,15 @@ items, delete or otherwise amend the test items:
 
 .. autofunction:: pytest_collection_modifyitems
 
+.. autofunction:: pytest_collection_finish
+
 Reporting hooks
 ~~~~~~~~~~~~~~~
 
 Session related reporting hooks:
 
 .. autofunction:: pytest_collectstart
+.. autofunction:: pytest_make_collect_report
 .. autofunction:: pytest_itemcollected
 .. autofunction:: pytest_collectreport
 .. autofunction:: pytest_deselected
@@ -618,7 +653,6 @@ Session related reporting hooks:
 .. autofunction:: pytest_terminal_summary
 .. autofunction:: pytest_fixture_setup
 .. autofunction:: pytest_fixture_post_finalizer
-.. autofunction:: pytest_logwarning
 .. autofunction:: pytest_warning_captured
 
 And here is the central hook for reporting about
@@ -725,13 +759,6 @@ MarkGenerator
     :members:
 
 
-MarkInfo
-~~~~~~~~
-
-.. autoclass:: _pytest.mark.MarkInfo
-    :members:
-
-
 Mark
 ~~~~
 
@@ -805,6 +832,33 @@ Special Variables
 pytest treats some global variables in a special manner when defined in a test module.
 
 
+collect_ignore
+~~~~~~~~~~~~~~
+
+**Tutorial**: :ref:`customizing-test-collection`
+
+Can be declared in *conftest.py files* to exclude test directories or modules.
+Needs to be ``list[str]``.
+
+.. code-block:: python
+
+  collect_ignore = ["setup.py"]
+
+
+collect_ignore_glob
+~~~~~~~~~~~~~~~~~~~
+
+**Tutorial**: :ref:`customizing-test-collection`
+
+Can be declared in *conftest.py files* to exclude test directories or modules
+with Unix shell-style wildcards. Needs to be ``list[str]`` where ``str`` can
+contain glob patterns.
+
+.. code-block:: python
+
+  collect_ignore_glob = ["*_ignore.py"]
+
+
 pytest_plugins
 ~~~~~~~~~~~~~~
 
@@ -828,7 +882,7 @@ pytest_mark
 **Tutorial**: :ref:`scoped-marking`
 
 Can be declared at the **global** level in *test modules* to apply one or more :ref:`marks <marks ref>` to all
-test functions and methods. Can be either a single mark or a sequence of marks.
+test functions and methods. Can be either a single mark or a list of marks.
 
 .. code-block:: python
 
@@ -841,7 +895,7 @@ test functions and methods. Can be either a single mark or a sequence of marks.
 
     import pytest
 
-    pytestmark = (pytest.mark.integration, pytest.mark.slow)
+    pytestmark = [pytest.mark.integration, pytest.mark.slow]
 
 PYTEST_DONT_REWRITE (module docstring)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -897,6 +951,12 @@ Here is a list of builtin configuration options that may be written in a ``pytes
 file, usually located at the root of your repository. All options must be under a ``[pytest]`` section
 (``[tool:pytest]`` for ``setup.cfg`` files).
 
+.. warning::
+    Usage of ``setup.cfg`` is not recommended unless for very simple use cases. ``.cfg``
+    files use a different parser than ``pytest.ini`` and ``tox.ini`` which might cause hard to track
+    down problems.
+    When possible, it is recommended to use the latter files to hold your pytest configuration.
+
 Configuration file options may be overwritten in the command-line by using ``-o/--override``, which can also be
 passed multiple times. The expected format is ``name=value``. For example::
 
@@ -923,7 +983,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: cache_dir
 
-   .. versionadded:: 3.2
+
 
    Sets a directory where stores content of cache plugin. Default directory is
    ``.pytest_cache`` which is created in :ref:`rootdir <rootdir>`. Directory may be
@@ -943,7 +1003,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: console_output_style
 
-   .. versionadded:: 3.3
+
 
    Sets the console output style while running tests:
 
@@ -963,7 +1023,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: doctest_encoding
 
-   .. versionadded:: 3.1
+
 
    Default encoding to use to decode text files with docstrings.
    :doc:`See how pytest handles doctests <doctest>`.
@@ -977,7 +1037,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: empty_parameter_set_mark
 
-    .. versionadded:: 3.4
+
 
     Allows to pick the action for empty parametersets in parameterization
 
@@ -1000,7 +1060,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: filterwarnings
 
-   .. versionadded:: 3.1
+
 
    Sets a list of filters and actions that should be taken for matched
    warnings. By default all warnings emitted during the test session
@@ -1017,10 +1077,24 @@ passed multiple times. The expected format is ``name=value``. For example::
    This tells pytest to ignore deprecation warnings and turn all other warnings
    into errors. For more information please refer to :ref:`warnings`.
 
+.. confval:: junit_family
+
+    .. versionadded:: 4.2
+
+    Configures the format of the generated JUnit XML file. The possible options are:
+
+    * ``xunit1`` (or ``legacy``): produces old style output, compatible with the xunit 1.0 format. **This is the default**.
+    * ``xunit2``: produces `xunit 2.0 style output <https://github.com/jenkinsci/xunit-plugin/blob/xunit-2.3.2/src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd>`__,
+        which should be more compatible with latest Jenkins versions.
+
+    .. code-block:: ini
+
+        [pytest]
+        junit_family = xunit2
 
 .. confval:: junit_suite_name
 
-    .. versionadded:: 3.1
+
 
     To set the name of the root test suite xml item, you can configure the ``junit_suite_name`` option in your config file:
 
@@ -1032,7 +1106,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_cli_date_format
 
-    .. versionadded:: 3.3
+
 
     Sets a :py:func:`time.strftime`-compatible string that will be used when formatting dates for live logging.
 
@@ -1045,7 +1119,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_cli_format
 
-    .. versionadded:: 3.3
+
 
     Sets a :py:mod:`logging`-compatible string used to format live logging messages.
 
@@ -1059,7 +1133,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_cli_level
 
-    .. versionadded:: 3.3
+
 
     Sets the minimum log message level that should be captured for live logging. The integer value or
     the names of the levels can be used.
@@ -1074,7 +1148,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_date_format
 
-    .. versionadded:: 3.3
+
 
     Sets a :py:func:`time.strftime`-compatible string that will be used when formatting dates for logging capture.
 
@@ -1088,7 +1162,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_file
 
-    .. versionadded:: 3.3
+
 
     Sets a file name relative to the ``pytest.ini`` file where log messages should be written to, in addition
     to the other logging facilities that are active.
@@ -1103,7 +1177,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_file_date_format
 
-    .. versionadded:: 3.3
+
 
     Sets a :py:func:`time.strftime`-compatible string that will be used when formatting dates for the logging file.
 
@@ -1116,7 +1190,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_file_format
 
-    .. versionadded:: 3.3
+
 
     Sets a :py:mod:`logging`-compatible string used to format logging messages redirected to the logging file.
 
@@ -1129,7 +1203,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_file_level
 
-    .. versionadded:: 3.3
+
 
     Sets the minimum log message level that should be captured for the logging file. The integer value or
     the names of the levels can be used.
@@ -1144,7 +1218,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_format
 
-    .. versionadded:: 3.3
+
 
     Sets a :py:mod:`logging`-compatible string used to format captured logging messages.
 
@@ -1158,7 +1232,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_level
 
-    .. versionadded:: 3.3
+
 
     Sets the minimum log message level that should be captured for logging capture. The integer value or
     the names of the levels can be used.
@@ -1173,7 +1247,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: log_print
 
-    .. versionadded:: 3.3
+
 
     If set to ``False``, will disable displaying captured logging messages for failed tests.
 
@@ -1187,8 +1261,11 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: markers
 
-    List of markers that are allowed in test functions, enforced when ``--strict`` command-line argument is used.
-    You can use a marker name per line, indented from the option name.
+    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.
+
+    You can list one marker name per line, indented from the option name.
 
     .. code-block:: ini
 
@@ -1307,7 +1384,7 @@ passed multiple times. The expected format is ``name=value``. For example::
 
 .. confval:: testpaths
 
-   .. versionadded:: 2.8
+
 
    Sets list of directories that should be searched for tests when
    no specific directories, files or test ids are given in the command line when

doc/en/requirements.txt

@@ -1,3 +1,4 @@
 pygments-pytest>=1.1.0
-sphinx>=1.8.2
+sphinx>=1.8.2,<2.1
 sphinxcontrib-trio
+sphinx-removed-in>=0.2.0

doc/en/skipping.rst

@@ -22,7 +22,9 @@ it's an **xpass** and will be reported in the test summary.
 ``pytest`` counts and lists *skip* and *xfail* tests separately. Detailed
 information about skipped/xfailed tests is not shown by default to avoid
 cluttering the output.  You can use the ``-r`` option to see details
-corresponding to the "short" letters shown in the test progress::
+corresponding to the "short" letters shown in the test progress:
+
+.. code-block:: bash
 
     pytest -rxXs  # show extra info on xfailed, xpassed, and skipped tests
 
@@ -37,7 +39,7 @@ More details on the ``-r`` option can be found by running ``pytest -h``.
 Skipping test functions
 -----------------------
 
-.. versionadded:: 2.9
+
 
 The simplest way to skip a test function is to mark it with the ``skip`` decorator
 which may be passed an optional ``reason``:
@@ -78,36 +80,48 @@ It is also possible to skip the whole module using
 ``skipif``
 ~~~~~~~~~~
 
-.. versionadded:: 2.0
+
 
 If you wish to skip something conditionally then you can use ``skipif`` instead.
 Here is an example of marking a test function to be skipped
-when run on an interpreter earlier than Python3.6 ::
+when run on an interpreter earlier than Python3.6:
+
+.. code-block:: python
 
     import sys
-    @pytest.mark.skipif(sys.version_info < (3,6),
-                        reason="requires python3.6 or higher")
+
+
+    @pytest.mark.skipif(sys.version_info < (3, 6), reason="requires python3.6 or higher")
     def test_function():
         ...
 
 If the condition evaluates to ``True`` during collection, the test function will be skipped,
 with the specified reason appearing in the summary when using ``-rs``.
 
-You can share ``skipif`` markers between modules.  Consider this test module::
+You can share ``skipif`` markers between modules.  Consider this test module:
+
+.. code-block:: python
 
     # content of test_mymodule.py
     import mymodule
-    minversion = pytest.mark.skipif(mymodule.__versioninfo__ < (1,1),
-                                    reason="at least mymodule-1.1 required")
+
+    minversion = pytest.mark.skipif(
+        mymodule.__versioninfo__ < (1, 1), reason="at least mymodule-1.1 required"
+    )
+
+
     @minversion
     def test_function():
         ...
 
-You can import the marker and reuse it in another test module::
+You can import the marker and reuse it in another test module:
+
+.. code-block:: python
 
     # test_myothermodule.py
     from test_mymodule import minversion
 
+
     @minversion
     def test_anotherfunction():
         ...
@@ -126,12 +140,12 @@ so they are supported mainly for backward compatibility reasons.
 Skip all test functions of a class or module
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You can use the ``skipif`` marker (as any other marker) on classes::
+You can use the ``skipif`` marker (as any other marker) on classes:
 
-    @pytest.mark.skipif(sys.platform == 'win32',
-                        reason="does not run on windows")
+.. code-block:: python
+
+    @pytest.mark.skipif(sys.platform == "win32", reason="does not run on windows")
     class TestPosixCalls(object):
-
         def test_function(self):
             "will not be setup or run under 'win32' platform"
 
@@ -194,7 +208,7 @@ Here's a quick guide on how to skip tests in a module in different situations:
 
   .. code-block:: python
 
-        pytestmark = pytest.mark.skipif(sys.platform == "win32", "tests for linux only")
+        pytestmark = pytest.mark.skipif(sys.platform == "win32", reason="tests for linux only")
 
 3. Skip all tests in a module if some import is missing:
 
@@ -240,7 +254,7 @@ internally by raising a known exception.
 ``strict`` parameter
 ~~~~~~~~~~~~~~~~~~~~
 
-.. versionadded:: 2.9
+
 
 Both ``XFAIL`` and ``XPASS`` don't fail the test suite, unless the ``strict`` keyword-only
 parameter is passed as ``True``:
@@ -267,10 +281,11 @@ You can change the default value of the ``strict`` parameter using the
 ~~~~~~~~~~~~~~~~~~~~
 
 As with skipif_ you can also mark your expectation of a failure
-on a particular platform::
+on a particular platform:
 
-    @pytest.mark.xfail(sys.version_info >= (3,6),
-                       reason="python3.6 api changes")
+.. code-block:: python
+
+    @pytest.mark.xfail(sys.version_info >= (3, 6), reason="python3.6 api changes")
     def test_function():
         ...
 
@@ -309,7 +324,9 @@ investigated later.
 Ignoring xfail
 ~~~~~~~~~~~~~~
 
-By specifying on the commandline::
+By specifying on the commandline:
+
+.. code-block:: bash
 
     pytest --runxfail
 
@@ -330,7 +347,8 @@ 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
-    rootdir: $REGENDOC_TMPDIR/example, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR/example
     collected 7 items
 
     xfail_demo.py xxxxxxx                                                [100%]

doc/en/talks.rst

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

doc/en/tmpdir.rst

@@ -8,7 +8,7 @@ Temporary directories and files
 The ``tmp_path`` fixture
 ------------------------
 
-.. versionadded:: 3.9
+
 
 
 You can use the ``tmp_path`` fixture which will
@@ -42,7 +42,8 @@ Running this would result in a passed test except for the last
     $ pytest test_tmp_path.py
     =========================== test session starts ============================
     platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_tmp_path.py F                                                   [100%]
@@ -65,10 +66,12 @@ Running this would result in a passed test except for the last
     test_tmp_path.py:13: AssertionError
     ========================= 1 failed in 0.12 seconds =========================
 
+.. _`tmp_path_factory example`:
+
 The ``tmp_path_factory`` fixture
 --------------------------------
 
-.. versionadded:: 3.9
+
 
 
 The ``tmp_path_factory`` is a session-scoped fixture which can be used
@@ -76,6 +79,8 @@ to create arbitrary temporary directories from any other fixture or test.
 
 It is intended to replace ``tmpdir_factory``, and returns :class:`pathlib.Path` instances.
 
+See :ref:`tmp_path_factory API <tmp_path_factory factory api>` for details.
+
 
 The 'tmpdir' fixture
 --------------------
@@ -104,7 +109,8 @@ Running this would result in a passed test except for the last
     $ pytest test_tmpdir.py
     =========================== test session starts ============================
     platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_tmpdir.py F                                                     [100%]
@@ -130,7 +136,7 @@ Running this would result in a passed test except for the last
 The 'tmpdir_factory' fixture
 ----------------------------
 
-.. versionadded:: 2.8
+
 
 The ``tmpdir_factory`` is a session-scoped fixture which can be used
 to create arbitrary temporary directories from any other fixture or test.
@@ -172,7 +178,9 @@ the system temporary directory.  The base name will be ``pytest-NUM`` where
 ``NUM`` will be incremented with each test run.  Moreover, entries older
 than 3 temporary directories will be removed.
 
-You can override the default temporary directory setting like this::
+You can override the default temporary directory setting like this:
+
+.. code-block:: bash
 
     pytest --basetemp=mydir
 

doc/en/unittest.rst

@@ -129,7 +129,8 @@ the ``self.db`` values in the traceback:
     $ pytest test_unittest_db.py
     =========================== test session starts ============================
     platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 2 items
 
     test_unittest_db.py FF                                               [100%]

doc/en/usage.rst

@@ -10,9 +10,11 @@ Usage and Invocations
 Calling pytest through ``python -m pytest``
 -----------------------------------------------------
 
-.. versionadded:: 2.0
 
-You can invoke testing through the Python interpreter from the command line::
+
+You can invoke testing through the Python interpreter from the command line:
+
+.. code-block:: text
 
     python -m pytest [...]
 
@@ -34,7 +36,7 @@ Running ``pytest`` can result in six different exit codes:
 Getting help on version, option names, environment variables
 --------------------------------------------------------------
 
-::
+.. code-block:: bash
 
     pytest --version   # shows where pytest was imported from
     pytest --fixtures  # show available builtin function arguments
@@ -46,7 +48,9 @@ Getting help on version, option names, environment variables
 Stopping after the first (or N) failures
 ---------------------------------------------------
 
-To stop the testing process after the first (N) failures::
+To stop the testing process after the first (N) failures:
+
+.. code-block:: bash
 
     pytest -x            # stop after first failure
     pytest --maxfail=2    # stop after two failures
@@ -60,19 +64,19 @@ Pytest supports several ways to run and select tests from the command-line.
 
 **Run tests in a module**
 
-::
+.. code-block:: bash
 
     pytest test_mod.py
 
 **Run tests in a directory**
 
-::
+.. code-block:: bash
 
     pytest testing/
 
 **Run tests by keyword expressions**
 
-::
+.. code-block:: bash
 
     pytest -k "MyClass and not method"
 
@@ -87,18 +91,22 @@ The example above will run ``TestMyClass.test_something``  but not ``TestMyClass
 Each collected test is assigned a unique ``nodeid`` which consist of the module filename followed
 by specifiers like class names, function names and parameters from parametrization, separated by ``::`` characters.
 
-To run a specific test within a module::
+To run a specific test within a module:
+
+.. code-block:: bash
 
     pytest test_mod.py::test_func
 
 
-Another example specifying a test method in the command line::
+Another example specifying a test method in the command line:
+
+.. code-block:: bash
 
     pytest test_mod.py::TestClass::test_method
 
 **Run tests by marker expressions**
 
-::
+.. code-block:: bash
 
     pytest -m slow
 
@@ -108,7 +116,7 @@ For more information see :ref:`marks <mark>`.
 
 **Run tests from packages**
 
-::
+.. code-block:: bash
 
     pytest --pyargs pkg.testing
 
@@ -118,7 +126,9 @@ This will import ``pkg.testing`` and use its filesystem location to find and run
 Modifying Python traceback printing
 ----------------------------------------------
 
-Examples for modifying traceback printing::
+Examples for modifying traceback printing:
+
+.. code-block:: bash
 
     pytest --showlocals # show local variables in tracebacks
     pytest -l           # show local variables (shortcut)
@@ -145,22 +155,85 @@ option you make sure a trace is shown.
 Detailed summary report
 -----------------------
 
-.. versionadded:: 2.9
 
-The ``-r`` flag can be used to display test results summary at the end of the test session,
+
+The ``-r`` flag can be used to display a "short test summary info" at the end of the test session,
 making it easy in large test suites to get a clear picture of all failures, skips, xfails, etc.
 
 Example:
 
+.. code-block:: python
+
+    # content of test_example.py
+    import pytest
+
+
+    @pytest.fixture
+    def error_fixture():
+        assert 0
+
+
+    def test_ok():
+        print("ok")
+
+
+    def test_fail():
+        assert 0
+
+
+    def test_error(error_fixture):
+        pass
+
+
+    def test_skip():
+        pytest.skip("skipping this test")
+
+
+    def test_xfail():
+        pytest.xfail("xfailing this test")
+
+
+    @pytest.mark.xfail(reason="always xfail")
+    def test_xpass():
+        pass
+
+
 .. code-block:: pytest
 
     $ pytest -ra
     =========================== test session starts ============================
     platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 0 items
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collected 6 items
 
-    ======================= no tests ran in 0.12 seconds =======================
+    test_example.py .FEsxX                                               [100%]
+
+    ================================== ERRORS ==================================
+    _______________________ ERROR at setup of test_error _______________________
+
+        @pytest.fixture
+        def error_fixture():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:6: AssertionError
+    ================================= FAILURES =================================
+    ________________________________ test_fail _________________________________
+
+        def test_fail():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:14: AssertionError
+    ========================= short test summary info ==========================
+    SKIPPED [1] $REGENDOC_TMPDIR/test_example.py:23: skipping this test
+    XFAIL test_example.py::test_xfail
+      reason: xfailing this test
+    XPASS test_example.py::test_xpass always xfail
+    ERROR test_example.py::test_error
+    FAILED test_example.py::test_fail
+    = 1 failed, 1 passed, 1 skipped, 1 xfailed, 1 xpassed, 1 error in 0.12 seconds =
 
 The ``-r`` options accepts a number of characters after it, with ``a`` used above meaning "all except passes".
 
@@ -182,10 +255,72 @@ More than one character can be used, so for example to only see failed and skipp
     $ pytest -rfs
     =========================== test session starts ============================
     platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
-    rootdir: $REGENDOC_TMPDIR, inifile:
-    collected 0 items
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collected 6 items
 
-    ======================= no tests ran in 0.12 seconds =======================
+    test_example.py .FEsxX                                               [100%]
+
+    ================================== ERRORS ==================================
+    _______________________ ERROR at setup of test_error _______________________
+
+        @pytest.fixture
+        def error_fixture():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:6: AssertionError
+    ================================= FAILURES =================================
+    ________________________________ test_fail _________________________________
+
+        def test_fail():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:14: AssertionError
+    ========================= short test summary info ==========================
+    FAILED test_example.py::test_fail
+    SKIPPED [1] $REGENDOC_TMPDIR/test_example.py:23: skipping this test
+    = 1 failed, 1 passed, 1 skipped, 1 xfailed, 1 xpassed, 1 error in 0.12 seconds =
+
+Using ``p`` lists the passing tests, whilst ``P`` adds an extra section "PASSES" with those tests that passed but had
+captured output:
+
+.. code-block:: pytest
+
+    $ pytest -rpP
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
+    collected 6 items
+
+    test_example.py .FEsxX                                               [100%]
+
+    ================================== ERRORS ==================================
+    _______________________ ERROR at setup of test_error _______________________
+
+        @pytest.fixture
+        def error_fixture():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:6: AssertionError
+    ================================= FAILURES =================================
+    ________________________________ test_fail _________________________________
+
+        def test_fail():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:14: AssertionError
+    ========================= short test summary info ==========================
+    PASSED test_example.py::test_ok
+    ================================== PASSES ==================================
+    _________________________________ test_ok __________________________________
+    --------------------------- Captured stdout call ---------------------------
+    ok
+    = 1 failed, 1 passed, 1 skipped, 1 xfailed, 1 xpassed, 1 error in 0.12 seconds =
 
 .. _pdb-option:
 
@@ -195,13 +330,17 @@ Dropping to PDB_ (Python Debugger) on failures
 .. _PDB: http://docs.python.org/library/pdb.html
 
 Python comes with a builtin Python debugger called PDB_.  ``pytest``
-allows one to drop into the PDB_ prompt via a command line option::
+allows one to drop into the PDB_ prompt via a command line option:
+
+.. code-block:: bash
 
     pytest --pdb
 
 This will invoke the Python debugger on every failure (or KeyboardInterrupt).
 Often you might only want to do this for the first failing test to understand
-a certain failure situation::
+a certain failure situation:
+
+.. code-block:: bash
 
     pytest -x --pdb   # drop to PDB on first failure, then end test session
     pytest --pdb --maxfail=3  # drop to PDB for first three failures
@@ -224,7 +363,9 @@ Dropping to PDB_ (Python Debugger) at the start of a test
 ----------------------------------------------------------
 
 
-``pytest`` allows one to drop into the PDB_ prompt immediately at the start of each test via a command line option::
+``pytest`` allows one to drop into the PDB_ prompt immediately at the start of each test via a command line option:
+
+.. code-block:: bash
 
     pytest --trace
 
@@ -243,10 +384,8 @@ in your code and pytest automatically disables its output capture for that test:
 * Output capture in other tests is not affected.
 * Any prior test output that has already been captured and will be processed as
   such.
-* Any later output produced within the same test will not be captured and will
-  instead get sent directly to ``sys.stdout``. Note that this holds true even
-  for test output occurring after you exit the interactive PDB_ tracing session
-  and continue with the regular test run.
+* Output capture gets resumed when ending the debugger session (via the
+  ``continue`` command).
 
 
 .. _`breakpoint-builtin`:
@@ -269,7 +408,9 @@ Profiling test execution duration
 
 .. versionadded: 2.2
 
-To get a list of the slowest 10 test durations::
+To get a list of the slowest 10 test durations:
+
+.. code-block:: bash
 
     pytest --durations=10
 
@@ -279,13 +420,15 @@ Creating JUnitXML format files
 ----------------------------------------------------
 
 To create result files which can be read by Jenkins_ or other Continuous
-integration servers, use this invocation::
+integration servers, use this invocation:
+
+.. code-block:: bash
 
     pytest --junitxml=path
 
 to create an XML file at ``path``.
 
-.. versionadded:: 3.1
+
 
 To set the name of the root test suite xml item, you can configure the ``junit_suite_name`` option in your config file:
 
@@ -294,13 +437,27 @@ To set the name of the root test suite xml item, you can configure the ``junit_s
     [pytest]
     junit_suite_name = my_suite
 
+.. versionadded:: 4.0
+
+JUnit XML specification seems to indicate that ``"time"`` attribute
+should report total test execution times, including setup and teardown
+(`1 <http://windyroad.com.au/dl/Open%20Source/JUnit.xsd>`_, `2
+<https://www.ibm.com/support/knowledgecenter/en/SSQ2R2_14.1.0/com.ibm.rsar.analysis.codereview.cobol.doc/topics/cac_useresults_junit.html>`_).
+It is the default pytest behavior. To report just call durations
+instead, configure the ``junit_duration_report`` option like this:
+
+.. code-block:: ini
+
+    [pytest]
+    junit_duration_report = call
+
 .. _record_property example:
 
 record_property
 ^^^^^^^^^^^^^^^
 
-.. versionadded:: 2.8
-.. versionchanged:: 3.5
+
+
 
    Fixture renamed from ``record_xml_property`` to ``record_property`` as user
    properties are now available to all reporters.
@@ -371,7 +528,7 @@ Will result in:
 record_xml_attribute
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. versionadded:: 3.4
+
 
 To add an additional xml attribute to a testcase element, you can use
 ``record_xml_attribute`` fixture. This can also be used to override existing values:
@@ -431,7 +588,7 @@ Instead, this will add an attribute ``assertions="REQ-1234"`` inside the generat
 LogXML: add_global_property
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. versionadded:: 3.0
+
 
 If you want to add a properties node in the testsuite level, which may contains properties that are relevant
 to all testcases you can use ``LogXML.add_global_properties``
@@ -481,18 +638,16 @@ This will add a property node below the testsuite node to the generated xml:
 Creating resultlog format files
 ----------------------------------------------------
 
-.. deprecated:: 3.0
 
-    This option is rarely used and is scheduled for removal in 4.0.
 
-    An alternative for users which still need similar functionality is to use the
-    `pytest-tap <https://pypi.org/project/pytest-tap/>`_ plugin which provides
-    a stream of test data.
+    This option is rarely used and is scheduled for removal in 5.0.
 
-    If you have any concerns, please don't hesitate to
-    `open an issue <https://github.com/pytest-dev/pytest/issues>`_.
+    See `the deprecation docs <https://docs.pytest.org/en/latest/deprecations.html#result-log-result-log>`__
+    for more information.
 
-To create plain-text machine-readable result files you can issue::
+To create plain-text machine-readable result files you can issue:
+
+.. code-block:: bash
 
     pytest --resultlog=path
 
@@ -505,7 +660,9 @@ by the `PyPy-test`_ web page to show test results over several revisions.
 Sending test report to online pastebin service
 -----------------------------------------------------
 
-**Creating a URL for each test failure**::
+**Creating a URL for each test failure**:
+
+.. code-block:: bash
 
     pytest --pastebin=failed
 
@@ -513,12 +670,30 @@ This will submit test run information to a remote Paste service and
 provide a URL for each failure.  You may select tests as usual or add
 for example ``-x`` if you only want to send one particular failure.
 
-**Creating a URL for a whole test session log**::
+**Creating a URL for a whole test session log**:
+
+.. code-block:: bash
 
     pytest --pastebin=all
 
 Currently only pasting to the http://bpaste.net service is implemented.
 
+Early loading plugins
+---------------------
+
+You can early-load plugins (internal and external) explicitly in the command-line with the ``-p`` option::
+
+    pytest -p mypluginmodule
+
+The option receives a ``name`` parameter, which can be:
+
+* A full module dotted name, for example ``myproject.plugins``. This dotted name must be importable.
+* The entry-point name of a plugin. This is the name passed to ``setuptools`` when the plugin is
+  registered. For example to early-load the `pytest-cov <https://pypi.org/project/pytest-cov/>`__ plugin you can use::
+
+    pytest -p pytest_cov
+
+
 Disabling plugins
 -----------------
 
@@ -526,7 +701,9 @@ To disable loading specific plugins at invocation time, use the ``-p`` option
 together with the prefix ``no:``.
 
 Example: to disable loading the plugin ``doctest``, which is responsible for
-executing doctest tests from text files, invoke pytest like this::
+executing doctest tests from text files, invoke pytest like this:
+
+.. code-block:: bash
 
     pytest -p no:doctest
 
@@ -535,7 +712,7 @@ executing doctest tests from text files, invoke pytest like this::
 Calling pytest from Python code
 ----------------------------------------------------
 
-.. versionadded:: 2.0
+
 
 You can invoke ``pytest`` from Python code directly::
 
@@ -558,11 +735,30 @@ You can specify additional plugins to ``pytest.main``::
     pytest.main(["-qq"], plugins=[MyPlugin()])
 
 Running it will show that ``MyPlugin`` was added and its
-hook was invoked::
+hook was invoked:
+
+.. code-block:: pytest
 
     $ python myinvoke.py
-    .                                                                    [100%]*** test run reporting finishing
+    .FEsxX.                                                              [100%]*** test run reporting finishing
 
+    ================================== ERRORS ==================================
+    _______________________ ERROR at setup of test_error _______________________
+
+        @pytest.fixture
+        def error_fixture():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:6: AssertionError
+    ================================= FAILURES =================================
+    ________________________________ test_fail _________________________________
+
+        def test_fail():
+    >       assert 0
+    E       assert 0
+
+    test_example.py:14: AssertionError
 
 .. note::
 

doc/en/warnings.rst

@@ -3,18 +3,22 @@
 Warnings Capture
 ================
 
-.. versionadded:: 3.1
+
 
 Starting from version ``3.1``, pytest now automatically catches warnings during test execution
-and displays them at the end of the session::
+and displays them at the end of the session:
+
+.. code-block:: python
 
     # content of test_show_warnings.py
     import warnings
 
+
     def api_v1():
         warnings.warn(UserWarning("api v1, should use functions from v2"))
         return 1
 
+
     def test_one():
         assert api_v1() == 1
 
@@ -25,14 +29,15 @@ Running pytest now produces this output:
     $ pytest test_show_warnings.py
     =========================== test session starts ============================
     platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
-    rootdir: $REGENDOC_TMPDIR, inifile:
+    cachedir: $PYTHON_PREFIX/.pytest_cache
+    rootdir: $REGENDOC_TMPDIR
     collected 1 item
 
     test_show_warnings.py .                                              [100%]
 
     ============================= warnings summary =============================
     test_show_warnings.py::test_one
-      $REGENDOC_TMPDIR/test_show_warnings.py:4: UserWarning: api v1, should use functions from v2
+      $REGENDOC_TMPDIR/test_show_warnings.py:5: UserWarning: api v1, should use functions from v2
         warnings.warn(UserWarning("api v1, should use functions from v2"))
 
     -- Docs: https://docs.pytest.org/en/latest/warnings.html
@@ -51,14 +56,14 @@ them into errors:
         def test_one():
     >       assert api_v1() == 1
 
-    test_show_warnings.py:8:
+    test_show_warnings.py:10:
     _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
         def api_v1():
     >       warnings.warn(UserWarning("api v1, should use functions from v2"))
     E       UserWarning: api v1, should use functions from v2
 
-    test_show_warnings.py:4: UserWarning
+    test_show_warnings.py:5: UserWarning
     1 failed in 0.12 seconds
 
 The same option can be set in the ``pytest.ini`` file using the ``filterwarnings`` ini option.
@@ -85,7 +90,7 @@ documentation for other examples and advanced usage.
 ``@pytest.mark.filterwarnings``
 -------------------------------
 
-.. versionadded:: 3.2
+
 
 You can use the ``@pytest.mark.filterwarnings`` to add warning filters to specific test items,
 allowing you to have finer control of which warnings should be captured at test, class or
@@ -151,11 +156,11 @@ using an external system.
 DeprecationWarning and PendingDeprecationWarning
 ------------------------------------------------
 
-.. versionadded:: 3.8
-.. versionchanged:: 3.9
+
+
 
 By default pytest will display ``DeprecationWarning`` and ``PendingDeprecationWarning`` warnings from
-user code and third-party libraries, as recommended by `PEP-0506 <https://www.python.org/dev/peps/pep-0565>`_.
+user code and third-party libraries, as recommended by `PEP-0565 <https://www.python.org/dev/peps/pep-0565>`_.
 This helps users keep their code modern and avoid breakages when deprecated warnings are effectively removed.
 
 Sometimes it is useful to hide some specific deprecation warnings that happen in code that you have no control over
@@ -194,28 +199,36 @@ Ensuring code triggers a deprecation warning
 
 You can also call a global helper for checking
 that a certain function call triggers a ``DeprecationWarning`` or
-``PendingDeprecationWarning``::
+``PendingDeprecationWarning``:
+
+.. code-block:: python
 
     import pytest
 
+
     def test_global():
         pytest.deprecated_call(myfunction, 17)
 
 By default, ``DeprecationWarning`` and ``PendingDeprecationWarning`` will not be
 caught when using ``pytest.warns`` or ``recwarn`` because default Python warnings filters hide
 them. If you wish to record them in your own code, use the
-command ``warnings.simplefilter('always')``::
+command ``warnings.simplefilter('always')``:
+
+.. code-block:: python
 
     import warnings
     import pytest
 
+
     def test_deprecation(recwarn):
-        warnings.simplefilter('always')
+        warnings.simplefilter("always")
         warnings.warn("deprecated", DeprecationWarning)
         assert len(recwarn) == 1
         assert recwarn.pop(DeprecationWarning)
 
-You can also use it as a contextmanager::
+You can also use it as a contextmanager:
+
+.. code-block:: python
 
     def test_global():
         with pytest.deprecated_call():
@@ -232,16 +245,19 @@ You can also use it as a contextmanager::
 .. _warns:
 
 Asserting warnings with the warns function
------------------------------------------------
+------------------------------------------
+
 
-.. versionadded:: 2.8
 
 You can check that code raises a particular warning using ``pytest.warns``,
-which works in a similar manner to :ref:`raises <assertraises>`::
+which works in a similar manner to :ref:`raises <assertraises>`:
+
+.. code-block:: python
 
     import warnings
     import pytest
 
+
     def test_warning():
         with pytest.warns(UserWarning):
             warnings.warn("my warning", UserWarning)
@@ -268,7 +284,9 @@ You can also call ``pytest.warns`` on a function or code string::
 
 The function also returns a list of all raised warnings (as
 ``warnings.WarningMessage`` objects), which you can query for
-additional information::
+additional information:
+
+.. code-block:: python
 
     with pytest.warns(RuntimeWarning) as record:
         warnings.warn("another warning", RuntimeWarning)
@@ -290,13 +308,15 @@ Alternatively, you can examine raised warnings in detail using the
 .. _recwarn:
 
 Recording warnings
-------------------------
+------------------
 
 You can record raised warnings either using ``pytest.warns`` or with
 the ``recwarn`` fixture.
 
 To record with ``pytest.warns`` without asserting anything about the warnings,
-pass ``None`` as the expected warning type::
+pass ``None`` as the expected warning type:
+
+.. code-block:: python
 
     with pytest.warns(None) as record:
         warnings.warn("user", UserWarning)
@@ -306,10 +326,13 @@ pass ``None`` as the expected warning type::
     assert str(record[0].message) == "user"
     assert str(record[1].message) == "runtime"
 
-The ``recwarn`` fixture will record warnings for the whole function::
+The ``recwarn`` fixture will record warnings for the whole function:
+
+.. code-block:: python
 
     import warnings
 
+
     def test_hello(recwarn):
         warnings.warn("hello", UserWarning)
         assert len(recwarn) == 1
@@ -328,13 +351,33 @@ warnings, or index into it to get a particular recorded warning.
 
 Full API: :class:`WarningsRecorder`.
 
+.. _custom_failure_messages:
+
+Custom failure messages
+-----------------------
+
+Recording warnings provides an opportunity to produce custom test
+failure messages for when no warnings are issued or other conditions
+are met.
+
+.. code-block:: python
+
+    def test():
+        with pytest.warns(Warning) as record:
+            f()
+            if not record:
+                pytest.fail("Expected a warning!")
+
+If no warnings are issued when calling ``f``, then ``not record`` will
+evaluate to ``True``.  You can then call ``pytest.fail`` with a
+custom error message.
 
 .. _internal-warnings:
 
 Internal pytest warnings
 ------------------------
 
-.. versionadded:: 3.8
+
 
 pytest may generate its own warnings in some situations, such as improper usage or deprecated features.
 

doc/en/writing_plugins.rst

@@ -413,6 +413,7 @@ additionally it is possible to copy examples for an example folder before runnin
     $ pytest
     =========================== test session starts ============================
     platform linux -- Python 3.x.y, pytest-4.x.y, py-1.x.y, pluggy-0.x.y
+    cachedir: $PYTHON_PREFIX/.pytest_cache
     rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
     collected 2 items
 
@@ -495,7 +496,7 @@ hookwrapper: executing around other hooks
 
 .. currentmodule:: _pytest.core
 
-.. versionadded:: 2.7
+
 
 pytest plugins can implement hook wrappers which wrap the execution
 of other hook implementations.  A hook wrapper is a generator function
@@ -508,10 +509,13 @@ a :py:class:`Result <pluggy._Result>` instance which encapsulates a result or
 exception info.  The yield point itself will thus typically not raise
 exceptions (unless there are bugs).
 
-Here is an example definition of a hook wrapper::
+Here is an example definition of a hook wrapper:
+
+.. code-block:: python
 
     import pytest
 
+
     @pytest.hookimpl(hookwrapper=True)
     def pytest_pyfunc_call(pyfuncitem):
         do_something_before_next_hook_executes()
@@ -616,10 +620,13 @@ if you depend on a plugin that is not installed, validation will fail and
 the error message will not make much sense to your users.
 
 One approach is to defer the hook implementation to a new plugin instead of
-declaring the hook functions directly in your plugin module, for example::
+declaring the hook functions directly in your plugin module, for example:
+
+.. code-block:: python
 
     # contents of myplugin.py
 
+
     class DeferPlugin(object):
         """Simple plugin to defer pytest-xdist hook functions."""
 
@@ -627,8 +634,9 @@ declaring the hook functions directly in your plugin module, for example::
             """standard xdist hook function.
             """
 
+
     def pytest_configure(config):
-        if config.pluginmanager.hasplugin('xdist'):
+        if config.pluginmanager.hasplugin("xdist"):
             config.pluginmanager.register(DeferPlugin())
 
 This has the added benefit of allowing you to conditionally install hooks

doc/en/xunit_setup.rst

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

doc/en/yieldfixture.rst

@@ -5,9 +5,9 @@
 "yield_fixture" functions
 ---------------------------------------------------------------
 
-.. deprecated:: 3.0
 
-.. versionadded:: 2.4
+
+
 
 .. important::
     Since pytest-3.0, fixtures using the normal ``fixture`` decorator can use a ``yield``

pyproject.toml

@@ -5,6 +5,7 @@ requires = [
   "setuptools-scm",
   "wheel",
 ]
+build-backend = "setuptools.build_meta"
 
 [tool.towncrier]
 package = "pytest"

scripts/install-pypy.bat

@@ -1,6 +0,0 @@
-REM install pypy using choco
-REM redirect to a file because choco install python.pypy is too noisy. If the command fails, write output to console
-choco install python.pypy > pypy-inst.log 2>&1 || (type pypy-inst.log & exit /b 1)
-set PATH=C:\tools\pypy\pypy;%PATH% # so tox can find pypy
-echo PyPy installed
-pypy --version

scripts/prepare-coverage.bat

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

scripts/setup-coverage-vars.bat

@@ -0,0 +1,7 @@
+if "%PYTEST_COVERAGE%" == "1" (
+  set "_PYTEST_TOX_COVERAGE_RUN=coverage run -m"
+  set "_PYTEST_TOX_EXTRA_DEP=coverage-enable-subprocess"
+  echo Coverage vars configured, PYTEST_COVERAGE=%PYTEST_COVERAGE%
+) else (
+  echo Skipping coverage vars setup, PYTEST_COVERAGE=%PYTEST_COVERAGE%
+)

scripts/upload-coverage.bat

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

setup.cfg

@@ -36,10 +36,11 @@ platforms = unix, linux, osx, cygwin, win32
 zip_safe = no
 packages =
     _pytest
-    _pytest.assertion
     _pytest._code
-    _pytest.mark
+    _pytest._io
+    _pytest.assertion
     _pytest.config
+    _pytest.mark
 
 py_modules = pytest
 python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*

setup.py

@@ -1,8 +1,5 @@
-import os
-
 from setuptools import setup
 
-
 # TODO: if py gets upgrade to >=1.6,
 #       remove _width_of_current_line in terminal.py
 INSTALL_REQUIRES = [
@@ -10,20 +7,16 @@ INSTALL_REQUIRES = [
     "six>=1.10.0",
     "setuptools",
     "attrs>=17.4.0",
-    "more-itertools>=4.0.0",
+    'more-itertools>=4.0.0,<6.0.0;python_version<="2.7"',
+    'more-itertools>=4.0.0;python_version>"2.7"',
     "atomicwrites>=1.0",
-    'funcsigs;python_version<"3.0"',
+    'funcsigs>=1.0;python_version<"3.0"',
     'pathlib2>=2.2.0;python_version<"3.6"',
     'colorama;sys_platform=="win32"',
+    "pluggy>=0.11",
 ]
 
 
-# if _PYTEST_SETUP_SKIP_PLUGGY_DEP is set, skip installing pluggy;
-# used by tox.ini to test with pluggy master
-if "_PYTEST_SETUP_SKIP_PLUGGY_DEP" not in os.environ:
-    INSTALL_REQUIRES.append("pluggy>=0.7")
-
-
 def main():
     setup(
         use_scm_version={"write_to": "src/_pytest/_version.py"},
@@ -32,6 +25,7 @@ def main():
         # fmt: off
         extras_require={
             "testing": [
+                "argcomplete",
                 "hypothesis>=3.56",
                 "nose",
                 "requests",

src/_pytest/_code/code.py

@@ -3,7 +3,6 @@ from __future__ import division
 from __future__ import print_function
 
 import inspect
-import pprint
 import re
 import sys
 import traceback
@@ -14,17 +13,16 @@ from weakref import ref
 import attr
 import pluggy
 import py
-import six
 from six import text_type
 
 import _pytest
+from _pytest._io.saferepr import safeformat
+from _pytest._io.saferepr import saferepr
 from _pytest.compat import _PY2
 from _pytest.compat import _PY3
 from _pytest.compat import PY35
 from _pytest.compat import safe_str
 
-builtin_repr = repr
-
 if _PY3:
     from traceback import format_exception_only
 else:
@@ -139,12 +137,12 @@ class Frame(object):
         """
         f_locals = self.f_locals.copy()
         f_locals.update(vars)
-        six.exec_(code, self.f_globals, f_locals)
+        exec(code, self.f_globals, f_locals)
 
     def repr(self, object):
         """ return a 'safe' (non-recursive, one-line) string repr for 'object'
         """
-        return py.io.saferepr(object)
+        return saferepr(object)
 
     def is_true(self, object):
         return object
@@ -242,25 +240,20 @@ class TracebackEntry(object):
 
     def ishidden(self):
         """ return True if the current frame has a var __tracebackhide__
-            resolving to True
+            resolving to True.
 
             If __tracebackhide__ is a callable, it gets called with the
             ExceptionInfo instance and can decide whether to hide the traceback.
 
             mostly for internal use
         """
-        try:
-            tbh = self.frame.f_locals["__tracebackhide__"]
-        except KeyError:
-            try:
-                tbh = self.frame.f_globals["__tracebackhide__"]
-            except KeyError:
-                return False
-
-        if callable(tbh):
+        f = self.frame
+        tbh = f.f_locals.get(
+            "__tracebackhide__", f.f_globals.get("__tracebackhide__", False)
+        )
+        if tbh and callable(tbh):
             return tbh(None if self._excinfo is None else self._excinfo())
-        else:
-            return tbh
+        return tbh
 
     def __str__(self):
         try:
@@ -391,44 +384,86 @@ co_equal = compile(
 )
 
 
+@attr.s(repr=False)
 class ExceptionInfo(object):
     """ wraps sys.exc_info() objects and offers
         help for navigating the traceback.
     """
 
-    _striptext = ""
     _assert_start_repr = (
         "AssertionError(u'assert " if _PY2 else "AssertionError('assert "
     )
 
-    def __init__(self, tup=None, exprinfo=None):
-        import _pytest._code
+    _excinfo = attr.ib()
+    _striptext = attr.ib(default="")
+    _traceback = attr.ib(default=None)
 
-        if tup is None:
-            tup = sys.exc_info()
-            if exprinfo is None and isinstance(tup[1], AssertionError):
-                exprinfo = getattr(tup[1], "msg", None)
-                if exprinfo is None:
-                    exprinfo = py.io.saferepr(tup[1])
-                if exprinfo and exprinfo.startswith(self._assert_start_repr):
-                    self._striptext = "AssertionError: "
-        self._excinfo = tup
-        #: the exception class
-        self.type = tup[0]
-        #: the exception instance
-        self.value = tup[1]
-        #: the exception raw traceback
-        self.tb = tup[2]
-        #: the exception type name
-        self.typename = self.type.__name__
-        #: the exception traceback (_pytest._code.Traceback instance)
-        self.traceback = _pytest._code.Traceback(self.tb, excinfo=ref(self))
+    @classmethod
+    def from_current(cls, exprinfo=None):
+        """returns an ExceptionInfo matching the current traceback
+
+        .. warning::
+
+            Experimental API
+
+
+        :param exprinfo: a text string helping to determine if we should
+                         strip ``AssertionError`` from the output, defaults
+                         to the exception message/``__str__()``
+        """
+        tup = sys.exc_info()
+        assert tup[0] is not None, "no current exception"
+        _striptext = ""
+        if exprinfo is None and isinstance(tup[1], AssertionError):
+            exprinfo = getattr(tup[1], "msg", None)
+            if exprinfo is None:
+                exprinfo = saferepr(tup[1])
+            if exprinfo and exprinfo.startswith(cls._assert_start_repr):
+                _striptext = "AssertionError: "
+
+        return cls(tup, _striptext)
+
+    @classmethod
+    def for_later(cls):
+        """return an unfilled ExceptionInfo
+        """
+        return cls(None)
+
+    @property
+    def type(self):
+        """the exception class"""
+        return self._excinfo[0]
+
+    @property
+    def value(self):
+        """the exception value"""
+        return self._excinfo[1]
+
+    @property
+    def tb(self):
+        """the exception raw traceback"""
+        return self._excinfo[2]
+
+    @property
+    def typename(self):
+        """the type name of the exception"""
+        return self.type.__name__
+
+    @property
+    def traceback(self):
+        """the traceback"""
+        if self._traceback is None:
+            self._traceback = Traceback(self.tb, excinfo=ref(self))
+        return self._traceback
+
+    @traceback.setter
+    def traceback(self, value):
+        self._traceback = value
 
     def __repr__(self):
-        try:
-            return "<ExceptionInfo %s tblen=%d>" % (self.typename, len(self.traceback))
-        except AttributeError:
-            return "<ExceptionInfo uninitialized>"
+        if self._excinfo is None:
+            return "<ExceptionInfo for raises contextmanager>"
+        return "<ExceptionInfo %s tblen=%d>" % (self.typename, len(self.traceback))
 
     def exconly(self, tryshort=False):
         """ return the exception as a string
@@ -516,13 +551,11 @@ class ExceptionInfo(object):
         return fmt.repr_excinfo(self)
 
     def __str__(self):
-        try:
-            entry = self.traceback[-1]
-        except AttributeError:
+        if self._excinfo is None:
             return repr(self)
-        else:
-            loc = ReprFileLocation(entry.path, entry.lineno + 1, self.exconly())
-            return str(loc)
+        entry = self.traceback[-1]
+        loc = ReprFileLocation(entry.path, entry.lineno + 1, self.exconly())
+        return str(loc)
 
     def __unicode__(self):
         entry = self.traceback[-1]
@@ -580,14 +613,11 @@ class FormattedExcinfo(object):
             source = source.deindent()
         return source
 
-    def _saferepr(self, obj):
-        return py.io.saferepr(obj)
-
     def repr_args(self, entry):
         if self.funcargs:
             args = []
             for argname, argvalue in entry.frame.getargs(var=True):
-                args.append((argname, self._saferepr(argvalue)))
+                args.append((argname, saferepr(argvalue)))
             return ReprFuncArgs(args)
 
     def get_source(self, source, line_index=-1, excinfo=None, short=False):
@@ -640,9 +670,9 @@ class FormattedExcinfo(object):
                     # _repr() function, which is only reprlib.Repr in
                     # disguise, so is very configurable.
                     if self.truncate_locals:
-                        str_repr = self._saferepr(value)
+                        str_repr = saferepr(value)
                     else:
-                        str_repr = pprint.pformat(value)
+                        str_repr = safeformat(value)
                     # if len(str_repr) < 70 or not isinstance(value,
                     #                            (list, tuple, dict)):
                     lines.append("%-10s = %s" % (name, str_repr))
@@ -908,8 +938,6 @@ class ReprEntryNative(TerminalRepr):
 
 
 class ReprEntry(TerminalRepr):
-    localssep = "_ "
-
     def __init__(self, lines, reprfuncargs, reprlocals, filelocrepr, style):
         self.lines = lines
         self.reprfuncargs = reprfuncargs
@@ -931,7 +959,6 @@ class ReprEntry(TerminalRepr):
             red = line.startswith("E   ")
             tw.line(line, bold=True, red=red)
         if self.reprlocals:
-            # tw.sep(self.localssep, "Locals")
             tw.line("")
             self.reprlocals.toterminal(tw)
         if self.reprfileloc:

src/_pytest/_code/source.py

@@ -203,7 +203,9 @@ def compile_(source, filename=None, mode="exec", flags=0, dont_inherit=0):
 
 def getfslineno(obj):
     """ Return source location (path, lineno) for the given object.
-    If the source cannot be determined return ("", -1)
+    If the source cannot be determined return ("", -1).
+
+    The line number is 0-based.
     """
     from .code import Code
 
@@ -237,9 +239,7 @@ def getfslineno(obj):
 def findsource(obj):
     try:
         sourcelines, lineno = inspect.findsource(obj)
-    except py.builtin._sysex:
-        raise
-    except:  # noqa
+    except Exception:
         return None, -1
     source = Source()
     source.lines = [line.rstrip() for line in sourcelines]

src/_pytest/_io/saferepr.py

@@ -0,0 +1,82 @@
+import pprint
+
+from six.moves import reprlib
+
+
+def _call_and_format_exception(call, x, *args):
+    try:
+        # Try the vanilla repr and make sure that the result is a string
+        return call(x, *args)
+    except Exception as exc:
+        exc_name = type(exc).__name__
+        try:
+            exc_info = str(exc)
+        except Exception:
+            exc_info = "unknown"
+        return '<[%s("%s") raised in repr()] %s object at 0x%x>' % (
+            exc_name,
+            exc_info,
+            x.__class__.__name__,
+            id(x),
+        )
+
+
+class SafeRepr(reprlib.Repr):
+    """subclass of repr.Repr that limits the resulting size of repr()
+    and includes information on exceptions raised during the call.
+    """
+
+    def repr(self, x):
+        return self._callhelper(reprlib.Repr.repr, self, x)
+
+    def repr_unicode(self, x, level):
+        # Strictly speaking wrong on narrow builds
+        def repr(u):
+            if "'" not in u:
+                return u"'%s'" % u
+            elif '"' not in u:
+                return u'"%s"' % u
+            else:
+                return u"'%s'" % u.replace("'", r"\'")
+
+        s = repr(x[: self.maxstring])
+        if len(s) > self.maxstring:
+            i = max(0, (self.maxstring - 3) // 2)
+            j = max(0, self.maxstring - 3 - i)
+            s = repr(x[:i] + x[len(x) - j :])
+            s = s[:i] + "..." + s[len(s) - j :]
+        return s
+
+    def repr_instance(self, x, level):
+        return self._callhelper(repr, x)
+
+    def _callhelper(self, call, x, *args):
+        s = _call_and_format_exception(call, x, *args)
+        if len(s) > self.maxsize:
+            i = max(0, (self.maxsize - 3) // 2)
+            j = max(0, self.maxsize - 3 - i)
+            s = s[:i] + "..." + s[len(s) - j :]
+        return s
+
+
+def safeformat(obj):
+    """return a pretty printed string for the given object.
+    Failing __repr__ functions of user instances will be represented
+    with a short exception info.
+    """
+    return _call_and_format_exception(pprint.pformat, obj)
+
+
+def saferepr(obj, maxsize=240):
+    """return a size-limited safe repr-string for the given object.
+    Failing __repr__ functions of user instances will be represented
+    with a short exception info and 'saferepr' generally takes
+    care to never raise exceptions itself.  This function is a wrapper
+    around the Repr/reprlib functionality of the standard 2.6 lib.
+    """
+    # review exception handling
+    srepr = SafeRepr()
+    srepr.maxstring = maxsize
+    srepr.maxsize = maxsize
+    srepr.maxother = 160
+    return srepr.repr(obj)

src/_pytest/assertion/rewrite.py

@@ -19,7 +19,11 @@ import atomicwrites
 import py
 import six
 
+from _pytest._io.saferepr import saferepr
 from _pytest.assertion import util
+from _pytest.assertion.util import (  # noqa: F401
+    format_explanation as _format_explanation,
+)
 from _pytest.compat import spec_from_file_location
 from _pytest.pathlib import fnmatch_ex
 from _pytest.pathlib import PurePath
@@ -265,11 +269,11 @@ class AssertionRewritingHook(object):
 
     def _warn_already_imported(self, name):
         from _pytest.warning_types import PytestWarning
-        from _pytest.warnings import _issue_config_warning
+        from _pytest.warnings import _issue_warning_captured
 
-        _issue_config_warning(
+        _issue_warning_captured(
             PytestWarning("Module already imported so cannot be rewritten: %s" % name),
-            self.config,
+            self.config.hook,
             stacklevel=5,
         )
 
@@ -292,7 +296,7 @@ class AssertionRewritingHook(object):
             mod.__loader__ = self
             # Normally, this attribute is 3.4+
             mod.__spec__ = spec_from_file_location(name, co.co_filename, loader=self)
-            six.exec_(co, mod.__dict__)
+            exec(co, mod.__dict__)
         except:  # noqa
             if name in sys.modules:
                 del sys.modules[name]
@@ -343,9 +347,11 @@ def _write_pyc(state, co, source_stat, pyc):
     try:
         with atomicwrites.atomic_write(pyc, mode="wb", overwrite=True) as fp:
             fp.write(imp.get_magic())
-            mtime = int(source_stat.mtime)
+            # as of now, bytecode header expects 32-bit numbers for size and mtime (#4903)
+            mtime = int(source_stat.mtime) & 0xFFFFFFFF
             size = source_stat.size & 0xFFFFFFFF
-            fp.write(struct.pack("<ll", mtime, size))
+            # "<LL" stands for 2 unsigned longs, little-ending
+            fp.write(struct.pack("<LL", mtime, size))
             fp.write(marshal.dumps(co))
     except EnvironmentError as e:
         state.trace("error writing pyc file at %s: errno=%s" % (pyc, e.errno))
@@ -440,7 +446,7 @@ def _read_pyc(source, pyc, trace=lambda x: None):
         if (
             len(data) != 12
             or data[:4] != imp.get_magic()
-            or struct.unpack("<ll", data[4:]) != (mtime, size)
+            or struct.unpack("<LL", data[4:]) != (mtime & 0xFFFFFFFF, size & 0xFFFFFFFF)
         ):
             trace("_read_pyc(%s): invalid or out of date pyc" % source)
             return None
@@ -471,7 +477,7 @@ def _saferepr(obj):
     JSON reprs.
 
     """
-    r = py.io.saferepr(obj)
+    r = saferepr(obj)
     # only occurs in python2.x, repr must return text in python3+
     if isinstance(r, bytes):
         # Represent unprintable bytes as `\x##`
@@ -482,15 +488,12 @@ def _saferepr(obj):
     return r.replace(u"\n", u"\\n")
 
 
-from _pytest.assertion.util import format_explanation as _format_explanation  # noqa
-
-
 def _format_assertmsg(obj):
     """Format the custom assertion message given.
 
     For strings this simply replaces newlines with '\n~' so that
     util.format_explanation() will preserve them instead of escaping
-    newlines.  For other objects py.io.saferepr() is used first.
+    newlines.  For other objects saferepr() is used first.
 
     """
     # reprlib appears to have a bug which means that if a string
@@ -499,7 +502,7 @@ def _format_assertmsg(obj):
     # However in either case we want to preserve the newline.
     replaces = [(u"\n", u"\n~"), (u"%", u"%%")]
     if not isinstance(obj, six.string_types):
-        obj = py.io.saferepr(obj)
+        obj = saferepr(obj)
         replaces.append((u"\\n", u"\n~"))
 
     if isinstance(obj, bytes):
@@ -512,7 +515,13 @@ def _format_assertmsg(obj):
 
 
 def _should_repr_global_name(obj):
-    return not hasattr(obj, "__name__") and not callable(obj)
+    if callable(obj):
+        return False
+
+    try:
+        return not hasattr(obj, "__name__")
+    except Exception:
+        return True
 
 
 def _format_boolop(explanations, is_or):
@@ -659,7 +668,7 @@ class AssertionRewriter(ast.NodeVisitor):
         # Insert some special imports at the top of the module but after any
         # docstrings and __future__ imports.
         aliases = [
-            ast.alias(py.builtin.builtins.__name__, "@py_builtins"),
+            ast.alias(six.moves.builtins.__name__, "@py_builtins"),
             ast.alias("_pytest.assertion.rewrite", "@pytest_ar"),
         ]
         doc = getattr(mod, "docstring", None)
@@ -734,7 +743,7 @@ class AssertionRewriter(ast.NodeVisitor):
         return ast.Name(name, ast.Load())
 
     def display(self, expr):
-        """Call py.io.saferepr on the expression."""
+        """Call saferepr on the expression."""
         return self.helper("saferepr", expr)
 
     def helper(self, name, *args):
@@ -828,6 +837,13 @@ class AssertionRewriter(ast.NodeVisitor):
         self.push_format_context()
         # Rewrite assert into a bunch of statements.
         top_condition, explanation = self.visit(assert_.test)
+        # If in a test module, check if directly asserting None, in order to warn [Issue #3191]
+        if self.module_path is not None:
+            self.statements.append(
+                self.warn_about_none_ast(
+                    top_condition, module_path=self.module_path, lineno=assert_.lineno
+                )
+            )
         # Create failure message.
         body = self.on_failure
         negation = ast.UnaryOp(ast.Not(), top_condition)
@@ -858,6 +874,33 @@ class AssertionRewriter(ast.NodeVisitor):
             set_location(stmt, assert_.lineno, assert_.col_offset)
         return self.statements
 
+    def warn_about_none_ast(self, node, module_path, lineno):
+        """
+        Returns an AST issuing a warning if the value of node is `None`.
+        This is used to warn the user when asserting a function that asserts
+        internally already.
+        See issue #3191 for more details.
+        """
+
+        # Using parse because it is different between py2 and py3.
+        AST_NONE = ast.parse("None").body[0].value
+        val_is_none = ast.Compare(node, [ast.Is()], [AST_NONE])
+        send_warning = ast.parse(
+            """
+from _pytest.warning_types import PytestWarning
+from warnings import warn_explicit
+warn_explicit(
+    PytestWarning('asserting the value None, please use "assert is None"'),
+    category=None,
+    filename={filename!r},
+    lineno={lineno},
+)
+            """.format(
+                filename=module_path.strpath, lineno=lineno
+            )
+        ).body
+        return ast.If(val_is_none, send_warning, [])
+
     def visit_Name(self, name):
         # Display the repr of the name if it's a local variable or
         # _should_repr_global_name() thinks it's acceptable.

src/_pytest/assertion/truncate.py

@@ -12,7 +12,6 @@ import os
 
 import six
 
-
 DEFAULT_MAX_LINES = 8
 DEFAULT_MAX_CHARS = 8 * 80
 USAGE_MSG = "use '-vv' to show"

src/_pytest/assertion/util.py

@@ -5,11 +5,12 @@ from __future__ import print_function
 
 import pprint
 
-import py
 import six
 
 import _pytest._code
 from ..compat import Sequence
+from _pytest import outcomes
+from _pytest._io.saferepr import saferepr
 
 # The _reprcompare attribute on the util module is used by the new assertion
 # interpretation code and assertion rewriter to detect this plugin was
@@ -102,33 +103,46 @@ except NameError:
     basestring = str
 
 
+def issequence(x):
+    return isinstance(x, Sequence) and not isinstance(x, basestring)
+
+
+def istext(x):
+    return isinstance(x, basestring)
+
+
+def isdict(x):
+    return isinstance(x, dict)
+
+
+def isset(x):
+    return isinstance(x, (set, frozenset))
+
+
+def isdatacls(obj):
+    return getattr(obj, "__dataclass_fields__", None) is not None
+
+
+def isattrs(obj):
+    return getattr(obj, "__attrs_attrs__", None) is not None
+
+
+def isiterable(obj):
+    try:
+        iter(obj)
+        return not istext(obj)
+    except TypeError:
+        return False
+
+
 def assertrepr_compare(config, op, left, right):
     """Return specialised explanations for some operators/operands"""
     width = 80 - 15 - len(op) - 2  # 15 chars indentation, 1 space around op
-    left_repr = py.io.saferepr(left, maxsize=int(width // 2))
-    right_repr = py.io.saferepr(right, maxsize=width - len(left_repr))
+    left_repr = saferepr(left, maxsize=int(width // 2))
+    right_repr = saferepr(right, maxsize=width - len(left_repr))
 
     summary = u"%s %s %s" % (ecu(left_repr), op, ecu(right_repr))
 
-    def issequence(x):
-        return isinstance(x, Sequence) and not isinstance(x, basestring)
-
-    def istext(x):
-        return isinstance(x, basestring)
-
-    def isdict(x):
-        return isinstance(x, dict)
-
-    def isset(x):
-        return isinstance(x, (set, frozenset))
-
-    def isiterable(obj):
-        try:
-            iter(obj)
-            return not istext(obj)
-        except TypeError:
-            return False
-
     verbose = config.getoption("verbose")
     explanation = None
     try:
@@ -142,6 +156,11 @@ def assertrepr_compare(config, op, left, right):
                     explanation = _compare_eq_set(left, right, verbose)
                 elif isdict(left) and isdict(right):
                     explanation = _compare_eq_dict(left, right, verbose)
+                elif type(left) == type(right) and (isdatacls(left) or isattrs(left)):
+                    type_fn = (isdatacls, isattrs)
+                    explanation = _compare_eq_cls(left, right, verbose, type_fn)
+                elif verbose > 0:
+                    explanation = _compare_eq_verbose(left, right)
                 if isiterable(left) and isiterable(right):
                     expl = _compare_eq_iterable(left, right, verbose)
                     if explanation is not None:
@@ -151,11 +170,13 @@ def assertrepr_compare(config, op, left, right):
         elif op == "not in":
             if istext(left) and istext(right):
                 explanation = _notin_text(left, right, verbose)
+    except outcomes.Exit:
+        raise
     except Exception:
         explanation = [
             u"(pytest_assertion plugin: representation of details failed.  "
             u"Probably an object has a faulty __repr__.)",
-            six.text_type(_pytest._code.ExceptionInfo()),
+            six.text_type(_pytest._code.ExceptionInfo.from_current()),
         ]
 
     if not explanation:
@@ -164,8 +185,8 @@ def assertrepr_compare(config, op, left, right):
     return [summary] + explanation
 
 
-def _diff_text(left, right, verbose=False):
-    """Return the explanation for the diff between text or bytes
+def _diff_text(left, right, verbose=0):
+    """Return the explanation for the diff between text or bytes.
 
     Unless --verbose is used this will skip leading and trailing
     characters which are identical to keep the diff minimal.
@@ -191,7 +212,7 @@ def _diff_text(left, right, verbose=False):
         left = escape_for_readable_diff(left)
     if isinstance(right, bytes):
         right = escape_for_readable_diff(right)
-    if not verbose:
+    if verbose < 1:
         i = 0  # just in case left or right has zero length
         for i in range(min(len(left), len(right))):
             if left[i] != right[i]:
@@ -227,7 +248,19 @@ def _diff_text(left, right, verbose=False):
     return explanation
 
 
-def _compare_eq_iterable(left, right, verbose=False):
+def _compare_eq_verbose(left, right):
+    keepends = True
+    left_lines = repr(left).splitlines(keepends)
+    right_lines = repr(right).splitlines(keepends)
+
+    explanation = []
+    explanation += [u"-" + line for line in left_lines]
+    explanation += [u"+" + line for line in right_lines]
+
+    return explanation
+
+
+def _compare_eq_iterable(left, right, verbose=0):
     if not verbose:
         return [u"Use -v to get the full diff"]
     # dynamic import to speedup pytest
@@ -250,7 +283,7 @@ def _compare_eq_iterable(left, right, verbose=False):
     return explanation
 
 
-def _compare_eq_sequence(left, right, verbose=False):
+def _compare_eq_sequence(left, right, verbose=0):
     explanation = []
     for i in range(min(len(left), len(right))):
         if left[i] != right[i]:
@@ -259,32 +292,32 @@ def _compare_eq_sequence(left, right, verbose=False):
     if len(left) > len(right):
         explanation += [
             u"Left contains more items, first extra item: %s"
-            % py.io.saferepr(left[len(right)])
+            % saferepr(left[len(right)])
         ]
     elif len(left) < len(right):
         explanation += [
             u"Right contains more items, first extra item: %s"
-            % py.io.saferepr(right[len(left)])
+            % saferepr(right[len(left)])
         ]
     return explanation
 
 
-def _compare_eq_set(left, right, verbose=False):
+def _compare_eq_set(left, right, verbose=0):
     explanation = []
     diff_left = left - right
     diff_right = right - left
     if diff_left:
         explanation.append(u"Extra items in the left set:")
         for item in diff_left:
-            explanation.append(py.io.saferepr(item))
+            explanation.append(saferepr(item))
     if diff_right:
         explanation.append(u"Extra items in the right set:")
         for item in diff_right:
-            explanation.append(py.io.saferepr(item))
+            explanation.append(saferepr(item))
     return explanation
 
 
-def _compare_eq_dict(left, right, verbose=False):
+def _compare_eq_dict(left, right, verbose=0):
     explanation = []
     common = set(left).intersection(set(right))
     same = {k: left[k] for k in common if left[k] == right[k]}
@@ -297,9 +330,7 @@ def _compare_eq_dict(left, right, verbose=False):
     if diff:
         explanation += [u"Differing items:"]
         for k in diff:
-            explanation += [
-                py.io.saferepr({k: left[k]}) + " != " + py.io.saferepr({k: right[k]})
-            ]
+            explanation += [saferepr({k: left[k]}) + " != " + saferepr({k: right[k]})]
     extra_left = set(left) - set(right)
     if extra_left:
         explanation.append(u"Left contains more items:")
@@ -315,13 +346,45 @@ def _compare_eq_dict(left, right, verbose=False):
     return explanation
 
 
-def _notin_text(term, text, verbose=False):
+def _compare_eq_cls(left, right, verbose, type_fns):
+    isdatacls, isattrs = type_fns
+    if isdatacls(left):
+        all_fields = left.__dataclass_fields__
+        fields_to_check = [field for field, info in all_fields.items() if info.compare]
+    elif isattrs(left):
+        all_fields = left.__attrs_attrs__
+        fields_to_check = [field.name for field in all_fields if field.cmp]
+
+    same = []
+    diff = []
+    for field in fields_to_check:
+        if getattr(left, field) == getattr(right, field):
+            same.append(field)
+        else:
+            diff.append(field)
+
+    explanation = []
+    if same and verbose < 2:
+        explanation.append(u"Omitting %s identical items, use -vv to show" % len(same))
+    elif same:
+        explanation += [u"Matching attributes:"]
+        explanation += pprint.pformat(same).splitlines()
+    if diff:
+        explanation += [u"Differing attributes:"]
+        for field in diff:
+            explanation += [
+                (u"%s: %r != %r") % (field, getattr(left, field), getattr(right, field))
+            ]
+    return explanation
+
+
+def _notin_text(term, text, verbose=0):
     index = text.find(term)
     head = text[:index]
     tail = text[index + len(term) :]
     correct_text = head + tail
     diff = _diff_text(correct_text, text, verbose)
-    newdiff = [u"%s is contained here:" % py.io.saferepr(term, maxsize=42)]
+    newdiff = [u"%s is contained here:" % saferepr(term, maxsize=42)]
     for line in diff:
         if line.startswith(u"Skipping"):
             continue

src/_pytest/cacheprovider.py

@@ -33,6 +33,13 @@ which provides the `--lf` and `--ff` options, as well as the `cache` fixture.
 See [the docs](https://docs.pytest.org/en/latest/cache.html) for more information.
 """
 
+CACHEDIR_TAG_CONTENT = b"""\
+Signature: 8a477f597d28d172789f06886806bc55
+# This file is a cache directory tag created by pytest.
+# For information about cache directory tags, see:
+#	http://www.bford.info/cachedir/spec.html
+"""
+
 
 @attr.s
 class Cache(object):
@@ -52,12 +59,12 @@ class Cache(object):
         return resolve_from_str(config.getini("cache_dir"), config.rootdir)
 
     def warn(self, fmt, **args):
-        from _pytest.warnings import _issue_config_warning
+        from _pytest.warnings import _issue_warning_captured
         from _pytest.warning_types import PytestWarning
 
-        _issue_config_warning(
+        _issue_warning_captured(
             PytestWarning(fmt.format(**args) if args else fmt),
-            self._config,
+            self._config.hook,
             stacklevel=3,
         )
 
@@ -114,10 +121,12 @@ class Cache(object):
                 cache_dir_exists_already = True
             else:
                 cache_dir_exists_already = self._cachedir.exists()
-            path.parent.mkdir(exist_ok=True, parents=True)
+                path.parent.mkdir(exist_ok=True, parents=True)
         except (IOError, OSError):
             self.warn("could not create cache path {path}", path=path)
             return
+        if not cache_dir_exists_already:
+            self._ensure_supporting_files()
         try:
             f = path.open("wb" if PY2 else "w")
         except (IOError, OSError):
@@ -125,20 +134,18 @@ class Cache(object):
         else:
             with f:
                 json.dump(value, f, indent=2, sort_keys=True)
-            if not cache_dir_exists_already:
-                self._ensure_supporting_files()
 
     def _ensure_supporting_files(self):
         """Create supporting files in the cache dir that are not really part of the cache."""
-        if self._cachedir.is_dir():
-            readme_path = self._cachedir / "README.md"
-            if not readme_path.is_file():
-                readme_path.write_text(README_CONTENT)
+        readme_path = self._cachedir / "README.md"
+        readme_path.write_text(README_CONTENT)
 
-            gitignore_path = self._cachedir.joinpath(".gitignore")
-            if not gitignore_path.is_file():
-                msg = u"# Created by pytest automatically.\n*"
-                gitignore_path.write_text(msg, encoding="UTF-8")
+        gitignore_path = self._cachedir.joinpath(".gitignore")
+        msg = u"# Created by pytest automatically.\n*"
+        gitignore_path.write_text(msg, encoding="UTF-8")
+
+        cachedir_tag_path = self._cachedir.joinpath("CACHEDIR.TAG")
+        cachedir_tag_path.write_bytes(CACHEDIR_TAG_CONTENT)
 
 
 class LFPlugin(object):
@@ -333,7 +340,7 @@ def cache(request):
 
 def pytest_report_header(config):
     """Display cachedir with --cache-show and if non-default."""
-    if config.option.verbose or config.getini("cache_dir") != ".pytest_cache":
+    if config.option.verbose > 0 or config.getini("cache_dir") != ".pytest_cache":
         cachedir = config.cache._cachedir
         # TODO: evaluate generating upward relative paths
         # starting with .., ../.. if sensible

src/_pytest/capture.py

@@ -17,6 +17,7 @@ from tempfile import TemporaryFile
 import six
 
 import pytest
+from _pytest.compat import _PY3
 from _pytest.compat import CaptureIO
 
 patchsysdict = {0: "stdin", 1: "stdout", 2: "stderr"}
@@ -90,6 +91,13 @@ class CaptureManager(object):
         self._global_capturing = None
         self._current_item = None
 
+    def __repr__(self):
+        return "<CaptureManager _method=%r _global_capturing=%r _current_item=%r>" % (
+            self._method,
+            self._global_capturing,
+            self._current_item,
+        )
+
     def _getcapture(self, method):
         if method == "fd":
             return MultiCapture(out=True, err=True, Capture=FDCapture)
@@ -97,8 +105,17 @@ class CaptureManager(object):
             return MultiCapture(out=True, err=True, Capture=SysCapture)
         elif method == "no":
             return MultiCapture(out=False, err=False, in_=False)
-        else:
-            raise ValueError("unknown capturing method: %r" % method)
+        raise ValueError("unknown capturing method: %r" % method)  # pragma: no cover
+
+    def is_capturing(self):
+        if self.is_globally_capturing():
+            return "global"
+        capture_fixture = getattr(self._current_item, "_capture_fixture", None)
+        if capture_fixture is not None:
+            return (
+                "fixture %s" % self._current_item._capture_fixture.request.fixturename
+            )
+        return False
 
     # Global capturing control
 
@@ -127,6 +144,15 @@ class CaptureManager(object):
         if cap is not None:
             cap.suspend_capturing(in_=in_)
 
+    def suspend(self, in_=False):
+        # Need to undo local capsys-et-al if it exists before disabling global capture.
+        self.suspend_fixture(self._current_item)
+        self.suspend_global_capture(in_)
+
+    def resume(self):
+        self.resume_global_capture()
+        self.resume_fixture(self._current_item)
+
     def read_global_capture(self):
         return self._global_capturing.readouterr()
 
@@ -160,15 +186,12 @@ class CaptureManager(object):
 
     @contextlib.contextmanager
     def global_and_fixture_disabled(self):
-        """Context manager to temporarily disables global and current fixture capturing."""
-        # Need to undo local capsys-et-al if exists before disabling global capture
-        self.suspend_fixture(self._current_item)
-        self.suspend_global_capture(in_=False)
+        """Context manager to temporarily disable global and current fixture capturing."""
+        self.suspend()
         try:
             yield
         finally:
-            self.resume_global_capture()
-            self.resume_fixture(self._current_item)
+            self.resume()
 
     @contextlib.contextmanager
     def item_capture(self, when, item):
@@ -246,10 +269,11 @@ def _ensure_only_one_capture_fixture(request, name):
 
 @pytest.fixture
 def capsys(request):
-    """Enable capturing of writes to ``sys.stdout`` and ``sys.stderr`` and make
-    captured output available via ``capsys.readouterr()`` method calls
-    which return a ``(out, err)`` namedtuple.  ``out`` and ``err`` will be ``text``
-    objects.
+    """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.
     """
     _ensure_only_one_capture_fixture(request, "capsys")
     with _install_capture_fixture_on_item(request, SysCapture) as fixture:
@@ -258,26 +282,28 @@ def capsys(request):
 
 @pytest.fixture
 def capsysbinary(request):
-    """Enable capturing of writes to ``sys.stdout`` and ``sys.stderr`` and make
-    captured output available via ``capsys.readouterr()`` method calls
-    which return a ``(out, err)`` tuple.  ``out`` and ``err`` will be ``bytes``
-    objects.
+    """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.
     """
     _ensure_only_one_capture_fixture(request, "capsysbinary")
     # Currently, the implementation uses the python3 specific `.buffer`
     # property of CaptureIO.
     if sys.version_info < (3,):
-        raise request.raiseerror("capsysbinary is only supported on python 3")
+        raise request.raiseerror("capsysbinary is only supported on Python 3")
     with _install_capture_fixture_on_item(request, SysCaptureBinary) as fixture:
         yield fixture
 
 
 @pytest.fixture
 def capfd(request):
-    """Enable capturing of writes to file descriptors ``1`` and ``2`` and make
-    captured output available via ``capfd.readouterr()`` method calls
-    which return a ``(out, err)`` tuple.  ``out`` and ``err`` will be ``text``
-    objects.
+    """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.
     """
     _ensure_only_one_capture_fixture(request, "capfd")
     if not hasattr(os, "dup"):
@@ -290,10 +316,11 @@ def capfd(request):
 
 @pytest.fixture
 def capfdbinary(request):
-    """Enable capturing of write to file descriptors 1 and 2 and make
-    captured output available via ``capfdbinary.readouterr`` method calls
-    which return a ``(out, err)`` tuple.  ``out`` and ``err`` will be
-    ``bytes`` objects.
+    """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.
     """
     _ensure_only_one_capture_fixture(request, "capfdbinary")
     if not hasattr(os, "dup"):
@@ -315,9 +342,9 @@ def _install_capture_fixture_on_item(request, capture_class):
     """
     request.node._capture_fixture = fixture = CaptureFixture(capture_class, request)
     capmanager = request.config.pluginmanager.getplugin("capturemanager")
-    # need to active this fixture right away in case it is being used by another fixture (setup phase)
-    # if this fixture is being used only by a test function (call phase), then we wouldn't need this
-    # activation, but it doesn't hurt
+    # Need to active this fixture right away in case it is being used by another fixture (setup phase).
+    # If this fixture is being used only by a test function (call phase), then we wouldn't need this
+    # activation, but it doesn't hurt.
     capmanager.activate_fixture(request.node)
     yield fixture
     fixture.close()
@@ -356,7 +383,7 @@ class CaptureFixture(object):
     def readouterr(self):
         """Read and return the captured output so far, resetting the internal buffer.
 
-        :return: captured content as a namedtuple with  ``out`` and ``err`` string attributes
+        :return: captured content as a namedtuple with ``out`` and ``err`` string attributes
         """
         captured_out, captured_err = self._captured_out, self._captured_err
         if self._capture is not None:
@@ -412,6 +439,10 @@ class EncodedFile(object):
     def write(self, obj):
         if isinstance(obj, six.text_type):
             obj = obj.encode(self.encoding, "replace")
+        elif _PY3:
+            raise TypeError(
+                "write() argument must be str, not {}".format(type(obj).__name__)
+            )
         self.buffer.write(obj)
 
     def writelines(self, linelist):
@@ -441,6 +472,9 @@ class MultiCapture(object):
         if err:
             self.err = Capture(2)
 
+    def __repr__(self):
+        return "<MultiCapture out=%r err=%r in_=%r>" % (self.out, self.err, self.in_)
+
     def start_capturing(self):
         if self.in_:
             self.in_.start()
@@ -534,7 +568,10 @@ class FDCaptureBinary(object):
             self.tmpfile_fd = tmpfile.fileno()
 
     def __repr__(self):
-        return "<FDCapture %s oldfd=%s>" % (self.targetfd, self.targetfd_save)
+        return "<FDCapture %s oldfd=%s>" % (
+            self.targetfd,
+            getattr(self, "targetfd_save", None),
+        )
 
     def start(self):
         """ Start capturing on targetfd using memorized tmpfile. """
@@ -585,7 +622,7 @@ class FDCapture(FDCaptureBinary):
     EMPTY_BUFFER = str()
 
     def snap(self):
-        res = FDCaptureBinary.snap(self)
+        res = super(FDCapture, self).snap()
         enc = getattr(self.tmpfile, "encoding", None)
         if enc and isinstance(res, bytes):
             res = six.text_type(res, enc, "replace")
@@ -688,13 +725,11 @@ def _colorama_workaround():
     first import of colorama while I/O capture is active, colorama will
     fail in various ways.
     """
-
-    if not sys.platform.startswith("win32"):
-        return
-    try:
-        import colorama  # noqa
-    except ImportError:
-        pass
+    if sys.platform.startswith("win32"):
+        try:
+            import colorama  # noqa: F401
+        except ImportError:
+            pass
 
 
 def _readline_workaround():
@@ -715,13 +750,11 @@ def _readline_workaround():
 
     See https://github.com/pytest-dev/pytest/pull/1281
     """
-
-    if not sys.platform.startswith("win32"):
-        return
-    try:
-        import readline  # noqa
-    except ImportError:
-        pass
+    if sys.platform.startswith("win32"):
+        try:
+            import readline  # noqa: F401
+        except ImportError:
+            pass
 
 
 def _py36_windowsconsoleio_workaround(stream):
@@ -773,9 +806,9 @@ def _py36_windowsconsoleio_workaround(stream):
             f.line_buffering,
         )
 
-    sys.__stdin__ = sys.stdin = _reopen_stdio(sys.stdin, "rb")
-    sys.__stdout__ = sys.stdout = _reopen_stdio(sys.stdout, "wb")
-    sys.__stderr__ = sys.stderr = _reopen_stdio(sys.stderr, "wb")
+    sys.stdin = _reopen_stdio(sys.stdin, "rb")
+    sys.stdout = _reopen_stdio(sys.stdout, "wb")
+    sys.stderr = _reopen_stdio(sys.stderr, "wb")
 
 
 def _attempt_to_close_capture_file(f):

src/_pytest/compat.py

@@ -17,6 +17,7 @@ import six
 from six import text_type
 
 import _pytest
+from _pytest._io.saferepr import saferepr
 from _pytest.outcomes import fail
 from _pytest.outcomes import TEST_OUTCOME
 
@@ -45,11 +46,11 @@ MODULE_NOT_FOUND_ERROR = "ModuleNotFoundError" if PY36 else "ImportError"
 
 if _PY3:
     from collections.abc import MutableMapping as MappingMixin
-    from collections.abc import Mapping, Sequence
+    from collections.abc import Iterable, Mapping, Sequence, Sized
 else:
     # those raise DeprecationWarnings in Python >=3.7
     from collections import MutableMapping as MappingMixin  # noqa
-    from collections import Mapping, Sequence  # noqa
+    from collections import Iterable, Mapping, Sequence, Sized  # noqa
 
 
 if sys.version_info >= (3, 4):
@@ -182,6 +183,18 @@ def get_default_arg_names(function):
     )
 
 
+_non_printable_ascii_translate_table = {
+    i: u"\\x{:02x}".format(i) for i in range(128) if i not in range(32, 127)
+}
+_non_printable_ascii_translate_table.update(
+    {ord("\t"): u"\\t", ord("\r"): u"\\r", ord("\n"): u"\\n"}
+)
+
+
+def _translate_non_printable(s):
+    return s.translate(_non_printable_ascii_translate_table)
+
+
 if _PY3:
     STRING_TYPES = bytes, str
     UNICODE_TYPES = six.text_type
@@ -221,9 +234,10 @@ if _PY3:
 
         """
         if isinstance(val, bytes):
-            return _bytes_to_ascii(val)
+            ret = _bytes_to_ascii(val)
         else:
-            return val.encode("unicode_escape").decode("ascii")
+            ret = val.encode("unicode_escape").decode("ascii")
+        return _translate_non_printable(ret)
 
 
 else:
@@ -241,11 +255,12 @@ else:
         """
         if isinstance(val, bytes):
             try:
-                return val.encode("ascii")
+                ret = val.decode("ascii")
             except UnicodeDecodeError:
-                return val.encode("string-escape")
+                ret = val.encode("string-escape").decode("ascii")
         else:
-            return val.encode("unicode-escape")
+            ret = val.encode("unicode-escape").decode("ascii")
+        return _translate_non_printable(ret)
 
 
 class _PytestWrapper(object):
@@ -280,7 +295,7 @@ def get_real_func(obj):
     else:
         raise ValueError(
             ("could not find real function of {start}\nstopped at {current}").format(
-                start=py.io.saferepr(start_obj), current=py.io.saferepr(obj)
+                start=saferepr(start_obj), current=saferepr(obj)
             )
         )
     if isinstance(obj, functools.partial):
@@ -375,7 +390,6 @@ else:
 COLLECT_FAKEMODULE_ATTRIBUTES = (
     "Collector",
     "Module",
-    "Generator",
     "Function",
     "Instance",
     "Session",

src/_pytest/config/__init__.py

@@ -14,7 +14,6 @@ import warnings
 
 import py
 import six
-from pkg_resources import parse_version
 from pluggy import HookimplMarker
 from pluggy import HookspecMarker
 from pluggy import PluginManager
@@ -26,11 +25,14 @@ from .exceptions import PrintHelp
 from .exceptions import UsageError
 from .findpaths import determine_setup
 from .findpaths import exists
+from _pytest import deprecated
 from _pytest._code import ExceptionInfo
 from _pytest._code import filter_traceback
 from _pytest.compat import lru_cache
 from _pytest.compat import safe_str
+from _pytest.outcomes import fail
 from _pytest.outcomes import Skipped
+from _pytest.warning_types import PytestWarning
 
 hookimpl = HookimplMarker("pytest")
 hookspec = HookspecMarker("pytest")
@@ -138,6 +140,7 @@ default_plugins = (
     "stepwise",
     "warnings",
     "logging",
+    "reports",
 )
 
 
@@ -145,10 +148,15 @@ builtin_plugins = set(default_plugins)
 builtin_plugins.add("pytester")
 
 
-def get_config():
+def get_config(args=None):
     # subsequent calls to main will create a fresh instance
     pluginmanager = PytestPluginManager()
     config = Config(pluginmanager)
+
+    if args is not None:
+        # Handle any "-p no:plugin" args.
+        pluginmanager.consider_preparse(args)
+
     for spec in default_plugins:
         pluginmanager.import_plugin(spec)
     return config
@@ -173,13 +181,10 @@ def _prepareconfig(args=None, plugins=None):
     elif isinstance(args, py.path.local):
         args = [str(args)]
     elif not isinstance(args, (tuple, list)):
-        if not isinstance(args, str):
-            raise ValueError("not a string or argument list: %r" % (args,))
-        args = shlex.split(args, posix=sys.platform != "win32")
-        from _pytest import deprecated
+        msg = "`args` parameter expected to be a list or tuple of strings, got: {!r} (type: {})"
+        raise TypeError(msg.format(args, type(args)))
 
-        warning = deprecated.MAIN_STR_ARGS
-    config = get_config()
+    config = get_config(args)
     pluginmanager = config.pluginmanager
     try:
         if plugins:
@@ -189,9 +194,9 @@ def _prepareconfig(args=None, plugins=None):
                 else:
                     pluginmanager.register(plugin)
         if warning:
-            from _pytest.warnings import _issue_config_warning
+            from _pytest.warnings import _issue_warning_captured
 
-            _issue_config_warning(warning, config=config, stacklevel=4)
+            _issue_warning_captured(warning, hook=config.hook, stacklevel=4)
         return pluginmanager.hook.pytest_cmdline_parse(
             pluginmanager=pluginmanager, args=args
         )
@@ -245,14 +250,7 @@ class PytestPluginManager(PluginManager):
         Use :py:meth:`pluggy.PluginManager.add_hookspecs <PluginManager.add_hookspecs>`
         instead.
         """
-        warning = dict(
-            code="I2",
-            fslocation=_pytest._code.getfslineno(sys._getframe(1)),
-            nodeid=None,
-            message="use pluginmanager.add_hookspecs instead of "
-            "deprecated addhooks() method.",
-        )
-        self._warn(warning)
+        warnings.warn(deprecated.PLUGIN_MANAGER_ADDHOOKS, stacklevel=2)
         return self.add_hookspecs(module_or_class)
 
     def parse_hookimpl_opts(self, plugin, name):
@@ -261,8 +259,8 @@ class PytestPluginManager(PluginManager):
         # (see issue #1073)
         if not name.startswith("pytest_"):
             return
-        # ignore some historic special names which can not be hooks anyway
-        if name == "pytest_plugins" or name.startswith("pytest_funcarg__"):
+        # ignore names which can not be hooks
+        if name == "pytest_plugins":
             return
 
         method = getattr(plugin, name)
@@ -275,10 +273,14 @@ class PytestPluginManager(PluginManager):
         # collect unmarked hooks as long as they have the `pytest_' prefix
         if opts is None and name.startswith("pytest_"):
             opts = {}
-
         if opts is not None:
+            # TODO: DeprecationWarning, people should use hookimpl
+            # https://github.com/pytest-dev/pytest/issues/4562
+            known_marks = {m.name for m in getattr(method, "pytestmark", [])}
+
             for name in ("tryfirst", "trylast", "optionalhook", "hookwrapper"):
-                opts.setdefault(name, hasattr(method, name))
+
+                opts.setdefault(name, hasattr(method, name) or name in known_marks)
         return opts
 
     def parse_hookspec_opts(self, module_or_class, name):
@@ -287,19 +289,27 @@ class PytestPluginManager(PluginManager):
         )
         if opts is None:
             method = getattr(module_or_class, name)
+
             if name.startswith("pytest_"):
+                # todo: deprecate hookspec hacks
+                # https://github.com/pytest-dev/pytest/issues/4562
+                known_marks = {m.name for m in getattr(method, "pytestmark", [])}
                 opts = {
-                    "firstresult": hasattr(method, "firstresult"),
-                    "historic": hasattr(method, "historic"),
+                    "firstresult": hasattr(method, "firstresult")
+                    or "firstresult" in known_marks,
+                    "historic": hasattr(method, "historic")
+                    or "historic" in known_marks,
                 }
         return opts
 
     def register(self, plugin, name=None):
         if name in ["pytest_catchlog", "pytest_capturelog"]:
-            self._warn(
-                "{} plugin has been merged into the core, "
-                "please remove it from your requirements.".format(
-                    name.replace("_", "-")
+            warnings.warn(
+                PytestWarning(
+                    "{} plugin has been merged into the core, "
+                    "please remove it from your requirements.".format(
+                        name.replace("_", "-")
+                    )
                 )
             )
             return
@@ -336,14 +346,6 @@ class PytestPluginManager(PluginManager):
         )
         self._configured = True
 
-    def _warn(self, message):
-        kwargs = (
-            message
-            if isinstance(message, dict)
-            else {"code": "I1", "message": message, "fslocation": None, "nodeid": None}
-        )
-        self.hook.pytest_logwarning.call_historic(kwargs=kwargs)
-
     #
     # internal API for local conftest plugin handling
     #
@@ -411,7 +413,10 @@ class PytestPluginManager(PluginManager):
                 continue
             conftestpath = parent.join("conftest.py")
             if conftestpath.isfile():
-                mod = self._importconftest(conftestpath)
+                # Use realpath to avoid loading the same conftest twice
+                # with build systems that create build directories containing
+                # symlinks to actual files.
+                mod = self._importconftest(conftestpath.realpath())
                 clist.append(mod)
         self._dirpath2confmods[directory] = clist
         return clist
@@ -440,14 +445,14 @@ class PytestPluginManager(PluginManager):
                     and not self._using_pyargs
                 ):
                     from _pytest.deprecated import (
-                        PYTEST_PLUGINS_FROM_NON_TOP_LEVEL_CONFTEST
+                        PYTEST_PLUGINS_FROM_NON_TOP_LEVEL_CONFTEST,
                     )
 
-                    warnings.warn_explicit(
-                        PYTEST_PLUGINS_FROM_NON_TOP_LEVEL_CONFTEST,
-                        category=None,
-                        filename=str(conftestpath),
-                        lineno=0,
+                    fail(
+                        PYTEST_PLUGINS_FROM_NON_TOP_LEVEL_CONFTEST.format(
+                            conftestpath, self._confcutdir
+                        ),
+                        pytrace=False,
                     )
             except Exception:
                 raise ConftestImportFailure(conftestpath, sys.exc_info())
@@ -470,9 +475,23 @@ class PytestPluginManager(PluginManager):
     #
 
     def consider_preparse(self, args):
-        for opt1, opt2 in zip(args, args[1:]):
-            if opt1 == "-p":
-                self.consider_pluginarg(opt2)
+        i = 0
+        n = len(args)
+        while i < n:
+            opt = args[i]
+            i += 1
+            if isinstance(opt, six.string_types):
+                if opt == "-p":
+                    try:
+                        parg = args[i]
+                    except IndexError:
+                        return
+                    i += 1
+                elif opt.startswith("-p"):
+                    parg = opt[2:]
+                else:
+                    continue
+                self.consider_pluginarg(parg)
 
     def consider_pluginarg(self, arg):
         if arg.startswith("no:"):
@@ -486,7 +505,15 @@ class PytestPluginManager(PluginManager):
             if not name.startswith("pytest_"):
                 self.set_blocked("pytest_" + name)
         else:
-            self.import_plugin(arg)
+            name = arg
+            # Unblock the plugin.  None indicates that it has been blocked.
+            # There is no interface with pluggy for this.
+            if self._name2plugin.get(name, -1) is None:
+                del self._name2plugin[name]
+            if not name.startswith("pytest_"):
+                if self._name2plugin.get("pytest_" + name, -1) is None:
+                    del self._name2plugin["pytest_" + name]
+            self.import_plugin(arg, consider_entry_points=True)
 
     def consider_conftest(self, conftestmodule):
         self.register(conftestmodule, name=conftestmodule.__file__)
@@ -502,36 +529,50 @@ class PytestPluginManager(PluginManager):
         for import_spec in plugins:
             self.import_plugin(import_spec)
 
-    def import_plugin(self, modname):
+    def import_plugin(self, modname, consider_entry_points=False):
+        """
+        Imports a plugin with ``modname``. If ``consider_entry_points`` is True, entry point
+        names are also considered to find a plugin.
+        """
         # most often modname refers to builtin modules, e.g. "pytester",
         # "terminal" or "capture".  Those plugins are registered under their
         # basename for historic purposes but must be imported with the
         # _pytest prefix.
-        assert isinstance(modname, (six.text_type, str)), (
+        assert isinstance(modname, six.string_types), (
             "module name as text required, got %r" % modname
         )
         modname = str(modname)
         if self.is_blocked(modname) or self.get_plugin(modname) is not None:
             return
-        if modname in builtin_plugins:
-            importspec = "_pytest." + modname
-        else:
-            importspec = modname
+
+        importspec = "_pytest." + modname if modname in builtin_plugins else modname
         self.rewrite_hook.mark_rewrite(importspec)
+
+        if consider_entry_points:
+            loaded = self.load_setuptools_entrypoints("pytest11", name=modname)
+            if loaded:
+                return
+
         try:
             __import__(importspec)
         except ImportError as e:
-            new_exc_type = ImportError
             new_exc_message = 'Error importing plugin "%s": %s' % (
                 modname,
                 safe_str(e.args[0]),
             )
-            new_exc = new_exc_type(new_exc_message)
+            new_exc = ImportError(new_exc_message)
+            tb = sys.exc_info()[2]
 
-            six.reraise(new_exc_type, new_exc, sys.exc_info()[2])
+            six.reraise(ImportError, new_exc, tb)
 
         except Skipped as e:
-            self._warn("skipped plugin %r: %s" % ((modname, e.msg)))
+            from _pytest.warnings import _issue_warning_captured
+
+            _issue_warning_captured(
+                PytestWarning("skipped plugin %r: %s" % (modname, e.msg)),
+                self.hook,
+                stacklevel=1,
+            )
         else:
             mod = sys.modules[importspec]
             self.register(mod, modname)
@@ -545,8 +586,8 @@ def _get_plugin_specs_as_list(specs):
     which case it is returned as a list. Specs can also be `None` in which case an
     empty list is returned.
     """
-    if specs is not None:
-        if isinstance(specs, str):
+    if specs is not None and not isinstance(specs, types.ModuleType):
+        if isinstance(specs, six.string_types):
             specs = specs.split(",") if specs else []
         if not isinstance(specs, (list, tuple)):
             raise UsageError(
@@ -606,16 +647,9 @@ class Config(object):
         self._override_ini = ()
         self._opt2dest = {}
         self._cleanup = []
-        self._warn = self.pluginmanager._warn
         self.pluginmanager.register(self, "pytestconfig")
         self._configured = False
-
-        def do_setns(dic):
-            import pytest
-
-            setns(pytest, dic)
-
-        self.hook.pytest_namespace.call_historic(do_setns, {})
+        self.invocation_dir = py.path.local()
         self.hook.pytest_addoption.call_historic(kwargs=dict(parser=self._parser))
 
     def add_cleanup(self, func):
@@ -637,46 +671,35 @@ class Config(object):
             fin = self._cleanup.pop()
             fin()
 
-    def warn(self, code, message, fslocation=None, nodeid=None):
-        """
-        .. deprecated:: 3.8
-
-            Use :py:func:`warnings.warn` or :py:func:`warnings.warn_explicit` directly instead.
-
-        Generate a warning for this test session.
-        """
-        from _pytest.warning_types import RemovedInPytest4Warning
-
-        if isinstance(fslocation, (tuple, list)) and len(fslocation) > 2:
-            filename, lineno = fslocation[:2]
-        else:
-            filename = "unknown file"
-            lineno = 0
-        msg = "config.warn has been deprecated, use warnings.warn instead"
-        if nodeid:
-            msg = "{}: {}".format(nodeid, msg)
-        warnings.warn_explicit(
-            RemovedInPytest4Warning(msg),
-            category=None,
-            filename=filename,
-            lineno=lineno,
-        )
-        self.hook.pytest_logwarning.call_historic(
-            kwargs=dict(
-                code=code, message=message, fslocation=fslocation, nodeid=nodeid
-            )
-        )
-
     def get_terminal_writer(self):
         return self.pluginmanager.get_plugin("terminalreporter")._tw
 
     def pytest_cmdline_parse(self, pluginmanager, args):
-        # REF1 assert self == pluginmanager.config, (self, pluginmanager.config)
-        self.parse(args)
+        try:
+            self.parse(args)
+        except UsageError:
+
+            # Handle --version and --help here in a minimal fashion.
+            # This gets done via helpconfig normally, but its
+            # pytest_cmdline_main is not called in case of errors.
+            if getattr(self.option, "version", False) or "--version" in args:
+                from _pytest.helpconfig import showversion
+
+                showversion(self)
+            elif (
+                getattr(self.option, "help", False) or "--help" in args or "-h" in args
+            ):
+                self._parser._getparser().print_help()
+                sys.stdout.write(
+                    "\nNOTE: displaying only minimal help due to UsageError.\n\n"
+                )
+
+            raise
+
         return self
 
     def notify_exception(self, excinfo, option=None):
-        if option and option.fulltrace:
+        if option and getattr(option, "fulltrace", False):
             style = "long"
         else:
             style = "native"
@@ -699,7 +722,7 @@ class Config(object):
     @classmethod
     def fromdictargs(cls, option_dict, args):
         """ constructor useable for subprocesses. """
-        config = get_config()
+        config = get_config(args)
         config.option.__dict__.update(option_dict)
         config.parse(args, addopts=False)
         for x in config.option.plugins:
@@ -731,7 +754,6 @@ class Config(object):
         self.rootdir, self.inifile, self.inicfg = r
         self._parser.extra_info["rootdir"] = self.rootdir
         self._parser.extra_info["inifile"] = self.inifile
-        self.invocation_dir = py.path.local()
         self._parser.addini("addopts", "extra command line options", "args")
         self._parser.addini("minversion", "minimally required pytest version")
         self._override_ini = ns.override_ini or ()
@@ -744,7 +766,7 @@ class Config(object):
         by the importhook.
         """
         ns, unknown_args = self._parser.parse_known_and_unknown_args(args)
-        mode = ns.assertmode
+        mode = getattr(ns, "assertmode", "plain")
         if mode == "rewrite":
             try:
                 hook = _pytest.assertion.install_importhook(self)
@@ -784,21 +806,32 @@ class Config(object):
         for name in _iter_rewritable_modules(package_files):
             hook.mark_rewrite(name)
 
-    def _validate_args(self, args):
+    def _validate_args(self, args, via):
         """Validate known args."""
-        self._parser.parse_known_and_unknown_args(
-            args, namespace=copy.copy(self.option)
-        )
+        self._parser._config_source_hint = via
+        try:
+            self._parser.parse_known_and_unknown_args(
+                args, namespace=copy.copy(self.option)
+            )
+        finally:
+            del self._parser._config_source_hint
+
         return args
 
     def _preparse(self, args, addopts=True):
         if addopts:
             env_addopts = os.environ.get("PYTEST_ADDOPTS", "")
             if len(env_addopts):
-                args[:] = self._validate_args(shlex.split(env_addopts)) + args
+                args[:] = (
+                    self._validate_args(shlex.split(env_addopts), "via PYTEST_ADDOPTS")
+                    + args
+                )
         self._initini(args)
         if addopts:
-            args[:] = self._validate_args(self.getini("addopts")) + args
+            args[:] = (
+                self._validate_args(self.getini("addopts"), "via addopts config") + args
+            )
+
         self._checkversion()
         self._consider_importhook(args)
         self.pluginmanager.consider_preparse(args)
@@ -822,12 +855,21 @@ class Config(object):
             if ns.help or ns.version:
                 # we don't want to prevent --help/--version to work
                 # so just let is pass and print a warning at the end
-                self._warn("could not load initial conftests (%s)\n" % e.path)
+                from _pytest.warnings import _issue_warning_captured
+
+                _issue_warning_captured(
+                    PytestWarning(
+                        "could not load initial conftests: {}".format(e.path)
+                    ),
+                    self.hook,
+                    stacklevel=2,
+                )
             else:
                 raise
 
     def _checkversion(self):
         import pytest
+        from pkg_resources import parse_version
 
         minver = self.inicfg.get("minversion", None)
         if minver:

src/_pytest/config/argparsing.py

@@ -1,12 +1,10 @@
 import argparse
-import sys as _sys
 import warnings
-from gettext import gettext as _
 
 import py
 import six
 
-from ..main import EXIT_USAGEERROR
+from _pytest.config.exceptions import UsageError
 
 FILE_OR_DIR = "file_or_dir"
 
@@ -18,6 +16,8 @@ class Parser(object):
         there's an error processing the command line arguments.
     """
 
+    prog = None
+
     def __init__(self, usage=None, processopt=None):
         self._anonymous = OptionGroup("custom options", parser=self)
         self._groups = []
@@ -82,7 +82,7 @@ class Parser(object):
     def _getparser(self):
         from _pytest._argcomplete import filescompleter
 
-        optparser = MyOptionParser(self, self.extra_info)
+        optparser = MyOptionParser(self, self.extra_info, prog=self.prog)
         groups = self._groups + [self._anonymous]
         for group in groups:
             if group.options:
@@ -319,12 +319,13 @@ class OptionGroup(object):
 
 
 class MyOptionParser(argparse.ArgumentParser):
-    def __init__(self, parser, extra_info=None):
+    def __init__(self, parser, extra_info=None, prog=None):
         if not extra_info:
             extra_info = {}
         self._parser = parser
         argparse.ArgumentParser.__init__(
             self,
+            prog=prog,
             usage=parser._usage,
             add_help=False,
             formatter_class=DropShorterLongHelpFormatter,
@@ -334,14 +335,13 @@ class MyOptionParser(argparse.ArgumentParser):
         self.extra_info = extra_info
 
     def error(self, message):
-        """error(message: string)
+        """Transform argparse error message into UsageError."""
+        msg = "%s: error: %s" % (self.prog, message)
 
-        Prints a usage message incorporating the message to stderr and
-        exits.
-        Overrides the method in parent class to change exit code"""
-        self.print_usage(_sys.stderr)
-        args = {"prog": self.prog, "message": message}
-        self.exit(EXIT_USAGEERROR, _("%(prog)s: error: %(message)s\n") % args)
+        if hasattr(self._parser, "_config_source_hint"):
+            msg = "%s (%s)" % (msg, self._parser._config_source_hint)
+
+        raise UsageError(self.format_usage() + msg)
 
     def parse_args(self, args=None, namespace=None):
         """allow splitting of positional arguments"""

src/_pytest/config/findpaths.py

@@ -3,6 +3,7 @@ import os
 import py
 
 from .exceptions import UsageError
+from _pytest.outcomes import fail
 
 
 def exists(path, ignore=EnvironmentError):
@@ -32,24 +33,19 @@ def getcfg(args, config=None):
                 p = base.join(inibasename)
                 if exists(p):
                     iniconfig = py.iniconfig.IniConfig(p)
-                    if "pytest" in iniconfig.sections:
-                        if inibasename == "setup.cfg" and config is not None:
-                            from _pytest.warnings import _issue_config_warning
-                            from _pytest.warning_types import RemovedInPytest4Warning
-
-                            _issue_config_warning(
-                                RemovedInPytest4Warning(
-                                    CFG_PYTEST_SECTION.format(filename=inibasename)
-                                ),
-                                config=config,
-                                stacklevel=2,
-                            )
-                        return base, p, iniconfig["pytest"]
                     if (
                         inibasename == "setup.cfg"
                         and "tool:pytest" in iniconfig.sections
                     ):
                         return base, p, iniconfig["tool:pytest"]
+                    elif "pytest" in iniconfig.sections:
+                        if inibasename == "setup.cfg" and config is not None:
+
+                            fail(
+                                CFG_PYTEST_SECTION.format(filename=inibasename),
+                                pytrace=False,
+                            )
+                        return base, p, iniconfig["pytest"]
                     elif inibasename == "pytest.ini":
                         # allowed to be empty
                         return base, p, {}
@@ -112,40 +108,41 @@ def determine_setup(inifile, args, rootdir_cmd_arg=None, config=None):
                 inicfg = iniconfig[section]
                 if is_cfg_file and section == "pytest" and config is not None:
                     from _pytest.deprecated import CFG_PYTEST_SECTION
-                    from _pytest.warnings import _issue_config_warning
 
-                    # TODO: [pytest] section in *.cfg files is deprecated. Need refactoring once
-                    # the deprecation expires.
-                    _issue_config_warning(
-                        CFG_PYTEST_SECTION.format(filename=str(inifile)),
-                        config,
-                        stacklevel=2,
+                    fail(
+                        CFG_PYTEST_SECTION.format(filename=str(inifile)), pytrace=False
                     )
                 break
             except KeyError:
                 inicfg = None
-        rootdir = get_common_ancestor(dirs)
+        if rootdir_cmd_arg is None:
+            rootdir = get_common_ancestor(dirs)
     else:
         ancestor = get_common_ancestor(dirs)
         rootdir, inifile, inicfg = getcfg([ancestor], config=config)
-        if rootdir is None:
-            for rootdir in ancestor.parts(reverse=True):
-                if rootdir.join("setup.py").exists():
+        if rootdir is None and rootdir_cmd_arg is None:
+            for possible_rootdir in ancestor.parts(reverse=True):
+                if possible_rootdir.join("setup.py").exists():
+                    rootdir = possible_rootdir
                     break
             else:
-                rootdir, inifile, inicfg = getcfg(dirs, config=config)
+                if dirs != [ancestor]:
+                    rootdir, inifile, inicfg = getcfg(dirs, config=config)
                 if rootdir is None:
-                    rootdir = get_common_ancestor([py.path.local(), ancestor])
+                    if config is not None:
+                        cwd = config.invocation_dir
+                    else:
+                        cwd = py.path.local()
+                    rootdir = get_common_ancestor([cwd, ancestor])
                     is_fs_root = os.path.splitdrive(str(rootdir))[1] == "/"
                     if is_fs_root:
                         rootdir = ancestor
     if rootdir_cmd_arg:
-        rootdir_abs_path = py.path.local(os.path.expandvars(rootdir_cmd_arg))
-        if not os.path.isdir(str(rootdir_abs_path)):
+        rootdir = py.path.local(os.path.expandvars(rootdir_cmd_arg))
+        if not rootdir.isdir():
             raise UsageError(
                 "Directory '{}' not found. Check your '--rootdir' option.".format(
-                    rootdir_abs_path
+                    rootdir
                 )
             )
-        rootdir = rootdir_abs_path
     return rootdir, inifile, inicfg or {}

src/_pytest/debugging.py

@@ -3,12 +3,25 @@ from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
 
+import argparse
 import pdb
 import sys
 from doctest import UnexpectedException
 
 from _pytest import outcomes
 from _pytest.config import hookimpl
+from _pytest.config.exceptions import UsageError
+
+
+def _validate_usepdb_cls(value):
+    """Validate syntax of --pdbcls option."""
+    try:
+        modname, classname = value.split(":")
+    except ValueError:
+        raise argparse.ArgumentTypeError(
+            "{!r} is not in the format 'modname:classname'".format(value)
+        )
+    return (modname, classname)
 
 
 def pytest_addoption(parser):
@@ -23,6 +36,7 @@ def pytest_addoption(parser):
         "--pdbcls",
         dest="usepdb_cls",
         metavar="modulename:classname",
+        type=_validate_usepdb_cls,
         help="start a custom interactive Python debugger on errors. "
         "For example: --pdbcls=IPython.terminal.debugger:TerminalPdb",
     )
@@ -34,11 +48,27 @@ def pytest_addoption(parser):
     )
 
 
-def pytest_configure(config):
-    if config.getvalue("usepdb_cls"):
-        modname, classname = config.getvalue("usepdb_cls").split(":")
+def _import_pdbcls(modname, classname):
+    try:
         __import__(modname)
-        pdb_cls = getattr(sys.modules[modname], classname)
+        mod = sys.modules[modname]
+
+        # Handle --pdbcls=pdb:pdb.Pdb (useful e.g. with pdbpp).
+        parts = classname.split(".")
+        pdb_cls = getattr(mod, parts[0])
+        for part in parts[1:]:
+            pdb_cls = getattr(pdb_cls, part)
+
+        return pdb_cls
+    except Exception as exc:
+        value = ":".join((modname, classname))
+        raise UsageError("--pdbcls: could not import {!r}: {}".format(value, exc))
+
+
+def pytest_configure(config):
+    pdb_cls = config.getvalue("usepdb_cls")
+    if pdb_cls:
+        pdb_cls = _import_pdbcls(*pdb_cls)
     else:
         pdb_cls = pdb.Pdb
 
@@ -75,38 +105,74 @@ class pytestPDB(object):
     _config = None
     _pdb_cls = pdb.Pdb
     _saved = []
+    _recursive_debug = 0
 
     @classmethod
-    def set_trace(cls, set_break=True):
-        """ invoke PDB set_trace debugging, dropping any IO capturing. """
+    def _is_capturing(cls, capman):
+        if capman:
+            return capman.is_capturing()
+        return False
+
+    @classmethod
+    def _init_pdb(cls, *args, **kwargs):
+        """ Initialize PDB debugging, dropping any IO capturing. """
         import _pytest.config
 
-        frame = sys._getframe().f_back
         if cls._pluginmanager is not None:
             capman = cls._pluginmanager.getplugin("capturemanager")
             if capman:
-                capman.suspend_global_capture(in_=True)
+                capman.suspend(in_=True)
             tw = _pytest.config.create_terminal_writer(cls._config)
             tw.line()
-            if capman and capman.is_globally_capturing():
-                tw.sep(">", "PDB set_trace (IO-capturing turned off)")
-            else:
-                tw.sep(">", "PDB set_trace")
+            if cls._recursive_debug == 0:
+                # Handle header similar to pdb.set_trace in py37+.
+                header = kwargs.pop("header", None)
+                if header is not None:
+                    tw.sep(">", header)
+                else:
+                    capturing = cls._is_capturing(capman)
+                    if capturing:
+                        if capturing == "global":
+                            tw.sep(">", "PDB set_trace (IO-capturing turned off)")
+                        else:
+                            tw.sep(
+                                ">",
+                                "PDB set_trace (IO-capturing turned off for %s)"
+                                % capturing,
+                            )
+                    else:
+                        tw.sep(">", "PDB set_trace")
 
             class _PdbWrapper(cls._pdb_cls, object):
                 _pytest_capman = capman
                 _continued = False
 
+                def do_debug(self, arg):
+                    cls._recursive_debug += 1
+                    ret = super(_PdbWrapper, self).do_debug(arg)
+                    cls._recursive_debug -= 1
+                    return ret
+
                 def do_continue(self, arg):
                     ret = super(_PdbWrapper, self).do_continue(arg)
-                    if self._pytest_capman:
+                    if cls._recursive_debug == 0:
                         tw = _pytest.config.create_terminal_writer(cls._config)
                         tw.line()
-                        if self._pytest_capman.is_globally_capturing():
-                            tw.sep(">", "PDB continue (IO-capturing resumed)")
+
+                        capman = self._pytest_capman
+                        capturing = pytestPDB._is_capturing(capman)
+                        if capturing:
+                            if capturing == "global":
+                                tw.sep(">", "PDB continue (IO-capturing resumed)")
+                            else:
+                                tw.sep(
+                                    ">",
+                                    "PDB continue (IO-capturing resumed for %s)"
+                                    % capturing,
+                                )
+                            capman.resume()
                         else:
                             tw.sep(">", "PDB continue")
-                        self._pytest_capman.resume_global_capture()
                     cls._pluginmanager.hook.pytest_leave_pdb(
                         config=cls._config, pdb=self
                     )
@@ -115,6 +181,17 @@ class pytestPDB(object):
 
                 do_c = do_cont = do_continue
 
+                def set_quit(self):
+                    """Raise Exit outcome when quit command is used in pdb.
+
+                    This is a bit of a hack - it would be better if BdbQuit
+                    could be handled, but this would require to wrap the
+                    whole pytest run, and adjust the report etc.
+                    """
+                    super(_PdbWrapper, self).set_quit()
+                    if cls._recursive_debug == 0:
+                        outcomes.exit("Quitting debugger")
+
                 def setup(self, f, tb):
                     """Suspend on setup().
 
@@ -129,13 +206,18 @@ class pytestPDB(object):
                             self._pytest_capman.suspend_global_capture(in_=True)
                     return ret
 
-            _pdb = _PdbWrapper()
+            _pdb = _PdbWrapper(**kwargs)
             cls._pluginmanager.hook.pytest_enter_pdb(config=cls._config, pdb=_pdb)
         else:
-            _pdb = cls._pdb_cls()
+            _pdb = cls._pdb_cls(**kwargs)
+        return _pdb
 
-        if set_break:
-            _pdb.set_trace(frame)
+    @classmethod
+    def set_trace(cls, *args, **kwargs):
+        """Invoke debugging via ``Pdb.set_trace``, dropping any IO capturing."""
+        frame = sys._getframe().f_back
+        _pdb = cls._init_pdb(*args, **kwargs)
+        _pdb.set_trace(frame)
 
 
 class PdbInvoke(object):
@@ -161,20 +243,15 @@ class PdbTrace(object):
 
 
 def _test_pytest_function(pyfuncitem):
-    pytestPDB.set_trace(set_break=False)
+    _pdb = pytestPDB._init_pdb()
     testfunction = pyfuncitem.obj
-    pyfuncitem.obj = pdb.runcall
-    if pyfuncitem._isyieldedfunction():
-        arg_list = list(pyfuncitem._args)
-        arg_list.insert(0, testfunction)
-        pyfuncitem._args = tuple(arg_list)
-    else:
-        if "func" in pyfuncitem._fixtureinfo.argnames:
-            raise ValueError("--trace can't be used with a fixture named func!")
-        pyfuncitem.funcargs["func"] = testfunction
-        new_list = list(pyfuncitem._fixtureinfo.argnames)
-        new_list.append("func")
-        pyfuncitem._fixtureinfo.argnames = tuple(new_list)
+    pyfuncitem.obj = _pdb.runcall
+    if "func" in pyfuncitem._fixtureinfo.argnames:  # noqa
+        raise ValueError("--trace can't be used with a fixture named func!")
+    pyfuncitem.funcargs["func"] = testfunction
+    new_list = list(pyfuncitem._fixtureinfo.argnames)
+    new_list.append("func")
+    pyfuncitem._fixtureinfo.argnames = tuple(new_list)
 
 
 def _enter_pdb(node, excinfo, rep):
@@ -202,8 +279,7 @@ def _enter_pdb(node, excinfo, rep):
     tw.sep(">", "entering PDB")
     tb = _postmortem_traceback(excinfo)
     rep._pdbshown = True
-    if post_mortem(tb):
-        outcomes.exit("Quitting debugger")
+    post_mortem(tb)
     return rep
 
 
@@ -224,9 +300,9 @@ def _find_last_non_hidden_frame(stack):
 
 
 def post_mortem(t):
-    class Pdb(pytestPDB._pdb_cls):
+    class Pdb(pytestPDB._pdb_cls, object):
         def get_stack(self, f, t):
-            stack, i = pdb.Pdb.get_stack(self, f, t)
+            stack, i = super(Pdb, self).get_stack(f, t)
             if f is None:
                 i = _find_last_non_hidden_frame(stack)
             return stack, i
@@ -234,4 +310,5 @@ def post_mortem(t):
     p = Pdb()
     p.reset()
     p.interaction(None, t)
-    return p.quitting
+    if p.quitting:
+        outcomes.exit("Quitting debugger")

src/_pytest/deprecated.py

@@ -16,108 +16,80 @@ from _pytest.warning_types import PytestDeprecationWarning
 from _pytest.warning_types import RemovedInPytest4Warning
 from _pytest.warning_types import UnformattedWarning
 
+YIELD_TESTS = "yield tests were removed in pytest 4.0 - {name} will be ignored"
 
-MAIN_STR_ARGS = RemovedInPytest4Warning(
-    "passing a string to pytest.main() is deprecated, "
-    "pass a list of arguments instead."
-)
 
-YIELD_TESTS = RemovedInPytest4Warning(
-    "yield tests are deprecated, and scheduled to be removed in pytest 4.0"
-)
-
-CACHED_SETUP = RemovedInPytest4Warning(
-    "cached_setup is deprecated and will be removed in a future release. "
-    "Use standard fixture functions instead."
-)
-
-COMPAT_PROPERTY = UnformattedWarning(
-    RemovedInPytest4Warning,
-    "usage of {owner}.{name} is deprecated, please use pytest.{name} instead",
-)
-
-CUSTOM_CLASS = UnformattedWarning(
-    RemovedInPytest4Warning,
-    'use of special named "{name}" objects in collectors of type "{type_name}" to '
-    "customize the created nodes is deprecated. "
-    "Use pytest_pycollect_makeitem(...) to create custom "
-    "collection nodes instead.",
-)
-
-FUNCARG_PREFIX = UnformattedWarning(
-    RemovedInPytest4Warning,
-    '{name}: declaring fixtures using "pytest_funcarg__" prefix is deprecated '
-    "and scheduled to be removed in pytest 4.0.  "
-    "Please remove the prefix and use the @pytest.fixture decorator instead.",
-)
-
-FIXTURE_FUNCTION_CALL = UnformattedWarning(
-    RemovedInPytest4Warning,
-    'Fixture "{name}" called directly. Fixtures are not meant to be called directly, '
-    "are created automatically when test functions request them as parameters. "
-    "See https://docs.pytest.org/en/latest/fixture.html for more information.",
+FIXTURE_FUNCTION_CALL = (
+    'Fixture "{name}" called directly. Fixtures are not meant to be called directly,\n'
+    "but are created automatically when test functions request them as parameters.\n"
+    "See https://docs.pytest.org/en/latest/fixture.html for more information about fixtures, and\n"
+    "https://docs.pytest.org/en/latest/deprecations.html#calling-fixtures-directly about how to update your code."
 )
 
 FIXTURE_NAMED_REQUEST = PytestDeprecationWarning(
     "'request' is a reserved name for fixtures and will raise an error in future versions"
 )
 
-CFG_PYTEST_SECTION = UnformattedWarning(
-    RemovedInPytest4Warning,
-    "[pytest] section in {filename} files is deprecated, use [tool:pytest] instead.",
-)
+CFG_PYTEST_SECTION = "[pytest] section in {filename} files is no longer supported, change to [tool:pytest] instead."
 
 GETFUNCARGVALUE = RemovedInPytest4Warning(
     "getfuncargvalue is deprecated, use getfixturevalue"
 )
 
-RESULT_LOG = RemovedInPytest4Warning(
-    "--result-log is deprecated and scheduled for removal in pytest 4.0.\n"
-    "See https://docs.pytest.org/en/latest/usage.html#creating-resultlog-format-files for more information."
+RAISES_MESSAGE_PARAMETER = PytestDeprecationWarning(
+    "The 'message' parameter is deprecated.\n"
+    "(did you mean to use `match='some regex'` to check the exception message?)\n"
+    "Please comment on https://github.com/pytest-dev/pytest/issues/3974 "
+    "if you have concerns about removal of this parameter."
 )
 
-MARK_INFO_ATTRIBUTE = RemovedInPytest4Warning(
-    "MarkInfo objects are deprecated as they contain merged marks which are hard to deal with correctly.\n"
-    "Please use node.get_closest_marker(name) or node.iter_markers(name).\n"
-    "Docs: https://docs.pytest.org/en/latest/mark.html#updating-code"
+RESULT_LOG = PytestDeprecationWarning(
+    "--result-log is deprecated and scheduled for removal in pytest 5.0.\n"
+    "See https://docs.pytest.org/en/latest/deprecations.html#result-log-result-log for more information."
 )
 
-MARK_PARAMETERSET_UNPACKING = RemovedInPytest4Warning(
-    "Applying marks directly to parameters is deprecated,"
-    " please use pytest.param(..., marks=...) instead.\n"
-    "For more details, see: https://docs.pytest.org/en/latest/parametrize.html"
+RAISES_EXEC = PytestDeprecationWarning(
+    "raises(..., 'code(as_a_string)') is deprecated, use the context manager form or use `exec()` directly\n\n"
+    "See https://docs.pytest.org/en/latest/deprecations.html#raises-warns-exec"
+)
+WARNS_EXEC = PytestDeprecationWarning(
+    "warns(..., 'code(as_a_string)') is deprecated, use the context manager form or use `exec()` directly.\n\n"
+    "See https://docs.pytest.org/en/latest/deprecations.html#raises-warns-exec"
 )
 
-NODE_WARN = RemovedInPytest4Warning(
-    "Node.warn(code, message) form has been deprecated, use Node.warn(warning_instance) instead."
-)
-
-RECORD_XML_PROPERTY = RemovedInPytest4Warning(
-    'Fixture renamed from "record_xml_property" to "record_property" as user '
-    "properties are now available to all reporters.\n"
-    '"record_xml_property" is now deprecated.'
-)
-
-COLLECTOR_MAKEITEM = RemovedInPytest4Warning(
-    "pycollector makeitem was removed as it is an accidentially leaked internal api"
-)
-
-METAFUNC_ADD_CALL = RemovedInPytest4Warning(
-    "Metafunc.addcall is deprecated and scheduled to be removed in pytest 4.0.\n"
-    "Please use Metafunc.parametrize instead."
-)
-
-PYTEST_PLUGINS_FROM_NON_TOP_LEVEL_CONFTEST = RemovedInPytest4Warning(
-    "Defining pytest_plugins in a non-top-level conftest is deprecated, "
+PYTEST_PLUGINS_FROM_NON_TOP_LEVEL_CONFTEST = (
+    "Defining 'pytest_plugins' in a non-top-level conftest is no longer supported "
     "because it affects the entire directory tree in a non-explicit way.\n"
-    "Please move it to the top level conftest file instead."
+    "  {}\n"
+    "Please move it to a top level conftest file at the rootdir:\n"
+    "  {}\n"
+    "For more information, visit:\n"
+    "  https://docs.pytest.org/en/latest/deprecations.html#pytest-plugins-in-non-top-level-conftest-files"
 )
 
-PYTEST_NAMESPACE = RemovedInPytest4Warning(
-    "pytest_namespace is deprecated and will be removed soon"
+PYTEST_CONFIG_GLOBAL = PytestDeprecationWarning(
+    "the `pytest.config` global is deprecated.  Please use `request.config` "
+    "or `pytest_configure` (if you're a pytest plugin) instead."
 )
 
 PYTEST_ENSURETEMP = RemovedInPytest4Warning(
     "pytest/tmpdir_factory.ensuretemp is deprecated, \n"
     "please use the tmp_path fixture or tmp_path_factory.mktemp"
 )
+
+PYTEST_LOGWARNING = PytestDeprecationWarning(
+    "pytest_logwarning is deprecated, no longer being called, and will be removed soon\n"
+    "please use pytest_warning_captured instead"
+)
+
+PYTEST_WARNS_UNKNOWN_KWARGS = UnformattedWarning(
+    PytestDeprecationWarning,
+    "pytest.warns() got unexpected keyword arguments: {args!r}.\n"
+    "This will be an error in future versions.",
+)
+
+PYTEST_PARAM_UNKNOWN_KWARGS = UnformattedWarning(
+    PytestDeprecationWarning,
+    "pytest.param() got unexpected keyword arguments: {args!r}.\n"
+    "This will be an error in future versions.",
+)

src/_pytest/doctest.py

@@ -3,16 +3,19 @@ from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
 
+import inspect
 import platform
 import sys
 import traceback
+from contextlib import contextmanager
 
 import pytest
 from _pytest._code.code import ExceptionInfo
 from _pytest._code.code import ReprFileLocation
 from _pytest._code.code import TerminalRepr
+from _pytest.compat import safe_getattr
 from _pytest.fixtures import FixtureRequest
-
+from _pytest.outcomes import Skipped
 
 DOCTEST_REPORT_CHOICE_NONE = "none"
 DOCTEST_REPORT_CHOICE_CDIFF = "cdiff"
@@ -151,6 +154,8 @@ def _init_runner_class():
                 raise failure
 
         def report_unexpected_exception(self, out, test, example, exc_info):
+            if isinstance(exc_info[1], Skipped):
+                raise exc_info[1]
             failure = doctest.UnexpectedException(test, example, exc_info)
             if self.continue_on_failure:
                 out.append(failure)
@@ -346,10 +351,61 @@ def _check_all_skipped(test):
         pytest.skip("all tests skipped by +SKIP option")
 
 
+def _is_mocked(obj):
+    """
+    returns if a object is possibly a mock object by checking the existence of a highly improbable attribute
+    """
+    return (
+        safe_getattr(obj, "pytest_mock_example_attribute_that_shouldnt_exist", None)
+        is not None
+    )
+
+
+@contextmanager
+def _patch_unwrap_mock_aware():
+    """
+    contextmanager which replaces ``inspect.unwrap`` with a version
+    that's aware of mock objects and doesn't recurse on them
+    """
+    real_unwrap = getattr(inspect, "unwrap", None)
+    if real_unwrap is None:
+        yield
+    else:
+
+        def _mock_aware_unwrap(obj, stop=None):
+            if stop is None:
+                return real_unwrap(obj, stop=_is_mocked)
+            else:
+                return real_unwrap(obj, stop=lambda obj: _is_mocked(obj) or stop(obj))
+
+        inspect.unwrap = _mock_aware_unwrap
+        try:
+            yield
+        finally:
+            inspect.unwrap = real_unwrap
+
+
 class DoctestModule(pytest.Module):
     def collect(self):
         import doctest
 
+        class MockAwareDocTestFinder(doctest.DocTestFinder):
+            """
+            a hackish doctest finder that overrides stdlib internals to fix a stdlib bug
+
+            https://github.com/pytest-dev/pytest/issues/3456
+            https://bugs.python.org/issue25532
+            """
+
+            def _find(self, tests, obj, name, module, source_lines, globs, seen):
+                if _is_mocked(obj):
+                    return
+                with _patch_unwrap_mock_aware():
+
+                    doctest.DocTestFinder._find(
+                        self, tests, obj, name, module, source_lines, globs, seen
+                    )
+
         if self.fspath.basename == "conftest.py":
             module = self.config.pluginmanager._importconftest(self.fspath)
         else:
@@ -361,7 +417,7 @@ class DoctestModule(pytest.Module):
                 else:
                     raise
         # uses internal doctest module parsing mechanism
-        finder = doctest.DocTestFinder()
+        finder = MockAwareDocTestFinder()
         optionflags = get_optionflags(self)
         runner = _get_runner(
             verbose=0,

src/_pytest/fixtures.py

@@ -4,6 +4,7 @@ from __future__ import print_function
 
 import functools
 import inspect
+import itertools
 import sys
 import warnings
 from collections import defaultdict
@@ -13,11 +14,10 @@ from collections import OrderedDict
 import attr
 import py
 import six
-from more_itertools import flatten
-from py._code.code import FormattedExcinfo
 
 import _pytest
 from _pytest import nodes
+from _pytest._code.code import FormattedExcinfo
 from _pytest._code.code import TerminalRepr
 from _pytest.compat import _format_args
 from _pytest.compat import _PytestWrapper
@@ -38,8 +38,6 @@ from _pytest.deprecated import FIXTURE_NAMED_REQUEST
 from _pytest.outcomes import fail
 from _pytest.outcomes import TEST_OUTCOME
 
-FIXTURE_MSG = 'fixtures cannot have "pytest_funcarg__" prefix and be decorated with @pytest.fixture:\n{}'
-
 
 @attr.s(frozen=True)
 class PseudoFixtureDef(object):
@@ -309,8 +307,8 @@ class FuncFixtureInfo(object):
     # fixture names specified via usefixtures and via autouse=True in fixture
     # definitions.
     initialnames = attr.ib(type=tuple)
-    names_closure = attr.ib()  # type: List[str]
-    name2fixturedefs = attr.ib()  # type: List[str, List[FixtureDef]]
+    names_closure = attr.ib()  # List[str]
+    name2fixturedefs = attr.ib()  # List[str, List[FixtureDef]]
 
     def prune_dependency_tree(self):
         """Recompute names_closure from initialnames and name2fixturedefs
@@ -469,43 +467,6 @@ class FixtureRequest(FuncargnamesCompatAttr):
             if argname not in item.funcargs:
                 item.funcargs[argname] = self.getfixturevalue(argname)
 
-    def cached_setup(self, setup, teardown=None, scope="module", extrakey=None):
-        """ (deprecated) Return a testing resource managed by ``setup`` &
-        ``teardown`` calls.  ``scope`` and ``extrakey`` determine when the
-        ``teardown`` function will be called so that subsequent calls to
-        ``setup`` would recreate the resource.  With pytest-2.3 you often
-        do not need ``cached_setup()`` as you can directly declare a scope
-        on a fixture function and register a finalizer through
-        ``request.addfinalizer()``.
-
-        :arg teardown: function receiving a previously setup resource.
-        :arg setup: a no-argument function creating a resource.
-        :arg scope: a string value out of ``function``, ``class``, ``module``
-            or ``session`` indicating the caching lifecycle of the resource.
-        :arg extrakey: added to internal caching key of (funcargname, scope).
-        """
-        from _pytest.deprecated import CACHED_SETUP
-
-        warnings.warn(CACHED_SETUP, stacklevel=2)
-        if not hasattr(self.config, "_setupcache"):
-            self.config._setupcache = {}  # XXX weakref?
-        cachekey = (self.fixturename, self._getscopeitem(scope), extrakey)
-        cache = self.config._setupcache
-        try:
-            val = cache[cachekey]
-        except KeyError:
-            self._check_scope(self.fixturename, self.scope, scope)
-            val = setup()
-            cache[cachekey] = val
-            if teardown is not None:
-
-                def finalizer():
-                    del cache[cachekey]
-                    teardown(val)
-
-                self._addfinalizer(finalizer, scope=scope)
-        return val
-
     def getfixturevalue(self, argname):
         """ Dynamically run a named fixture function.
 
@@ -605,8 +566,7 @@ class FixtureRequest(FuncargnamesCompatAttr):
                 )
                 fail(msg, pytrace=False)
         else:
-            # indices might not be set if old-style metafunc.addcall() was used
-            param_index = funcitem.callspec.indices.get(argname, 0)
+            param_index = funcitem.callspec.indices[argname]
             # if a parametrize invocation set a scope it will override
             # the static scope defined with the fixture function
             paramscopenum = funcitem.callspec._arg2scopenum.get(argname)
@@ -625,11 +585,13 @@ class FixtureRequest(FuncargnamesCompatAttr):
             # call the fixture function
             fixturedef.execute(request=subrequest)
         finally:
-            # if fixture function failed it might have registered finalizers
-            self.session._setupstate.addfinalizer(
-                functools.partial(fixturedef.finish, request=subrequest),
-                subrequest.node,
-            )
+            self._schedule_finalizers(fixturedef, subrequest)
+
+    def _schedule_finalizers(self, fixturedef, subrequest):
+        # if fixture function failed it might have registered finalizers
+        self.session._setupstate.addfinalizer(
+            functools.partial(fixturedef.finish, request=subrequest), subrequest.node
+        )
 
     def _check_scope(self, argname, invoking_scope, requested_scope):
         if argname == "request":
@@ -652,7 +614,7 @@ class FixtureRequest(FuncargnamesCompatAttr):
             fs, lineno = getfslineno(factory)
             p = self._pyfuncitem.session.fspath.bestrelpath(fs)
             args = _format_args(factory)
-            lines.append("%s:%d:  def %s%s" % (p, lineno, factory.__name__, args))
+            lines.append("%s:%d:  def %s%s" % (p, lineno + 1, factory.__name__, args))
         return lines
 
     def _getscopeitem(self, scope):
@@ -699,11 +661,15 @@ class SubRequest(FixtureRequest):
     def addfinalizer(self, finalizer):
         self._fixturedef.addfinalizer(finalizer)
 
-
-class ScopeMismatchError(Exception):
-    """ A fixture function tries to use a different fixture function which
-    which has a lower scope (e.g. a Session one calls a function one)
-    """
+    def _schedule_finalizers(self, fixturedef, subrequest):
+        # if the executing fixturedef was not explicitly requested in the argument list (via
+        # getfixturevalue inside the fixture call) then ensure this fixture def will be finished
+        # first
+        if fixturedef.argname not in self.funcargnames:
+            fixturedef.addfinalizer(
+                functools.partial(self._fixturedef.finish, request=self)
+            )
+        super(SubRequest, self)._schedule_finalizers(fixturedef, subrequest)
 
 
 scopes = "session package module class function".split()
@@ -887,7 +853,9 @@ class FixtureDef(object):
                     exceptions.append(sys.exc_info())
             if exceptions:
                 e = exceptions[0]
-                del exceptions  # ensure we don't keep all frames alive because of the traceback
+                del (
+                    exceptions
+                )  # ensure we don't keep all frames alive because of the traceback
                 six.reraise(*e)
 
         finally:
@@ -982,34 +950,17 @@ def _ensure_immutable_ids(ids):
     return tuple(ids)
 
 
-def wrap_function_to_warning_if_called_directly(function, fixture_marker):
-    """Wrap the given fixture function so we can issue warnings about it being called directly, instead of
-    used as an argument in a test function.
+def wrap_function_to_error_out_if_called_directly(function, fixture_marker):
+    """Wrap the given fixture function so we can raise an error about it being called directly,
+    instead of used as an argument in a test function.
     """
-    is_yield_function = is_generator(function)
-    warning = FIXTURE_FUNCTION_CALL.format(
+    message = FIXTURE_FUNCTION_CALL.format(
         name=fixture_marker.name or function.__name__
     )
 
-    if is_yield_function:
-
-        @functools.wraps(function)
-        def result(*args, **kwargs):
-            __tracebackhide__ = True
-            warnings.warn(warning, stacklevel=3)
-            for x in function(*args, **kwargs):
-                yield x
-
-    else:
-
-        @functools.wraps(function)
-        def result(*args, **kwargs):
-            __tracebackhide__ = True
-            warnings.warn(warning, stacklevel=3)
-            return function(*args, **kwargs)
-
-    if six.PY2:
-        result.__wrapped__ = function
+    @six.wraps(function)
+    def result(*args, **kwargs):
+        fail(message, pytrace=False)
 
     # keep reference to the original function in our own custom attribute so we don't unwrap
     # further than this point and lose useful wrappings like @mock.patch (#3774)
@@ -1035,7 +986,7 @@ class FixtureFunctionMarker(object):
                 "fixture is being applied more than once to the same function"
             )
 
-        function = wrap_function_to_warning_if_called_directly(function, self)
+        function = wrap_function_to_error_out_if_called_directly(function, self)
 
         name = self.name or function.__name__
         if name == "request":
@@ -1116,7 +1067,7 @@ def pytestconfig(request):
     Example::
 
         def test_foo(pytestconfig):
-            if pytestconfig.getoption("verbose"):
+            if pytestconfig.getoption("verbose") > 0:
                 ...
 
     """
@@ -1155,7 +1106,6 @@ class FixtureManager(object):
     by a lookup of their FuncFixtureInfo.
     """
 
-    _argprefix = "pytest_funcarg__"
     FixtureLookupError = FixtureLookupError
     FixtureLookupErrorRepr = FixtureLookupErrorRepr
 
@@ -1173,7 +1123,7 @@ class FixtureManager(object):
             argnames = getfuncargnames(func, cls=cls)
         else:
             argnames = ()
-        usefixtures = flatten(
+        usefixtures = itertools.chain.from_iterable(
             mark.args for mark in node.iter_markers(name="usefixtures")
         )
         initialnames = tuple(usefixtures) + argnames
@@ -1265,19 +1215,20 @@ class FixtureManager(object):
             if faclist:
                 fixturedef = faclist[-1]
                 if fixturedef.params is not None:
-                    parametrize_func = getattr(metafunc.function, "parametrize", None)
-                    if parametrize_func is not None:
-                        parametrize_func = parametrize_func.combined
-                    func_params = getattr(parametrize_func, "args", [[None]])
-                    func_kwargs = getattr(parametrize_func, "kwargs", {})
-                    # skip directly parametrized arguments
-                    if "argnames" in func_kwargs:
-                        argnames = parametrize_func.kwargs["argnames"]
+                    markers = list(metafunc.definition.iter_markers("parametrize"))
+                    for parametrize_mark in markers:
+                        if "argnames" in parametrize_mark.kwargs:
+                            argnames = parametrize_mark.kwargs["argnames"]
+                        else:
+                            argnames = parametrize_mark.args[0]
+
+                        if not isinstance(argnames, (tuple, list)):
+                            argnames = [
+                                x.strip() for x in argnames.split(",") if x.strip()
+                            ]
+                        if argname in argnames:
+                            break
                     else:
-                        argnames = func_params[0]
-                    if not isinstance(argnames, (tuple, list)):
-                        argnames = [x.strip() for x in argnames.split(",") if x.strip()]
-                    if argname not in func_params and argname not in argnames:
                         metafunc.parametrize(
                             argname,
                             fixturedef.params,
@@ -1293,8 +1244,6 @@ class FixtureManager(object):
         items[:] = reorder_items(items)
 
     def parsefactories(self, node_or_obj, nodeid=NOTSET, unittest=False):
-        from _pytest import deprecated
-
         if nodeid is not NOTSET:
             holderobj = node_or_obj
         else:
@@ -1303,44 +1252,20 @@ class FixtureManager(object):
         if holderobj in self._holderobjseen:
             return
 
-        from _pytest.nodes import _CompatProperty
-
         self._holderobjseen.add(holderobj)
         autousenames = []
         for name in dir(holderobj):
             # The attribute can be an arbitrary descriptor, so the attribute
             # access below can raise. safe_getatt() ignores such exceptions.
-            maybe_property = safe_getattr(type(holderobj), name, None)
-            if isinstance(maybe_property, _CompatProperty):
-                # deprecated
-                continue
             obj = safe_getattr(holderobj, name, None)
             marker = getfixturemarker(obj)
-            # fixture functions have a pytest_funcarg__ prefix (pre-2.3 style)
-            # or are "@pytest.fixture" marked
-            if marker is None:
-                if not name.startswith(self._argprefix):
-                    continue
-                if not callable(obj):
-                    continue
-                marker = defaultfuncargprefixmarker
-
-                filename, lineno = getfslineno(obj)
-                warnings.warn_explicit(
-                    deprecated.FUNCARG_PREFIX.format(name=name),
-                    category=None,
-                    filename=str(filename),
-                    lineno=lineno + 1,
-                )
-                name = name[len(self._argprefix) :]
-            elif not isinstance(marker, FixtureFunctionMarker):
+            if not isinstance(marker, FixtureFunctionMarker):
                 # magic globals  with __getattr__ might have got us a wrong
                 # fixture attribute
                 continue
-            else:
-                if marker.name:
-                    name = marker.name
-                assert not name.startswith(self._argprefix), FIXTURE_MSG.format(name)
+
+            if marker.name:
+                name = marker.name
 
             # during fixture definition we wrap the original fixture function
             # to issue a warning if called directly, so here we unwrap it in order to not emit the warning

src/_pytest/helpconfig.py

@@ -60,7 +60,7 @@ def pytest_addoption(parser):
         dest="plugins",
         default=[],
         metavar="name",
-        help="early-load given plugin (multi-allowed). "
+        help="early-load given plugin module name or entry point (multi-allowed). "
         "To avoid loading of plugins, use the `no:` prefix, e.g. "
         "`no:doctest`.",
     )
@@ -118,16 +118,20 @@ def pytest_cmdline_parse():
         config.add_cleanup(unset_tracing)
 
 
+def showversion(config):
+    p = py.path.local(pytest.__file__)
+    sys.stderr.write(
+        "This is pytest version %s, imported from %s\n" % (pytest.__version__, p)
+    )
+    plugininfo = getpluginversioninfo(config)
+    if plugininfo:
+        for line in plugininfo:
+            sys.stderr.write(line + "\n")
+
+
 def pytest_cmdline_main(config):
     if config.option.version:
-        p = py.path.local(pytest.__file__)
-        sys.stderr.write(
-            "This is pytest version %s, imported from %s\n" % (pytest.__version__, p)
-        )
-        plugininfo = getpluginversioninfo(config)
-        if plugininfo:
-            for line in plugininfo:
-                sys.stderr.write(line + "\n")
+        showversion(config)
         return 0
     elif config.option.help:
         config._do_configure()

src/_pytest/hookspec.py

@@ -1,8 +1,7 @@
 """ hook specifications for pytest plugins, invoked from main.py and builtin plugins.  """
 from pluggy import HookspecMarker
 
-from .deprecated import PYTEST_NAMESPACE
-
+from _pytest.deprecated import PYTEST_LOGWARNING
 
 hookspec = HookspecMarker("pytest")
 
@@ -24,32 +23,6 @@ def pytest_addhooks(pluginmanager):
     """
 
 
-@hookspec(historic=True, warn_on_impl=PYTEST_NAMESPACE)
-def pytest_namespace():
-    """
-    return dict of name->object to be made globally available in
-    the pytest namespace.
-
-    This hook is called at plugin registration time.
-
-    .. note::
-        This hook is incompatible with ``hookwrapper=True``.
-
-    .. warning::
-        This hook has been **deprecated** and will be removed in pytest 4.0.
-
-        Plugins whose users depend on the current namespace functionality should prepare to migrate to a
-        namespace they actually own.
-
-        To support the migration it's suggested to trigger ``DeprecationWarnings`` for objects they put into the
-        pytest namespace.
-
-        A stopgap measure to avoid the warning is to monkeypatch the ``pytest`` module, but just as the
-        ``pytest_namespace`` hook this should be seen as a temporary measure to be removed in future versions after
-        an appropriate transition period.
-    """
-
-
 @hookspec(historic=True)
 def pytest_plugin_registered(plugin, manager):
     """ a new pytest plugin got registered.
@@ -126,7 +99,8 @@ def pytest_cmdline_parse(pluginmanager, args):
     Stops at first non-None result, see :ref:`firstresult`
 
     .. note::
-        This hook will not be called for ``conftest.py`` files, only for setuptools plugins.
+        This hook will only be called for plugin classes passed to the ``plugins`` arg when using `pytest.main`_ to
+        perform an in-process test run.
 
     :param _pytest.config.PytestPluginManager pluginmanager: pytest plugin manager
     :param list[str] args: list of arguments passed on the command line
@@ -214,7 +188,7 @@ def pytest_ignore_collect(path, config):
 
     Stops at first non-None result, see :ref:`firstresult`
 
-    :param str path: the path to analyze
+    :param path: a :py:class:`py.path.local` - the path to analyze
     :param _pytest.config.Config config: pytest config object
     """
 
@@ -225,7 +199,7 @@ def pytest_collect_directory(path, parent):
 
     Stops at first non-None result, see :ref:`firstresult`
 
-    :param str path: the path to analyze
+    :param path: a :py:class:`py.path.local` - the path to analyze
     """
 
 
@@ -233,7 +207,7 @@ def pytest_collect_file(path, parent):
     """ return collection Node or None for the given path. Any new node
     needs to have the specified ``parent`` as a parent.
 
-    :param str path: the path to collect
+    :param path: a :py:class:`py.path.local` - the path to collect
     """
 
 
@@ -275,7 +249,10 @@ def pytest_pycollect_makemodule(path, parent):
     The pytest_collect_file hook needs to be used if you want to
     create test modules for files that do not match as a test module.
 
-    Stops at first non-None result, see :ref:`firstresult` """
+    Stops at first non-None result, see :ref:`firstresult`
+
+    :param path: a :py:class:`py.path.local` - the path of module to collect
+    """
 
 
 @hookspec(firstresult=True)
@@ -402,6 +379,41 @@ def pytest_runtest_logreport(report):
     the respective phase of executing a test. """
 
 
+@hookspec(firstresult=True)
+def pytest_report_to_serializable(config, report):
+    """
+    .. warning::
+        This hook is experimental and subject to change between pytest releases, even
+        bug fixes.
+
+        The intent is for this to be used by plugins maintained by the core-devs, such
+        as ``pytest-xdist``, ``pytest-subtests``, and as a replacement for the internal
+        'resultlog' plugin.
+
+        In the future it might become part of the public hook API.
+
+    Serializes the given report object into a data structure suitable for sending
+    over the wire, e.g. converted to JSON.
+    """
+
+
+@hookspec(firstresult=True)
+def pytest_report_from_serializable(config, data):
+    """
+    .. warning::
+        This hook is experimental and subject to change between pytest releases, even
+        bug fixes.
+
+        The intent is for this to be used by plugins maintained by the core-devs, such
+        as ``pytest-xdist``, ``pytest-subtests``, and as a replacement for the internal
+        'resultlog' plugin.
+
+        In the future it might become part of the public hook API.
+
+    Restores a report object previously serialized with pytest_report_to_serializable().
+    """
+
+
 # -------------------------------------------------------------------------
 # Fixture related hooks
 # -------------------------------------------------------------------------
@@ -507,24 +519,27 @@ def pytest_report_collectionfinish(config, startdir, items):
 
 
 @hookspec(firstresult=True)
-def pytest_report_teststatus(report):
+def pytest_report_teststatus(report, config):
     """ return result-category, shortletter and verbose word for reporting.
 
+    :param _pytest.config.Config config: pytest config object
+
     Stops at first non-None result, see :ref:`firstresult` """
 
 
-def pytest_terminal_summary(terminalreporter, exitstatus):
+def pytest_terminal_summary(terminalreporter, exitstatus, config):
     """Add a section to terminal summary reporting.
 
     :param _pytest.terminal.TerminalReporter terminalreporter: the internal terminal reporter object
     :param int exitstatus: the exit status that will be reported back to the OS
+    :param _pytest.config.Config config: pytest config object
 
-    .. versionadded:: 3.5
+    .. versionadded:: 4.2
         The ``config`` parameter.
     """
 
 
-@hookspec(historic=True)
+@hookspec(historic=True, warn_on_impl=PYTEST_LOGWARNING)
 def pytest_logwarning(message, code, nodeid, fslocation):
     """
     .. deprecated:: 3.8