Remove deprecated features (#5529)

Remove deprecated features

Author: nicoddemus

changelog/5180.removal.rst

@@ -0,0 +1,26 @@
+As per our policy, the following features have been deprecated in the 4.X series and are now
+removed:
+
+* ``Request.getfuncargvalue``: use ``Request.getfixturevalue`` instead.
+
+* ``pytest.raises`` and ``pytest.warns`` no longer support strings as the second argument.
+
+* ``message`` parameter of ``pytest.raises``.
+
+* ``pytest.raises``, ``pytest.warns`` and ``ParameterSet.param`` now use native keyword-only
+  syntax. This might change the exception message from previous versions, but they still raise
+  ``TypeError`` on unknown keyword arguments as before.
+
+* ``pytest.config`` global variable.
+
+* ``tmpdir_factory.ensuretemp`` method.
+
+* ``pytest_logwarning`` hook.
+
+* ``RemovedInPytest4Warning`` warning type.
+
+* ``request`` is now a reserved name for fixtures.
+
+
+For more information consult
+`Deprecations and Removals <https://docs.pytest.org/en/latest/deprecations.html>`__ in the docs.

doc/en/deprecations.rst

@@ -20,8 +20,8 @@ Below is a complete list of all pytest features which are considered deprecated.
 :ref:`standard warning filters <warnings>`.
 
 
-Removal of ``funcargnames`` alias for ``fixturenames``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``funcargnames`` alias for ``fixturenames``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. deprecated:: 5.0
 
@@ -34,12 +34,47 @@ in places where we or plugin authors must distinguish between fixture names and
 names supplied by non-fixture things such as ``pytest.mark.parametrize``.
 
 
+Result log (``--result-log``)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. deprecated:: 4.0
+
+The ``--result-log`` option produces a stream of test reports which can be
+analysed at runtime. It uses a custom format which requires users to implement their own
+parser, but the team believes using a line-based format that can be parsed using standard
+tools would provide a suitable and better alternative.
+
+The current plan is to provide an alternative in the pytest 5.0 series and remove the ``--result-log``
+option in pytest 6.0 after the new implementation proves satisfactory to all users and is deemed
+stable.
+
+The actual alternative is still being discussed in issue `#4488 <https://github.com/pytest-dev/pytest/issues/4488>`__.
+
+
+Removed Features
+----------------
+
+As stated in our :ref:`backwards-compatibility` policy, deprecated features are removed only in major releases after
+an appropriate period of deprecation has passed.
+
+
+``pytest.config`` global
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionremoved:: 5.0
+
+The ``pytest.config`` global object is deprecated.  Instead use
+``request.config`` (via the ``request`` fixture) or if you are a plugin author
+use the ``pytest_configure(config)`` hook. Note that many hooks can also access
+the ``config`` object indirectly, through ``session.config`` or ``item.config`` for example.
+
+
 .. _`raises message deprecated`:
 
 ``"message"`` parameter of ``pytest.raises``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. deprecated:: 4.1
+.. versionremoved:: 5.0
 
 It is a common mistake to think this parameter will match the exception message, while in fact
 it only serves to provide a custom message in case the ``pytest.raises`` check fails. To prevent
@@ -70,22 +105,12 @@ If you still have concerns about this deprecation and future removal, please com
 `issue #3974 <https://github.com/pytest-dev/pytest/issues/3974>`__.
 
 
-``pytest.config`` global
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. deprecated:: 4.1
-
-The ``pytest.config`` global object is deprecated.  Instead use
-``request.config`` (via the ``request`` fixture) or if you are a plugin author
-use the ``pytest_configure(config)`` hook. Note that many hooks can also access
-the ``config`` object indirectly, through ``session.config`` or ``item.config`` for example.
-
 .. _raises-warns-exec:
 
 ``raises`` / ``warns`` with a string as the second argument
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. deprecated:: 4.1
+.. versionremoved:: 5.0
 
 Use the context manager form of these instead.  When necessary, invoke ``exec``
 directly.
@@ -116,27 +141,6 @@ Becomes:
 
 
 
-Result log (``--result-log``)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. deprecated:: 4.0
-
-The ``--result-log`` option produces a stream of test reports which can be
-analysed at runtime. It uses a custom format which requires users to implement their own
-parser, but the team believes using a line-based format that can be parsed using standard
-tools would provide a suitable and better alternative.
-
-The current plan is to provide an alternative in the pytest 5.0 series and remove the ``--result-log``
-option in pytest 6.0 after the new implementation proves satisfactory to all users and is deemed
-stable.
-
-The actual alternative is still being discussed in issue `#4488 <https://github.com/pytest-dev/pytest/issues/4488>`__.
-
-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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/en/warnings.rst

@@ -430,5 +430,3 @@ The following warning types ares used by pytest and are part of the public API:
 .. autoclass:: pytest.PytestUnhandledCoroutineWarning
 
 .. autoclass:: pytest.PytestUnknownMarkWarning
-
-.. autoclass:: pytest.RemovedInPytest4Warning

src/_pytest/compat.py

@@ -56,11 +56,11 @@ def iscoroutinefunction(func):
     )
 
 
