Merge pytest-dev/pytest@master (#165)

Author: blueyed

.coveragerc

@@ -24,3 +24,5 @@ exclude_lines =
     \#\s*pragma: no cover
     ^\s*raise NotImplementedError\b
     ^\s*return NotImplemented\b
+
+    ^\s*if TYPE_CHECKING:

.github/workflows/main.yml

@@ -10,6 +10,9 @@ on:
   push:
     branches:
       - master
+    tags:
+      - "*"
+
   pull_request:
     branches:
       - master
@@ -154,3 +157,35 @@ jobs:
         flags: ${{ runner.os }}
         fail_ci_if_error: false
         name: ${{ matrix.name }}
+
+  deploy:
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') && github.repository == 'pytest-dev/pytest'
+
+    runs-on: ubuntu-latest
+
+    needs: [build]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: "3.7"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install --upgrade wheel setuptools tox
+    - name: Build package
+      run: |
+        python setup.py sdist bdist_wheel
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        user: __token__
+        password: ${{ secrets.pypi_token }}
+    - name: Publish GitHub release notes
+      env:
+        GH_RELEASE_NOTES_TOKEN: ${{ secrets.release_notes }}
+      run: |
+        sudo apt-get install pandoc
+        tox -e publish-gh-release-notes

AUTHORS

@@ -54,6 +54,7 @@ Ceridwen
 Charles Cloud
 Charnjit SiNGH (CCSJ)
 Chris Lamb
+Chris NeJame
 Christian Boelsen
 Christian Fetzer
 Christian Neumüller

changelog/2780.bugfix.rst

@@ -0,0 +1 @@
+Captured output during teardown is shown with ``-rP``.

changelog/6436.bugfix.rst

@@ -0,0 +1,3 @@
+:class:`FixtureDef <_pytest.fixtures.FixtureDef>` objects now properly register their finalizers with autouse and
+parameterized fixtures that execute before them in the fixture stack so they are torn
+down at the right times, and in the right order.

doc/en/conf.py

@@ -19,8 +19,9 @@
 import sys
 
 from _pytest import __version__ as version
+from _pytest.compat import TYPE_CHECKING
 
-if False:  # TYPE_CHECKING
+if TYPE_CHECKING:
     import sphinx.application
 
 

doc/en/customize.rst

@@ -20,8 +20,6 @@ which were registered by installed plugins.
 Initialization: determining rootdir and inifile
 -----------------------------------------------
 
-
-
 pytest determines a ``rootdir`` for each test run which depends on
 the command line arguments (specified test files, paths) and on
 the existence of *ini-files*.  The determined ``rootdir`` and *ini-file* are
@@ -30,17 +28,17 @@ printed as part of the pytest header during startup.
 Here's a summary what ``pytest`` uses ``rootdir`` for:
 
 * Construct *nodeids* during collection; each test is assigned
-  a unique *nodeid* which is rooted at the ``rootdir`` and takes in account full path,
-  class name, function name and parametrization (if any).
+  a unique *nodeid* which is rooted at the ``rootdir`` and takes into account
+  the full path, class name, function name and parametrization (if any).
 
 * Is used by plugins as a stable location to store project/test run specific information;
   for example, the internal :ref:`cache <cache>` plugin creates a ``.pytest_cache`` subdirectory
   in ``rootdir`` to store its cross-test run state.
 
-Important to emphasize that ``rootdir`` is **NOT** used to modify ``sys.path``/``PYTHONPATH`` or
+``rootdir`` is **NOT** used to modify ``sys.path``/``PYTHONPATH`` or
 influence how modules are imported. See :ref:`pythonpath` for more details.
 
-``--rootdir=path`` command-line option can be used to force a specific directory.
+The ``--rootdir=path`` command-line option can be used to force a specific directory.
 The directory passed may contain environment variables when it is used in conjunction
 with ``addopts`` in a ``pytest.ini`` file.
 

scripts/publish-gh-release-notes.py

@@ -68,19 +68,21 @@ def main(argv):
     if len(argv) > 1:
         tag_name = argv[1]
     else:
-        tag_name = os.environ.get("TRAVIS_TAG")
+        tag_name = os.environ.get("GITHUB_REF")
         if not tag_name:
-            print("tag_name not given and $TRAVIS_TAG not set", file=sys.stderr)
+            print("tag_name not given and $GITHUB_REF not set", file=sys.stderr)
             return 1
+        if tag_name.startswith("refs/tags/"):
+            tag_name = tag_name[len("refs/tags/") :]
 
     token = os.environ.get("GH_RELEASE_NOTES_TOKEN")
     if not token:
         print("GH_RELEASE_NOTES_TOKEN not set", file=sys.stderr)
         return 1
 
-    slug = os.environ.get("TRAVIS_REPO_SLUG")
+    slug = os.environ.get("GITHUB_REPOSITORY")
     if not slug:
-        print("TRAVIS_REPO_SLUG not set", file=sys.stderr)
+        print("GITHUB_REPOSITORY not set", file=sys.stderr)
         return 1
 
     rst_body = parse_changelog(tag_name)

src/_pytest/_code/code.py

@@ -32,9 +32,10 @@
 from _pytest._io.saferepr import safeformat
 from _pytest._io.saferepr import saferepr
 from _pytest.compat import overload
+from _pytest.compat import TYPE_CHECKING
 from _pytest.outcomes import OutcomeException
 
-if False:  # TYPE_CHECKING
+if TYPE_CHECKING:
     from typing import Type
     from typing_extensions import Literal
     from weakref import ReferenceType  # noqa: F401

src/_pytest/compat.py

@@ -27,7 +27,13 @@
 from _pytest.outcomes import fail
 from _pytest.outcomes import TEST_OUTCOME
 
-if False:  # TYPE_CHECKING
+if sys.version_info < (3, 5, 2):
+    TYPE_CHECKING = False  # type: bool
+else:
+    from typing import TYPE_CHECKING
+
+
+if TYPE_CHECKING:
     from typing import Type  # noqa: F401 (used in type string)
 
 

src/_pytest/config/__init__.py

@@ -37,12 +37,13 @@
 from _pytest._code import ExceptionInfo
 from _pytest._code import filter_traceback
 from _pytest.compat import importlib_metadata
+from _pytest.compat import TYPE_CHECKING
 from _pytest.outcomes import fail
 from _pytest.outcomes import Skipped
 from _pytest.pathlib import Path
 from _pytest.warning_types import PytestConfigWarning
 
-if False:  # TYPE_CHECKING
+if TYPE_CHECKING:
     from typing import Type
 
     from .argparsing import Argument

src/_pytest/config/findpaths.py

@@ -5,9 +5,10 @@
 import py
 
 from .exceptions import UsageError
+from _pytest.compat import TYPE_CHECKING
 from _pytest.outcomes import fail
 
-if False:
+if TYPE_CHECKING:
     from . import Config  # noqa: F401
 
 

src/_pytest/doctest.py

@@ -18,12 +18,13 @@
 from _pytest._code.code import ReprFileLocation
 from _pytest._code.code import TerminalRepr
 from _pytest.compat import safe_getattr
+from _pytest.compat import TYPE_CHECKING
 from _pytest.fixtures import FixtureRequest
 from _pytest.outcomes import Skipped
 from _pytest.python_api import approx
 from _pytest.warning_types import PytestWarning
 
-if False:  # TYPE_CHECKING
+if TYPE_CHECKING:
     import doctest
     from typing import Type
 

src/_pytest/fixtures.py

@@ -27,12 +27,13 @@
 from _pytest.compat import is_generator
 from _pytest.compat import NOTSET
 from _pytest.compat import safe_getattr
+from _pytest.compat import TYPE_CHECKING
 from _pytest.deprecated import FIXTURE_POSITIONAL_ARGUMENTS
 from _pytest.deprecated import FUNCARGNAMES
 from _pytest.outcomes import fail
 from _pytest.outcomes import TEST_OUTCOME
 
-if False:  # TYPE_CHECKING
+if TYPE_CHECKING:
     from typing import Type
 
     from _pytest import nodes
@@ -880,9 +881,7 @@ def finish(self, request):
             self._finalizers = []
 
     def execute(self, request):
-        # get required arguments and register our own finish()
-        # with their finalization
-        for argname in self.argnames:
+        for argname in self._dependee_fixture_argnames(request):
             fixturedef = request._get_active_fixturedef(argname)
             if argname != "request":
                 fixturedef.addfinalizer(functools.partial(self.finish, request=request))
@@ -905,6 +904,61 @@ def execute(self, request):
         hook = self._fixturemanager.session.gethookproxy(request.node.fspath)
         return hook.pytest_fixture_setup(fixturedef=self, request=request)
 
+    def _dependee_fixture_argnames(self, request):
+        """A list of argnames for fixtures that this fixture depends on.
+
+        Given a request, this looks at the currently known list of fixture argnames, and
+        attempts to determine what slice of the list contains fixtures that it can know
+        should execute before it. This information is necessary so that this fixture can
+        know what fixtures to register its finalizer with to make sure that if they
+        would be torn down, they would tear down this fixture before themselves. It's
+        crucial for fixtures to be torn down in the inverse order that they were set up
+        in so that they don't try to clean up something that another fixture is still
+        depending on.
+
+        When autouse fixtures are involved, it can be tricky to figure out when fixtures
+        should be torn down. To solve this, this method leverages the ``fixturenames``
+        list provided by the ``request`` object, as this list is at least somewhat
+        sorted (in terms of the order fixtures are set up in) by the time this method is
+        reached. It's sorted enough that the starting point of fixtures that depend on
+        this one can be found using the ``self._parent_request`` stack.
+
+        If a request in the ``self._parent_request`` stack has a ``:class:FixtureDef``
+        associated with it, then that fixture is dependent on this one, so any fixture
+        names that appear in the list of fixture argnames that come after it can also be
+        ruled out. The argnames of all fixtures associated with a request in the
+        ``self._parent_request`` stack are found, and the lowest index argname is
+        considered the earliest point in the list of fixture argnames where everything
+        from that point onward can be considered to execute after this fixture.
+        Everything before this point can be considered fixtures that this fixture
+        depends on, and so this fixture should register its finalizer with all of them
+        to ensure that if any of them are to be torn down, they will tear this fixture
+        down first.
+
+        This is the first part of the list of fixture argnames that is returned. The last
+        part of the list is everything in ``self.argnames`` as those are explicit
+        dependees of this fixture, so this fixture should definitely register its
+        finalizer with them.
+        """
+        all_fix_names = request.fixturenames
+        try:
+            current_fix_index = all_fix_names.index(self.argname)
+        except ValueError:
+            current_fix_index = len(request.fixturenames)
+        parent_fixture_indexes = set()
+
+        parent_request = request._parent_request
+        while hasattr(parent_request, "_parent_request"):
+            if hasattr(parent_request, "_fixturedef"):
+                parent_fix_name = parent_request._fixturedef.argname
+                if parent_fix_name in all_fix_names:
+                    parent_fixture_indexes.add(all_fix_names.index(parent_fix_name))
+            parent_request = parent_request._parent_request
+
+        stack_slice_index = min([current_fix_index, *parent_fixture_indexes])
+        active_fixture_argnames = all_fix_names[:stack_slice_index]
+        return {*active_fixture_argnames, *self.argnames}
+
     def cache_key(self, request):
         return request.param_index if not hasattr(request, "param") else request.param
 

src/_pytest/nodes.py

@@ -17,6 +17,7 @@
 from _pytest._code.code import ReprExceptionInfo
 from _pytest.compat import cached_property
 from _pytest.compat import getfslineno
+from _pytest.compat import TYPE_CHECKING
 from _pytest.config import Config
 from _pytest.deprecated import NODE_USE_FROM_PARENT
 from _pytest.fixtures import FixtureDef
@@ -27,7 +28,7 @@
 from _pytest.mark.structures import NodeKeywords
 from _pytest.outcomes import Failed
 
-if False:  # TYPE_CHECKING
+if TYPE_CHECKING:
     # Imported here due to circular import.
     from _pytest.main import Session  # noqa: F401
 

src/_pytest/outcomes.py

@@ -8,7 +8,9 @@
 
 from packaging.version import Version
 
-if False:  # TYPE_CHECKING
+TYPE_CHECKING = False  # avoid circular import through compat
+
+if TYPE_CHECKING:
     from typing import NoReturn
 
 

src/_pytest/pytester.py

@@ -30,16 +30,19 @@
 from _pytest._io.saferepr import saferepr
 from _pytest.capture import MultiCapture
 from _pytest.capture import SysCapture
+from _pytest.compat import TYPE_CHECKING
 from _pytest.fixtures import FixtureRequest
 from _pytest.main import ExitCode
 from _pytest.main import Session
 from _pytest.monkeypatch import MonkeyPatch
 from _pytest.pathlib import Path
 from _pytest.reports import TestReport
 
-if False:  # TYPE_CHECKING
+if TYPE_CHECKING:
     from typing import Type
 
+    import pexpect
+
 
 IGNORE_PAM = [  # filenames added when obtaining details about the current user
     "/var/lib/sss/mc/passwd"
@@ -193,7 +196,7 @@ def __repr__(self):
             self._name, ", ".join(("{}={!r}".format(k, v)) for k, v in d.items())
         )
 
-    if False:  # TYPE_CHECKING
+    if TYPE_CHECKING:
         # The class has undetermined attributes, this tells mypy about it.
         def __getattr__(self, key):
             raise NotImplementedError()
@@ -1281,7 +1284,7 @@ def runpytest_subprocess(self, *args, timeout=None) -> RunResult:
         args = self._getpytestargs() + args
         return self.run(*args, timeout=timeout)
 
-    def spawn_pytest(self, *args, **kwargs):
+    def spawn_pytest(self, *args: str, **kwargs) -> "pexpect.spawn":
         """Run pytest using pexpect.
 
         This makes sure to use the right pytest and sets up the temporary
@@ -1304,7 +1307,7 @@ def spawn_pytest(self, *args, **kwargs):
         args = self._getpytestargs() + ("--basetemp={}".format(basetemp),) + args
         return self.spawn(args[0], *args[1:], **kwargs)
 
-    def spawn(self, *args: str, **kwargs):
+    def spawn(self, *args: str, **kwargs) -> "pexpect.spawn":
         """Run a command using pexpect.
 
         The pexpect child is returned.

src/_pytest/python_api.py

@@ -23,9 +23,10 @@
 import _pytest._code
 from _pytest.compat import overload
 from _pytest.compat import STRING_TYPES
+from _pytest.compat import TYPE_CHECKING
 from _pytest.outcomes import fail
 
-if False:  # TYPE_CHECKING
+if TYPE_CHECKING:
     from typing import Type  # noqa: F401 (used in type string)
 
 

src/_pytest/recwarn.py

@@ -12,10 +12,11 @@
 from typing import Union
 
 from _pytest.compat import overload
+from _pytest.compat import TYPE_CHECKING
 from _pytest.fixtures import yield_fixture
 from _pytest.outcomes import fail
 
-if False:  # TYPE_CHECKING
+if TYPE_CHECKING:
     from typing import Type