blob: 91ab849a65ac125be17ebb8f73422e8113396927 [file] [log] [blame]
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001****************************
Raymond Hettingerf558ddd2009-06-28 21:37:08 +00002 What's New In Python 3.2
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00003****************************
4
5:Author: Raymond Hettinger
6:Release: |release|
7:Date: |today|
8
9.. $Id$
10 Rules for maintenance:
11
12 * Anyone can add text to this document. Do not spend very much time
13 on the wording of your changes, because your text will probably
14 get rewritten to some degree.
15
16 * The maintainer will go through Misc/NEWS periodically and add
17 changes; it's therefore more important to add your changes to
18 Misc/NEWS than to this file.
19
20 * This is not a complete list of every single change; completeness
21 is the purpose of Misc/NEWS. Some changes I consider too small
22 or esoteric to include. If such a change is added to the text,
23 I'll just remove it. (This is another reason you shouldn't spend
24 too much time on writing your addition.)
25
26 * If you want to draw your new text to the attention of the
27 maintainer, add 'XXX' to the beginning of the paragraph or
28 section.
29
30 * It's OK to just add a fragmentary note about a change. For
31 example: "XXX Describe the transmogrify() function added to the
32 socket module." The maintainer will research the change and
33 write the necessary text.
34
35 * You can comment out your additions if you like, but it's not
36 necessary (especially when a final release is some months away).
37
38 * Credit the author of a patch or bugfix. Just the name is
Georg Brandlda0a2112010-09-05 11:28:33 +000039 sufficient; the e-mail address isn't necessary. It's helpful to
40 add the issue number:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +000041
Éric Araujo4234ad42010-09-05 17:32:25 +000042 XXX Describe the transmogrify() function added to the socket
43 module.
44
45 (Contributed by P.Y. Developer; :issue:`12345`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +000046
47 This saves the maintainer the effort of going through the SVN log
48 when researching a change.
49
50This article explains the new features in Python 3.2, compared to 3.1.
51
52
Éric Araujo4234ad42010-09-05 17:32:25 +000053PEP 391: Dictionary Based Configuration for Logging
54====================================================
Raymond Hettingeref2335c2010-09-05 08:35:38 +000055
Raymond Hettinger92ba2862010-09-06 01:16:46 +000056The :mod:`logging` module provided two kinds of configuration, one style with
57function calls for each option or another style driven by an external file saved
58in a :mod:`ConfigParser` format. Those options did not provide the flexibility
Georg Brandl9e75cad2010-09-06 06:45:47 +000059to create configurations from JSON or YAML files, nor did they support
Raymond Hettinger92ba2862010-09-06 01:16:46 +000060incremental configuration, which is needed for specifying logger options from a
61command line.
Raymond Hettingeref2335c2010-09-05 08:35:38 +000062
63To support a more flexible style, the module now offers
Raymond Hettinger92ba2862010-09-06 01:16:46 +000064:func:`logging.config.dictConfig` for specifying logging configuration with
65plain Python dictionaries. The configuration options include formatters,
66handlers, filters, and loggers. Here's a working example of a configuration
67dictionary::
Raymond Hettingeref2335c2010-09-05 08:35:38 +000068
Georg Brandlda0a2112010-09-05 11:28:33 +000069 {"version": 1,
70 "formatters": {"brief": {"format": "%(levelname)-8s: %(name)-15s: %(message)s"},
71 "full": {"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"},
72 },
73 "handlers": {"console": {
74 "class": "logging.StreamHandler",
75 "formatter": "brief",
76 "level": "INFO",
77 "stream": "ext://sys.stdout"},
78 "console_priority": {
79 "class": "logging.StreamHandler",
80 "formatter": "full",
81 "level": "ERROR",
82 "stream": "ext://sys.stderr"},
83 },
84 "root": {"level": "DEBUG", "handlers": ["console", "console_priority"]}}
Raymond Hettingeref2335c2010-09-05 08:35:38 +000085
Raymond Hettinger92ba2862010-09-06 01:16:46 +000086
87If that dictionary is stored in a file called "conf.json", it can loaded
88and called with code like this::
89
90 >>> import logging.config
91 >>> logging.config.dictConfig(json.load(open('conf.json', 'rb')))
92 >>> logging.info("Transaction completed normally")
93 >>> logging.critical("Abnormal termination")
94
Raymond Hettingeref2335c2010-09-05 08:35:38 +000095.. seealso::
96
97 :pep:`391` - Dictionary Based Configuration for Logging
98 PEP written by Vinay Sajip.
99
Georg Brandl97b20da2010-11-16 15:15:29 +0000100PEP 3148: The ``concurrent.futures`` module
101============================================
102
103.. (Stub section)
104
Georg Brandlda0a2112010-09-05 11:28:33 +0000105
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000106PEP 3147: PYC Repository Directories
107=====================================
108
109Python's scheme for caching bytecode in *.pyc* files did not work well in
110environments with multiple python interpreters. If one interpreter encountered
111a cached file created by another interpreter, it would recompile the source and
112overwrite the cached file, thus losing the benefits of caching.
113
114The issue of "pyc fights" has become more pronounced as it has become
Éric Araujo4234ad42010-09-05 17:32:25 +0000115commonplace for Linux distributions to ship with multiple versions of Python.
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000116These conflicts also arise with CPython alternatives such as Unladen Swallow.
117
118To solve this problem, Python's import machinery has been extended to use
Éric Araujo4234ad42010-09-05 17:32:25 +0000119distinct filenames for each interpreter. Instead of Python 3.2 and Python 3.3 and
120Unladen Swallow each competing for a file called "mymodule.pyc", they will now
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000121look for "mymodule.cpython-32.pyc", "mymodule.cpython-33.pyc", and
Éric Araujo4234ad42010-09-05 17:32:25 +0000122"mymodule.unladen10.pyc". And to prevent all of these new files from
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000123cluttering source directories, the *pyc* files are now collected in a
124"__pycache__" directory stored under the package directory.
125
126Aside from the filenames and target directories, the new scheme has a few
127aspects that are visible to the programmer:
128
Georg Brandlda0a2112010-09-05 11:28:33 +0000129* Imported modules now have a :attr:`__cached__` attribute which stores the name
130 of the actual file that was imported:
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000131
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000132 >>> import collections
133 >>> collections.__cached__
134 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000135
136* The tag that is unique to each interpreter is accessible from the :mod:`imp`
Georg Brandlda0a2112010-09-05 11:28:33 +0000137 module:
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000138
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000139 >>> import imp
140 >>> imp.get_tag()
141 'cpython-32'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000142
143* Scripts that try to deduce source filename from the imported file now need to
144 be smarter. It is no longer sufficient to simply strip the "c" from a ".pyc"
145 filename. Instead, use the new functions in the :mod:`imp` module:
146
Georg Brandlda0a2112010-09-05 11:28:33 +0000147 >>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc')
148 'c:/py32/lib/collections.py'
149 >>> imp.cache_from_source('c:/py32/lib/collections.py')
150 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000151
152* The :mod:`py_compile` and :mod:`compileall` modules have been updated to
153 reflect the new naming convention and target directory.
154
155.. seealso::
156
157 :pep:`3147` - PYC Repository Directories
158 PEP written by Barry Warsaw.
159
Georg Brandlda0a2112010-09-05 11:28:33 +0000160
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000161PEP 3149 ABI Version Tagged .so Files
162=====================================
Georg Brandlf11c6c42010-09-03 22:20:58 +0000163
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000164The PYC repository directory allows multiple bytecode cache files to be
165co-located. This PEP implements a similar mechanism for shared object files by
166giving them a common directory and distinct names for each version.
Georg Brandlf11c6c42010-09-03 22:20:58 +0000167
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000168The common directory is "pyshared" and the file names are made distinct by
169identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the
170major and minor version numbers, and optional build flags (such as "d" for
Éric Araujo4234ad42010-09-05 17:32:25 +0000171debug, "m" for pymalloc, "u" for wide-unicode). For an arbitrary package "foo",
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000172you may see these files when the distribution package is installed::
173
174 /usr/share/pyshared/foo.cpython-32m.so
175 /usr/share/pyshared/foo.cpython-33md.so
176
177In Python itself, the tags are accessible from functions in the :mod:`sysconfig`
178module::
179
180 >>> import sysconfig
181 >>> sysconfig.get_config_var('SOABI') # find the version tag
182 'cpython-32mu'
183 >>> sysconfig.get_config_var('SO') # find the full filename extension
184 'cpython-32mu.so'
185
186.. seealso::
187
188 :pep:`3149` - ABI Version Tagged .so Files
189 PEP written by Barry Warsaw.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000190
191
R. David Murray7c0a2272010-10-08 21:37:39 +0000192Email 5.1
193=========
194
195The email package is extended to be able to parse and generate email messages
196in bytes format.
197
198* New functions :func:`~email.message_from_bytes` and
199 :func:`~email.message_from_binary_file`, and new classes
200 :class:`~email.parser.BytesFeedParser` and :class:`~email.parser.BytesParser`
201 allow binary message data to be parsed into model objects.
202
203* Given bytes input to the model, :meth:`~email.message.Message.get_payload`
204 will by default decode a message body that has a
Senthil Kumaran82270452010-10-15 13:29:33 +0000205 :mailheader:`Content-Transfer-Encoding` of ``8bit`` using the charset
206 specified in the MIME headers and return the resulting string.
R. David Murray7c0a2272010-10-08 21:37:39 +0000207
208* Given bytes input to the model, :class:`~email.generator.Generator` will
209 convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of
210 8bit to instead have a 7bit Content-Transfer-Encoding.
211
212* New class :class:`~email.generator.BytesGenerator` produces bytes
213 as output, preserving any unchanged non-ASCII data that was
214 present in the input used to build the model, including message bodies
215 with a :mailheader:`Content-Transfer-Encoding` of 8bit.
216
217 (Proposed and implemented by R. David Murray, :issue:`4661`.)
218
219
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000220Other Language Changes
221======================
222
223Some smaller changes made to the core Python language are:
224
Georg Brandlda0a2112010-09-05 11:28:33 +0000225* The :func:`hasattr` function used to catch and suppress any Exception. Now,
226 it only catches :exc:`AttributeError`. Under the hood, :func:`hasattr` works
227 by calling :func:`getattr` and throwing away the results. This is necessary
228 because dynamic attribute creation is possible using :meth:`__getattribute__`
Éric Araujo4234ad42010-09-05 17:32:25 +0000229 or :meth:`__getattr__`. If :func:`hasattr` were to just scan instance and class
Éric Araujocc6aac62010-09-07 21:35:35 +0000230 dictionaries it would miss the dynamic methods and make it difficult to
Georg Brandlda0a2112010-09-05 11:28:33 +0000231 implement proxy objects.
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000232
233 (Discovered by Yury Selivanov and fixed by Benjamin Peterson; :issue:`9666`.)
234
Éric Araujo4234ad42010-09-05 17:32:25 +0000235* The :func:`str` of a float or complex number is now the same as its
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000236 :func:`repr`. Previously, the :func:`str` form was shorter but that just
Éric Araujo4234ad42010-09-05 17:32:25 +0000237 caused confusion and is no longer needed now that the shortest possible
Georg Brandlda0a2112010-09-05 11:28:33 +0000238 :func:`repr` is displayed by default:
Raymond Hettingerbb734c62010-09-05 05:56:44 +0000239
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000240 >>> repr(math.pi)
241 '3.141592653589793'
242 >>> str(math.pi)
243 '3.141592653589793'
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000244
Georg Brandlda0a2112010-09-05 11:28:33 +0000245 (Proposed and implemented by Mark Dickinson; :issue:`9337`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000246
Antoine Pitroud3052002010-09-15 15:09:40 +0000247* :class:`memoryview` objects now have a :meth:`release()` method and support
248 the context manager protocol. This allows timely release of any resources
249 that were acquired when requesting a buffer from the original object.
250
251 (Added by Antoine Pitrou; :issue:`9757`.)
252
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000253* Mark Dickinson crafted an elegant and efficient scheme for assuring that
254 different numeric datatypes will have the same hash value whenever their
255 actual values are equal::
256
257 >>> assert hash(Fraction(3, 2)) == hash(1.5) == \
258 hash(Decimal("1.5")) == hash(complex(1.5, 0))
259
260 (See :issue:`8188`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000261
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000262* Previously it was illegal to delete a name from the local namespace if it
263 occurs as a free variable in a nested block::
264
265 >>> def outer(x):
266 ... def inner():
267 ... return x
268 ... inner()
269 ... del x
270
271 This is now allowed. Remember that the target of an :keyword:`except` clause
272 is cleared, so this code which used to work with Python 2.6, raised a
273 :exc:`SyntaxError` with Python 3.1 and now works again::
274
275 >>> def f():
276 ... def print_error():
277 ... print(e)
278 ... try:
279 ... something
280 ... except Exception as e:
281 ... print_error()
282 ... # implicit "del e" here
283
284 (See :issue:`4617`.)
285
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000286* A new warning category, :exc:`ResourceWarning`, has been added. It is
287 emitted when certain potential issues with resource consumption or cleanup
288 are detected. It is silenced by default in normal release builds, but
289 can be easily enabled through the means provided by the :mod:`warnings`
290 module, or on the command line.
291
292 :exc:`ResourceWarning` is issued at interpreter shutdown if the
293 :data:`gc.garbage` list isn't empty. This is meant to make the programmer
294 aware that their code contains object finalization issues.
295
296 (Added by Antoine Pitrou and Georg Brandl; :issue:`477863`.)
297
298 :exc:`ResourceWarning` is also issued when a :term:`file object` is destroyed
299 without having been explicitly closed. While the deallocator for such
300 object ensures it closes the underlying operating system resource
301 (usually, a file descriptor), the delay in deallocating the object could
302 produce various issues, especially under Windows. Here is an example
303 of enabling the warning from the command line::
304
305 $ ./python -Wdefault
306 Python 3.2a3+ (py3k, Nov 5 2010, 22:58:04)
307 [GCC 4.4.3] on linux2
308 Type "help", "copyright", "credits" or "license" for more information.
309 >>> f = open("foo", "wb")
310 >>> del f
311 __main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>
312 >>>
313
314 (Added by Antoine Pitrou, :issue:`10093`.)
315
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000316
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000317New, Improved, and Deprecated Modules
318=====================================
319
Georg Brandle572bce2010-09-07 08:18:26 +0000320* XXX mention :mod:`argparse`.
321
Éric Araujo4234ad42010-09-05 17:32:25 +0000322* The :mod:`functools` module includes a new decorator for caching function
Georg Brandlda0a2112010-09-05 11:28:33 +0000323 calls. :func:`functools.lru_cache` can save repeated queries to an external
324 resource whenever the results are expected to be the same.
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000325
Raymond Hettinger86f96132010-08-06 23:23:49 +0000326 For example, adding a caching decorator to a database query function can save
327 database accesses for popular searches::
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000328
Georg Brandlda0a2112010-09-05 11:28:33 +0000329 @functools.lru_cache(maxsize=300)
330 def get_phone_number(name):
331 c = conn.cursor()
332 c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,))
333 return c.fetchone()[0]
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000334
Nick Coghlan234515a2010-11-30 06:19:46 +0000335 XXX: update for Issue 10586 changes to cache statistics API
336
Raymond Hettingerf3098282010-08-15 03:30:45 +0000337 To help with choosing an effective cache size, the wrapped function is
Georg Brandlda0a2112010-09-05 11:28:33 +0000338 instrumented with two attributes *cache_hits* and *cache_misses*:
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000339
Georg Brandlda0a2112010-09-05 11:28:33 +0000340 >>> for name in user_requests:
341 ... get_phone_number(name)
342 >>> print(get_phone_number.cache_hits, get_phone_number.cache_misses)
343 4805 980
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000344
Raymond Hettingerf3098282010-08-15 03:30:45 +0000345 If the phonelist table gets updated, the outdated contents of the cache can be
Georg Brandlda0a2112010-09-05 11:28:33 +0000346 cleared with:
Raymond Hettingerf3098282010-08-15 03:30:45 +0000347
Georg Brandlda0a2112010-09-05 11:28:33 +0000348 >>> get_phone_number.cache_clear()
Raymond Hettingerf3098282010-08-15 03:30:45 +0000349
Georg Brandlda0a2112010-09-05 11:28:33 +0000350 (Contributed by Raymond Hettinger.)
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000351
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000352* The :func:`functools.wraps` decorator now adds a :attr:`__wrapped__` attribute
353 pointing to the original callable function. This allows wrapped functions to
354 be introspected. It also copies :attr:`__annotations__` if defined. And now
355 it also gracefully skips over missing attributes such as :attr:`__doc__` which
356 might not be defined for the wrapped callable.
357
358 (By Nick Coghlan and Terrence Cole; :issue:`9567`, :issue:`3445`, and
359 :issue:`8814`.)
360
Antoine Pitroucd889af2010-10-06 21:13:56 +0000361* The :mod:`nntplib` module gets a revamped implementation with better
362 bytes / unicode semantics as well as more practical APIs. These improvements
363 break compatibility with the nntplib version in Python 3.1, which was
364 partly dysfunctional in itself.
365
366 (Contributed by Antoine Pitrou in :issue:`9360`)
367
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000368* The :mod:`abc` module now supports :func:`~abc.abstractclassmethod` and
369 :func:`~abc.abstractstaticmethod`.
370
371 (Patch submitted by Daniel Urban; :issue:`5867`.)
372
Georg Brandlda0a2112010-09-05 11:28:33 +0000373* The previously deprecated :func:`contextlib.nested` function has been removed
374 in favor of a plain :keyword:`with` statement which can accept multiple
375 context managers. The latter technique is faster (because it is built-in),
376 and it does a better job finalizing multiple context managers when one of them
377 raises an exception.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000378
379 (Contributed by Georg Brandl and Mattias Brändström;
380 `appspot issue 53094 <http://codereview.appspot.com/53094>`_.)
381
Georg Brandlda0a2112010-09-05 11:28:33 +0000382* The :class:`ftplib.FTP` class now supports the context manager protocol to
Éric Araujo4234ad42010-09-05 17:32:25 +0000383 unconditionally consume :exc:`socket.error` exceptions and to close the FTP
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000384 connection when done::
Raymond Hettingerbcbd6962010-09-05 08:46:36 +0000385
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000386 >>> from ftplib import FTP
387 >>> with FTP("ftp1.at.proftpd.org") as ftp:
388 ... ftp.login()
389 ... ftp.dir()
390 ...
391 '230 Anonymous login ok, restrictions apply.'
392 dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .
393 dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 ..
394 dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS
395 dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora
Raymond Hettingerbcbd6962010-09-05 08:46:36 +0000396
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000397 Other file-like objects such as :class:`mmap.mmap` and :func:`fileinput.input`
398 also grew auto-closing context managers::
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000399
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000400 with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
401 for line in f:
402 process(line)
Georg Brandlda0a2112010-09-05 11:28:33 +0000403
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000404 (Contributed by Tarek Ziadé and Giampaolo Rodolà in :issue:`4972`, and
405 by Georg Brandl in :issue:`8046` and :issue:`1286`.)
Antoine Pitrou696e0352010-08-08 22:18:46 +0000406
Antoine Pitroucd889af2010-10-06 21:13:56 +0000407* :class:`gzip.GzipFile` now implements the :class:`io.BufferedIOBase` ABC
408 (except for ``truncate()``), has a :meth:`~gzip.GzipFile.peek` method,
409 and supports unseekable as well as zero-padded file objects.
410
411 (Contributed by Antoine Pitrou, Nir Aides and Brian Curtin in :issue:`9962`,
412 :issue:`1675951`, :issue:`7471` and :issue:`2846`.)
413
414 The :mod:`gzip` module also gains the :func:`~gzip.compress` and
415 :func:`~gzip.decompress` functions for easier in-memory compression and
416 decompression.
417
418 (Contributed by Anand B. Pillai in :issue:`3488`.)
419
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +0000420* The :mod:`os` module now has the :const:`ST_RDONLY` and :const:`ST_NOSUID`
421 constants, for use with the :func:`~os.statvfs` function.
Raymond Hettingerbcbd6962010-09-05 08:46:36 +0000422
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +0000423 (Patch by Adam Jackson; :issue:`7647`.)
424
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +0000425* :func:`os.getppid` is now supported on Windows. Note that it will continue to
426 return the same pid even after the parent process has exited.
427
428 (Patch by Jon Anglin; :issue:`6394`.)
429
Antoine Pitroud67075e2010-07-31 22:48:02 +0000430* The :func:`shutil.copytree` function has two new options:
431
Raymond Hettingerdb9044e2010-09-06 01:29:23 +0000432 * *ignore_dangling_symlinks*: when ``symlinks=False`` so that the function
433 copies the file pointed to by the symlink, not the symlink itself. This
Georg Brandlda0a2112010-09-05 11:28:33 +0000434 option will silence the error raised if the file doesn't exist.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000435
Raymond Hettingerdb9044e2010-09-06 01:29:23 +0000436 * *copy_function*: is a callable that will be used to copy files.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000437 :func:`shutil.copy2` is used by default.
438
439 (Contributed by Tarek Ziadé.)
440
Georg Brandlda0a2112010-09-05 11:28:33 +0000441* Socket objects now have a :meth:`~socket.socket.detach()` method which puts
442 the socket into closed state without actually closing the underlying file
443 descriptor. The latter can then be reused for other purposes.
Antoine Pitroue43f9d02010-08-08 23:24:50 +0000444
445 (Added by Antoine Pitrou; :issue:`8524`.)
446
Raymond Hettingerd881f312010-09-05 08:54:32 +0000447* The :mod:`sqlite3` module has two new capabilities.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000448
Georg Brandlda0a2112010-09-05 11:28:33 +0000449 The :attr:`Connection.in_transit` attribute is true if there is an active
450 transaction for uncommitted changes.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000451
Raymond Hettingerd881f312010-09-05 08:54:32 +0000452 The :meth:`Connection.enable_load_extension` and
453 :meth:`Connection.load_extension` methods allows you to load SQLite extensions
454 from ".so" files. One well-known extension is the fulltext-search extension
455 distributed with SQLite.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000456
Georg Brandlda0a2112010-09-05 11:28:33 +0000457 (Contributed by R. David Murray and Shashwat Anand; :issue:`8845`.)
Antoine Pitroud67075e2010-07-31 22:48:02 +0000458
Georg Brandlda0a2112010-09-05 11:28:33 +0000459* The :mod:`ssl` module has a new class, :class:`~ssl.SSLContext` which serves
460 as a container for various persistent SSL data, such as protocol settings,
461 certificates, private keys, and various other options. The
462 :meth:`~ssl.SSLContext.wrap_socket` method allows to create an SSL socket from
463 such an SSL context. (Added by Antoine Pitrou; :issue:`8550`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000464
Antoine Pitrou0ee4c9f2010-10-08 16:46:17 +0000465 A new function, :func:`ssl.match_hostname`, helps implement server identity
466 verification for higher-level protocols by implementing the rules of
467 HTTPS (from :rfc:`2818`), which are also suitable for other protocols.
468 (Added by Antoine Pitrou, :issue:`1589`).
469
Georg Brandlda0a2112010-09-05 11:28:33 +0000470 The :func:`ssl.wrap_socket` constructor function now takes a *ciphers*
471 argument that's a string listing the encryption algorithms to be allowed; the
472 format of the string is described `in the OpenSSL documentation
473 <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT>`__. (Added
474 by Antoine Pitrou; :issue:`8322`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000475
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000476 When linked against a recent enough version of OpenSSL, the :mod:`ssl`
477 module now supports the Server Name Indication extension to the TLS
478 protocol, allowing for several "virtual hosts" using different certificates
479 on a single IP/port. This extension is only supported in client mode,
480 and is activated by passing the *server_hostname* argument to
481 :meth:`SSLContext.wrap_socket`.
482 (Added by Antoine Pitrou, :issue:`5639`.)
483
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000484 Various options have been added to the :mod:`ssl` module, such as
Georg Brandlda0a2112010-09-05 11:28:33 +0000485 :data:`~ssl.OP_NO_SSLv2` which allows to force disabling of the insecure and
486 obsolete SSLv2 protocol. (Added by Antoine Pitrou; :issue:`4870`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000487
Georg Brandlda0a2112010-09-05 11:28:33 +0000488 Another change makes the extension load all of OpenSSL's ciphers and digest
489 algorithms so that they're all available. Some SSL certificates couldn't be
490 verified, reporting an "unknown algorithm" error. (Reported by Beda Kosata,
491 and fixed by Antoine Pitrou; :issue:`8484`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000492
Georg Brandlda0a2112010-09-05 11:28:33 +0000493 The version of OpenSSL being used is now available as the module attributes
494 :data:`ssl.OPENSSL_VERSION` (a string), :data:`ssl.OPENSSL_VERSION_INFO` (a
495 5-tuple), and :data:`ssl.OPENSSL_VERSION_NUMBER` (an integer). (Added by
496 Antoine Pitrou; :issue:`8321`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000497
Antoine Pitrouafb078d2010-11-05 22:18:28 +0000498* :class:`http.client.HTTPSConnection`, :class:`urllib.request.HTTPSHandler`
499 and :func:`urllib.request.urlopen` now take optional arguments to allow for
500 server certificate checking against a set of Certificate Authorities,
501 as recommended in public uses of HTTPS.
502 (Added by Antoine Pitrou, :issue:`9003`.)
503
Antoine Pitroud3052002010-09-15 15:09:40 +0000504* Instances of :class:`unittest.TestCase` have two new methods
505 :meth:`~unittest.TestCase.assertWarns` and :meth:`~unittest.TestCase.assertWarnsRegexp`
506 to check that a given warning type was triggered by the code under test::
507
508 with self.assertWarns(DeprecationWarning):
509 legacy_function('XYZ')
510
Ezio Melotti2baf1a62010-11-22 12:56:58 +0000511* The following :class:`unittest.TestCase` methods are now deprecated:
512 * :meth:`assert_` (use :meth:`.assertTrue` instead);
513 * :meth:`assertEquals` (use :meth:`.assertEqual` instead);
514 * :meth:`assertNotEquals` (use :meth:`.assertNotEqual` instead);
515 * :meth:`assertAlmostEquals` (use :meth:`.assertAlmostEqual` instead);
516 * :meth:`assertNotAlmostEquals` (use :meth:`.assertNotAlmostEqual` instead);
517
518 The ``TestCase.fail*`` methods deprecated in Python 3.1 will be removed in
519 Python 3.3. See also the :ref:`deprecated-aliases` section in the
520 :mod:`unittest` documentation.
521
522 (Contributed by Ezio Melotti; :issue:`9424`.)
Antoine Pitroud3052002010-09-15 15:09:40 +0000523
Georg Brandlda0a2112010-09-05 11:28:33 +0000524* The previously deprecated :func:`string.maketrans` function has been removed
525 in favor of the static methods, :meth:`bytes.maketrans` and
Raymond Hettingerf558ddd2009-06-28 21:37:08 +0000526 :meth:`bytearray.maketrans`. This change solves the confusion around which
Georg Brandlda0a2112010-09-05 11:28:33 +0000527 types were supported by the :mod:`string` module. Now, :class:`str`,
Raymond Hettingerf558ddd2009-06-28 21:37:08 +0000528 :class:`bytes`, and :class:`bytearray` each have their own **maketrans** and
Georg Brandlda0a2112010-09-05 11:28:33 +0000529 **translate** methods with intermediate translation tables of the appropriate
530 type.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000531
Raymond Hettingerf558ddd2009-06-28 21:37:08 +0000532 (Contributed by Georg Brandl; :issue:`5675`.)
533
Giampaolo Rodolà42382fe2010-08-17 16:09:53 +0000534* :class:`~poplib.POP3_SSL` class now accepts a *context* parameter, which is a
535 :class:`ssl.SSLContext` object allowing bundling SSL configuration options,
536 certificates and private keys into a single (potentially long-lived)
537 structure.
538
539 (Contributed by Giampaolo Rodolà; :issue:`8807`.)
540
Giampaolo Rodolàb383dbb2010-09-08 22:44:12 +0000541* :func:`socket.create_connection` now supports the context manager protocol
542 to unconditionally consume :exc:`socket.error` exceptions and to close the
543 socket when done.
544
545 (Contributed by Giampaolo Rodolà; :issue:`9794`.)
546
Giampaolo Rodolà977c7072010-10-04 21:08:36 +0000547* :class:`asyncore.dispatcher` now provides a
548 :meth:`~asyncore.dispatcher.handle_accepted()` method
549 returning a `(sock, addr)` pair which is called when a connection has actually
550 been established with a new remote endpoint. This is supposed to be used as a
551 replacement for old :meth:`~asyncore.dispatcher.handle_accept()` and avoids
552 the user to call :meth:`~asyncore.dispatcher.accept()` directly.
553
554 (Contributed by Giampaolo Rodolà; :issue:`6706`.)
Georg Brandlda0a2112010-09-05 11:28:33 +0000555
Nick Coghlan543af752010-10-24 11:23:25 +0000556* The :mod:`tempfile` module has a new context manager,
557 :class:`~tempfile.TemporaryDirectory` which provides easy deterministic
558 cleanup of temporary directories.
559
560 (Contributed by Neil Schemenauer and Nick Coghlan; :issue:`5178`.)
561
R. David Murray7dff9e02010-11-08 17:15:13 +0000562* The :mod:`smtplib` :class:`~smtplib.SMTP` class now accepts a byte string
563 for the *msg* argument to the :meth:`~smtplib.SMTP.sendmail` method,
564 and a new method, :meth:`~smtplib.SMTP.send_message` accepts a
565 :class:`~email.message.Message` object and can optionally obtain the
566 *from_addr* and *to_addrs* addresses directly from the object.
567
568 (Contributed by R. David Murray, :issue:`10321`.)
569
Nick Coghlan543af752010-10-24 11:23:25 +0000570
Nick Coghlane0f04652010-11-21 03:44:04 +0000571* The :mod:`inspect` module has a new function :func:`getgenatorstate`
572 to easily identify the current state of a generator as one of
573 ``GEN_CREATED``, ``GEN_RUNNING``, ``GEN_SUSPENDED`` or ``GEN_CLOSED``.
574
575 (Contributed by Rodolpho Eckhardt and Nick Coghlan, :issue:`10220`.)
576
577.. XXX: Mention inspect.getattr_static (Michael Foord)
578
Antoine Pitroud42bc512009-11-10 23:18:31 +0000579Multi-threading
580===============
581
Georg Brandlda0a2112010-09-05 11:28:33 +0000582* The mechanism for serializing execution of concurrently running Python threads
583 (generally known as the GIL or Global Interpreter Lock) has been rewritten.
584 Among the objectives were more predictable switching intervals and reduced
585 overhead due to lock contention and the number of ensuing system calls. The
586 notion of a "check interval" to allow thread switches has been abandoned and
587 replaced by an absolute duration expressed in seconds. This parameter is
588 tunable through :func:`sys.setswitchinterval()`. It currently defaults to 5
589 milliseconds.
Antoine Pitroud42bc512009-11-10 23:18:31 +0000590
591 Additional details about the implementation can be read from a `python-dev
592 mailing-list message
593 <http://mail.python.org/pipermail/python-dev/2009-October/093321.html>`_
Georg Brandlda0a2112010-09-05 11:28:33 +0000594 (however, "priority requests" as exposed in this message have not been kept
595 for inclusion).
Antoine Pitroud42bc512009-11-10 23:18:31 +0000596
Georg Brandl5e73a812010-04-22 07:02:51 +0000597 (Contributed by Antoine Pitrou.)
Antoine Pitroud42bc512009-11-10 23:18:31 +0000598
Antoine Pitrou5bab5082009-11-13 22:58:45 +0000599* Recursive locks (created with the :func:`threading.RLock` API) now benefit
Georg Brandlda0a2112010-09-05 11:28:33 +0000600 from a C implementation which makes them as fast as regular locks, and between
601 10x and 15x faster than their previous pure Python implementation.
Antoine Pitrou5bab5082009-11-13 22:58:45 +0000602
603 (Contributed by Antoine Pitrou; :issue:`3001`.)
604
Georg Brandlda0a2112010-09-05 11:28:33 +0000605* Regular and recursive locks now accept an optional *timeout* argument to their
Raymond Hettinger09e4ebb2010-09-06 19:55:51 +0000606 :meth:`acquire` method. (Contributed by Antoine Pitrou; :issue:`7316`.)
Georg Brandlda0a2112010-09-05 11:28:33 +0000607
Antoine Pitroue95a9ff2010-05-04 23:31:41 +0000608 Similarly, :meth:`threading.Semaphore.acquire` also gains a *timeout*
Georg Brandlda0a2112010-09-05 11:28:33 +0000609 argument. (Contributed by Torsten Landschoff; :issue:`850728`.)
Antoine Pitroue95a9ff2010-05-04 23:31:41 +0000610
Antoine Pitroud42bc512009-11-10 23:18:31 +0000611
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000612Optimizations
613=============
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000614
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000615A number of small performance enhancements have been added:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000616
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000617* JSON decoding performance is improved and memory consumption is reduced
618 whenever the same string is repeated for multiple keys.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000619
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000620 (Contributed by Antoine Pitrou; :issue:`7451`.)
Victor Stinner94908bb2010-08-18 21:23:25 +0000621
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000622* JSON encoding now uses the C speedups also when the ``sort_keys`` argument
623 is true.
624
625 (Contributed by Raymond Hettinger and Antoine Pitrou, :issue:`10314`.)
626
Antoine Pitroud3052002010-09-15 15:09:40 +0000627* Python's peephole optimizer now recognizes patterns such ``x in {1, 2, 3}`` as
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000628 being a test for membership in a set of constants. The optimizer recasts the
629 :class:`set` as a :class:`frozenset` and stores the pre-built constant.
630
631 Now that the speed penalty is gone, it is practical to start writing
632 membership tests using set-notation. This style is both semantically clear
633 and operationally fast::
634
635 extension = name.rpartition('.')[2]
636 if extension in {'xml', 'html', 'xhtml', 'css'}:
637 handle(name)
638
639 (Patch and additional tests by Dave Malcolm; :issue:`6690`).
640
641* The fast-search algorithm in stringlib is now used by the :meth:`split`,
642 :meth:`rsplit`, :meth:`splitlines` and :meth:`replace` methods on
643 :class:`bytes`, :class:`bytearray` and :class:`str` objects. Likewise, the
644 algorithm is also used by :meth:`rfind`, :meth:`rindex`, :meth:`rsplit` and
645 :meth:`rpartition`.
646
647 (Patch by Florent Xicluna in :issue:`7622` and :issue:`7462`.)
648
Antoine Pitroud3052002010-09-15 15:09:40 +0000649* Serializing and unserializing data using the :mod:`pickle` module is now
Antoine Pitrou6c314ec2010-10-12 21:07:20 +0000650 several times faster. (Contributed by Alexandre Vassalotti, Antoine Pitrou
Antoine Pitrouff150f22010-10-22 21:41:05 +0000651 and the Unladen Swallow team in :issue:`9410` and :issue:`3873`.)
Antoine Pitroud3052002010-09-15 15:09:40 +0000652
653
Victor Stinner47ce9652010-10-29 00:57:35 +0000654Unicode
655=======
Victor Stinner94908bb2010-08-18 21:23:25 +0000656
Éric Araujo4234ad42010-09-05 17:32:25 +0000657The :mod:`os` module has two new functions: :func:`~os.fsencode` and
Victor Stinner47ce9652010-10-29 00:57:35 +0000658:func:`~os.fsdecode`. Add :data:`os.environb`: bytes version of
659:data:`os.environ`, :func:`os.getenvb` function and
660:data:`os.supports_bytes_environ` constant.
Victor Stinnere8d51452010-08-19 01:05:19 +0000661
Georg Brandl326c57d2010-11-26 12:10:06 +0000662``'mbcs'`` encoding doesn't ignore the error handler argument any more. By
Victor Stinner47ce9652010-10-29 00:57:35 +0000663default (strict mode), it raises an UnicodeDecodeError on undecodable byte
664sequence and UnicodeEncodeError on unencodable character. To get the ``'mbcs'``
665encoding of Python 3.1, use ``'ignore'`` error handler to decode and
666``'replace'`` error handler to encode. ``'mbcs'`` supports ``'strict'`` and
667``'ignore'`` error handlers for decoding, and ``'strict'`` and ``'replace'``
668for encoding.
669
670On Mac OS X, Python uses ``'utf-8'`` to decode the command line arguments,
671instead of the locale encoding (which is ISO-8859-1 if the ``LANG`` environment
672variable is not set).
673
674By default, tarfile uses ``'utf-8'`` encoding on Windows (instead of
675``'mbcs'``), and the ``'surrogateescape'`` error handler on all operating
676systems.
Antoine Pitroud3052002010-09-15 15:09:40 +0000677
Victor Stinner94908bb2010-08-18 21:23:25 +0000678
Georg Brandlda0a2112010-09-05 11:28:33 +0000679.. IDLE
680 ====
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000681
Georg Brandlda0a2112010-09-05 11:28:33 +0000682 * Stub
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000683
684
685Build and C API Changes
686=======================
687
688Changes to Python's build process and to the C API include:
689
Georg Brandlda0a2112010-09-05 11:28:33 +0000690* The C functions that access the Unicode Database now accept and return
691 characters from the full Unicode range, even on narrow unicode builds
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000692 (Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and others). A visible difference
Georg Brandlda0a2112010-09-05 11:28:33 +0000693 in Python is that :func:`unicodedata.numeric` now returns the correct value
694 for large code points, and :func:`repr` may consider more characters as
695 printable.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000696
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000697 (Reported by Bupjoe Lee and fixed by Amaury Forgeot D'Arc; :issue:`5127`.)
698
Georg Brandlda0a2112010-09-05 11:28:33 +0000699* Computed gotos are now enabled by default on supported compilers (which are
Raymond Hettingerdb9044e2010-09-06 01:29:23 +0000700 detected by the configure script). They can still be disabled selectively by
Georg Brandlda0a2112010-09-05 11:28:33 +0000701 specifying ``--without-computed-gotos``.
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000702
Georg Brandlda0a2112010-09-05 11:28:33 +0000703 (Contributed by Antoine Pitrou; :issue:`9203`.)
704
Amaury Forgeot d'Arcfeb73072010-09-12 22:42:57 +0000705* The option ``--with-wctype-functions`` was removed. The built-in unicode
706 database is now used for all functions.
707
708 (Contributed by Amaury Forgeot D'Arc; :issue:`9210`.)
709
Skip Montanaro961aaf52010-10-17 22:22:24 +0000710* Hash values are now values of a new type, Py_hash_t, which is defined to
711 be the same size as a pointer. Previously they were of type long, which
712 on some 64-bit operating systems is still only 32 bits long.
713
714 (Contributed by Benjamin Peterson; :issue:`9778`.)
715
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000716
Raymond Hettingerf558ddd2009-06-28 21:37:08 +0000717Porting to Python 3.2
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000718=====================
719
Georg Brandlda0a2112010-09-05 11:28:33 +0000720This section lists previously described changes and other bugfixes that may
721require changes to your code:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000722
Antoine Pitroucd889af2010-10-06 21:13:56 +0000723* The :mod:`nntplib` module was reworked extensively, meaning that its APIs
724 are often incompatible with the 3.1 APIs.
725
Georg Brandl326c57d2010-11-26 12:10:06 +0000726* :class:`bytearray` objects cannot be used any more as filenames: convert them
Georg Brandlda0a2112010-09-05 11:28:33 +0000727 to :class:`bytes`.
Victor Stinnerdcb24032010-04-22 12:08:36 +0000728
Victor Stinner25e8ec42010-06-25 00:02:38 +0000729* PyArg_Parse*() functions:
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000730
Victor Stinner25e8ec42010-06-25 00:02:38 +0000731 * "t#" format has been removed: use "s#" or "s*" instead
732 * "w" and "w#" formats has been removed: use "w*" instead
733
Georg Brandl60203b42010-10-06 10:11:56 +0000734* The :c:type:`PyCObject` type, deprecated in 3.1, has been removed. To wrap
735 opaque C pointers in Python objects, the :c:type:`PyCapsule` API should be used
Éric Araujo4234ad42010-09-05 17:32:25 +0000736 instead; the new type has a well-defined interface for passing typing safety
Georg Brandlda0a2112010-09-05 11:28:33 +0000737 information and a less complicated signature for calling a destructor.
Victor Stinner0cbec572010-09-12 20:32:57 +0000738
Victor Stinner47ce9652010-10-29 00:57:35 +0000739 * Remove sys.setfilesystemencoding() function: it was broken by design.