-def getlocation(function, curdir):
+def getlocation(function, curdir=None):
     function = get_real_func(function)
     fn = py.path.local(inspect.getfile(function))
     lineno = function.__code__.co_firstlineno
-    if fn.relto(curdir):
+    if curdir is not None and fn.relto(curdir):
         fn = fn.relto(curdir)
     return "%s:%d" % (fn, lineno + 1)
 

src/_pytest/config/__init__.py

@@ -17,6 +17,7 @@
 
 import _pytest._code
 import _pytest.assertion
+import _pytest.deprecated
 import _pytest.hookspec  # the extension point definitions
 from .exceptions import PrintHelp
 from .exceptions import UsageError
@@ -204,6 +205,19 @@ def _prepareconfig(args=None, plugins=None):
         raise
 
 
+def _fail_on_non_top_pytest_plugins(conftestpath, confcutdir):
+    msg = (
+        "Defining 'pytest_plugins' in a non-top-level conftest is no longer supported:\n"
+        "It affects the entire test suite instead of just below the conftest as expected.\n"
+        "  {}\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"
+    )
+    fail(msg.format(conftestpath, confcutdir), pytrace=False)
+
+
 class PytestPluginManager(PluginManager):
     """
     Overwrites :py:class:`pluggy.PluginManager <pluggy.PluginManager>` to add pytest-specific
@@ -424,16 +438,7 @@ def _importconftest(self, conftestpath):
                     and self._configured
                     and not self._using_pyargs
                 ):
-                    from _pytest.deprecated import (
-                        PYTEST_PLUGINS_FROM_NON_TOP_LEVEL_CONFTEST,
-                    )
-
-                    fail(
-                        PYTEST_PLUGINS_FROM_NON_TOP_LEVEL_CONFTEST.format(
-                            conftestpath, self._confcutdir
-                        ),
-                        pytrace=False,
-                    )
+                    _fail_on_non_top_pytest_plugins(conftestpath, self._confcutdir)
             except Exception:
                 raise ConftestImportFailure(conftestpath, sys.exc_info())
 

src/_pytest/config/findpaths.py

@@ -20,8 +20,6 @@ def getcfg(args, config=None):
 
     note: config is optional and used only to issue warnings explicitly (#2891).
     """
-    from _pytest.deprecated import CFG_PYTEST_SECTION
-
     inibasenames = ["pytest.ini", "tox.ini", "setup.cfg"]
     args = [x for x in args if not str(x).startswith("-")]
     if not args:
@@ -97,6 +95,9 @@ def get_dir_from_path(path):
     return [get_dir_from_path(path) for path in possible_paths if path.exists()]
 
 
