Skip to content

Commit 668ebb1

Browse files
committed
Clean up changelog
- Merged 3.0 and 2.10 as much stuff from the sprint went to the 2.10 section. - Cleaned up mixture of link/text blocks - Moved some entries to "Bug Fixes" and "Incompatible changes" - Stop doing "Fixes (#123) ..." because it looks weird - Add some new empty points for all sections
1 parent 293351c commit 668ebb1

File tree

1 file changed

+123
-103
lines changed

1 file changed

+123
-103
lines changed

CHANGELOG.rst

Lines changed: 123 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,54 @@
11
3.0.0.dev1
22
==========
33

4-
**Changes**
4+
**Incompatible changes**
55

6-
*
6+
* Removed the following deprecated commandline options
77

8-
*
8+
* ``--genscript``
9+
* ``--no-assert``
10+
* ``--nomagic``
11+
* ``--report``
912

10-
*
13+
Thanks to `@RedBeardCode`_ for the PR (`#1664`_)
14+
15+
* ImportErrors in plugins now are a fatal error instead of issuing a
16+
pytest warning (`#1479`_). Thanks to `@The-Compiler`_ for the PR.
1117

12-
* Fix (`#607`_): pytest.skip() is no longer allowed at module level to
18+
* removed support code for python 3 < 3.3 addressing (`#1627`_)
19+
20+
* Remove all py.test-X* entry points. The versioned, suffixed entry points
21+
were never documented and a leftover from a pre-virtualenv era. These entry
22+
points also created broken entry points in wheels, so removing them also
23+
removes a source of confusion for users (`#1632`_).
24+
Thanks `@obestwalter`_ for the PR.
25+
26+
* Fix `#607`_: pytest.skip() is no longer allowed at module level to
1327
prevent misleading use as test function decorator. When used at a module
1428
level an error will be raised during collection.
1529
Thanks `@omarkohl`_ for the complete PR (`#1519`_).
1630

17-
*
18-
19-
**Incompatible changes**
31+
* Fix `#1421`_: Exit tests if a collection error occurs and add
32+
``--continue-on-collection-errors`` option to restore previous behaviour.
33+
Thanks `@olegpidsadnyi`_ and `@omarkohl`_ for the complete PR (`#1628`_).
2034

21-
* Removing the following deprecated commandline options
35+
* Renamed the pytest ``pdb`` module (plugin) into ``debugging``.
2236

23-
* ``--genscript``
24-
* ``--no-assert``
25-
* ``--nomagic``
26-
* ``--report``
37+
* Raise helpful failure message, when requesting parametrized fixture at runtime,
38+
e.g. with ``request.getfuncargvalue``. Previously these params were simply
39+
never defined. So a fixture decorated like ``@pytest.fixture(params=[0, 1,
40+
2])`` only ran once. Now a failure is raised. Fixes `#460`_. Thanks to
41+
`@nikratio`_ for bug report, `@RedBeardCode`_ and `@tomviner`_ for PR.
2742

28-
Thanks to `@RedBeardCode`_ for the PR(`#1664`_)
43+
*
2944

30-
* removed support code for python 3 < 3.3 addressing (`#1627`_)
45+
*
3146

32-
.. _#607: https://github.com/pytest-dev/pytest/issues/607
33-
.. _#1519: https://github.com/pytest-dev/pytest/pull/1519
34-
.. _#1664: https://github.com/pytest-dev/pytest/pull/1664
35-
.. _#1627: https://github.com/pytest-dev/pytest/pull/1627
47+
*
3648

49+
*
3750

38-
2.10.0.dev1
39-
===========
51+
*
4052

4153
**New Features**
4254

@@ -66,7 +78,7 @@
6678

6779
* ``__tracebackhide__`` can now also be set to a callable which then can decide
6880
whether to filter the traceback based on the ``ExceptionInfo`` object passed
69-
to it.
81+
to it. Thanks `@The-Compiler`_ for the complete PR (`#1526`_).
7082

7183
* New ``pytest_make_parametrize_id`` hook.
7284
Thanks `@palaviv`_ for the PR.
@@ -104,11 +116,15 @@
104116
Example '-o xfail_strict=True'. A complete ini-options can be viewed
105117
by py.test --help. Thanks `@blueyed`_ and `@fengxx`_ for the PR
106118

