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: .github/PULL_REQUEST_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ Thanks for submitting a PR, your contribution is really appreciated!
3
3
Here's a quick checklist that should be present in PRs (you can delete this text from the final description, this is
4
4
just a guideline):
5
5
6
-
-[ ] Create a new changelog file in the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](/changelog/README.rst) for details.
6
+
-[ ] Create a new changelog file in the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](https://github.com/pytest-dev/pytest/blob/master/changelog/README.rst) for details.
7
7
-[ ] Target the `master` branch for bug fixes, documentation updates and trivial changes.
8
8
-[ ] Target the `features` branch for new features and removals/deprecations.
9
9
-[ ] Include documentation when adding new features.
- `#3616 <https://github.com/pytest-dev/pytest/issues/3616>`_: The following accesses have been documented as deprecated for years, but are now actually emitting deprecation warnings.
39
+
40
+
* Access of ``Module``, ``Function``, ``Class``, ``Instance``, ``File`` and ``Item`` through ``Node`` instances. Now
41
+
users will this warning::
42
+
43
+
usage of Function.Module is deprecated, please use pytest.Module instead
44
+
45
+
Users should just ``import pytest`` and access those objects using the ``pytest`` module.
46
+
47
+
* ``request.cached_setup``, this was the precursor of the setup/teardown mechanism available to fixtures. You can
48
+
consult `funcarg comparison section in the docs <https://docs.pytest.org/en/latest/funcarg_compare.html>`_.
49
+
50
+
* Using objects named ``"Class"`` as a way to customize the type of nodes that are collected in ``Collector``
51
+
subclasses has been deprecated. Users instead should use ``pytest_collect_make_item`` to customize node types during
52
+
collection.
53
+
54
+
This issue should affect only advanced plugins who create new collection types, so if you see this warning
55
+
message please contact the authors so they can change the code.
56
+
57
+
* The warning that produces the message below has changed to ``RemovedInPytest4Warning``::
58
+
59
+
getfuncargvalue is deprecated, use getfixturevalue
60
+
61
+
62
+
- `#3988 <https://github.com/pytest-dev/pytest/issues/3988>`_: Add a Deprecation warning for pytest.ensuretemp as it was deprecated since a while.
63
+
64
+
65
+
66
+
Features
67
+
--------
68
+
69
+
- `#2293 <https://github.com/pytest-dev/pytest/issues/2293>`_: Improve usage errors messages by hiding internal details which can be distracting and noisy.
70
+
71
+
This has the side effect that some error conditions that previously raised generic errors (such as
72
+
``ValueError`` for unregistered marks) are now raising ``Failed`` exceptions.
73
+
74
+
75
+
- `#3332 <https://github.com/pytest-dev/pytest/issues/3332>`_: Improve the error displayed when a ``conftest.py`` file could not be imported.
76
+
77
+
In order to implement this, a new ``chain`` parameter was added to ``ExceptionInfo.getrepr``
78
+
to show or hide chained tracebacks in Python 3 (defaults to ``True``).
79
+
80
+
81
+
- `#3849 <https://github.com/pytest-dev/pytest/issues/3849>`_: Add ``empty_parameter_set_mark=fail_at_collect`` ini option for raising an exception when parametrize collects an empty set.
82
+
83
+
84
+
- `#3964 <https://github.com/pytest-dev/pytest/issues/3964>`_: Log messages generated in the collection phase are shown when
85
+
live-logging is enabled and/or when they are logged to a file.
86
+
87
+
88
+
- `#3985 <https://github.com/pytest-dev/pytest/issues/3985>`_: Introduce ``tmp_path`` as a fixture providing a Path object.
89
+
90
+
91
+
- `#4013 <https://github.com/pytest-dev/pytest/issues/4013>`_: Deprecation warnings are now shown even if you customize the warnings filters yourself. In the previous version
92
+
any customization would override pytest's filters and deprecation warnings would fall back to being hidden by default.
93
+
94
+
95
+
- `#4073 <https://github.com/pytest-dev/pytest/issues/4073>`_: Allow specification of timeout for ``Testdir.runpytest_subprocess()`` and ``Testdir.run()``.
96
+
97
+
98
+
- `#4098 <https://github.com/pytest-dev/pytest/issues/4098>`_: Add returncode argument to pytest.exit() to exit pytest with a specific return code.
99
+
100
+
101
+
- `#4102 <https://github.com/pytest-dev/pytest/issues/4102>`_: Reimplement ``pytest.deprecated_call`` using ``pytest.warns`` so it supports the ``match='...'`` keyword argument.
102
+
103
+
This has the side effect that ``pytest.deprecated_call`` now raises ``pytest.fail.Exception`` instead
104
+
of ``AssertionError``.
105
+
106
+
107
+
- `#4149 <https://github.com/pytest-dev/pytest/issues/4149>`_: Require setuptools>=30.3 and move most of the metadata to ``setup.cfg``.
108
+
109
+
110
+
111
+
Bug Fixes
112
+
---------
113
+
114
+
- `#2535 <https://github.com/pytest-dev/pytest/issues/2535>`_: Improve error message when test functions of ``unittest.TestCase`` subclasses use a parametrized fixture.
115
+
116
+
117
+
- `#3057 <https://github.com/pytest-dev/pytest/issues/3057>`_: ``request.fixturenames`` now correctly returns the name of fixtures created by ``request.getfixturevalue()``.
118
+
119
+
120
+
- `#3946 <https://github.com/pytest-dev/pytest/issues/3946>`_: Warning filters passed as command line options using ``-W`` now take precedence over filters defined in ``ini``
121
+
configuration files.
122
+
123
+
124
+
- `#4066 <https://github.com/pytest-dev/pytest/issues/4066>`_: Fix source reindenting by using ``textwrap.dedent`` directly.
125
+
126
+
127
+
- `#4102 <https://github.com/pytest-dev/pytest/issues/4102>`_: ``pytest.warn`` will capture previously-warned warnings in Python 2. Previously they were never raised.
128
+
129
+
130
+
- `#4108 <https://github.com/pytest-dev/pytest/issues/4108>`_: Resolve symbolic links for args.
131
+
132
+
This fixes running ``pytest tests/test_foo.py::test_bar``, where ``tests``
133
+
is a symlink to ``project/app/tests``:
134
+
previously ``project/app/conftest.py`` would be ignored for fixtures then.
135
+
136
+
137
+
- `#4132 <https://github.com/pytest-dev/pytest/issues/4132>`_: Fix duplicate printing of internal errors when using ``--pdb``.
138
+
139
+
140
+
- `#4135 <https://github.com/pytest-dev/pytest/issues/4135>`_: pathlib based tmpdir cleanup now correctly handles symlinks in the folder.
141
+
142
+
143
+
- `#4152 <https://github.com/pytest-dev/pytest/issues/4152>`_: Display the filename when encountering ``SyntaxWarning``.
144
+
145
+
146
+
147
+
Improved Documentation
148
+
----------------------
149
+
150
+
- `#3713 <https://github.com/pytest-dev/pytest/issues/3713>`_: Update usefixtures documentation to clarify that it can't be used with fixture functions.
151
+
152
+
153
+
- `#4058 <https://github.com/pytest-dev/pytest/issues/4058>`_: Update fixture documentation to specify that a fixture can be invoked twice in the scope it's defined for.
154
+
155
+
156
+
- `#4064 <https://github.com/pytest-dev/pytest/issues/4064>`_: According to unittest.rst, setUpModule and tearDownModule were not implemented, but it turns out they are. So updated the documentation for unittest.
157
+
158
+
159
+
- `#4151 <https://github.com/pytest-dev/pytest/issues/4151>`_: Add tempir testing example to CONTRIBUTING.rst guide
160
+
161
+
162
+
163
+
Trivial/Internal Changes
164
+
------------------------
165
+
166
+
- `#2293 <https://github.com/pytest-dev/pytest/issues/2293>`_: The internal ``MarkerError`` exception has been removed.
167
+
168
+
169
+
- `#3988 <https://github.com/pytest-dev/pytest/issues/3988>`_: Port the implementation of tmpdir to pathlib.
170
+
171
+
172
+
- `#4063 <https://github.com/pytest-dev/pytest/issues/4063>`_: Exclude 0.00 second entries from ``--duration`` output unless ``-vv`` is passed on the command-line.
173
+
174
+
175
+
- `#4093 <https://github.com/pytest-dev/pytest/issues/4093>`_: Fixed formatting of string literals in internal tests.
Copy file name to clipboardExpand all lines: CONTRIBUTING.rst
+41Lines changed: 41 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -280,6 +280,47 @@ Here is a simple overview, with pytest-specific bits:
280
280
base: features # if it's a feature
281
281
282
282
283
+
Writing Tests
284
+
----------------------------
285
+
286
+
Writing tests for plugins or for pytest itself is often done using the `testdir fixture <https://docs.pytest.org/en/latest/reference.html#testdir>`_, as a "black-box" test.
287
+
288
+
For example, to ensure a simple test passes you can write:
289
+
290
+
.. code-block:: python
291
+
292
+
deftest_true_assertion(testdir):
293
+
testdir.makepyfile(
294
+
"""
295
+
def test_foo():
296
+
assert True
297
+
"""
298
+
)
299
+
result = testdir.runpytest()
300
+
result.assert_outcomes(failed=0, passed=1)
301
+
302
+
303
+
Alternatively, it is possible to make checks based on the actual output of the termal using
0 commit comments