From cf86f23b14f77067237da4a3d83e3db029de76f4 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Mon, 8 Nov 2021 20:11:40 +0100 Subject: [PATCH] Streamline deprecation changelogs/docs --- changelog/7259.breaking.rst | 1 + changelog/8447.deprecation.rst | 4 +-- changelog/8592.deprecation.rst | 2 ++ doc/en/deprecations.rst | 47 ++++++++++++++++++++++++++++------ 4 files changed, 44 insertions(+), 10 deletions(-) diff --git a/changelog/7259.breaking.rst b/changelog/7259.breaking.rst index 37f2fe6d7..48ecbcbb7 100644 --- a/changelog/7259.breaking.rst +++ b/changelog/7259.breaking.rst @@ -5,4 +5,5 @@ Since `py.path.local` is a `os.PathLike[str]`, these plugins are unaffacted. Plugins and users which call `reportinfo()`, use the first return value and interact with it as a `py.path.local`, would need to adjust by calling `py.path.local(fspath)`. Although preferably, avoid the legacy `py.path.local` and use `pathlib.Path`, or use `item.location` or `item.path`, instead. + Note: pytest was not able to provide a deprecation period for this change. diff --git a/changelog/8447.deprecation.rst b/changelog/8447.deprecation.rst index 0116483a3..8386e3b74 100644 --- a/changelog/8447.deprecation.rst +++ b/changelog/8447.deprecation.rst @@ -1,4 +1,4 @@ -Defining a custom pytest node type which is both an :class:`pytest.Item ` and a :class:`pytest.Collector ` now issues a warning. +Defining a custom pytest node type which is both an :class:`pytest.Item ` and a :class:`pytest.Collector ` (e.g. :class:`pytest.File `) now issues a warning. It was never sanely supported and triggers hard to debug errors. -Instead, a separate collector node should be used, which collects the item. See :ref:`non-python tests` for an example. +See :ref:`the deprecation note ` for full details. diff --git a/changelog/8592.deprecation.rst b/changelog/8592.deprecation.rst index 51b7a6b0d..733ad3586 100644 --- a/changelog/8592.deprecation.rst +++ b/changelog/8592.deprecation.rst @@ -1 +1,3 @@ :func:`pytest_cmdline_preparse <_pytest.hookspec.pytest_cmdline_preparse>` has been officially deprecated. It will be removed in a future release. Use :func:`pytest_load_initial_conftests <_pytest.hookspec.pytest_load_initial_conftests>` instead. + +See :ref:`the deprecation note ` for full details. diff --git a/doc/en/deprecations.rst b/doc/en/deprecations.rst index c47e9a703..87fbd6842 100644 --- a/doc/en/deprecations.rst +++ b/doc/en/deprecations.rst @@ -55,6 +55,26 @@ In order to support the transition from ``py.path.local`` to :mod:`pathlib`, the The accompanying ``py.path.local`` based paths have been deprecated: plugins which manually invoke those hooks should only pass the new ``pathlib.Path`` arguments, and users should change their hook implementations to use the new ``pathlib.Path`` arguments. +Directly constructing internal classes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. deprecated:: 7.0 + +Directly constructing the following classes is now deprecated: + +- ``_pytest.mark.structures.Mark`` +- ``_pytest.mark.structures.MarkDecorator`` +- ``_pytest.mark.structures.MarkGenerator`` +- ``_pytest.python.Metafunc`` +- ``_pytest.runner.CallInfo`` +- ``_pytest._code.ExceptionInfo`` +- ``_pytest.config.argparsing.Parser`` +- ``_pytest.config.argparsing.OptionGroup`` +- ``_pytest.pytester.HookRecorder`` + +These constructors have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 8. + +.. _cmdline-preparse-deprecated: Implementing the ``pytest_cmdline_preparse`` hook ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -78,18 +98,19 @@ Implement the :func:`pytest_load_initial_conftests <_pytest.hookspec.pytest_load ) -> None: ... +.. _diamond-inheritance-deprecated: -Diamond inheritance between :class:`pytest.File` and :class:`pytest.Item` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Diamond inheritance between :class:`pytest.Collector` and :class:`pytest.Item` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. deprecated:: 7.0 -Inheriting from both Item and file at once has never been supported officially, -however some plugins providing linting/code analysis have been using this as a hack. - -This practice is now officially deprecated and a common way to fix this is `example pr fixing inheritance`_. - +Defining a custom pytest node type which is both an :class:`pytest.Item ` and a :class:`pytest.Collector ` (e.g. :class:`pytest.File `) now issues a warning. +It was never sanely supported and triggers hard to debug errors. +Some plugins providing linting/code analysis have been using this as a hack. +Instead, a separate collector node should be used, which collects the item. See +:ref:`non-python tests` for an example, as well as an `example pr fixing inheritance`_. .. _example pr fixing inheritance: https://github.com/asmeurer/pytest-flakes/pull/40/files @@ -100,7 +121,7 @@ Backward compatibilities in ``Parser.addoption`` .. deprecated:: 2.4 Several behaviors of :meth:`Parser.addoption ` are now -scheduled for removal in pytest 7 (deprecated since pytest 2.4.0): +scheduled for removal in pytest 8 (deprecated since pytest 2.4.0): - ``parser.addoption(..., help=".. %default ..")`` - use ``%(default)s`` instead. - ``parser.addoption(..., type="int/string/float/complex")`` - use ``type=int`` etc. instead. @@ -119,6 +140,16 @@ collection. You are probably not doing that. Ordinary usage of :class:`unittest.SkipTest` / :meth:`unittest.TestCase.skipTest` / :func:`unittest.skip` in unittest test cases is fully supported. +Using ``pytest.warns(None)`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. deprecated:: 7.0 + +:func:`pytest.warns(None) ` is now deprecated because many people used +it to mean "this code does not emit warnings", but it actually had the effect of +checking that the code emits at least one warning of any type - like ``pytest.warns()`` +or ``pytest.warns(Warning)``. + The ``--strict`` command-line option ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~