107-
* Remove all py.test-X* entry points. The versioned, suffixed entry points
108-
were never documented and a leftover from a pre-virtualenv era. These entry
109-
points also created broken entry points in wheels, so removing them also
110-
removes a source of confusion for users (`#1632`_).
111-
Thanks `@obestwalter`_ for the PR.
119+
*
120+
121+
*
122+
123+
*
124+
125+
*
126+
127+
*
112128

113129
**Changes**
114130

@@ -118,7 +134,7 @@
118134
the preferred way to write teardown code (`#1461`_).
119135
Thanks `@csaftoiu`_ for bringing this to attention and `@nicoddemus`_ for the PR.
120136

121-
* Fix (`#1351`_):
137+
* Fix `#1351`_:
122138
explicitly passed parametrize ids do not get escaped to ascii.
123139
Thanks `@ceridwen`_ for the PR.
124140

@@ -148,27 +164,10 @@
148164
* Text documents without any doctests no longer appear as "skipped".
149165
Thanks `@graingert`_ for reporting and providing a full PR (`#1580`_).
150166

151-
* Fix internal error issue when ``method`` argument is missing for
152-
``teardown_method()``. Fixes (`#1605`_).
153-
154-
* Fix exception visualization in case the current working directory (CWD) gets
155-
deleted during testing. Fixes (`#1235`). Thanks `@bukzor`_ for reporting. PR by
156-
`@marscher`. Thanks `@nicoddemus`_ for his help.
157-
158167
* Ensure that a module within a namespace package can be found when it
159168
is specified on the command line together with the ``--pyargs``
160169
option. Thanks to `@taschini`_ for the PR (`#1597`_).
161170

162-
* Raise helpful failure message, when requesting parametrized fixture at runtime,
163-
e.g. with ``request.getfuncargvalue``. BACKWARD INCOMPAT: Previously these params
164-
were simply never defined. So a fixture decorated like ``@pytest.fixture(params=[0, 1, 2])``
165-
only ran once. Now a failure is raised. Fixes (`#460`_). Thanks to
166-
`@nikratio`_ for bug report, `@RedBeardCode`_ and `@tomviner`_ for PR.
167-
168-
* Create correct diff for strings ending with newlines. Fixes (`#1553`_).
169-
Thanks `@Vogtinator`_ for reporting. Thanks to `@RedBeardCode`_ and
170-
`@tomviner`_ for PR.
171-
172171
* Add proposal to docs for a new feature that enables users to combine multiple
173172
fixtures into one. Thanks to `@hpk42`_ and `@hackebrot`_.
174173

@@ -181,94 +180,115 @@
181180
Thanks `@bagerard`_ for reporting (`#1503`_). Thanks to `@davehunt`_ and
182181
`@tomviner`_ for PR.
183182

184-
* Renamed the pytest ``pdb`` module (plugin) into ``debugging``.
183+
* ``OptionGroup.addoption()`` now checks if option names were already
184+
added before, to make it easier to track down issues like `#1618`_.
185+
Before, you only got exceptions later from ``argparse`` library,
186+
giving no clue about the actual reason for double-added options.
185187

186-
* Improve of the test output for logical expression with brackets.
187-
Fixes(`#925`_). Thanks `@DRMacIver`_ for reporting. Thanks to `@RedBeardCode`_
188-
for PR.
188+
*
189189

190-
* ImportErrors in plugins now are a fatal error instead of issuing a
190+
*
191191

192-
.. _#1632: https://github.com/pytest-dev/pytest/issues/1632
192+
*
193193

194-
pytest warning (`#1479`_). Thanks to `@The-Compiler`_ for the PR.
194+
*
195195

196-
.. _#1580: https://github.com/pytest-dev/pytest/pull/1580
197-
.. _#1605: https://github.com/pytest-dev/pytest/issues/1605
198-
.. _#1597: https://github.com/pytest-dev/pytest/pull/1597
199-
.. _#460: https://github.com/pytest-dev/pytest/pull/460
200-
.. _#1553: https://github.com/pytest-dev/pytest/issues/1553
201-
.. _#1626: https://github.com/pytest-dev/pytest/pull/1626
202-
.. _#1503: https://github.com/pytest-dev/pytest/issues/1503
203-
.. _#1479: https://github.com/pytest-dev/pytest/issues/1479
204-
.. _#925: https://github.com/pytest-dev/pytest/issues/925
196+
*
205197

