Skip to content

Commit

Permalink
Add explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
The-Compiler committed Nov 29, 2021
1 parent 9b04d20 commit ede3f5e
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 0 deletions.
3 changes: 3 additions & 0 deletions changelog/7259.deprecation.rst
Expand Up @@ -5,3 +5,6 @@
.. note::
The name of the ``Node`` arguments and attributes (old ``fspath``, new ``path``) is **the opposite**
of the situation for hooks (old ``path``, new ``fspath``).
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).
3 changes: 3 additions & 0 deletions changelog/8144.feature.rst
Expand Up @@ -9,3 +9,6 @@ The following hooks now receive an additional ``pathlib.Path`` argument, equival
.. note::
The name of the ``Node`` arguments and attributes (old ``fspath``, new ``path``) is **the opposite**
of the situation for hooks (old ``path``, new ``fspath``).
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).
3 changes: 3 additions & 0 deletions changelog/8251.feature.rst
Expand Up @@ -4,3 +4,6 @@ due to the ongoing migration of methods like :meth:`~_pytest.Item.reportinfo`, w
.. note::
The name of the attributes (old ``fspath``, new ``path``) is **the opposite**
of the situation for hooks.
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).
6 changes: 6 additions & 0 deletions doc/en/deprecations.rst
Expand Up @@ -59,6 +59,9 @@ Plugins which implement custom items and collectors are encouraged to replace
.. note::
The name of the arguments (old ``fspath``, new ``path``) is **the opposite**
of the situation for hooks, :ref:`outlined below <legacy-path-hooks-deprecated>`.
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).

Due to the ongoing migration of methods like :meth:`~_pytest.Item.reportinfo`
which still is expected to return a ``py.path.local`` object, nodes still have
Expand Down Expand Up @@ -86,6 +89,9 @@ The accompanying ``py.path.local`` based paths have been deprecated: plugins whi
.. note::
The name of the arguments (old ``path``, new ``fspath``) is **the opposite**
of the situation for the :class:`~_pytest.nodes.Node` class, :ref:`outlined above <node-ctor-fspath-deprecation>`.
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).

Directly constructing internal classes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit ede3f5e

Please sign in to comment.