Please remove the dependency on 'py' #7259

mgorny · 2020-05-25T14:52:12Z

Since 'py' isn't really receiving any attention, and distributions end up carrying growing pile of patches just to keep it working, I think it'd be reasonable for pytest to stop requiring it. Just to be clear, right now we need to patch tests to work with pytest-4+, we hackaround breakages in python3.8 and python3.9 is around the corner with yet another set of problems.

RonnyPfannschmidt · 2020-05-25T16:09:00Z

We are working on it, it's still going to take years

bluetech · 2020-05-26T08:57:47Z

In master, we are down to depending on only two parts of py: py.path.local and py.iniconfig (and one instance of py.error.Error which I can remove). Migrating from py.path.local would require a big effort, but py.iniconfig can be imported quite easily. WDYT @RonnyPfannschmidt?

RonnyPfannschmidt · 2020-05-26T14:51:00Z

Ini config is already externalized, no need to copy into pytest

kerizane · 2020-05-31T20:18:37Z

Is the plan documented anyway? Any preferences or guidelines?

RonnyPfannschmidt · 2020-05-31T20:40:39Z

the plan is not documented anywhere, in detail yet, we created https://github.com/pytest-dev/pytest/projects/4 to de-tangle and track it

Zac-HD · 2020-06-01T13:55:52Z

Personally I'd be happy to have a hard-cutover to pathlib in pytest 6.0

It's a significant change and may be a breaking one for some users and plugins, but I think likely to cause less churn in dependencies than trying to invent a compatibility layer. I estimate that almost no end-users will be directly affected, and only a small fraction of plugins - and importantly that it will be easier on pytest maintainers to help plugins migrate than to have an upstream compat layer.

nicoddemus · 2020-06-01T14:21:13Z

It's a significant change and may be a breaking one for some users and plugins

Oh no it would break the world: tmpdir (a very used fixture) is a py.path.local object.

Zac-HD · 2020-06-01T14:35:11Z

Ah. Yes, that would do it 🤦‍♂️

RonnyPfannschmidt · 2020-06-02T05:03:21Z

Personally i will reject a compatibility layer beyond casting some objects to local paths and leaving behind the legacy properties which do

Support for py.path.local will then be constrained to the python versions where pylib works and pylib will turn into a optional dependency that's declared dead

bluetech · 2020-06-02T17:44:32Z

In master, we are down to depending on only two parts of py: py.path.local and py.iniconfig

For some reason, one slipped my mind: py.xml used in the junitxml plugin.

nicoddemus · 2020-06-02T18:06:03Z

Oh right. That will be a simple, but arduous refactoring.

kerizane · 2020-06-02T18:14:08Z

junitxml already has a ticket:
#4970

gnikonorov · 2020-06-02T18:15:07Z

Question. What is the reason for py’s existence? Were the features it added just not available in standard python at the time or was it optimized for pytest?

nicoddemus · 2020-06-02T18:21:11Z

The first one: it dates before/around Python 3.0 was released, so it contained a bunch of utilities that worked in both Python 2 and Python 3.0 at the time, plus general utilities such as xml manipulation, file first-class objects, I/O, and including py.test, which was the early stages of pytest. pytest was in fact born by extracting py.test from py.

Since then, there are better alternatives for all of which is implemented there, that's why we have no interest in adding new features to it, or even maintaining it if possible.

gnikonorov · 2020-06-02T18:31:10Z

Thank you for the explanation @nicoddemus

bluetech · 2021-03-20T20:39:39Z

As mentioned in this comment, I have looked more closely at what remains to be done before we can deprecate py.path. Of course, before we can deprecate, there must be replacements for everything which takes or returns a py.path. After all of our recent PRs, I created a branch which removes all py.path functionality for which there exist replacements (i.e. can be readily deprecated), here: https://github.com/bluetech/pytest/commits/rm-py. That branch passes all tests and lints which ensures I don't miss anything.

There are only two remaining py.path usages which cannot be easily handled:

pathlist

The pathlist ini type (as in parser.addini("mypaths", "my ini option", type="pathlist")). This type takes a line list and returns the values as a list of paths relative to the ini file. This type is not documented anywhere that I can see.

It is not possible to fix a return type, so this would either need to be removed, replaced or broken without deprecation.

Plugins which use this

pytest-pythonpath/pytest_pythonpath.py
9-    # py.test has an issue where the cwd is not in the PYTHONPATH. Fix it here.
10-    if os.getcwd() not in sys.path:
11-        sys.path.insert(0, os.getcwd())
12:    parser.addini("python_paths", type="pathlist", help="space seperated directory paths to add to PYTHONPATH via sys.path.insert(0, path)",
13-                  default=[])
14:    parser.addini("site_dirs", type="pathlist", help="space seperated directory paths to add to PYTHONPATH via site.addsitedir(path)",
15-                  default=[])
16-
17-

pytest-cloud/pytest_cloud/plugin.py
174-    parser.addini(
175-        "cloud_develop_eggs",
176-        "list of python package paths to install in develop mode on the remote side",
177:        type="pathlist",
178-    )
179-
180-

pytest-srcpaths/pytest_srcpaths.py
7-
8-def pytest_addoption(parser):
9-    parser.addini("srcpaths",
10:                  type="pathlist",
11-                  help="Add paths to sys.path")
12-
13-

pytest-xdist/src/xdist/plugin.py
142-    parser.addini(
143-        "rsyncdirs",
144-        "list of (relative) paths to be rsynced for remote distributed testing.",
145:        type="pathlist",
146-    )
147-    parser.addini(
148-        "rsyncignore",
149-        "list of (relative) glob-style paths to be ignored for rsyncing.",
150:        type="pathlist",
151-    )
152-    parser.addini(
153-        "looponfailroots",
154:        type="pathlist",
155-        help="directories to check for changes",
156-        default=[py.path.local()],
157-    )

pytest-postgresql/src/pytest_postgresql/plugin.py
100-
101-    parser.addini(
102-        name='postgresql_load',
103:        type='pathlist',
104-        help=_help_load,
105-        default=None
106-    )

reportinfo

This is a method that needs to be implemented by custom Items. One of its return values is a py.path.

Most plugins implement the method, which is normally called by pytest, but some plugins do call it. So the py.path is in both a covariant and contravariant position.

If we only care about the plugin-implements case, then we can change the contract to "returns path-like object" instead of "returns py.path". If we also care about the plugin-calls case, then we need to come up with another solution.

Plugins which use this

pytest-isort/pytest_isort.py
184:    def reportinfo(self):

pytest-pycodestyle/src/pytest_pycodestyle.py
85:    def reportinfo(self):

pytest-pycodestyle/tests/test_pytest_pycodestyle.py
118:    def test_reportinfo(self):

pytest-ghostinspector/pytest_gi/plugin.py
241:    def reportinfo(self):

pytest-qml/src/pytestqml/nodes.py
130:    def reportinfo(self):

pytest-alembic/src/pytest_alembic/plugin/plugin.py
105:    def reportinfo(self):

pytest-codestyle/tests/test_pytest_pycodestyle.py
118:    def test_reportinfo(self):

pytest-codestyle/src/pytest_pycodestyle.py
85:    def reportinfo(self):

pytest-check-links/pytest_check_links/plugin.py
223:    def reportinfo(self):

pytest-gherkin/pytest_gherkin/gherkin.py
174:    def reportinfo(self):

pytest_oot/pytest_oot/oot_plugin.py
223:    def reportinfo(self):

pytest-flake8/pytest_flake8.py
141:    def reportinfo(self):

pytest-eradicate/pytest_eradicate.py
84:    def reportinfo(self):

pytest-asptest/asptest/classes.py
171:    def reportinfo(self):

pytest-freeze-reqs/freeze_reqs/pytest_freeze_reqs.py
99:    def reportinfo(self):

pytest-mypy-plugins/pytest_mypy_plugins/item.py
352:    def reportinfo(self) -> Tuple[Union[py.path.local, str], Optional[int], str]:

pytest-jasmine/pytest_jasmine.py
157:    def reportinfo(self):

pytest-notebook/pytest_notebook/plugin.py
306:    def reportinfo(self):

pytest-checkipdb/pytest_checkipdb.py
47:    def reportinfo(self):

pytest-pydocstyle/tests/test_pytest_pydocstyle.py
131:    def test_reportinfo(self):

pytest-pydocstyle/src/pytest_pydocstyle.py
104:    def reportinfo(self):

python-pytest-cases/pytest_cases/case_parametrizer_new.py
827:#             fspath, lineno, _ = item.reportinfo()

pytest-bandit/pytest_bandit/controller.py
95:    def reportinfo(self):

pytest-mypy/src/pytest_mypy.py
176:    def reportinfo(self):

pytest-translations/pytest_translations/po_spelling.py
123:    def reportinfo(self):

pytest-translations/pytest_translations/mo_files.py
85:    def reportinfo(self):

pytest-translations/pytest_translations/po_files.py
83:    def reportinfo(self):
101:    def reportinfo(self):
119:    def reportinfo(self):

pytest-black/pytest_black.py
89:    def reportinfo(self):

agent-python-pytest/pytest_reportportal/service.py
717:            return test_item.reportinfo()[2]

pytest-mccabe/pytest_mccabe.py
92:    def reportinfo(self):

pytest-requests/pytest_python_requests.py
418:    def reportinfo(self):

pytest-reqs/pytest_reqs.py
160:    def reportinfo(self):

pytest-dash/pytest_dash/behaviors.py
85:    def reportinfo(self):

pytest-docstyle/src/pytest_pydocstyle.py
104:    def reportinfo(self):

pytest-docstyle/tests/test_pytest_pydocstyle.py
131:    def test_reportinfo(self):

pytest-yapf3/src/pytest_yapf3/__init__.py
147:    def reportinfo(self):

pytest-pylint/pytest_pylint/plugin.py
391:    def reportinfo(self):

pytest-molecule/pytest_molecule/__init__.py
233:    def reportinfo(self):

pytest-contexts/pytest_contexts.py
31:    def reportinfo(self):
64:    def reportinfo(self):

dbt-adapter-tests/pytest_dbt_adapter/spec_file.py
689:    def reportinfo(self):

pytest-mypy-testing/src/pytest_mypy_testing/plugin.py
74:    def reportinfo(self) -> Tuple[str, Optional[int], str]:

allure-pytest/allure/pytest_plugin.py
115:            description = item.reportinfo()[2]

pytest-cpp/src/pytest_cpp/plugin.py
155:    def reportinfo(self):

pytest-flakes/pytest_flakes.py
102:    def reportinfo(self):

pytest-cram/pytest_cram/__init__.py
83:    def reportinfo(self):

RonnyPfannschmidt · 2021-03-22T07:52:14Z

i wonder if we can revise the concept of the reportinfo while ridding us of py.path

i'd also like to rid pytest of the copy of pylibs exceptioninfo to bring in better features for tracebacks on async, twisted and frameworks in general

bluetech · 2021-04-26T08:09:22Z