206-
.. _@graingert: https://github.com/graingert
207-
.. _@taschini: https://github.com/taschini
208-
.. _@nikratio: https://github.com/nikratio
209-
.. _@RedBeardCode: https://github.com/RedBeardCode
210-
.. _@Vogtinator: https://github.com/Vogtinator
211-
.. _@blueyed: https://github.com/blueyed
212-
.. _@fengxx: https://github.com/fengxx
213-
.. _@bagerard: https://github.com/bagerard
214-
.. _@DRMacIver: https://github.com/DRMacIver
198+
**Bug Fixes**
215199

216-
* Fix `#1421`_: Exit tests if a collection error occurs and add
217-
``--continue-on-collection-errors`` option to restore previous behaviour.
218-
Thanks `@olegpidsadnyi`_ and `@omarkohl`_ for the complete PR (`#1628`_).
200+
* When receiving identical test ids in parametrize we generate unique test ids.
219201

202+
* Fix internal error issue when ``method`` argument is missing for
203+
``teardown_method()``. Fixes `#1605`_.
204+
205+
* Fix exception visualization in case the current working directory (CWD) gets
206+
deleted during testing. Fixes `#1235`_. Thanks `@bukzor`_ for reporting. PR by
207+
`@marscher`_. Thanks `@nicoddemus`_ for his help.
208+
209+
* Improve of the test output for logical expression with brackets.
210+
Fixes `#925`_. Thanks `@DRMacIver`_ for reporting. Thanks to `@RedBeardCode`_
211+
for PR.
212+
213+
* Create correct diff for strings ending with newlines. Fixes `#1553`_.
214+
Thanks `@Vogtinator`_ for reporting. Thanks to `@RedBeardCode`_ and
215+
`@tomviner`_ for PR.
220216

221217
*
222218

223-
* ``OptionGroup.addoption()`` now checks if option names were already
224-
added before, to make it easier to track down issues like `#1618`_.
225-
Before, you only got exceptions later from ``argparse`` library,
226-
giving no clue about the actual reason for double-added options.
219+
*
227220

228-
.. _@milliams: https://github.com/milliams
229-
.. _@csaftoiu: https://github.com/csaftoiu
230-
.. _@flub: https://github.com/flub
231-
.. _@novas0x2a: https://github.com/novas0x2a
232-
.. _@kalekundert: https://github.com/kalekundert
233-
.. _@tareqalayan: https://github.com/tareqalayan
234-
.. _@ceridwen: https://github.com/ceridwen
235-
.. _@palaviv: https://github.com/palaviv
236-
.. _@omarkohl: https://github.com/omarkohl
237-
.. _@mikofski: https://github.com/mikofski
238-
.. _@sober7: https://github.com/sober7
239-
.. _@olegpidsadnyi: https://github.com/olegpidsadnyi
240-
.. _@obestwalter: https://github.com/obestwalter
241-
.. _@davehunt: https://github.com/davehunt
242-
.. _@sallner: https://github.com/sallner
243-
.. _@d6e: https://github.com/d6e
244-
.. _@kvas-it: https://github.com/kvas-it
221+
*
222+
223+
*
224+
225+
*
245226

