blob: 87f9e9403baf48c041a21b8b3a2a0124095d1914 [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 Brandlda0a2112010-09-05 11:28:33 +0000100
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000101PEP 3147: PYC Repository Directories
102=====================================
103
104Python's scheme for caching bytecode in *.pyc* files did not work well in
105environments with multiple python interpreters. If one interpreter encountered
106a cached file created by another interpreter, it would recompile the source and
107overwrite the cached file, thus losing the benefits of caching.
108
109The issue of "pyc fights" has become more pronounced as it has become
Éric Araujo4234ad42010-09-05 17:32:25 +0000110commonplace for Linux distributions to ship with multiple versions of Python.
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000111These conflicts also arise with CPython alternatives such as Unladen Swallow.
112
113To solve this problem, Python's import machinery has been extended to use
Éric Araujo4234ad42010-09-05 17:32:25 +0000114distinct filenames for each interpreter. Instead of Python 3.2 and Python 3.3 and
115Unladen Swallow each competing for a file called "mymodule.pyc", they will now
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000116look for "mymodule.cpython-32.pyc", "mymodule.cpython-33.pyc", and
Éric Araujo4234ad42010-09-05 17:32:25 +0000117"mymodule.unladen10.pyc". And to prevent all of these new files from
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000118cluttering source directories, the *pyc* files are now collected in a
119"__pycache__" directory stored under the package directory.
120
121Aside from the filenames and target directories, the new scheme has a few
122aspects that are visible to the programmer:
123
Georg Brandlda0a2112010-09-05 11:28:33 +0000124* Imported modules now have a :attr:`__cached__` attribute which stores the name
125 of the actual file that was imported:
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000126
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000127 >>> import collections
128 >>> collections.__cached__
129 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000130
131* The tag that is unique to each interpreter is accessible from the :mod:`imp`
Georg Brandlda0a2112010-09-05 11:28:33 +0000132 module:
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000133
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000134 >>> import imp
135 >>> imp.get_tag()
136 'cpython-32'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000137
138* Scripts that try to deduce source filename from the imported file now need to
139 be smarter. It is no longer sufficient to simply strip the "c" from a ".pyc"
140 filename. Instead, use the new functions in the :mod:`imp` module:
141
Georg Brandlda0a2112010-09-05 11:28:33 +0000142 >>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc')
143 'c:/py32/lib/collections.py'
144 >>> imp.cache_from_source('c:/py32/lib/collections.py')
145 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000146
147* The :mod:`py_compile` and :mod:`compileall` modules have been updated to
148 reflect the new naming convention and target directory.
149
150.. seealso::
151
152 :pep:`3147` - PYC Repository Directories
153 PEP written by Barry Warsaw.
154
Georg Brandlda0a2112010-09-05 11:28:33 +0000155
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000156PEP 3149 ABI Version Tagged .so Files
157=====================================
Georg Brandlf11c6c42010-09-03 22:20:58 +0000158
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000159The PYC repository directory allows multiple bytecode cache files to be
160co-located. This PEP implements a similar mechanism for shared object files by
161giving them a common directory and distinct names for each version.
Georg Brandlf11c6c42010-09-03 22:20:58 +0000162
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000163The common directory is "pyshared" and the file names are made distinct by
164identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the
165major and minor version numbers, and optional build flags (such as "d" for
Éric Araujo4234ad42010-09-05 17:32:25 +0000166debug, "m" for pymalloc, "u" for wide-unicode). For an arbitrary package "foo",
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000167you may see these files when the distribution package is installed::
168
169 /usr/share/pyshared/foo.cpython-32m.so
170 /usr/share/pyshared/foo.cpython-33md.so
171
172In Python itself, the tags are accessible from functions in the :mod:`sysconfig`
173module::
174
175 >>> import sysconfig
176 >>> sysconfig.get_config_var('SOABI') # find the version tag
177 'cpython-32mu'
178 >>> sysconfig.get_config_var('SO') # find the full filename extension
179 'cpython-32mu.so'
180
181.. seealso::
182
183 :pep:`3149` - ABI Version Tagged .so Files
184 PEP written by Barry Warsaw.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000185
186
R. David Murray7c0a2272010-10-08 21:37:39 +0000187Email 5.1
188=========
189
190The email package is extended to be able to parse and generate email messages
191in bytes format.
192
193* New functions :func:`~email.message_from_bytes` and
194 :func:`~email.message_from_binary_file`, and new classes
195 :class:`~email.parser.BytesFeedParser` and :class:`~email.parser.BytesParser`
196 allow binary message data to be parsed into model objects.
197
198* Given bytes input to the model, :meth:`~email.message.Message.get_payload`
199 will by default decode a message body that has a
Senthil Kumaran82270452010-10-15 13:29:33 +0000200 :mailheader:`Content-Transfer-Encoding` of ``8bit`` using the charset
201 specified in the MIME headers and return the resulting string.
R. David Murray7c0a2272010-10-08 21:37:39 +0000202
203* Given bytes input to the model, :class:`~email.generator.Generator` will
204 convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of
205 8bit to instead have a 7bit Content-Transfer-Encoding.
206
207* New class :class:`~email.generator.BytesGenerator` produces bytes
208 as output, preserving any unchanged non-ASCII data that was
209 present in the input used to build the model, including message bodies
210 with a :mailheader:`Content-Transfer-Encoding` of 8bit.
211
212 (Proposed and implemented by R. David Murray, :issue:`4661`.)
213
214
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000215Other Language Changes
216======================
217
218Some smaller changes made to the core Python language are:
219
Georg Brandlda0a2112010-09-05 11:28:33 +0000220* The :func:`hasattr` function used to catch and suppress any Exception. Now,
221 it only catches :exc:`AttributeError`. Under the hood, :func:`hasattr` works
222 by calling :func:`getattr` and throwing away the results. This is necessary
223 because dynamic attribute creation is possible using :meth:`__getattribute__`
Éric Araujo4234ad42010-09-05 17:32:25 +0000224 or :meth:`__getattr__`. If :func:`hasattr` were to just scan instance and class
Éric Araujocc6aac62010-09-07 21:35:35 +0000225 dictionaries it would miss the dynamic methods and make it difficult to
Georg Brandlda0a2112010-09-05 11:28:33 +0000226 implement proxy objects.
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000227
228 (Discovered by Yury Selivanov and fixed by Benjamin Peterson; :issue:`9666`.)
229
Éric Araujo4234ad42010-09-05 17:32:25 +0000230* The :func:`str` of a float or complex number is now the same as its
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000231 :func:`repr`. Previously, the :func:`str` form was shorter but that just
Éric Araujo4234ad42010-09-05 17:32:25 +0000232 caused confusion and is no longer needed now that the shortest possible
Georg Brandlda0a2112010-09-05 11:28:33 +0000233 :func:`repr` is displayed by default:
Raymond Hettingerbb734c62010-09-05 05:56:44 +0000234
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000235 >>> repr(math.pi)
236 '3.141592653589793'
237 >>> str(math.pi)
238 '3.141592653589793'
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000239
Georg Brandlda0a2112010-09-05 11:28:33 +0000240 (Proposed and implemented by Mark Dickinson; :issue:`9337`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000241
Antoine Pitroud3052002010-09-15 15:09:40 +0000242* :class:`memoryview` objects now have a :meth:`release()` method and support
243 the context manager protocol. This allows timely release of any resources
244 that were acquired when requesting a buffer from the original object.
245
246 (Added by Antoine Pitrou; :issue:`9757`.)
247
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000248* Mark Dickinson crafted an elegant and efficient scheme for assuring that
249 different numeric datatypes will have the same hash value whenever their
250 actual values are equal::
251
252 >>> assert hash(Fraction(3, 2)) == hash(1.5) == \
253 hash(Decimal("1.5")) == hash(complex(1.5, 0))
254
255 (See :issue:`8188`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000256
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000257* Previously it was illegal to delete a name from the local namespace if it
258 occurs as a free variable in a nested block::
259
260 >>> def outer(x):
261 ... def inner():
262 ... return x
263 ... inner()
264 ... del x
265
266 This is now allowed. Remember that the target of an :keyword:`except` clause
267 is cleared, so this code which used to work with Python 2.6, raised a
268 :exc:`SyntaxError` with Python 3.1 and now works again::
269
270 >>> def f():
271 ... def print_error():
272 ... print(e)
273 ... try:
274 ... something
275 ... except Exception as e:
276 ... print_error()
277 ... # implicit "del e" here
278
279 (See :issue:`4617`.)
280
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000281* A new warning category, :exc:`ResourceWarning`, has been added. It is
282 emitted when certain potential issues with resource consumption or cleanup
283 are detected. It is silenced by default in normal release builds, but
284 can be easily enabled through the means provided by the :mod:`warnings`
285 module, or on the command line.
286
287 :exc:`ResourceWarning` is issued at interpreter shutdown if the
288 :data:`gc.garbage` list isn't empty. This is meant to make the programmer
289 aware that their code contains object finalization issues.
290
291 (Added by Antoine Pitrou and Georg Brandl; :issue:`477863`.)
292
293 :exc:`ResourceWarning` is also issued when a :term:`file object` is destroyed
294 without having been explicitly closed. While the deallocator for such
295 object ensures it closes the underlying operating system resource
296 (usually, a file descriptor), the delay in deallocating the object could
297 produce various issues, especially under Windows. Here is an example
298 of enabling the warning from the command line::
299
300 $ ./python -Wdefault
301 Python 3.2a3+ (py3k, Nov 5 2010, 22:58:04)
302 [GCC 4.4.3] on linux2
303 Type "help", "copyright", "credits" or "license" for more information.
304 >>> f = open("foo", "wb")
305 >>> del f
306 __main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>
307 >>>
308
309 (Added by Antoine Pitrou, :issue:`10093`.)
310
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000311
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000312New, Improved, and Deprecated Modules
313=====================================
314
Georg Brandle572bce2010-09-07 08:18:26 +0000315* XXX mention :mod:`argparse`.
316
Éric Araujo4234ad42010-09-05 17:32:25 +0000317* The :mod:`functools` module includes a new decorator for caching function
Georg Brandlda0a2112010-09-05 11:28:33 +0000318 calls. :func:`functools.lru_cache` can save repeated queries to an external
319 resource whenever the results are expected to be the same.
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000320
Raymond Hettinger86f96132010-08-06 23:23:49 +0000321 For example, adding a caching decorator to a database query function can save
322 database accesses for popular searches::
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000323
Georg Brandlda0a2112010-09-05 11:28:33 +0000324 @functools.lru_cache(maxsize=300)
325 def get_phone_number(name):
326 c = conn.cursor()
327 c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,))
328 return c.fetchone()[0]
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000329
Raymond Hettingerf3098282010-08-15 03:30:45 +0000330 To help with choosing an effective cache size, the wrapped function is
Georg Brandlda0a2112010-09-05 11:28:33 +0000331 instrumented with two attributes *cache_hits* and *cache_misses*:
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000332
Georg Brandlda0a2112010-09-05 11:28:33 +0000333 >>> for name in user_requests:
334 ... get_phone_number(name)
335 >>> print(get_phone_number.cache_hits, get_phone_number.cache_misses)
336 4805 980
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000337
Raymond Hettingerf3098282010-08-15 03:30:45 +0000338 If the phonelist table gets updated, the outdated contents of the cache can be
Georg Brandlda0a2112010-09-05 11:28:33 +0000339 cleared with:
Raymond Hettingerf3098282010-08-15 03:30:45 +0000340
Georg Brandlda0a2112010-09-05 11:28:33 +0000341 >>> get_phone_number.cache_clear()
Raymond Hettingerf3098282010-08-15 03:30:45 +0000342
Georg Brandlda0a2112010-09-05 11:28:33 +0000343 (Contributed by Raymond Hettinger.)
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000344
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000345* The :func:`functools.wraps` decorator now adds a :attr:`__wrapped__` attribute
346 pointing to the original callable function. This allows wrapped functions to
347 be introspected. It also copies :attr:`__annotations__` if defined. And now
348 it also gracefully skips over missing attributes such as :attr:`__doc__` which
349 might not be defined for the wrapped callable.
350
351 (By Nick Coghlan and Terrence Cole; :issue:`9567`, :issue:`3445`, and
352 :issue:`8814`.)
353
Antoine Pitroucd889af2010-10-06 21:13:56 +0000354* The :mod:`nntplib` module gets a revamped implementation with better
355 bytes / unicode semantics as well as more practical APIs. These improvements
356 break compatibility with the nntplib version in Python 3.1, which was
357 partly dysfunctional in itself.
358
359 (Contributed by Antoine Pitrou in :issue:`9360`)
360
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000361* The :mod:`abc` module now supports :func:`~abc.abstractclassmethod` and
362 :func:`~abc.abstractstaticmethod`.
363
364 (Patch submitted by Daniel Urban; :issue:`5867`.)
365
Georg Brandlda0a2112010-09-05 11:28:33 +0000366* The previously deprecated :func:`contextlib.nested` function has been removed
367 in favor of a plain :keyword:`with` statement which can accept multiple
368 context managers. The latter technique is faster (because it is built-in),
369 and it does a better job finalizing multiple context managers when one of them
370 raises an exception.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000371
372 (Contributed by Georg Brandl and Mattias Brändström;
373 `appspot issue 53094 <http://codereview.appspot.com/53094>`_.)
374
Georg Brandlda0a2112010-09-05 11:28:33 +0000375* The :class:`ftplib.FTP` class now supports the context manager protocol to
Éric Araujo4234ad42010-09-05 17:32:25 +0000376 unconditionally consume :exc:`socket.error` exceptions and to close the FTP
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000377 connection when done::
Raymond Hettingerbcbd6962010-09-05 08:46:36 +0000378
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000379 >>> from ftplib import FTP
380 >>> with FTP("ftp1.at.proftpd.org") as ftp:
381 ... ftp.login()
382 ... ftp.dir()
383 ...
384 '230 Anonymous login ok, restrictions apply.'
385 dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .
386 dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 ..
387 dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS
388 dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora
Raymond Hettingerbcbd6962010-09-05 08:46:36 +0000389
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000390 Other file-like objects such as :class:`mmap.mmap` and :func:`fileinput.input`
391 also grew auto-closing context managers::
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000392
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000393 with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
394 for line in f:
395 process(line)
Georg Brandlda0a2112010-09-05 11:28:33 +0000396
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000397 (Contributed by Tarek Ziadé and Giampaolo Rodolà in :issue:`4972`, and
398 by Georg Brandl in :issue:`8046` and :issue:`1286`.)
Antoine Pitrou696e0352010-08-08 22:18:46 +0000399
Antoine Pitroucd889af2010-10-06 21:13:56 +0000400* :class:`gzip.GzipFile` now implements the :class:`io.BufferedIOBase` ABC
401 (except for ``truncate()``), has a :meth:`~gzip.GzipFile.peek` method,
402 and supports unseekable as well as zero-padded file objects.
403
404 (Contributed by Antoine Pitrou, Nir Aides and Brian Curtin in :issue:`9962`,
405 :issue:`1675951`, :issue:`7471` and :issue:`2846`.)
406
407 The :mod:`gzip` module also gains the :func:`~gzip.compress` and
408 :func:`~gzip.decompress` functions for easier in-memory compression and
409 decompression.
410
411 (Contributed by Anand B. Pillai in :issue:`3488`.)
412
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +0000413* The :mod:`os` module now has the :const:`ST_RDONLY` and :const:`ST_NOSUID`
414 constants, for use with the :func:`~os.statvfs` function.
Raymond Hettingerbcbd6962010-09-05 08:46:36 +0000415
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +0000416 (Patch by Adam Jackson; :issue:`7647`.)
417
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +0000418* :func:`os.getppid` is now supported on Windows. Note that it will continue to
419 return the same pid even after the parent process has exited.
420
421 (Patch by Jon Anglin; :issue:`6394`.)
422
Antoine Pitroud67075e2010-07-31 22:48:02 +0000423* The :func:`shutil.copytree` function has two new options:
424
Raymond Hettingerdb9044e2010-09-06 01:29:23 +0000425 * *ignore_dangling_symlinks*: when ``symlinks=False`` so that the function
426 copies the file pointed to by the symlink, not the symlink itself. This
Georg Brandlda0a2112010-09-05 11:28:33 +0000427 option will silence the error raised if the file doesn't exist.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000428
Raymond Hettingerdb9044e2010-09-06 01:29:23 +0000429 * *copy_function*: is a callable that will be used to copy files.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000430 :func:`shutil.copy2` is used by default.
431
432 (Contributed by Tarek Ziadé.)
433
Georg Brandlda0a2112010-09-05 11:28:33 +0000434* Socket objects now have a :meth:`~socket.socket.detach()` method which puts
435 the socket into closed state without actually closing the underlying file
436 descriptor. The latter can then be reused for other purposes.
Antoine Pitroue43f9d02010-08-08 23:24:50 +0000437
438 (Added by Antoine Pitrou; :issue:`8524`.)
439
Raymond Hettingerd881f312010-09-05 08:54:32 +0000440* The :mod:`sqlite3` module has two new capabilities.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000441
Georg Brandlda0a2112010-09-05 11:28:33 +0000442 The :attr:`Connection.in_transit` attribute is true if there is an active
443 transaction for uncommitted changes.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000444
Raymond Hettingerd881f312010-09-05 08:54:32 +0000445 The :meth:`Connection.enable_load_extension` and
446 :meth:`Connection.load_extension` methods allows you to load SQLite extensions
447 from ".so" files. One well-known extension is the fulltext-search extension
448 distributed with SQLite.
Antoine Pitroud67075e2010-07-31 22:48:02 +0000449
Georg Brandlda0a2112010-09-05 11:28:33 +0000450 (Contributed by R. David Murray and Shashwat Anand; :issue:`8845`.)
Antoine Pitroud67075e2010-07-31 22:48:02 +0000451
Georg Brandlda0a2112010-09-05 11:28:33 +0000452* The :mod:`ssl` module has a new class, :class:`~ssl.SSLContext` which serves
453 as a container for various persistent SSL data, such as protocol settings,
454 certificates, private keys, and various other options. The
455 :meth:`~ssl.SSLContext.wrap_socket` method allows to create an SSL socket from
456 such an SSL context. (Added by Antoine Pitrou; :issue:`8550`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000457
Antoine Pitrou0ee4c9f2010-10-08 16:46:17 +0000458 A new function, :func:`ssl.match_hostname`, helps implement server identity
459 verification for higher-level protocols by implementing the rules of
460 HTTPS (from :rfc:`2818`), which are also suitable for other protocols.
461 (Added by Antoine Pitrou, :issue:`1589`).
462
Georg Brandlda0a2112010-09-05 11:28:33 +0000463 The :func:`ssl.wrap_socket` constructor function now takes a *ciphers*
464 argument that's a string listing the encryption algorithms to be allowed; the
465 format of the string is described `in the OpenSSL documentation
466 <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT>`__. (Added
467 by Antoine Pitrou; :issue:`8322`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000468
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000469 When linked against a recent enough version of OpenSSL, the :mod:`ssl`
470 module now supports the Server Name Indication extension to the TLS
471 protocol, allowing for several "virtual hosts" using different certificates
472 on a single IP/port. This extension is only supported in client mode,
473 and is activated by passing the *server_hostname* argument to
474 :meth:`SSLContext.wrap_socket`.
475 (Added by Antoine Pitrou, :issue:`5639`.)
476
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000477 Various options have been added to the :mod:`ssl` module, such as
Georg Brandlda0a2112010-09-05 11:28:33 +0000478 :data:`~ssl.OP_NO_SSLv2` which allows to force disabling of the insecure and
479 obsolete SSLv2 protocol. (Added by Antoine Pitrou; :issue:`4870`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000480
Georg Brandlda0a2112010-09-05 11:28:33 +0000481 Another change makes the extension load all of OpenSSL's ciphers and digest
482 algorithms so that they're all available. Some SSL certificates couldn't be
483 verified, reporting an "unknown algorithm" error. (Reported by Beda Kosata,
484 and fixed by Antoine Pitrou; :issue:`8484`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000485
Georg Brandlda0a2112010-09-05 11:28:33 +0000486 The version of OpenSSL being used is now available as the module attributes
487 :data:`ssl.OPENSSL_VERSION` (a string), :data:`ssl.OPENSSL_VERSION_INFO` (a
488 5-tuple), and :data:`ssl.OPENSSL_VERSION_NUMBER` (an integer). (Added by
489 Antoine Pitrou; :issue:`8321`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +0000490
Antoine Pitrouafb078d2010-11-05 22:18:28 +0000491* :class:`http.client.HTTPSConnection`, :class:`urllib.request.HTTPSHandler`
492 and :func:`urllib.request.urlopen` now take optional arguments to allow for
493 server certificate checking against a set of Certificate Authorities,
494 as recommended in public uses of HTTPS.
495 (Added by Antoine Pitrou, :issue:`9003`.)
496
Antoine Pitroud3052002010-09-15 15:09:40 +0000497* Instances of :class:`unittest.TestCase` have two new methods
498 :meth:`~unittest.TestCase.assertWarns` and :meth:`~unittest.TestCase.assertWarnsRegexp`
499 to check that a given warning type was triggered by the code under test::
500
501 with self.assertWarns(DeprecationWarning):
502 legacy_function('XYZ')
503
504
Georg Brandlda0a2112010-09-05 11:28:33 +0000505* The previously deprecated :func:`string.maketrans` function has been removed
506 in favor of the static methods, :meth:`bytes.maketrans` and
Raymond Hettingerf558ddd2009-06-28 21:37:08 +0000507 :meth:`bytearray.maketrans`. This change solves the confusion around which
Georg Brandlda0a2112010-09-05 11:28:33 +0000508 types were supported by the :mod:`string` module. Now, :class:`str`,
Raymond Hettingerf558ddd2009-06-28 21:37:08 +0000509 :class:`bytes`, and :class:`bytearray` each have their own **maketrans** and
Georg Brandlda0a2112010-09-05 11:28:33 +0000510 **translate** methods with intermediate translation tables of the appropriate
511 type.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000512
Raymond Hettingerf558ddd2009-06-28 21:37:08 +0000513 (Contributed by Georg Brandl; :issue:`5675`.)
514
Giampaolo Rodolà42382fe2010-08-17 16:09:53 +0000515* :class:`~poplib.POP3_SSL` class now accepts a *context* parameter, which is a
516 :class:`ssl.SSLContext` object allowing bundling SSL configuration options,
517 certificates and private keys into a single (potentially long-lived)
518 structure.
519
520 (Contributed by Giampaolo Rodolà; :issue:`8807`.)
521
Giampaolo Rodolàb383dbb2010-09-08 22:44:12 +0000522* :func:`socket.create_connection` now supports the context manager protocol
523 to unconditionally consume :exc:`socket.error` exceptions and to close the
524 socket when done.
525
526 (Contributed by Giampaolo Rodolà; :issue:`9794`.)
527
Giampaolo Rodolà977c7072010-10-04 21:08:36 +0000528* :class:`asyncore.dispatcher` now provides a
529 :meth:`~asyncore.dispatcher.handle_accepted()` method
530 returning a `(sock, addr)` pair which is called when a connection has actually
531 been established with a new remote endpoint. This is supposed to be used as a
532 replacement for old :meth:`~asyncore.dispatcher.handle_accept()` and avoids
533 the user to call :meth:`~asyncore.dispatcher.accept()` directly.
534
535 (Contributed by Giampaolo Rodolà; :issue:`6706`.)
Georg Brandlda0a2112010-09-05 11:28:33 +0000536
Nick Coghlan543af752010-10-24 11:23:25 +0000537* The :mod:`tempfile` module has a new context manager,
538 :class:`~tempfile.TemporaryDirectory` which provides easy deterministic
539 cleanup of temporary directories.
540
541 (Contributed by Neil Schemenauer and Nick Coghlan; :issue:`5178`.)
542
543
Antoine Pitroud42bc512009-11-10 23:18:31 +0000544Multi-threading
545===============
546
Georg Brandlda0a2112010-09-05 11:28:33 +0000547* The mechanism for serializing execution of concurrently running Python threads
548 (generally known as the GIL or Global Interpreter Lock) has been rewritten.
549 Among the objectives were more predictable switching intervals and reduced
550 overhead due to lock contention and the number of ensuing system calls. The
551 notion of a "check interval" to allow thread switches has been abandoned and
552 replaced by an absolute duration expressed in seconds. This parameter is
553 tunable through :func:`sys.setswitchinterval()`. It currently defaults to 5
554 milliseconds.
Antoine Pitroud42bc512009-11-10 23:18:31 +0000555
556 Additional details about the implementation can be read from a `python-dev
557 mailing-list message
558 <http://mail.python.org/pipermail/python-dev/2009-October/093321.html>`_
Georg Brandlda0a2112010-09-05 11:28:33 +0000559 (however, "priority requests" as exposed in this message have not been kept
560 for inclusion).
Antoine Pitroud42bc512009-11-10 23:18:31 +0000561
Georg Brandl5e73a812010-04-22 07:02:51 +0000562 (Contributed by Antoine Pitrou.)
Antoine Pitroud42bc512009-11-10 23:18:31 +0000563
Antoine Pitrou5bab5082009-11-13 22:58:45 +0000564* Recursive locks (created with the :func:`threading.RLock` API) now benefit
Georg Brandlda0a2112010-09-05 11:28:33 +0000565 from a C implementation which makes them as fast as regular locks, and between
566 10x and 15x faster than their previous pure Python implementation.
Antoine Pitrou5bab5082009-11-13 22:58:45 +0000567
568 (Contributed by Antoine Pitrou; :issue:`3001`.)
569
Georg Brandlda0a2112010-09-05 11:28:33 +0000570* Regular and recursive locks now accept an optional *timeout* argument to their
Raymond Hettinger09e4ebb2010-09-06 19:55:51 +0000571 :meth:`acquire` method. (Contributed by Antoine Pitrou; :issue:`7316`.)
Georg Brandlda0a2112010-09-05 11:28:33 +0000572
Antoine Pitroue95a9ff2010-05-04 23:31:41 +0000573 Similarly, :meth:`threading.Semaphore.acquire` also gains a *timeout*
Georg Brandlda0a2112010-09-05 11:28:33 +0000574 argument. (Contributed by Torsten Landschoff; :issue:`850728`.)
Antoine Pitroue95a9ff2010-05-04 23:31:41 +0000575
Antoine Pitroud42bc512009-11-10 23:18:31 +0000576
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000577Optimizations
578=============
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000579
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000580A number of small performance enhancements have been added:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000581
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000582* JSON decoding performance is improved and memory consumption is reduced
583 whenever the same string is repeated for multiple keys.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000584
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000585 (Contributed by Antoine Pitrou; :issue:`7451`.)
Victor Stinner94908bb2010-08-18 21:23:25 +0000586
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000587* JSON encoding now uses the C speedups also when the ``sort_keys`` argument
588 is true.
589
590 (Contributed by Raymond Hettinger and Antoine Pitrou, :issue:`10314`.)
591
Antoine Pitroud3052002010-09-15 15:09:40 +0000592* Python's peephole optimizer now recognizes patterns such ``x in {1, 2, 3}`` as
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000593 being a test for membership in a set of constants. The optimizer recasts the
594 :class:`set` as a :class:`frozenset` and stores the pre-built constant.
595
596 Now that the speed penalty is gone, it is practical to start writing
597 membership tests using set-notation. This style is both semantically clear
598 and operationally fast::
599
600 extension = name.rpartition('.')[2]
601 if extension in {'xml', 'html', 'xhtml', 'css'}:
602 handle(name)
603
604 (Patch and additional tests by Dave Malcolm; :issue:`6690`).
605
606* The fast-search algorithm in stringlib is now used by the :meth:`split`,
607 :meth:`rsplit`, :meth:`splitlines` and :meth:`replace` methods on
608 :class:`bytes`, :class:`bytearray` and :class:`str` objects. Likewise, the
609 algorithm is also used by :meth:`rfind`, :meth:`rindex`, :meth:`rsplit` and
610 :meth:`rpartition`.
611
612 (Patch by Florent Xicluna in :issue:`7622` and :issue:`7462`.)
613
Antoine Pitroud3052002010-09-15 15:09:40 +0000614* Serializing and unserializing data using the :mod:`pickle` module is now
Antoine Pitrou6c314ec2010-10-12 21:07:20 +0000615 several times faster. (Contributed by Alexandre Vassalotti, Antoine Pitrou
Antoine Pitrouff150f22010-10-22 21:41:05 +0000616 and the Unladen Swallow team in :issue:`9410` and :issue:`3873`.)
Antoine Pitroud3052002010-09-15 15:09:40 +0000617
618
Victor Stinner47ce9652010-10-29 00:57:35 +0000619Unicode
620=======
Victor Stinner94908bb2010-08-18 21:23:25 +0000621
Éric Araujo4234ad42010-09-05 17:32:25 +0000622The :mod:`os` module has two new functions: :func:`~os.fsencode` and
Victor Stinner47ce9652010-10-29 00:57:35 +0000623:func:`~os.fsdecode`. Add :data:`os.environb`: bytes version of
624:data:`os.environ`, :func:`os.getenvb` function and
625:data:`os.supports_bytes_environ` constant.
Victor Stinnere8d51452010-08-19 01:05:19 +0000626
Victor Stinner47ce9652010-10-29 00:57:35 +0000627``'mbcs'`` encoding doesn't ignore the error handler argument anymore. By
628default (strict mode), it raises an UnicodeDecodeError on undecodable byte
629sequence and UnicodeEncodeError on unencodable character. To get the ``'mbcs'``
630encoding of Python 3.1, use ``'ignore'`` error handler to decode and
631``'replace'`` error handler to encode. ``'mbcs'`` supports ``'strict'`` and
632``'ignore'`` error handlers for decoding, and ``'strict'`` and ``'replace'``
633for encoding.
634
635On Mac OS X, Python uses ``'utf-8'`` to decode the command line arguments,
636instead of the locale encoding (which is ISO-8859-1 if the ``LANG`` environment
637variable is not set).
638
639By default, tarfile uses ``'utf-8'`` encoding on Windows (instead of
640``'mbcs'``), and the ``'surrogateescape'`` error handler on all operating
641systems.
Antoine Pitroud3052002010-09-15 15:09:40 +0000642
Victor Stinner94908bb2010-08-18 21:23:25 +0000643
Georg Brandlda0a2112010-09-05 11:28:33 +0000644.. IDLE
645 ====
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000646
Georg Brandlda0a2112010-09-05 11:28:33 +0000647 * Stub
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000648
649
650Build and C API Changes
651=======================
652
653Changes to Python's build process and to the C API include:
654
Georg Brandlda0a2112010-09-05 11:28:33 +0000655* The C functions that access the Unicode Database now accept and return
656 characters from the full Unicode range, even on narrow unicode builds
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000657 (Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and others). A visible difference
Georg Brandlda0a2112010-09-05 11:28:33 +0000658 in Python is that :func:`unicodedata.numeric` now returns the correct value
659 for large code points, and :func:`repr` may consider more characters as
660 printable.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000661
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000662 (Reported by Bupjoe Lee and fixed by Amaury Forgeot D'Arc; :issue:`5127`.)
663
Georg Brandlda0a2112010-09-05 11:28:33 +0000664* Computed gotos are now enabled by default on supported compilers (which are
Raymond Hettingerdb9044e2010-09-06 01:29:23 +0000665 detected by the configure script). They can still be disabled selectively by
Georg Brandlda0a2112010-09-05 11:28:33 +0000666 specifying ``--without-computed-gotos``.
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000667
Georg Brandlda0a2112010-09-05 11:28:33 +0000668 (Contributed by Antoine Pitrou; :issue:`9203`.)
669
Amaury Forgeot d'Arcfeb73072010-09-12 22:42:57 +0000670* The option ``--with-wctype-functions`` was removed. The built-in unicode
671 database is now used for all functions.
672
673 (Contributed by Amaury Forgeot D'Arc; :issue:`9210`.)
674
Skip Montanaro961aaf52010-10-17 22:22:24 +0000675* Hash values are now values of a new type, Py_hash_t, which is defined to
676 be the same size as a pointer. Previously they were of type long, which
677 on some 64-bit operating systems is still only 32 bits long.
678
679 (Contributed by Benjamin Peterson; :issue:`9778`.)
680
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000681
Raymond Hettingerf558ddd2009-06-28 21:37:08 +0000682Porting to Python 3.2
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000683=====================
684
Georg Brandlda0a2112010-09-05 11:28:33 +0000685This section lists previously described changes and other bugfixes that may
686require changes to your code:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000687
Antoine Pitroucd889af2010-10-06 21:13:56 +0000688* The :mod:`nntplib` module was reworked extensively, meaning that its APIs
689 are often incompatible with the 3.1 APIs.
690
Georg Brandlda0a2112010-09-05 11:28:33 +0000691* :class:`bytearray` objects cannot be used anymore as filenames: convert them
692 to :class:`bytes`.
Victor Stinnerdcb24032010-04-22 12:08:36 +0000693
Victor Stinner25e8ec42010-06-25 00:02:38 +0000694* PyArg_Parse*() functions:
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000695
Victor Stinner25e8ec42010-06-25 00:02:38 +0000696 * "t#" format has been removed: use "s#" or "s*" instead
697 * "w" and "w#" formats has been removed: use "w*" instead
698
Georg Brandl60203b42010-10-06 10:11:56 +0000699* The :c:type:`PyCObject` type, deprecated in 3.1, has been removed. To wrap
700 opaque C pointers in Python objects, the :c:type:`PyCapsule` API should be used
Éric Araujo4234ad42010-09-05 17:32:25 +0000701 instead; the new type has a well-defined interface for passing typing safety
Georg Brandlda0a2112010-09-05 11:28:33 +0000702 information and a less complicated signature for calling a destructor.
Victor Stinner0cbec572010-09-12 20:32:57 +0000703
Victor Stinner47ce9652010-10-29 00:57:35 +0000704 * Remove sys.setfilesystemencoding() function: it was broken by design.