You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.rst
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -146,7 +146,7 @@ the following:
146
146
- PyPI presence with packaging metadata that contains a ``pytest-``
147
147
prefixed name, version number, authors, short and long description.
148
148
149
-
- a `tox configuration <https://tox.readthedocs.io/en/latest/config.html#configuration-discovery>`_
149
+
- a `tox configuration <https://tox.readthedocs.io/en/latest/config.html#configuration-discovery>`_
150
150
for running tests using `tox <https://tox.readthedocs.io>`_.
151
151
152
152
- a ``README`` describing how to use the plugin and on which
@@ -280,7 +280,7 @@ Here is a simple overview, with pytest-specific bits:
280
280
#. You can now edit your local working copy and run the tests again as necessary. Please follow `PEP-8 <https://www.python.org/dev/peps/pep-0008/>`_ for naming.
281
281
282
282
You can pass different options to ``tox``. For example, to run tests on Python 3.13 and pass options to pytest
283
-
(e.g. enter pdb on failure) to pytest you can do::
283
+
(e.g. enter pdb on failure) you can do::
284
284
285
285
$ tox -e py313 -- --pdb
286
286
@@ -346,7 +346,7 @@ For example, to ensure a simple test passes you can write:
346
346
result.assert_outcomes(failed=0, passed=1)
347
347
348
348
349
-
Alternatively, it is possible to make checks based on the actual output of the termal using
349
+
Alternatively, it is possible to make checks based on the actual output of the terminal using
350
350
*glob-like* expressions:
351
351
352
352
.. code-block:: python
@@ -479,10 +479,10 @@ above?
479
479
to do the backport.
480
480
2. However, often the merge is done by another maintainer, in which case it is nice of them to
481
481
do the backport procedure if they have the time.
482
-
3. For bugs submitted by non-maintainers, it is expected that a core developer will to do
482
+
3. For bugs submitted by non-maintainers, it is expected that a core developer will do
483
483
the backport, normally the one that merged the PR on ``main``.
484
-
4. If a non-maintainers notices a bug which is fixed on ``main`` but has not been backported
485
-
(due to maintainers forgetting to apply the *needs backport* label, or just plain missing it),
484
+
4. If a non-maintainer notices a bug which is fixed on ``main`` but has not been backported
485
+
(due to maintainers forgetting to apply the *needs backport* or *backport x.x.x* labels, or just plain missing it),
486
486
they are also welcome to open a PR with the backport. The procedure is simple and really
487
487
helps with the maintenance of the project.
488
488
@@ -512,7 +512,7 @@ can always reopen the issue/pull request in their own time later if it makes sen
512
512
When to close
513
513
~~~~~~~~~~~~~
514
514
515
-
Here are a few general rules the maintainers use deciding when to close issues/PRs because
515
+
Here are a few general rules the maintainers use to decide when to close issues/PRs because
516
516
of lack of inactivity:
517
517
518
518
* Issues labeled ``question`` or ``needs information``: closed after 14 days inactive.
@@ -524,15 +524,15 @@ The above are **not hard rules**, but merely **guidelines**, and can be (and oft
524
524
Closing pull requests
525
525
~~~~~~~~~~~~~~~~~~~~~
526
526
527
-
When closing a Pull Request, it needs to be acknowledging the time, effort, and interest demonstrated by the person which submitted it. As mentioned previously, it is not the intent of the team to dismiss a stalled pull request entirely but to merely to clear up our queue, so a message like the one below is warranted when closing a pull request that went stale:
527
+
When closing a Pull Request, we should acknowledge the time, effort, and interest demonstrated by the person who submitted it. As mentioned previously, it is not the intent of the team to dismiss a stalled pull request entirely but to merely to clear up our queue, so a message like the one below is warranted when closing a pull request that went stale:
528
528
529
529
Hi <contributor>,
530
530
531
531
First of all, we would like to thank you for your time and effort on working on this, the pytest team deeply appreciates it.
532
532
533
533
We noticed it has been awhile since you have updated this PR, however. pytest is a high activity project, with many issues/PRs being opened daily, so it is hard for us maintainers to track which PRs are ready for merging, for review, or need more attention.
534
534
535
-
So for those reasons we, think it is best to close the PR for now, but with the only intention to clean up our queue, it is by no means a rejection of your changes. We still encourage you to re-open this PR (it is just a click of a button away) when you are ready to get back to it.
535
+
So for those reasons, we think it is best to close the PR for now, but with the only intention to clean up our queue, it is by no means a rejection of your changes. We still encourage you to re-open this PR (it is just a click of a button away) when you are ready to get back to it.
536
536
537
537
Again we appreciate your time for working on this, and hope you might get back to this at a later time!
Copy file name to clipboardExpand all lines: changelog/README.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,12 +16,12 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
16
16
* ``feature``: new user facing features, like new command-line options and new behavior.
17
17
* ``improvement``: improvement of existing functionality, usually without requiring user intervention (for example, new fields being written in ``--junit-xml``, improved colors in terminal, etc).
18
18
* ``bugfix``: fixes a bug.
19
-
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
19
+
* ``doc``: documentation improvement, like rewording an entire section or adding missing docs.
20
20
* ``deprecation``: feature deprecation.
21
21
* ``breaking``: a change which may break existing suites, such as feature removal or behavior change.
22
22
* ``vendor``: changes in packages vendored in pytest.
23
23
* ``packaging``: notes for downstreams about unobvious side effects
24
-
and tooling. changes in the test invocation considerations and
24
+
and tooling. Changes in the test invocation considerations and
25
25
runtime assumptions.
26
26
* ``contrib``: stuff that affects the contributor experience. e.g.
27
27
Running tests, building the docs, setting up the development
Keeping backwards compatibility has a very high priority in the pytest project. Although we have deprecated functionality over the years, most of it is still supported. All deprecations in pytest were done because simpler or more efficient ways of accomplishing the same tasks have emerged, making the old way of doing things unnecessary.
Copy file name to clipboardExpand all lines: doc/en/deprecations.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,7 +90,7 @@ Example of problematic code:
90
90
deftest_2(self, n):
91
91
pass
92
92
93
-
You can fix it by convert generators and iterators to lists or tuples:
93
+
You can fix it by converting generators and iterators to lists or tuples:
94
94
95
95
.. code-block:: python
96
96
@@ -167,7 +167,7 @@ In ``8.2`` the ``exc_type`` parameter has been added, giving users the ability o
167
167
to skip tests only if the module cannot really be found, and not because of some other error.
168
168
169
169
Catching only :class:`ModuleNotFoundError` by default (and letting other errors propagate) would be the best solution,
170
-
however for backward compatibility, pytest will keep the existing behavior but raise an warning if:
170
+
however for backward compatibility, pytest will keep the existing behavior but raise a warning if:
171
171
172
172
1. The captured exception is of type :class:`ImportError`, and:
173
173
2. The user does not pass ``exc_type`` explicitly.
@@ -342,7 +342,7 @@ The ``yield_fixture`` function/decorator
342
342
343
343
``pytest.yield_fixture`` is a deprecated alias for :func:`pytest.fixture`.
344
344
345
-
It has been so for a very long time, so can be search/replaced safely.
345
+
It has been so for a very long time, so it can be searched/replaced safely.
346
346
347
347
348
348
Removed Features and Breaking Changes
@@ -876,7 +876,7 @@ The ``pytest._fillfuncargs`` function
876
876
877
877
This function was kept for backward compatibility with an older plugin.
878
878
879
-
It's functionality is not meant to be used directly, but if you must replace
879
+
Its functionality is not meant to be used directly, but if you must replace
880
880
it, use `function._request._fillfixtures()` instead, though note this is not
881
881
a public API and may break in the future.
882
882
@@ -907,7 +907,7 @@ The ``--result-log`` option produces a stream of test reports which can be
907
907
analysed at runtime, but it uses a custom format which requires users to implement their own
908
908
parser.
909
909
910
-
The `pytest-reportlog<https://github.com/pytest-dev/pytest-reportlog>`__ plugin provides a ``--report-log`` option, a more standard and extensible alternative, producing
910
+
The :pypi:`pytest-reportlog` plugin provides a ``--report-log`` option, a more standard and extensible alternative, producing
911
911
one JSON object per-line, and should cover the same use cases. Please try it out and provide feedback.
912
912
913
913
The ``pytest-reportlog`` plugin might even be merged into the core
0 commit comments