+CFG_PYTEST_SECTION = "[pytest] section in {filename} files is no longer supported, change to [tool:pytest] instead."
+
+
 def determine_setup(inifile, args, rootdir_cmd_arg=None, config=None):
     dirs = get_dirs_from_args(args)
     if inifile:
@@ -107,8 +108,6 @@ def determine_setup(inifile, args, rootdir_cmd_arg=None, config=None):
             try:
                 inicfg = iniconfig[section]
                 if is_cfg_file and section == "pytest" and config is not None:
-                    from _pytest.deprecated import CFG_PYTEST_SECTION
-
                     fail(
                         CFG_PYTEST_SECTION.format(filename=str(inifile)), pytrace=False
                     )

src/_pytest/deprecated.py

@@ -9,10 +9,6 @@
 in case of warnings which need to format their messages.
 """
 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"
 
 # set of plugins which have been integrated into the core; we use this list to ignore
 # them during registration to avoid conflicts
@@ -23,82 +19,13 @@
 }
 
 
-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 = "[pytest] section in {filename} files is no longer supported, change to [tool:pytest] instead."
-
-GETFUNCARGVALUE = RemovedInPytest4Warning(
-    "getfuncargvalue is deprecated, use getfixturevalue"
-)
-
 FUNCARGNAMES = PytestDeprecationWarning(
     "The `funcargnames` attribute was an alias for `fixturenames`, "
     "since pytest 2.3 - use the newer attribute instead."
 )
 
-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 see:\n"
-    "  https://docs.pytest.org/en/4.6-maintenance/deprecations.html#message-parameter-of-pytest-raises"
-)
 
 RESULT_LOG = PytestDeprecationWarning(
     "--result-log is deprecated and scheduled for removal in pytest 6.0.\n"
     "See https://docs.pytest.org/en/latest/deprecations.html#result-log-result-log for more information."
 )
-
-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"
-)
-
-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"
-    "  {}\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_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/fixtures.py

@@ -2,7 +2,6 @@
 import inspect
 import itertools
 import sys
-import warnings
 from collections import defaultdict
 from collections import deque
 from collections import OrderedDict
@@ -28,8 +27,6 @@
 from _pytest.compat import is_generator
 from _pytest.compat import NOTSET
 from _pytest.compat import safe_getattr
-from _pytest.deprecated import FIXTURE_FUNCTION_CALL
-from _pytest.deprecated import FIXTURE_NAMED_REQUEST
 from _pytest.outcomes import fail
 from _pytest.outcomes import TEST_OUTCOME
 
@@ -475,13 +472,6 @@ def getfixturevalue(self, argname):
         """
         return self._get_active_fixturedef(argname).cached_result[0]
 
-    def getfuncargvalue(self, argname):
-        """ Deprecated, use getfixturevalue. """
-        from _pytest import deprecated
-
-        warnings.warn(deprecated.GETFUNCARGVALUE, stacklevel=2)
-        return self.getfixturevalue(argname)
-
     def _get_active_fixturedef(self, argname):
         try:
             return self._fixture_defs[argname]
@@ -945,9 +935,12 @@ 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.
     """
-    message = FIXTURE_FUNCTION_CALL.format(
-        name=fixture_marker.name or function.__name__
-    )
+    message = (
+        '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."
+    ).format(name=fixture_marker.name or function.__name__)
 
     @functools.wraps(function)
     def result(*args, **kwargs):
@@ -982,7 +975,13 @@ def __call__(self, function):
 
         name = self.name or function.__name__
         if name == "request":
-            warnings.warn(FIXTURE_NAMED_REQUEST)
+            location = getlocation(function)
+            fail(
+                "'request' is a reserved word for fixtures, use another name:\n  {}".format(
+                    location
+                ),
+                pytrace=False,
+            )
         function._pytestfixturefunction = self
         return function