Merge master into features

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 exclude: doc/en/example/py2py3/test_py2.py
 repos:
--   repo: https://github.com/python/black
+-   repo: https://github.com/psf/black
     rev: 19.3b0
     hooks:
     -   id: black

CONTRIBUTING.rst

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

README.rst

@@ -26,7 +26,7 @@
     :target: https://dev.azure.com/pytest-dev/pytest
 
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/python/black
+    :target: https://github.com/psf/black
 
 .. image:: https://www.codetriage.com/pytest-dev/pytest/badges/users.svg
     :target: https://www.codetriage.com/pytest-dev/pytest

changelog/5669.doc.rst

@@ -0,0 +1 @@
+Add docstring for ``Testdir.copy_example``.

doc/en/capture.rst

@@ -57,7 +57,7 @@ is that you can use print statements for debugging:
 
 
     def setup_function(function):
-        print("setting up %s" % function)
+        print("setting up", function)
 
 
     def test_func1():

doc/en/example/assertion/failure_demo.py

@@ -177,7 +177,7 @@ def test_tupleerror(self):
 
     def test_reinterpret_fails_with_print_for_the_fun_of_it(self):
         items = [1, 2, 3]
-        print("items is %r" % items)
+        print("items is {!r}".format(items))
         a, b = items.pop()
 
     def test_some_error(self):

doc/en/example/markers.rst

@@ -384,7 +384,7 @@ specifies via named environments:
         envnames = [mark.args[0] for mark in item.iter_markers(name="env")]
         if envnames:
             if item.config.getoption("-E") not in envnames:
-                pytest.skip("test requires env in %r" % envnames)
+                pytest.skip("test requires env in {!r}".format(envnames))
 
 A test file using this local plugin:
 
@@ -578,7 +578,7 @@ for your particular platform, you could use the following plugin:
         supported_platforms = ALL.intersection(mark.name for mark in item.iter_markers())
         plat = sys.platform
         if supported_platforms and plat not in supported_platforms:
-            pytest.skip("cannot run on platform %s" % (plat))
+            pytest.skip("cannot run on platform {}".format(plat))
 
 then tests will be skipped if they were specified for a different platform.
 Let's do a little test file to show how this looks like:

doc/en/example/multipython.py

@@ -69,4 +69,4 @@ def load_and_is_true(self, expression):
 @pytest.mark.parametrize("obj", [42, {}, {1: 3}])
 def test_basic_objects(python1, python2, obj):
     python1.dumps(obj)
-    python2.load_and_is_true("obj == %s" % obj)
+    python2.load_and_is_true("obj == {}".format(obj))

doc/en/example/nonpython/conftest.py

@@ -33,13 +33,13 @@ def repr_failure(self, excinfo):
             return "\n".join(
                 [
                     "usecase execution failed",
-                    "   spec failed: %r: %r" % excinfo.value.args[1:3],
+                    "   spec failed: {1!r}: {2!r}".format(*excinfo.value.args),
                     "   no further details known at this point.",
                 ]
             )
 
     def reportinfo(self):
-        return self.fspath, 0, "usecase: %s" % self.name
+        return self.fspath, 0, "usecase: {}".format(self.name)
 
 
 class YamlException(Exception):

doc/en/example/reportingdemo.rst

@@ -434,7 +434,7 @@ Here is a nice run of several failures and how ``pytest`` presents things:
 
         def test_reinterpret_fails_with_print_for_the_fun_of_it(self):
             items = [1, 2, 3]
-            print("items is %r" % items)
+            print("items is {!r}".format(items))
     >       a, b = items.pop()
     E       TypeError: 'int' object is not iterable
 

doc/en/example/simple.rst

@@ -478,7 +478,7 @@ an ``incremental`` marker which is to be used on classes:
         if "incremental" in item.keywords:
             previousfailed = getattr(item.parent, "_previousfailed", None)
             if previousfailed is not None:
-                pytest.xfail("previous test failed (%s)" % previousfailed.name)
+                pytest.xfail("previous test failed ({})".format(previousfailed.name))
 
 These two hook implementations work together to abort incremental-marked
 tests in a class.  Here is a test module example:
@@ -684,7 +684,7 @@ case we just write some information out to a ``failures`` file:
             with open("failures", mode) as f:
                 # let's also access a fixture for the fun of it
                 if "tmpdir" in item.fixturenames:
-                    extra = " (%s)" % item.funcargs["tmpdir"]
+                    extra = " ({})".format(item.funcargs["tmpdir"])
                 else:
                     extra = ""
 

doc/en/fixture.rst