As for pathlist (see comment #7259 (comment) above), I think we can add a paths INI type (parser.addini("mypaths", "my ini option", type="paths")) to replace pathlist. This would of course return a list of Paths instead of py.paths. Then we could deprecate pathlist.

Another alternative is to just deprecate pathlist without replacement, it's not used that much and not really hard to implement oneself.

I think I will submit a PR to add paths unless someone has other preferences.

i wonder if we can revise the concept of the reportinfo while ridding us of py.path

Right, for reportinfo there doesn't seem to be simple solutions. This ^ would need some design work.

bluetech · 2021-05-19T08:28:28Z

OK, here is my suggestion:

For 6.3.0 (next minor release)

Add a single PendingDeprecationWarning type for py.path. Go over all py.path usages and add it. Message for each case would be different and indicate the suggested replacement. It would be possible to ignore the entire class based on the type, or specific cases based on the message.
Add a section to the deprecation docs with a rationale, the deprecation timeline and listing all of the deprecated py.path usages and their replacements (single central place to link to), along with the version from which the replacement is available.
Add a note to the release notes indicating the deprecation has began and linking to the doc.

One hitch here is reportinfo which has no replacement but I suggest we punt it for now -- better than nothing. Of course it won't be marked deprecated until there is a replacement.

For 7.0.0 (next major release)

Change the PendingDeprecationWarning to a DeprecationWarning.

For 8.0.0

Remove. I estimate this would be 2-3 years from now.

If this sounds OK, I can do the work for the 6.3.0 release.

The idea here is just to give ample time to transition.

Does anyone have alternative ideas on how we could reduce the pain here? The audiences are:

Users: presumably we want them to just pin or require a new pytest version and convert all tmpdir to tmp_path etc. and be done with it. Can we ease these migrations?
Plugins 1: they often would want to support older versions which don't have full pathlib support. Should we just rely on the long deprecation period + dropping support for older versions, or can we offer some way to do it without dropping compat?
Plugins 2: some probably have their own APIs which expose py.path. Can we aid them in migrating to pathlib?

I know @RonnyPfannschmidt has ideas around legacy_path etc. but I don't think I've seen the exact idea/plan.

RonnyPfannschmidt · 2021-05-19T08:34:41Z

@bluetech the basic idea of legacy_path is that we can turn the pylib dependency optional at some point while leaving the deprecated calls in - a legacy_path would eventually act "like" a py.path.local but only pylib is installed

so in sense we would pass around "py.path.local" tokens that only turn into a py.path.local when actually used

exposing legacy_path would also help them to migrate

beleive the basic idea should be to help everyone migrate off py.path.local as soon as possible and investigate how other plugins can have that easy (maybe by providing some extra collection classes in a compat package)

The-Compiler · 2021-05-19T11:41:34Z

FWIW I'm strongly opposed to adding more to the 6.3.0 (or 7.0.0, if we decide to go for that) backlog unless absolutely required. We haven't had a feature release in more than half a year, and adding more stuff rather than finishing what we've started (mostly #8435 at this point?) is only going to make things worse.

RonnyPfannschmidt · 2021-05-19T12:35:48Z

Thanks for the check, I'll aim at finishing that by the end of the week and let's push the rest to 6.4/7

nicoddemus · 2021-05-19T13:48:53Z

Thanks @bluetech for the write up and bringing this up to attention again.

Add a single PendingDeprecationWarning type for py.path. Go over all py.path usages and add it. Message for each case would be different and indicate the suggested replacement. It would be possible to ignore the entire class based on the type, or specific cases based on the message.

👍

Add a section to the deprecation docs with a rationale, the deprecation timeline and listing all of the deprecated py.path usages and their replacements (single central place to link to), along with the version from which the replacement is available.

Add a note to the release notes indicating the deprecation has began and linking to the doc.

👍

Just to mention that IMHO deprecation docs (both rationale and how to port the code) are absolutely the most important thing we should do regarding deprecations. Normal users are just annoyed by deprecations ("my code was working"), so having a good, concise explanations and even better a simple copy/paste suggestionst to migrate does wonders here.

Users: presumably we want them to just pin or require a new pytest version and convert all tmpdir to tmp_path etc. and be done with it. Can we ease these migrations?

Unfortunately this will be a huge huge pain. There are very large suites out there that make extensive use of tmpdir, and porting to tmp_path is a trivial but manually intensive labor. Suggesting to pin to old versions is not a solution, as those are "live" code bases that want to use the latest pytest.

We have discussed this before, but IIRC the best proposal to ease that pain is to create a pytest-tmpdir or pytest-pypath-legacy plugin, which provides the tmpdir fixture back. That plugin could provide a shim to the py.path API, using pathlib.Path as the implementation. It should be maintained by the core team, IMHO. The advantage of that being a plugin (instead of keeping tmpdir in the core using a shim) is that we don't need to keep the old API around pytest itself, plus a plugin can make less guarantees about the shim compatibility: by that I mean "behaves the same" but some things might be slightly different, say some operation might leave a "/" at the end which doesn't happen in the original py.path, but should not affect normal usage otherwise.

the basic idea of legacy_path is that we can turn the pylib dependency optional at some point while leaving the deprecated calls in - a legacy_path would eventually act "like" a py.path.local but only pylib is installed

Hmm but then we now have to support that mechanism long term as well... until now I thought of legacy_path more as a central place to keep py.path stuff for easy removal later, rather than being actually a feature.

Thanks for the check, I'll aim at finishing that by the end of the week and let's push the rest to 6.4/7

Agree, we should avoid pilling up more into 6.3.0. 👍

The-Compiler · 2021-05-19T14:08:32Z

Unfortunately this will be a huge huge pain. There are very large suites out there that make extensive use of tmpdir, and porting to tmp_path is a trivial but manually intensive labor.

We could try to write a tool in the spirit of unittest2pytest or hypothesis codemod to automate this to the extent that's possible. LibCST seems like an excellent base for something like this, but I have no real experience with it.

For reference, here's hypothesis' implementation: codemods.py

…hLike[str]` `reportinfo()` is the last remaining py.path-only code path in pytest, i.e. the last piece holding back py.path deprecation. The problem with it is that plugins/users use it from both sides -- implementing it (returning the value) and using it (using the return value). Dealing with implementers is easy enough -- allow to return `os.PathLike[str]`. But for callers who expect strictly `py.path` this will break and there's not really a good way to provide backward compat for this. From analyzing a corpus of 680 pytest plugins, the vast majority of `reportinfo` appearances are implementations, and the few callers don't actually access the path part of the return tuple. As for test suites that might access `reportinfo` (e.g. using `request.node.reportinfo()` or other ways), that is much harder to survey, but from the ones I searched, I only found case (`pytest_teamcity`, but even then it uses `str(fspath)` so is unlikely to be affected in practice). They are better served with using `node.location` or `node.path` directly. Therefore, just break it and change the return type to `str|os.PathLike[str]`. Refs pytest-dev#7259.

nicoddemus · 2021-10-20T13:23:26Z

From #7259 (comment):

Rollout of plugin

It would be great if we could issue warnings for the functions provided by the plugin, indicating to install the standalone version. This would mean keeping both internal and external plugins "around" for a bit, which would be a bit more work but provide a more smooth transition (and chance to catch early problems).

…hLike[str]` `reportinfo()` is the last remaining py.path-only code path in pytest, i.e. the last piece holding back py.path deprecation. The problem with it is that plugins/users use it from both sides -- implementing it (returning the value) and using it (using the return value). Dealing with implementers is easy enough -- allow to return `os.PathLike[str]`. But for callers who expect strictly `py.path` this will break and there's not really a good way to provide backward compat for this. From analyzing a corpus of 680 pytest plugins, the vast majority of `reportinfo` appearances are implementations, and the few callers don't actually access the path part of the return tuple. As for test suites that might access `reportinfo` (e.g. using `request.node.reportinfo()` or other ways), that is much harder to survey, but from the ones I searched, I only found case (`pytest_teamcity`, but even then it uses `str(fspath)` so is unlikely to be affected in practice). They are better served with using `node.location` or `node.path` directly. Therefore, just break it and change the return type to `str|os.PathLike[str]`. Refs pytest-dev#7259.

118: Update pytest to 7.0.0 r=aragilar a=pyup-bot This PR updates [pytest](https://pypi.org/project/pytest) from **6.2.4** to **7.0.0**. <details> <summary>Changelog</summary> ### 7.0.0 ``` ========================= (**Please see the full set of changes for this release also in the 7.0.0rc1 notes below**) Deprecations ------------ - `9488 <https://github.com/pytest-dev/pytest/issues/9488>`_: If custom subclasses of nodes like :class:`pytest.Item` override the ``__init__`` method, they should take ``**kwargs``. See :ref:`uncooperative-constructors-deprecated` for details. Note that a deprection warning is only emitted when there is a conflict in the arguments pytest expected to pass. This deprecation was already part of pytest 7.0.0rc1 but wasn't documented. Bug Fixes --------- - `9355 <https://github.com/pytest-dev/pytest/issues/9355>`_: Fixed error message prints function decorators when using assert in Python 3.8 and above. - `9396 <https://github.com/pytest-dev/pytest/issues/9396>`_: Ensure :attr:`pytest.Config.inifile` is available during the :func:`pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>` hook (regression during ``7.0.0rc1``). Improved Documentation ---------------------- - `9404 <https://github.com/pytest-dev/pytest/issues/9404>`_: Added extra documentation on alternatives to common misuses of `pytest.warns(None)` ahead of its deprecation. - `9505 <https://github.com/pytest-dev/pytest/issues/9505>`_: Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository. Trivial/Internal Changes ------------------------ - `9521 <https://github.com/pytest-dev/pytest/issues/9521>`_: Add test coverage to assertion rewrite path. ``` ### 7.0.0rc1 ``` ============================ Breaking Changes ---------------- - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: The :ref:`Node.reportinfo() <non-python tests>` function first return value type has been expanded from `py.path.local | str` to `os.PathLike[str] | str`. Most plugins which refer to `reportinfo()` only define it as part of a custom :class:`pytest.Item` implementation. 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. - `8246 <https://github.com/pytest-dev/pytest/issues/8246>`_: ``--version`` now writes version information to ``stdout`` rather than ``stderr``. - `8733 <https://github.com/pytest-dev/pytest/issues/8733>`_: Drop a workaround for `pyreadline <https://github.com/pyreadline/pyreadline>`__ that made it work with ``--pdb``. The workaround was introduced in `1281 <https://github.com/pytest-dev/pytest/pull/1281>`__ in 2015, however since then `pyreadline seems to have gone unmaintained <https://github.com/pyreadline/pyreadline/issues/58>`__, is `generating warnings <https://github.com/pytest-dev/pytest/issues/8847>`__, and will stop working on Python 3.10. - `9061 <https://github.com/pytest-dev/pytest/issues/9061>`_: Using :func:`pytest.approx` in a boolean context now raises an error hinting at the proper usage. It is apparently common for users to mistakenly use ``pytest.approx`` like this: .. code-block:: python assert pytest.approx(actual, expected) While the correct usage is: .. code-block:: python assert actual == pytest.approx(expected) The new error message helps catch those mistakes. - `9277 <https://github.com/pytest-dev/pytest/issues/9277>`_: The ``pytest.Instance`` collector type has been removed. Importing ``pytest.Instance`` or ``_pytest.python.Instance`` returns a dummy type and emits a deprecation warning. See :ref:`instance-collector-deprecation` for details. - `9308 <https://github.com/pytest-dev/pytest/issues/9308>`_: **PytestRemovedIn7Warning deprecation warnings are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type ``PytestRemovedIn7Warning`` now generate errors instead of warning messages by default. **The affected features will be effectively removed in pytest 7.1**, so please consult the :ref:`deprecations` section in the docs for directions on how to update existing code. In the pytest ``7.0.X`` series, it is possible to change the errors back into warnings as a stopgap measure by adding this to your ``pytest.ini`` file: .. code-block:: ini [pytest] filterwarnings = ignore::pytest.PytestRemovedIn7Warning But this will stop working when pytest ``7.1`` is released. **If you have concerns** about the removal of a specific feature, please add a comment to :issue:`9308`. Deprecations ------------ - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: ``py.path.local`` arguments for hooks have been deprecated. See :ref:`the deprecation note <legacy-path-hooks-deprecated>` for full details. ``py.path.local`` arguments to Node constructors have been deprecated. See :ref:`the deprecation note <node-ctor-fspath-deprecation>` for full details. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: 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. - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: Raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is deprecated. Use :func:`pytest.skip` instead. Note: This deprecation only relates to using :class:`unittest.SkipTest` during test 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. - `8315 <https://github.com/pytest-dev/pytest/issues/8315>`_: Several behaviors of :meth:`Parser.addoption <pytest.Parser.addoption>` are now 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. - `8447 <https://github.com/pytest-dev/pytest/issues/8447>`_: Defining a custom pytest node type which is both an :class:`pytest.Item <Item>` and a :class:`pytest.Collector <Collector>` (e.g. :class:`pytest.File <File>`) now issues a warning. It was never sanely supported and triggers hard to debug errors. See :ref:`the deprecation note <diamond-inheritance-deprecated>` for full details. - `8592 <https://github.com/pytest-dev/pytest/issues/8592>`_: 🪝`pytest_cmdline_preparse` has been officially deprecated. It will be removed in a future release. Use 🪝`pytest_load_initial_conftests` instead. See :ref:`the deprecation note <cmdline-preparse-deprecated>` for full details. - `8645 <https://github.com/pytest-dev/pytest/issues/8645>`_: :func:`pytest.warns(None) <pytest.warns>` 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)``. - `8948 <https://github.com/pytest-dev/pytest/issues/8948>`_: :func:`pytest.skip(msg=...) <pytest.skip>`, :func:`pytest.fail(msg=...) <pytest.fail>` and :func:`pytest.exit(msg=...) <pytest.exit>` signatures now accept a ``reason`` argument instead of ``msg``. Using ``msg`` still works, but is deprecated and will be removed in a future release. This was changed for consistency with :func:`pytest.mark.skip <pytest.mark.skip>` and :func:`pytest.mark.xfail <pytest.mark.xfail>` which both accept ``reason`` as an argument. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to types reachable through :attr:`pytest.ExceptionInfo.traceback`: - The ``path`` property of ``_pytest.code.Code`` returns ``Path`` instead of ``py.path.local``. - The ``path`` property of ``_pytest.code.TracebackEntry`` returns ``Path`` instead of ``py.path.local``. There was no deprecation period for this change (sorry!). Features -------- - `5196 <https://github.com/pytest-dev/pytest/issues/5196>`_: Tests are now ordered by definition order in more cases. In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order). - `7132 <https://github.com/pytest-dev/pytest/issues/7132>`_: Added two environment variables :envvar:`PYTEST_THEME` and :envvar:`PYTEST_THEME_MODE` to let the users customize the pygments theme used. - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: Added :meth:`cache.mkdir() <pytest.Cache.mkdir>`, which is similar to the existing :meth:`cache.makedir() <pytest.Cache.makedir>`, but returns a :class:`pathlib.Path` instead of a legacy ``py.path.local``. Added a ``paths`` type to :meth:`parser.addini() <pytest.Parser.addini>`, as in ``parser.addini("mypaths", "my paths", type="paths")``, which is similar to the existing ``pathlist``, but returns a list of :class:`pathlib.Path` instead of legacy ``py.path.local``. - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: The types of objects used in pytest's API are now exported so they may be used in type annotations. The newly-exported types are: - ``pytest.Config`` for :class:`Config <pytest.Config>`. - ``pytest.Mark`` for :class:`marks <pytest.Mark>`. - ``pytest.MarkDecorator`` for :class:`mark decorators <pytest.MarkDecorator>`. - ``pytest.MarkGenerator`` for the :class:`pytest.mark <pytest.MarkGenerator>` singleton. - ``pytest.Metafunc`` for the :class:`metafunc <pytest.MarkGenerator>` argument to the 🪝`pytest_generate_tests` hook. - ``pytest.CallInfo`` for the :class:`CallInfo <pytest.CallInfo>` type passed to various hooks. - ``pytest.PytestPluginManager`` for :class:`PytestPluginManager <pytest.PytestPluginManager>`. - ``pytest.ExceptionInfo`` for the :class:`ExceptionInfo <pytest.ExceptionInfo>` type returned from :func:`pytest.raises` and passed to various hooks. - ``pytest.Parser`` for the :class:`Parser <pytest.Parser>` type passed to the 🪝`pytest_addoption` hook. - ``pytest.OptionGroup`` for the :class:`OptionGroup <pytest.OptionGroup>` type returned from the :func:`parser.addgroup <pytest.Parser.getgroup>` method. - ``pytest.HookRecorder`` for the :class:`HookRecorder <pytest.HookRecorder>` type returned from :class:`~pytest.Pytester`. - ``pytest.RecordedHookCall`` for the :class:`RecordedHookCall <pytest.HookRecorder>` type returned from :class:`~pytest.HookRecorder`. - ``pytest.RunResult`` for the :class:`RunResult <pytest.RunResult>` type returned from :class:`~pytest.Pytester`. - ``pytest.LineMatcher`` for the :class:`LineMatcher <pytest.RunResult>` type used in :class:`~pytest.RunResult` and others. - ``pytest.TestReport`` for the :class:`TestReport <pytest.TestReport>` type used in various hooks. - ``pytest.CollectReport`` for the :class:`CollectReport <pytest.CollectReport>` type used in various hooks. Constructing most of them directly is not supported; they are only meant for use in type annotations. Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0. Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy. - `7856 <https://github.com/pytest-dev/pytest/issues/7856>`_: :ref:`--import-mode=importlib <import-modes>` now works with features that depend on modules being on :py:data:`sys.modules`, such as :mod:`pickle` and :mod:`dataclasses`. - `8144 <https://github.com/pytest-dev/pytest/issues/8144>`_: The following hooks now receive an additional ``pathlib.Path`` argument, equivalent to an existing ``py.path.local`` argument: - 🪝`pytest_ignore_collect` - The ``collection_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_collect_file` - The ``file_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_pycollect_makemodule` - The ``module_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_report_header` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). - 🪝`pytest_report_collectionfinish` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8251 <https://github.com/pytest-dev/pytest/issues/8251>`_: Implement ``Node.path`` as a ``pathlib.Path``. Both the old ``fspath`` and this new attribute gets set no matter whether ``path`` or ``fspath`` (deprecated) is passed to the constructor. It is a replacement for the ``fspath`` attribute (which represents the same path as ``py.path.local``). While ``fspath`` is not deprecated yet due to the ongoing migration of methods like :meth:`~_pytest.Item.reportinfo`, we expect to deprecate it in a future release. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8421 <https://github.com/pytest-dev/pytest/issues/8421>`_: :func:`pytest.approx` now works on :class:`~decimal.Decimal` within mappings/dicts and sequences/lists. - `8606 <https://github.com/pytest-dev/pytest/issues/8606>`_: pytest invocations with ``--fixtures-per-test`` and ``--fixtures`` have been enriched with: - Fixture location path printed with the fixture name. - First section of the fixture's docstring printed under the fixture name. - Whole of fixture's docstring printed under the fixture name using ``--verbose`` option. - `8761 <https://github.com/pytest-dev/pytest/issues/8761>`_: New :ref:`version-tuple` attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions). - `8789 <https://github.com/pytest-dev/pytest/issues/8789>`_: Switch TOML parser from ``toml`` to ``tomli`` for TOML v1.0.0 support in ``pyproject.toml``. - `8920 <https://github.com/pytest-dev/pytest/issues/8920>`_: Added :class:`pytest.Stash`, a facility for plugins to store their data on :class:`~pytest.Config` and :class:`~_pytest.nodes.Node`\s in a type-safe and conflict-free manner. See :ref:`plugin-stash` for details. - `8953 <https://github.com/pytest-dev/pytest/issues/8953>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``warnings`` argument to assert the total number of warnings captured. - `8954 <https://github.com/pytest-dev/pytest/issues/8954>`_: ``--debug`` flag now accepts a :class:`str` file to route debug logs into, remains defaulted to `pytestdebug.log`. - `9023 <https://github.com/pytest-dev/pytest/issues/9023>`_: Full diffs are now always shown for equality assertions of iterables when `CI` or ``BUILD_NUMBER`` is found in the environment, even when ``-v`` isn't used. - `9113 <https://github.com/pytest-dev/pytest/issues/9113>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``deselected`` argument to assert the total number of deselected tests. - `9114 <https://github.com/pytest-dev/pytest/issues/9114>`_: Added :confval:`pythonpath` setting that adds listed paths to :data:`sys.path` for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in `pythonpath` setting. Improvements ------------ - `7480 <https://github.com/pytest-dev/pytest/issues/7480>`_: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category `PytestRemovedInXWarning`, a subclass of :class:`~pytest.PytestDeprecationWarning`, instead of :class:`PytestDeprecationWarning` directly. See :ref:`backwards-compatibility` for more details. - `7864 <https://github.com/pytest-dev/pytest/issues/7864>`_: Improved error messages when parsing warning filters. Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause of the problem (for example an ``ImportError`` while importing a specific warning type). - `8335 <https://github.com/pytest-dev/pytest/issues/8335>`_: Improved :func:`pytest.approx` assertion messages for sequences of numbers. The assertion messages now dumps a table with the index and the error of each diff. Example:: > assert [1, 2, 3, 4] == pytest.approx([1, 3, 3, 5]) E assert comparison failed for 2 values: E Index | Obtained | Expected E 1 | 2 | 3 +- 3.0e-06 E 3 | 4 | 5 +- 5.0e-06 - `8403 <https://github.com/pytest-dev/pytest/issues/8403>`_: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much, currently at ``240`` characters by default. However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using ``-v`` will now increase the truncation threshold to ``2400`` characters, and ``-vv`` or higher will disable truncation entirely. - `8509 <https://github.com/pytest-dev/pytest/issues/8509>`_: Fixed issue where :meth:`unittest.TestCase.setUpClass` is not called when a test has `/` in its name since pytest 6.2.0. This refers to the path part in pytest node IDs, e.g. ``TestClass::test_it`` in the node ID ``tests/test_file.py::TestClass::test_it``. Now, instead of assuming that the test name does not contain ``/``, it is assumed that test path does not contain ``::``. We plan to hopefully make both of these work in the future. - `8803 <https://github.com/pytest-dev/pytest/issues/8803>`_: It is now possible to add colors to custom log levels on cli log. By using :func:`add_color_level <_pytest.logging.add_color_level>` from a ``pytest_configure`` hook, colors can be added:: logging_plugin = config.pluginmanager.get_plugin('logging-plugin') logging_plugin.log_cli_handler.formatter.add_color_level(logging.INFO, 'cyan') logging_plugin.log_cli_handler.formatter.add_color_level(logging.SPAM, 'blue') See :ref:`log_colors` for more information. - `8822 <https://github.com/pytest-dev/pytest/issues/8822>`_: When showing fixture paths in `--fixtures` or `--fixtures-by-test`, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the `site-packages` directory. - `8898 <https://github.com/pytest-dev/pytest/issues/8898>`_: Complex numbers are now treated like floats and integers when generating parameterization IDs. - `9062 <https://github.com/pytest-dev/pytest/issues/9062>`_: ``--stepwise-skip`` now implicitly enables ``--stepwise`` and can be used on its own. - `9205 <https://github.com/pytest-dev/pytest/issues/9205>`_: :meth:`pytest.Cache.set` now preserves key order when saving dicts. Bug Fixes --------- - `7124 <https://github.com/pytest-dev/pytest/issues/7124>`_: Fixed an issue where ``__main__.py`` would raise an ``ImportError`` when ``--doctest-modules`` was provided. - `8061 <https://github.com/pytest-dev/pytest/issues/8061>`_: Fixed failing ``staticmethod`` test cases if they are inherited from a parent test class. - `8192 <https://github.com/pytest-dev/pytest/issues/8192>`_: ``testdir.makefile`` now silently accepts values which don't start with ``.`` to maintain backward compatibility with older pytest versions. ``pytester.makefile`` now issues a clearer error if the ``.`` is missing in the ``ext`` argument. - `8258 <https://github.com/pytest-dev/pytest/issues/8258>`_: Fixed issue where pytest's ``faulthandler`` support would not dump traceback on crashes if the :mod:`faulthandler` module was already enabled during pytest startup (using ``python -X dev -m pytest`` for example). - `8317 <https://github.com/pytest-dev/pytest/issues/8317>`_: Fixed an issue where illegal directory characters derived from ``getpass.getuser()`` raised an ``OSError``. - `8367 <https://github.com/pytest-dev/pytest/issues/8367>`_: Fix ``Class.from_parent`` so it forwards extra keyword arguments to the constructor. - `8377 <https://github.com/pytest-dev/pytest/issues/8377>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing forward slash (``/``) characters. - `8384 <https://github.com/pytest-dev/pytest/issues/8384>`_: The ``pytest.mark.skip`` decorator now correctly handles its arguments. When the ``reason`` argument is accidentally given both positional and as a keyword (e.g. because it was confused with ``skipif``), a ``TypeError`` now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally, ``reason`` is now documented correctly as positional or keyword (rather than keyword-only). - `8394 <https://github.com/pytest-dev/pytest/issues/8394>`_: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default ``--fixtures`` invocation (but they still show up with ``--fixtures -v``). - `8456 <https://github.com/pytest-dev/pytest/issues/8456>`_: The :confval:`required_plugins` config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all. - `8464 <https://github.com/pytest-dev/pytest/issues/8464>`_: ``-c <config file>`` now also properly defines ``rootdir`` as the directory that contains ``<config file>``. - `8503 <https://github.com/pytest-dev/pytest/issues/8503>`_: :meth:`pytest.MonkeyPatch.syspath_prepend` no longer fails when ``setuptools`` is not installed. It now only calls :func:`pkg_resources.fixup_namespace_packages` if ``pkg_resources`` was previously imported, because it is not needed otherwise. - `8548 <https://github.com/pytest-dev/pytest/issues/8548>`_: Introduce fix to handle precision width in ``log-cli-format`` in turn to fix output coloring for certain formats. - `8796 <https://github.com/pytest-dev/pytest/issues/8796>`_: Fixed internal error when skipping doctests. - `8983 <https://github.com/pytest-dev/pytest/issues/8983>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing backslash (`\\`) characters. Backslashes are treated literally, not as escape characters (the values being matched against are already escaped). - `8990 <https://github.com/pytest-dev/pytest/issues/8990>`_: Fix `pytest -vv` crashing with an internal exception `AttributeError: 'str' object has no attribute 'relative_to'` in some cases. - `9077 <https://github.com/pytest-dev/pytest/issues/9077>`_: Fixed confusing error message when ``request.fspath`` / ``request.path`` was accessed from a session-scoped fixture. - `9131 <https://github.com/pytest-dev/pytest/issues/9131>`_: Fixed the URL used by ``--pastebin`` to use `bpa.st <http://bpa.st>`__. - `9163 <https://github.com/pytest-dev/pytest/issues/9163>`_: The end line number and end column offset are now properly set for rewritten assert statements. - `9169 <https://github.com/pytest-dev/pytest/issues/9169>`_: Support for the ``files`` API from ``importlib.resources`` within rewritten files. - `9272 <https://github.com/pytest-dev/pytest/issues/9272>`_: The nose compatibility module-level fixtures `setup()` and `teardown()` are now only called once per module, instead of for each test function. They are now called even if object-level `setup`/`teardown` is defined. Improved Documentation ---------------------- - `4320 <https://github.com/pytest-dev/pytest/issues/4320>`_: Improved docs for `pytester.copy_example`. - `5105 <https://github.com/pytest-dev/pytest/issues/5105>`_: Add automatically generated :ref:`plugin-list`. The list is updated on a periodic schedule. - `8337 <https://github.com/pytest-dev/pytest/issues/8337>`_: Recommend `numpy.testing <https://numpy.org/doc/stable/reference/routines.testing.html>`__ module on :func:`pytest.approx` documentation. - `8655 <https://github.com/pytest-dev/pytest/issues/8655>`_: Help text for ``--pdbcls`` more accurately reflects the option's behavior. - `9210 <https://github.com/pytest-dev/pytest/issues/9210>`_: Remove incorrect docs about ``confcutdir`` being a configuration option: it can only be set through the ``--confcutdir`` command-line option. - `9242 <https://github.com/pytest-dev/pytest/issues/9242>`_: Upgrade readthedocs configuration to use a `newer Ubuntu version <https://blog.readthedocs.com/new-build-specification/>`__` with better unicode support for PDF docs. - `9341 <https://github.com/pytest-dev/pytest/issues/9341>`_: Various methods commonly used for :ref:`non-python tests` are now correctly documented in the reference docs. They were undocumented previously. Trivial/Internal Changes ------------------------ - `8133 <https://github.com/pytest-dev/pytest/issues/8133>`_: Migrate to ``setuptools_scm`` 6.x to use ``SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST`` for more robust release tooling. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to internal pytest types/functions: - The ``_pytest.code.getfslineno()`` function returns ``Path`` instead of ``py.path.local``. - The ``_pytest.python.path_matches_patterns()`` function takes ``Path`` instead of ``py.path.local``. - The ``_pytest._code.Traceback.cut()`` function accepts any ``os.PathLike[str]``, not just ``py.path.local``. - `8248 <https://github.com/pytest-dev/pytest/issues/8248>`_: Internal Restructure: let ``python.PyObjMixin`` inherit from ``nodes.Node`` to carry over typing information. - `8432 <https://github.com/pytest-dev/pytest/issues/8432>`_: Improve error message when :func:`pytest.skip` is used at module level without passing `allow_module_level=True`. - `8818 <https://github.com/pytest-dev/pytest/issues/8818>`_: Ensure ``regendoc`` opts out of ``TOX_ENV`` cachedir selection to ensure independent example test runs. - `8913 <https://github.com/pytest-dev/pytest/issues/8913>`_: The private ``CallSpec2._arg2scopenum`` attribute has been removed after an internal refactoring. - `8967 <https://github.com/pytest-dev/pytest/issues/8967>`_: 🪝`pytest_assertion_pass` is no longer considered experimental and future changes to it will be considered more carefully. - `9202 <https://github.com/pytest-dev/pytest/issues/9202>`_: Add github action to upload coverage report to codecov instead of bash uploader. - `9225 <https://github.com/pytest-dev/pytest/issues/9225>`_: Changed the command used to create sdist and wheel artifacts: using the build package instead of setup.py. - `9351 <https://github.com/pytest-dev/pytest/issues/9351>`_: Correct minor typos in doc/en/example/special.rst. ``` ### 6.2.5 ``` ========================= Trivial/Internal Changes ------------------------ - :issue:`8494`: Python 3.10 is now supported. - :issue:`9040`: Enable compatibility with ``pluggy 1.0`` or later. ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/pytest - Changelog: https://pyup.io/changelogs/pytest/ - Homepage: https://docs.pytest.org/en/latest/ </details> Co-authored-by: pyup-bot <github-bot@pyup.io>

pytest-molecule suffers from one of the [deprecations](https://docs.pytest.org/en/7.0.x/changelog.html#id20): - pytest-dev/pytest#7259 - https://docs.pytest.org/en/latest/deprecations.html#fspath-argument-for-node-constructors-replaced-with-pathlib-path - https://docs.pytest.org/en/7.0.x/deprecations.html#legacy-path-hooks-deprecated

33: Update pytest to 7.1.1 r=aragilar a=pyup-bot This PR updates [pytest](https://pypi.org/project/pytest) from **6.2.4** to **7.1.1**. <details> <summary>Changelog</summary> ### 7.1.0 ``` ========================= Breaking Changes ---------------- - `8838 <https://github.com/pytest-dev/pytest/issues/8838>`_: As per our policy, the following features have been deprecated in the 6.X series and are now removed: * ``pytest._fillfuncargs`` function. * ``pytest_warning_captured`` hook - use ``pytest_warning_recorded`` instead. * ``-k -foobar`` syntax - use ``-k 'not foobar'`` instead. * ``-k foobar:`` syntax. * ``pytest.collect`` module - import from ``pytest`` directly. For more information consult `Deprecations and Removals <https://docs.pytest.org/en/latest/deprecations.html>`__ in the docs. - `9437 <https://github.com/pytest-dev/pytest/issues/9437>`_: Dropped support for Python 3.6, which reached `end-of-life <https://devguide.python.org/#status-of-python-branches>`__ at 2021-12-23. Improvements ------------ - `5192 <https://github.com/pytest-dev/pytest/issues/5192>`_: Fixed test output for some data types where ``-v`` would show less information. Also, when showing diffs for sequences, ``-q`` would produce full diffs instead of the expected diff. - `9362 <https://github.com/pytest-dev/pytest/issues/9362>`_: pytest now avoids specialized assert formatting when it is detected that the default ``__eq__`` is overridden in ``attrs`` or ``dataclasses``. - `9536 <https://github.com/pytest-dev/pytest/issues/9536>`_: When ``-vv`` is given on command line, show skipping and xfail reasons in full instead of truncating them to fit the terminal width. - `9644 <https://github.com/pytest-dev/pytest/issues/9644>`_: More information about the location of resources that led Python to raise :class:`ResourceWarning` can now be obtained by enabling :mod:`tracemalloc`. See :ref:`resource-warnings` for more information. - `9678 <https://github.com/pytest-dev/pytest/issues/9678>`_: More types are now accepted in the ``ids`` argument to ``pytest.mark.parametrize``. Previously only `str`, `float`, `int` and `bool` were accepted; now `bytes`, `complex`, `re.Pattern`, `Enum` and anything with a `__name__` are also accepted. - `9692 <https://github.com/pytest-dev/pytest/issues/9692>`_: :func:`pytest.approx` now raises a :class:`TypeError` when given an unordered sequence (such as :class:`set`). Note that this implies that custom classes which only implement ``__iter__`` and ``__len__`` are no longer supported as they don't guarantee order. Bug Fixes --------- - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: The deprecation of raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is reverted - this is now a supported feature again. - `9493 <https://github.com/pytest-dev/pytest/issues/9493>`_: Symbolic link components are no longer resolved in conftest paths. This means that if a conftest appears twice in collection tree, using symlinks, it will be executed twice. For example, given tests/real/conftest.py tests/real/test_it.py tests/link -> tests/real running ``pytest tests`` now imports the conftest twice, once as ``tests/real/conftest.py`` and once as ``tests/link/conftest.py``. This is a fix to match a similar change made to test collection itself in pytest 6.0 (see :pull:`6523` for details). - `9626 <https://github.com/pytest-dev/pytest/issues/9626>`_: Fixed count of selected tests on terminal collection summary when there were errors or skipped modules. If there were errors or skipped modules on collection, pytest would mistakenly subtract those from the selected count. - `9645 <https://github.com/pytest-dev/pytest/issues/9645>`_: Fixed regression where ``--import-mode=importlib`` used together with :envvar:`PYTHONPATH` or :confval:`pythonpath` would cause import errors in test suites. - `9708 <https://github.com/pytest-dev/pytest/issues/9708>`_: :fixture:`pytester` now requests a :fixture:`monkeypatch` fixture instead of creating one internally. This solves some issues with tests that involve pytest environment variables. - `9730 <https://github.com/pytest-dev/pytest/issues/9730>`_: Malformed ``pyproject.toml`` files now produce a clearer error message. ``` ### 7.0.1 ``` ========================= Bug Fixes --------- - `9608 <https://github.com/pytest-dev/pytest/issues/9608>`_: Fix invalid importing of ``importlib.readers`` in Python 3.9. - `9610 <https://github.com/pytest-dev/pytest/issues/9610>`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method. Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`. Regressed in pytest 7.0.0. - `9636 <https://github.com/pytest-dev/pytest/issues/9636>`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin. - `9642 <https://github.com/pytest-dev/pytest/issues/9642>`_: Fix running tests by id with ``::`` in the parametrize portion. - `9643 <https://github.com/pytest-dev/pytest/issues/9643>`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters <warnings>`. ``` ### 7.0.0 ``` ========================= (**Please see the full set of changes for this release also in the 7.0.0rc1 notes below**) Deprecations ------------ - `9488 <https://github.com/pytest-dev/pytest/issues/9488>`_: If custom subclasses of nodes like :class:`pytest.Item` override the ``__init__`` method, they should take ``**kwargs``. See :ref:`uncooperative-constructors-deprecated` for details. Note that a deprection warning is only emitted when there is a conflict in the arguments pytest expected to pass. This deprecation was already part of pytest 7.0.0rc1 but wasn't documented. Bug Fixes --------- - `9355 <https://github.com/pytest-dev/pytest/issues/9355>`_: Fixed error message prints function decorators when using assert in Python 3.8 and above. - `9396 <https://github.com/pytest-dev/pytest/issues/9396>`_: Ensure :attr:`pytest.Config.inifile` is available during the :func:`pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>` hook (regression during ``7.0.0rc1``). Improved Documentation ---------------------- - `9404 <https://github.com/pytest-dev/pytest/issues/9404>`_: Added extra documentation on alternatives to common misuses of `pytest.warns(None)` ahead of its deprecation. - `9505 <https://github.com/pytest-dev/pytest/issues/9505>`_: Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository. Trivial/Internal Changes ------------------------ - `9521 <https://github.com/pytest-dev/pytest/issues/9521>`_: Add test coverage to assertion rewrite path. ``` ### 7.0.0rc1 ``` ============================ Breaking Changes ---------------- - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: The :ref:`Node.reportinfo() <non-python tests>` function first return value type has been expanded from `py.path.local | str` to `os.PathLike[str] | str`. Most plugins which refer to `reportinfo()` only define it as part of a custom :class:`pytest.Item` implementation. 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. - `8246 <https://github.com/pytest-dev/pytest/issues/8246>`_: ``--version`` now writes version information to ``stdout`` rather than ``stderr``. - `8733 <https://github.com/pytest-dev/pytest/issues/8733>`_: Drop a workaround for `pyreadline <https://github.com/pyreadline/pyreadline>`__ that made it work with ``--pdb``. The workaround was introduced in `1281 <https://github.com/pytest-dev/pytest/pull/1281>`__ in 2015, however since then `pyreadline seems to have gone unmaintained <https://github.com/pyreadline/pyreadline/issues/58>`__, is `generating warnings <https://github.com/pytest-dev/pytest/issues/8847>`__, and will stop working on Python 3.10. - `9061 <https://github.com/pytest-dev/pytest/issues/9061>`_: Using :func:`pytest.approx` in a boolean context now raises an error hinting at the proper usage. It is apparently common for users to mistakenly use ``pytest.approx`` like this: .. code-block:: python assert pytest.approx(actual, expected) While the correct usage is: .. code-block:: python assert actual == pytest.approx(expected) The new error message helps catch those mistakes. - `9277 <https://github.com/pytest-dev/pytest/issues/9277>`_: The ``pytest.Instance`` collector type has been removed. Importing ``pytest.Instance`` or ``_pytest.python.Instance`` returns a dummy type and emits a deprecation warning. See :ref:`instance-collector-deprecation` for details. - `9308 <https://github.com/pytest-dev/pytest/issues/9308>`_: **PytestRemovedIn7Warning deprecation warnings are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type ``PytestRemovedIn7Warning`` now generate errors instead of warning messages by default. **The affected features will be effectively removed in pytest 7.1**, so please consult the :ref:`deprecations` section in the docs for directions on how to update existing code. In the pytest ``7.0.X`` series, it is possible to change the errors back into warnings as a stopgap measure by adding this to your ``pytest.ini`` file: .. code-block:: ini [pytest] filterwarnings = ignore::pytest.PytestRemovedIn7Warning But this will stop working when pytest ``7.1`` is released. **If you have concerns** about the removal of a specific feature, please add a comment to :issue:`9308`. Deprecations ------------ - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: ``py.path.local`` arguments for hooks have been deprecated. See :ref:`the deprecation note <legacy-path-hooks-deprecated>` for full details. ``py.path.local`` arguments to Node constructors have been deprecated. See :ref:`the deprecation note <node-ctor-fspath-deprecation>` for full details. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: 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. - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: Raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is deprecated. Use :func:`pytest.skip` instead. Note: This deprecation only relates to using :class:`unittest.SkipTest` during test 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. .. note:: This deprecation has been reverted in pytest 7.1.0. - `8315 <https://github.com/pytest-dev/pytest/issues/8315>`_: Several behaviors of :meth:`Parser.addoption <pytest.Parser.addoption>` are now 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. - `8447 <https://github.com/pytest-dev/pytest/issues/8447>`_: Defining a custom pytest node type which is both an :class:`pytest.Item <Item>` and a :class:`pytest.Collector <Collector>` (e.g. :class:`pytest.File <File>`) now issues a warning. It was never sanely supported and triggers hard to debug errors. See :ref:`the deprecation note <diamond-inheritance-deprecated>` for full details. - `8592 <https://github.com/pytest-dev/pytest/issues/8592>`_: 🪝`pytest_cmdline_preparse` has been officially deprecated. It will be removed in a future release. Use 🪝`pytest_load_initial_conftests` instead. See :ref:`the deprecation note <cmdline-preparse-deprecated>` for full details. - `8645 <https://github.com/pytest-dev/pytest/issues/8645>`_: :func:`pytest.warns(None) <pytest.warns>` 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)``. - `8948 <https://github.com/pytest-dev/pytest/issues/8948>`_: :func:`pytest.skip(msg=...) <pytest.skip>`, :func:`pytest.fail(msg=...) <pytest.fail>` and :func:`pytest.exit(msg=...) <pytest.exit>` signatures now accept a ``reason`` argument instead of ``msg``. Using ``msg`` still works, but is deprecated and will be removed in a future release. This was changed for consistency with :func:`pytest.mark.skip <pytest.mark.skip>` and :func:`pytest.mark.xfail <pytest.mark.xfail>` which both accept ``reason`` as an argument. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to types reachable through :attr:`pytest.ExceptionInfo.traceback`: - The ``path`` property of ``_pytest.code.Code`` returns ``Path`` instead of ``py.path.local``. - The ``path`` property of ``_pytest.code.TracebackEntry`` returns ``Path`` instead of ``py.path.local``. There was no deprecation period for this change (sorry!). Features -------- - `5196 <https://github.com/pytest-dev/pytest/issues/5196>`_: Tests are now ordered by definition order in more cases. In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order). - `7132 <https://github.com/pytest-dev/pytest/issues/7132>`_: Added two environment variables :envvar:`PYTEST_THEME` and :envvar:`PYTEST_THEME_MODE` to let the users customize the pygments theme used. - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: Added :meth:`cache.mkdir() <pytest.Cache.mkdir>`, which is similar to the existing :meth:`cache.makedir() <pytest.Cache.makedir>`, but returns a :class:`pathlib.Path` instead of a legacy ``py.path.local``. Added a ``paths`` type to :meth:`parser.addini() <pytest.Parser.addini>`, as in ``parser.addini("mypaths", "my paths", type="paths")``, which is similar to the existing ``pathlist``, but returns a list of :class:`pathlib.Path` instead of legacy ``py.path.local``. - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: The types of objects used in pytest's API are now exported so they may be used in type annotations. The newly-exported types are: - ``pytest.Config`` for :class:`Config <pytest.Config>`. - ``pytest.Mark`` for :class:`marks <pytest.Mark>`. - ``pytest.MarkDecorator`` for :class:`mark decorators <pytest.MarkDecorator>`. - ``pytest.MarkGenerator`` for the :class:`pytest.mark <pytest.MarkGenerator>` singleton. - ``pytest.Metafunc`` for the :class:`metafunc <pytest.MarkGenerator>` argument to the 🪝`pytest_generate_tests` hook. - ``pytest.CallInfo`` for the :class:`CallInfo <pytest.CallInfo>` type passed to various hooks. - ``pytest.PytestPluginManager`` for :class:`PytestPluginManager <pytest.PytestPluginManager>`. - ``pytest.ExceptionInfo`` for the :class:`ExceptionInfo <pytest.ExceptionInfo>` type returned from :func:`pytest.raises` and passed to various hooks. - ``pytest.Parser`` for the :class:`Parser <pytest.Parser>` type passed to the 🪝`pytest_addoption` hook. - ``pytest.OptionGroup`` for the :class:`OptionGroup <pytest.OptionGroup>` type returned from the :func:`parser.addgroup <pytest.Parser.getgroup>` method. - ``pytest.HookRecorder`` for the :class:`HookRecorder <pytest.HookRecorder>` type returned from :class:`~pytest.Pytester`. - ``pytest.RecordedHookCall`` for the :class:`RecordedHookCall <pytest.HookRecorder>` type returned from :class:`~pytest.HookRecorder`. - ``pytest.RunResult`` for the :class:`RunResult <pytest.RunResult>` type returned from :class:`~pytest.Pytester`. - ``pytest.LineMatcher`` for the :class:`LineMatcher <pytest.RunResult>` type used in :class:`~pytest.RunResult` and others. - ``pytest.TestReport`` for the :class:`TestReport <pytest.TestReport>` type used in various hooks. - ``pytest.CollectReport`` for the :class:`CollectReport <pytest.CollectReport>` type used in various hooks. Constructing most of them directly is not supported; they are only meant for use in type annotations. Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0. Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy. - `7856 <https://github.com/pytest-dev/pytest/issues/7856>`_: :ref:`--import-mode=importlib <import-modes>` now works with features that depend on modules being on :py:data:`sys.modules`, such as :mod:`pickle` and :mod:`dataclasses`. - `8144 <https://github.com/pytest-dev/pytest/issues/8144>`_: The following hooks now receive an additional ``pathlib.Path`` argument, equivalent to an existing ``py.path.local`` argument: - 🪝`pytest_ignore_collect` - The ``collection_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_collect_file` - The ``file_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_pycollect_makemodule` - The ``module_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_report_header` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). - 🪝`pytest_report_collectionfinish` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8251 <https://github.com/pytest-dev/pytest/issues/8251>`_: Implement ``Node.path`` as a ``pathlib.Path``. Both the old ``fspath`` and this new attribute gets set no matter whether ``path`` or ``fspath`` (deprecated) is passed to the constructor. It is a replacement for the ``fspath`` attribute (which represents the same path as ``py.path.local``). While ``fspath`` is not deprecated yet due to the ongoing migration of methods like :meth:`~_pytest.Item.reportinfo`, we expect to deprecate it in a future release. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8421 <https://github.com/pytest-dev/pytest/issues/8421>`_: :func:`pytest.approx` now works on :class:`~decimal.Decimal` within mappings/dicts and sequences/lists. - `8606 <https://github.com/pytest-dev/pytest/issues/8606>`_: pytest invocations with ``--fixtures-per-test`` and ``--fixtures`` have been enriched with: - Fixture location path printed with the fixture name. - First section of the fixture's docstring printed under the fixture name. - Whole of fixture's docstring printed under the fixture name using ``--verbose`` option. - `8761 <https://github.com/pytest-dev/pytest/issues/8761>`_: New :ref:`version-tuple` attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions). - `8789 <https://github.com/pytest-dev/pytest/issues/8789>`_: Switch TOML parser from ``toml`` to ``tomli`` for TOML v1.0.0 support in ``pyproject.toml``. - `8920 <https://github.com/pytest-dev/pytest/issues/8920>`_: Added :class:`pytest.Stash`, a facility for plugins to store their data on :class:`~pytest.Config` and :class:`~_pytest.nodes.Node`\s in a type-safe and conflict-free manner. See :ref:`plugin-stash` for details. - `8953 <https://github.com/pytest-dev/pytest/issues/8953>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``warnings`` argument to assert the total number of warnings captured. - `8954 <https://github.com/pytest-dev/pytest/issues/8954>`_: ``--debug`` flag now accepts a :class:`str` file to route debug logs into, remains defaulted to `pytestdebug.log`. - `9023 <https://github.com/pytest-dev/pytest/issues/9023>`_: Full diffs are now always shown for equality assertions of iterables when `CI` or ``BUILD_NUMBER`` is found in the environment, even when ``-v`` isn't used. - `9113 <https://github.com/pytest-dev/pytest/issues/9113>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``deselected`` argument to assert the total number of deselected tests. - `9114 <https://github.com/pytest-dev/pytest/issues/9114>`_: Added :confval:`pythonpath` setting that adds listed paths to :data:`sys.path` for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in `pythonpath` setting. Improvements ------------ - `7480 <https://github.com/pytest-dev/pytest/issues/7480>`_: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category `PytestRemovedInXWarning`, a subclass of :class:`~pytest.PytestDeprecationWarning`, instead of :class:`PytestDeprecationWarning` directly. See :ref:`backwards-compatibility` for more details. - `7864 <https://github.com/pytest-dev/pytest/issues/7864>`_: Improved error messages when parsing warning filters. Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause of the problem (for example an ``ImportError`` while importing a specific warning type). - `8335 <https://github.com/pytest-dev/pytest/issues/8335>`_: Improved :func:`pytest.approx` assertion messages for sequences of numbers. The assertion messages now dumps a table with the index and the error of each diff. Example:: > assert [1, 2, 3, 4] == pytest.approx([1, 3, 3, 5]) E assert comparison failed for 2 values: E Index | Obtained | Expected E 1 | 2 | 3 +- 3.0e-06 E 3 | 4 | 5 +- 5.0e-06 - `8403 <https://github.com/pytest-dev/pytest/issues/8403>`_: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much, currently at ``240`` characters by default. However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using ``-v`` will now increase the truncation threshold to ``2400`` characters, and ``-vv`` or higher will disable truncation entirely. - `8509 <https://github.com/pytest-dev/pytest/issues/8509>`_: Fixed issue where :meth:`unittest.TestCase.setUpClass` is not called when a test has `/` in its name since pytest 6.2.0. This refers to the path part in pytest node IDs, e.g. ``TestClass::test_it`` in the node ID ``tests/test_file.py::TestClass::test_it``. Now, instead of assuming that the test name does not contain ``/``, it is assumed that test path does not contain ``::``. We plan to hopefully make both of these work in the future. - `8803 <https://github.com/pytest-dev/pytest/issues/8803>`_: It is now possible to add colors to custom log levels on cli log. By using :func:`add_color_level <_pytest.logging.add_color_level>` from a ``pytest_configure`` hook, colors can be added:: logging_plugin = config.pluginmanager.get_plugin('logging-plugin') logging_plugin.log_cli_handler.formatter.add_color_level(logging.INFO, 'cyan') logging_plugin.log_cli_handler.formatter.add_color_level(logging.SPAM, 'blue') See :ref:`log_colors` for more information. - `8822 <https://github.com/pytest-dev/pytest/issues/8822>`_: When showing fixture paths in `--fixtures` or `--fixtures-by-test`, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the `site-packages` directory. - `8898 <https://github.com/pytest-dev/pytest/issues/8898>`_: Complex numbers are now treated like floats and integers when generating parameterization IDs. - `9062 <https://github.com/pytest-dev/pytest/issues/9062>`_: ``--stepwise-skip`` now implicitly enables ``--stepwise`` and can be used on its own. - `9205 <https://github.com/pytest-dev/pytest/issues/9205>`_: :meth:`pytest.Cache.set` now preserves key order when saving dicts. Bug Fixes --------- - `7124 <https://github.com/pytest-dev/pytest/issues/7124>`_: Fixed an issue where ``__main__.py`` would raise an ``ImportError`` when ``--doctest-modules`` was provided. - `8061 <https://github.com/pytest-dev/pytest/issues/8061>`_: Fixed failing ``staticmethod`` test cases if they are inherited from a parent test class. - `8192 <https://github.com/pytest-dev/pytest/issues/8192>`_: ``testdir.makefile`` now silently accepts values which don't start with ``.`` to maintain backward compatibility with older pytest versions. ``pytester.makefile`` now issues a clearer error if the ``.`` is missing in the ``ext`` argument. - `8258 <https://github.com/pytest-dev/pytest/issues/8258>`_: Fixed issue where pytest's ``faulthandler`` support would not dump traceback on crashes if the :mod:`faulthandler` module was already enabled during pytest startup (using ``python -X dev -m pytest`` for example). - `8317 <https://github.com/pytest-dev/pytest/issues/8317>`_: Fixed an issue where illegal directory characters derived from ``getpass.getuser()`` raised an ``OSError``. - `8367 <https://github.com/pytest-dev/pytest/issues/8367>`_: Fix ``Class.from_parent`` so it forwards extra keyword arguments to the constructor. - `8377 <https://github.com/pytest-dev/pytest/issues/8377>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing forward slash (``/``) characters. - `8384 <https://github.com/pytest-dev/pytest/issues/8384>`_: The ``pytest.mark.skip`` decorator now correctly handles its arguments. When the ``reason`` argument is accidentally given both positional and as a keyword (e.g. because it was confused with ``skipif``), a ``TypeError`` now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally, ``reason`` is now documented correctly as positional or keyword (rather than keyword-only). - `8394 <https://github.com/pytest-dev/pytest/issues/8394>`_: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default ``--fixtures`` invocation (but they still show up with ``--fixtures -v``). - `8456 <https://github.com/pytest-dev/pytest/issues/8456>`_: The :confval:`required_plugins` config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all. - `8464 <https://github.com/pytest-dev/pytest/issues/8464>`_: ``-c <config file>`` now also properly defines ``rootdir`` as the directory that contains ``<config file>``. - `8503 <https://github.com/pytest-dev/pytest/issues/8503>`_: :meth:`pytest.MonkeyPatch.syspath_prepend` no longer fails when ``setuptools`` is not installed. It now only calls :func:`pkg_resources.fixup_namespace_packages` if ``pkg_resources`` was previously imported, because it is not needed otherwise. - `8548 <https://github.com/pytest-dev/pytest/issues/8548>`_: Introduce fix to handle precision width in ``log-cli-format`` in turn to fix output coloring for certain formats. - `8796 <https://github.com/pytest-dev/pytest/issues/8796>`_: Fixed internal error when skipping doctests. - `8983 <https://github.com/pytest-dev/pytest/issues/8983>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing backslash (`\\`) characters. Backslashes are treated literally, not as escape characters (the values being matched against are already escaped). - `8990 <https://github.com/pytest-dev/pytest/issues/8990>`_: Fix `pytest -vv` crashing with an internal exception `AttributeError: 'str' object has no attribute 'relative_to'` in some cases. - `9077 <https://github.com/pytest-dev/pytest/issues/9077>`_: Fixed confusing error message when ``request.fspath`` / ``request.path`` was accessed from a session-scoped fixture. - `9131 <https://github.com/pytest-dev/pytest/issues/9131>`_: Fixed the URL used by ``--pastebin`` to use `bpa.st <http://bpa.st>`__. - `9163 <https://github.com/pytest-dev/pytest/issues/9163>`_: The end line number and end column offset are now properly set for rewritten assert statements. - `9169 <https://github.com/pytest-dev/pytest/issues/9169>`_: Support for the ``files`` API from ``importlib.resources`` within rewritten files. - `9272 <https://github.com/pytest-dev/pytest/issues/9272>`_: The nose compatibility module-level fixtures `setup()` and `teardown()` are now only called once per module, instead of for each test function. They are now called even if object-level `setup`/`teardown` is defined. Improved Documentation ---------------------- - `4320 <https://github.com/pytest-dev/pytest/issues/4320>`_: Improved docs for `pytester.copy_example`. - `5105 <https://github.com/pytest-dev/pytest/issues/5105>`_: Add automatically generated :ref:`plugin-list`. The list is updated on a periodic schedule. - `8337 <https://github.com/pytest-dev/pytest/issues/8337>`_: Recommend `numpy.testing <https://numpy.org/doc/stable/reference/routines.testing.html>`__ module on :func:`pytest.approx` documentation. - `8655 <https://github.com/pytest-dev/pytest/issues/8655>`_: Help text for ``--pdbcls`` more accurately reflects the option's behavior. - `9210 <https://github.com/pytest-dev/pytest/issues/9210>`_: Remove incorrect docs about ``confcutdir`` being a configuration option: it can only be set through the ``--confcutdir`` command-line option. - `9242 <https://github.com/pytest-dev/pytest/issues/9242>`_: Upgrade readthedocs configuration to use a `newer Ubuntu version <https://blog.readthedocs.com/new-build-specification/>`__` with better unicode support for PDF docs. - `9341 <https://github.com/pytest-dev/pytest/issues/9341>`_: Various methods commonly used for :ref:`non-python tests` are now correctly documented in the reference docs. They were undocumented previously. Trivial/Internal Changes ------------------------ - `8133 <https://github.com/pytest-dev/pytest/issues/8133>`_: Migrate to ``setuptools_scm`` 6.x to use ``SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST`` for more robust release tooling. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to internal pytest types/functions: - The ``_pytest.code.getfslineno()`` function returns ``Path`` instead of ``py.path.local``. - The ``_pytest.python.path_matches_patterns()`` function takes ``Path`` instead of ``py.path.local``. - The ``_pytest._code.Traceback.cut()`` function accepts any ``os.PathLike[str]``, not just ``py.path.local``. - `8248 <https://github.com/pytest-dev/pytest/issues/8248>`_: Internal Restructure: let ``python.PyObjMixin`` inherit from ``nodes.Node`` to carry over typing information. - `8432 <https://github.com/pytest-dev/pytest/issues/8432>`_: Improve error message when :func:`pytest.skip` is used at module level without passing `allow_module_level=True`. - `8818 <https://github.com/pytest-dev/pytest/issues/8818>`_: Ensure ``regendoc`` opts out of ``TOX_ENV`` cachedir selection to ensure independent example test runs. - `8913 <https://github.com/pytest-dev/pytest/issues/8913>`_: The private ``CallSpec2._arg2scopenum`` attribute has been removed after an internal refactoring. - `8967 <https://github.com/pytest-dev/pytest/issues/8967>`_: 🪝`pytest_assertion_pass` is no longer considered experimental and future changes to it will be considered more carefully. - `9202 <https://github.com/pytest-dev/pytest/issues/9202>`_: Add github action to upload coverage report to codecov instead of bash uploader. - `9225 <https://github.com/pytest-dev/pytest/issues/9225>`_: Changed the command used to create sdist and wheel artifacts: using the build package instead of setup.py. - `9351 <https://github.com/pytest-dev/pytest/issues/9351>`_: Correct minor typos in doc/en/example/special.rst. ``` ### 6.2.5 ``` ========================= Trivial/Internal Changes ------------------------ - :issue:`8494`: Python 3.10 is now supported. - :issue:`9040`: Enable compatibility with ``pluggy 1.0`` or later. ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/pytest - Changelog: https://pyup.io/changelogs/pytest/ - Homepage: https://docs.pytest.org/en/latest/ </details> 34: Disable fstring suggestions for now r=aragilar a=aragilar Co-authored-by: pyup-bot <github-bot@pyup.io> Co-authored-by: James Tocknell <aragilar@gmail.com>

29: Update pytest to 7.1.1 r=aragilar a=pyup-bot This PR updates [pytest](https://pypi.org/project/pytest) from **6.2.4** to **7.1.1**. <details> <summary>Changelog</summary> ### 7.1.0 ``` ========================= Breaking Changes ---------------- - `8838 <https://github.com/pytest-dev/pytest/issues/8838>`_: As per our policy, the following features have been deprecated in the 6.X series and are now removed: * ``pytest._fillfuncargs`` function. * ``pytest_warning_captured`` hook - use ``pytest_warning_recorded`` instead. * ``-k -foobar`` syntax - use ``-k 'not foobar'`` instead. * ``-k foobar:`` syntax. * ``pytest.collect`` module - import from ``pytest`` directly. For more information consult `Deprecations and Removals <https://docs.pytest.org/en/latest/deprecations.html>`__ in the docs. - `9437 <https://github.com/pytest-dev/pytest/issues/9437>`_: Dropped support for Python 3.6, which reached `end-of-life <https://devguide.python.org/#status-of-python-branches>`__ at 2021-12-23. Improvements ------------ - `5192 <https://github.com/pytest-dev/pytest/issues/5192>`_: Fixed test output for some data types where ``-v`` would show less information. Also, when showing diffs for sequences, ``-q`` would produce full diffs instead of the expected diff. - `9362 <https://github.com/pytest-dev/pytest/issues/9362>`_: pytest now avoids specialized assert formatting when it is detected that the default ``__eq__`` is overridden in ``attrs`` or ``dataclasses``. - `9536 <https://github.com/pytest-dev/pytest/issues/9536>`_: When ``-vv`` is given on command line, show skipping and xfail reasons in full instead of truncating them to fit the terminal width. - `9644 <https://github.com/pytest-dev/pytest/issues/9644>`_: More information about the location of resources that led Python to raise :class:`ResourceWarning` can now be obtained by enabling :mod:`tracemalloc`. See :ref:`resource-warnings` for more information. - `9678 <https://github.com/pytest-dev/pytest/issues/9678>`_: More types are now accepted in the ``ids`` argument to ``pytest.mark.parametrize``. Previously only `str`, `float`, `int` and `bool` were accepted; now `bytes`, `complex`, `re.Pattern`, `Enum` and anything with a `__name__` are also accepted. - `9692 <https://github.com/pytest-dev/pytest/issues/9692>`_: :func:`pytest.approx` now raises a :class:`TypeError` when given an unordered sequence (such as :class:`set`). Note that this implies that custom classes which only implement ``__iter__`` and ``__len__`` are no longer supported as they don't guarantee order. Bug Fixes --------- - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: The deprecation of raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is reverted - this is now a supported feature again. - `9493 <https://github.com/pytest-dev/pytest/issues/9493>`_: Symbolic link components are no longer resolved in conftest paths. This means that if a conftest appears twice in collection tree, using symlinks, it will be executed twice. For example, given tests/real/conftest.py tests/real/test_it.py tests/link -> tests/real running ``pytest tests`` now imports the conftest twice, once as ``tests/real/conftest.py`` and once as ``tests/link/conftest.py``. This is a fix to match a similar change made to test collection itself in pytest 6.0 (see :pull:`6523` for details). - `9626 <https://github.com/pytest-dev/pytest/issues/9626>`_: Fixed count of selected tests on terminal collection summary when there were errors or skipped modules. If there were errors or skipped modules on collection, pytest would mistakenly subtract those from the selected count. - `9645 <https://github.com/pytest-dev/pytest/issues/9645>`_: Fixed regression where ``--import-mode=importlib`` used together with :envvar:`PYTHONPATH` or :confval:`pythonpath` would cause import errors in test suites. - `9708 <https://github.com/pytest-dev/pytest/issues/9708>`_: :fixture:`pytester` now requests a :fixture:`monkeypatch` fixture instead of creating one internally. This solves some issues with tests that involve pytest environment variables. - `9730 <https://github.com/pytest-dev/pytest/issues/9730>`_: Malformed ``pyproject.toml`` files now produce a clearer error message. ``` ### 7.0.1 ``` ========================= Bug Fixes --------- - `9608 <https://github.com/pytest-dev/pytest/issues/9608>`_: Fix invalid importing of ``importlib.readers`` in Python 3.9. - `9610 <https://github.com/pytest-dev/pytest/issues/9610>`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method. Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`. Regressed in pytest 7.0.0. - `9636 <https://github.com/pytest-dev/pytest/issues/9636>`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin. - `9642 <https://github.com/pytest-dev/pytest/issues/9642>`_: Fix running tests by id with ``::`` in the parametrize portion. - `9643 <https://github.com/pytest-dev/pytest/issues/9643>`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters <warnings>`. ``` ### 7.0.0 ``` ========================= (**Please see the full set of changes for this release also in the 7.0.0rc1 notes below**) Deprecations ------------ - `9488 <https://github.com/pytest-dev/pytest/issues/9488>`_: If custom subclasses of nodes like :class:`pytest.Item` override the ``__init__`` method, they should take ``**kwargs``. See :ref:`uncooperative-constructors-deprecated` for details. Note that a deprection warning is only emitted when there is a conflict in the arguments pytest expected to pass. This deprecation was already part of pytest 7.0.0rc1 but wasn't documented. Bug Fixes --------- - `9355 <https://github.com/pytest-dev/pytest/issues/9355>`_: Fixed error message prints function decorators when using assert in Python 3.8 and above. - `9396 <https://github.com/pytest-dev/pytest/issues/9396>`_: Ensure :attr:`pytest.Config.inifile` is available during the :func:`pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>` hook (regression during ``7.0.0rc1``). Improved Documentation ---------------------- - `9404 <https://github.com/pytest-dev/pytest/issues/9404>`_: Added extra documentation on alternatives to common misuses of `pytest.warns(None)` ahead of its deprecation. - `9505 <https://github.com/pytest-dev/pytest/issues/9505>`_: Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository. Trivial/Internal Changes ------------------------ - `9521 <https://github.com/pytest-dev/pytest/issues/9521>`_: Add test coverage to assertion rewrite path. ``` ### 7.0.0rc1 ``` ============================ Breaking Changes ---------------- - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: The :ref:`Node.reportinfo() <non-python tests>` function first return value type has been expanded from `py.path.local | str` to `os.PathLike[str] | str`. Most plugins which refer to `reportinfo()` only define it as part of a custom :class:`pytest.Item` implementation. 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. - `8246 <https://github.com/pytest-dev/pytest/issues/8246>`_: ``--version`` now writes version information to ``stdout`` rather than ``stderr``. - `8733 <https://github.com/pytest-dev/pytest/issues/8733>`_: Drop a workaround for `pyreadline <https://github.com/pyreadline/pyreadline>`__ that made it work with ``--pdb``. The workaround was introduced in `1281 <https://github.com/pytest-dev/pytest/pull/1281>`__ in 2015, however since then `pyreadline seems to have gone unmaintained <https://github.com/pyreadline/pyreadline/issues/58>`__, is `generating warnings <https://github.com/pytest-dev/pytest/issues/8847>`__, and will stop working on Python 3.10. - `9061 <https://github.com/pytest-dev/pytest/issues/9061>`_: Using :func:`pytest.approx` in a boolean context now raises an error hinting at the proper usage. It is apparently common for users to mistakenly use ``pytest.approx`` like this: .. code-block:: python assert pytest.approx(actual, expected) While the correct usage is: .. code-block:: python assert actual == pytest.approx(expected) The new error message helps catch those mistakes. - `9277 <https://github.com/pytest-dev/pytest/issues/9277>`_: The ``pytest.Instance`` collector type has been removed. Importing ``pytest.Instance`` or ``_pytest.python.Instance`` returns a dummy type and emits a deprecation warning. See :ref:`instance-collector-deprecation` for details. - `9308 <https://github.com/pytest-dev/pytest/issues/9308>`_: **PytestRemovedIn7Warning deprecation warnings are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type ``PytestRemovedIn7Warning`` now generate errors instead of warning messages by default. **The affected features will be effectively removed in pytest 7.1**, so please consult the :ref:`deprecations` section in the docs for directions on how to update existing code. In the pytest ``7.0.X`` series, it is possible to change the errors back into warnings as a stopgap measure by adding this to your ``pytest.ini`` file: .. code-block:: ini [pytest] filterwarnings = ignore::pytest.PytestRemovedIn7Warning But this will stop working when pytest ``7.1`` is released. **If you have concerns** about the removal of a specific feature, please add a comment to :issue:`9308`. Deprecations ------------ - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: ``py.path.local`` arguments for hooks have been deprecated. See :ref:`the deprecation note <legacy-path-hooks-deprecated>` for full details. ``py.path.local`` arguments to Node constructors have been deprecated. See :ref:`the deprecation note <node-ctor-fspath-deprecation>` for full details. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: 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. - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: Raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is deprecated. Use :func:`pytest.skip` instead. Note: This deprecation only relates to using :class:`unittest.SkipTest` during test 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. .. note:: This deprecation has been reverted in pytest 7.1.0. - `8315 <https://github.com/pytest-dev/pytest/issues/8315>`_: Several behaviors of :meth:`Parser.addoption <pytest.Parser.addoption>` are now 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. - `8447 <https://github.com/pytest-dev/pytest/issues/8447>`_: Defining a custom pytest node type which is both an :class:`pytest.Item <Item>` and a :class:`pytest.Collector <Collector>` (e.g. :class:`pytest.File <File>`) now issues a warning. It was never sanely supported and triggers hard to debug errors. See :ref:`the deprecation note <diamond-inheritance-deprecated>` for full details. - `8592 <https://github.com/pytest-dev/pytest/issues/8592>`_: 🪝`pytest_cmdline_preparse` has been officially deprecated. It will be removed in a future release. Use 🪝`pytest_load_initial_conftests` instead. See :ref:`the deprecation note <cmdline-preparse-deprecated>` for full details. - `8645 <https://github.com/pytest-dev/pytest/issues/8645>`_: :func:`pytest.warns(None) <pytest.warns>` 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)``. - `8948 <https://github.com/pytest-dev/pytest/issues/8948>`_: :func:`pytest.skip(msg=...) <pytest.skip>`, :func:`pytest.fail(msg=...) <pytest.fail>` and :func:`pytest.exit(msg=...) <pytest.exit>` signatures now accept a ``reason`` argument instead of ``msg``. Using ``msg`` still works, but is deprecated and will be removed in a future release. This was changed for consistency with :func:`pytest.mark.skip <pytest.mark.skip>` and :func:`pytest.mark.xfail <pytest.mark.xfail>` which both accept ``reason`` as an argument. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to types reachable through :attr:`pytest.ExceptionInfo.traceback`: - The ``path`` property of ``_pytest.code.Code`` returns ``Path`` instead of ``py.path.local``. - The ``path`` property of ``_pytest.code.TracebackEntry`` returns ``Path`` instead of ``py.path.local``. There was no deprecation period for this change (sorry!). Features -------- - `5196 <https://github.com/pytest-dev/pytest/issues/5196>`_: Tests are now ordered by definition order in more cases. In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order). - `7132 <https://github.com/pytest-dev/pytest/issues/7132>`_: Added two environment variables :envvar:`PYTEST_THEME` and :envvar:`PYTEST_THEME_MODE` to let the users customize the pygments theme used. - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: Added :meth:`cache.mkdir() <pytest.Cache.mkdir>`, which is similar to the existing :meth:`cache.makedir() <pytest.Cache.makedir>`, but returns a :class:`pathlib.Path` instead of a legacy ``py.path.local``. Added a ``paths`` type to :meth:`parser.addini() <pytest.Parser.addini>`, as in ``parser.addini("mypaths", "my paths", type="paths")``, which is similar to the existing ``pathlist``, but returns a list of :class:`pathlib.Path` instead of legacy ``py.path.local``. - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: The types of objects used in pytest's API are now exported so they may be used in type annotations. The newly-exported types are: - ``pytest.Config`` for :class:`Config <pytest.Config>`. - ``pytest.Mark`` for :class:`marks <pytest.Mark>`. - ``pytest.MarkDecorator`` for :class:`mark decorators <pytest.MarkDecorator>`. - ``pytest.MarkGenerator`` for the :class:`pytest.mark <pytest.MarkGenerator>` singleton. - ``pytest.Metafunc`` for the :class:`metafunc <pytest.MarkGenerator>` argument to the 🪝`pytest_generate_tests` hook. - ``pytest.CallInfo`` for the :class:`CallInfo <pytest.CallInfo>` type passed to various hooks. - ``pytest.PytestPluginManager`` for :class:`PytestPluginManager <pytest.PytestPluginManager>`. - ``pytest.ExceptionInfo`` for the :class:`ExceptionInfo <pytest.ExceptionInfo>` type returned from :func:`pytest.raises` and passed to various hooks. - ``pytest.Parser`` for the :class:`Parser <pytest.Parser>` type passed to the 🪝`pytest_addoption` hook. - ``pytest.OptionGroup`` for the :class:`OptionGroup <pytest.OptionGroup>` type returned from the :func:`parser.addgroup <pytest.Parser.getgroup>` method. - ``pytest.HookRecorder`` for the :class:`HookRecorder <pytest.HookRecorder>` type returned from :class:`~pytest.Pytester`. - ``pytest.RecordedHookCall`` for the :class:`RecordedHookCall <pytest.HookRecorder>` type returned from :class:`~pytest.HookRecorder`. - ``pytest.RunResult`` for the :class:`RunResult <pytest.RunResult>` type returned from :class:`~pytest.Pytester`. - ``pytest.LineMatcher`` for the :class:`LineMatcher <pytest.RunResult>` type used in :class:`~pytest.RunResult` and others. - ``pytest.TestReport`` for the :class:`TestReport <pytest.TestReport>` type used in various hooks. - ``pytest.CollectReport`` for the :class:`CollectReport <pytest.CollectReport>` type used in various hooks. Constructing most of them directly is not supported; they are only meant for use in type annotations. Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0. Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy. - `7856 <https://github.com/pytest-dev/pytest/issues/7856>`_: :ref:`--import-mode=importlib <import-modes>` now works with features that depend on modules being on :py:data:`sys.modules`, such as :mod:`pickle` and :mod:`dataclasses`. - `8144 <https://github.com/pytest-dev/pytest/issues/8144>`_: The following hooks now receive an additional ``pathlib.Path`` argument, equivalent to an existing ``py.path.local`` argument: - 🪝`pytest_ignore_collect` - The ``collection_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_collect_file` - The ``file_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_pycollect_makemodule` - The ``module_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_report_header` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). - 🪝`pytest_report_collectionfinish` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8251 <https://github.com/pytest-dev/pytest/issues/8251>`_: Implement ``Node.path`` as a ``pathlib.Path``. Both the old ``fspath`` and this new attribute gets set no matter whether ``path`` or ``fspath`` (deprecated) is passed to the constructor. It is a replacement for the ``fspath`` attribute (which represents the same path as ``py.path.local``). While ``fspath`` is not deprecated yet due to the ongoing migration of methods like :meth:`~_pytest.Item.reportinfo`, we expect to deprecate it in a future release. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8421 <https://github.com/pytest-dev/pytest/issues/8421>`_: :func:`pytest.approx` now works on :class:`~decimal.Decimal` within mappings/dicts and sequences/lists. - `8606 <https://github.com/pytest-dev/pytest/issues/8606>`_: pytest invocations with ``--fixtures-per-test`` and ``--fixtures`` have been enriched with: - Fixture location path printed with the fixture name. - First section of the fixture's docstring printed under the fixture name. - Whole of fixture's docstring printed under the fixture name using ``--verbose`` option. - `8761 <https://github.com/pytest-dev/pytest/issues/8761>`_: New :ref:`version-tuple` attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions). - `8789 <https://github.com/pytest-dev/pytest/issues/8789>`_: Switch TOML parser from ``toml`` to ``tomli`` for TOML v1.0.0 support in ``pyproject.toml``. - `8920 <https://github.com/pytest-dev/pytest/issues/8920>`_: Added :class:`pytest.Stash`, a facility for plugins to store their data on :class:`~pytest.Config` and :class:`~_pytest.nodes.Node`\s in a type-safe and conflict-free manner. See :ref:`plugin-stash` for details. - `8953 <https://github.com/pytest-dev/pytest/issues/8953>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``warnings`` argument to assert the total number of warnings captured. - `8954 <https://github.com/pytest-dev/pytest/issues/8954>`_: ``--debug`` flag now accepts a :class:`str` file to route debug logs into, remains defaulted to `pytestdebug.log`. - `9023 <https://github.com/pytest-dev/pytest/issues/9023>`_: Full diffs are now always shown for equality assertions of iterables when `CI` or ``BUILD_NUMBER`` is found in the environment, even when ``-v`` isn't used. - `9113 <https://github.com/pytest-dev/pytest/issues/9113>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``deselected`` argument to assert the total number of deselected tests. - `9114 <https://github.com/pytest-dev/pytest/issues/9114>`_: Added :confval:`pythonpath` setting that adds listed paths to :data:`sys.path` for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in `pythonpath` setting. Improvements ------------ - `7480 <https://github.com/pytest-dev/pytest/issues/7480>`_: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category `PytestRemovedInXWarning`, a subclass of :class:`~pytest.PytestDeprecationWarning`, instead of :class:`PytestDeprecationWarning` directly. See :ref:`backwards-compatibility` for more details. - `7864 <https://github.com/pytest-dev/pytest/issues/7864>`_: Improved error messages when parsing warning filters. Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause of the problem (for example an ``ImportError`` while importing a specific warning type). - `8335 <https://github.com/pytest-dev/pytest/issues/8335>`_: Improved :func:`pytest.approx` assertion messages for sequences of numbers. The assertion messages now dumps a table with the index and the error of each diff. Example:: > assert [1, 2, 3, 4] == pytest.approx([1, 3, 3, 5]) E assert comparison failed for 2 values: E Index | Obtained | Expected E 1 | 2 | 3 +- 3.0e-06 E 3 | 4 | 5 +- 5.0e-06 - `8403 <https://github.com/pytest-dev/pytest/issues/8403>`_: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much, currently at ``240`` characters by default. However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using ``-v`` will now increase the truncation threshold to ``2400`` characters, and ``-vv`` or higher will disable truncation entirely. - `8509 <https://github.com/pytest-dev/pytest/issues/8509>`_: Fixed issue where :meth:`unittest.TestCase.setUpClass` is not called when a test has `/` in its name since pytest 6.2.0. This refers to the path part in pytest node IDs, e.g. ``TestClass::test_it`` in the node ID ``tests/test_file.py::TestClass::test_it``. Now, instead of assuming that the test name does not contain ``/``, it is assumed that test path does not contain ``::``. We plan to hopefully make both of these work in the future. - `8803 <https://github.com/pytest-dev/pytest/issues/8803>`_: It is now possible to add colors to custom log levels on cli log. By using :func:`add_color_level <_pytest.logging.add_color_level>` from a ``pytest_configure`` hook, colors can be added:: logging_plugin = config.pluginmanager.get_plugin('logging-plugin') logging_plugin.log_cli_handler.formatter.add_color_level(logging.INFO, 'cyan') logging_plugin.log_cli_handler.formatter.add_color_level(logging.SPAM, 'blue') See :ref:`log_colors` for more information. - `8822 <https://github.com/pytest-dev/pytest/issues/8822>`_: When showing fixture paths in `--fixtures` or `--fixtures-by-test`, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the `site-packages` directory. - `8898 <https://github.com/pytest-dev/pytest/issues/8898>`_: Complex numbers are now treated like floats and integers when generating parameterization IDs. - `9062 <https://github.com/pytest-dev/pytest/issues/9062>`_: ``--stepwise-skip`` now implicitly enables ``--stepwise`` and can be used on its own. - `9205 <https://github.com/pytest-dev/pytest/issues/9205>`_: :meth:`pytest.Cache.set` now preserves key order when saving dicts. Bug Fixes --------- - `7124 <https://github.com/pytest-dev/pytest/issues/7124>`_: Fixed an issue where ``__main__.py`` would raise an ``ImportError`` when ``--doctest-modules`` was provided. - `8061 <https://github.com/pytest-dev/pytest/issues/8061>`_: Fixed failing ``staticmethod`` test cases if they are inherited from a parent test class. - `8192 <https://github.com/pytest-dev/pytest/issues/8192>`_: ``testdir.makefile`` now silently accepts values which don't start with ``.`` to maintain backward compatibility with older pytest versions. ``pytester.makefile`` now issues a clearer error if the ``.`` is missing in the ``ext`` argument. - `8258 <https://github.com/pytest-dev/pytest/issues/8258>`_: Fixed issue where pytest's ``faulthandler`` support would not dump traceback on crashes if the :mod:`faulthandler` module was already enabled during pytest startup (using ``python -X dev -m pytest`` for example). - `8317 <https://github.com/pytest-dev/pytest/issues/8317>`_: Fixed an issue where illegal directory characters derived from ``getpass.getuser()`` raised an ``OSError``. - `8367 <https://github.com/pytest-dev/pytest/issues/8367>`_: Fix ``Class.from_parent`` so it forwards extra keyword arguments to the constructor. - `8377 <https://github.com/pytest-dev/pytest/issues/8377>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing forward slash (``/``) characters. - `8384 <https://github.com/pytest-dev/pytest/issues/8384>`_: The ``pytest.mark.skip`` decorator now correctly handles its arguments. When the ``reason`` argument is accidentally given both positional and as a keyword (e.g. because it was confused with ``skipif``), a ``TypeError`` now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally, ``reason`` is now documented correctly as positional or keyword (rather than keyword-only). - `8394 <https://github.com/pytest-dev/pytest/issues/8394>`_: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default ``--fixtures`` invocation (but they still show up with ``--fixtures -v``). - `8456 <https://github.com/pytest-dev/pytest/issues/8456>`_: The :confval:`required_plugins` config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all. - `8464 <https://github.com/pytest-dev/pytest/issues/8464>`_: ``-c <config file>`` now also properly defines ``rootdir`` as the directory that contains ``<config file>``. - `8503 <https://github.com/pytest-dev/pytest/issues/8503>`_: :meth:`pytest.MonkeyPatch.syspath_prepend` no longer fails when ``setuptools`` is not installed. It now only calls :func:`pkg_resources.fixup_namespace_packages` if ``pkg_resources`` was previously imported, because it is not needed otherwise. - `8548 <https://github.com/pytest-dev/pytest/issues/8548>`_: Introduce fix to handle precision width in ``log-cli-format`` in turn to fix output coloring for certain formats. - `8796 <https://github.com/pytest-dev/pytest/issues/8796>`_: Fixed internal error when skipping doctests. - `8983 <https://github.com/pytest-dev/pytest/issues/8983>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing backslash (`\\`) characters. Backslashes are treated literally, not as escape characters (the values being matched against are already escaped). - `8990 <https://github.com/pytest-dev/pytest/issues/8990>`_: Fix `pytest -vv` crashing with an internal exception `AttributeError: 'str' object has no attribute 'relative_to'` in some cases. - `9077 <https://github.com/pytest-dev/pytest/issues/9077>`_: Fixed confusing error message when ``request.fspath`` / ``request.path`` was accessed from a session-scoped fixture. - `9131 <https://github.com/pytest-dev/pytest/issues/9131>`_: Fixed the URL used by ``--pastebin`` to use `bpa.st <http://bpa.st>`__. - `9163 <https://github.com/pytest-dev/pytest/issues/9163>`_: The end line number and end column offset are now properly set for rewritten assert statements. - `9169 <https://github.com/pytest-dev/pytest/issues/9169>`_: Support for the ``files`` API from ``importlib.resources`` within rewritten files. - `9272 <https://github.com/pytest-dev/pytest/issues/9272>`_: The nose compatibility module-level fixtures `setup()` and `teardown()` are now only called once per module, instead of for each test function. They are now called even if object-level `setup`/`teardown` is defined. Improved Documentation ---------------------- - `4320 <https://github.com/pytest-dev/pytest/issues/4320>`_: Improved docs for `pytester.copy_example`. - `5105 <https://github.com/pytest-dev/pytest/issues/5105>`_: Add automatically generated :ref:`plugin-list`. The list is updated on a periodic schedule. - `8337 <https://github.com/pytest-dev/pytest/issues/8337>`_: Recommend `numpy.testing <https://numpy.org/doc/stable/reference/routines.testing.html>`__ module on :func:`pytest.approx` documentation. - `8655 <https://github.com/pytest-dev/pytest/issues/8655>`_: Help text for ``--pdbcls`` more accurately reflects the option's behavior. - `9210 <https://github.com/pytest-dev/pytest/issues/9210>`_: Remove incorrect docs about ``confcutdir`` being a configuration option: it can only be set through the ``--confcutdir`` command-line option. - `9242 <https://github.com/pytest-dev/pytest/issues/9242>`_: Upgrade readthedocs configuration to use a `newer Ubuntu version <https://blog.readthedocs.com/new-build-specification/>`__` with better unicode support for PDF docs. - `9341 <https://github.com/pytest-dev/pytest/issues/9341>`_: Various methods commonly used for :ref:`non-python tests` are now correctly documented in the reference docs. They were undocumented previously. Trivial/Internal Changes ------------------------ - `8133 <https://github.com/pytest-dev/pytest/issues/8133>`_: Migrate to ``setuptools_scm`` 6.x to use ``SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST`` for more robust release tooling. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to internal pytest types/functions: - The ``_pytest.code.getfslineno()`` function returns ``Path`` instead of ``py.path.local``. - The ``_pytest.python.path_matches_patterns()`` function takes ``Path`` instead of ``py.path.local``. - The ``_pytest._code.Traceback.cut()`` function accepts any ``os.PathLike[str]``, not just ``py.path.local``. - `8248 <https://github.com/pytest-dev/pytest/issues/8248>`_: Internal Restructure: let ``python.PyObjMixin`` inherit from ``nodes.Node`` to carry over typing information. - `8432 <https://github.com/pytest-dev/pytest/issues/8432>`_: Improve error message when :func:`pytest.skip` is used at module level without passing `allow_module_level=True`. - `8818 <https://github.com/pytest-dev/pytest/issues/8818>`_: Ensure ``regendoc`` opts out of ``TOX_ENV`` cachedir selection to ensure independent example test runs. - `8913 <https://github.com/pytest-dev/pytest/issues/8913>`_: The private ``CallSpec2._arg2scopenum`` attribute has been removed after an internal refactoring. - `8967 <https://github.com/pytest-dev/pytest/issues/8967>`_: 🪝`pytest_assertion_pass` is no longer considered experimental and future changes to it will be considered more carefully. - `9202 <https://github.com/pytest-dev/pytest/issues/9202>`_: Add github action to upload coverage report to codecov instead of bash uploader. - `9225 <https://github.com/pytest-dev/pytest/issues/9225>`_: Changed the command used to create sdist and wheel artifacts: using the build package instead of setup.py. - `9351 <https://github.com/pytest-dev/pytest/issues/9351>`_: Correct minor typos in doc/en/example/special.rst. ``` ### 6.2.5 ``` ========================= Trivial/Internal Changes ------------------------ - :issue:`8494`: Python 3.10 is now supported. - :issue:`9040`: Enable compatibility with ``pluggy 1.0`` or later. ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/pytest - Changelog: https://pyup.io/changelogs/pytest/ - Homepage: https://docs.pytest.org/en/latest/ </details> Co-authored-by: pyup-bot <github-bot@pyup.io>

33: Update pytest to 7.1.1 r=aragilar a=pyup-bot This PR updates [pytest](https://pypi.org/project/pytest) from **6.2.4** to **7.1.1**. <details> <summary>Changelog</summary> ### 7.1.0 ``` ========================= Breaking Changes ---------------- - `8838 <https://github.com/pytest-dev/pytest/issues/8838>`_: As per our policy, the following features have been deprecated in the 6.X series and are now removed: * ``pytest._fillfuncargs`` function. * ``pytest_warning_captured`` hook - use ``pytest_warning_recorded`` instead. * ``-k -foobar`` syntax - use ``-k 'not foobar'`` instead. * ``-k foobar:`` syntax. * ``pytest.collect`` module - import from ``pytest`` directly. For more information consult `Deprecations and Removals <https://docs.pytest.org/en/latest/deprecations.html>`__ in the docs. - `9437 <https://github.com/pytest-dev/pytest/issues/9437>`_: Dropped support for Python 3.6, which reached `end-of-life <https://devguide.python.org/#status-of-python-branches>`__ at 2021-12-23. Improvements ------------ - `5192 <https://github.com/pytest-dev/pytest/issues/5192>`_: Fixed test output for some data types where ``-v`` would show less information. Also, when showing diffs for sequences, ``-q`` would produce full diffs instead of the expected diff. - `9362 <https://github.com/pytest-dev/pytest/issues/9362>`_: pytest now avoids specialized assert formatting when it is detected that the default ``__eq__`` is overridden in ``attrs`` or ``dataclasses``. - `9536 <https://github.com/pytest-dev/pytest/issues/9536>`_: When ``-vv`` is given on command line, show skipping and xfail reasons in full instead of truncating them to fit the terminal width. - `9644 <https://github.com/pytest-dev/pytest/issues/9644>`_: More information about the location of resources that led Python to raise :class:`ResourceWarning` can now be obtained by enabling :mod:`tracemalloc`. See :ref:`resource-warnings` for more information. - `9678 <https://github.com/pytest-dev/pytest/issues/9678>`_: More types are now accepted in the ``ids`` argument to ``pytest.mark.parametrize``. Previously only `str`, `float`, `int` and `bool` were accepted; now `bytes`, `complex`, `re.Pattern`, `Enum` and anything with a `__name__` are also accepted. - `9692 <https://github.com/pytest-dev/pytest/issues/9692>`_: :func:`pytest.approx` now raises a :class:`TypeError` when given an unordered sequence (such as :class:`set`). Note that this implies that custom classes which only implement ``__iter__`` and ``__len__`` are no longer supported as they don't guarantee order. Bug Fixes --------- - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: The deprecation of raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is reverted - this is now a supported feature again. - `9493 <https://github.com/pytest-dev/pytest/issues/9493>`_: Symbolic link components are no longer resolved in conftest paths. This means that if a conftest appears twice in collection tree, using symlinks, it will be executed twice. For example, given tests/real/conftest.py tests/real/test_it.py tests/link -> tests/real running ``pytest tests`` now imports the conftest twice, once as ``tests/real/conftest.py`` and once as ``tests/link/conftest.py``. This is a fix to match a similar change made to test collection itself in pytest 6.0 (see :pull:`6523` for details). - `9626 <https://github.com/pytest-dev/pytest/issues/9626>`_: Fixed count of selected tests on terminal collection summary when there were errors or skipped modules. If there were errors or skipped modules on collection, pytest would mistakenly subtract those from the selected count. - `9645 <https://github.com/pytest-dev/pytest/issues/9645>`_: Fixed regression where ``--import-mode=importlib`` used together with :envvar:`PYTHONPATH` or :confval:`pythonpath` would cause import errors in test suites. - `9708 <https://github.com/pytest-dev/pytest/issues/9708>`_: :fixture:`pytester` now requests a :fixture:`monkeypatch` fixture instead of creating one internally. This solves some issues with tests that involve pytest environment variables. - `9730 <https://github.com/pytest-dev/pytest/issues/9730>`_: Malformed ``pyproject.toml`` files now produce a clearer error message. ``` ### 7.0.1 ``` ========================= Bug Fixes --------- - `9608 <https://github.com/pytest-dev/pytest/issues/9608>`_: Fix invalid importing of ``importlib.readers`` in Python 3.9. - `9610 <https://github.com/pytest-dev/pytest/issues/9610>`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method. Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`. Regressed in pytest 7.0.0. - `9636 <https://github.com/pytest-dev/pytest/issues/9636>`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin. - `9642 <https://github.com/pytest-dev/pytest/issues/9642>`_: Fix running tests by id with ``::`` in the parametrize portion. - `9643 <https://github.com/pytest-dev/pytest/issues/9643>`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters <warnings>`. ``` ### 7.0.0 ``` ========================= (**Please see the full set of changes for this release also in the 7.0.0rc1 notes below**) Deprecations ------------ - `9488 <https://github.com/pytest-dev/pytest/issues/9488>`_: If custom subclasses of nodes like :class:`pytest.Item` override the ``__init__`` method, they should take ``**kwargs``. See :ref:`uncooperative-constructors-deprecated` for details. Note that a deprection warning is only emitted when there is a conflict in the arguments pytest expected to pass. This deprecation was already part of pytest 7.0.0rc1 but wasn't documented. Bug Fixes --------- - `9355 <https://github.com/pytest-dev/pytest/issues/9355>`_: Fixed error message prints function decorators when using assert in Python 3.8 and above. - `9396 <https://github.com/pytest-dev/pytest/issues/9396>`_: Ensure :attr:`pytest.Config.inifile` is available during the :func:`pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>` hook (regression during ``7.0.0rc1``). Improved Documentation ---------------------- - `9404 <https://github.com/pytest-dev/pytest/issues/9404>`_: Added extra documentation on alternatives to common misuses of `pytest.warns(None)` ahead of its deprecation. - `9505 <https://github.com/pytest-dev/pytest/issues/9505>`_: Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository. Trivial/Internal Changes ------------------------ - `9521 <https://github.com/pytest-dev/pytest/issues/9521>`_: Add test coverage to assertion rewrite path. ``` ### 7.0.0rc1 ``` ============================ Breaking Changes ---------------- - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: The :ref:`Node.reportinfo() <non-python tests>` function first return value type has been expanded from `py.path.local | str` to `os.PathLike[str] | str`. Most plugins which refer to `reportinfo()` only define it as part of a custom :class:`pytest.Item` implementation. 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. - `8246 <https://github.com/pytest-dev/pytest/issues/8246>`_: ``--version`` now writes version information to ``stdout`` rather than ``stderr``. - `8733 <https://github.com/pytest-dev/pytest/issues/8733>`_: Drop a workaround for `pyreadline <https://github.com/pyreadline/pyreadline>`__ that made it work with ``--pdb``. The workaround was introduced in `1281 <https://github.com/pytest-dev/pytest/pull/1281>`__ in 2015, however since then `pyreadline seems to have gone unmaintained <https://github.com/pyreadline/pyreadline/issues/58>`__, is `generating warnings <https://github.com/pytest-dev/pytest/issues/8847>`__, and will stop working on Python 3.10. - `9061 <https://github.com/pytest-dev/pytest/issues/9061>`_: Using :func:`pytest.approx` in a boolean context now raises an error hinting at the proper usage. It is apparently common for users to mistakenly use ``pytest.approx`` like this: .. code-block:: python assert pytest.approx(actual, expected) While the correct usage is: .. code-block:: python assert actual == pytest.approx(expected) The new error message helps catch those mistakes. - `9277 <https://github.com/pytest-dev/pytest/issues/9277>`_: The ``pytest.Instance`` collector type has been removed. Importing ``pytest.Instance`` or ``_pytest.python.Instance`` returns a dummy type and emits a deprecation warning. See :ref:`instance-collector-deprecation` for details. - `9308 <https://github.com/pytest-dev/pytest/issues/9308>`_: **PytestRemovedIn7Warning deprecation warnings are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type ``PytestRemovedIn7Warning`` now generate errors instead of warning messages by default. **The affected features will be effectively removed in pytest 7.1**, so please consult the :ref:`deprecations` section in the docs for directions on how to update existing code. In the pytest ``7.0.X`` series, it is possible to change the errors back into warnings as a stopgap measure by adding this to your ``pytest.ini`` file: .. code-block:: ini [pytest] filterwarnings = ignore::pytest.PytestRemovedIn7Warning But this will stop working when pytest ``7.1`` is released. **If you have concerns** about the removal of a specific feature, please add a comment to :issue:`9308`. Deprecations ------------ - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: ``py.path.local`` arguments for hooks have been deprecated. See :ref:`the deprecation note <legacy-path-hooks-deprecated>` for full details. ``py.path.local`` arguments to Node constructors have been deprecated. See :ref:`the deprecation note <node-ctor-fspath-deprecation>` for full details. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: 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. - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: Raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is deprecated. Use :func:`pytest.skip` instead. Note: This deprecation only relates to using :class:`unittest.SkipTest` during test 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. .. note:: This deprecation has been reverted in pytest 7.1.0. - `8315 <https://github.com/pytest-dev/pytest/issues/8315>`_: Several behaviors of :meth:`Parser.addoption <pytest.Parser.addoption>` are now 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. - `8447 <https://github.com/pytest-dev/pytest/issues/8447>`_: Defining a custom pytest node type which is both an :class:`pytest.Item <Item>` and a :class:`pytest.Collector <Collector>` (e.g. :class:`pytest.File <File>`) now issues a warning. It was never sanely supported and triggers hard to debug errors. See :ref:`the deprecation note <diamond-inheritance-deprecated>` for full details. - `8592 <https://github.com/pytest-dev/pytest/issues/8592>`_: 🪝`pytest_cmdline_preparse` has been officially deprecated. It will be removed in a future release. Use 🪝`pytest_load_initial_conftests` instead. See :ref:`the deprecation note <cmdline-preparse-deprecated>` for full details. - `8645 <https://github.com/pytest-dev/pytest/issues/8645>`_: :func:`pytest.warns(None) <pytest.warns>` 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)``. - `8948 <https://github.com/pytest-dev/pytest/issues/8948>`_: :func:`pytest.skip(msg=...) <pytest.skip>`, :func:`pytest.fail(msg=...) <pytest.fail>` and :func:`pytest.exit(msg=...) <pytest.exit>` signatures now accept a ``reason`` argument instead of ``msg``. Using ``msg`` still works, but is deprecated and will be removed in a future release. This was changed for consistency with :func:`pytest.mark.skip <pytest.mark.skip>` and :func:`pytest.mark.xfail <pytest.mark.xfail>` which both accept ``reason`` as an argument. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to types reachable through :attr:`pytest.ExceptionInfo.traceback`: - The ``path`` property of ``_pytest.code.Code`` returns ``Path`` instead of ``py.path.local``. - The ``path`` property of ``_pytest.code.TracebackEntry`` returns ``Path`` instead of ``py.path.local``. There was no deprecation period for this change (sorry!). Features -------- - `5196 <https://github.com/pytest-dev/pytest/issues/5196>`_: Tests are now ordered by definition order in more cases. In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order). - `7132 <https://github.com/pytest-dev/pytest/issues/7132>`_: Added two environment variables :envvar:`PYTEST_THEME` and :envvar:`PYTEST_THEME_MODE` to let the users customize the pygments theme used. - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: Added :meth:`cache.mkdir() <pytest.Cache.mkdir>`, which is similar to the existing :meth:`cache.makedir() <pytest.Cache.makedir>`, but returns a :class:`pathlib.Path` instead of a legacy ``py.path.local``. Added a ``paths`` type to :meth:`parser.addini() <pytest.Parser.addini>`, as in ``parser.addini("mypaths", "my paths", type="paths")``, which is similar to the existing ``pathlist``, but returns a list of :class:`pathlib.Path` instead of legacy ``py.path.local``. - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: The types of objects used in pytest's API are now exported so they may be used in type annotations. The newly-exported types are: - ``pytest.Config`` for :class:`Config <pytest.Config>`. - ``pytest.Mark`` for :class:`marks <pytest.Mark>`. - ``pytest.MarkDecorator`` for :class:`mark decorators <pytest.MarkDecorator>`. - ``pytest.MarkGenerator`` for the :class:`pytest.mark <pytest.MarkGenerator>` singleton. - ``pytest.Metafunc`` for the :class:`metafunc <pytest.MarkGenerator>` argument to the 🪝`pytest_generate_tests` hook. - ``pytest.CallInfo`` for the :class:`CallInfo <pytest.CallInfo>` type passed to various hooks. - ``pytest.PytestPluginManager`` for :class:`PytestPluginManager <pytest.PytestPluginManager>`. - ``pytest.ExceptionInfo`` for the :class:`ExceptionInfo <pytest.ExceptionInfo>` type returned from :func:`pytest.raises` and passed to various hooks. - ``pytest.Parser`` for the :class:`Parser <pytest.Parser>` type passed to the 🪝`pytest_addoption` hook. - ``pytest.OptionGroup`` for the :class:`OptionGroup <pytest.OptionGroup>` type returned from the :func:`parser.addgroup <pytest.Parser.getgroup>` method. - ``pytest.HookRecorder`` for the :class:`HookRecorder <pytest.HookRecorder>` type returned from :class:`~pytest.Pytester`. - ``pytest.RecordedHookCall`` for the :class:`RecordedHookCall <pytest.HookRecorder>` type returned from :class:`~pytest.HookRecorder`. - ``pytest.RunResult`` for the :class:`RunResult <pytest.RunResult>` type returned from :class:`~pytest.Pytester`. - ``pytest.LineMatcher`` for the :class:`LineMatcher <pytest.RunResult>` type used in :class:`~pytest.RunResult` and others. - ``pytest.TestReport`` for the :class:`TestReport <pytest.TestReport>` type used in various hooks. - ``pytest.CollectReport`` for the :class:`CollectReport <pytest.CollectReport>` type used in various hooks. Constructing most of them directly is not supported; they are only meant for use in type annotations. Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0. Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy. - `7856 <https://github.com/pytest-dev/pytest/issues/7856>`_: :ref:`--import-mode=importlib <import-modes>` now works with features that depend on modules being on :py:data:`sys.modules`, such as :mod:`pickle` and :mod:`dataclasses`. - `8144 <https://github.com/pytest-dev/pytest/issues/8144>`_: The following hooks now receive an additional ``pathlib.Path`` argument, equivalent to an existing ``py.path.local`` argument: - 🪝`pytest_ignore_collect` - The ``collection_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_collect_file` - The ``file_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_pycollect_makemodule` - The ``module_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_report_header` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). - 🪝`pytest_report_collectionfinish` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8251 <https://github.com/pytest-dev/pytest/issues/8251>`_: Implement ``Node.path`` as a ``pathlib.Path``. Both the old ``fspath`` and this new attribute gets set no matter whether ``path`` or ``fspath`` (deprecated) is passed to the constructor. It is a replacement for the ``fspath`` attribute (which represents the same path as ``py.path.local``). While ``fspath`` is not deprecated yet due to the ongoing migration of methods like :meth:`~_pytest.Item.reportinfo`, we expect to deprecate it in a future release. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8421 <https://github.com/pytest-dev/pytest/issues/8421>`_: :func:`pytest.approx` now works on :class:`~decimal.Decimal` within mappings/dicts and sequences/lists. - `8606 <https://github.com/pytest-dev/pytest/issues/8606>`_: pytest invocations with ``--fixtures-per-test`` and ``--fixtures`` have been enriched with: - Fixture location path printed with the fixture name. - First section of the fixture's docstring printed under the fixture name. - Whole of fixture's docstring printed under the fixture name using ``--verbose`` option. - `8761 <https://github.com/pytest-dev/pytest/issues/8761>`_: New :ref:`version-tuple` attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions). - `8789 <https://github.com/pytest-dev/pytest/issues/8789>`_: Switch TOML parser from ``toml`` to ``tomli`` for TOML v1.0.0 support in ``pyproject.toml``. - `8920 <https://github.com/pytest-dev/pytest/issues/8920>`_: Added :class:`pytest.Stash`, a facility for plugins to store their data on :class:`~pytest.Config` and :class:`~_pytest.nodes.Node`\s in a type-safe and conflict-free manner. See :ref:`plugin-stash` for details. - `8953 <https://github.com/pytest-dev/pytest/issues/8953>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``warnings`` argument to assert the total number of warnings captured. - `8954 <https://github.com/pytest-dev/pytest/issues/8954>`_: ``--debug`` flag now accepts a :class:`str` file to route debug logs into, remains defaulted to `pytestdebug.log`. - `9023 <https://github.com/pytest-dev/pytest/issues/9023>`_: Full diffs are now always shown for equality assertions of iterables when `CI` or ``BUILD_NUMBER`` is found in the environment, even when ``-v`` isn't used. - `9113 <https://github.com/pytest-dev/pytest/issues/9113>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``deselected`` argument to assert the total number of deselected tests. - `9114 <https://github.com/pytest-dev/pytest/issues/9114>`_: Added :confval:`pythonpath` setting that adds listed paths to :data:`sys.path` for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in `pythonpath` setting. Improvements ------------ - `7480 <https://github.com/pytest-dev/pytest/issues/7480>`_: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category `PytestRemovedInXWarning`, a subclass of :class:`~pytest.PytestDeprecationWarning`, instead of :class:`PytestDeprecationWarning` directly. See :ref:`backwards-compatibility` for more details. - `7864 <https://github.com/pytest-dev/pytest/issues/7864>`_: Improved error messages when parsing warning filters. Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause of the problem (for example an ``ImportError`` while importing a specific warning type). - `8335 <https://github.com/pytest-dev/pytest/issues/8335>`_: Improved :func:`pytest.approx` assertion messages for sequences of numbers. The assertion messages now dumps a table with the index and the error of each diff. Example:: > assert [1, 2, 3, 4] == pytest.approx([1, 3, 3, 5]) E assert comparison failed for 2 values: E Index | Obtained | Expected E 1 | 2 | 3 +- 3.0e-06 E 3 | 4 | 5 +- 5.0e-06 - `8403 <https://github.com/pytest-dev/pytest/issues/8403>`_: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much, currently at ``240`` characters by default. However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using ``-v`` will now increase the truncation threshold to ``2400`` characters, and ``-vv`` or higher will disable truncation entirely. - `8509 <https://github.com/pytest-dev/pytest/issues/8509>`_: Fixed issue where :meth:`unittest.TestCase.setUpClass` is not called when a test has `/` in its name since pytest 6.2.0. This refers to the path part in pytest node IDs, e.g. ``TestClass::test_it`` in the node ID ``tests/test_file.py::TestClass::test_it``. Now, instead of assuming that the test name does not contain ``/``, it is assumed that test path does not contain ``::``. We plan to hopefully make both of these work in the future. - `8803 <https://github.com/pytest-dev/pytest/issues/8803>`_: It is now possible to add colors to custom log levels on cli log. By using :func:`add_color_level <_pytest.logging.add_color_level>` from a ``pytest_configure`` hook, colors can be added:: logging_plugin = config.pluginmanager.get_plugin('logging-plugin') logging_plugin.log_cli_handler.formatter.add_color_level(logging.INFO, 'cyan') logging_plugin.log_cli_handler.formatter.add_color_level(logging.SPAM, 'blue') See :ref:`log_colors` for more information. - `8822 <https://github.com/pytest-dev/pytest/issues/8822>`_: When showing fixture paths in `--fixtures` or `--fixtures-by-test`, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the `site-packages` directory. - `8898 <https://github.com/pytest-dev/pytest/issues/8898>`_: Complex numbers are now treated like floats and integers when generating parameterization IDs. - `9062 <https://github.com/pytest-dev/pytest/issues/9062>`_: ``--stepwise-skip`` now implicitly enables ``--stepwise`` and can be used on its own. - `9205 <https://github.com/pytest-dev/pytest/issues/9205>`_: :meth:`pytest.Cache.set` now preserves key order when saving dicts. Bug Fixes --------- - `7124 <https://github.com/pytest-dev/pytest/issues/7124>`_: Fixed an issue where ``__main__.py`` would raise an ``ImportError`` when ``--doctest-modules`` was provided. - `8061 <https://github.com/pytest-dev/pytest/issues/8061>`_: Fixed failing ``staticmethod`` test cases if they are inherited from a parent test class. - `8192 <https://github.com/pytest-dev/pytest/issues/8192>`_: ``testdir.makefile`` now silently accepts values which don't start with ``.`` to maintain backward compatibility with older pytest versions. ``pytester.makefile`` now issues a clearer error if the ``.`` is missing in the ``ext`` argument. - `8258 <https://github.com/pytest-dev/pytest/issues/8258>`_: Fixed issue where pytest's ``faulthandler`` support would not dump traceback on crashes if the :mod:`faulthandler` module was already enabled during pytest startup (using ``python -X dev -m pytest`` for example). - `8317 <https://github.com/pytest-dev/pytest/issues/8317>`_: Fixed an issue where illegal directory characters derived from ``getpass.getuser()`` raised an ``OSError``. - `8367 <https://github.com/pytest-dev/pytest/issues/8367>`_: Fix ``Class.from_parent`` so it forwards extra keyword arguments to the constructor. - `8377 <https://github.com/pytest-dev/pytest/issues/8377>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing forward slash (``/``) characters. - `8384 <https://github.com/pytest-dev/pytest/issues/8384>`_: The ``pytest.mark.skip`` decorator now correctly handles its arguments. When the ``reason`` argument is accidentally given both positional and as a keyword (e.g. because it was confused with ``skipif``), a ``TypeError`` now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally, ``reason`` is now documented correctly as positional or keyword (rather than keyword-only). - `8394 <https://github.com/pytest-dev/pytest/issues/8394>`_: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default ``--fixtures`` invocation (but they still show up with ``--fixtures -v``). - `8456 <https://github.com/pytest-dev/pytest/issues/8456>`_: The :confval:`required_plugins` config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all. - `8464 <https://github.com/pytest-dev/pytest/issues/8464>`_: ``-c <config file>`` now also properly defines ``rootdir`` as the directory that contains ``<config file>``. - `8503 <https://github.com/pytest-dev/pytest/issues/8503>`_: :meth:`pytest.MonkeyPatch.syspath_prepend` no longer fails when ``setuptools`` is not installed. It now only calls :func:`pkg_resources.fixup_namespace_packages` if ``pkg_resources`` was previously imported, because it is not needed otherwise. - `8548 <https://github.com/pytest-dev/pytest/issues/8548>`_: Introduce fix to handle precision width in ``log-cli-format`` in turn to fix output coloring for certain formats. - `8796 <https://github.com/pytest-dev/pytest/issues/8796>`_: Fixed internal error when skipping doctests. - `8983 <https://github.com/pytest-dev/pytest/issues/8983>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing backslash (`\\`) characters. Backslashes are treated literally, not as escape characters (the values being matched against are already escaped). - `8990 <https://github.com/pytest-dev/pytest/issues/8990>`_: Fix `pytest -vv` crashing with an internal exception `AttributeError: 'str' object has no attribute 'relative_to'` in some cases. - `9077 <https://github.com/pytest-dev/pytest/issues/9077>`_: Fixed confusing error message when ``request.fspath`` / ``request.path`` was accessed from a session-scoped fixture. - `9131 <https://github.com/pytest-dev/pytest/issues/9131>`_: Fixed the URL used by ``--pastebin`` to use `bpa.st <http://bpa.st>`__. - `9163 <https://github.com/pytest-dev/pytest/issues/9163>`_: The end line number and end column offset are now properly set for rewritten assert statements. - `9169 <https://github.com/pytest-dev/pytest/issues/9169>`_: Support for the ``files`` API from ``importlib.resources`` within rewritten files. - `9272 <https://github.com/pytest-dev/pytest/issues/9272>`_: The nose compatibility module-level fixtures `setup()` and `teardown()` are now only called once per module, instead of for each test function. They are now called even if object-level `setup`/`teardown` is defined. Improved Documentation ---------------------- - `4320 <https://github.com/pytest-dev/pytest/issues/4320>`_: Improved docs for `pytester.copy_example`. - `5105 <https://github.com/pytest-dev/pytest/issues/5105>`_: Add automatically generated :ref:`plugin-list`. The list is updated on a periodic schedule. - `8337 <https://github.com/pytest-dev/pytest/issues/8337>`_: Recommend `numpy.testing <https://numpy.org/doc/stable/reference/routines.testing.html>`__ module on :func:`pytest.approx` documentation. - `8655 <https://github.com/pytest-dev/pytest/issues/8655>`_: Help text for ``--pdbcls`` more accurately reflects the option's behavior. - `9210 <https://github.com/pytest-dev/pytest/issues/9210>`_: Remove incorrect docs about ``confcutdir`` being a configuration option: it can only be set through the ``--confcutdir`` command-line option. - `9242 <https://github.com/pytest-dev/pytest/issues/9242>`_: Upgrade readthedocs configuration to use a `newer Ubuntu version <https://blog.readthedocs.com/new-build-specification/>`__` with better unicode support for PDF docs. - `9341 <https://github.com/pytest-dev/pytest/issues/9341>`_: Various methods commonly used for :ref:`non-python tests` are now correctly documented in the reference docs. They were undocumented previously. Trivial/Internal Changes ------------------------ - `8133 <https://github.com/pytest-dev/pytest/issues/8133>`_: Migrate to ``setuptools_scm`` 6.x to use ``SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST`` for more robust release tooling. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to internal pytest types/functions: - The ``_pytest.code.getfslineno()`` function returns ``Path`` instead of ``py.path.local``. - The ``_pytest.python.path_matches_patterns()`` function takes ``Path`` instead of ``py.path.local``. - The ``_pytest._code.Traceback.cut()`` function accepts any ``os.PathLike[str]``, not just ``py.path.local``. - `8248 <https://github.com/pytest-dev/pytest/issues/8248>`_: Internal Restructure: let ``python.PyObjMixin`` inherit from ``nodes.Node`` to carry over typing information. - `8432 <https://github.com/pytest-dev/pytest/issues/8432>`_: Improve error message when :func:`pytest.skip` is used at module level without passing `allow_module_level=True`. - `8818 <https://github.com/pytest-dev/pytest/issues/8818>`_: Ensure ``regendoc`` opts out of ``TOX_ENV`` cachedir selection to ensure independent example test runs. - `8913 <https://github.com/pytest-dev/pytest/issues/8913>`_: The private ``CallSpec2._arg2scopenum`` attribute has been removed after an internal refactoring. - `8967 <https://github.com/pytest-dev/pytest/issues/8967>`_: 🪝`pytest_assertion_pass` is no longer considered experimental and future changes to it will be considered more carefully. - `9202 <https://github.com/pytest-dev/pytest/issues/9202>`_: Add github action to upload coverage report to codecov instead of bash uploader. - `9225 <https://github.com/pytest-dev/pytest/issues/9225>`_: Changed the command used to create sdist and wheel artifacts: using the build package instead of setup.py. - `9351 <https://github.com/pytest-dev/pytest/issues/9351>`_: Correct minor typos in doc/en/example/special.rst. ``` ### 6.2.5 ``` ========================= Trivial/Internal Changes ------------------------ - :issue:`8494`: Python 3.10 is now supported. - :issue:`9040`: Enable compatibility with ``pluggy 1.0`` or later. ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/pytest - Changelog: https://pyup.io/changelogs/pytest/ - Homepage: https://docs.pytest.org/en/latest/ </details> Co-authored-by: pyup-bot <github-bot@pyup.io>

128: Update pytest to 7.1.1 r=aragilar a=pyup-bot This PR updates [pytest](https://pypi.org/project/pytest) from **6.2.4** to **7.1.1**. <details> <summary>Changelog</summary> ### 7.1.0 ``` ========================= Breaking Changes ---------------- - `8838 <https://github.com/pytest-dev/pytest/issues/8838>`_: As per our policy, the following features have been deprecated in the 6.X series and are now removed: * ``pytest._fillfuncargs`` function. * ``pytest_warning_captured`` hook - use ``pytest_warning_recorded`` instead. * ``-k -foobar`` syntax - use ``-k 'not foobar'`` instead. * ``-k foobar:`` syntax. * ``pytest.collect`` module - import from ``pytest`` directly. For more information consult `Deprecations and Removals <https://docs.pytest.org/en/latest/deprecations.html>`__ in the docs. - `9437 <https://github.com/pytest-dev/pytest/issues/9437>`_: Dropped support for Python 3.6, which reached `end-of-life <https://devguide.python.org/#status-of-python-branches>`__ at 2021-12-23. Improvements ------------ - `5192 <https://github.com/pytest-dev/pytest/issues/5192>`_: Fixed test output for some data types where ``-v`` would show less information. Also, when showing diffs for sequences, ``-q`` would produce full diffs instead of the expected diff. - `9362 <https://github.com/pytest-dev/pytest/issues/9362>`_: pytest now avoids specialized assert formatting when it is detected that the default ``__eq__`` is overridden in ``attrs`` or ``dataclasses``. - `9536 <https://github.com/pytest-dev/pytest/issues/9536>`_: When ``-vv`` is given on command line, show skipping and xfail reasons in full instead of truncating them to fit the terminal width. - `9644 <https://github.com/pytest-dev/pytest/issues/9644>`_: More information about the location of resources that led Python to raise :class:`ResourceWarning` can now be obtained by enabling :mod:`tracemalloc`. See :ref:`resource-warnings` for more information. - `9678 <https://github.com/pytest-dev/pytest/issues/9678>`_: More types are now accepted in the ``ids`` argument to ``pytest.mark.parametrize``. Previously only `str`, `float`, `int` and `bool` were accepted; now `bytes`, `complex`, `re.Pattern`, `Enum` and anything with a `__name__` are also accepted. - `9692 <https://github.com/pytest-dev/pytest/issues/9692>`_: :func:`pytest.approx` now raises a :class:`TypeError` when given an unordered sequence (such as :class:`set`). Note that this implies that custom classes which only implement ``__iter__`` and ``__len__`` are no longer supported as they don't guarantee order. Bug Fixes --------- - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: The deprecation of raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is reverted - this is now a supported feature again. - `9493 <https://github.com/pytest-dev/pytest/issues/9493>`_: Symbolic link components are no longer resolved in conftest paths. This means that if a conftest appears twice in collection tree, using symlinks, it will be executed twice. For example, given tests/real/conftest.py tests/real/test_it.py tests/link -> tests/real running ``pytest tests`` now imports the conftest twice, once as ``tests/real/conftest.py`` and once as ``tests/link/conftest.py``. This is a fix to match a similar change made to test collection itself in pytest 6.0 (see :pull:`6523` for details). - `9626 <https://github.com/pytest-dev/pytest/issues/9626>`_: Fixed count of selected tests on terminal collection summary when there were errors or skipped modules. If there were errors or skipped modules on collection, pytest would mistakenly subtract those from the selected count. - `9645 <https://github.com/pytest-dev/pytest/issues/9645>`_: Fixed regression where ``--import-mode=importlib`` used together with :envvar:`PYTHONPATH` or :confval:`pythonpath` would cause import errors in test suites. - `9708 <https://github.com/pytest-dev/pytest/issues/9708>`_: :fixture:`pytester` now requests a :fixture:`monkeypatch` fixture instead of creating one internally. This solves some issues with tests that involve pytest environment variables. - `9730 <https://github.com/pytest-dev/pytest/issues/9730>`_: Malformed ``pyproject.toml`` files now produce a clearer error message. ``` ### 7.0.1 ``` ========================= Bug Fixes --------- - `9608 <https://github.com/pytest-dev/pytest/issues/9608>`_: Fix invalid importing of ``importlib.readers`` in Python 3.9. - `9610 <https://github.com/pytest-dev/pytest/issues/9610>`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method. Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`. Regressed in pytest 7.0.0. - `9636 <https://github.com/pytest-dev/pytest/issues/9636>`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin. - `9642 <https://github.com/pytest-dev/pytest/issues/9642>`_: Fix running tests by id with ``::`` in the parametrize portion. - `9643 <https://github.com/pytest-dev/pytest/issues/9643>`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters <warnings>`. ``` ### 7.0.0 ``` ========================= (**Please see the full set of changes for this release also in the 7.0.0rc1 notes below**) Deprecations ------------ - `9488 <https://github.com/pytest-dev/pytest/issues/9488>`_: If custom subclasses of nodes like :class:`pytest.Item` override the ``__init__`` method, they should take ``**kwargs``. See :ref:`uncooperative-constructors-deprecated` for details. Note that a deprection warning is only emitted when there is a conflict in the arguments pytest expected to pass. This deprecation was already part of pytest 7.0.0rc1 but wasn't documented. Bug Fixes --------- - `9355 <https://github.com/pytest-dev/pytest/issues/9355>`_: Fixed error message prints function decorators when using assert in Python 3.8 and above. - `9396 <https://github.com/pytest-dev/pytest/issues/9396>`_: Ensure :attr:`pytest.Config.inifile` is available during the :func:`pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>` hook (regression during ``7.0.0rc1``). Improved Documentation ---------------------- - `9404 <https://github.com/pytest-dev/pytest/issues/9404>`_: Added extra documentation on alternatives to common misuses of `pytest.warns(None)` ahead of its deprecation. - `9505 <https://github.com/pytest-dev/pytest/issues/9505>`_: Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository. Trivial/Internal Changes ------------------------ - `9521 <https://github.com/pytest-dev/pytest/issues/9521>`_: Add test coverage to assertion rewrite path. ``` ### 7.0.0rc1 ``` ============================ Breaking Changes ---------------- - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: The :ref:`Node.reportinfo() <non-python tests>` function first return value type has been expanded from `py.path.local | str` to `os.PathLike[str] | str`. Most plugins which refer to `reportinfo()` only define it as part of a custom :class:`pytest.Item` implementation. 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. - `8246 <https://github.com/pytest-dev/pytest/issues/8246>`_: ``--version`` now writes version information to ``stdout`` rather than ``stderr``. - `8733 <https://github.com/pytest-dev/pytest/issues/8733>`_: Drop a workaround for `pyreadline <https://github.com/pyreadline/pyreadline>`__ that made it work with ``--pdb``. The workaround was introduced in `1281 <https://github.com/pytest-dev/pytest/pull/1281>`__ in 2015, however since then `pyreadline seems to have gone unmaintained <https://github.com/pyreadline/pyreadline/issues/58>`__, is `generating warnings <https://github.com/pytest-dev/pytest/issues/8847>`__, and will stop working on Python 3.10. - `9061 <https://github.com/pytest-dev/pytest/issues/9061>`_: Using :func:`pytest.approx` in a boolean context now raises an error hinting at the proper usage. It is apparently common for users to mistakenly use ``pytest.approx`` like this: .. code-block:: python assert pytest.approx(actual, expected) While the correct usage is: .. code-block:: python assert actual == pytest.approx(expected) The new error message helps catch those mistakes. - `9277 <https://github.com/pytest-dev/pytest/issues/9277>`_: The ``pytest.Instance`` collector type has been removed. Importing ``pytest.Instance`` or ``_pytest.python.Instance`` returns a dummy type and emits a deprecation warning. See :ref:`instance-collector-deprecation` for details. - `9308 <https://github.com/pytest-dev/pytest/issues/9308>`_: **PytestRemovedIn7Warning deprecation warnings are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type ``PytestRemovedIn7Warning`` now generate errors instead of warning messages by default. **The affected features will be effectively removed in pytest 7.1**, so please consult the :ref:`deprecations` section in the docs for directions on how to update existing code. In the pytest ``7.0.X`` series, it is possible to change the errors back into warnings as a stopgap measure by adding this to your ``pytest.ini`` file: .. code-block:: ini [pytest] filterwarnings = ignore::pytest.PytestRemovedIn7Warning But this will stop working when pytest ``7.1`` is released. **If you have concerns** about the removal of a specific feature, please add a comment to :issue:`9308`. Deprecations ------------ - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: ``py.path.local`` arguments for hooks have been deprecated. See :ref:`the deprecation note <legacy-path-hooks-deprecated>` for full details. ``py.path.local`` arguments to Node constructors have been deprecated. See :ref:`the deprecation note <node-ctor-fspath-deprecation>` for full details. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: 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. - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: Raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is deprecated. Use :func:`pytest.skip` instead. Note: This deprecation only relates to using :class:`unittest.SkipTest` during test 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. .. note:: This deprecation has been reverted in pytest 7.1.0. - `8315 <https://github.com/pytest-dev/pytest/issues/8315>`_: Several behaviors of :meth:`Parser.addoption <pytest.Parser.addoption>` are now 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. - `8447 <https://github.com/pytest-dev/pytest/issues/8447>`_: Defining a custom pytest node type which is both an :class:`pytest.Item <Item>` and a :class:`pytest.Collector <Collector>` (e.g. :class:`pytest.File <File>`) now issues a warning. It was never sanely supported and triggers hard to debug errors. See :ref:`the deprecation note <diamond-inheritance-deprecated>` for full details. - `8592 <https://github.com/pytest-dev/pytest/issues/8592>`_: 🪝`pytest_cmdline_preparse` has been officially deprecated. It will be removed in a future release. Use 🪝`pytest_load_initial_conftests` instead. See :ref:`the deprecation note <cmdline-preparse-deprecated>` for full details. - `8645 <https://github.com/pytest-dev/pytest/issues/8645>`_: :func:`pytest.warns(None) <pytest.warns>` 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)``. - `8948 <https://github.com/pytest-dev/pytest/issues/8948>`_: :func:`pytest.skip(msg=...) <pytest.skip>`, :func:`pytest.fail(msg=...) <pytest.fail>` and :func:`pytest.exit(msg=...) <pytest.exit>` signatures now accept a ``reason`` argument instead of ``msg``. Using ``msg`` still works, but is deprecated and will be removed in a future release. This was changed for consistency with :func:`pytest.mark.skip <pytest.mark.skip>` and :func:`pytest.mark.xfail <pytest.mark.xfail>` which both accept ``reason`` as an argument. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to types reachable through :attr:`pytest.ExceptionInfo.traceback`: - The ``path`` property of ``_pytest.code.Code`` returns ``Path`` instead of ``py.path.local``. - The ``path`` property of ``_pytest.code.TracebackEntry`` returns ``Path`` instead of ``py.path.local``. There was no deprecation period for this change (sorry!). Features -------- - `5196 <https://github.com/pytest-dev/pytest/issues/5196>`_: Tests are now ordered by definition order in more cases. In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order). - `7132 <https://github.com/pytest-dev/pytest/issues/7132>`_: Added two environment variables :envvar:`PYTEST_THEME` and :envvar:`PYTEST_THEME_MODE` to let the users customize the pygments theme used. - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: Added :meth:`cache.mkdir() <pytest.Cache.mkdir>`, which is similar to the existing :meth:`cache.makedir() <pytest.Cache.makedir>`, but returns a :class:`pathlib.Path` instead of a legacy ``py.path.local``. Added a ``paths`` type to :meth:`parser.addini() <pytest.Parser.addini>`, as in ``parser.addini("mypaths", "my paths", type="paths")``, which is similar to the existing ``pathlist``, but returns a list of :class:`pathlib.Path` instead of legacy ``py.path.local``. - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: The types of objects used in pytest's API are now exported so they may be used in type annotations. The newly-exported types are: - ``pytest.Config`` for :class:`Config <pytest.Config>`. - ``pytest.Mark`` for :class:`marks <pytest.Mark>`. - ``pytest.MarkDecorator`` for :class:`mark decorators <pytest.MarkDecorator>`. - ``pytest.MarkGenerator`` for the :class:`pytest.mark <pytest.MarkGenerator>` singleton. - ``pytest.Metafunc`` for the :class:`metafunc <pytest.MarkGenerator>` argument to the 🪝`pytest_generate_tests` hook. - ``pytest.CallInfo`` for the :class:`CallInfo <pytest.CallInfo>` type passed to various hooks. - ``pytest.PytestPluginManager`` for :class:`PytestPluginManager <pytest.PytestPluginManager>`. - ``pytest.ExceptionInfo`` for the :class:`ExceptionInfo <pytest.ExceptionInfo>` type returned from :func:`pytest.raises` and passed to various hooks. - ``pytest.Parser`` for the :class:`Parser <pytest.Parser>` type passed to the 🪝`pytest_addoption` hook. - ``pytest.OptionGroup`` for the :class:`OptionGroup <pytest.OptionGroup>` type returned from the :func:`parser.addgroup <pytest.Parser.getgroup>` method. - ``pytest.HookRecorder`` for the :class:`HookRecorder <pytest.HookRecorder>` type returned from :class:`~pytest.Pytester`. - ``pytest.RecordedHookCall`` for the :class:`RecordedHookCall <pytest.HookRecorder>` type returned from :class:`~pytest.HookRecorder`. - ``pytest.RunResult`` for the :class:`RunResult <pytest.RunResult>` type returned from :class:`~pytest.Pytester`. - ``pytest.LineMatcher`` for the :class:`LineMatcher <pytest.RunResult>` type used in :class:`~pytest.RunResult` and others. - ``pytest.TestReport`` for the :class:`TestReport <pytest.TestReport>` type used in various hooks. - ``pytest.CollectReport`` for the :class:`CollectReport <pytest.CollectReport>` type used in various hooks. Constructing most of them directly is not supported; they are only meant for use in type annotations. Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0. Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy. - `7856 <https://github.com/pytest-dev/pytest/issues/7856>`_: :ref:`--import-mode=importlib <import-modes>` now works with features that depend on modules being on :py:data:`sys.modules`, such as :mod:`pickle` and :mod:`dataclasses`. - `8144 <https://github.com/pytest-dev/pytest/issues/8144>`_: The following hooks now receive an additional ``pathlib.Path`` argument, equivalent to an existing ``py.path.local`` argument: - 🪝`pytest_ignore_collect` - The ``collection_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_collect_file` - The ``file_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_pycollect_makemodule` - The ``module_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_report_header` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). - 🪝`pytest_report_collectionfinish` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8251 <https://github.com/pytest-dev/pytest/issues/8251>`_: Implement ``Node.path`` as a ``pathlib.Path``. Both the old ``fspath`` and this new attribute gets set no matter whether ``path`` or ``fspath`` (deprecated) is passed to the constructor. It is a replacement for the ``fspath`` attribute (which represents the same path as ``py.path.local``). While ``fspath`` is not deprecated yet due to the ongoing migration of methods like :meth:`~_pytest.Item.reportinfo`, we expect to deprecate it in a future release. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8421 <https://github.com/pytest-dev/pytest/issues/8421>`_: :func:`pytest.approx` now works on :class:`~decimal.Decimal` within mappings/dicts and sequences/lists. - `8606 <https://github.com/pytest-dev/pytest/issues/8606>`_: pytest invocations with ``--fixtures-per-test`` and ``--fixtures`` have been enriched with: - Fixture location path printed with the fixture name. - First section of the fixture's docstring printed under the fixture name. - Whole of fixture's docstring printed under the fixture name using ``--verbose`` option. - `8761 <https://github.com/pytest-dev/pytest/issues/8761>`_: New :ref:`version-tuple` attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions). - `8789 <https://github.com/pytest-dev/pytest/issues/8789>`_: Switch TOML parser from ``toml`` to ``tomli`` for TOML v1.0.0 support in ``pyproject.toml``. - `8920 <https://github.com/pytest-dev/pytest/issues/8920>`_: Added :class:`pytest.Stash`, a facility for plugins to store their data on :class:`~pytest.Config` and :class:`~_pytest.nodes.Node`\s in a type-safe and conflict-free manner. See :ref:`plugin-stash` for details. - `8953 <https://github.com/pytest-dev/pytest/issues/8953>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``warnings`` argument to assert the total number of warnings captured. - `8954 <https://github.com/pytest-dev/pytest/issues/8954>`_: ``--debug`` flag now accepts a :class:`str` file to route debug logs into, remains defaulted to `pytestdebug.log`. - `9023 <https://github.com/pytest-dev/pytest/issues/9023>`_: Full diffs are now always shown for equality assertions of iterables when `CI` or ``BUILD_NUMBER`` is found in the environment, even when ``-v`` isn't used. - `9113 <https://github.com/pytest-dev/pytest/issues/9113>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``deselected`` argument to assert the total number of deselected tests. - `9114 <https://github.com/pytest-dev/pytest/issues/9114>`_: Added :confval:`pythonpath` setting that adds listed paths to :data:`sys.path` for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in `pythonpath` setting. Improvements ------------ - `7480 <https://github.com/pytest-dev/pytest/issues/7480>`_: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category `PytestRemovedInXWarning`, a subclass of :class:`~pytest.PytestDeprecationWarning`, instead of :class:`PytestDeprecationWarning` directly. See :ref:`backwards-compatibility` for more details. - `7864 <https://github.com/pytest-dev/pytest/issues/7864>`_: Improved error messages when parsing warning filters. Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause of the problem (for example an ``ImportError`` while importing a specific warning type). - `8335 <https://github.com/pytest-dev/pytest/issues/8335>`_: Improved :func:`pytest.approx` assertion messages for sequences of numbers. The assertion messages now dumps a table with the index and the error of each diff. Example:: > assert [1, 2, 3, 4] == pytest.approx([1, 3, 3, 5]) E assert comparison failed for 2 values: E Index | Obtained | Expected E 1 | 2 | 3 +- 3.0e-06 E 3 | 4 | 5 +- 5.0e-06 - `8403 <https://github.com/pytest-dev/pytest/issues/8403>`_: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much, currently at ``240`` characters by default. However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using ``-v`` will now increase the truncation threshold to ``2400`` characters, and ``-vv`` or higher will disable truncation entirely. - `8509 <https://github.com/pytest-dev/pytest/issues/8509>`_: Fixed issue where :meth:`unittest.TestCase.setUpClass` is not called when a test has `/` in its name since pytest 6.2.0. This refers to the path part in pytest node IDs, e.g. ``TestClass::test_it`` in the node ID ``tests/test_file.py::TestClass::test_it``. Now, instead of assuming that the test name does not contain ``/``, it is assumed that test path does not contain ``::``. We plan to hopefully make both of these work in the future. - `8803 <https://github.com/pytest-dev/pytest/issues/8803>`_: It is now possible to add colors to custom log levels on cli log. By using :func:`add_color_level <_pytest.logging.add_color_level>` from a ``pytest_configure`` hook, colors can be added:: logging_plugin = config.pluginmanager.get_plugin('logging-plugin') logging_plugin.log_cli_handler.formatter.add_color_level(logging.INFO, 'cyan') logging_plugin.log_cli_handler.formatter.add_color_level(logging.SPAM, 'blue') See :ref:`log_colors` for more information. - `8822 <https://github.com/pytest-dev/pytest/issues/8822>`_: When showing fixture paths in `--fixtures` or `--fixtures-by-test`, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the `site-packages` directory. - `8898 <https://github.com/pytest-dev/pytest/issues/8898>`_: Complex numbers are now treated like floats and integers when generating parameterization IDs. - `9062 <https://github.com/pytest-dev/pytest/issues/9062>`_: ``--stepwise-skip`` now implicitly enables ``--stepwise`` and can be used on its own. - `9205 <https://github.com/pytest-dev/pytest/issues/9205>`_: :meth:`pytest.Cache.set` now preserves key order when saving dicts. Bug Fixes --------- - `7124 <https://github.com/pytest-dev/pytest/issues/7124>`_: Fixed an issue where ``__main__.py`` would raise an ``ImportError`` when ``--doctest-modules`` was provided. - `8061 <https://github.com/pytest-dev/pytest/issues/8061>`_: Fixed failing ``staticmethod`` test cases if they are inherited from a parent test class. - `8192 <https://github.com/pytest-dev/pytest/issues/8192>`_: ``testdir.makefile`` now silently accepts values which don't start with ``.`` to maintain backward compatibility with older pytest versions. ``pytester.makefile`` now issues a clearer error if the ``.`` is missing in the ``ext`` argument. - `8258 <https://github.com/pytest-dev/pytest/issues/8258>`_: Fixed issue where pytest's ``faulthandler`` support would not dump traceback on crashes if the :mod:`faulthandler` module was already enabled during pytest startup (using ``python -X dev -m pytest`` for example). - `8317 <https://github.com/pytest-dev/pytest/issues/8317>`_: Fixed an issue where illegal directory characters derived from ``getpass.getuser()`` raised an ``OSError``. - `8367 <https://github.com/pytest-dev/pytest/issues/8367>`_: Fix ``Class.from_parent`` so it forwards extra keyword arguments to the constructor. - `8377 <https://github.com/pytest-dev/pytest/issues/8377>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing forward slash (``/``) characters. - `8384 <https://github.com/pytest-dev/pytest/issues/8384>`_: The ``pytest.mark.skip`` decorator now correctly handles its arguments. When the ``reason`` argument is accidentally given both positional and as a keyword (e.g. because it was confused with ``skipif``), a ``TypeError`` now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally, ``reason`` is now documented correctly as positional or keyword (rather than keyword-only). - `8394 <https://github.com/pytest-dev/pytest/issues/8394>`_: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default ``--fixtures`` invocation (but they still show up with ``--fixtures -v``). - `8456 <https://github.com/pytest-dev/pytest/issues/8456>`_: The :confval:`required_plugins` config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all. - `8464 <https://github.com/pytest-dev/pytest/issues/8464>`_: ``-c <config file>`` now also properly defines ``rootdir`` as the directory that contains ``<config file>``. - `8503 <https://github.com/pytest-dev/pytest/issues/8503>`_: :meth:`pytest.MonkeyPatch.syspath_prepend` no longer fails when ``setuptools`` is not installed. It now only calls :func:`pkg_resources.fixup_namespace_packages` if ``pkg_resources`` was previously imported, because it is not needed otherwise. - `8548 <https://github.com/pytest-dev/pytest/issues/8548>`_: Introduce fix to handle precision width in ``log-cli-format`` in turn to fix output coloring for certain formats. - `8796 <https://github.com/pytest-dev/pytest/issues/8796>`_: Fixed internal error when skipping doctests. - `8983 <https://github.com/pytest-dev/pytest/issues/8983>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing backslash (`\\`) characters. Backslashes are treated literally, not as escape characters (the values being matched against are already escaped). - `8990 <https://github.com/pytest-dev/pytest/issues/8990>`_: Fix `pytest -vv` crashing with an internal exception `AttributeError: 'str' object has no attribute 'relative_to'` in some cases. - `9077 <https://github.com/pytest-dev/pytest/issues/9077>`_: Fixed confusing error message when ``request.fspath`` / ``request.path`` was accessed from a session-scoped fixture. - `9131 <https://github.com/pytest-dev/pytest/issues/9131>`_: Fixed the URL used by ``--pastebin`` to use `bpa.st <http://bpa.st>`__. - `9163 <https://github.com/pytest-dev/pytest/issues/9163>`_: The end line number and end column offset are now properly set for rewritten assert statements. - `9169 <https://github.com/pytest-dev/pytest/issues/9169>`_: Support for the ``files`` API from ``importlib.resources`` within rewritten files. - `9272 <https://github.com/pytest-dev/pytest/issues/9272>`_: The nose compatibility module-level fixtures `setup()` and `teardown()` are now only called once per module, instead of for each test function. They are now called even if object-level `setup`/`teardown` is defined. Improved Documentation ---------------------- - `4320 <https://github.com/pytest-dev/pytest/issues/4320>`_: Improved docs for `pytester.copy_example`. - `5105 <https://github.com/pytest-dev/pytest/issues/5105>`_: Add automatically generated :ref:`plugin-list`. The list is updated on a periodic schedule. - `8337 <https://github.com/pytest-dev/pytest/issues/8337>`_: Recommend `numpy.testing <https://numpy.org/doc/stable/reference/routines.testing.html>`__ module on :func:`pytest.approx` documentation. - `8655 <https://github.com/pytest-dev/pytest/issues/8655>`_: Help text for ``--pdbcls`` more accurately reflects the option's behavior. - `9210 <https://github.com/pytest-dev/pytest/issues/9210>`_: Remove incorrect docs about ``confcutdir`` being a configuration option: it can only be set through the ``--confcutdir`` command-line option. - `9242 <https://github.com/pytest-dev/pytest/issues/9242>`_: Upgrade readthedocs configuration to use a `newer Ubuntu version <https://blog.readthedocs.com/new-build-specification/>`__` with better unicode support for PDF docs. - `9341 <https://github.com/pytest-dev/pytest/issues/9341>`_: Various methods commonly used for :ref:`non-python tests` are now correctly documented in the reference docs. They were undocumented previously. Trivial/Internal Changes ------------------------ - `8133 <https://github.com/pytest-dev/pytest/issues/8133>`_: Migrate to ``setuptools_scm`` 6.x to use ``SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST`` for more robust release tooling. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to internal pytest types/functions: - The ``_pytest.code.getfslineno()`` function returns ``Path`` instead of ``py.path.local``. - The ``_pytest.python.path_matches_patterns()`` function takes ``Path`` instead of ``py.path.local``. - The ``_pytest._code.Traceback.cut()`` function accepts any ``os.PathLike[str]``, not just ``py.path.local``. - `8248 <https://github.com/pytest-dev/pytest/issues/8248>`_: Internal Restructure: let ``python.PyObjMixin`` inherit from ``nodes.Node`` to carry over typing information. - `8432 <https://github.com/pytest-dev/pytest/issues/8432>`_: Improve error message when :func:`pytest.skip` is used at module level without passing `allow_module_level=True`. - `8818 <https://github.com/pytest-dev/pytest/issues/8818>`_: Ensure ``regendoc`` opts out of ``TOX_ENV`` cachedir selection to ensure independent example test runs. - `8913 <https://github.com/pytest-dev/pytest/issues/8913>`_: The private ``CallSpec2._arg2scopenum`` attribute has been removed after an internal refactoring. - `8967 <https://github.com/pytest-dev/pytest/issues/8967>`_: 🪝`pytest_assertion_pass` is no longer considered experimental and future changes to it will be considered more carefully. - `9202 <https://github.com/pytest-dev/pytest/issues/9202>`_: Add github action to upload coverage report to codecov instead of bash uploader. - `9225 <https://github.com/pytest-dev/pytest/issues/9225>`_: Changed the command used to create sdist and wheel artifacts: using the build package instead of setup.py. - `9351 <https://github.com/pytest-dev/pytest/issues/9351>`_: Correct minor typos in doc/en/example/special.rst. ``` ### 6.2.5 ``` ========================= Trivial/Internal Changes ------------------------ - :issue:`8494`: Python 3.10 is now supported. - :issue:`9040`: Enable compatibility with ``pluggy 1.0`` or later. ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/pytest - Changelog: https://pyup.io/changelogs/pytest/ - Homepage: https://docs.pytest.org/en/latest/ </details> Co-authored-by: pyup-bot <github-bot@pyup.io>

35: Update sphinx_rtd_theme to 1.0.0 r=aragilar a=pyup-bot This PR updates [sphinx_rtd_theme](https://pypi.org/project/sphinx_rtd_theme) from **0.5.2** to **1.0.0**. *The bot wasn't able to find a changelog for this release. [Got an idea?](https://github.com/pyupio/changelogs/issues/new)* <details> <summary>Links</summary> - PyPI: https://pypi.org/project/sphinx-rtd-theme - Repo: https://github.com/readthedocs/sphinx_rtd_theme </details> 36: Update pytest to 7.1.1 r=aragilar a=pyup-bot This PR updates [pytest](https://pypi.org/project/pytest) from **6.2.4** to **7.1.1**. <details> <summary>Changelog</summary> ### 7.1.0 ``` ========================= Breaking Changes ---------------- - `8838 <https://github.com/pytest-dev/pytest/issues/8838>`_: As per our policy, the following features have been deprecated in the 6.X series and are now removed: * ``pytest._fillfuncargs`` function. * ``pytest_warning_captured`` hook - use ``pytest_warning_recorded`` instead. * ``-k -foobar`` syntax - use ``-k 'not foobar'`` instead. * ``-k foobar:`` syntax. * ``pytest.collect`` module - import from ``pytest`` directly. For more information consult `Deprecations and Removals <https://docs.pytest.org/en/latest/deprecations.html>`__ in the docs. - `9437 <https://github.com/pytest-dev/pytest/issues/9437>`_: Dropped support for Python 3.6, which reached `end-of-life <https://devguide.python.org/#status-of-python-branches>`__ at 2021-12-23. Improvements ------------ - `5192 <https://github.com/pytest-dev/pytest/issues/5192>`_: Fixed test output for some data types where ``-v`` would show less information. Also, when showing diffs for sequences, ``-q`` would produce full diffs instead of the expected diff. - `9362 <https://github.com/pytest-dev/pytest/issues/9362>`_: pytest now avoids specialized assert formatting when it is detected that the default ``__eq__`` is overridden in ``attrs`` or ``dataclasses``. - `9536 <https://github.com/pytest-dev/pytest/issues/9536>`_: When ``-vv`` is given on command line, show skipping and xfail reasons in full instead of truncating them to fit the terminal width. - `9644 <https://github.com/pytest-dev/pytest/issues/9644>`_: More information about the location of resources that led Python to raise :class:`ResourceWarning` can now be obtained by enabling :mod:`tracemalloc`. See :ref:`resource-warnings` for more information. - `9678 <https://github.com/pytest-dev/pytest/issues/9678>`_: More types are now accepted in the ``ids`` argument to ``pytest.mark.parametrize``. Previously only `str`, `float`, `int` and `bool` were accepted; now `bytes`, `complex`, `re.Pattern`, `Enum` and anything with a `__name__` are also accepted. - `9692 <https://github.com/pytest-dev/pytest/issues/9692>`_: :func:`pytest.approx` now raises a :class:`TypeError` when given an unordered sequence (such as :class:`set`). Note that this implies that custom classes which only implement ``__iter__`` and ``__len__`` are no longer supported as they don't guarantee order. Bug Fixes --------- - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: The deprecation of raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is reverted - this is now a supported feature again. - `9493 <https://github.com/pytest-dev/pytest/issues/9493>`_: Symbolic link components are no longer resolved in conftest paths. This means that if a conftest appears twice in collection tree, using symlinks, it will be executed twice. For example, given tests/real/conftest.py tests/real/test_it.py tests/link -> tests/real running ``pytest tests`` now imports the conftest twice, once as ``tests/real/conftest.py`` and once as ``tests/link/conftest.py``. This is a fix to match a similar change made to test collection itself in pytest 6.0 (see :pull:`6523` for details). - `9626 <https://github.com/pytest-dev/pytest/issues/9626>`_: Fixed count of selected tests on terminal collection summary when there were errors or skipped modules. If there were errors or skipped modules on collection, pytest would mistakenly subtract those from the selected count. - `9645 <https://github.com/pytest-dev/pytest/issues/9645>`_: Fixed regression where ``--import-mode=importlib`` used together with :envvar:`PYTHONPATH` or :confval:`pythonpath` would cause import errors in test suites. - `9708 <https://github.com/pytest-dev/pytest/issues/9708>`_: :fixture:`pytester` now requests a :fixture:`monkeypatch` fixture instead of creating one internally. This solves some issues with tests that involve pytest environment variables. - `9730 <https://github.com/pytest-dev/pytest/issues/9730>`_: Malformed ``pyproject.toml`` files now produce a clearer error message. ``` ### 7.0.1 ``` ========================= Bug Fixes --------- - `9608 <https://github.com/pytest-dev/pytest/issues/9608>`_: Fix invalid importing of ``importlib.readers`` in Python 3.9. - `9610 <https://github.com/pytest-dev/pytest/issues/9610>`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method. Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`. Regressed in pytest 7.0.0. - `9636 <https://github.com/pytest-dev/pytest/issues/9636>`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin. - `9642 <https://github.com/pytest-dev/pytest/issues/9642>`_: Fix running tests by id with ``::`` in the parametrize portion. - `9643 <https://github.com/pytest-dev/pytest/issues/9643>`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters <warnings>`. ``` ### 7.0.0 ``` ========================= (**Please see the full set of changes for this release also in the 7.0.0rc1 notes below**) Deprecations ------------ - `9488 <https://github.com/pytest-dev/pytest/issues/9488>`_: If custom subclasses of nodes like :class:`pytest.Item` override the ``__init__`` method, they should take ``**kwargs``. See :ref:`uncooperative-constructors-deprecated` for details. Note that a deprection warning is only emitted when there is a conflict in the arguments pytest expected to pass. This deprecation was already part of pytest 7.0.0rc1 but wasn't documented. Bug Fixes --------- - `9355 <https://github.com/pytest-dev/pytest/issues/9355>`_: Fixed error message prints function decorators when using assert in Python 3.8 and above. - `9396 <https://github.com/pytest-dev/pytest/issues/9396>`_: Ensure :attr:`pytest.Config.inifile` is available during the :func:`pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>` hook (regression during ``7.0.0rc1``). Improved Documentation ---------------------- - `9404 <https://github.com/pytest-dev/pytest/issues/9404>`_: Added extra documentation on alternatives to common misuses of `pytest.warns(None)` ahead of its deprecation. - `9505 <https://github.com/pytest-dev/pytest/issues/9505>`_: Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository. Trivial/Internal Changes ------------------------ - `9521 <https://github.com/pytest-dev/pytest/issues/9521>`_: Add test coverage to assertion rewrite path. ``` ### 7.0.0rc1 ``` ============================ Breaking Changes ---------------- - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: The :ref:`Node.reportinfo() <non-python tests>` function first return value type has been expanded from `py.path.local | str` to `os.PathLike[str] | str`. Most plugins which refer to `reportinfo()` only define it as part of a custom :class:`pytest.Item` implementation. 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. - `8246 <https://github.com/pytest-dev/pytest/issues/8246>`_: ``--version`` now writes version information to ``stdout`` rather than ``stderr``. - `8733 <https://github.com/pytest-dev/pytest/issues/8733>`_: Drop a workaround for `pyreadline <https://github.com/pyreadline/pyreadline>`__ that made it work with ``--pdb``. The workaround was introduced in `1281 <https://github.com/pytest-dev/pytest/pull/1281>`__ in 2015, however since then `pyreadline seems to have gone unmaintained <https://github.com/pyreadline/pyreadline/issues/58>`__, is `generating warnings <https://github.com/pytest-dev/pytest/issues/8847>`__, and will stop working on Python 3.10. - `9061 <https://github.com/pytest-dev/pytest/issues/9061>`_: Using :func:`pytest.approx` in a boolean context now raises an error hinting at the proper usage. It is apparently common for users to mistakenly use ``pytest.approx`` like this: .. code-block:: python assert pytest.approx(actual, expected) While the correct usage is: .. code-block:: python assert actual == pytest.approx(expected) The new error message helps catch those mistakes. - `9277 <https://github.com/pytest-dev/pytest/issues/9277>`_: The ``pytest.Instance`` collector type has been removed. Importing ``pytest.Instance`` or ``_pytest.python.Instance`` returns a dummy type and emits a deprecation warning. See :ref:`instance-collector-deprecation` for details. - `9308 <https://github.com/pytest-dev/pytest/issues/9308>`_: **PytestRemovedIn7Warning deprecation warnings are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type ``PytestRemovedIn7Warning`` now generate errors instead of warning messages by default. **The affected features will be effectively removed in pytest 7.1**, so please consult the :ref:`deprecations` section in the docs for directions on how to update existing code. In the pytest ``7.0.X`` series, it is possible to change the errors back into warnings as a stopgap measure by adding this to your ``pytest.ini`` file: .. code-block:: ini [pytest] filterwarnings = ignore::pytest.PytestRemovedIn7Warning But this will stop working when pytest ``7.1`` is released. **If you have concerns** about the removal of a specific feature, please add a comment to :issue:`9308`. Deprecations ------------ - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: ``py.path.local`` arguments for hooks have been deprecated. See :ref:`the deprecation note <legacy-path-hooks-deprecated>` for full details. ``py.path.local`` arguments to Node constructors have been deprecated. See :ref:`the deprecation note <node-ctor-fspath-deprecation>` for full details. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: 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. - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: Raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is deprecated. Use :func:`pytest.skip` instead. Note: This deprecation only relates to using :class:`unittest.SkipTest` during test 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. .. note:: This deprecation has been reverted in pytest 7.1.0. - `8315 <https://github.com/pytest-dev/pytest/issues/8315>`_: Several behaviors of :meth:`Parser.addoption <pytest.Parser.addoption>` are now 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. - `8447 <https://github.com/pytest-dev/pytest/issues/8447>`_: Defining a custom pytest node type which is both an :class:`pytest.Item <Item>` and a :class:`pytest.Collector <Collector>` (e.g. :class:`pytest.File <File>`) now issues a warning. It was never sanely supported and triggers hard to debug errors. See :ref:`the deprecation note <diamond-inheritance-deprecated>` for full details. - `8592 <https://github.com/pytest-dev/pytest/issues/8592>`_: 🪝`pytest_cmdline_preparse` has been officially deprecated. It will be removed in a future release. Use 🪝`pytest_load_initial_conftests` instead. See :ref:`the deprecation note <cmdline-preparse-deprecated>` for full details. - `8645 <https://github.com/pytest-dev/pytest/issues/8645>`_: :func:`pytest.warns(None) <pytest.warns>` 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)``. - `8948 <https://github.com/pytest-dev/pytest/issues/8948>`_: :func:`pytest.skip(msg=...) <pytest.skip>`, :func:`pytest.fail(msg=...) <pytest.fail>` and :func:`pytest.exit(msg=...) <pytest.exit>` signatures now accept a ``reason`` argument instead of ``msg``. Using ``msg`` still works, but is deprecated and will be removed in a future release. This was changed for consistency with :func:`pytest.mark.skip <pytest.mark.skip>` and :func:`pytest.mark.xfail <pytest.mark.xfail>` which both accept ``reason`` as an argument. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to types reachable through :attr:`pytest.ExceptionInfo.traceback`: - The ``path`` property of ``_pytest.code.Code`` returns ``Path`` instead of ``py.path.local``. - The ``path`` property of ``_pytest.code.TracebackEntry`` returns ``Path`` instead of ``py.path.local``. There was no deprecation period for this change (sorry!). Features -------- - `5196 <https://github.com/pytest-dev/pytest/issues/5196>`_: Tests are now ordered by definition order in more cases. In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order). - `7132 <https://github.com/pytest-dev/pytest/issues/7132>`_: Added two environment variables :envvar:`PYTEST_THEME` and :envvar:`PYTEST_THEME_MODE` to let the users customize the pygments theme used. - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: Added :meth:`cache.mkdir() <pytest.Cache.mkdir>`, which is similar to the existing :meth:`cache.makedir() <pytest.Cache.makedir>`, but returns a :class:`pathlib.Path` instead of a legacy ``py.path.local``. Added a ``paths`` type to :meth:`parser.addini() <pytest.Parser.addini>`, as in ``parser.addini("mypaths", "my paths", type="paths")``, which is similar to the existing ``pathlist``, but returns a list of :class:`pathlib.Path` instead of legacy ``py.path.local``. - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: The types of objects used in pytest's API are now exported so they may be used in type annotations. The newly-exported types are: - ``pytest.Config`` for :class:`Config <pytest.Config>`. - ``pytest.Mark`` for :class:`marks <pytest.Mark>`. - ``pytest.MarkDecorator`` for :class:`mark decorators <pytest.MarkDecorator>`. - ``pytest.MarkGenerator`` for the :class:`pytest.mark <pytest.MarkGenerator>` singleton. - ``pytest.Metafunc`` for the :class:`metafunc <pytest.MarkGenerator>` argument to the 🪝`pytest_generate_tests` hook. - ``pytest.CallInfo`` for the :class:`CallInfo <pytest.CallInfo>` type passed to various hooks. - ``pytest.PytestPluginManager`` for :class:`PytestPluginManager <pytest.PytestPluginManager>`. - ``pytest.ExceptionInfo`` for the :class:`ExceptionInfo <pytest.ExceptionInfo>` type returned from :func:`pytest.raises` and passed to various hooks. - ``pytest.Parser`` for the :class:`Parser <pytest.Parser>` type passed to the 🪝`pytest_addoption` hook. - ``pytest.OptionGroup`` for the :class:`OptionGroup <pytest.OptionGroup>` type returned from the :func:`parser.addgroup <pytest.Parser.getgroup>` method. - ``pytest.HookRecorder`` for the :class:`HookRecorder <pytest.HookRecorder>` type returned from :class:`~pytest.Pytester`. - ``pytest.RecordedHookCall`` for the :class:`RecordedHookCall <pytest.HookRecorder>` type returned from :class:`~pytest.HookRecorder`. - ``pytest.RunResult`` for the :class:`RunResult <pytest.RunResult>` type returned from :class:`~pytest.Pytester`. - ``pytest.LineMatcher`` for the :class:`LineMatcher <pytest.RunResult>` type used in :class:`~pytest.RunResult` and others. - ``pytest.TestReport`` for the :class:`TestReport <pytest.TestReport>` type used in various hooks. - ``pytest.CollectReport`` for the :class:`CollectReport <pytest.CollectReport>` type used in various hooks. Constructing most of them directly is not supported; they are only meant for use in type annotations. Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0. Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy. - `7856 <https://github.com/pytest-dev/pytest/issues/7856>`_: :ref:`--import-mode=importlib <import-modes>` now works with features that depend on modules being on :py:data:`sys.modules`, such as :mod:`pickle` and :mod:`dataclasses`. - `8144 <https://github.com/pytest-dev/pytest/issues/8144>`_: The following hooks now receive an additional ``pathlib.Path`` argument, equivalent to an existing ``py.path.local`` argument: - 🪝`pytest_ignore_collect` - The ``collection_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_collect_file` - The ``file_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_pycollect_makemodule` - The ``module_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_report_header` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). - 🪝`pytest_report_collectionfinish` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8251 <https://github.com/pytest-dev/pytest/issues/8251>`_: Implement ``Node.path`` as a ``pathlib.Path``. Both the old ``fspath`` and this new attribute gets set no matter whether ``path`` or ``fspath`` (deprecated) is passed to the constructor. It is a replacement for the ``fspath`` attribute (which represents the same path as ``py.path.local``). While ``fspath`` is not deprecated yet due to the ongoing migration of methods like :meth:`~_pytest.Item.reportinfo`, we expect to deprecate it in a future release. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8421 <https://github.com/pytest-dev/pytest/issues/8421>`_: :func:`pytest.approx` now works on :class:`~decimal.Decimal` within mappings/dicts and sequences/lists. - `8606 <https://github.com/pytest-dev/pytest/issues/8606>`_: pytest invocations with ``--fixtures-per-test`` and ``--fixtures`` have been enriched with: - Fixture location path printed with the fixture name. - First section of the fixture's docstring printed under the fixture name. - Whole of fixture's docstring printed under the fixture name using ``--verbose`` option. - `8761 <https://github.com/pytest-dev/pytest/issues/8761>`_: New :ref:`version-tuple` attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions). - `8789 <https://github.com/pytest-dev/pytest/issues/8789>`_: Switch TOML parser from ``toml`` to ``tomli`` for TOML v1.0.0 support in ``pyproject.toml``. - `8920 <https://github.com/pytest-dev/pytest/issues/8920>`_: Added :class:`pytest.Stash`, a facility for plugins to store their data on :class:`~pytest.Config` and :class:`~_pytest.nodes.Node`\s in a type-safe and conflict-free manner. See :ref:`plugin-stash` for details. - `8953 <https://github.com/pytest-dev/pytest/issues/8953>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``warnings`` argument to assert the total number of warnings captured. - `8954 <https://github.com/pytest-dev/pytest/issues/8954>`_: ``--debug`` flag now accepts a :class:`str` file to route debug logs into, remains defaulted to `pytestdebug.log`. - `9023 <https://github.com/pytest-dev/pytest/issues/9023>`_: Full diffs are now always shown for equality assertions of iterables when `CI` or ``BUILD_NUMBER`` is found in the environment, even when ``-v`` isn't used. - `9113 <https://github.com/pytest-dev/pytest/issues/9113>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``deselected`` argument to assert the total number of deselected tests. - `9114 <https://github.com/pytest-dev/pytest/issues/9114>`_: Added :confval:`pythonpath` setting that adds listed paths to :data:`sys.path` for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in `pythonpath` setting. Improvements ------------ - `7480 <https://github.com/pytest-dev/pytest/issues/7480>`_: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category `PytestRemovedInXWarning`, a subclass of :class:`~pytest.PytestDeprecationWarning`, instead of :class:`PytestDeprecationWarning` directly. See :ref:`backwards-compatibility` for more details. - `7864 <https://github.com/pytest-dev/pytest/issues/7864>`_: Improved error messages when parsing warning filters. Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause of the problem (for example an ``ImportError`` while importing a specific warning type). - `8335 <https://github.com/pytest-dev/pytest/issues/8335>`_: Improved :func:`pytest.approx` assertion messages for sequences of numbers. The assertion messages now dumps a table with the index and the error of each diff. Example:: > assert [1, 2, 3, 4] == pytest.approx([1, 3, 3, 5]) E assert comparison failed for 2 values: E Index | Obtained | Expected E 1 | 2 | 3 +- 3.0e-06 E 3 | 4 | 5 +- 5.0e-06 - `8403 <https://github.com/pytest-dev/pytest/issues/8403>`_: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much, currently at ``240`` characters by default. However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using ``-v`` will now increase the truncation threshold to ``2400`` characters, and ``-vv`` or higher will disable truncation entirely. - `8509 <https://github.com/pytest-dev/pytest/issues/8509>`_: Fixed issue where :meth:`unittest.TestCase.setUpClass` is not called when a test has `/` in its name since pytest 6.2.0. This refers to the path part in pytest node IDs, e.g. ``TestClass::test_it`` in the node ID ``tests/test_file.py::TestClass::test_it``. Now, instead of assuming that the test name does not contain ``/``, it is assumed that test path does not contain ``::``. We plan to hopefully make both of these work in the future. - `8803 <https://github.com/pytest-dev/pytest/issues/8803>`_: It is now possible to add colors to custom log levels on cli log. By using :func:`add_color_level <_pytest.logging.add_color_level>` from a ``pytest_configure`` hook, colors can be added:: logging_plugin = config.pluginmanager.get_plugin('logging-plugin') logging_plugin.log_cli_handler.formatter.add_color_level(logging.INFO, 'cyan') logging_plugin.log_cli_handler.formatter.add_color_level(logging.SPAM, 'blue') See :ref:`log_colors` for more information. - `8822 <https://github.com/pytest-dev/pytest/issues/8822>`_: When showing fixture paths in `--fixtures` or `--fixtures-by-test`, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the `site-packages` directory. - `8898 <https://github.com/pytest-dev/pytest/issues/8898>`_: Complex numbers are now treated like floats and integers when generating parameterization IDs. - `9062 <https://github.com/pytest-dev/pytest/issues/9062>`_: ``--stepwise-skip`` now implicitly enables ``--stepwise`` and can be used on its own. - `9205 <https://github.com/pytest-dev/pytest/issues/9205>`_: :meth:`pytest.Cache.set` now preserves key order when saving dicts. Bug Fixes --------- - `7124 <https://github.com/pytest-dev/pytest/issues/7124>`_: Fixed an issue where ``__main__.py`` would raise an ``ImportError`` when ``--doctest-modules`` was provided. - `8061 <https://github.com/pytest-dev/pytest/issues/8061>`_: Fixed failing ``staticmethod`` test cases if they are inherited from a parent test class. - `8192 <https://github.com/pytest-dev/pytest/issues/8192>`_: ``testdir.makefile`` now silently accepts values which don't start with ``.`` to maintain backward compatibility with older pytest versions. ``pytester.makefile`` now issues a clearer error if the ``.`` is missing in the ``ext`` argument. - `8258 <https://github.com/pytest-dev/pytest/issues/8258>`_: Fixed issue where pytest's ``faulthandler`` support would not dump traceback on crashes if the :mod:`faulthandler` module was already enabled during pytest startup (using ``python -X dev -m pytest`` for example). - `8317 <https://github.com/pytest-dev/pytest/issues/8317>`_: Fixed an issue where illegal directory characters derived from ``getpass.getuser()`` raised an ``OSError``. - `8367 <https://github.com/pytest-dev/pytest/issues/8367>`_: Fix ``Class.from_parent`` so it forwards extra keyword arguments to the constructor. - `8377 <https://github.com/pytest-dev/pytest/issues/8377>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing forward slash (``/``) characters. - `8384 <https://github.com/pytest-dev/pytest/issues/8384>`_: The ``pytest.mark.skip`` decorator now correctly handles its arguments. When the ``reason`` argument is accidentally given both positional and as a keyword (e.g. because it was confused with ``skipif``), a ``TypeError`` now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally, ``reason`` is now documented correctly as positional or keyword (rather than keyword-only). - `8394 <https://github.com/pytest-dev/pytest/issues/8394>`_: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default ``--fixtures`` invocation (but they still show up with ``--fixtures -v``). - `8456 <https://github.com/pytest-dev/pytest/issues/8456>`_: The :confval:`required_plugins` config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all. - `8464 <https://github.com/pytest-dev/pytest/issues/8464>`_: ``-c <config file>`` now also properly defines ``rootdir`` as the directory that contains ``<config file>``. - `8503 <https://github.com/pytest-dev/pytest/issues/8503>`_: :meth:`pytest.MonkeyPatch.syspath_prepend` no longer fails when ``setuptools`` is not installed. It now only calls :func:`pkg_resources.fixup_namespace_packages` if ``pkg_resources`` was previously imported, because it is not needed otherwise. - `8548 <https://github.com/pytest-dev/pytest/issues/8548>`_: Introduce fix to handle precision width in ``log-cli-format`` in turn to fix output coloring for certain formats. - `8796 <https://github.com/pytest-dev/pytest/issues/8796>`_: Fixed internal error when skipping doctests. - `8983 <https://github.com/pytest-dev/pytest/issues/8983>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing backslash (`\\`) characters. Backslashes are treated literally, not as escape characters (the values being matched against are already escaped). - `8990 <https://github.com/pytest-dev/pytest/issues/8990>`_: Fix `pytest -vv` crashing with an internal exception `AttributeError: 'str' object has no attribute 'relative_to'` in some cases. - `9077 <https://github.com/pytest-dev/pytest/issues/9077>`_: Fixed confusing error message when ``request.fspath`` / ``request.path`` was accessed from a session-scoped fixture. - `9131 <https://github.com/pytest-dev/pytest/issues/9131>`_: Fixed the URL used by ``--pastebin`` to use `bpa.st <http://bpa.st>`__. - `9163 <https://github.com/pytest-dev/pytest/issues/9163>`_: The end line number and end column offset are now properly set for rewritten assert statements. - `9169 <https://github.com/pytest-dev/pytest/issues/9169>`_: Support for the ``files`` API from ``importlib.resources`` within rewritten files. - `9272 <https://github.com/pytest-dev/pytest/issues/9272>`_: The nose compatibility module-level fixtures `setup()` and `teardown()` are now only called once per module, instead of for each test function. They are now called even if object-level `setup`/`teardown` is defined. Improved Documentation ---------------------- - `4320 <https://github.com/pytest-dev/pytest/issues/4320>`_: Improved docs for `pytester.copy_example`. - `5105 <https://github.com/pytest-dev/pytest/issues/5105>`_: Add automatically generated :ref:`plugin-list`. The list is updated on a periodic schedule. - `8337 <https://github.com/pytest-dev/pytest/issues/8337>`_: Recommend `numpy.testing <https://numpy.org/doc/stable/reference/routines.testing.html>`__ module on :func:`pytest.approx` documentation. - `8655 <https://github.com/pytest-dev/pytest/issues/8655>`_: Help text for ``--pdbcls`` more accurately reflects the option's behavior. - `9210 <https://github.com/pytest-dev/pytest/issues/9210>`_: Remove incorrect docs about ``confcutdir`` being a configuration option: it can only be set through the ``--confcutdir`` command-line option. - `9242 <https://github.com/pytest-dev/pytest/issues/9242>`_: Upgrade readthedocs configuration to use a `newer Ubuntu version <https://blog.readthedocs.com/new-build-specification/>`__` with better unicode support for PDF docs. - `9341 <https://github.com/pytest-dev/pytest/issues/9341>`_: Various methods commonly used for :ref:`non-python tests` are now correctly documented in the reference docs. They were undocumented previously. Trivial/Internal Changes ------------------------ - `8133 <https://github.com/pytest-dev/pytest/issues/8133>`_: Migrate to ``setuptools_scm`` 6.x to use ``SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST`` for more robust release tooling. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to internal pytest types/functions: - The ``_pytest.code.getfslineno()`` function returns ``Path`` instead of ``py.path.local``. - The ``_pytest.python.path_matches_patterns()`` function takes ``Path`` instead of ``py.path.local``. - The ``_pytest._code.Traceback.cut()`` function accepts any ``os.PathLike[str]``, not just ``py.path.local``. - `8248 <https://github.com/pytest-dev/pytest/issues/8248>`_: Internal Restructure: let ``python.PyObjMixin`` inherit from ``nodes.Node`` to carry over typing information. - `8432 <https://github.com/pytest-dev/pytest/issues/8432>`_: Improve error message when :func:`pytest.skip` is used at module level without passing `allow_module_level=True`. - `8818 <https://github.com/pytest-dev/pytest/issues/8818>`_: Ensure ``regendoc`` opts out of ``TOX_ENV`` cachedir selection to ensure independent example test runs. - `8913 <https://github.com/pytest-dev/pytest/issues/8913>`_: The private ``CallSpec2._arg2scopenum`` attribute has been removed after an internal refactoring. - `8967 <https://github.com/pytest-dev/pytest/issues/8967>`_: 🪝`pytest_assertion_pass` is no longer considered experimental and future changes to it will be considered more carefully. - `9202 <https://github.com/pytest-dev/pytest/issues/9202>`_: Add github action to upload coverage report to codecov instead of bash uploader. - `9225 <https://github.com/pytest-dev/pytest/issues/9225>`_: Changed the command used to create sdist and wheel artifacts: using the build package instead of setup.py. - `9351 <https://github.com/pytest-dev/pytest/issues/9351>`_: Correct minor typos in doc/en/example/special.rst. ``` ### 6.2.5 ``` ========================= Trivial/Internal Changes ------------------------ - :issue:`8494`: Python 3.10 is now supported. - :issue:`9040`: Enable compatibility with ``pluggy 1.0`` or later. ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/pytest - Changelog: https://pyup.io/changelogs/pytest/ - Homepage: https://docs.pytest.org/en/latest/ </details> Co-authored-by: pyup-bot <github-bot@pyup.io>

31: Update pytest to 7.1.1 r=aragilar a=pyup-bot This PR updates [pytest](https://pypi.org/project/pytest) from **6.2.4** to **7.1.1**. <details> <summary>Changelog</summary> ### 7.1.0 ``` ========================= Breaking Changes ---------------- - `8838 <https://github.com/pytest-dev/pytest/issues/8838>`_: As per our policy, the following features have been deprecated in the 6.X series and are now removed: * ``pytest._fillfuncargs`` function. * ``pytest_warning_captured`` hook - use ``pytest_warning_recorded`` instead. * ``-k -foobar`` syntax - use ``-k 'not foobar'`` instead. * ``-k foobar:`` syntax. * ``pytest.collect`` module - import from ``pytest`` directly. For more information consult `Deprecations and Removals <https://docs.pytest.org/en/latest/deprecations.html>`__ in the docs. - `9437 <https://github.com/pytest-dev/pytest/issues/9437>`_: Dropped support for Python 3.6, which reached `end-of-life <https://devguide.python.org/#status-of-python-branches>`__ at 2021-12-23. Improvements ------------ - `5192 <https://github.com/pytest-dev/pytest/issues/5192>`_: Fixed test output for some data types where ``-v`` would show less information. Also, when showing diffs for sequences, ``-q`` would produce full diffs instead of the expected diff. - `9362 <https://github.com/pytest-dev/pytest/issues/9362>`_: pytest now avoids specialized assert formatting when it is detected that the default ``__eq__`` is overridden in ``attrs`` or ``dataclasses``. - `9536 <https://github.com/pytest-dev/pytest/issues/9536>`_: When ``-vv`` is given on command line, show skipping and xfail reasons in full instead of truncating them to fit the terminal width. - `9644 <https://github.com/pytest-dev/pytest/issues/9644>`_: More information about the location of resources that led Python to raise :class:`ResourceWarning` can now be obtained by enabling :mod:`tracemalloc`. See :ref:`resource-warnings` for more information. - `9678 <https://github.com/pytest-dev/pytest/issues/9678>`_: More types are now accepted in the ``ids`` argument to ``pytest.mark.parametrize``. Previously only `str`, `float`, `int` and `bool` were accepted; now `bytes`, `complex`, `re.Pattern`, `Enum` and anything with a `__name__` are also accepted. - `9692 <https://github.com/pytest-dev/pytest/issues/9692>`_: :func:`pytest.approx` now raises a :class:`TypeError` when given an unordered sequence (such as :class:`set`). Note that this implies that custom classes which only implement ``__iter__`` and ``__len__`` are no longer supported as they don't guarantee order. Bug Fixes --------- - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: The deprecation of raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is reverted - this is now a supported feature again. - `9493 <https://github.com/pytest-dev/pytest/issues/9493>`_: Symbolic link components are no longer resolved in conftest paths. This means that if a conftest appears twice in collection tree, using symlinks, it will be executed twice. For example, given tests/real/conftest.py tests/real/test_it.py tests/link -> tests/real running ``pytest tests`` now imports the conftest twice, once as ``tests/real/conftest.py`` and once as ``tests/link/conftest.py``. This is a fix to match a similar change made to test collection itself in pytest 6.0 (see :pull:`6523` for details). - `9626 <https://github.com/pytest-dev/pytest/issues/9626>`_: Fixed count of selected tests on terminal collection summary when there were errors or skipped modules. If there were errors or skipped modules on collection, pytest would mistakenly subtract those from the selected count. - `9645 <https://github.com/pytest-dev/pytest/issues/9645>`_: Fixed regression where ``--import-mode=importlib`` used together with :envvar:`PYTHONPATH` or :confval:`pythonpath` would cause import errors in test suites. - `9708 <https://github.com/pytest-dev/pytest/issues/9708>`_: :fixture:`pytester` now requests a :fixture:`monkeypatch` fixture instead of creating one internally. This solves some issues with tests that involve pytest environment variables. - `9730 <https://github.com/pytest-dev/pytest/issues/9730>`_: Malformed ``pyproject.toml`` files now produce a clearer error message. ``` ### 7.0.1 ``` ========================= Bug Fixes --------- - `9608 <https://github.com/pytest-dev/pytest/issues/9608>`_: Fix invalid importing of ``importlib.readers`` in Python 3.9. - `9610 <https://github.com/pytest-dev/pytest/issues/9610>`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method. Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`. Regressed in pytest 7.0.0. - `9636 <https://github.com/pytest-dev/pytest/issues/9636>`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin. - `9642 <https://github.com/pytest-dev/pytest/issues/9642>`_: Fix running tests by id with ``::`` in the parametrize portion. - `9643 <https://github.com/pytest-dev/pytest/issues/9643>`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters <warnings>`. ``` ### 7.0.0 ``` ========================= (**Please see the full set of changes for this release also in the 7.0.0rc1 notes below**) Deprecations ------------ - `9488 <https://github.com/pytest-dev/pytest/issues/9488>`_: If custom subclasses of nodes like :class:`pytest.Item` override the ``__init__`` method, they should take ``**kwargs``. See :ref:`uncooperative-constructors-deprecated` for details. Note that a deprection warning is only emitted when there is a conflict in the arguments pytest expected to pass. This deprecation was already part of pytest 7.0.0rc1 but wasn't documented. Bug Fixes --------- - `9355 <https://github.com/pytest-dev/pytest/issues/9355>`_: Fixed error message prints function decorators when using assert in Python 3.8 and above. - `9396 <https://github.com/pytest-dev/pytest/issues/9396>`_: Ensure :attr:`pytest.Config.inifile` is available during the :func:`pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>` hook (regression during ``7.0.0rc1``). Improved Documentation ---------------------- - `9404 <https://github.com/pytest-dev/pytest/issues/9404>`_: Added extra documentation on alternatives to common misuses of `pytest.warns(None)` ahead of its deprecation. - `9505 <https://github.com/pytest-dev/pytest/issues/9505>`_: Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository. Trivial/Internal Changes ------------------------ - `9521 <https://github.com/pytest-dev/pytest/issues/9521>`_: Add test coverage to assertion rewrite path. ``` ### 7.0.0rc1 ``` ============================ Breaking Changes ---------------- - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: The :ref:`Node.reportinfo() <non-python tests>` function first return value type has been expanded from `py.path.local | str` to `os.PathLike[str] | str`. Most plugins which refer to `reportinfo()` only define it as part of a custom :class:`pytest.Item` implementation. 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. - `8246 <https://github.com/pytest-dev/pytest/issues/8246>`_: ``--version`` now writes version information to ``stdout`` rather than ``stderr``. - `8733 <https://github.com/pytest-dev/pytest/issues/8733>`_: Drop a workaround for `pyreadline <https://github.com/pyreadline/pyreadline>`__ that made it work with ``--pdb``. The workaround was introduced in `1281 <https://github.com/pytest-dev/pytest/pull/1281>`__ in 2015, however since then `pyreadline seems to have gone unmaintained <https://github.com/pyreadline/pyreadline/issues/58>`__, is `generating warnings <https://github.com/pytest-dev/pytest/issues/8847>`__, and will stop working on Python 3.10. - `9061 <https://github.com/pytest-dev/pytest/issues/9061>`_: Using :func:`pytest.approx` in a boolean context now raises an error hinting at the proper usage. It is apparently common for users to mistakenly use ``pytest.approx`` like this: .. code-block:: python assert pytest.approx(actual, expected) While the correct usage is: .. code-block:: python assert actual == pytest.approx(expected) The new error message helps catch those mistakes. - `9277 <https://github.com/pytest-dev/pytest/issues/9277>`_: The ``pytest.Instance`` collector type has been removed. Importing ``pytest.Instance`` or ``_pytest.python.Instance`` returns a dummy type and emits a deprecation warning. See :ref:`instance-collector-deprecation` for details. - `9308 <https://github.com/pytest-dev/pytest/issues/9308>`_: **PytestRemovedIn7Warning deprecation warnings are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type ``PytestRemovedIn7Warning`` now generate errors instead of warning messages by default. **The affected features will be effectively removed in pytest 7.1**, so please consult the :ref:`deprecations` section in the docs for directions on how to update existing code. In the pytest ``7.0.X`` series, it is possible to change the errors back into warnings as a stopgap measure by adding this to your ``pytest.ini`` file: .. code-block:: ini [pytest] filterwarnings = ignore::pytest.PytestRemovedIn7Warning But this will stop working when pytest ``7.1`` is released. **If you have concerns** about the removal of a specific feature, please add a comment to :issue:`9308`. Deprecations ------------ - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: ``py.path.local`` arguments for hooks have been deprecated. See :ref:`the deprecation note <legacy-path-hooks-deprecated>` for full details. ``py.path.local`` arguments to Node constructors have been deprecated. See :ref:`the deprecation note <node-ctor-fspath-deprecation>` for full details. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: 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. - `8242 <https://github.com/pytest-dev/pytest/issues/8242>`_: Raising :class:`unittest.SkipTest` to skip collection of tests during the pytest collection phase is deprecated. Use :func:`pytest.skip` instead. Note: This deprecation only relates to using :class:`unittest.SkipTest` during test 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. .. note:: This deprecation has been reverted in pytest 7.1.0. - `8315 <https://github.com/pytest-dev/pytest/issues/8315>`_: Several behaviors of :meth:`Parser.addoption <pytest.Parser.addoption>` are now 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. - `8447 <https://github.com/pytest-dev/pytest/issues/8447>`_: Defining a custom pytest node type which is both an :class:`pytest.Item <Item>` and a :class:`pytest.Collector <Collector>` (e.g. :class:`pytest.File <File>`) now issues a warning. It was never sanely supported and triggers hard to debug errors. See :ref:`the deprecation note <diamond-inheritance-deprecated>` for full details. - `8592 <https://github.com/pytest-dev/pytest/issues/8592>`_: 🪝`pytest_cmdline_preparse` has been officially deprecated. It will be removed in a future release. Use 🪝`pytest_load_initial_conftests` instead. See :ref:`the deprecation note <cmdline-preparse-deprecated>` for full details. - `8645 <https://github.com/pytest-dev/pytest/issues/8645>`_: :func:`pytest.warns(None) <pytest.warns>` 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)``. - `8948 <https://github.com/pytest-dev/pytest/issues/8948>`_: :func:`pytest.skip(msg=...) <pytest.skip>`, :func:`pytest.fail(msg=...) <pytest.fail>` and :func:`pytest.exit(msg=...) <pytest.exit>` signatures now accept a ``reason`` argument instead of ``msg``. Using ``msg`` still works, but is deprecated and will be removed in a future release. This was changed for consistency with :func:`pytest.mark.skip <pytest.mark.skip>` and :func:`pytest.mark.xfail <pytest.mark.xfail>` which both accept ``reason`` as an argument. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to types reachable through :attr:`pytest.ExceptionInfo.traceback`: - The ``path`` property of ``_pytest.code.Code`` returns ``Path`` instead of ``py.path.local``. - The ``path`` property of ``_pytest.code.TracebackEntry`` returns ``Path`` instead of ``py.path.local``. There was no deprecation period for this change (sorry!). Features -------- - `5196 <https://github.com/pytest-dev/pytest/issues/5196>`_: Tests are now ordered by definition order in more cases. In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order). - `7132 <https://github.com/pytest-dev/pytest/issues/7132>`_: Added two environment variables :envvar:`PYTEST_THEME` and :envvar:`PYTEST_THEME_MODE` to let the users customize the pygments theme used. - `7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: Added :meth:`cache.mkdir() <pytest.Cache.mkdir>`, which is similar to the existing :meth:`cache.makedir() <pytest.Cache.makedir>`, but returns a :class:`pathlib.Path` instead of a legacy ``py.path.local``. Added a ``paths`` type to :meth:`parser.addini() <pytest.Parser.addini>`, as in ``parser.addini("mypaths", "my paths", type="paths")``, which is similar to the existing ``pathlist``, but returns a list of :class:`pathlib.Path` instead of legacy ``py.path.local``. - `7469 <https://github.com/pytest-dev/pytest/issues/7469>`_: The types of objects used in pytest's API are now exported so they may be used in type annotations. The newly-exported types are: - ``pytest.Config`` for :class:`Config <pytest.Config>`. - ``pytest.Mark`` for :class:`marks <pytest.Mark>`. - ``pytest.MarkDecorator`` for :class:`mark decorators <pytest.MarkDecorator>`. - ``pytest.MarkGenerator`` for the :class:`pytest.mark <pytest.MarkGenerator>` singleton. - ``pytest.Metafunc`` for the :class:`metafunc <pytest.MarkGenerator>` argument to the 🪝`pytest_generate_tests` hook. - ``pytest.CallInfo`` for the :class:`CallInfo <pytest.CallInfo>` type passed to various hooks. - ``pytest.PytestPluginManager`` for :class:`PytestPluginManager <pytest.PytestPluginManager>`. - ``pytest.ExceptionInfo`` for the :class:`ExceptionInfo <pytest.ExceptionInfo>` type returned from :func:`pytest.raises` and passed to various hooks. - ``pytest.Parser`` for the :class:`Parser <pytest.Parser>` type passed to the 🪝`pytest_addoption` hook. - ``pytest.OptionGroup`` for the :class:`OptionGroup <pytest.OptionGroup>` type returned from the :func:`parser.addgroup <pytest.Parser.getgroup>` method. - ``pytest.HookRecorder`` for the :class:`HookRecorder <pytest.HookRecorder>` type returned from :class:`~pytest.Pytester`. - ``pytest.RecordedHookCall`` for the :class:`RecordedHookCall <pytest.HookRecorder>` type returned from :class:`~pytest.HookRecorder`. - ``pytest.RunResult`` for the :class:`RunResult <pytest.RunResult>` type returned from :class:`~pytest.Pytester`. - ``pytest.LineMatcher`` for the :class:`LineMatcher <pytest.RunResult>` type used in :class:`~pytest.RunResult` and others. - ``pytest.TestReport`` for the :class:`TestReport <pytest.TestReport>` type used in various hooks. - ``pytest.CollectReport`` for the :class:`CollectReport <pytest.CollectReport>` type used in various hooks. Constructing most of them directly is not supported; they are only meant for use in type annotations. Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0. Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy. - `7856 <https://github.com/pytest-dev/pytest/issues/7856>`_: :ref:`--import-mode=importlib <import-modes>` now works with features that depend on modules being on :py:data:`sys.modules`, such as :mod:`pickle` and :mod:`dataclasses`. - `8144 <https://github.com/pytest-dev/pytest/issues/8144>`_: The following hooks now receive an additional ``pathlib.Path`` argument, equivalent to an existing ``py.path.local`` argument: - 🪝`pytest_ignore_collect` - The ``collection_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_collect_file` - The ``file_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_pycollect_makemodule` - The ``module_path`` parameter (equivalent to existing ``path`` parameter). - 🪝`pytest_report_header` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). - 🪝`pytest_report_collectionfinish` - The ``start_path`` parameter (equivalent to existing ``startdir`` parameter). .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8251 <https://github.com/pytest-dev/pytest/issues/8251>`_: Implement ``Node.path`` as a ``pathlib.Path``. Both the old ``fspath`` and this new attribute gets set no matter whether ``path`` or ``fspath`` (deprecated) is passed to the constructor. It is a replacement for the ``fspath`` attribute (which represents the same path as ``py.path.local``). While ``fspath`` is not deprecated yet due to the ongoing migration of methods like :meth:`~_pytest.Item.reportinfo`, we expect to deprecate it in a future release. .. note:: The name of the :class:`~_pytest.nodes.Node` arguments and attributes (the new attribute being ``path``) is **the opposite** of the situation for hooks (the old argument being ``path``). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the :pypi:`py` dependency (see :issue:`9283` for a longer discussion). - `8421 <https://github.com/pytest-dev/pytest/issues/8421>`_: :func:`pytest.approx` now works on :class:`~decimal.Decimal` within mappings/dicts and sequences/lists. - `8606 <https://github.com/pytest-dev/pytest/issues/8606>`_: pytest invocations with ``--fixtures-per-test`` and ``--fixtures`` have been enriched with: - Fixture location path printed with the fixture name. - First section of the fixture's docstring printed under the fixture name. - Whole of fixture's docstring printed under the fixture name using ``--verbose`` option. - `8761 <https://github.com/pytest-dev/pytest/issues/8761>`_: New :ref:`version-tuple` attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions). - `8789 <https://github.com/pytest-dev/pytest/issues/8789>`_: Switch TOML parser from ``toml`` to ``tomli`` for TOML v1.0.0 support in ``pyproject.toml``. - `8920 <https://github.com/pytest-dev/pytest/issues/8920>`_: Added :class:`pytest.Stash`, a facility for plugins to store their data on :class:`~pytest.Config` and :class:`~_pytest.nodes.Node`\s in a type-safe and conflict-free manner. See :ref:`plugin-stash` for details. - `8953 <https://github.com/pytest-dev/pytest/issues/8953>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``warnings`` argument to assert the total number of warnings captured. - `8954 <https://github.com/pytest-dev/pytest/issues/8954>`_: ``--debug`` flag now accepts a :class:`str` file to route debug logs into, remains defaulted to `pytestdebug.log`. - `9023 <https://github.com/pytest-dev/pytest/issues/9023>`_: Full diffs are now always shown for equality assertions of iterables when `CI` or ``BUILD_NUMBER`` is found in the environment, even when ``-v`` isn't used. - `9113 <https://github.com/pytest-dev/pytest/issues/9113>`_: :class:`RunResult <_pytest.pytester.RunResult>` method :meth:`assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>` now accepts a ``deselected`` argument to assert the total number of deselected tests. - `9114 <https://github.com/pytest-dev/pytest/issues/9114>`_: Added :confval:`pythonpath` setting that adds listed paths to :data:`sys.path` for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in `pythonpath` setting. Improvements ------------ - `7480 <https://github.com/pytest-dev/pytest/issues/7480>`_: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category `PytestRemovedInXWarning`, a subclass of :class:`~pytest.PytestDeprecationWarning`, instead of :class:`PytestDeprecationWarning` directly. See :ref:`backwards-compatibility` for more details. - `7864 <https://github.com/pytest-dev/pytest/issues/7864>`_: Improved error messages when parsing warning filters. Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause of the problem (for example an ``ImportError`` while importing a specific warning type). - `8335 <https://github.com/pytest-dev/pytest/issues/8335>`_: Improved :func:`pytest.approx` assertion messages for sequences of numbers. The assertion messages now dumps a table with the index and the error of each diff. Example:: > assert [1, 2, 3, 4] == pytest.approx([1, 3, 3, 5]) E assert comparison failed for 2 values: E Index | Obtained | Expected E 1 | 2 | 3 +- 3.0e-06 E 3 | 4 | 5 +- 5.0e-06 - `8403 <https://github.com/pytest-dev/pytest/issues/8403>`_: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much, currently at ``240`` characters by default. However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using ``-v`` will now increase the truncation threshold to ``2400`` characters, and ``-vv`` or higher will disable truncation entirely. - `8509 <https://github.com/pytest-dev/pytest/issues/8509>`_: Fixed issue where :meth:`unittest.TestCase.setUpClass` is not called when a test has `/` in its name since pytest 6.2.0. This refers to the path part in pytest node IDs, e.g. ``TestClass::test_it`` in the node ID ``tests/test_file.py::TestClass::test_it``. Now, instead of assuming that the test name does not contain ``/``, it is assumed that test path does not contain ``::``. We plan to hopefully make both of these work in the future. - `8803 <https://github.com/pytest-dev/pytest/issues/8803>`_: It is now possible to add colors to custom log levels on cli log. By using :func:`add_color_level <_pytest.logging.add_color_level>` from a ``pytest_configure`` hook, colors can be added:: logging_plugin = config.pluginmanager.get_plugin('logging-plugin') logging_plugin.log_cli_handler.formatter.add_color_level(logging.INFO, 'cyan') logging_plugin.log_cli_handler.formatter.add_color_level(logging.SPAM, 'blue') See :ref:`log_colors` for more information. - `8822 <https://github.com/pytest-dev/pytest/issues/8822>`_: When showing fixture paths in `--fixtures` or `--fixtures-by-test`, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the `site-packages` directory. - `8898 <https://github.com/pytest-dev/pytest/issues/8898>`_: Complex numbers are now treated like floats and integers when generating parameterization IDs. - `9062 <https://github.com/pytest-dev/pytest/issues/9062>`_: ``--stepwise-skip`` now implicitly enables ``--stepwise`` and can be used on its own. - `9205 <https://github.com/pytest-dev/pytest/issues/9205>`_: :meth:`pytest.Cache.set` now preserves key order when saving dicts. Bug Fixes --------- - `7124 <https://github.com/pytest-dev/pytest/issues/7124>`_: Fixed an issue where ``__main__.py`` would raise an ``ImportError`` when ``--doctest-modules`` was provided. - `8061 <https://github.com/pytest-dev/pytest/issues/8061>`_: Fixed failing ``staticmethod`` test cases if they are inherited from a parent test class. - `8192 <https://github.com/pytest-dev/pytest/issues/8192>`_: ``testdir.makefile`` now silently accepts values which don't start with ``.`` to maintain backward compatibility with older pytest versions. ``pytester.makefile`` now issues a clearer error if the ``.`` is missing in the ``ext`` argument. - `8258 <https://github.com/pytest-dev/pytest/issues/8258>`_: Fixed issue where pytest's ``faulthandler`` support would not dump traceback on crashes if the :mod:`faulthandler` module was already enabled during pytest startup (using ``python -X dev -m pytest`` for example). - `8317 <https://github.com/pytest-dev/pytest/issues/8317>`_: Fixed an issue where illegal directory characters derived from ``getpass.getuser()`` raised an ``OSError``. - `8367 <https://github.com/pytest-dev/pytest/issues/8367>`_: Fix ``Class.from_parent`` so it forwards extra keyword arguments to the constructor. - `8377 <https://github.com/pytest-dev/pytest/issues/8377>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing forward slash (``/``) characters. - `8384 <https://github.com/pytest-dev/pytest/issues/8384>`_: The ``pytest.mark.skip`` decorator now correctly handles its arguments. When the ``reason`` argument is accidentally given both positional and as a keyword (e.g. because it was confused with ``skipif``), a ``TypeError`` now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally, ``reason`` is now documented correctly as positional or keyword (rather than keyword-only). - `8394 <https://github.com/pytest-dev/pytest/issues/8394>`_: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default ``--fixtures`` invocation (but they still show up with ``--fixtures -v``). - `8456 <https://github.com/pytest-dev/pytest/issues/8456>`_: The :confval:`required_plugins` config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all. - `8464 <https://github.com/pytest-dev/pytest/issues/8464>`_: ``-c <config file>`` now also properly defines ``rootdir`` as the directory that contains ``<config file>``. - `8503 <https://github.com/pytest-dev/pytest/issues/8503>`_: :meth:`pytest.MonkeyPatch.syspath_prepend` no longer fails when ``setuptools`` is not installed. It now only calls :func:`pkg_resources.fixup_namespace_packages` if ``pkg_resources`` was previously imported, because it is not needed otherwise. - `8548 <https://github.com/pytest-dev/pytest/issues/8548>`_: Introduce fix to handle precision width in ``log-cli-format`` in turn to fix output coloring for certain formats. - `8796 <https://github.com/pytest-dev/pytest/issues/8796>`_: Fixed internal error when skipping doctests. - `8983 <https://github.com/pytest-dev/pytest/issues/8983>`_: The test selection options ``pytest -k`` and ``pytest -m`` now support matching names containing backslash (`\\`) characters. Backslashes are treated literally, not as escape characters (the values being matched against are already escaped). - `8990 <https://github.com/pytest-dev/pytest/issues/8990>`_: Fix `pytest -vv` crashing with an internal exception `AttributeError: 'str' object has no attribute 'relative_to'` in some cases. - `9077 <https://github.com/pytest-dev/pytest/issues/9077>`_: Fixed confusing error message when ``request.fspath`` / ``request.path`` was accessed from a session-scoped fixture. - `9131 <https://github.com/pytest-dev/pytest/issues/9131>`_: Fixed the URL used by ``--pastebin`` to use `bpa.st <http://bpa.st>`__. - `9163 <https://github.com/pytest-dev/pytest/issues/9163>`_: The end line number and end column offset are now properly set for rewritten assert statements. - `9169 <https://github.com/pytest-dev/pytest/issues/9169>`_: Support for the ``files`` API from ``importlib.resources`` within rewritten files. - `9272 <https://github.com/pytest-dev/pytest/issues/9272>`_: The nose compatibility module-level fixtures `setup()` and `teardown()` are now only called once per module, instead of for each test function. They are now called even if object-level `setup`/`teardown` is defined. Improved Documentation ---------------------- - `4320 <https://github.com/pytest-dev/pytest/issues/4320>`_: Improved docs for `pytester.copy_example`. - `5105 <https://github.com/pytest-dev/pytest/issues/5105>`_: Add automatically generated :ref:`plugin-list`. The list is updated on a periodic schedule. - `8337 <https://github.com/pytest-dev/pytest/issues/8337>`_: Recommend `numpy.testing <https://numpy.org/doc/stable/reference/routines.testing.html>`__ module on :func:`pytest.approx` documentation. - `8655 <https://github.com/pytest-dev/pytest/issues/8655>`_: Help text for ``--pdbcls`` more accurately reflects the option's behavior. - `9210 <https://github.com/pytest-dev/pytest/issues/9210>`_: Remove incorrect docs about ``confcutdir`` being a configuration option: it can only be set through the ``--confcutdir`` command-line option. - `9242 <https://github.com/pytest-dev/pytest/issues/9242>`_: Upgrade readthedocs configuration to use a `newer Ubuntu version <https://blog.readthedocs.com/new-build-specification/>`__` with better unicode support for PDF docs. - `9341 <https://github.com/pytest-dev/pytest/issues/9341>`_: Various methods commonly used for :ref:`non-python tests` are now correctly documented in the reference docs. They were undocumented previously. Trivial/Internal Changes ------------------------ - `8133 <https://github.com/pytest-dev/pytest/issues/8133>`_: Migrate to ``setuptools_scm`` 6.x to use ``SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST`` for more robust release tooling. - `8174 <https://github.com/pytest-dev/pytest/issues/8174>`_: The following changes have been made to internal pytest types/functions: - The ``_pytest.code.getfslineno()`` function returns ``Path`` instead of ``py.path.local``. - The ``_pytest.python.path_matches_patterns()`` function takes ``Path`` instead of ``py.path.local``. - The ``_pytest._code.Traceback.cut()`` function accepts any ``os.PathLike[str]``, not just ``py.path.local``. - `8248 <https://github.com/pytest-dev/pytest/issues/8248>`_: Internal Restructure: let ``python.PyObjMixin`` inherit from ``nodes.Node`` to carry over typing information. - `8432 <https://github.com/pytest-dev/pytest/issues/8432>`_: Improve error message when :func:`pytest.skip` is used at module level without passing `allow_module_level=True`. - `8818 <https://github.com/pytest-dev/pytest/issues/8818>`_: Ensure ``regendoc`` opts out of ``TOX_ENV`` cachedir selection to ensure independent example test runs. - `8913 <https://github.com/pytest-dev/pytest/issues/8913>`_: The private ``CallSpec2._arg2scopenum`` attribute has been removed after an internal refactoring. - `8967 <https://github.com/pytest-dev/pytest/issues/8967>`_: 🪝`pytest_assertion_pass` is no longer considered experimental and future changes to it will be considered more carefully. - `9202 <https://github.com/pytest-dev/pytest/issues/9202>`_: Add github action to upload coverage report to codecov instead of bash uploader. - `9225 <https://github.com/pytest-dev/pytest/issues/9225>`_: Changed the command used to create sdist and wheel artifacts: using the build package instead of setup.py. - `9351 <https://github.com/pytest-dev/pytest/issues/9351>`_: Correct minor typos in doc/en/example/special.rst. ``` ### 6.2.5 ``` ========================= Trivial/Internal Changes ------------------------ - :issue:`8494`: Python 3.10 is now supported. - :issue:`9040`: Enable compatibility with ``pluggy 1.0`` or later. ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/pytest - Changelog: https://pyup.io/changelogs/pytest/ - Homepage: https://docs.pytest.org/en/latest/ </details> Co-authored-by: pyup-bot <github-bot@pyup.io>

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [pytest](https://docs.pytest.org/en/latest/) ([source](https://github.com/pytest-dev/pytest), [changelog](https://docs.pytest.org/en/stable/changelog.html)) | dev-dependencies | major | `^5.2` -> `^7.0.0` | --- ### Release Notes <details> <summary>pytest-dev/pytest</summary> ### [`v7.3.1`](https://github.com/pytest-dev/pytest/releases/tag/7.3.1) [Compare Source](https://github.com/pytest-dev/pytest/compare/7.3.0...7.3.1) # pytest 7.3.1 (2023-04-14) ## Improvements - [#10875](https://github.com/pytest-dev/pytest/issues/10875): Python 3.12 support: fixed `RuntimeError: TestResult has no addDuration method` when running `unittest` tests. - [#10890](https://github.com/pytest-dev/pytest/issues/10890): Python 3.12 support: fixed `shutil.rmtree(onerror=...)` deprecation warning when using `tmp_path`{.interpreted-text role="fixture"}. ## Bug Fixes - [#10896](https://github.com/pytest-dev/pytest/issues/10896): Fixed performance regression related to `tmp_path`{.interpreted-text role="fixture"} and the new `tmp_path_retention_policy`{.interpreted-text role="confval"} option. - [#10903](https://github.com/pytest-dev/pytest/issues/10903): Fix crash `INTERNALERROR IndexError: list index out of range` which happens when displaying an exception where all entries are hidden. This reverts the change "Correctly handle `__tracebackhide__` for chained exceptions." introduced in version 7.3.0. ### [`v7.3.0`](https://github.com/pytest-dev/pytest/releases/tag/7.3.0) [Compare Source](https://github.com/pytest-dev/pytest/compare/7.2.2...7.3.0) # pytest 7.3.0 (2023-04-08) ## Features - [#10525](https://github.com/pytest-dev/pytest/issues/10525): Test methods decorated with `@classmethod` can now be discovered as tests, following the same rules as normal methods. This fills the gap that static methods were discoverable as tests but not class methods. - [#10755](https://github.com/pytest-dev/pytest/issues/10755): `console_output_style`{.interpreted-text role="confval"} now supports `progress-even-when-capture-no` to force the use of the progress output even when capture is disabled. This is useful in large test suites where capture may have significant performance impact. - [#7431](https://github.com/pytest-dev/pytest/issues/7431): `--log-disable` CLI option added to disable individual loggers. - [#8141](https://github.com/pytest-dev/pytest/issues/8141): Added `tmp_path_retention_count`{.interpreted-text role="confval"} and `tmp_path_retention_policy`{.interpreted-text role="confval"} configuration options to control how directories created by the `tmp_path`{.interpreted-text role="fixture"} fixture are kept. ## Improvements - [#10226](https://github.com/pytest-dev/pytest/issues/10226): If multiple errors are raised in teardown, we now re-raise an `ExceptionGroup` of them instead of discarding all but the last. - [#10658](https://github.com/pytest-dev/pytest/issues/10658): Allow `-p` arguments to include spaces (eg: `-p no:logging` instead of `-pno:logging`). Mostly useful in the `addopts` section of the configuration file. - [#10710](https://github.com/pytest-dev/pytest/issues/10710): Added `start` and `stop` timestamps to `TestReport` objects. - [#10727](https://github.com/pytest-dev/pytest/issues/10727): Split the report header for `rootdir`, `config file` and `testpaths` so each has its own line. - [#10840](https://github.com/pytest-dev/pytest/issues/10840): pytest should no longer crash on AST with pathological position attributes, for example testing AST produced by \[Hylang \<https://github.com/hylang/hy>\__]{.title-ref}. - [#6267](https://github.com/pytest-dev/pytest/issues/6267): The full output of a test is no longer truncated if the truncation message would be longer than the hidden text. The line number shown has also been fixed. ## Bug Fixes - [#10743](https://github.com/pytest-dev/pytest/issues/10743): The assertion rewriting mechanism now works correctly when assertion expressions contain the walrus operator. - [#10765](https://github.com/pytest-dev/pytest/issues/10765): Fixed `tmp_path`{.interpreted-text role="fixture"} fixture always raising `OSError`{.interpreted-text role="class"} on `emscripten` platform due to missing `os.getuid`{.interpreted-text role="func"}. - [#1904](https://github.com/pytest-dev/pytest/issues/1904): Correctly handle `__tracebackhide__` for chained exceptions. ## Improved Documentation - [#10782](https://github.com/pytest-dev/pytest/issues/10782): Fixed the minimal example in `goodpractices`{.interpreted-text role="ref"}: `pip install -e .` requires a `version` entry in `pyproject.toml` to run successfully. ## Trivial/Internal Changes - [#10669](https://github.com/pytest-dev/pytest/issues/10669): pytest no longer depends on the \[attrs]{.title-ref} package (don't worry, nice diffs for attrs classes are still supported). ### [`v7.2.2`](https://github.com/pytest-dev/pytest/releases/tag/7.2.2) [Compare Source](https://github.com/pytest-dev/pytest/compare/7.2.1...7.2.2) # pytest 7.2.2 (2023-03-03) ## Bug Fixes - [#10533](https://github.com/pytest-dev/pytest/issues/10533): Fixed `pytest.approx`{.interpreted-text role="func"} handling of dictionaries containing one or more values of \[0.0]{.title-ref}. - [#10592](https://github.com/pytest-dev/pytest/issues/10592): Fixed crash if \[--cache-show]{.title-ref} and \[--help]{.title-ref} are passed at the same time. - [#10597](https://github.com/pytest-dev/pytest/issues/10597): Fixed bug where a fixture method named `teardown` would be called as part of `nose` teardown stage. - [#10626](https://github.com/pytest-dev/pytest/issues/10626): Fixed crash if `--fixtures` and `--help` are passed at the same time. - [#10660](https://github.com/pytest-dev/pytest/issues/10660): Fixed :py`pytest.raises`{.interpreted-text role="func"} to return a 'ContextManager' so that type-checkers could narrow `pytest.raises(...) if ... else nullcontext()` down to 'ContextManager' rather than 'object'. ## Improved Documentation - [#10690](https://github.com/pytest-dev/pytest/issues/10690): Added \[CI]{.title-ref} and \[BUILD_NUMBER]{.title-ref} environment variables to the documentation. - [#10721](https://github.com/pytest-dev/pytest/issues/10721): Fixed entry-points declaration in the documentation example using Hatch. - [#10753](https://github.com/pytest-dev/pytest/issues/10753): Changed wording of the module level skip to be very explicit about not collecting tests and not executing the rest of the module. ### [`v7.2.1`](https://github.com/pytest-dev/pytest/releases/tag/7.2.1) [Compare Source](https://github.com/pytest-dev/pytest/compare/7.2.0...7.2.1) # pytest 7.2.1 (2023-01-13) ## Bug Fixes - [#10452](https://github.com/pytest-dev/pytest/issues/10452): Fix 'importlib.abc.TraversableResources' deprecation warning in Python 3.12. - [#10457](https://github.com/pytest-dev/pytest/issues/10457): If a test is skipped from inside a fixture, the test summary now shows the test location instead of the fixture location. - [#10506](https://github.com/pytest-dev/pytest/issues/10506): Fix bug where sometimes pytest would use the file system root directory as `rootdir <rootdir>`{.interpreted-text role="ref"} on Windows. - [#10607](https://github.com/pytest-dev/pytest/issues/10607): Fix a race condition when creating junitxml reports, which could occur when multiple instances of pytest execute in parallel. - [#10641](https://github.com/pytest-dev/pytest/issues/10641): Fix a race condition when creating or updating the stepwise plugin's cache, which could occur when multiple xdist worker nodes try to simultaneously update the stepwise plugin's cache. ### [`v7.2.0`](https://github.com/pytest-dev/pytest/releases/tag/7.2.0) [Compare Source](https://github.com/pytest-dev/pytest/compare/7.1.3...7.2.0) # pytest 7.2.0 (2022-10-23) ## Deprecations - [#10012](https://github.com/pytest-dev/pytest/issues/10012): Update `pytest.PytestUnhandledCoroutineWarning`{.interpreted-text role="class"} to a deprecation; it will raise an error in pytest 8. - [#10396](https://github.com/pytest-dev/pytest/issues/10396): pytest no longer depends on the `py` library. `pytest` provides a vendored copy of `py.error` and `py.path` modules but will use the `py` library if it is installed. If you need other `py.*` modules, continue to install the deprecated `py` library separately, otherwise it can usually be removed as a dependency. - [#4562](https://github.com/pytest-dev/pytest/issues/4562): Deprecate configuring hook specs/impls using attributes/marks. Instead use :py`pytest.hookimpl`{.interpreted-text role="func"} and :py`pytest.hookspec`{.interpreted-text role="func"}. For more details, see the `docs <legacy-path-hooks-deprecated>`{.interpreted-text role="ref"}. - [#9886](https://github.com/pytest-dev/pytest/issues/9886): The functionality for running tests written for `nose` has been officially deprecated. This includes: - Plain `setup` and `teardown` functions and methods: this might catch users by surprise, as `setup()` and `teardown()` are not pytest idioms, but part of the `nose` support. - Setup/teardown using the [@with_setup](with-setup-nose) decorator. For more details, consult the `deprecation docs <nose-deprecation>`{.interpreted-text role="ref"}. ## Features - [#9897](https://github.com/pytest-dev/pytest/issues/9897): Added shell-style wildcard support to `testpaths`. ## Improvements - [#10218](https://github.com/pytest-dev/pytest/issues/10218): `@pytest.mark.parametrize()` (and similar functions) now accepts any `Sequence[str]` for the argument names, instead of just `list[str]` and `tuple[str, ...]`. (Note that `str`, which is itself a `Sequence[str]`, is still treated as a comma-delimited name list, as before). - [#10381](https://github.com/pytest-dev/pytest/issues/10381): The `--no-showlocals` flag has been added. This can be passed directly to tests to override `--showlocals` declared through `addopts`. - [#3426](https://github.com/pytest-dev/pytest/issues/3426): Assertion failures with strings in NFC and NFD forms that normalize to the same string now have a dedicated error message detailing the issue, and their utf-8 representation is expresed instead. - [#7337](https://github.com/pytest-dev/pytest/issues/7337): A warning is now emitted if a test function returns something other than \[None]{.title-ref}. This prevents a common mistake among beginners that expect that returning a \[bool]{.title-ref} (for example \[return foo(a, b) == result]{.title-ref}) would cause a test to pass or fail, instead of using \[assert]{.title-ref}. - [#8508](https://github.com/pytest-dev/pytest/issues/8508): Introduce multiline display for warning matching via :py`pytest.warns`{.interpreted-text role="func"} and enhance match comparison for :py`_pytest._code.ExceptionInfo.match`{.interpreted-text role="func"} as returned by :py`pytest.raises`{.interpreted-text role="func"}. - [#8646](https://github.com/pytest-dev/pytest/issues/8646): Improve :py`pytest.raises`{.interpreted-text role="func"}. Previously passing an empty tuple would give a confusing error. We now raise immediately with a more helpful message. - [#9741](https://github.com/pytest-dev/pytest/issues/9741): On Python 3.11, use the standard library's `tomllib`{.interpreted-text role="mod"} to parse TOML. `tomli`{.interpreted-text role="mod"}\` is no longer a dependency on Python 3.11. - [#9742](https://github.com/pytest-dev/pytest/issues/9742): Display assertion message without escaped newline characters with `-vv`. - [#9823](https://github.com/pytest-dev/pytest/issues/9823): Improved error message that is shown when no collector is found for a given file. - [#9873](https://github.com/pytest-dev/pytest/issues/9873): Some coloring has been added to the short test summary. - [#9883](https://github.com/pytest-dev/pytest/issues/9883): Normalize the help description of all command-line options. - [#9920](https://github.com/pytest-dev/pytest/issues/9920): Display full crash messages in `short test summary info`, when runng in a CI environment. - [#9987](https://github.com/pytest-dev/pytest/issues/9987): Added support for hidden configuration file by allowing `.pytest.ini` as an alternative to `pytest.ini`. ## Bug Fixes - [#10150](https://github.com/pytest-dev/pytest/issues/10150): `sys.stdin`{.interpreted-text role="data"} now contains all expected methods of a file-like object when capture is enabled. - [#10382](https://github.com/pytest-dev/pytest/issues/10382): Do not break into pdb when `raise unittest.SkipTest()` appears top-level in a file. - [#7792](https://github.com/pytest-dev/pytest/issues/7792): Marks are now inherited according to the full MRO in test classes. Previously, if a test class inherited from two or more classes, only marks from the first super-class would apply. When inheriting marks from super-classes, marks from the sub-classes are now ordered before marks from the super-classes, in MRO order. Previously it was the reverse. When inheriting marks from super-classes, the \[pytestmark]{.title-ref} attribute of the sub-class now only contains the marks directly applied to it. Previously, it also contained marks from its super-classes. Please note that this attribute should not normally be accessed directly; use `pytest.Node.iter_markers`{.interpreted-text role="func"} instead. - [#9159](https://github.com/pytest-dev/pytest/issues/9159): Showing inner exceptions by forcing native display in `ExceptionGroups` even when using display options other than `--tb=native`. A temporary step before full implementation of pytest-native display for inner exceptions in `ExceptionGroups`. - [#9877](https://github.com/pytest-dev/pytest/issues/9877): Ensure `caplog.get_records(when)` returns current/correct data after invoking `caplog.clear()`. ## Improved Documentation - [#10344](https://github.com/pytest-dev/pytest/issues/10344): Update information on writing plugins to use `pyproject.toml` instead of `setup.py`. - [#9248](https://github.com/pytest-dev/pytest/issues/9248): The documentation is now built using Sphinx 5.x (up from 3.x previously). - [#9291](https://github.com/pytest-dev/pytest/issues/9291): Update documentation on how `pytest.warns`{.interpreted-text role="func"} affects `DeprecationWarning`{.interpreted-text role="class"}. ## Trivial/Internal Changes - [#10196](https://github.com/pytest-dev/pytest/issues/10196): `~pytest.PytestReturnNotNoneWarning`{.interpreted-text role="class"} is now a subclass of `~pytest.PytestRemovedIn8Warning`{.interpreted-text role="class"}: the plan is to make returning non-`None` from tests an error in the future. - [#10313](https://github.com/pytest-dev/pytest/issues/10313): Made `_pytest.doctest.DoctestItem` export `pytest.DoctestItem` for type check and runtime purposes. Made \[\_pytest.doctest]{.title-ref} use internal APIs to avoid circular imports. - [#9906](https://github.com/pytest-dev/pytest/issues/9906): Made `_pytest.compat` re-export `importlib_metadata` in the eyes of type checkers. - [#9910](https://github.com/pytest-dev/pytest/issues/9910): Fix default encoding warning (`EncodingWarning`) in `cacheprovider` - [#9984](https://github.com/pytest-dev/pytest/issues/9984): Improve the error message when we attempt to access a fixture that has been torn down. Add an additional sentence to the docstring explaining when it's not a good idea to call getfixturevalue. ### [`v7.1.3`](https://github.com/pytest-dev/pytest/releases/tag/7.1.3) [Compare Source](https://github.com/pytest-dev/pytest/compare/7.1.2...7.1.3) # pytest 7.1.3 (2022-08-31) ## Bug Fixes - [#10060](https://github.com/pytest-dev/pytest/issues/10060): When running with `--pdb`, `TestCase.tearDown` is no longer called for tests when the *class* has been skipped via `unittest.skip` or `pytest.mark.skip`. - [#10190](https://github.com/pytest-dev/pytest/issues/10190): Invalid XML characters in setup or teardown error messages are now properly escaped for JUnit XML reports. - [#10230](https://github.com/pytest-dev/pytest/issues/10230): Ignore `.py` files created by `pyproject.toml`-based editable builds introduced in [pip 21.3](https://pip.pypa.io/en/stable/news/#v21-3). - [#3396](https://github.com/pytest-dev/pytest/issues/3396): Doctests now respect the `--import-mode` flag. - [#9514](https://github.com/pytest-dev/pytest/issues/9514): Type-annotate `FixtureRequest.param` as `Any` as a stop gap measure until `8073`{.interpreted-text role="issue"} is fixed. - [#9791](https://github.com/pytest-dev/pytest/issues/9791): Fixed a path handling code in `rewrite.py` that seems to work fine, but was incorrect and fails in some systems. - [#9917](https://github.com/pytest-dev/pytest/issues/9917): Fixed string representation for `pytest.approx`{.interpreted-text role="func"} when used to compare tuples. ## Improved Documentation - [#9937](https://github.com/pytest-dev/pytest/issues/9937): Explicit note that `tmpdir`{.interpreted-text role="fixture"} fixture is discouraged in favour of `tmp_path`{.interpreted-text role="fixture"}. ## Trivial/Internal Changes - [#10114](https://github.com/pytest-dev/pytest/issues/10114): Replace [atomicwrites](https://github.com/untitaker/python-atomicwrites) dependency on windows with \[os.replace]{.title-ref}. ### [`v7.1.2`](https://github.com/pytest-dev/pytest/releases/tag/7.1.2) [Compare Source](https://github.com/pytest-dev/pytest/compare/7.1.1...7.1.2) # pytest 7.1.2 (2022-04-23) ## Bug Fixes - [#9726](https://github.com/pytest-dev/pytest/issues/9726): An unnecessary `numpy` import inside `pytest.approx`{.interpreted-text role="func"} was removed. - [#9820](https://github.com/pytest-dev/pytest/issues/9820): Fix comparison of `dataclasses` with `InitVar`. - [#9869](https://github.com/pytest-dev/pytest/issues/9869): Increase `stacklevel` for the `NODE_CTOR_FSPATH_ARG` deprecation to point to the user's code, not pytest. - [#9871](https://github.com/pytest-dev/pytest/issues/9871): Fix a bizarre (and fortunately rare) bug where the \[temp_path]{.title-ref} fixture could raise an internal error while attempting to get the current user's username. ### [`v7.1.1`](https://github.com/pytest-dev/pytest/releases/tag/7.1.1) [Compare Source](https://github.com/pytest-dev/pytest/compare/7.1.0...7.1.1) # pytest 7.1.1 (2022-03-17) ## Bug Fixes - [#9767](https://github.com/pytest-dev/pytest/issues/9767): Fixed a regression in pytest 7.1.0 where some conftest.py files outside of the source tree (e.g. in the \[site-packages]{.title-ref} directory) were not picked up. ### [`v7.1.0`](https://github.com/pytest-dev/pytest/releases/tag/7.1.0) [Compare Source](https://github.com/pytest-dev/pytest/compare/7.0.1...7.1.0) # pytest 7.1.0 (2022-03-13) ## Breaking Changes - [#8838](https://github.com/pytest-dev/pytest/issues/8838): As per our policy, the following features have been deprecated in the 6.X series and are now removed: - `pytest._fillfuncargs` function. - `pytest_warning_captured` hook - use `pytest_warning_recorded` instead. - `-k -foobar` syntax - use `-k 'not foobar'` instead. - `-k foobar:` syntax. - `pytest.collect` module - import from `pytest` directly. For more information consult [Deprecations and Removals](https://docs.pytest.org/en/latest/deprecations.html) in the docs. - [#9437](https://github.com/pytest-dev/pytest/issues/9437): Dropped support for Python 3.6, which reached [end-of-life](https://devguide.python.org/#status-of-python-branches) at 2021-12-23. ## Improvements - [#5192](https://github.com/pytest-dev/pytest/issues/5192): Fixed test output for some data types where `-v` would show less information. Also, when showing diffs for sequences, `-q` would produce full diffs instead of the expected diff. - [#9362](https://github.com/pytest-dev/pytest/issues/9362): pytest now avoids specialized assert formatting when it is detected that the default `__eq__` is overridden in `attrs` or `dataclasses`. - [#9536](https://github.com/pytest-dev/pytest/issues/9536): When `-vv` is given on command line, show skipping and xfail reasons in full instead of truncating them to fit the terminal width. - [#9644](https://github.com/pytest-dev/pytest/issues/9644): More information about the location of resources that led Python to raise `ResourceWarning`{.interpreted-text role="class"} can now be obtained by enabling `tracemalloc`{.interpreted-text role="mod"}. See `resource-warnings`{.interpreted-text role="ref"} for more information. - [#9678](https://github.com/pytest-dev/pytest/issues/9678): More types are now accepted in the `ids` argument to `@pytest.mark.parametrize`. Previously only \[str]{.title-ref}, \[float]{.title-ref}, \[int]{.title-ref} and \[bool]{.title-ref} were accepted; now \[bytes]{.title-ref}, \[complex]{.title-ref}, \[re.Pattern]{.title-ref}, \[Enum]{.title-ref} and anything with a \[\__name\_\_]{.title-ref} are also accepted. - [#9692](https://github.com/pytest-dev/pytest/issues/9692): `pytest.approx`{.interpreted-text role="func"} now raises a `TypeError`{.interpreted-text role="class"} when given an unordered sequence (such as `set`{.interpreted-text role="class"}). Note that this implies that custom classes which only implement `__iter__` and `__len__` are no longer supported as they don't guarantee order. ## Bug Fixes - [#8242](https://github.com/pytest-dev/pytest/issues/8242): The deprecation of raising `unittest.SkipTest`{.interpreted-text role="class"} to skip collection of tests during the pytest collection phase is reverted - this is now a supported feature again. - [#9493](https://github.com/pytest-dev/pytest/issues/9493): Symbolic link components are no longer resolved in conftest paths. This means that if a conftest appears twice in collection tree, using symlinks, it will be executed twice. For example, given > tests/real/conftest.py > tests/real/test_it.py > tests/link -> tests/real running `pytest tests` now imports the conftest twice, once as `tests/real/conftest.py` and once as `tests/link/conftest.py`. This is a fix to match a similar change made to test collection itself in pytest 6.0 (see `6523`{.interpreted-text role="pull"} for details). - [#9626](https://github.com/pytest-dev/pytest/issues/9626): Fixed count of selected tests on terminal collection summary when there were errors or skipped modules. If there were errors or skipped modules on collection, pytest would mistakenly subtract those from the selected count. - [#9645](https://github.com/pytest-dev/pytest/issues/9645): Fixed regression where `--import-mode=importlib` used together with `PYTHONPATH`{.interpreted-text role="envvar"} or `pythonpath`{.interpreted-text role="confval"} would cause import errors in test suites. - [#9708](https://github.com/pytest-dev/pytest/issues/9708): `pytester`{.interpreted-text role="fixture"} now requests a `monkeypatch`{.interpreted-text role="fixture"} fixture instead of creating one internally. This solves some issues with tests that involve pytest environment variables. - [#9730](https://github.com/pytest-dev/pytest/issues/9730): Malformed `pyproject.toml` files now produce a clearer error message. ### [`v7.0.1`](https://github.com/pytest-dev/pytest/releases/tag/7.0.1) [Compare Source](https://github.com/pytest-dev/pytest/compare/7.0.0...7.0.1) # pytest 7.0.1 (2022-02-11) ## Bug Fixes - [#9608](https://github.com/pytest-dev/pytest/issues/9608): Fix invalid importing of `importlib.readers` in Python 3.9. - [#9610](https://github.com/pytest-dev/pytest/issues/9610): Restore \[UnitTestFunction.obj]{.title-ref} to return unbound rather than bound method. Fixes a crash during a failed teardown in unittest TestCases with non-default \[\__init\_\_]{.title-ref}. Regressed in pytest 7.0.0. - [#9636](https://github.com/pytest-dev/pytest/issues/9636): The `pythonpath` plugin was renamed to `python_path`. This avoids a conflict with the `pytest-pythonpath` plugin. - [#9642](https://github.com/pytest-dev/pytest/issues/9642): Fix running tests by id with `::` in the parametrize portion. - [#9643](https://github.com/pytest-dev/pytest/issues/9643): Delay issuing a `~pytest.PytestWarning`{.interpreted-text role="class"} about diamond inheritance involving `~pytest.Item`{.interpreted-text role="class"} and `~pytest.Collector`{.interpreted-text role="class"} so it can be filtered using `standard warning filters <warnings>`{.interpreted-text role="ref"}. ### [`v7.0.0`](https://github.com/pytest-dev/pytest/releases/tag/7.0.0) [Compare Source](https://github.com/pytest-dev/pytest/compare/6.2.5...7.0.0) # pytest 7.0.0 (2022-02-03) (**Please see the full set of changes for this release also in the 7.0.0rc1 notes below**) ## Deprecations - [#9488](https://github.com/pytest-dev/pytest/issues/9488): If custom subclasses of nodes like `pytest.Item`{.interpreted-text role="class"} override the `__init__` method, they should take `**kwargs`. See `uncooperative-constructors-deprecated`{.interpreted-text role="ref"} for details. Note that a deprection warning is only emitted when there is a conflict in the arguments pytest expected to pass. This deprecation was already part of pytest 7.0.0rc1 but wasn't documented. ## Bug Fixes - [#9355](https://github.com/pytest-dev/pytest/issues/9355): Fixed error message prints function decorators when using assert in Python 3.8 and above. - [#9396](https://github.com/pytest-dev/pytest/issues/9396): Ensure `pytest.Config.inifile`{.interpreted-text role="attr"} is available during the `pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>`{.interpreted-text role="func"} hook (regression during `7.0.0rc1`). ## Improved Documentation - [#9404](https://github.com/pytest-dev/pytest/issues/9404): Added extra documentation on alternatives to common misuses of \[pytest.warns(None)]{.title-ref} ahead of its deprecation. - [#9505](https://github.com/pytest-dev/pytest/issues/9505): Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository. ## Trivial/Internal Changes - [#9521](https://github.com/pytest-dev/pytest/issues/9521): Add test coverage to assertion rewrite path. # pytest 7.0.0rc1 (2021-12-06) ## Breaking Changes - [#7259](https://github.com/pytest-dev/pytest/issues/7259): The `Node.reportinfo() <non-python tests>`{.interpreted-text role="ref"} function first return value type has been expanded from \[py.path.local | str]{.title-ref} to \[os.PathLike\[str] | str]{.title-ref}. Most plugins which refer to \[reportinfo()]{.title-ref} only define it as part of a custom `pytest.Item`{.interpreted-text role="class"} implementation. Since \[py.path.local]{.title-ref} is a \[os.PathLike\[str]]{.title-ref}, these plugins are unaffacted. Plugins and users which call \[reportinfo()]{.title-ref}, use the first return value and interact with it as a \[py.path.local]{.title-ref}, would need to adjust by calling \[py.path.local(fspath)]{.title-ref}. Although preferably, avoid the legacy \[py.path.local]{.title-ref} and use \[pathlib.Path]{.title-ref}, or use \[item.location]{.title-ref} or \[item.path]{.title-ref}, instead. Note: pytest was not able to provide a deprecation period for this change. - [#8246](https://github.com/pytest-dev/pytest/issues/8246): `--version` now writes version information to `stdout` rather than `stderr`. - [#8733](https://github.com/pytest-dev/pytest/issues/8733): Drop a workaround for [pyreadline](https://github.com/pyreadline/pyreadline) that made it work with `--pdb`. The workaround was introduced in [#1281](https://github.com/pytest-dev/pytest/pull/1281) in 2015, however since then [pyreadline seems to have gone unmaintained](https://github.com/pyreadline/pyreadline/issues/58), is [generating warnings](https://github.com/pytest-dev/pytest/issues/8847), and will stop working on Python 3.10. - [#9061](https://github.com/pytest-dev/pytest/issues/9061): Using `pytest.approx`{.interpreted-text role="func"} in a boolean context now raises an error hinting at the proper usage. It is apparently common for users to mistakenly use `pytest.approx` like this: ```{.sourceCode .python} assert pytest.approx(actual, expected) ``` While the correct usage is: ```{.sourceCode .python} assert actual == pytest.approx(expected) ``` The new error message helps catch those mistakes. - [#9277](https://github.com/pytest-dev/pytest/issues/9277): The `pytest.Instance` collector type has been removed. Importing `pytest.Instance` or `_pytest.python.Instance` returns a dummy type and emits a deprecation warning. See `instance-collector-deprecation`{.interpreted-text role="ref"} for details. - [#9308](https://github.com/pytest-dev/pytest/issues/9308): **PytestRemovedIn7Warning deprecation warnings are now errors by default.** Following our plan to remove deprecated features with as little disruption as possible, all warnings of type `PytestRemovedIn7Warning` now generate errors instead of warning messages by default. **The affected features will be effectively removed in pytest 7.1**, so please consult the `deprecations`{.interpreted-text role="ref"} section in the docs for directions on how to update existing code. In the pytest `7.0.X` series, it is possible to change the errors back into warnings as a stopgap measure by adding this to your `pytest.ini` file: ```{.sourceCode .ini} [pytest] filterwarnings = ignore::pytest.PytestRemovedIn7Warning ``` But this will stop working when pytest `7.1` is released. **If you have concerns** about the removal of a specific feature, please add a comment to `9308`{.interpreted-text role="issue"}. ## Deprecations - [#7259](https://github.com/pytest-dev/pytest/issues/7259): `py.path.local` arguments for hooks have been deprecated. See `the deprecation note <legacy-path-hooks-deprecated>`{.interpreted-text role="ref"} for full details. `py.path.local` arguments to Node constructors have been deprecated. See `the deprecation note <node-ctor-fspath-deprecation>`{.interpreted-text role="ref"} for full details. ::: {.note} ::: {.admonition-title} Note ::: The name of the `~_pytest.nodes.Node`{.interpreted-text role="class"} arguments and attributes (the new attribute being `path`) is **the opposite** of the situation for hooks (the old argument being `path`). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the `py`{.interpreted-text role="pypi"} dependency (see `9283`{.interpreted-text role="issue"} for a longer discussion). ::: - [#7469](https://github.com/pytest-dev/pytest/issues/7469): 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. - [#8242](https://github.com/pytest-dev/pytest/issues/8242): Raising `unittest.SkipTest`{.interpreted-text role="class"} to skip collection of tests during the pytest collection phase is deprecated. Use `pytest.skip`{.interpreted-text role="func"} instead. Note: This deprecation only relates to using `unittest.SkipTest`{.interpreted-text role="class"} during test collection. You are probably not doing that. Ordinary usage of `unittest.SkipTest`{.interpreted-text role="class"} / `unittest.TestCase.skipTest`{.interpreted-text role="meth"} / `unittest.skip`{.interpreted-text role="func"} in unittest test cases is fully supported. - [#8315](https://github.com/pytest-dev/pytest/issues/8315): Several behaviors of `Parser.addoption <pytest.Parser.addoption>`{.interpreted-text role="meth"} are now 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. - [#8447](https://github.com/pytest-dev/pytest/issues/8447): Defining a custom pytest node type which is both an `pytest.Item <Item>`{.interpreted-text role="class"} and a `pytest.Collector <Collector>`{.interpreted-text role="class"} (e.g. `pytest.File <File>`{.interpreted-text role="class"}) now issues a warning. It was never sanely supported and triggers hard to debug errors. See `the deprecation note <diamond-inheritance-deprecated>`{.interpreted-text role="ref"} for full details. - [#8592](https://github.com/pytest-dev/pytest/issues/8592): `pytest_cmdline_preparse`{.interpreted-text role="hook"} has been officially deprecated. It will be removed in a future release. Use `pytest_load_initial_conftests`{.interpreted-text role="hook"} instead. See `the deprecation note <cmdline-preparse-deprecated>`{.interpreted-text role="ref"} for full details. - [#8645](https://github.com/pytest-dev/pytest/issues/8645): `pytest.warns(None) <pytest.warns>`{.interpreted-text role="func"} 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)`. - [#8948](https://github.com/pytest-dev/pytest/issues/8948): `pytest.skip(msg=...) <pytest.skip>`{.interpreted-text role="func"}, `pytest.fail(msg=...) <pytest.fail>`{.interpreted-text role="func"} and `pytest.exit(msg=...) <pytest.exit>`{.interpreted-text role="func"} signatures now accept a `reason` argument instead of `msg`. Using `msg` still works, but is deprecated and will be removed in a future release. This was changed for consistency with `pytest.mark.skip <pytest.mark.skip>`{.interpreted-text role="func"} and `pytest.mark.xfail <pytest.mark.xfail>`{.interpreted-text role="func"} which both accept `reason` as an argument. - [#8174](https://github.com/pytest-dev/pytest/issues/8174): The following changes have been made to types reachable through `pytest.ExceptionInfo.traceback`{.interpreted-text role="attr"}: - The `path` property of `_pytest.code.Code` returns `Path` instead of `py.path.local`. - The `path` property of `_pytest.code.TracebackEntry` returns `Path` instead of `py.path.local`. There was no deprecation period for this change (sorry!). ## Features - [#5196](https://github.com/pytest-dev/pytest/issues/5196): Tests are now ordered by definition order in more cases. In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order). - [#7132](https://github.com/pytest-dev/pytest/issues/7132): Added two environment variables `PYTEST_THEME`{.interpreted-text role="envvar"} and `PYTEST_THEME_MODE`{.interpreted-text role="envvar"} to let the users customize the pygments theme used. - [#7259](https://github.com/pytest-dev/pytest/issues/7259): Added `cache.mkdir() <pytest.Cache.mkdir>`{.interpreted-text role="meth"}, which is similar to the existing `cache.makedir() <pytest.Cache.makedir>`{.interpreted-text role="meth"}, but returns a `pathlib.Path`{.interpreted-text role="class"} instead of a legacy `py.path.local`. Added a `paths` type to `parser.addini() <pytest.Parser.addini>`{.interpreted-text role="meth"}, as in `parser.addini("mypaths", "my paths", type="paths")`, which is similar to the existing `pathlist`, but returns a list of `pathlib.Path`{.interpreted-text role="class"} instead of legacy `py.path.local`. - [#7469](https://github.com/pytest-dev/pytest/issues/7469): The types of objects used in pytest's API are now exported so they may be used in type annotations. The newly-exported types are: - `pytest.Config` for `Config <pytest.Config>`{.interpreted-text role="class"}. - `pytest.Mark` for `marks <pytest.Mark>`{.interpreted-text role="class"}. - `pytest.MarkDecorator` for `mark decorators <pytest.MarkDecorator>`{.interpreted-text role="class"}. - `pytest.MarkGenerator` for the `pytest.mark <pytest.MarkGenerator>`{.interpreted-text role="class"} singleton. - `pytest.Metafunc` for the `metafunc <pytest.MarkGenerator>`{.interpreted-text role="class"} argument to the `pytest_generate_tests`{.interpreted-text role="hook"} hook. - `pytest.CallInfo` for the `CallInfo <pytest.CallInfo>`{.interpreted-text role="class"} type passed to various hooks. - `pytest.PytestPluginManager` for `PytestPluginManager <pytest.PytestPluginManager>`{.interpreted-text role="class"}. - `pytest.ExceptionInfo` for the `ExceptionInfo <pytest.ExceptionInfo>`{.interpreted-text role="class"} type returned from `pytest.raises`{.interpreted-text role="func"} and passed to various hooks. - `pytest.Parser` for the `Parser <pytest.Parser>`{.interpreted-text role="class"} type passed to the `pytest_addoption`{.interpreted-text role="hook"} hook. - `pytest.OptionGroup` for the `OptionGroup <pytest.OptionGroup>`{.interpreted-text role="class"} type returned from the `parser.addgroup <pytest.Parser.getgroup>`{.interpreted-text role="func"} method. - `pytest.HookRecorder` for the `HookRecorder <pytest.HookRecorder>`{.interpreted-text role="class"} type returned from `~pytest.Pytester`{.interpreted-text role="class"}. - `pytest.RecordedHookCall` for the `RecordedHookCall <pytest.HookRecorder>`{.interpreted-text role="class"} type returned from `~pytest.HookRecorder`{.interpreted-text role="class"}. - `pytest.RunResult` for the `RunResult <pytest.RunResult>`{.interpreted-text role="class"} type returned from `~pytest.Pytester`{.interpreted-text role="class"}. - `pytest.LineMatcher` for the `LineMatcher <pytest.RunResult>`{.interpreted-text role="class"} type used in `~pytest.RunResult`{.interpreted-text role="class"} and others. - `pytest.TestReport` for the `TestReport <pytest.TestReport>`{.interpreted-text role="class"} type used in various hooks. - `pytest.CollectReport` for the `CollectReport <pytest.CollectReport>`{.interpreted-text role="class"} type used in various hooks. Constructing most of them directly is not supported; they are only meant for use in type annotations. Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0. Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy. - [#7856](https://github.com/pytest-dev/pytest/issues/7856): `--import-mode=importlib <import-modes>`{.interpreted-text role="ref"} now works with features that depend on modules being on :py`sys.modules`{.interpreted-text role="data"}, such as `pickle`{.interpreted-text role="mod"} and `dataclasses`{.interpreted-text role="mod"}. - [#8144](https://github.com/pytest-dev/pytest/issues/8144): The following hooks now receive an additional `pathlib.Path` argument, equivalent to an existing `py.path.local` argument: - `pytest_ignore_collect`{.interpreted-text role="hook"} - The `collection_path` parameter (equivalent to existing `path` parameter). - `pytest_collect_file`{.interpreted-text role="hook"} - The `file_path` parameter (equivalent to existing `path` parameter). - `pytest_pycollect_makemodule`{.interpreted-text role="hook"} - The `module_path` parameter (equivalent to existing `path` parameter). - `pytest_report_header`{.interpreted-text role="hook"} - The `start_path` parameter (equivalent to existing `startdir` parameter). - `pytest_report_collectionfinish`{.interpreted-text role="hook"} - The `start_path` parameter (equivalent to existing `startdir` parameter). ::: {.note} ::: {.admonition-title} Note ::: The name of the `~_pytest.nodes.Node`{.interpreted-text role="class"} arguments and attributes (the new attribute being `path`) is **the opposite** of the situation for hooks (the old argument being `path`). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the `py`{.interpreted-text role="pypi"} dependency (see `9283`{.interpreted-text role="issue"} for a longer discussion). ::: - [#8251](https://github.com/pytest-dev/pytest/issues/8251): Implement `Node.path` as a `pathlib.Path`. Both the old `fspath` and this new attribute gets set no matter whether `path` or `fspath` (deprecated) is passed to the constructor. It is a replacement for the `fspath` attribute (which represents the same path as `py.path.local`). While `fspath` is not deprecated yet due to the ongoing migration of methods like `~_pytest.Item.reportinfo`{.interpreted-text role="meth"}, we expect to deprecate it in a future release. ::: {.note} ::: {.admonition-title} Note ::: The name of the `~_pytest.nodes.Node`{.interpreted-text role="class"} arguments and attributes (the new attribute being `path`) is **the opposite** of the situation for hooks (the old argument being `path`). This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the `py`{.interpreted-text role="pypi"} dependency (see `9283`{.interpreted-text role="issue"} for a longer discussion). ::: - [#8421](https://github.com/pytest-dev/pytest/issues/8421): `pytest.approx`{.interpreted-text role="func"} now works on `~decimal.Decimal`{.interpreted-text role="class"} within mappings/dicts and sequences/lists. - [#8606](https://github.com/pytest-dev/pytest/issues/8606): pytest invocations with `--fixtures-per-test` and `--fixtures` have been enriched with: - Fixture location path printed with the fixture name. - First section of the fixture's docstring printed under the fixture name. - Whole of fixture's docstring printed under the fixture name using `--verbose` option. - [#8761](https://github.com/pytest-dev/pytest/issues/8761): New `version-tuple`{.interpreted-text role="ref"} attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions). - [#8789](https://github.com/pytest-dev/pytest/issues/8789): Switch TOML parser from `toml` to `tomli` for TOML v1.0.0 support in `pyproject.toml`. - [#8920](https://github.com/pytest-dev/pytest/issues/8920): Added `pytest.Stash`{.interpreted-text role="class"}, a facility for plugins to store their data on `~pytest.Config`{.interpreted-text role="class"} and `~_pytest.nodes.Node`{.interpreted-text role="class"}s in a type-safe and conflict-free manner. See `plugin-stash`{.interpreted-text role="ref"} for details. - [#8953](https://github.com/pytest-dev/pytest/issues/8953): `RunResult <_pytest.pytester.RunResult>`{.interpreted-text role="class"} method `assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>`{.interpreted-text role="meth"} now accepts a `warnings` argument to assert the total number of warnings captured. - [#8954](https://github.com/pytest-dev/pytest/issues/8954): `--debug` flag now accepts a `str`{.interpreted-text role="class"} file to route debug logs into, remains defaulted to \[pytestdebug.log]{.title-ref}. - [#9023](https://github.com/pytest-dev/pytest/issues/9023): Full diffs are now always shown for equality assertions of iterables when \[CI]{.title-ref} or `BUILD_NUMBER` is found in the environment, even when `-v` isn't used. - [#9113](https://github.com/pytest-dev/pytest/issues/9113): `RunResult <_pytest.pytester.RunResult>`{.interpreted-text role="class"} method `assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>`{.interpreted-text role="meth"} now accepts a `deselected` argument to assert the total number of deselected tests. - [#9114](https://github.com/pytest-dev/pytest/issues/9114): Added `pythonpath`{.interpreted-text role="confval"} setting that adds listed paths to `sys.path`{.interpreted-text role="data"} for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in \[pythonpath]{.title-ref} setting. ## Improvements - [#7480](https://github.com/pytest-dev/pytest/issues/7480): A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category \[PytestRemovedInXWarning]{.title-ref}, a subclass of `~pytest.PytestDeprecationWarning`{.interpreted-text role="class"}, instead of `PytestDeprecationWarning`{.interpreted-text role="class"} directly. See `backwards-compatibility`{.interpreted-text role="ref"} for more details. - [#7864](https://github.com/pytest-dev/pytest/issues/7864): Improved error messages when parsing warning filters. Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause of the problem (for example an `ImportError` while importing a specific warning type). - [#8335](https://github.com/pytest-dev/pytest/issues/8335): Improved `pytest.approx`{.interpreted-text role="func"} assertion messages for sequences of numbers. The assertion messages now dumps a table with the index and the error of each diff. Example: > assert [1, 2, 3, 4] == pytest.approx([1, 3, 3, 5]) E assert comparison failed for 2 values: E Index | Obtained | Expected E 1 | 2 | 3 +- 3.0e-06 E 3 | 4 | 5 +- 5.0e-06 - [#8403](https://github.com/pytest-dev/pytest/issues/8403): By default, pytest will truncate long strings in assert errors so they don't clutter the output too much, currently at `240` characters by default. However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using `-v` will now increase the truncation threshold to `2400` characters, and `-vv` or higher will disable truncation entirely. - [#8509](https://github.com/pytest-dev/pytest/issues/8509): Fixed issue where `unittest.TestCase.setUpClass`{.interpreted-text role="meth"} is not called when a test has \[/]{.title-ref} in its name since pytest 6.2.0. This refers to the path part in pytest node IDs, e.g. `TestClass::test_it` in the node ID `tests/test_file.py::TestClass::test_it`. Now, instead of assuming that the test name does not contain `/`, it is assumed that test path does not contain `::`. We plan to hopefully make both of these work in the future. - [#8803](https://github.com/pytest-dev/pytest/issues/8803): It is now possible to add colors to custom log levels on cli log. By using `add_color_level <_pytest.logging.add_color_level>`{.interpreted-text role="func"} from a `pytest_configure` hook, colors can be added: logging_plugin = config.pluginmanager.get_plugin('logging-plugin') logging_plugin.log_cli_handler.formatter.add_color_level(logging.INFO, 'cyan') logging_plugin.log_cli_handler.formatter.add_color_level(logging.SPAM, 'blue') See `log_colors`{.interpreted-text role="ref"} for more information. - [#8822](https://github.com/pytest-dev/pytest/issues/8822): When showing fixture paths in \[--fixtures]{.title-ref} or \[--fixtures-by-test]{.title-ref}, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the \[site-packages]{.title-ref} directory. - [#8898](https://github.com/pytest-dev/pytest/issues/8898): Complex numbers are now treated like floats and integers when generating parameterization IDs. - [#9062](https://github.com/pytest-dev/pytest/issues/9062): `--stepwise-skip` now implicitly enables `--stepwise` and can be used on its own. - [#9205](https://github.com/pytest-dev/pytest/issues/9205): `pytest.Cache.set`{.interpreted-text role="meth"} now preserves key order when saving dicts. ## Bug Fixes - [#7124](https://github.com/pytest-dev/pytest/issues/7124): Fixed an issue where `__main__.py` would raise an `ImportError` when `--doctest-modules` was provided. - [#8061](https://github.com/pytest-dev/pytest/issues/8061): Fixed failing `staticmethod` test cases if they are inherited from a parent test class. - [#8192](https://github.com/pytest-dev/pytest/issues/8192): `testdir.makefile` now silently accepts values which don't start with `.` to maintain backward compatibility with older pytest versions. `pytester.makefile` now issues a clearer error if the `.` is missing in the `ext` argument. - [#8258](https://github.com/pytest-dev/pytest/issues/8258): Fixed issue where pytest's `faulthandler` support would not dump traceback on crashes if the `faulthandler`{.interpreted-text role="mod"} module was already enabled during pytest startup (using `python -X dev -m pytest` for example). - [#8317](https://github.com/pytest-dev/pytest/issues/8317): Fixed an issue where illegal directory characters derived from `getpass.getuser()` raised an `OSError`. - [#8367](https://github.com/pytest-dev/pytest/issues/8367): Fix `Class.from_parent` so it forwards extra keyword arguments to the constructor. - [#8377](https://github.com/pytest-dev/pytest/issues/8377): The test selection options `pytest -k` and `pytest -m` now support matching names containing forward slash (`/`) characters. - [#8384](https://github.com/pytest-dev/pytest/issues/8384): The `@pytest.mark.skip` decorator now correctly handles its arguments. When the `reason` argument is accidentally given both positional and as a keyword (e.g. because it was confused with `skipif`), a `TypeError` now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally, `reason` is now documented correctly as positional or keyword (rather than keyword-only). - [#8394](https://github.com/pytest-dev/pytest/issues/8394): Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default `--fixtures` invocation (but they still show up with `--fixtures -v`). - [#8456](https://github.com/pytest-dev/pytest/issues/8456): The `required_plugins`{.interpreted-text role="confval"} config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all. - [#8464](https://github.com/pytest-dev/pytest/issues/8464): `-c <config file>` now also properly defines `rootdir` as the directory that contains `<config file>`. - [#8503](https://github.com/pytest-dev/pytest/issues/8503): `pytest.MonkeyPatch.syspath_prepend`{.interpreted-text role="meth"} no longer fails when `setuptools` is not installed. It now only calls `pkg_resources.fixup_namespace_packages`{.interpreted-text role="func"} if `pkg_resources` was previously imported, because it is not needed otherwise. - [#8548](https://github.com/pytest-dev/pytest/issues/8548): Introduce fix to handle precision width in `log-cli-format` in turn to fix output coloring for certain formats. - [#8796](https://github.com/pytest-dev/pytest/issues/8796): Fixed internal error when skipping doctests. - [#8983](https://github.com/pytest-dev/pytest/issues/8983): The test selection options `pytest -k` and `pytest -m` now support matching names containing backslash (\[\\]{.title-ref}) characters. Backslashes are treated literally, not as escape characters (the values being matched against are already escaped). - [#8990](https://github.com/pytest-dev/pytest/issues/8990): Fix \[pytest -vv]{.title-ref} crashing with an internal exception \[AttributeError: 'str' object has no attribute 'relative_to']{.title-ref} in some cases. - [#9077](https://github.com/pytest-dev/pytest/issues/9077): Fixed confusing error message when `request.fspath` / `request.path` was accessed from a session-scoped fixture. - [#9131](https://github.com/pytest-dev/pytest/issues/9131): Fixed the URL used by `--pastebin` to use [bpa.st](http://bpa.st). - [#9163](https://github.com/pytest-dev/pytest/issues/9163): The end line number and end column offset are now properly set for rewritten assert statements. - [#9169](https://github.com/pytest-dev/pytest/issues/9169): Support for the `files` API from `importlib.resources` within rewritten files. - [#9272](https://github.com/pytest-dev/pytest/issues/9272): The nose compatibility module-level fixtures \[setup()]{.title-ref} and \[teardown()]{.title-ref} are now only called once per module, instead of for each test function. They are now called even if object-level \[setup]{.title-ref}/\[teardown]{.title-ref} is defined. ## Improved Documentation - [#4320](https://github.com/pytest-dev/pytest/issues/4320): Improved docs for \[pytester.copy_example]{.title-ref}. - [#5105](https://github.com/pytest-dev/pytest/issues/5105): Add automatically generated `plugin-list`{.interpreted-text role="ref"}. The list is updated on a periodic schedule. - [#8337](https://github.com/pytest-dev/pytest/issues/8337): Recommend [numpy.testing](https://numpy.org/doc/stable/reference/routines.testing.html) module on `pytest.approx`{.interpreted-text role="func"} documentation. - [#8655](https://github.com/pytest-dev/pytest/issues/8655): Help text for `--pdbcls` more accurately reflects the option's behavior. - [#9210](https://github.com/pytest-dev/pytest/issues/9210): Remove incorrect docs about `confcutdir` being a configuration option: it can only be set through the `--confcutdir` command-line option. - [#9242](https://github.com/pytest-dev/pytest/issues/9242): Upgrade readthedocs configuration to use a [newer Ubuntu version](https://blog.readthedocs.com/new-build-specification/)\` with better unicode support for PDF docs. - [#9341](https://github.com/pytest-dev/pytest/issues/9341): Various methods commonly used for `non-python tests`{.interpreted-text role="ref"} are now correctly documented in the reference docs. They were undocumented previously. ## Trivial/Internal Changes - [#8133](https://github.com/pytest-dev/pytest/issues/8133): Migrate to `setuptools_scm` 6.x to use `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST` for more robust release tooling. - [#8174](https://github.com/pytest-dev/pytest/issues/8174): The following changes have been made to internal pytest types/functions: - The `_pytest.code.getfslineno()` function returns `Path` instead of `py.path.local`. - The `_pytest.python.path_matches_patterns()` function takes `Path` instead of `py.path.local`. - The `_pytest._code.Traceback.cut()` function accepts any `os.PathLike[str]`, not just `py.path.local`. - [#8248](https://github.com/pytest-dev/pytest/issues/8248): Internal Restructure: let `python.PyObjMixin` inherit from `nodes.Node` to carry over typing information. - [#8432](https://github.com/pytest-dev/pytest/issues/8432): Improve error message when `pytest.skip`{.interpreted-text role="func"} is used at module level without passing \[allow_module_level=True]{.title-ref}. - [#8818](https://github.com/pytest-dev/pytest/issues/8818): Ensure `regendoc` opts out of `TOX_ENV` cachedir selection to ensure independent example test runs. - [#8913](https://github.com/pytest-dev/pytest/issues/8913): The private `CallSpec2._arg2scopenum` attribute has been removed after an internal refactoring. - [#8967](https://github.com/pytest-dev/pytest/issues/8967): `pytest_assertion_pass`{.interpreted-text role="hook"} is no longer considered experimental and future changes to it will be considered more carefully. - [#9202](https://github.com/pytest-dev/pytest/issues/9202): Add github action to upload coverage report to codecov instead of bash uploader. - [#9225](https://github.com/pytest-dev/pytest/issues/9225): Changed the command used to create sdist and wheel artifacts: using the build package instead of setup.py. - [#9351](https://github.com/pytest-dev/pytest/issues/9351): Correct minor typos in doc/en/example/special.rst. ### [`v6.2.5`](https://github.com/pytest-dev/pytest/releases/tag/6.2.5) [Compare Source](https://github.com/pytest-dev/pytest/compare/6.2.4...6.2.5) # pytest 6.2.5 (2021-08-29) ## Trivial/Internal Changes - [#8494](https://github.com/pytest-dev/pytest/issues/8494): Python 3.10 is now supported. - [#9040](https://github.com/pytest-dev/pytest/issues/9040): Enable compatibility with `pluggy 1.0` or later. ### [`v6.2.4`](https://github.com/pytest-dev/pytest/releases/tag/6.2.4) [Compare Source](https://github.com/pytest-dev/pytest/compare/6.2.3...6.2.4) # pytest 6.2.4 (2021-05-04) ## Bug Fixes - [#8539](https://github.com/pytest-dev/pytest/issues/8539): Fixed assertion rewriting on Python 3.10. ### [`v6.2.3`](https://github.com/pytest-dev/pytest/releases/tag/6.2.3) [Compare Source](https://github.com/pytest-dev/pytest/compare/6.2.2...6.2.3) # pytest 6.2.3 (2021-04-03) ## Bug Fixes - [#8414](https://github.com/pytest-dev/pytest/issues/8414): pytest used to create directories under `/tmp` with world-readable permissions. This means that any user in the system was able to read information written by tests in temporary directories (such as those created by the `tmp_path`/`tmpdir` fixture). Now the directories are created with private permissions. pytest used silenty use a pre-existing `/tmp/pytest-of-<username>` directory, even if owned by another user. This means another user could pre-create such a directory and gain control of another user's temporary directory. Now such a condition results in an error. ### [`v6.2.2`](https://github.com/pytest-dev/pytest/releases/tag/6.2.2) [Compare Source](https://github.com/pytest-dev/pytest/compare/6.2.1...6.2.2) # pytest 6.2.2 (2021-01-25) ## Bug Fixes - [#8152](https://github.com/pytest-dev/pytest/issues/8152): Fixed "(\<Skipped instance>)" being shown as a skip reason in the verbose test summary line when the reason is empty. - [#8249](https://github.com/pytest-dev/pytest/issues/8249): Fix the `faulthandler` plugin for occasions when running with `twisted.logger` and using `pytest --capture=no`. ### [`v6.2.1`](https://github.com/pytest-dev/pytest/releases/tag/6.2.1) [Compare Source](https://github.com/pytest-dev/pytest/compare/6.2.0...6.2.1) # pytest 6.2.1 (2020-12-15) ## Bug Fixes - [#7678](https://github.com/pytest-dev/pytest/issues/7678): Fixed bug where `ImportPathMismatchError` would be raised for files compiled in the host and loaded later from an UNC mounted path (Windows). - [#8132](https://github.com/pytest-dev/pytest/issues/8132): Fixed regression in `approx`: in 6.2.0 `approx` no longer raises `TypeError` when dealing with non-numeric types, falling back to normal comparison. Before 6.2.0, array types like tf.DeviceArray fell through to the scalar case, and happened to compare correctly to a scalar if they had only one element. After 6.2.0, these types began failing, because they inherited neither from standard Python number hierarchy nor from `numpy.ndarray`. `approx` now converts arguments to `numpy.ndarray` if they expose the array protocol and are not scalars. This treats array-like objects like numpy arrays, regardless of size. ### [`v6.2.0`](https://github.com/pytest-dev/pytest/releases/tag/6.2.0) [Compare Source](https://github.com/pytest-dev/pytest/compare/6.1.2...6.2.0) # pytest 6.2.0 (2020-12-12) ## Breaking Changes - [#7808](https://github.com/pytest-dev/pytest/issues/7808): pytest now supports python3.6+ only. ## Deprecations - [#7469](https://github.com/pytest-dev/pytest/issues/7469): Directly constructing/calling the following classes/functions is now deprecated: - `_pytest.cacheprovider.Cache` - `_pytest.cacheprovider.Cache.for_config()` - `_pytest.cacheprovider.Cache.clear_cache()` - `_pytest.cacheprovider.Cache.cache_dir_from_config()` - `_pytest.capture.CaptureFixture` - `_pytest.fixtures.FixtureRequest` - `_pytest.fixtures.SubRequest` - `_pytest.logging.LogCaptureFixture` - `_pytest.pytester.Pytester` - `_pytest.pytester.Testdir` - `_pytest.recwarn.WarningsRecorder` - `_pytest.recwarn.WarningsChecker` - `_pytest.tmpdir.TempPathFactory` - `_pytest.tmpdir.TempdirFactory` These have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 7.0.0. - [#7530](https://github.com/pytest-dev/pytest/issues/7530): The `--strict` command-line option has been deprecated, use `--strict-markers` instead. We have plans to maybe in the future to reintroduce `--strict` and make it an encompassing flag for all strictness related options (`--strict-markers` and `--strict-config` at the moment, more might be introduced in the future). - [#7988](https://github.com/pytest-dev/pytest/issues/7988): The `@pytest.yield_fixture` decorator/function is now deprecated. Use pytest.fixture instead. `yield_fixture` has been an alias for `fixture` for a very long time, so can be search/replaced safely. ## Features - [#5299](https://github.com/pytest-dev/pytest/issues/5299): pytest now warns about unraisable exceptions and unhandled thread exceptions that occur in tests on Python>=3.8. See unraisable for more information. - [#7425](https://github.com/pytest-dev/pytest/issues/7425): New pytester fixture, which is identical to testdir but its methods return pathlib.Path when appropriate instead of `py.path.local`. This is part of the movement to use pathlib.Path objects internally, in order to remove the dependency to `py` in the future. Internally, the old Testdir <\_pytest.pytester.Testdir> is now a thin wrapper around Pytester <\_pytest.pytester.Pytester>, preserving the old interface. - [#7695](https://github.com/pytest-dev/pytest/issues/7695): A new hook was added, pytest_markeval_namespace which should return a dictionary. This dictionary will be used to augment the "global" variables available to evaluate skipif/xfail/xpass markers. Pseudo example `conftest.py`: ```{.sourceCode .python} def pytest_markeval_namespace(): return {"color": "red"} ``` `test_func.py`: ```{.sourceCode .python} @pytest.mark.skipif("color == 'blue'", reason="Color is not red") def test_func(): assert False ``` - [#8006](https://github.com/pytest-dev/pytest/issues/8006): It is now possible to construct a ~pytest.MonkeyPatch object directly as `pytest.MonkeyPatch()`, in cases when the monkeypatch fixture cannot be used. Previously some users imported it from the private \_pytest.monkeypatch.MonkeyPatch namespace. Additionally, MonkeyPatch.context \<pytest.MonkeyPatch.context> is now a classmethod, and can be used as `with MonkeyPatch.context() as mp: ...`. This is the recommended way to use `MonkeyPatch` directly, since unlike the `mon…

RonnyPfannschmidt · 2023-08-22T21:09:36Z

closing as completed as we removed the py dependency when the CVE did hit

The-Compiler · 2023-08-24T14:42:47Z

Didn't we have some further plans around this? I thought at some point we wanted to get rid of our py shim, possibly deprecating and then removing things in your legacypath built-in plugin, no?

RonnyPfannschmidt · 2023-08-24T16:20:35Z

Indeed, but we completed the removal of the actual dependency

bluetech · 2023-08-24T17:34:52Z

The proposed deprecation plan was here: #7259 (comment)

It should be mostly straightforward code-wise to deprecate and move to external plugin for those who still want it. At least after 8.1 removes various related already-deprecated functionality like the path parameters in hooks.

But for me at least the main reason for doing so was to remove the py dependency, and since we already did this then it's starting to look less appealing to put people through the deprecation pain (as @nicoddemus said, the py.path stuff is used a lot so this will be painful).

RonnyPfannschmidt · 2023-08-24T18:16:22Z

We have to put local path to a rest, it's a White elephant

nicoddemus · 2023-08-25T12:01:31Z

The pain in this case is for users that still use tmpdir in their code bases to add pytest-tmpdir to their dependencies... I think it is worthy tradeoff, as it has the big benefit of plain pytest installations no longer having tmpdir, which might point inexperienced users in the wrong direction otherwise.

Another point to consider is the absolute ton of content out there that expects tmpdir to be builtin, and will be out-dated.

RonnyPfannschmidt · 2023-08-25T14:48:28Z

It's important to put into perspective that pyllib was a good idea in 2005, we are now close to 2025, its not been aging well

Zac-HD added type: infrastructure improvement to development/releases/CI structure type: removal marks the actual removal of a feature, usually done in major releases labels Jun 1, 2020

RonnyPfannschmidt mentioned this issue Jun 1, 2020

switch from py.iniconfig to iniconfig #7291

Closed

karlch mentioned this issue Jun 8, 2020

Tests: use the tmp_path fixture instead of tmpdir karlch/vimiv-qt#242

Merged

bluetech mentioned this issue Jul 23, 2020

junitxml: convert from py.xml to xml.etree.ElementTree #7536

Merged

bluetech mentioned this issue Apr 26, 2021

argparsing: support parser.addini(type="paths") which returns pathlib.Paths #8594

Merged

bluetech mentioned this issue Oct 9, 2021

[7.0] Change Node.reportinfo() return value from py.path to str|os.PathLike[str] #9184

Merged

bluetech mentioned this issue Oct 16, 2021

Add legacypath plugin, move py.path stuff there #9208

Merged

CAM-Gerlach mentioned this issue Nov 3, 2021

PR: Avoid future deprecations and decrease general technical debt spyder-ide/qtpy#273

Merged

7 tasks

SirUli mentioned this issue Feb 15, 2022

WIP: file collection after deprecation of 'py' in pytest ansible-community/pytest-molecule#114

Closed

link2xt mentioned this issue May 8, 2022

Introduce caching of configured live accounts in each test process deltachat/deltachat-core-rust#3298

Merged

This was referenced Oct 19, 2022

ReDoS vulnerability in svnurl.py pytest-dev/py#287

Open

CVE-2022-42969: security issue in library py used by this project #10392

Closed

Plan for dropping/deprecating submodules of py and releasing v2.0 pytest-dev/py#288

Open

RonnyPfannschmidt closed this as completed Aug 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Please remove the dependency on 'py' #7259

Please remove the dependency on 'py' #7259

mgorny commented May 25, 2020

RonnyPfannschmidt commented May 25, 2020

bluetech commented May 26, 2020

RonnyPfannschmidt commented May 26, 2020

kerizane commented May 31, 2020

RonnyPfannschmidt commented May 31, 2020

Zac-HD commented Jun 1, 2020

nicoddemus commented Jun 1, 2020

Zac-HD commented Jun 1, 2020

RonnyPfannschmidt commented Jun 2, 2020

bluetech commented Jun 2, 2020

nicoddemus commented Jun 2, 2020

kerizane commented Jun 2, 2020 •

edited

gnikonorov commented Jun 2, 2020

nicoddemus commented Jun 2, 2020

gnikonorov commented Jun 2, 2020

bluetech commented Mar 20, 2021

RonnyPfannschmidt commented Mar 22, 2021

bluetech commented Apr 26, 2021

bluetech commented May 19, 2021

RonnyPfannschmidt commented May 19, 2021

The-Compiler commented May 19, 2021 •

edited

RonnyPfannschmidt commented May 19, 2021

nicoddemus commented May 19, 2021

The-Compiler commented May 19, 2021

nicoddemus commented Oct 20, 2021 •

edited

RonnyPfannschmidt commented Aug 22, 2023

The-Compiler commented Aug 24, 2023

RonnyPfannschmidt commented Aug 24, 2023

bluetech commented Aug 24, 2023

RonnyPfannschmidt commented Aug 24, 2023

nicoddemus commented Aug 25, 2023 •

edited

RonnyPfannschmidt commented Aug 25, 2023

Please remove the dependency on 'py' #7259

Please remove the dependency on 'py' #7259

Comments

mgorny commented May 25, 2020

RonnyPfannschmidt commented May 25, 2020

bluetech commented May 26, 2020

RonnyPfannschmidt commented May 26, 2020

kerizane commented May 31, 2020

RonnyPfannschmidt commented May 31, 2020

Zac-HD commented Jun 1, 2020

nicoddemus commented Jun 1, 2020

Zac-HD commented Jun 1, 2020

RonnyPfannschmidt commented Jun 2, 2020

bluetech commented Jun 2, 2020

nicoddemus commented Jun 2, 2020

kerizane commented Jun 2, 2020 • edited

gnikonorov commented Jun 2, 2020

nicoddemus commented Jun 2, 2020

gnikonorov commented Jun 2, 2020

bluetech commented Mar 20, 2021

pathlist

reportinfo

RonnyPfannschmidt commented Mar 22, 2021

bluetech commented Apr 26, 2021

bluetech commented May 19, 2021

For 6.3.0 (next minor release)

For 7.0.0 (next major release)

For 8.0.0

RonnyPfannschmidt commented May 19, 2021

The-Compiler commented May 19, 2021 • edited

RonnyPfannschmidt commented May 19, 2021

nicoddemus commented May 19, 2021

The-Compiler commented May 19, 2021

nicoddemus commented Oct 20, 2021 • edited

RonnyPfannschmidt commented Aug 22, 2023

The-Compiler commented Aug 24, 2023

RonnyPfannschmidt commented Aug 24, 2023

bluetech commented Aug 24, 2023

RonnyPfannschmidt commented Aug 24, 2023

nicoddemus commented Aug 25, 2023 • edited

RonnyPfannschmidt commented Aug 25, 2023

kerizane commented Jun 2, 2020 •

edited

The-Compiler commented May 19, 2021 •

edited

nicoddemus commented Oct 20, 2021 •

edited

nicoddemus commented Aug 25, 2023 •

edited