227+
.. _#372: https://github.com/pytest-dev/pytest/issues/372
228+
.. _#460: https://github.com/pytest-dev/pytest/pull/460
229+
.. _#607: https://github.com/pytest-dev/pytest/issues/607
230+
.. _#925: https://github.com/pytest-dev/pytest/issues/925
231+
.. _#1235: https://github.com/pytest-dev/pytest/issues/1235
232+
.. _#1351: https://github.com/pytest-dev/pytest/issues/1351
246233
.. _#1421: https://github.com/pytest-dev/pytest/issues/1421
247234
.. _#1426: https://github.com/pytest-dev/pytest/issues/1426
248235
.. _#1428: https://github.com/pytest-dev/pytest/pull/1428
249-
.. _#1444: https://github.com/pytest-dev/pytest/pull/1444
250236
.. _#1441: https://github.com/pytest-dev/pytest/pull/1441
237+
.. _#1444: https://github.com/pytest-dev/pytest/pull/1444
251238
.. _#1454: https://github.com/pytest-dev/pytest/pull/1454
252-
.. _#1351: https://github.com/pytest-dev/pytest/issues/1351
253239
.. _#1461: https://github.com/pytest-dev/pytest/pull/1461
254240
.. _#1468: https://github.com/pytest-dev/pytest/pull/1468
255241
.. _#1474: https://github.com/pytest-dev/pytest/pull/1474
242+
.. _#1479: https://github.com/pytest-dev/pytest/issues/1479
256243
.. _#1502: https://github.com/pytest-dev/pytest/pull/1502
244+
.. _#1503: https://github.com/pytest-dev/pytest/issues/1503
245+
.. _#1519: https://github.com/pytest-dev/pytest/pull/1519
257246
.. _#1520: https://github.com/pytest-dev/pytest/pull/1520
258-
.. _#1619: https://github.com/pytest-dev/pytest/issues/1619
259-
.. _#372: https://github.com/pytest-dev/pytest/issues/372
247+
.. _#1526: https://github.com/pytest-dev/pytest/pull/1526
260248
.. _#1544: https://github.com/pytest-dev/pytest/issues/1544
249+
.. _#1553: https://github.com/pytest-dev/pytest/issues/1553
261250
.. _#1562: https://github.com/pytest-dev/pytest/issues/1562
251+
.. _#1580: https://github.com/pytest-dev/pytest/pull/1580
252+
.. _#1597: https://github.com/pytest-dev/pytest/pull/1597
253+
.. _#1605: https://github.com/pytest-dev/pytest/issues/1605
262254
.. _#1616: https://github.com/pytest-dev/pytest/pull/1616
255+
.. _#1618: https://github.com/pytest-dev/pytest/issues/1618
256+
.. _#1619: https://github.com/pytest-dev/pytest/issues/1619
257+
.. _#1626: https://github.com/pytest-dev/pytest/pull/1626
258+
.. _#1627: https://github.com/pytest-dev/pytest/pull/1627
263259
.. _#1628: https://github.com/pytest-dev/pytest/pull/1628
264260
.. _#1629: https://github.com/pytest-dev/pytest/issues/1629
261+
.. _#1632: https://github.com/pytest-dev/pytest/issues/1632
265262
.. _#1633: https://github.com/pytest-dev/pytest/pull/1633
266-
.. _#1618: https://github.com/pytest-dev/pytest/issues/1618
267-
268-
269-
**Bug Fixes**
263+
.. _#1664: https://github.com/pytest-dev/pytest/pull/1664
270264

271-
* When receiving identical test ids in parametrize we generate unique test ids.
265+
.. _@DRMacIver: https://github.com/DRMacIver
266+
.. _@RedBeardCode: https://github.com/RedBeardCode
267+
.. _@Vogtinator: https://github.com/Vogtinator
268+
.. _@bagerard: https://github.com/bagerard
269+
.. _@blueyed: https://github.com/blueyed
270+
.. _@ceridwen: https://github.com/ceridwen
271+
.. _@csaftoiu: https://github.com/csaftoiu
272+
.. _@d6e: https://github.com/d6e
273+
.. _@davehunt: https://github.com/davehunt
274+
.. _@fengxx: https://github.com/fengxx
275+
.. _@flub: https://github.com/flub
276+
.. _@graingert: https://github.com/graingert
277+
.. _@kalekundert: https://github.com/kalekundert
278+
.. _@kvas-it: https://github.com/kvas-it
279+
.. _@marscher: https://github.com/marscher
280+
.. _@mikofski: https://github.com/mikofski
281+
.. _@milliams: https://github.com/milliams
282+
.. _@nikratio: https://github.com/nikratio
283+
.. _@novas0x2a: https://github.com/novas0x2a
284+
.. _@obestwalter: https://github.com/obestwalter
285+
.. _@olegpidsadnyi: https://github.com/olegpidsadnyi
286+
.. _@omarkohl: https://github.com/omarkohl
287+
.. _@palaviv: https://github.com/palaviv
288+
.. _@sallner: https://github.com/sallner
289+
.. _@sober7: https://github.com/sober7
290+
.. _@tareqalayan: https://github.com/tareqalayan
291+
.. _@taschini: https://github.com/taschini
272292

273293
2.9.2
274294
=====

0 commit comments

Comments
 (0)