@@ -629,7 +629,7 @@ through the special :py:class:`request <FixtureRequest>` object:
     def smtp_connection(request):
         smtp_connection = smtplib.SMTP(request.param, 587, timeout=5)
         yield smtp_connection
-        print("finalizing %s" % smtp_connection)
+        print("finalizing {}".format(smtp_connection))
         smtp_connection.close()
 
 The main change is the declaration of ``params`` with
@@ -902,25 +902,25 @@ to show the setup/teardown flow:
     @pytest.fixture(scope="module", params=["mod1", "mod2"])
     def modarg(request):
         param = request.param
-        print("  SETUP modarg %s" % param)
+        print("  SETUP modarg", param)
         yield param
-        print("  TEARDOWN modarg %s" % param)
+        print("  TEARDOWN modarg", param)
 
 
     @pytest.fixture(scope="function", params=[1, 2])
     def otherarg(request):
         param = request.param
-        print("  SETUP otherarg %s" % param)
+        print("  SETUP otherarg", param)
         yield param
-        print("  TEARDOWN otherarg %s" % param)
+        print("  TEARDOWN otherarg", param)
 
 
     def test_0(otherarg):
-        print("  RUN test0 with otherarg %s" % otherarg)
+        print("  RUN test0 with otherarg", otherarg)
 
 
     def test_1(modarg):
-        print("  RUN test1 with modarg %s" % modarg)
+        print("  RUN test1 with modarg", modarg)
 
 
     def test_2(otherarg, modarg):

doc/en/getting-started.rst

@@ -28,7 +28,7 @@ Install ``pytest``
 .. code-block:: bash
 
     $ pytest --version
-    This is pytest version 5.x.y, imported from $PYTHON_PREFIX/lib/python3.6/site-packages/pytest.py
+    This is pytest version 5.x.y, imported from $PYTHON_PREFIX/lib/python3.x/site-packages/pytest.py
 
 .. _`simpletest`:
 

doc/en/reference.rst

@@ -27,6 +27,8 @@ pytest.skip
 
 .. autofunction:: _pytest.outcomes.skip(msg, [allow_module_level=False])
 
+.. _`pytest.importorskip ref`:
+
 pytest.importorskip
 ~~~~~~~~~~~~~~~~~~~
 

doc/en/skipping.rst

@@ -179,16 +179,15 @@ information.
 Skipping on a missing import dependency
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You can use the following helper at module level
-or within a test or test setup function:
+You can skip tests on a missing import by using :ref:`pytest.importorskip`
+at module level, within a test, or test setup function.
 
 .. code-block:: python
 
     docutils = pytest.importorskip("docutils")
 
-If ``docutils`` cannot be imported here, this will lead to a
-skip outcome of the test.  You can also skip based on the
-version number of a library:
+If ``docutils`` cannot be imported here, this will lead to a skip outcome of
+the test. You can also skip based on the version number of a library:
 
 .. code-block:: python
 

src/_pytest/outcomes.py

@@ -161,10 +161,17 @@ def importorskip(
     if the module cannot be imported.
 
     :param str modname: the name of the module to import
-    :param str minversion: if given, the imported module ``__version__`` attribute must be
-        at least this minimal version, otherwise the test is still skipped.
-    :param str reason: if given, this reason is shown as the message when the module
-        cannot be imported.
+    :param str minversion: if given, the imported module's ``__version__``
+        attribute must be at least this minimal version, otherwise the test is
+        still skipped.
+    :param str reason: if given, this reason is shown as the message when the
+        module cannot be imported.
+    :returns: The imported module. This should be assigned to its canonical
+        name.
+
+    Example::
+
+        docutils = pytest.importorskip("docutils")
     """
     import warnings
 

src/_pytest/pytester.py

@@ -630,6 +630,12 @@ def mkpydir(self, name):
         return p
 
     def copy_example(self, name=None):
+        """Copy file from project's directory into the testdir.
+
+        :param str name: The name of the file to copy.
+        :return: path to the copied directory (inside ``self.tmpdir``).
+
+        """
         import warnings
         from _pytest.warning_types import PYTESTER_COPY_EXAMPLE
 

testing/test_pastebin.py

@@ -55,7 +55,7 @@ def test_skip():
             ]
         )
 
-    def test_non_ascii_paste_text(self, testdir):
+    def test_non_ascii_paste_text(self, testdir, pastebinlist):
         """Make sure that text which contains non-ascii characters is pasted
         correctly. See #1219.
         """
@@ -74,6 +74,7 @@ def test():
                 "*Sending information to Paste Service*",
             ]
         )
+        assert len(pastebinlist) == 1
 
 
 class TestPaste: