blob: 9d63540e630991466652ef3f0a6daa3ca93975d0 [file] [log] [blame]
Ned Deily4829bc62016-09-12 17:29:04 -04001****************************
2 What's New In Python 3.7
3****************************
4
5:Release: |release|
6:Date: |today|
7
8.. Rules for maintenance:
9
10 * Anyone can add text to this document. Do not spend very much time
11 on the wording of your changes, because your text will probably
12 get rewritten to some degree.
13
14 * The maintainer will go through Misc/NEWS periodically and add
15 changes; it's therefore more important to add your changes to
16 Misc/NEWS than to this file.
17
18 * This is not a complete list of every single change; completeness
19 is the purpose of Misc/NEWS. Some changes I consider too small
20 or esoteric to include. If such a change is added to the text,
21 I'll just remove it. (This is another reason you shouldn't spend
22 too much time on writing your addition.)
23
24 * If you want to draw your new text to the attention of the
25 maintainer, add 'XXX' to the beginning of the paragraph or
26 section.
27
28 * It's OK to just add a fragmentary note about a change. For
29 example: "XXX Describe the transmogrify() function added to the
30 socket module." The maintainer will research the change and
31 write the necessary text.
32
33 * You can comment out your additions if you like, but it's not
34 necessary (especially when a final release is some months away).
35
36 * Credit the author of a patch or bugfix. Just the name is
37 sufficient; the e-mail address isn't necessary.
38
39 * It's helpful to add the bug/patch number as a comment:
40
41 XXX Describe the transmogrify() function added to the socket
42 module.
43 (Contributed by P.Y. Developer in :issue:`12345`.)
44
45 This saves the maintainer the effort of going through the Mercurial log
46 when researching a change.
47
48This article explains the new features in Python 3.7, compared to 3.6.
49
Steve Dower3e7d93d2016-09-22 17:11:53 -070050For full details, see the :ref:`changelog <changelog>`.
Ned Deily4829bc62016-09-12 17:29:04 -040051
52.. note::
53
54 Prerelease users should be aware that this document is currently in draft
55 form. It will be updated substantially as Python 3.7 moves towards release,
56 so it's worth checking back even after reading earlier versions.
57
58
59Summary -- Release highlights
60=============================
61
62.. This section singles out the most important changes in Python 3.7.
63 Brevity is key.
64
65
66.. PEP-sized items next.
67
68
69
70New Features
71============
72
Nick Coghlan6ea41862017-06-11 13:16:15 +100073.. _whatsnew37-pep538:
74
75PEP 538: Legacy C Locale Coercion
76---------------------------------
77
78An ongoing challenge within the Python 3 series has been determining a sensible
79default strategy for handling the "7-bit ASCII" text encoding assumption
80currently implied by the use of the default C locale on non-Windows platforms.
81
82:pep:`538` updates the default interpreter command line interface to
83automatically coerce that locale to an available UTF-8 based locale as
84described in the documentation of the new :envvar:`PYTHONCOERCECLOCALE`
85environment variable. Automatically setting ``LC_CTYPE`` this way means that
86both the core interpreter and locale-aware C extensions (such as
87:mod:`readline`) will assume the use of UTF-8 as the default text encoding,
88rather than ASCII.
89
90The platform support definition in :pep:`11` has also been updated to limit
91full text handling support to suitably configured non-ASCII based locales.
92
93As part of this change, the default error handler for ``stdin`` and ``stdout``
94is now ``surrogateescape`` (rather than ``strict``) when using any of the
95defined coercion target locales (currently ``C.UTF-8``, ``C.utf8``, and
96``UTF-8``). The default error handler for ``stderr`` continues to be
97``backslashreplace``, regardless of locale.
98
Nick Coghlaneb817952017-06-18 12:29:42 +100099Locale coercion is silent by default, but to assist in debugging potentially
100locale related integration problems, explicit warnings (emitted directly on
101``stderr`` can be requested by setting ``PYTHONCOERCECLOCALE=warn``. This
102setting will also cause the Python runtime to emit a warning if the legacy C
103locale remains active when the core interpreter is initialized.
Nick Coghlan6ea41862017-06-11 13:16:15 +1000104
105.. seealso::
106
107 :pep:`538` -- Coercing the legacy C locale to a UTF-8 based locale
108 PEP written and implemented by Nick Coghlan.
Ned Deily4829bc62016-09-12 17:29:04 -0400109
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400110.. _whatsnew37-pep553:
111
112PEP 553: Built-in breakpoint()
113------------------------------
114
115:pep:`553` describes a new built-in called ``breakpoint()`` which makes it
116easy and consistent to enter the Python debugger. Built-in ``breakpoint()``
117calls ``sys.breakpointhook()``. By default, this latter imports ``pdb`` and
118then calls ``pdb.set_trace()``, but by binding ``sys.breakpointhook()`` to the
119function of your choosing, ``breakpoint()`` can enter any debugger. Or, the
120environment variable :envvar:`PYTHONBREAKPOINT` can be set to the callable of
121your debugger of choice. Set ``PYTHONBREAKPOINT=0`` to completely disable
122built-in ``breakpoint()``.
123
124.. seealso::
125
126 :pep:`553` -- Built-in breakpoint()
127 PEP written and implemented by Barry Warsaw
128
Ned Deily4829bc62016-09-12 17:29:04 -0400129
Masayuki Yamamoto731e1892017-10-06 19:41:34 +0900130.. _whatsnew37-pep539:
131
132PEP 539: A New C-API for Thread-Local Storage in CPython
133--------------------------------------------------------
134
135While Python provides a C API for thread-local storage support; the existing
136:ref:`Thread Local Storage (TLS) API <thread-local-storage-api>` has used
137:c:type:`int` to represent TLS keys across all platforms. This has not
138generally been a problem for officially-support platforms, but that is neither
139POSIX-compliant, nor portable in any practical sense.
140
141:pep:`539` changes this by providing a new :ref:`Thread Specific Storage (TSS)
142API <thread-specific-storage-api>` to CPython which supersedes use of the
143existing TLS API within the CPython interpreter, while deprecating the existing
144API. The TSS API uses a new type :c:type:`Py_tss_t` instead of :c:type:`int`
145to represent TSS keys--an opaque type the definition of which may depend on
146the underlying TLS implementation. Therefore, this will allow to build CPython
147on platforms where the native TLS key is defined in a way that cannot be safely
148cast to :c:type:`int`.
149
150Note that on platforms where the native TLS key is defined in a way that cannot
151be safely cast to :c:type:`int`, all functions of the existing TLS API will be
152no-op and immediately return failure. This indicates clearly that the old API
153is not supported on platforms where it cannot be used reliably, and that no
154effort will be made to add such support.
155
156.. seealso::
157
158 :pep:`539` -- A New C-API for Thread-Local Storage in CPython
159 PEP written by Erik M. Bray; implementation by Masayuki Yamamoto.
160
161
Victor Stinnerc29b5852017-11-02 07:28:27 -0700162PEP 564: Add new time functions with nanosecond resolution
163----------------------------------------------------------
164
165Add six new "nanosecond" variants of existing functions to the :mod:`time`
166module:
167
168* :func:`time.clock_gettime_ns`
169* :func:`time.clock_settime_ns`
170* :func:`time.monotonic_ns`
171* :func:`time.perf_counter_ns`
172* :func:`time.process_time_ns`
173* :func:`time.time_ns`
174
175While similar to the existing functions without the ``_ns`` suffix, they
176provide nanosecond resolution: they return a number of nanoseconds as a Python
177``int``.
178
179The ``time.time_ns()`` resolution is 3 times better than the ``time.time()``
180resolution on Linux and Windows.
181
182.. seealso::
183
184 :pep:`564` -- Add new time functions with nanosecond resolution
185 PEP written and implemented by Victor Stinner
186
187
Ned Deily4829bc62016-09-12 17:29:04 -0400188Other Language Changes
189======================
190
Serhiy Storchaka5bb8b912016-12-16 19:19:02 +0200191* More than 255 arguments can now be passed to a function, and a function can
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800192 now have more than 255 parameters. (Contributed by Serhiy Storchaka in
193 :issue:`12844` and :issue:`18896`.)
Ned Deily4829bc62016-09-12 17:29:04 -0400194
Serhiy Storchakadd1da7f2016-12-19 18:51:37 +0200195* :meth:`bytes.fromhex` and :meth:`bytearray.fromhex` now ignore all ASCII
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800196 whitespace, not only spaces. (Contributed by Robert Xiao in :issue:`28927`.)
Serhiy Storchakadd1da7f2016-12-19 18:51:37 +0200197
Matthias Bussonnier1bc15642017-02-22 07:06:50 -0800198* :exc:`ImportError` now displays module name and module ``__file__`` path when
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800199 ``from ... import ...`` fails. (Contributed by Matthias Bussonnier in :issue:`29546`.)
Matthias Bussonnier1bc15642017-02-22 07:06:50 -0800200
Serhiy Storchakaf93234b2017-05-09 22:31:05 +0300201* Circular imports involving absolute imports with binding a submodule to
202 a name are now supported.
203 (Contributed by Serhiy Storchaka in :issue:`30024`.)
204
Serhiy Storchaka7e19dbc2017-05-13 12:40:52 +0300205* ``object.__format__(x, '')`` is now equivalent to ``str(x)`` rather than
206 ``format(str(self), '')``.
207 (Contributed by Serhiy Storchaka in :issue:`28974`.)
208
Ned Deily4829bc62016-09-12 17:29:04 -0400209
210New Modules
211===========
212
213* None yet.
214
215
216Improved Modules
217================
218
Pierre Quentelcc3fa202017-05-08 14:08:34 +0200219
R. David Murray0f6b9d22017-09-06 20:25:40 -0400220argparse
221--------
222
223The :meth:`~argparse.ArgumentParser.parse_intermixed_args` supports letting
224the user intermix options and positional arguments on the command line,
225as is possible in many unix commands. It supports most but not all
226argparse features. (Contributed by paul.j3 in :issue:`14191`.)
227
228
Xiang Zhang13f1f422017-05-03 11:16:21 +0800229binascii
230--------
231
232The :func:`~binascii.b2a_uu` function now accepts an optional *backtick*
233keyword argument. When it's true, zeros are represented by ``'`'``
234instead of spaces. (Contributed by Xiang Zhang in :issue:`30103`.)
235
Oz N Tiram8b7a4cc2017-06-06 11:35:59 +0200236
237calendar
238--------
239
Walter Dörwaldf5c58c72017-06-26 18:31:52 +0200240The class :class:`~calendar.HTMLCalendar` has new class attributes which ease
241the customisation of the CSS classes in the produced HTML calendar.
Oz N Tiram8b7a4cc2017-06-06 11:35:59 +0200242(Contributed by Oz Tiram in :issue:`30095`.)
243
244cgi
245---
246
247:func:`~cgi.parse_multipart` returns the same results as
248:class:`~FieldStorage` : for non-file fields, the value associated to a key
249is a list of strings, not bytes.
250(Contributed by Pierre Quentel in :issue:`29979`.)
251
Jelle Zijlstra2e624692017-04-30 18:25:58 -0700252contextlib
253----------
254
255:func:`contextlib.asynccontextmanager` has been added. (Contributed by
256Jelle Zijlstra in :issue:`29679`.)
257
Sanyam Khurana7973e272017-11-08 16:20:56 +0530258cProfile
259--------
260
261cProfile command line now accepts `-m module_name` as an alternative to
262script path. (Contributed by Sanyam Khurana in :issue:`21862`.)
263
Serhiy Storchakaeab3ff72017-10-24 19:36:17 +0300264crypt
265-----
266
267Added support for the Blowfish method.
268(Contributed by Serhiy Storchaka in :issue:`31664`.)
269
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300270dis
271---
272
273The :func:`~dis.dis` function now is able to
274disassemble nested code objects (the code of comprehensions, generator
275expressions and nested functions, and the code used for building nested
276classes). (Contributed by Serhiy Storchaka in :issue:`11822`.)
277
Ryan Gonzalezf9f87f02017-04-14 04:00:25 -0500278distutils
279---------
280
281README.rst is now included in the list of distutils standard READMEs and
282therefore included in source distributions.
283(Contributed by Ryan Gonzalez in :issue:`11913`.)
284
Nir Sofferad455cd2017-11-06 23:16:37 +0200285http.client
286-----------
287
288Add Configurable *blocksize* to ``HTTPConnection`` and
289``HTTPSConnection`` for improved upload throughput.
290(Contributed by Nir Soffer in :issue:`31945`.)
291
Pierre Quentel351adda2017-04-02 12:26:12 +0200292http.server
293-----------
294
295:class:`~http.server.SimpleHTTPRequestHandler` supports the HTTP
296If-Modified-Since header. The server returns the 304 response status if the
297target file was not modified after the time specified in the header.
298(Contributed by Pierre Quentel in :issue:`29654`.)
299
Stéphane Wirtela17a2f52017-05-24 09:29:06 +0200300Add the parameter ``directory`` to the :class:`~http.server.SimpleHTTPRequestHandler`
301and the ``--directory`` to the command line of the module :mod:`~http.server`.
302With this parameter, the server serves the specified directory, by default it uses the current working directory.
303(Contributed by Stéphane Wirtel and Julien Palard in :issue:`28707`.)
304
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800305locale
306------
307
308Added another argument *monetary* in :meth:`format_string` of :mod:`locale`.
309If *monetary* is true, the conversion uses monetary thousands separator and
310grouping strings. (Contributed by Garvit in :issue:`10379`.)
311
Mark Dickinsona0ce3752017-04-05 18:34:27 +0100312math
313----
314
315New :func:`~math.remainder` function, implementing the IEEE 754-style remainder
316operation. (Contributed by Mark Dickinson in :issue:`29962`.)
317
Serhiy Storchaka8f6b3442017-03-07 14:33:21 +0200318os
319--
320
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800321Added support for :class:`bytes` paths in :func:`~os.fwalk`. (Contributed by
322Serhiy Storchaka in :issue:`28682`.)
Serhiy Storchaka8f6b3442017-03-07 14:33:21 +0200323
Serhiy Storchakaea720fe2017-03-30 09:12:31 +0300324Added support for :ref:`file descriptors <path_fd>` in :func:`~os.scandir`
325on Unix. (Contributed by Serhiy Storchaka in :issue:`25996`.)
326
Antoine Pitrouf7ecfac2017-05-28 11:35:14 +0200327New function :func:`os.register_at_fork` allows registering Python callbacks
328to be executed on a process fork. (Contributed by Antoine Pitrou in
329:issue:`16500`.)
330
Barry Warsaw35425d62017-09-22 12:29:42 -0400331pdb
332---
333
Berker Peksag12d60562017-11-04 15:17:56 +0300334:func:`~pdb.set_trace` now takes an optional *header* keyword-only
Barry Warsaw35425d62017-09-22 12:29:42 -0400335argument. If given, this is printed to the console just before debugging
Berker Peksag12d60562017-11-04 15:17:56 +0300336begins. (Contributed by Barry Warsaw in :issue:`31389`.)
Barry Warsaw35425d62017-09-22 12:29:42 -0400337
Serhiy Storchaka3557b052017-10-24 23:31:42 +0300338re
339--
340
341The flags :const:`re.ASCII`, :const:`re.LOCALE` and :const:`re.UNICODE`
342can be set within the scope of a group.
343(Contributed by Serhiy Storchaka in :issue:`31690`.)
344
Barry Warsaw973b9012017-09-04 17:29:27 -0400345string
346------
347
348:class:`string.Template` now lets you to optionally modify the regular
349expression pattern for braced placeholders and non-braced placeholders
350separately. (Contributed by Barry Warsaw in :issue:`1198569`.)
351
Victor Stinnera64ce972017-11-02 04:19:19 -0700352time
353----
354
Victor Stinnerc29b5852017-11-02 07:28:27 -0700355The :pep:`564` added six new functions with nanosecond resolution:
356
357* :func:`time.clock_gettime_ns`
358* :func:`time.clock_settime_ns`
359* :func:`time.monotonic_ns`
360* :func:`time.perf_counter_ns`
361* :func:`time.process_time_ns`
362* :func:`time.time_ns`
363
Victor Stinnera64ce972017-11-02 04:19:19 -0700364Add new clock identifiers:
365
366* :data:`time.CLOCK_BOOTTIME` (Linux): Identical to
367 :data:`time.CLOCK_MONOTONIC`, except it also includes any time that the
368 system is suspended.
369* :data:`time.CLOCK_PROF` (FreeBSD, NetBSD and OpenBSD): High-resolution
370 per-process timer from the CPU.
371* :data:`time.CLOCK_UPTIME` (FreeBSD, OpenBSD): Time whose absolute value is
372 the time the system has been running and not suspended, providing accurate
373 uptime measurement, both absolute and interval.
374
Antoine Pitrou4bd41c92017-11-15 22:52:21 +0100375Added functions :func:`time.thread_time` and :func:`time.thread_time_ns`
376to get per-thread CPU time measurements.
377(Contributed by Antoine Pitrou in :issue:`32025`.)
378
Serhiy Storchakad9c956f2017-01-11 20:13:03 +0200379unittest.mock
380-------------
381
382The :const:`~unittest.mock.sentinel` attributes now preserve their identity
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800383when they are :mod:`copied <copy>` or :mod:`pickled <pickle>`. (Contributed by
384Serhiy Storchaka in :issue:`20804`.)
Serhiy Storchakad9c956f2017-01-11 20:13:03 +0200385
Mario Corchero552be9d2017-10-17 12:35:11 +0100386New function :const:`~unittest.mock.seal` will disable the creation of mock
387children by preventing to get or set any new attribute on the sealed mock.
388The sealing process is performed recursively. (Contributed by Mario Corchero
389in :issue:`30541`.)
390
Xiang Zhang267b9d22017-02-28 17:12:52 +0800391xmlrpc.server
392-------------
393
394:meth:`register_function` of :class:`xmlrpc.server.SimpleXMLRPCDispatcher` and
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800395its subclasses can be used as a decorator. (Contributed by Xiang Zhang in
396:issue:`7769`.)
Xiang Zhang267b9d22017-02-28 17:12:52 +0800397
Benjamin Peterson279a9622017-06-22 22:31:08 -0700398unicodedata
399-----------
400
401The internal :mod:`unicodedata` database has been upgraded to use `Unicode 10
402<http://www.unicode.org/versions/Unicode10.0.0/>`_. (Contributed by Benjamin
403Peterson.)
404
Ratnadeep Debnath21024f02017-02-25 14:30:28 +0530405urllib.parse
406------------
407
Daniel Himmelsteindadca482017-08-10 21:45:12 -0400408:func:`urllib.parse.quote` has been updated from RFC 2396 to RFC 3986,
Ratnadeep Debnath21024f02017-02-25 14:30:28 +0530409adding `~` to the set of characters that is never quoted by default.
410(Contributed by Christian Theune and Ratnadeep Debnath in :issue:`16285`.)
411
Xiang Zhang13f1f422017-05-03 11:16:21 +0800412uu
413--
414
415Function :func:`~uu.encode` now accepts an optional *backtick*
416keyword argument. When it's true, zeros are represented by ``'`'``
417instead of spaces. (Contributed by Xiang Zhang in :issue:`30103`.)
418
scoder101a5e82017-09-30 15:35:21 +0200419xml.etree
420---------
421
422:ref:`ElementPath <elementtree-xpath>` predicates in the :meth:`find`
423methods can now compare text of the current node with ``[. = "text"]``,
424not only text in children. Predicates also allow adding spaces for
425better readability. (Contributed by Stefan Behnel in :issue:`31648`.)
426
Paul Moore0780bf72017-08-26 18:04:12 +0100427zipapp
428------
429
430Function :func:`zipapp.create_archive` now accepts an optional *filter*
Zhiming Wangd87b1052017-09-29 13:31:52 -0400431argument to allow the user to select which files should be included in the
432archive, and an optional *compressed* argument to generate a compressed
Paul Moore0780bf72017-08-26 18:04:12 +0100433archive.
434
Zhiming Wangd87b1052017-09-29 13:31:52 -0400435A command line option ``--compress`` has also been added to support
436compression.
437
Ned Deily4829bc62016-09-12 17:29:04 -0400438
439Optimizations
440=============
441
Yury Selivanovf2392132016-12-13 19:03:51 -0500442* Added two new opcodes: ``LOAD_METHOD`` and ``CALL_METHOD`` to avoid
443 instantiation of bound method objects for method calls, which results
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800444 in method calls being faster up to 20%. (Contributed by Yury Selivanov and
445 INADA Naoki in :issue:`26110`.)
Yury Selivanovf2392132016-12-13 19:03:51 -0500446
Serhiy Storchaka0a58f722017-03-30 09:11:10 +0300447* Searching some unlucky Unicode characters (like Ukrainian capital "Є")
Cody Scott72fa3012017-11-09 13:58:59 -0500448 in a string was up to 25 times slower than searching other characters.
449 Now it is slower only by 3 times in the worst case.
Serhiy Storchaka0a58f722017-03-30 09:11:10 +0300450 (Contributed by Serhiy Storchaka in :issue:`24821`.)
451
Serhiy Storchaka97553fd2017-03-11 23:37:16 +0200452* Fast implementation from standard C library is now used for functions
Paul Romano992f6132017-09-15 12:00:57 -0500453 :func:`~math.erf` and :func:`~math.erfc` in the :mod:`math` module.
454 (Contributed by Serhiy Storchaka in :issue:`26121`.)
Serhiy Storchaka97553fd2017-03-11 23:37:16 +0200455
Serhiy Storchakaea720fe2017-03-30 09:12:31 +0300456* The :func:`os.fwalk` function has been sped up by 2 times. This was done
457 using the :func:`os.scandir` function.
458 (Contributed by Serhiy Storchaka in :issue:`25996`.)
459
Serhiy Storchakad4d79bc2017-11-04 14:16:35 +0200460* The :func:`shutil.rmtree` function has been sped up to 20--40%.
461 This was done using the :func:`os.scandir` function.
462 (Contributed by Serhiy Storchaka in :issue:`28564`.)
463
Serhiy Storchaka6d336a02017-05-09 23:37:14 +0300464* Optimized case-insensitive matching and searching of :mod:`regular
465 expressions <re>`. Searching some patterns can now be up to 20 times faster.
466 (Contributed by Serhiy Storchaka in :issue:`30285`.)
467
INADA Naokic1c47c12017-10-05 17:19:26 +0900468* :func:`re.compile` now converts ``flags`` parameter to int object if
469 it is ``RegexFlag``. It is now as fast as Python 3.5, and faster than
Cody Scott72fa3012017-11-09 13:58:59 -0500470 Python 3.6 by about 10% depending on the pattern.
INADA Naokic1c47c12017-10-05 17:19:26 +0900471 (Contributed by INADA Naoki in :issue:`31671`.)
472
Giampaolo Rodolafbfaa6f2017-06-09 22:20:41 +0200473* :meth:`selectors.EpollSelector.modify`, :meth:`selectors.PollSelector.modify`
474 and :meth:`selectors.DevpollSelector.modify` may be around 10% faster under
475 heavy loads. (Contributed by Giampaolo Rodola' in :issue:`30014`)
Ned Deily4829bc62016-09-12 17:29:04 -0400476
477Build and C API Changes
478=======================
479
Zachary Waref40d4dd2016-09-17 01:25:24 -0500480* A full copy of libffi is no longer bundled for use when building the
481 :mod:`_ctypes <ctypes>` module on non-OSX UNIX platforms. An installed copy
482 of libffi is now required when building ``_ctypes`` on such platforms.
483 Contributed by Zachary Ware in :issue:`27979`.
Ned Deily4829bc62016-09-12 17:29:04 -0400484
Serhiy Storchaka007d7ff2016-11-22 07:58:08 +0200485* The fields :c:member:`name` and :c:member:`doc` of structures
486 :c:type:`PyMemberDef`, :c:type:`PyGetSetDef`,
487 :c:type:`PyStructSequence_Field`, :c:type:`PyStructSequence_Desc`,
488 and :c:type:`wrapperbase` are now of type ``const char *`` rather of
489 ``char *``. (Contributed by Serhiy Storchaka in :issue:`28761`.)
490
Serhiy Storchaka2a404b62017-01-22 23:07:07 +0200491* The result of :c:func:`PyUnicode_AsUTF8AndSize` and :c:func:`PyUnicode_AsUTF8`
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800492 is now of type ``const char *`` rather of ``char *``. (Contributed by Serhiy
493 Storchaka in :issue:`28769`.)
Serhiy Storchaka2a404b62017-01-22 23:07:07 +0200494
Oren Milman0ccc0f62017-10-08 11:17:46 +0300495* The result of :c:func:`PyMapping_Keys`, :c:func:`PyMapping_Values` and
496 :c:func:`PyMapping_Items` is now always a list, rather than a list or a
497 tuple. (Contributed by Oren Milman in :issue:`28280`.)
498
Serhiy Storchaka6e08baf2017-01-25 13:27:44 +0200499* Added functions :c:func:`PySlice_Unpack` and :c:func:`PySlice_AdjustIndices`.
500 (Contributed by Serhiy Storchaka in :issue:`27867`.)
501
Antoine Pitrouf7ecfac2017-05-28 11:35:14 +0200502* :c:func:`PyOS_AfterFork` is deprecated in favour of the new functions
503 :c:func:`PyOS_BeforeFork`, :c:func:`PyOS_AfterFork_Parent` and
504 :c:func:`PyOS_AfterFork_Child`. (Contributed by Antoine Pitrou in
505 :issue:`16500`.)
506
Zachary Warecb8c0482017-06-15 22:34:59 -0500507* The Windows build process no longer depends on Subversion to pull in external
508 sources, a Python script is used to download zipfiles from GitHub instead.
509 If Python 3.6 is not found on the system (via ``py -3.6``), NuGet is used to
510 download a copy of 32-bit Python for this purpose. (Contributed by Zachary
511 Ware in :issue:`30450`.)
512
xdegaye56d1f5c2017-10-26 15:09:06 +0200513* The ``PyExc_RecursionErrorInst`` singleton that was part of the public API
514 has been removed as its members being never cleared may cause a segfault
515 during finalization of the interpreter. Contributed by Xavier de Gaye in
516 :issue:`22898` and :issue:`30697`.
517
Antoine Pitroua6a4dc82017-09-07 18:56:24 +0200518* Support for building ``--without-threads`` is removed.
519 (Contributed by Antoine Pitrou in :issue:`31370`.).
520
Ned Deily4829bc62016-09-12 17:29:04 -0400521
Nick Coghlan5a851672017-09-08 10:14:16 +1000522Other CPython Implementation Changes
523====================================
524
525* Trace hooks may now opt out of receiving ``line`` events from the interpreter
526 by setting the new ``f_trace_lines`` attribute to :const:`False` on the frame
527 being traced. (Contributed by Nick Coghlan in :issue:`31344`.)
528
529* Trace hooks may now opt in to receiving ``opcode`` events from the interpreter
530 by setting the new ``f_trace_opcodes`` attribute to :const:`True` on the frame
531 being traced. (Contributed by Nick Coghlan in :issue:`31344`.)
532
533
Ned Deily4829bc62016-09-12 17:29:04 -0400534Deprecated
535==========
536
Serhiy Storchaka6e08baf2017-01-25 13:27:44 +0200537- Function :c:func:`PySlice_GetIndicesEx` is deprecated and replaced with
538 a macro if ``Py_LIMITED_API`` is not set or set to the value between
539 ``0x03050400`` and ``0x03060000`` (not including) or ``0x03060100`` or
540 higher. (Contributed by Serhiy Storchaka in :issue:`27867`.)
Ned Deily4829bc62016-09-12 17:29:04 -0400541
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800542- Deprecated :meth:`format` from :mod:`locale`, use the :meth:`format_string`
543 instead. (Contributed by Garvit in :issue:`10379`.)
544
Matthias Bussonnier1d4601c2017-02-15 18:00:32 -0800545- Methods
546 :meth:`MetaPathFinder.find_module() <importlib.abc.MetaPathFinder.find_module>`
547 (replaced by
548 :meth:`MetaPathFinder.find_spec() <importlib.abc.MetaPathFinder.find_spec>`
549 ) and
550 :meth:`PathEntryFinder.find_loader() <importlib.abc.PathEntryFinder.find_loader>`
551 (replaced by
552 :meth:`PathEntryFinder.find_spec() <importlib.abc.PathEntryFinder.find_spec>`)
553 both deprecated in Python 3.4 now emit :exc:`DeprecationWarning`. (Contributed
554 by Matthias Bussonnier in :issue:`29576`)
555
Serhiy Storchakaf6595982017-03-12 13:15:01 +0200556- Using non-integer value for selecting a plural form in :mod:`gettext` is
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800557 now deprecated. It never correctly worked. (Contributed by Serhiy Storchaka
558 in :issue:`28692`.)
Serhiy Storchakaf6595982017-03-12 13:15:01 +0200559
Victor Stinner89a1c932017-05-15 11:01:21 +0200560- The :mod:`macpath` is now deprecated and will be removed in Python 3.8.
561
Ned Deily4829bc62016-09-12 17:29:04 -0400562
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200563Changes in the C API
564--------------------
565
566- The type of results of :c:func:`PyThread_start_new_thread` and
567 :c:func:`PyThread_get_thread_ident`, and the *id* parameter of
568 :c:func:`PyThreadState_SetAsyncExc` changed from :c:type:`long` to
569 :c:type:`unsigned long`.
570 (Contributed by Serhiy Storchaka in :issue:`6532`.)
571
Serhiy Storchakae613e6a2017-06-27 16:03:14 +0300572- :c:func:`PyUnicode_AsWideCharString` now raises a :exc:`ValueError` if the
573 second argument is *NULL* and the :c:type:`wchar_t*` string contains null
574 characters. (Contributed by Serhiy Storchaka in :issue:`30708`.)
575
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200576
Steve (Gadget) Barnes5b8f9722017-06-28 20:14:52 +0100577Windows Only
578------------
579- The python launcher, (py.exe), can accept 32 & 64 bit specifiers **without**
580 having to specify a minor version as well. So ``py -3-32`` and ``py -3-64``
581 become valid as well as ``py -3.7-32``, also the -*m*-64 and -*m.n*-64 forms
582 are now accepted to force 64 bit python even if 32 bit would have otherwise
583 been used. If the specified version is not available py.exe will error exit.
584 (Contributed by Steve Barnes in :issue:`30291`.)
585
586- The launcher can be run as "py -0" to produce a list of the installed pythons,
587 *with default marked with an asterix*. Running "py -0p" will include the paths.
588 If py is run with a version specifier that cannot be matched it will also print
589 the *short form* list of available specifiers.
590 (Contributed by Steve Barnes in :issue:`30362`.)
591
Ned Deily4829bc62016-09-12 17:29:04 -0400592Removed
593=======
594
Serhiy Storchakaff3dbe92016-12-06 19:25:19 +0200595API and Feature Removals
596------------------------
597
Victor Stinner01b5aab2017-10-24 02:02:00 -0700598* The ``os.stat_float_times()`` function has been removed. It was introduced in
599 Python 2.3 for backward compatibility with Python 2.2, and was deprecated
600 since Python 3.1.
601
Serhiy Storchakaff3dbe92016-12-06 19:25:19 +0200602* Unknown escapes consisting of ``'\'`` and an ASCII letter in replacement
Serhiy Storchakab2d61792017-01-13 21:14:40 +0200603 templates for :func:`re.sub` were deprecated in Python 3.5, and will now
604 cause an error.
Ned Deily4829bc62016-09-12 17:29:04 -0400605
Serhiy Storchaka4f76fb12017-01-13 13:25:24 +0200606* Removed support of the *exclude* argument in :meth:`tarfile.TarFile.add`.
Serhiy Storchakab2d61792017-01-13 21:14:40 +0200607 It was deprecated in Python 2.7 and 3.2. Use the *filter* argument instead.
Serhiy Storchaka4f76fb12017-01-13 13:25:24 +0200608
Serhiy Storchaka9ed707e2017-01-13 20:55:05 +0200609* The ``splitunc()`` function in the :mod:`ntpath` module was deprecated in
610 Python 3.1, and has now been removed. Use the :func:`~os.path.splitdrive`
611 function instead.
612
Raymond Hettinger8b57d732017-09-10 10:23:36 -0700613* :func:`collections.namedtuple` no longer supports the *verbose* parameter
614 or ``_source`` attribute which showed the generated source code for the
615 named tuple class. This was part of an optimization designed to speed-up
616 class creation. (Contributed by Jelle Zijlstra with further improvements
617 by INADA Naoki, Serhiy Storchaka, and Raymond Hettinger in :issue:`28638`.)
618
Serhiy Storchaka2e564242017-03-06 17:01:06 +0200619* Functions :func:`bool`, :func:`float`, :func:`list` and :func:`tuple` no
620 longer take keyword arguments. The first argument of :func:`int` can now
Daniel Porteous77f68e32017-06-21 10:21:48 +1000621 be passed only as positional argument.
Serhiy Storchaka2e564242017-03-06 17:01:06 +0200622
Serhiy Storchakaedef3582017-05-15 13:21:31 +0300623* Removed previously deprecated in Python 2.4 classes ``Plist``, ``Dict`` and
624 ``_InternalDict`` in the :mod:`plistlib` module. Dict values in the result
625 of functions :func:`~plistlib.readPlist` and
626 :func:`~plistlib.readPlistFromBytes` are now normal dicts. You no longer
627 can use attribute access to access items of these dictionaries.
628
Ned Deily4829bc62016-09-12 17:29:04 -0400629
630Porting to Python 3.7
631=====================
632
633This section lists previously described changes and other bugfixes
634that may require changes to your code.
635
636
Serhiy Storchaka9165f772017-11-15 08:49:40 +0200637Changes in Python behavior
638--------------------------
639
640* Due to an oversight, earlier Python versions erroneously accepted the
641 following syntax::
642
643 f(1 for x in [1],)
644
Serhiy Storchakaddbce132017-11-15 17:39:37 +0200645 class C(1 for x in [1]):
646 pass
647
Serhiy Storchaka9165f772017-11-15 08:49:40 +0200648 Python 3.7 now correctly raises a :exc:`SyntaxError`, as a generator
649 expression always needs to be directly inside a set of parentheses
Serhiy Storchakaddbce132017-11-15 17:39:37 +0200650 and cannot have a comma on either side, and the duplication of the
651 parentheses can be omitted only on calls.
652 (Contributed by Serhiy Storchaka in :issue:`32012` and :issue:`32023`.)
Serhiy Storchaka9165f772017-11-15 08:49:40 +0200653
654
Serhiy Storchaka009b0a12017-01-13 09:10:51 +0200655Changes in the Python API
656-------------------------
657
Sanyam Khuranab9c3da52017-06-13 22:41:14 +0530658* :meth:`pkgutil.walk_packages` now raises ValueError if *path* is a string.
659 Previously an empty list was returned. (Contributed by Sanyam Khurana in
660 :issue:`24744`.)
661
Serhiy Storchaka009b0a12017-01-13 09:10:51 +0200662* A format string argument for :meth:`string.Formatter.format`
663 is now :ref:`positional-only <positional-only_parameter>`.
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800664 Passing it as a keyword argument was deprecated in Python 3.5. (Contributed
665 by Serhiy Storchaka in :issue:`29193`.)
Serhiy Storchakacc283372017-01-13 09:23:15 +0200666
667* Attributes :attr:`~http.cookies.Morsel.key`,
668 :attr:`~http.cookies.Morsel.value` and
669 :attr:`~http.cookies.Morsel.coded_value` of class
670 :class:`http.cookies.Morsel` are now read-only.
Serhiy Storchakab2d61792017-01-13 21:14:40 +0200671 Assigning to them was deprecated in Python 3.5.
Serhiy Storchakacc283372017-01-13 09:23:15 +0200672 Use the :meth:`~http.cookies.Morsel.set` method for setting them.
673 (Contributed by Serhiy Storchaka in :issue:`29192`.)
INADA Naoki015bce62017-01-16 17:23:30 +0900674
INADA Naokicb41b272017-02-23 00:31:59 +0900675* ``Module``, ``FunctionDef``, ``AsyncFunctionDef``, and
676 ``ClassDef`` AST nodes now have a new ``docstring`` field.
677 The first statement in their body is not considered as a docstring
678 anymore. ``co_firstlineno`` and ``co_lnotab`` of code object for class
Garvit Khatri1cf93a72017-03-28 23:43:38 +0800679 and module are affected by this change. (Contributed by INADA Naoki and
680 Eugene Toder in :issue:`29463`.)
INADA Naoki015bce62017-01-16 17:23:30 +0900681
Serhiy Storchakae304e332017-03-24 13:27:42 +0200682* The *mode* argument of :func:`os.makedirs` no longer affects the file
683 permission bits of newly-created intermediate-level directories.
684 To set their file permission bits you can set the umask before invoking
685 ``makedirs()``.
686 (Contributed by Serhiy Storchaka in :issue:`19930`.)
687
Victor Stinnerf87b85f2017-06-23 15:11:12 +0200688* The :attr:`struct.Struct.format` type is now :class:`str` instead of
689 :class:`bytes`. (Contributed by Victor Stinner in :issue:`21071`.)
690
Segev Finer9f3bdcb2017-06-28 23:51:00 +0300691* Due to internal changes in :mod:`socket` you won't be able to
692 :func:`socket.fromshare` a socket :func:`~socket.socket.share`-ed in older
693 Python versions.
694
Utkarsh Upadhyay8e453182017-07-28 14:42:56 +0200695* ``repr`` for :class:`datetime.timedelta` has changed to include keyword arguments
696 in the output. (Contributed by Utkarsh Upadhyay in :issue:`30302`.)
697
Serhiy Storchakad4d79bc2017-11-04 14:16:35 +0200698* Because :func:`shutil.rmtree` is now implemented using the :func:`os.scandir`
699 function, the user specified handler *onerror* is now called with the first
700 argument ``os.scandir`` instead of ``os.listdir`` when listing the direcory
701 is failed.
702
Serhiy Storchaka05cb7282017-11-16 12:38:26 +0200703* Support of nested sets and set operations in regular expressions as in
704 `Unicode Technical Standard #18`_ might be added in the future. This would
705 change the syntax, so to facilitate this change a :exc:`FutureWarning` will
706 be raised in ambiguous cases for the time being.
707 That include sets starting with a literal ``'['`` or containing literal
708 character sequences ``'--'``, ``'&&'``, ``'~~'``, and ``'||'``. To
709 avoid a warning escape them with a backslash.
710 (Contributed by Serhiy Storchaka in :issue:`30349`.)
711
712.. _Unicode Technical Standard #18: https://unicode.org/reports/tr18/
713
Serhiy Storchakae304e332017-03-24 13:27:42 +0200714
Serhiy Storchaka4d3f0842017-10-08 12:53:34 +0300715Changes in the C API
716--------------------
717
718* The function :c:func:`PySlice_GetIndicesEx` is considered not safe for
719 resizable sequences. If the slice indices are not instances of :class:`int`,
720 but objects that implement the :meth:`!__index__` method, the sequence can be
721 resized after passing its length to :c:func:`!PySlice_GetIndicesEx`. This
722 can lead to returning indices out of the length of the sequence. For
723 avoiding possible problems use new functions :c:func:`PySlice_Unpack` and
724 :c:func:`PySlice_AdjustIndices`.
725 (Contributed by Serhiy Storchaka in :issue:`27867`.)
726
727
INADA Naoki015bce62017-01-16 17:23:30 +0900728CPython bytecode changes
729------------------------
730
Martin Panter91a88662017-01-24 00:30:06 +0000731* Added two new opcodes: :opcode:`LOAD_METHOD` and :opcode:`CALL_METHOD`.
INADA Naoki015bce62017-01-16 17:23:30 +0900732 (Contributed by Yury Selivanov and INADA Naoki in :issue:`26110`.)
Julien Palard809d1732017-10-24 11:22:22 +0200733
734
Nick Coghlan1b461312017-11-05 14:58:45 +1000735Other CPython implementation changes
736------------------------------------
737
738* In preparation for potential future changes to the public CPython runtime
739 initialization API (see :pep:`432` for details), CPython's internal startup
740 and configuration management logic has been significantly refactored. While
741 these updates are intended to be entirely transparent to both embedding
742 applications and users of the regular CPython CLI, they're being mentioned
743 here as the refactoring changes the internal order of various operations
744 during interpreter startup, and hence may uncover previously latent defects,
745 either in embedding applications, or in CPython itself.
746 (Contributed by Nick Coghlan and Eric Snow as part of :issue:`22257`.)
747
748
Julien Palard809d1732017-10-24 11:22:22 +0200749Documentation
750=============
751
752.. _whatsnew37-pep545:
753
754PEP 545: Python Documentation Translations
755------------------------------------------
756
757:pep:`545` describes the process to translate Python documentation,
758and two translations have been added:
759
Berker Peksag28ab3ce2017-11-08 16:36:58 +0300760- Japanese: https://docs.python.org/ja/ and associated GitHub
Julien Palard809d1732017-10-24 11:22:22 +0200761 repository: https://github.com/python/python-docs-ja
762
Berker Peksag28ab3ce2017-11-08 16:36:58 +0300763- French: https://docs.python.org/fr/ and associated GitHub
Julien Palard809d1732017-10-24 11:22:22 +0200764 repository: https://github.com/python/python-docs-fr
765
766(Contributed by Julien Palard, Inada Naoki, and Victor Stinner in
Berker Peksag28ab3ce2017-11-08 16:36:58 +0300767:issue:`26546`.)