blob: 57749d9ff049459e65c05e374d67a69132f17bd5 [file] [log] [blame]
Raymond Hettingerd73be672010-12-18 10:48:26 +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
Raymond Hettinger6f04adc2010-12-04 22:56:25 +000014 get rewritten.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +000015
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
Raymond Hettingerffad35e2010-12-14 21:12:03 +000050This article explains the new features in Python 3.2 as compared to 3.1. It
51focuses on a few highlights and gives a few examples. For full details, see the
52:source:`Misc/NEWS <Misc/NEWS>` file.
Raymond Hettinger2c1ecc32010-12-07 09:55:02 +000053
Raymond Hettinger6778fa92010-12-21 20:09:55 +000054.. seealso::
55
56 :pep:`392` - Python 3.2 Release Schedule
Raymond Hettinger6e6565b2009-06-28 20:56:11 +000057
Raymond Hettingerca904be2011-01-18 00:02:40 +000058
Martin v. Löwis932e49e2010-12-04 13:49:32 +000059PEP 384: Defining a Stable ABI
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000060==============================
61
62In the past, extension modules built for one Python version were often
63not usable with other Python versions. Particularly on Windows, every
64feature release of Python required rebuilding all extension modules that
65one wanted to use. This requirement was the result of the free access to
66Python interpreter internals that extension modules could use.
67
68With Python 3.2, an alternative approach becomes available: extension
Raymond Hettinger6f04adc2010-12-04 22:56:25 +000069modules which restrict themselves to a limited API (by defining
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000070Py_LIMITED_API) cannot use many of the internals, but are constrained
71to a set of API functions that are promised to be stable for several
72releases. As a consequence, extension modules built for 3.2 in that
73mode will also work with 3.3, 3.4, and so on. Extension modules that
74make use of details of memory structures can still be built, but will
75need to be recompiled for every feature release.
76
Raymond Hettinger6f04adc2010-12-04 22:56:25 +000077.. seealso::
78
Georg Brandl65b2eb92010-12-05 11:42:38 +000079 :pep:`384` - Defining a Stable ABI
Raymond Hettinger2c1ecc32010-12-07 09:55:02 +000080 PEP written by Martin von Löwis.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +000081
Raymond Hettingerca904be2011-01-18 00:02:40 +000082
Raymond Hettingera5a35542010-12-05 00:39:18 +000083PEP 389: Argparse Command Line Parsing Module
84=============================================
85
86A new module for command line parsing, :mod:`argparse`, was introduced to
87overcome the limitations of :mod:`optparse` which did not provide support for
Raymond Hettinger677e10a2010-12-07 06:45:30 +000088positional arguments (not just options), subcommands, required options and other
Raymond Hettinger413abbc2010-12-05 07:06:47 +000089common patterns of specifying and validating options.
Raymond Hettingera5a35542010-12-05 00:39:18 +000090
Raymond Hettingerc8a16862011-01-18 09:01:34 +000091This module has already has widespread success in the community as a
Raymond Hettingerb1ff4022010-12-08 11:19:45 +000092third-party module. Being more fully featured than its predecessor, the
93:mod:`argparse` module is now the preferred module for command-line processing.
94The older module is still being kept available because of the substantial amount
95of legacy code that depends on it.
Raymond Hettingera5a35542010-12-05 00:39:18 +000096
Raymond Hettinger677e10a2010-12-07 06:45:30 +000097Here's an annotated example parser showing features like limiting results to a
98set of choices, specifying a *metavar* in the help screen, validating that one
Raymond Hettinger68f1e8d2010-12-07 09:24:30 +000099or more positional arguments is present, and making a required option::
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000100
101 import argparse
102 parser = argparse.ArgumentParser(
103 description = 'Manage servers', # main description for help
104 epilog = 'Tested on Solaris and Linux') # displayed after help
105 parser.add_argument('action', # argument name
Raymond Hettinger92977092011-01-16 09:18:59 +0000106 choices = ['deploy', 'start', 'stop'], # three allowed values
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000107 help = 'action on each target') # help msg
108 parser.add_argument('targets',
109 metavar = 'HOSTNAME', # var name used in help msg
Raymond Hettinger92977092011-01-16 09:18:59 +0000110 nargs = '+', # require one or more targets
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000111 help = 'url for target machines') # help msg explanation
112 parser.add_argument('-u', '--user', # -u or --user option
Georg Brandl52a43b52011-01-16 09:11:45 +0000113 required = True, # make it a required argument
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000114 help = 'login as user')
115
116Example of calling the parser on a command string::
117
118 >>> cmd = 'deploy sneezy.example.com sleepy.example.com -u skycaptain'
119 >>> result = parser.parse_args(cmd.split())
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000120 >>> result.action
121 'deploy'
122 >>> result.targets
123 ['sneezy.example.com', 'sleepy.example.com']
124 >>> result.user
125 'skycaptain'
126
127Example of the parser's automatically generated help::
128
129 >>> parser.parse_args('-h'.split())
130
Raymond Hettinger3fcf0022010-12-08 01:13:53 +0000131 usage: manage_cloud.py [-h] -u USER
132 {deploy,start,stop} HOSTNAME [HOSTNAME ...]
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000133
134 Manage servers
135
136 positional arguments:
137 {deploy,start,stop} action on each target
138 HOSTNAME url for target machines
139
140 optional arguments:
141 -h, --help show this help message and exit
142 -u USER, --user USER login as user
143
144 Tested on Solaris and Linux
145
Raymond Hettingerb1ff4022010-12-08 11:19:45 +0000146An especially nice :mod:`argparse` feature is the ability to define subparsers,
147each with their own argument patterns and help displays::
148
149 import argparse
150 parser = argparse.ArgumentParser(prog='HELM')
151 subparsers = parser.add_subparsers()
152
153 parser_l = subparsers.add_parser('launch', help='Launch Control') # first subgroup
Raymond Hettingerbb9686f2010-12-16 00:53:05 +0000154 parser_l.add_argument('-m', '--missiles', action='store_true')
Raymond Hettingerb1ff4022010-12-08 11:19:45 +0000155 parser_l.add_argument('-t', '--torpedos', action='store_true')
156
Raymond Hettinger3094ed82010-12-18 09:41:32 +0000157 parser_m = subparsers.add_parser('move', help='Move Vessel', # second subgroup
158 aliases=('steer', 'turn')) # equivalent names
Raymond Hettingerb1ff4022010-12-08 11:19:45 +0000159 parser_m.add_argument('-c', '--course', type=int, required=True)
160 parser_m.add_argument('-s', '--speed', type=int, default=0)
161
162 $ ./helm.py --help # top level help (launch and move)
163 $ ./helm.py launch --help # help for launch options
164 $ ./helm.py launch --missiles # set missiles=True and torpedos=False
Raymond Hettinger3094ed82010-12-18 09:41:32 +0000165 $ ./helm.py steer --course 180 --speed 5 # set movement parameters
Raymond Hettingera5a35542010-12-05 00:39:18 +0000166
167.. seealso::
168
169 :pep:`389` - New Command Line Parsing Module
170 PEP written by Steven Bethard.
171
Raymond Hettingerbe9994e2011-01-19 08:44:33 +0000172 :ref:`upgrading-optparse-code` for details on the differences from :mod:`optparse`.
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000173
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000174
Éric Araujo4234ad42010-09-05 17:32:25 +0000175PEP 391: Dictionary Based Configuration for Logging
176====================================================
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000177
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000178The :mod:`logging` module provided two kinds of configuration, one style with
179function calls for each option or another style driven by an external file saved
180in a :mod:`ConfigParser` format. Those options did not provide the flexibility
Georg Brandl9e75cad2010-09-06 06:45:47 +0000181to create configurations from JSON or YAML files, nor did they support
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000182incremental configuration, which is needed for specifying logger options from a
183command line.
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000184
185To support a more flexible style, the module now offers
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000186:func:`logging.config.dictConfig` for specifying logging configuration with
187plain Python dictionaries. The configuration options include formatters,
188handlers, filters, and loggers. Here's a working example of a configuration
189dictionary::
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000190
Georg Brandlda0a2112010-09-05 11:28:33 +0000191 {"version": 1,
192 "formatters": {"brief": {"format": "%(levelname)-8s: %(name)-15s: %(message)s"},
193 "full": {"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"},
194 },
195 "handlers": {"console": {
196 "class": "logging.StreamHandler",
197 "formatter": "brief",
198 "level": "INFO",
199 "stream": "ext://sys.stdout"},
200 "console_priority": {
201 "class": "logging.StreamHandler",
202 "formatter": "full",
203 "level": "ERROR",
204 "stream": "ext://sys.stderr"},
205 },
206 "root": {"level": "DEBUG", "handlers": ["console", "console_priority"]}}
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000207
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000208
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000209If that dictionary is stored in a file called :file:`conf.json`, it can be
210loaded and called with code like this::
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000211
Raymond Hettingerca904be2011-01-18 00:02:40 +0000212 >>> import json, logging.config
213 >>> with open('conf.json', 'rb') as f:
214 conf = json.load(f)
215 >>> logging.config.dictConfig(conf)
216 >>> logging.info("Transaction completed normally")
217 >>> logging.critical("Abnormal termination")
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000218
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000219.. seealso::
220
221 :pep:`391` - Dictionary Based Configuration for Logging
222 PEP written by Vinay Sajip.
223
Raymond Hettingerca904be2011-01-18 00:02:40 +0000224
Georg Brandl97b20da2010-11-16 15:15:29 +0000225PEP 3148: The ``concurrent.futures`` module
226============================================
227
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000228Code for creating and managing concurrency is being collected in a new top-level
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000229namespace, *concurrent*. Its first member is a *futures* package which provides
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000230a uniform high-level interface for managing threads and processes.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000231
232The design for :mod:`concurrent.futures` was inspired by
233*java.util.concurrent.package*. In that model, a running call and its result
Raymond Hettingerc136b042011-01-18 07:15:39 +0000234are represented by a :class:`~concurrent.futures.Future` object that abstracts
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000235features common to threads, processes, and remote procedure calls. That object
236supports status checks (running or done), timeouts, cancellations, adding
Raymond Hettinger24a09412010-12-08 06:50:02 +0000237callbacks, and access to results or exceptions.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000238
239The primary offering of the new module is a pair of executor classes for
240launching and managing calls. The goal of the executors is to make it easier to
241use existing tools for making parallel calls. They save the effort needed to
242setup a pool of resources, launch the calls, create a results queue, add
243time-out handling, and limit the total number of threads, processes, or remote
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000244procedure calls.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000245
246Ideally, each application should share a single executor across multiple
247components so that process and thread limits can be centrally managed. This
248solves the design challenge that arises when each component has its own
249competing strategy for resource management.
250
Raymond Hettingerb1055192010-12-08 06:42:41 +0000251Both classes share a common interface with three methods:
252:meth:`~concurrent.futures.Executor.submit` for scheduling a callable and
253returning a :class:`~concurrent.futures.Future` object;
254:meth:`~concurrent.futures.Executor.map` for scheduling many asynchronous calls
Raymond Hettinger83d80792010-12-08 06:48:33 +0000255at a time, and :meth:`~concurrent.futures.Executor.shutdown` for freeing
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000256resources. The class is a :term:`context manager` and can be used in a
Raymond Hettinger83d80792010-12-08 06:48:33 +0000257:keyword:`with` statement to assure that resources are automatically released
258when currently pending futures are done executing.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000259
Raymond Hettingerb1055192010-12-08 06:42:41 +0000260A simple of example of :class:`~concurrent.futures.ThreadPoolExecutor` is a
Raymond Hettinger83d80792010-12-08 06:48:33 +0000261launch of four parallel threads for copying files::
Raymond Hettingerb1055192010-12-08 06:42:41 +0000262
263 import shutil
264 with ThreadPoolExecutor(max_workers=4) as e:
265 e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
266 e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
267 e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
268 e.submit(shutil.copy, 'src3.txt', 'dest4.txt')
269
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000270.. seealso::
271
Raymond Hettingera5a35542010-12-05 00:39:18 +0000272 :pep:`3148` - Futures -- Execute Computations Asynchronously
Andrew M. Kuchling42877fe2010-12-15 02:37:01 +0000273 PEP written by Brian Quinlan.
Georg Brandl97b20da2010-11-16 15:15:29 +0000274
Raymond Hettinger83d80792010-12-08 06:48:33 +0000275 :ref:`Code for Threaded Parallel URL reads<threadpoolexecutor-example>`, an
276 example using threads to fetch multiple web pages in parallel.
277
278 :ref:`Code for computing prime numbers in
279 parallel<processpoolexecutor-example>`, an example demonstrating
280 :class:`~concurrent.futures.ProcessPoolExecutor`.
281
282
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000283PEP 3147: PYC Repository Directories
284=====================================
285
David Malcolm778645a2010-12-07 00:32:04 +0000286Python's scheme for caching bytecode in *.pyc* files did not work well in
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000287environments with multiple Python interpreters. If one interpreter encountered
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000288a cached file created by another interpreter, it would recompile the source and
289overwrite the cached file, thus losing the benefits of caching.
290
291The issue of "pyc fights" has become more pronounced as it has become
Éric Araujo4234ad42010-09-05 17:32:25 +0000292commonplace for Linux distributions to ship with multiple versions of Python.
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000293These conflicts also arise with CPython alternatives such as Unladen Swallow.
294
295To solve this problem, Python's import machinery has been extended to use
Éric Araujo4234ad42010-09-05 17:32:25 +0000296distinct filenames for each interpreter. Instead of Python 3.2 and Python 3.3 and
297Unladen Swallow each competing for a file called "mymodule.pyc", they will now
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000298look for "mymodule.cpython-32.pyc", "mymodule.cpython-33.pyc", and
Éric Araujo4234ad42010-09-05 17:32:25 +0000299"mymodule.unladen10.pyc". And to prevent all of these new files from
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000300cluttering source directories, the *pyc* files are now collected in a
301"__pycache__" directory stored under the package directory.
302
303Aside from the filenames and target directories, the new scheme has a few
304aspects that are visible to the programmer:
305
Georg Brandlda0a2112010-09-05 11:28:33 +0000306* Imported modules now have a :attr:`__cached__` attribute which stores the name
307 of the actual file that was imported:
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000308
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000309 >>> import collections
310 >>> collections.__cached__
311 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000312
313* The tag that is unique to each interpreter is accessible from the :mod:`imp`
Georg Brandlda0a2112010-09-05 11:28:33 +0000314 module:
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000315
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000316 >>> import imp
317 >>> imp.get_tag()
318 'cpython-32'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000319
320* Scripts that try to deduce source filename from the imported file now need to
321 be smarter. It is no longer sufficient to simply strip the "c" from a ".pyc"
322 filename. Instead, use the new functions in the :mod:`imp` module:
323
Georg Brandlda0a2112010-09-05 11:28:33 +0000324 >>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc')
325 'c:/py32/lib/collections.py'
326 >>> imp.cache_from_source('c:/py32/lib/collections.py')
327 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000328
329* The :mod:`py_compile` and :mod:`compileall` modules have been updated to
330 reflect the new naming convention and target directory.
331
Raymond Hettinger1dcc84e2011-01-17 21:55:40 +0000332* The :mod:`importlib.abc` module has been updated with new :term:`abstract base
Raymond Hettinger66352d22011-01-17 22:33:11 +0000333 classes <abstract base class>` for the loading bytecode files. The obsolete
334 ABCs, :class:`~importlib.abc.PyLoader` and
Raymond Hettinger1dcc84e2011-01-17 21:55:40 +0000335 :class:`~importlib.abc.PyPycLoader`, have been deprecated (instructions on how
Raymond Hettinger66352d22011-01-17 22:33:11 +0000336 to stay Python 3.1 compatible are included with the documentation).
Brett Cannon83a682d2011-01-16 21:02:09 +0000337
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000338.. seealso::
339
340 :pep:`3147` - PYC Repository Directories
341 PEP written by Barry Warsaw.
342
Georg Brandlda0a2112010-09-05 11:28:33 +0000343
Georg Brandl3ad46752010-12-05 07:59:29 +0000344PEP 3149: ABI Version Tagged .so Files
345======================================
Georg Brandlf11c6c42010-09-03 22:20:58 +0000346
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000347The PYC repository directory allows multiple bytecode cache files to be
348co-located. This PEP implements a similar mechanism for shared object files by
349giving them a common directory and distinct names for each version.
Georg Brandlf11c6c42010-09-03 22:20:58 +0000350
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000351The common directory is "pyshared" and the file names are made distinct by
352identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the
353major and minor version numbers, and optional build flags (such as "d" for
Éric Araujo4234ad42010-09-05 17:32:25 +0000354debug, "m" for pymalloc, "u" for wide-unicode). For an arbitrary package "foo",
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000355you may see these files when the distribution package is installed::
356
357 /usr/share/pyshared/foo.cpython-32m.so
358 /usr/share/pyshared/foo.cpython-33md.so
359
360In Python itself, the tags are accessible from functions in the :mod:`sysconfig`
361module::
362
363 >>> import sysconfig
364 >>> sysconfig.get_config_var('SOABI') # find the version tag
365 'cpython-32mu'
366 >>> sysconfig.get_config_var('SO') # find the full filename extension
367 'cpython-32mu.so'
368
369.. seealso::
370
371 :pep:`3149` - ABI Version Tagged .so Files
372 PEP written by Barry Warsaw.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000373
Raymond Hettingerca904be2011-01-18 00:02:40 +0000374
Raymond Hettinger3df46212011-01-06 02:01:26 +0000375PEP 3333: Python Web Server Gateway Interface v1.0.1
376=====================================================
377
378This informational PEP clarifies how bytes/text issues are to be handled by the
379WGSI protocol. The challenge is that string handling in Python 3 is most
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000380conveniently handled with the :class:`str` type even though the HTTP protocol
Raymond Hettinger3df46212011-01-06 02:01:26 +0000381is itself bytes oriented.
382
383The PEP differentiates so-called *native strings* that are used for
384request/response headers and metadata versus *byte strings* which are used for
385the bodies of requests and responses.
386
387The *native strings* are always of type :class:`str` but are restricted to code
Georg Brandl52a43b52011-01-16 09:11:45 +0000388points between *U+0000* through *U+00FF* which are translatable to bytes using
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000389*Latin-1* encoding. These strings are used for the keys and values in the
390environ dictionary and for response headers and statuses in the
391:func:`start_response` function. They must follow :rfc:`2616` with respect to
Raymond Hettinger3df46212011-01-06 02:01:26 +0000392encoding. That is, they must either be *ISO-8859-1* characters or use
393:rfc:`2047` MIME encoding.
394
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000395For developers porting WSGI applications from Python 2, here are the salient
396points:
397
398* If the app already used strings for headers in Python 2, no change is needed.
399
400* If instead, the app encoded output headers or decoded input headers, then the
401 headers will need to be re-encoded to Latin-1. For example, an output header
402 encoded in utf-8 was using ``h.encode('utf-8')`` now needs to convert from
403 bytes to native strings using ``h.encode('utf-8').decode('latin-1')``.
404
405* Values yielded by an application or sent using the :meth:`write` method
Raymond Hettinger51e21072011-01-10 23:38:15 +0000406 must be byte strings. The :func:`start_response` function and environ
407 must use native strings. The two cannot be mixed.
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000408
409For server implementers writing CGI-to-WSGI pathways or other CGI-style
410protocols, the users must to be able access the environment using native strings
Raymond Hettingerc136b042011-01-18 07:15:39 +0000411even though the underlying platform may have a different convention. To bridge
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000412this gap, the :mod:`wsgiref` module has a new function,
413:func:`wsgiref.handlers.read_environ` for transcoding CGI variables from
414:attr:`os.environ` into native strings and returning a new dictionary.
Raymond Hettinger3df46212011-01-06 02:01:26 +0000415
416.. seealso::
417
418 :pep:`3333` - Python Web Server Gateway Interface v1.0.1
419 PEP written by Phillip Eby.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000420
Raymond Hettingerca904be2011-01-18 00:02:40 +0000421
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000422Other Language Changes
423======================
424
425Some smaller changes made to the core Python language are:
426
Raymond Hettingere5e1a982010-12-05 08:35:21 +0000427* String formatting for :func:`format` and :meth:`str.format` gained new
428 capabilities for the format character **#**. Previously, for integers in
429 binary, octal, or hexadecimal, it caused the output to be prefixed with '0b',
430 '0o', or '0x' respectively. Now it can also handle floats, complex, and
431 Decimal, causing the output to always have a decimal point even when no digits
432 follow it.
Raymond Hettingere5e728b2010-12-05 06:35:16 +0000433
434 >>> format(20, '#o')
435 '0o24'
436 >>> format(12.34, '#5.0f')
437 ' 12.'
438
439 (Suggested by Mark Dickinson and implemented by Eric Smith in :issue:`7094`.)
Raymond Hettinger43b5a852010-12-05 04:04:21 +0000440
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000441* The interpreter can now be started with a quiet option, ``-q``, to suppress
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000442 the copyright and version information from being displayed in the interactive
443 mode. The option can be introspected using the :attr:`sys.flags` attribute::
Raymond Hettinger7d967712011-01-05 20:24:08 +0000444
445 $ python -q
446 >>> sys.flags
447 sys.flags(debug=0, division_warning=0, inspect=0, interactive=0,
448 optimize=0, dont_write_bytecode=0, no_user_site=0, no_site=0,
449 ignore_environment=0, verbose=0, bytes_warning=0, quiet=1)
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000450
Raymond Hettinger51e21072011-01-10 23:38:15 +0000451 (Contributed by Marcin Wojdyr in :issue:`1772833`).
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000452
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000453* The :func:`hasattr` function works by calling :func:`getattr` and detecting
454 whether an exception is raised. This technique allows it to detect methods
455 created dynamically by :meth:`__getattr__` or :meth:`__getattribute__` which
Raymond Hettinger90a4b312011-01-06 02:08:30 +0000456 would otherwise be absent from the class dictionary. Formerly, *hasattr*
457 would catch any exception, possibly masking genuine errors. Now, *hasattr*
458 has been tightened to only catch :exc:`AttributeError` and let other
459 exceptions pass through.
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000460
Raymond Hettingera55ffbc2010-12-15 18:31:57 +0000461 (Discovered by Yury Selivanov and fixed by Benjamin Peterson; :issue:`9666`.)
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000462
Éric Araujo4234ad42010-09-05 17:32:25 +0000463* The :func:`str` of a float or complex number is now the same as its
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000464 :func:`repr`. Previously, the :func:`str` form was shorter but that just
Éric Araujo4234ad42010-09-05 17:32:25 +0000465 caused confusion and is no longer needed now that the shortest possible
Georg Brandlda0a2112010-09-05 11:28:33 +0000466 :func:`repr` is displayed by default:
Raymond Hettingerbb734c62010-09-05 05:56:44 +0000467
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000468 >>> repr(math.pi)
469 '3.141592653589793'
470 >>> str(math.pi)
471 '3.141592653589793'
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000472
Georg Brandlda0a2112010-09-05 11:28:33 +0000473 (Proposed and implemented by Mark Dickinson; :issue:`9337`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000474
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +0000475* :class:`memoryview` objects now have a :meth:`~memoryview.release()` method
476 and they also now support the context manager protocol. This allows timely
477 release of any resources that were acquired when requesting a buffer from the
478 original object.
Antoine Pitroud3052002010-09-15 15:09:40 +0000479
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000480 >>> with memoryview(b'abcdefgh') as v:
481 ... print(v.tolist())
482 ...
483 [97, 98, 99, 100, 101, 102, 103, 104]
484
Antoine Pitroud3052002010-09-15 15:09:40 +0000485 (Added by Antoine Pitrou; :issue:`9757`.)
486
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000487* Previously it was illegal to delete a name from the local namespace if it
488 occurs as a free variable in a nested block::
489
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000490 def outer(x):
491 def inner():
492 return x
493 inner()
494 del x
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000495
496 This is now allowed. Remember that the target of an :keyword:`except` clause
497 is cleared, so this code which used to work with Python 2.6, raised a
498 :exc:`SyntaxError` with Python 3.1 and now works again::
499
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000500 def f():
501 def print_error():
502 print(e)
503 try:
504 something
505 except Exception as e:
506 print_error()
507 # implicit "del e" here
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000508
509 (See :issue:`4617`.)
510
Raymond Hettinger480ed782010-12-15 22:07:15 +0000511* The internal :c:type:`structsequence` tool now creates subclasses of tuple.
Raymond Hettinger51e21072011-01-10 23:38:15 +0000512 This means that C structures like those returned by :func:`os.stat`,
Raymond Hettinger480ed782010-12-15 22:07:15 +0000513 :func:`time.gmtime`, and :func:`sys.version_info` now work like a
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000514 :term:`named tuple` and now work with functions and methods that
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000515 expect a tuple as an argument. This is a big step forward in making the C
Raymond Hettinger480ed782010-12-15 22:07:15 +0000516 structures as flexible as their pure Python counterparts.
517
518 (Suggested by Arfrever Frehtes Taifersar Arahesis and implemented
519 by Benjamin Peterson in :issue:`8413`.)
520
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000521* Warnings are now easier to control using the :envvar:`PYTHONWARNINGS`
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000522 environment variable as an alternative to using ``-W`` at the command line.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000523
524 (Suggested by Barry Warsaw and implemented by Philip Jenvey in :issue:`7301`.)
525
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000526* A new warning category, :exc:`ResourceWarning`, has been added. It is
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000527 emitted when potential issues with resource consumption or cleanup
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000528 are detected. It is silenced by default in normal release builds but
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000529 can be enabled through the means provided by the :mod:`warnings`
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000530 module, or on the command line.
531
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000532 A :exc:`ResourceWarning` is issued at interpreter shutdown if the
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000533 :data:`gc.garbage` list isn't empty. This is meant to make the programmer
534 aware that their code contains object finalization issues.
535
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000536 A :exc:`ResourceWarning` is also issued when a :term:`file object` is destroyed
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000537 without having been explicitly closed. While the deallocator for such
538 object ensures it closes the underlying operating system resource
539 (usually, a file descriptor), the delay in deallocating the object could
540 produce various issues, especially under Windows. Here is an example
541 of enabling the warning from the command line::
542
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000543 $ python -q -Wdefault
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000544 >>> f = open("foo", "wb")
545 >>> del f
546 __main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000547
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000548 (Added by Antoine Pitrou and Georg Brandl in :issue:`10093` and :issue:`477863`.)
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000549
Raymond Hettingera0266332010-12-07 08:52:41 +0000550* :class:`range` objects now support *index* and *count* methods. This is part
551 of an effort to make more objects fully implement the
552 :class:`collections.Sequence` :term:`abstract base class`. As a result, the
553 language will have a more uniform API. In addition, :class:`range` objects
Raymond Hettingerb9656292011-01-16 18:22:06 +0000554 now support slicing and negative indices, even with values larger than
555 :attr:`sys.maxsize`. This makes *range* more interoperable with lists::
Raymond Hettinger2ffa6712010-12-08 10:18:21 +0000556
557 >>> range(0, 100, 2).count(10)
558 1
559 >>> range(0, 100, 2).index(10)
560 5
561 >>> range(0, 100, 2)[5]
562 10
563 >>> range(0, 100, 2)[0:5]
564 range(0, 10, 2)
Raymond Hettingerdadf93c2010-12-05 02:56:21 +0000565
Raymond Hettingerb9656292011-01-16 18:22:06 +0000566 (Contributed by Daniel Stutzbach in :issue:`9213`, by Alexander Belopolsky
567 in :issue:`2690`, and by Nick Coghlan in :issue:`10889`.)
Nick Coghlan37ee8502010-12-03 14:26:13 +0000568
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000569* The :func:`callable` builtin function from Py2.x was resurrected. It provides
Raymond Hettingerb87ba262010-12-06 04:31:40 +0000570 a concise, readable alternative to using an :term:`abstract base class` in an
Raymond Hettinger792c0762010-12-09 16:41:54 +0000571 expression like ``isinstance(x, collections.Callable)``:
572
573 >>> callable(max)
574 True
575 >>> callable(20)
576 False
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000577
578 (See :issue:`10518`.)
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000579
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000580* Python's import mechanism can now load modules installed in directories with
Raymond Hettinger070ec702010-12-10 17:45:13 +0000581 non-ASCII characters in the path name.
582
583 (Required extensive work by Victor Stinner in :issue:`9425`.)
584
585
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000586New, Improved, and Deprecated Modules
587=====================================
588
Raymond Hettinger99db3fd2010-12-15 19:33:49 +0000589Python's standard library has undergone significant maintenance efforts and
590quality improvements.
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000591
592The biggest news for Python 3.2 is that the :mod:`email` package and
Raymond Hettinger99db3fd2010-12-15 19:33:49 +0000593:mod:`nntplib` modules now work correctly with the bytes/text model in Python 3.
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000594For the first time, there is correct handling of inputs with mixed encodings.
595
Raymond Hettinger6046e222010-12-16 00:21:08 +0000596Throughout the standard library, there has been more careful attention to
597encodings and text versus bytes issues. In particular, interactions with the
598operating system are now better able to pass non-ASCII data using the Windows
Raymond Hettingerba5512f2011-01-18 08:28:01 +0000599MBCS encoding, locale-aware encodings, or UTF-8.
Raymond Hettinger6046e222010-12-16 00:21:08 +0000600
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000601Another significant win is the addition of substantially better support for
602*SSL* connections and security certificates.
603
Raymond Hettinger51e21072011-01-10 23:38:15 +0000604In addition, more classes now implement a :term:`context manager` to support
Raymond Hettingerc136b042011-01-18 07:15:39 +0000605convenient and reliable resource clean-up using a :keyword:`with` statement.
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000606
Raymond Hettinger0358a172010-12-15 19:00:38 +0000607email
608-----
609
610The usability of the :mod:`email` package in Python 3 has been mostly fixed by
611the extensive efforts of R. David Murray. The problem was that emails are
612typically read and stored in the form of :class:`bytes` rather than :class:`str`
613text, and they may contain multiple encodings within a single email. So, the
614email package had to be extended to parse and generate email messages in bytes
615format.
616
617* New functions :func:`~email.message_from_bytes` and
618 :func:`~email.message_from_binary_file`, and new classes
619 :class:`~email.parser.BytesFeedParser` and :class:`~email.parser.BytesParser`
620 allow binary message data to be parsed into model objects.
621
622* Given bytes input to the model, :meth:`~email.message.Message.get_payload`
623 will by default decode a message body that has a
624 :mailheader:`Content-Transfer-Encoding` of *8bit* using the charset
625 specified in the MIME headers and return the resulting string.
626
627* Given bytes input to the model, :class:`~email.generator.Generator` will
628 convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of
629 *8bit* to instead have a *7bit* :mailheader:`Content-Transfer-Encoding`.
Raymond Hettingerc08ea612011-01-08 10:32:31 +0000630
Raymond Hettingercf8a3822011-01-11 21:20:20 +0000631 Headers with unencoded non-ASCII bytes are deemed to be :rfc:`2047`\ -encoded
632 using the *unknown-8bit* character set.
Raymond Hettinger0358a172010-12-15 19:00:38 +0000633
634* A new class :class:`~email.generator.BytesGenerator` produces bytes as output,
635 preserving any unchanged non-ASCII data that was present in the input used to
636 build the model, including message bodies with a
637 :mailheader:`Content-Transfer-Encoding` of *8bit*.
638
639* The :mod:`smtplib` :class:`~smtplib.SMTP` class now accepts a byte string
640 for the *msg* argument to the :meth:`~smtplib.SMTP.sendmail` method,
641 and a new method, :meth:`~smtplib.SMTP.send_message` accepts a
642 :class:`~email.message.Message` object and can optionally obtain the
643 *from_addr* and *to_addrs* addresses directly from the object.
644
Raymond Hettinger0358a172010-12-15 19:00:38 +0000645(Proposed and implemented by R. David Murray, :issue:`4661` and :issue:`10321`.)
646
Raymond Hettinger6046e222010-12-16 00:21:08 +0000647elementtree
648-----------
649
Georg Brandl5d53fdd2010-12-18 11:58:12 +0000650The :mod:`xml.etree.ElementTree` package and its :mod:`xml.etree.cElementTree`
Raymond Hettinger6046e222010-12-16 00:21:08 +0000651counterpart have been updated to version 1.3.
652
653Several new and useful functions and methods have been added:
654
655* :func:`xml.etree.ElementTree.fromstringlist` which builds an XML document
656 from a sequence of fragments
657* :func:`xml.etree.ElementTree.register_namespace` for registering a global
658 namespace prefix
659* :func:`xml.etree.ElementTree.tostringlist` for string representation
660 including all sublists
661* :meth:`xml.etree.ElementTree.Element.extend` for appending a sequence of zero
662 or more elements
663* :meth:`xml.etree.ElementTree.Element.iterfind` searches an element and
664 subelements
665* :meth:`xml.etree.ElementTree.Element.itertext` creates a text iterator over
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000666 an element and its subelements
Raymond Hettinger6046e222010-12-16 00:21:08 +0000667* :meth:`xml.etree.ElementTree.TreeBuilder.end` closes the current element
668* :meth:`xml.etree.ElementTree.TreeBuilder.doctype` handles a doctype
669 declaration
670
671Two methods have been deprecated:
672
673* :meth:`xml.etree.ElementTree.getchildren` use ``list(elem)`` instead.
674* :meth:`xml.etree.ElementTree.getiterator` use ``Element.iter`` instead.
675
676For details of the update, see `Introducing ElementTree
677<http://effbot.org/zone/elementtree-13-intro.htm>`_ on Fredrik Lundh's website.
678
Antoine Pitrou12de8ac2010-12-16 13:33:56 +0000679(Contributed by Florent Xicluna and Fredrik Lundh, :issue:`6472`.)
Raymond Hettinger0358a172010-12-15 19:00:38 +0000680
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000681functools
682---------
683
Éric Araujo4234ad42010-09-05 17:32:25 +0000684* The :mod:`functools` module includes a new decorator for caching function
Georg Brandlda0a2112010-09-05 11:28:33 +0000685 calls. :func:`functools.lru_cache` can save repeated queries to an external
686 resource whenever the results are expected to be the same.
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000687
Raymond Hettinger86f96132010-08-06 23:23:49 +0000688 For example, adding a caching decorator to a database query function can save
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000689 database accesses for popular searches:
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000690
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000691 >>> @functools.lru_cache(maxsize=300)
692 >>> def get_phone_number(name):
693 c = conn.cursor()
694 c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,))
695 return c.fetchone()[0]
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000696
Georg Brandlda0a2112010-09-05 11:28:33 +0000697 >>> for name in user_requests:
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000698 get_phone_number(name) # cached lookup
Raymond Hettinger7496b412010-11-30 19:15:45 +0000699
700 To help with choosing an effective cache size, the wrapped function is
701 instrumented for tracking cache statistics:
702
Raymond Hettinger5e20bab2010-11-30 07:13:04 +0000703 >>> get_phone_number.cache_info()
Raymond Hettinger7496b412010-11-30 19:15:45 +0000704 CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300)
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000705
Raymond Hettingerf3098282010-08-15 03:30:45 +0000706 If the phonelist table gets updated, the outdated contents of the cache can be
Georg Brandlda0a2112010-09-05 11:28:33 +0000707 cleared with:
Raymond Hettingerf3098282010-08-15 03:30:45 +0000708
Georg Brandlda0a2112010-09-05 11:28:33 +0000709 >>> get_phone_number.cache_clear()
Raymond Hettingerf3098282010-08-15 03:30:45 +0000710
Raymond Hettinger6e353942010-12-04 23:42:12 +0000711 (Contributed by Raymond Hettinger and incorporating design ideas from
Raymond Hettingerb87ba262010-12-06 04:31:40 +0000712 Jim Baker, Miki Tebeka, and Nick Coghlan.)
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000713
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000714* The :func:`functools.wraps` decorator now adds a :attr:`__wrapped__` attribute
715 pointing to the original callable function. This allows wrapped functions to
716 be introspected. It also copies :attr:`__annotations__` if defined. And now
717 it also gracefully skips over missing attributes such as :attr:`__doc__` which
Raymond Hettinger5eb63902010-12-09 23:43:34 +0000718 might not be defined for the wrapped callable.
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000719
720 (By Nick Coghlan and Terrence Cole; :issue:`9567`, :issue:`3445`, and
721 :issue:`8814`.)
722
Raymond Hettinger6046e222010-12-16 00:21:08 +0000723* To help write classes with rich comparison methods, a new decorator
724 :func:`functools.total_ordering` will use a existing equality and inequality
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000725 methods to fill in the remaining methods.
Raymond Hettinger6046e222010-12-16 00:21:08 +0000726
727 For example, supplying *__eq__* and *__lt__* will enable
728 :func:`~functools.total_ordering` to fill-in *__le__*, *__gt__* and *__ge__*::
729
730 @total_ordering
731 class Student:
732 def __eq__(self, other):
733 return ((self.lastname.lower(), self.firstname.lower()) ==
734 (other.lastname.lower(), other.firstname.lower()))
735 def __lt__(self, other):
736 return ((self.lastname.lower(), self.firstname.lower()) <
737 (other.lastname.lower(), other.firstname.lower()))
738
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000739 With the *total_ordering* decorator, the remaining comparison methods
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000740 are filled in automatically.
Raymond Hettinger6046e222010-12-16 00:21:08 +0000741
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000742 (Contributed by Raymond Hettinger.)
Raymond Hettingerf35a34c2010-12-22 09:11:54 +0000743
Raymond Hettinger4bea9782011-01-19 04:14:34 +0000744* To aid in porting programs from Python 2, the :func:`functools.cmp_to_key`
Raymond Hettingerbb9686f2010-12-16 00:53:05 +0000745 function converts an old-style comparison function to
Raymond Hettinger6046e222010-12-16 00:21:08 +0000746 modern :term:`key function`:
747
748 >>> # locale-aware sort order
749 >>> sorted(iterable, key=cmp_to_key(locale.strcoll))
750
751 For sorting examples and a brief sorting tutorial, see the `Sorting HowTo
752 <http://wiki.python.org/moin/HowTo/Sorting/>`_ tutorial.
753
754 (Contributed by Raymond Hettinger.)
755
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000756itertools
757---------
758
Raymond Hettinger673ccf22010-12-07 09:37:11 +0000759* The :mod:`itertools` module has a new :func:`~itertools.accumulate` function
Raymond Hettinger4bea9782011-01-19 04:14:34 +0000760 modeled on APL's *scan* operator and Numpy's *accumulate* function:
Raymond Hettinger6e353942010-12-04 23:42:12 +0000761
762 >>> list(accumulate(8, 2, 50))
763 [8, 10, 60]
764
765 >>> prob_dist = [0.1, 0.4, 0.2, 0.3]
766 >>> list(accumulate(prob_dist)) # cumulative probability distribution
767 [0.1, 0.5, 0.7, 1.0]
768
769 For an example using :func:`~itertools.accumulate`, see the :ref:`examples for
770 the random module <random-examples>`.
771
772 (Contributed by Raymond Hettinger and incorporating design suggestions
773 from Mark Dickinson.)
774
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000775collections
776-----------
777
Raymond Hettinger792c0762010-12-09 16:41:54 +0000778* The :class:`collections.Counter` class now has two forms of in-place
779 subtraction, the existing *-=* operator for `saturating subtraction
780 <http://en.wikipedia.org/wiki/Saturation_arithmetic>`_ and the new
781 :meth:`~collections.Counter.subtract` method for regular subtraction. The
782 former is suitable for `multisets <http://en.wikipedia.org/wiki/Multiset>`_
Raymond Hettingerffad35e2010-12-14 21:12:03 +0000783 which only have positive counts, and the latter is more suitable for use cases
Raymond Hettinger792c0762010-12-09 16:41:54 +0000784 that allow negative counts:
Alexander Belopolsky72572312010-12-08 21:21:56 +0000785
Raymond Hettinger792c0762010-12-09 16:41:54 +0000786 >>> tally = Counter(dogs=5, cat=3)
787 >>> tally -= Counter(dogs=2, cats=8) # saturating subtraction
788 >>> tally
789 Counter({'dogs': 3})
Alexander Belopolsky72572312010-12-08 21:21:56 +0000790
Raymond Hettinger792c0762010-12-09 16:41:54 +0000791 >>> tally = Counter(dogs=5, cats=3)
792 >>> tally.subtract(dogs=2, cats=8) # regular subtraction
793 >>> tally
794 Counter({'dogs': 3, 'cats': -5})
Alexander Belopolsky72572312010-12-08 21:21:56 +0000795
Raymond Hettinger792c0762010-12-09 16:41:54 +0000796 (Contributed by Raymond Hettinger.)
Alexander Belopolsky72572312010-12-08 21:21:56 +0000797
Raymond Hettingere0a96002010-12-15 17:54:13 +0000798* The :class:`collections.OrderedDict` class has a new method
799 :meth:`~collections.OrderedDict.move_to_end` which takes an existing key and
Raymond Hettinger23ab1012011-01-18 20:25:04 +0000800 moves it to either the first or last position in the ordered sequence.
801
802 The default is to move an item to the last position. This is equivalent of
803 renewing an entry with ``od[k] = od.pop(k)``.
804
805 A fast move-to-end operation is useful for resequencing entries. For example,
806 an ordered dictionary can being used to track access order by aging entries
807 from oldest to most recently accessed.
Raymond Hettingere0a96002010-12-15 17:54:13 +0000808
809 >>> d = OrderedDict.fromkeys(['a', 'b', 'X', 'd', 'e'])
810 >>> list(d)
811 ['a', 'b', 'X', 'd', 'e']
Raymond Hettinger23ab1012011-01-18 20:25:04 +0000812 >>> d.move_to_end('X')
Raymond Hettingere0a96002010-12-15 17:54:13 +0000813 >>> list(d)
814 ['a', 'b', 'd', 'e', 'X']
Raymond Hettingere0a96002010-12-15 17:54:13 +0000815
Raymond Hettinger6046e222010-12-16 00:21:08 +0000816 (Contributed by Raymond Hettinger.)
817
Raymond Hettinger7ec790d2011-01-18 00:19:30 +0000818* The :class:`collections.deque` class grew two new methods
819 :meth:`~collections.deque.count` and :meth:`~collections.deque.reverse` that
820 make them more substitutable for :class:`list` objects:
Raymond Hettinger6046e222010-12-16 00:21:08 +0000821
822 >>> d = deque('simsalabim')
823 >>> d.count('s')
824 2
825 >>> d.reverse()
826 >>> d
827 deque(['m', 'i', 'b', 'a', 'l', 'a', 's', 'm', 'i', 's'])
828
829 (Contributed by Raymond Hettinger.)
830
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000831threading
832---------
833
834The :mod:`threading` module has a new :class:`~threading.Barrier`
835synchronization class for making multiple threads wait until all of them have
836reached a common barrier point. Barriers are useful for making sure that a task
837with multiple preconditions does not run until all of the predecessor tasks are
838complete.
839
840Barriers can work with an arbitrary number of threads. This is a generalization
841of a `Rendezvous <http://en.wikipedia.org/wiki/Synchronous_rendezvous>`_ which
842is defined for only two threads.
843
Raymond Hettinger15b47c52011-01-17 21:05:07 +0000844Implemented as a two-phase cyclic barrier, :class:`~threading.Barrier` objects
845are suitable for use in loops. The separate *filling* and *draining* phases
Raymond Hettingere0f1f322011-01-18 21:14:27 +0000846assure that all threads get released (drained) before any one of them can loop
847back and re-enter the barrier. The barrier fully resets after each cycle.
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000848
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000849Example of using barriers::
850
851 def get_votes(site):
852 ballots = conduct_election(site)
853 all_polls_closed.wait() # do not count until all polls are closed
Raymond Hettinger97673652011-01-11 21:13:26 +0000854 totals = summarize(ballots)
855 publish(site, totals)
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000856
857 all_polls_closed = Barrier(len(sites))
Raymond Hettinger3a8ae5f2011-01-11 20:51:45 +0000858 for site in sites:
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000859 Thread(target=get_votes, args=(site,)).start()
860
861In this example, the barrier enforces a rule that votes cannot be counted at any
862polling site until all polls are closed. Notice how a solution with a barrier
863is similar to one with :meth:`threading.Thread.join`, but the threads stay alive
864and continue to do work (summarizing ballots) after the barrier point is
865crossed.
866
Raymond Hettinger2c3865b2011-01-18 22:58:33 +0000867If any of the predecessor tasks can hang or be delayed, a barrier can be created
868with an optional *timeout* parameter. Then if the timeout period elapses before
869all the predecessor tasks reach the barrier point, all waiting threads are
870released and a :exc:`~threading.BrokenBarrierError` exception is raised::
871
872 def get_votes(site):
873 ballots = conduct_election(site)
874 try:
875 all_polls_closed.wait(timeout = midnight - time.now())
David Malcolm49348642011-01-18 23:45:53 +0000876 except BrokenBarrierError:
Raymond Hettinger2c3865b2011-01-18 22:58:33 +0000877 lockbox = seal_ballots(ballots)
878 queue.put(lockbox)
879 else:
880 totals = summarize(ballots)
881 publish(site, totals)
882
883In this example, the barrier enforces a more robust rule. If some election
884sites do not finish before midnight, the barrier times-out and the ballots are
885sealed and deposited in a queue for later handling.
886
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000887See `Barrier Synchronization Patterns
Raymond Hettinger3a8ae5f2011-01-11 20:51:45 +0000888<http://parlab.eecs.berkeley.edu/wiki/_media/patterns/paraplop_g1_3.pdf>`_ for
889more examples of how barriers can be used in parallel computing. Also, there is
890a simple but thorough explanation of barriers in `The Little Book of Semaphores
891<http://greenteapress.com/semaphores/downey08semaphores.pdf>`_, *section 3.6*.
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000892
Raymond Hettinger3a8ae5f2011-01-11 20:51:45 +0000893(Contributed by Kristján Valur Jónsson with an API review by Jeffrey Yasskin in
894:issue:`8777`.)
Raymond Hettinger6655d112011-01-11 08:49:10 +0000895
Raymond Hettinger97673652011-01-11 21:13:26 +0000896datetime and time
897-----------------
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000898
Raymond Hettinger792c0762010-12-09 16:41:54 +0000899* The :mod:`datetime` module has a new type :class:`~datetime.timezone` that
900 implements the :class:`~datetime.tzinfo` interface by returning a fixed UTC
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000901 offset and timezone name. This makes it easier to create timezone-aware
Raymond Hettinger792c0762010-12-09 16:41:54 +0000902 datetime objects:
Alexander Belopolsky72572312010-12-08 21:21:56 +0000903
Raymond Hettinger792c0762010-12-09 16:41:54 +0000904 >>> datetime.now(timezone.utc)
905 datetime.datetime(2010, 12, 8, 21, 4, 2, 923754, tzinfo=datetime.timezone.utc)
Alexander Belopolsky72572312010-12-08 21:21:56 +0000906
Raymond Hettinger792c0762010-12-09 16:41:54 +0000907 >>> datetime.strptime("01/01/2000 12:00 +0000", "%m/%d/%Y %H:%M %z")
908 datetime.datetime(2000, 1, 1, 12, 0, tzinfo=datetime.timezone.utc)
Alexander Belopolsky72572312010-12-08 21:21:56 +0000909
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000910* Also, :class:`~datetime.timedelta` objects can now be multiplied by
Raymond Hettinger792c0762010-12-09 16:41:54 +0000911 :class:`float` and divided by :class:`float` and :class:`int` objects.
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000912 And :class:`~datetime.timedelta` objects can now divide one another.
Raymond Hettinger792c0762010-12-09 16:41:54 +0000913
Raymond Hettingerca904be2011-01-18 00:02:40 +0000914* The :meth:`datetime.date.strftime` method is no longer restricted to years
915 after 1900. The new supported year range is from 1000 to 9999 inclusive.
Alexander Belopolsky72572312010-12-08 21:21:56 +0000916
Raymond Hettinger97673652011-01-11 21:13:26 +0000917* The rules for two-digit years in time tuples have changed. Now, the
918 :func:`time.asctime` and :func:`time.strftime` functions will format any year
919 when :attr:`time.accept2dyear` is false and will accept four-digit years
920 otherwise. The :func:`time.mktime` and :func:`time.strftime` functions now
921 accept full range supported by the operating system. Conversion of two-digit
922 years to four-digit is deprecated.
Alexander Belopolskybd96b062011-01-10 21:55:34 +0000923
Raymond Hettinger97673652011-01-11 21:13:26 +0000924(Contributed by Alexander Belopolsky and Victor Stinner.)
Alexander Belopolskybd96b062011-01-10 21:55:34 +0000925
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000926abc
927---
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000928
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000929The :mod:`abc` module now supports :func:`~abc.abstractclassmethod` and
930:func:`~abc.abstractstaticmethod`.
Raymond Hettingera5a35542010-12-05 00:39:18 +0000931
Raymond Hettinger7ec790d2011-01-18 00:19:30 +0000932These tools make it possible to define an :term:`abstract base class` that
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000933requires a particular :func:`classmethod` or :func:`staticmethod` to be
Raymond Hettinger7ec790d2011-01-18 00:19:30 +0000934implemented::
935
936 class Temperature(metaclass=ABCMeta):
937 @abc.abstractclassmethod
938 def from_farenheit(self, t):
939 ...
940 @abc.abstractclassmethod
941 def from_celsium(self, t):
942 ...
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000943
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000944(Patch submitted by Daniel Urban; :issue:`5867`.)
Raymond Hettingerbcbd6962010-09-05 08:46:36 +0000945
Raymond Hettinger480ed782010-12-15 22:07:15 +0000946contextlib
947----------
948
949There is a new and slightly mind-blowing tool
950:class:`~contextlib.ContextDecorator` that is helpful for creating a
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000951:term:`context manager` that does double duty as a function decorator.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000952
953As a convenience, this new functionality is used by
954:func:`~contextlib.contextmanager` so that no extra effort is needed to support
955both roles.
956
957The basic idea is that both context managers and function decorators can be used
958for pre-action and post-action wrappers. Context managers wrap a group of
Raymond Hettingerc136b042011-01-18 07:15:39 +0000959statements using a :keyword:`with` statement, and function decorators wrap a
Raymond Hettinger480ed782010-12-15 22:07:15 +0000960group of statements enclosed in a function. So, occasionally there is a need to
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000961write a pre-action or post-action wrapper that can be used in either role.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000962
963For example, it is sometimes useful to wrap functions or groups of statements
964with a logger that can track the time of entry and time of exit. Rather than
965writing both a function decorator and a context manager for the task, the
966:func:`~contextlib.contextmanager` provides both capabilities in a single
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000967definition::
Raymond Hettinger480ed782010-12-15 22:07:15 +0000968
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000969 import logging
970 logging.basicConfig(level=logging.INFO)
971 @contextmanager
972 def track_entry_and_exit(name):
973 logging.info('Entering: {}'.format(name))
974 yield
975 logging.info('Exiting: {}'.format(name))
Raymond Hettinger480ed782010-12-15 22:07:15 +0000976
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000977Formerly, this would have only been usable as a context manager::
Raymond Hettinger480ed782010-12-15 22:07:15 +0000978
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000979 with track_entry_and_exit('widget loader'):
980 print('Some time consuming activity goes here')
981 load_widget()
Raymond Hettinger480ed782010-12-15 22:07:15 +0000982
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000983Now, it can be used as a decorator as well::
Raymond Hettinger480ed782010-12-15 22:07:15 +0000984
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000985 @track_entry_and_exit('widget loader')
986 def activity():
987 print('Some time consuming activity goes here')
988 load_widget()
Raymond Hettinger480ed782010-12-15 22:07:15 +0000989
990Trying to fulfill two roles at once places some limitations on the technique.
991Context managers normally have the flexibility to return an argument usable by
Raymond Hettingerc136b042011-01-18 07:15:39 +0000992a :keyword:`with` statement, but there is no parallel for function decorators.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000993
Raymond Hettinger9743e4f2010-12-16 02:24:12 +0000994In the above example, there is not a clean way for the *track_entry_and_exit*
Raymond Hettinger388af4b2011-01-06 20:55:29 +0000995context manager to return a logging instance for use in the body of enclosed
996statements.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000997
998(Contributed by Michael Foord in :issue:`9110`.)
999
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001000decimal and fractions
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001001---------------------
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001002
1003Mark Dickinson crafted an elegant and efficient scheme for assuring that
1004different numeric datatypes will have the same hash value whenever their actual
1005values are equal (:issue:`8188`)::
1006
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001007 assert hash(Fraction(3, 2)) == hash(1.5) == \
1008 hash(Decimal("1.5")) == hash(complex(1.5, 0))
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001009
1010An early decision to limit the inter-operability of various numeric types has
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001011been relaxed. It is still unsupported (and ill-advised) to have implicit
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001012mixing in arithmetic expressions such as ``Decimal('1.1') + float('1.1')``
1013because the latter loses information in the process of constructing the binary
1014float. However, since existing floating point value can be converted losslessly
1015to either a decimal or rational representation, it makes sense to add them to
1016the constructor and to support mixed-type comparisons.
1017
Raymond Hettingerbb9686f2010-12-16 00:53:05 +00001018* The :class:`decimal.Decimal` constructor now accepts :class:`float` objects
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001019 directly so there in no longer a need to use the :meth:`~decimal.Decimal.from_float`
Raymond Hettinger6046e222010-12-16 00:21:08 +00001020 method (:issue:`8257`).
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001021
1022* Mixed type comparisons are now fully supported so that
1023 :class:`~decimal.Decimal` objects can be directly compared with :class:`float`
Raymond Hettinger6046e222010-12-16 00:21:08 +00001024 and :class:`fractions.Fraction` (:issue:`2531` and :issue:`8188`).
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001025
1026Similar changes were made to :class:`fractions.Fraction` so that the
1027:meth:`~fractions.Fraction.from_float()` and :meth:`~fractions.Fraction.from_decimal`
Raymond Hettinger6046e222010-12-16 00:21:08 +00001028methods are no longer needed (:issue:`8294`):
1029
1030>>> Decimal(1.1)
1031Decimal('1.100000000000000088817841970012523233890533447265625')
1032>>> Fraction(1.1)
1033Fraction(2476979795053773, 2251799813685248)
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001034
1035Another useful change for the :mod:`decimal` module is that the
1036:attr:`Context.clamp` attribute is now public. This is useful in creating
1037contexts that correspond to the decimal interchange formats specified in IEEE
1038754 (see :issue:`8540`).
1039
Raymond Hettinger6046e222010-12-16 00:21:08 +00001040(Contributed by Mark Dickinson and Raymond Hettinger.)
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001041
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001042ftp
1043---
Raymond Hettingerbcbd6962010-09-05 08:46:36 +00001044
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001045The :class:`ftplib.FTP` class now supports the context manager protocol to
1046unconditionally consume :exc:`socket.error` exceptions and to close the FTP
1047connection when done::
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +00001048
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001049 >>> from ftplib import FTP
1050 >>> with FTP("ftp1.at.proftpd.org") as ftp:
1051 ... ftp.login()
1052 ... ftp.dir()
1053 ...
1054 '230 Anonymous login ok, restrictions apply.'
1055 dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .
1056 dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 ..
1057 dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS
1058 dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora
Georg Brandlda0a2112010-09-05 11:28:33 +00001059
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001060Other file-like objects such as :class:`mmap.mmap` and :func:`fileinput.input`
1061also grew auto-closing context managers::
1062
1063 with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
1064 for line in f:
1065 process(line)
1066
1067(Contributed by Tarek Ziadé and Giampaolo Rodolà in :issue:`4972`, and
1068by Georg Brandl in :issue:`8046` and :issue:`1286`.)
Antoine Pitrou696e0352010-08-08 22:18:46 +00001069
Antoine Pitroubcba4342011-01-16 18:29:34 +00001070The :class:`~ftplib.FTP_TLS` class now accepts a *context* parameter, which is a
1071:class:`ssl.SSLContext` object allowing bundling SSL configuration options,
Raymond Hettinger4854d142011-01-17 21:29:58 +00001072certificates and private keys into a single (potentially long-lived) structure.
Antoine Pitroubcba4342011-01-16 18:29:34 +00001073
1074(Contributed by Giampaolo Rodolà; :issue:`8806`.)
1075
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001076popen
1077-----
1078
1079The :func:`os.popen` and :func:`subprocess.Popen` functions now support
Raymond Hettingerc136b042011-01-18 07:15:39 +00001080:keyword:`with` statements for auto-closing of the file descriptors.
Georg Brandl3ad46752010-12-05 07:59:29 +00001081
Raymond Hettinger6046e222010-12-16 00:21:08 +00001082gzip and zipfile
1083----------------
Antoine Pitroucd889af2010-10-06 21:13:56 +00001084
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001085:class:`gzip.GzipFile` now implements the :class:`io.BufferedIOBase`
1086:term:`abstract base class` (except for ``truncate()``). It also has a
1087:meth:`~gzip.GzipFile.peek` method and supports unseekable as well as
1088zero-padded file objects.
Raymond Hettingera0266332010-12-07 08:52:41 +00001089
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001090The :mod:`gzip` module also gains the :func:`~gzip.compress` and
1091:func:`~gzip.decompress` functions for easier in-memory compression and
Raymond Hettinger51e21072011-01-10 23:38:15 +00001092decompression. Keep in mind that text needs to be encoded as :class:`bytes`
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001093before compressing and decompressing:
Raymond Hettingera0266332010-12-07 08:52:41 +00001094
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001095>>> s = 'Three shall be the number thou shalt count, '
1096>>> s += 'and the number of the counting shall be three'
1097>>> b = s.encode() # convert to utf-8
1098>>> len(b)
109989
1100>>> c = gzip.compress(b)
1101>>> len(c)
110277
1103>>> gzip.decompress(c).decode()[:42] # decompress and convert to text
1104'Three shall be the number thou shalt count,'
Antoine Pitroucd889af2010-10-06 21:13:56 +00001105
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001106(Contributed by Anand B. Pillai in :issue:`3488`; and by Antoine Pitrou, Nir
1107Aides and Brian Curtin in :issue:`9962`, :issue:`1675951`, :issue:`7471` and
1108:issue:`2846`.)
1109
Raymond Hettinger6046e222010-12-16 00:21:08 +00001110Also, the :class:`zipfile.ZipExtFile` class was reworked internally to represent
1111files stored inside an archive. The new implementation is significantly faster
1112and can be wrapped in a :class:`io.BufferedReader` object for more speedups. It
1113also solves an issue where interleaved calls to *read* and *readline* gave the
1114wrong results.
1115
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001116(Patch submitted by Nir Aides in :issue:`7610`.)
Raymond Hettinger6046e222010-12-16 00:21:08 +00001117
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001118shutil
1119------
1120
1121The :func:`shutil.copytree` function has two new options:
Antoine Pitroud67075e2010-07-31 22:48:02 +00001122
Antoine Pitrou121a0552011-01-16 18:16:52 +00001123* *ignore_dangling_symlinks*: when ``symlinks=False`` so that the function
Raymond Hettingerc136b042011-01-18 07:15:39 +00001124 copies a file pointed to by a symlink, not the symlink itself. This option
1125 will silence the error raised if the file doesn't exist.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001126
Antoine Pitrou121a0552011-01-16 18:16:52 +00001127* *copy_function*: is a callable that will be used to copy files.
1128 :func:`shutil.copy2` is used by default.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001129
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001130(Contributed by Tarek Ziadé.)
Antoine Pitroud67075e2010-07-31 22:48:02 +00001131
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001132sqlite3
1133-------
Antoine Pitroue43f9d02010-08-08 23:24:50 +00001134
Raymond Hettinger6046e222010-12-16 00:21:08 +00001135The :mod:`sqlite3` module was updated to version 2.6.0. It has two new capabilities.
Antoine Pitroue43f9d02010-08-08 23:24:50 +00001136
Raymond Hettinger0358a172010-12-15 19:00:38 +00001137* The :attr:`sqlite3.Connection.in_transit` attribute is true if there is an
1138 active transaction for uncommitted changes.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001139
Raymond Hettinger0358a172010-12-15 19:00:38 +00001140* The :meth:`sqlite3.Connection.enable_load_extension` and
1141 :meth:`sqlite3.Connection.load_extension` methods allows you to load SQLite
1142 extensions from ".so" files. One well-known extension is the fulltext-search
1143 extension distributed with SQLite.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001144
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001145(Contributed by R. David Murray and Shashwat Anand; :issue:`8845`.)
1146
1147socket
1148------
1149
1150The :mod:`socket` module has two new improvements.
1151
1152* Socket objects now have a :meth:`~socket.socket.detach()` method which puts
1153 the socket into closed state without actually closing the underlying file
1154 descriptor. The latter can then be reused for other purposes.
1155 (Added by Antoine Pitrou; :issue:`8524`.)
1156
1157* :func:`socket.create_connection` now supports the context manager protocol
1158 to unconditionally consume :exc:`socket.error` exceptions and to close the
1159 socket when done.
1160 (Contributed by Giampaolo Rodolà; :issue:`9794`.)
1161
1162ssl
1163---
Antoine Pitroud67075e2010-07-31 22:48:02 +00001164
Raymond Hettinger4854d142011-01-17 21:29:58 +00001165The :mod:`ssl` module added a number of features to satisfy common requirements
1166for secure (encrypted, authenticated) internet connections:
Antoine Pitrou33da1d62011-01-16 18:16:09 +00001167
Raymond Hettinger4854d142011-01-17 21:29:58 +00001168* A new class, :class:`~ssl.SSLContext`, serves as a container for persistent
1169 SSL data, such as protocol settings, certificates, private keys, and various
1170 other options. It includes a :meth:`~ssl.SSLContext.wrap_socket` for creating
1171 an SSL socket from an SSL context.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001172
Raymond Hettinger4854d142011-01-17 21:29:58 +00001173* A new function, :func:`ssl.match_hostname`, supports server identity
1174 verification for higher-level protocols by implementing the rules of HTTPS
1175 (from :rfc:`2818`) which are also suitable for other protocols.
Antoine Pitrou0ee4c9f2010-10-08 16:46:17 +00001176
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001177* The :func:`ssl.wrap_socket` constructor function now takes a *ciphers*
Raymond Hettinger4854d142011-01-17 21:29:58 +00001178 argument. The *ciphers* string lists the allowed encryption algorithms using
1179 the format described in the `OpenSSL documentation
1180 <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT>`__.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001181
Raymond Hettinger4854d142011-01-17 21:29:58 +00001182* When linked against recent versions of OpenSSL, the :mod:`ssl` module now
1183 supports the Server Name Indication extension to the TLS protocol, allowing
1184 multiple "virtual hosts" using different certificates on a single IP port.
1185 This extension is only supported in client mode, and is activated by passing
1186 the *server_hostname* argument to :meth:`ssl.SSLContext.wrap_socket`.
Antoine Pitrou7d15a722010-11-05 22:13:55 +00001187
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001188* Various options have been added to the :mod:`ssl` module, such as
Raymond Hettinger4854d142011-01-17 21:29:58 +00001189 :data:`~ssl.OP_NO_SSLv2` which disables the insecure and obsolete SSLv2
1190 protocol.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001191
Raymond Hettinger4854d142011-01-17 21:29:58 +00001192* The extension now loads all the OpenSSL ciphers and digest algorithms. If
1193 some SSL certificates cannot be verified, they are reported as an "unknown
1194 algorithm" error.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001195
Raymond Hettinger4854d142011-01-17 21:29:58 +00001196* The version of OpenSSL being used is now accessible using the module
1197 attributes :data:`ssl.OPENSSL_VERSION` (a string),
1198 :data:`ssl.OPENSSL_VERSION_INFO` (a 5-tuple), and
1199 :data:`ssl.OPENSSL_VERSION_NUMBER` (an integer).
1200
1201(Contributed by Antoine Pitrou in :issue:`8850`, :issue:`1589`, :issue:`8322`,
1202:issue:`5639`, :issue:`4870`, :issue:`8484`, and :issue:`8321`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001203
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001204nntp
1205----
Raymond Hettinger070ec702010-12-10 17:45:13 +00001206
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001207The :mod:`nntplib` module has a revamped implementation with better bytes and
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001208text semantics as well as more practical APIs. These improvements break
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001209compatibility with the nntplib version in Python 3.1, which was partly
1210dysfunctional in itself.
Raymond Hettinger070ec702010-12-10 17:45:13 +00001211
Antoine Pitrou33da1d62011-01-16 18:16:09 +00001212Support for secure connections through both implicit (using
1213:class:`nntplib.NNTP_SSL`) and explicit (using :meth:`nntplib.NNTP.starttls`)
1214TLS has also been added.
1215
1216(Contributed by Antoine Pitrou in :issue:`9360` and Andrew Vant in :issue:`1926`.)
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001217
1218certificates
1219------------
1220
1221:class:`http.client.HTTPSConnection`, :class:`urllib.request.HTTPSHandler`
1222and :func:`urllib.request.urlopen` now take optional arguments to allow for
1223server certificate checking against a set of Certificate Authorities,
1224as recommended in public uses of HTTPS.
1225
1226(Added by Antoine Pitrou, :issue:`9003`.)
1227
Antoine Pitrou2e8ec222011-01-16 18:41:36 +00001228imaplib
1229-------
1230
1231Support for explicit TLS on standard IMAP4 connections has been added through
1232the new :mod:`imaplib.IMAP4.starttls` method.
1233
1234(Contributed by Lorenzo M. Catucci and Antoine Pitrou, :issue:`4471`.)
1235
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001236unittest
1237--------
Antoine Pitrouafb078d2010-11-05 22:18:28 +00001238
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001239The unittest module has a number of improvements supporting test discovery for
1240packages, easier experimentation at the interactive prompt, new testcase
1241methods, improved diagnostic messages for test failures, and better method
1242names.
1243
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001244* The command-line call ``python -m unittest`` can now accept file paths
Raymond Hettingera0266332010-12-07 08:52:41 +00001245 instead of module names for running specific tests (:issue:`10620`). The new
1246 test discovery can find tests within packages, locating any test importable
Raymond Hettingerc136b042011-01-18 07:15:39 +00001247 from the top-level directory. The top-level directory can be specified with
Raymond Hettingera0266332010-12-07 08:52:41 +00001248 the `-t` option, a pattern for matching files with ``-p``, and a directory to
1249 start discovery with ``-s``::
1250
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001251 $ python -m unittest discover -s my_proj_dir -p _test.py
Raymond Hettingera0266332010-12-07 08:52:41 +00001252
1253 (Contributed by Michael Foord.)
Antoine Pitroud3052002010-09-15 15:09:40 +00001254
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001255* Experimentation at the interactive prompt is now easier because the
1256 :class:`unittest.case.TestCase` class can now be instantiated without
1257 arguments:
1258
1259 >>> TestCase().assertEqual(pow(2, 3), 8)
1260
1261 (Contributed by Michael Foord.)
1262
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001263* The :mod:`unittest` module has two new methods,
1264 :meth:`~unittest.TestCase.assertWarns` and
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001265 :meth:`~unittest.TestCase.assertWarnsRegex` to verify that a given warning type
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001266 is triggered by the code under test::
Antoine Pitroud3052002010-09-15 15:09:40 +00001267
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001268 with self.assertWarns(DeprecationWarning):
1269 legacy_function('XYZ')
Ezio Melotti2baf1a62010-11-22 12:56:58 +00001270
Antoine Pitroueec6dbf2011-01-16 18:21:12 +00001271 (Contributed by Antoine Pitrou, :issue:`9754`.)
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001272
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001273 Another new method, :meth:`~unittest.TestCase.assertCountEqual` is used to
Raymond Hettingerffad35e2010-12-14 21:12:03 +00001274 compare two iterables to determine if their element counts are equal (whether
1275 the same elements are present with the same number of occurrences regardless
1276 of order)::
Raymond Hettingera0266332010-12-07 08:52:41 +00001277
1278 def test_anagram(self):
1279 self.assertCountEqual('algorithm', 'logarithm')
1280
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001281 (Contributed by Raymond Hettinger.)
1282
1283* A principal feature of the unittest module is an effort to produce meaningful
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001284 diagnostics when a test fails. When possible, the failure is recorded along
Raymond Hettingera0266332010-12-07 08:52:41 +00001285 with a diff of the output. This is especially helpful for analyzing log files
1286 of failed test runs. However, since diffs can sometime be voluminous, there is
1287 a new :attr:`~unittest.TestCase.maxDiff` attribute which sets maximum length of
1288 diffs.
1289
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001290* In addition, the method names in the module have undergone a number of clean-ups.
1291
1292 For example, :meth:`~unittest.TestCase.assertRegex` is the new name for
Raymond Hettingera0266332010-12-07 08:52:41 +00001293 :meth:`~unittest.TestCase.assertRegexpMatches` which was misnamed because the
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001294 test uses :func:`re.search`, not :func:`re.match`. Other methods using
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001295 regular expressions are now named using short form "Regex" in preference to
1296 "Regexp" -- this matches the names used in other unittest implementations,
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001297 matches Python's old name for the :mod:`re` module, and it has unambiguous
1298 camel-casing.
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001299
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001300 (Contributed by Raymond Hettinger and implemented by Ezio Melotti.)
1301
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001302* To improve consistency, some long-standing method aliases are being
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001303 deprecated in favor of the preferred names:
1304
Raymond Hettingerc1dfa2e2011-01-19 04:24:57 +00001305 =============================== ==============================
1306 Old Name Preferred Name
1307 =============================== ==============================
1308 :meth:`assert_` :meth:`.assertTrue`
1309 :meth:`assertEquals` :meth:`.assertEqual`
1310 :meth:`assertNotEquals` :meth:`.assertNotEqual`
1311 :meth:`assertAlmostEquals` :meth:`.assertAlmostEqual`
1312 :meth:`assertNotAlmostEquals` :meth:`.assertNotAlmostEqual`
1313 =============================== ==============================
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001314
1315 Likewise, the ``TestCase.fail*`` methods deprecated in Python 3.1 are expected
Raymond Hettingerc1dfa2e2011-01-19 04:24:57 +00001316 to be removed in Python 3.3. Also see the :ref:`deprecated-aliases` section in
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001317 the :mod:`unittest` documentation.
Ezio Melotti2baf1a62010-11-22 12:56:58 +00001318
1319 (Contributed by Ezio Melotti; :issue:`9424`.)
Antoine Pitroud3052002010-09-15 15:09:40 +00001320
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001321* The :meth:`~unittest.TestCase.assertDictContainsSubset` method was deprecated
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001322 because it was misimplemented with the arguments in the wrong order. This
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001323 created hard-to-debug optical illusions where tests like
1324 ``TestCase().assertDictContainsSubset({'a':1, 'b':2}, {'a':1})`` would fail.
1325
1326 (Contributed by Raymond Hettinger.)
1327
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001328random
1329------
Raymond Hettingere0a96002010-12-15 17:54:13 +00001330
Raymond Hettinger0358a172010-12-15 19:00:38 +00001331The integer methods in the :mod:`random` module now do a better job of producing
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001332uniform distributions. Previously, they computed selections with
1333``int(n*random())`` which had a slight bias whenever *n* was not a power of two.
Raymond Hettingerc136b042011-01-18 07:15:39 +00001334Now, multiple selections are made from a range up to the next power of two and a
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001335selection is kept only when it falls within the range ``0 <= x < n``. The
1336functions and methods affected are :func:`~random.randrange`,
1337:func:`~random.randint`, :func:`~random.choice`, :func:`~random.shuffle` and
1338:func:`~random.sample`.
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001339
1340(Contributed by Raymond Hettinger; :issue:`9025`.)
1341
1342poplib
1343------
Raymond Hettingere0a96002010-12-15 17:54:13 +00001344
Giampaolo Rodolà42382fe2010-08-17 16:09:53 +00001345* :class:`~poplib.POP3_SSL` class now accepts a *context* parameter, which is a
1346 :class:`ssl.SSLContext` object allowing bundling SSL configuration options,
1347 certificates and private keys into a single (potentially long-lived)
1348 structure.
1349
1350 (Contributed by Giampaolo Rodolà; :issue:`8807`.)
1351
Giampaolo Rodolà977c7072010-10-04 21:08:36 +00001352* :class:`asyncore.dispatcher` now provides a
1353 :meth:`~asyncore.dispatcher.handle_accepted()` method
1354 returning a `(sock, addr)` pair which is called when a connection has actually
1355 been established with a new remote endpoint. This is supposed to be used as a
1356 replacement for old :meth:`~asyncore.dispatcher.handle_accept()` and avoids
1357 the user to call :meth:`~asyncore.dispatcher.accept()` directly.
1358
1359 (Contributed by Giampaolo Rodolà; :issue:`6706`.)
Georg Brandlda0a2112010-09-05 11:28:33 +00001360
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001361tempfile
1362--------
Raymond Hettingera0266332010-12-07 08:52:41 +00001363
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001364The :mod:`tempfile` module has a new context manager,
1365:class:`~tempfile.TemporaryDirectory` which provides easy deterministic
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001366cleanup of temporary directories::
Nick Coghlan543af752010-10-24 11:23:25 +00001367
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001368 with tempfile.TemporaryDirectory() as tmpdirname:
1369 print('created temporary dir:', tmpdirname)
Nick Coghlan543af752010-10-24 11:23:25 +00001370
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001371(Contributed by Neil Schemenauer and Nick Coghlan; :issue:`5178`.)
Nick Coghlane0f04652010-11-21 03:44:04 +00001372
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001373inspect
1374-------
1375
Raymond Hettinger0358a172010-12-15 19:00:38 +00001376* The :mod:`inspect` module has a new function
1377 :func:`~inspect.getgeneratorstate` to easily identify the current state of a
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001378 generator as one of *GEN_CREATED*, *GEN_RUNNING*, *GEN_SUSPENDED* or
1379 *GEN_CLOSED*::
1380
1381 >>> def gen():
1382 yield 'one'
1383 yield 'two'
1384 >>> g = gen()
1385 >>> inspect.getgeneratorstate(g)
1386 'GEN_CREATED'
1387 >>> next(g)
1388 'one'
1389 >>> inspect.getgeneratorstate(g)
1390 'GEN_SUSPENDED'
1391
1392 (Contributed by Rodolpho Eckhardt and Nick Coghlan, :issue:`10220`.)
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001393
Raymond Hettingera55ffbc2010-12-15 18:31:57 +00001394* To support lookups without the possibility of activating a dynamic attribute,
1395 the :mod:`inspect` module has a new function, :func:`~inspect.getattr_static`.
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001396 Unlike :func:`hasattr`, this is a true read-only search, guaranteed not to
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001397 change state while it is searching::
1398
1399 >>> class A:
1400 @property
1401 def f(self):
1402 print('Running')
1403 return 10
1404
1405 >>> a = A()
1406 >>> getattr(a, 'f')
1407 Running
1408 10
1409 >>> inspect.getattr_static(a, 'f')
1410 <property object at 0x1022bd788>
1411
1412 (Contributed by Michael Foord.)
Nick Coghlane0f04652010-11-21 03:44:04 +00001413
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001414pydoc
1415-----
Nick Coghlan7bb30b72010-12-03 09:29:11 +00001416
Raymond Hettinger89c1cd12011-01-19 04:43:45 +00001417The :mod:`pydoc` module now provides a much-improved Web server interface, as
1418well as a new command-line option ``-b`` to automatically open a browser window
1419to display that server::
1420
1421 $ pydoc3.2 -b
Nick Coghlan7bb30b72010-12-03 09:29:11 +00001422
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001423(Contributed by Ron Adam; :issue:`2001`.)
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001424
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001425sysconfig
1426---------
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001427
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001428The new :mod:`sysconfig` module makes it straightforward to discover
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001429installation paths and configuration variables which vary across platforms and
1430installations.
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001431
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001432The module offers access simple access functions for platform and version
1433information:
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001434
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001435* :func:`~sysconfig.get_platform` returning values like *linux-i586* or
1436 *macosx-10.6-ppc*.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001437* :func:`~sysconfig.get_python_version` returns a Python version string
1438 such as "3.2".
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001439
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001440It also provides access to the paths and variables corresponding to one of
1441seven named schemes used by :mod:`distutils`. Those include *posix_prefix*,
1442*posix_home*, *posix_user*, *nt*, *nt_user*, *os2*, *os2_home*:
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001443
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001444* :func:`~sysconfig.get_paths` makes a dictionary containing installation paths
1445 for the current installation scheme.
1446* :func:`~sysconfig.get_config_vars` returns a dictionary of platform specific
1447 variables.
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001448
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001449There is also a convenient command-line interface::
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001450
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001451 C:\Python32>python -m sysconfig
1452 Platform: "win32"
1453 Python version: "3.2"
1454 Current installation scheme: "nt"
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001455
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001456 Paths:
1457 data = "C:\Python32"
Łukasz Langa79a06ed2010-12-17 22:05:46 +00001458 include = "C:\Python32\Include"
1459 platinclude = "C:\Python32\Include"
1460 platlib = "C:\Python32\Lib\site-packages"
1461 platstdlib = "C:\Python32\Lib"
1462 purelib = "C:\Python32\Lib\site-packages"
1463 scripts = "C:\Python32\Scripts"
1464 stdlib = "C:\Python32\Lib"
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001465
1466 Variables:
1467 BINDIR = "C:\Python32"
Łukasz Langa79a06ed2010-12-17 22:05:46 +00001468 BINLIBDEST = "C:\Python32\Lib"
1469 EXE = ".exe"
1470 INCLUDEPY = "C:\Python32\Include"
1471 LIBDEST = "C:\Python32\Lib"
1472 SO = ".pyd"
1473 VERSION = "32"
1474 abiflags = ""
1475 base = "C:\Python32"
1476 exec_prefix = "C:\Python32"
1477 platbase = "C:\Python32"
1478 prefix = "C:\Python32"
1479 projectbase = "C:\Python32"
1480 py_version = "3.2"
1481 py_version_nodot = "32"
1482 py_version_short = "3.2"
1483 srcdir = "C:\Python32"
1484 userbase = "C:\Documents and Settings\Raymond\Application Data\Python"
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001485
1486pdb
1487---
1488
1489The :mod:`pdb` debugger module gained a number of usability improvements:
Raymond Hettingerb5d79332010-12-07 02:04:56 +00001490
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001491* :file:`pdb.py` now has a ``-c`` option that executes commands as given in a
1492 :file:`.pdbrc` script file.
1493* A :file:`.pdbrc` script file can contain ``continue`` and ``next`` commands
1494 that continue debugging.
1495* The :class:`Pdb` class constructor now accepts a *nosigint* argument.
Raymond Hettinger51e21072011-01-10 23:38:15 +00001496* New commands: ``l(list)``, ``ll(long list)`` and ``source`` for
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001497 listing source code.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001498* New commands: ``display`` and ``undisplay`` for showing or hiding
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001499 the value of an expression if it has changed.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001500* New command: ``interact`` for starting an interactive interpreter containing
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001501 the global and local names found in the current scope.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001502* Breakpoints can be cleared by breakpoint number.
Raymond Hettingerb5d79332010-12-07 02:04:56 +00001503
Georg Brandl101234b2010-12-18 11:53:25 +00001504(Contributed by Georg Brandl, Antonio Cuni and Ilya Sandler.)
1505
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001506configparser
1507------------
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001508
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001509The :mod:`configparser` module was modified to improve usability and
1510predictability of the default parser and its supported INI syntax. The old
1511:class:`ConfigParser` class was removed in favor of :class:`SafeConfigParser`
Raymond Hettinger04129742010-12-18 10:57:50 +00001512which has in turn been renamed to :class:`~configparser.ConfigParser`. Support
1513for inline comments is now turned off by default and section or option
1514duplicates are not allowed in a single configuration source.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001515
1516Config parsers gained a new API based on the mapping protocol::
1517
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001518 >>> parser = ConfigParser()
1519 >>> parser.read_string("""
1520 [DEFAULT]
1521 location = upper left
1522 visible = yes
1523 editable = no
1524 color = blue
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001525
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001526 [main]
1527 title = Main Menu
1528 color = green
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001529
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001530 [options]
1531 title = Options
1532 """)
1533 >>> parser['main']['color']
1534 'green'
1535 >>> parser['main']['editable']
1536 'no'
1537 >>> section = parser['options']
1538 >>> section['title']
1539 'Options'
1540 >>> section['title'] = 'Options (editable: %(editable)s)'
1541 >>> section['title']
1542 'Options (editable: no)'
1543
1544The new API is implemented on top of the classical API, so custom parser
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001545subclasses should be able to use it without modifications.
1546
1547The INI file structure accepted by config parsers can now be customized. Users
Raymond Hettinger04129742010-12-18 10:57:50 +00001548can specify alternative option/value delimiters and comment prefixes, change the
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001549name of the *DEFAULT* section or switch the interpolation syntax.
1550
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001551There is support for pluggable interpolation including an additional interpolation
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001552handler :class:`~configparser.ExtendedInterpolation`::
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001553
1554 >>> parser = ConfigParser(interpolation=ExtendedInterpolation())
1555 >>> parser.read_dict({'buildout': {'directory': '/home/ambv/zope9'},
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001556 'custom': {'prefix': '/usr/local'}})
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001557 >>> parser.read_string("""
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001558 [buildout]
1559 parts =
1560 zope9
1561 instance
1562 find-links =
1563 ${buildout:directory}/downloads/dist
1564
1565 [zope9]
1566 recipe = plone.recipe.zope9install
1567 location = /opt/zope
1568
1569 [instance]
1570 recipe = plone.recipe.zope9instance
1571 zope9-location = ${zope9:location}
1572 zope-conf = ${custom:prefix}/etc/zope.conf
1573 """)
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001574 >>> parser['buildout']['find-links']
1575 '\n/home/ambv/zope9/downloads/dist'
1576 >>> parser['instance']['zope-conf']
1577 '/usr/local/etc/zope.conf'
1578 >>> instance = parser['instance']
1579 >>> instance['zope-conf']
1580 '/usr/local/etc/zope.conf'
1581 >>> instance['zope9-location']
1582 '/opt/zope'
1583
1584A number of smaller features were also introduced, like support for specifying
Raymond Hettinger04129742010-12-18 10:57:50 +00001585encoding in read operations, specifying fallback values for get-functions, or
1586reading directly from dictionaries and strings.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001587
1588(All changes contributed by Łukasz Langa.)
1589
Raymond Hettingera55ffbc2010-12-15 18:31:57 +00001590.. XXX: Mention urllib.parse changes
1591 Issue 9873 (Nick Coghlan):
1592 - ASCII byte sequence support in URL parsing
1593 - named tuple for urldefrag return value
1594 Issue 5468 (Dan Mahn) for urlencode:
1595 - bytes input support
1596 - non-UTF8 percent encoding of non-ASCII characters
1597 Issue 2987 for IPv6 (RFC2732) support in urlparse
Raymond Hettinger3df46212011-01-06 02:01:26 +00001598
Raymond Hettingera55ffbc2010-12-15 18:31:57 +00001599
Antoine Pitroud42bc512009-11-10 23:18:31 +00001600Multi-threading
1601===============
1602
Georg Brandlda0a2112010-09-05 11:28:33 +00001603* The mechanism for serializing execution of concurrently running Python threads
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001604 (generally known as the :term:`GIL` or :term:`Global Interpreter Lock`) has
1605 been rewritten. Among the objectives were more predictable switching
1606 intervals and reduced overhead due to lock contention and the number of
1607 ensuing system calls. The notion of a "check interval" to allow thread
1608 switches has been abandoned and replaced by an absolute duration expressed in
1609 seconds. This parameter is tunable through :func:`sys.setswitchinterval()`.
1610 It currently defaults to 5 milliseconds.
Antoine Pitroud42bc512009-11-10 23:18:31 +00001611
1612 Additional details about the implementation can be read from a `python-dev
1613 mailing-list message
1614 <http://mail.python.org/pipermail/python-dev/2009-October/093321.html>`_
Georg Brandlda0a2112010-09-05 11:28:33 +00001615 (however, "priority requests" as exposed in this message have not been kept
1616 for inclusion).
Antoine Pitroud42bc512009-11-10 23:18:31 +00001617
Georg Brandl5e73a812010-04-22 07:02:51 +00001618 (Contributed by Antoine Pitrou.)
Antoine Pitroud42bc512009-11-10 23:18:31 +00001619
Georg Brandlda0a2112010-09-05 11:28:33 +00001620* Regular and recursive locks now accept an optional *timeout* argument to their
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001621 :meth:`~threading.Lock.acquire` method. (Contributed by Antoine Pitrou;
1622 :issue:`7316`.)
Georg Brandlda0a2112010-09-05 11:28:33 +00001623
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001624* Similarly, :meth:`threading.Semaphore.acquire` also gained a *timeout*
Georg Brandlda0a2112010-09-05 11:28:33 +00001625 argument. (Contributed by Torsten Landschoff; :issue:`850728`.)
Antoine Pitroue95a9ff2010-05-04 23:31:41 +00001626
Antoine Pitrou810023d2010-12-15 22:59:16 +00001627* Regular and recursive lock acquisitions can now be interrupted by signals on
Raymond Hettingerc136b042011-01-18 07:15:39 +00001628 platforms using Pthreads. This means that Python programs that deadlock while
Antoine Pitrou810023d2010-12-15 22:59:16 +00001629 acquiring locks can be successfully killed by repeatedly sending SIGINT to the
Georg Brandleebb2522010-12-18 12:01:15 +00001630 process (by pressing :kbd:`Ctrl+C` in most shells).
Antoine Pitrou810023d2010-12-15 22:59:16 +00001631 (Contributed by Reid Kleckner; :issue:`8844`.)
1632
Antoine Pitroud42bc512009-11-10 23:18:31 +00001633
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001634Optimizations
1635=============
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001636
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001637A number of small performance enhancements have been added:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001638
Antoine Pitroud3052002010-09-15 15:09:40 +00001639* Python's peephole optimizer now recognizes patterns such ``x in {1, 2, 3}`` as
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001640 being a test for membership in a set of constants. The optimizer recasts the
1641 :class:`set` as a :class:`frozenset` and stores the pre-built constant.
1642
1643 Now that the speed penalty is gone, it is practical to start writing
1644 membership tests using set-notation. This style is both semantically clear
1645 and operationally fast::
1646
1647 extension = name.rpartition('.')[2]
1648 if extension in {'xml', 'html', 'xhtml', 'css'}:
1649 handle(name)
1650
Raymond Hettingerc136b042011-01-18 07:15:39 +00001651 (Patch and additional tests contributed by Dave Malcolm; :issue:`6690`).
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001652
Antoine Pitroud3052002010-09-15 15:09:40 +00001653* Serializing and unserializing data using the :mod:`pickle` module is now
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001654 several times faster.
1655
1656 (Contributed by Alexandre Vassalotti, Antoine Pitrou
Antoine Pitrouff150f22010-10-22 21:41:05 +00001657 and the Unladen Swallow team in :issue:`9410` and :issue:`3873`.)
Antoine Pitroud3052002010-09-15 15:09:40 +00001658
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001659* The `Timsort algorithm <http://en.wikipedia.org/wiki/Timsort>`_ used in
Raymond Hettingerffad35e2010-12-14 21:12:03 +00001660 :meth:`list.sort` and :func:`sorted` now runs faster and uses less memory
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001661 when called with a :term:`key function`. Previously, every element of
1662 a list was wrapped with a temporary object that remembered the key value
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001663 associated with each element. Now, two arrays of keys and values are
Raymond Hettingerc136b042011-01-18 07:15:39 +00001664 sorted in parallel. This saves the memory consumed by the sort wrappers,
1665 and it saves time lost to delegating comparisons.
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001666
Raymond Hettingereb70b902011-01-10 21:26:49 +00001667 (Patch by Daniel Stutzbach in :issue:`9915`.)
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001668
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001669* JSON decoding performance is improved and memory consumption is reduced
Raymond Hettinger413abbc2010-12-05 07:06:47 +00001670 whenever the same string is repeated for multiple keys. Also, JSON encoding
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001671 now uses the C speedups when the ``sort_keys`` argument is true.
1672
1673 (Contributed by Antoine Pitrou in :issue:`7451` and by Raymond Hettinger and
1674 Antoine Pitrou in :issue:`10314`.)
1675
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001676* Recursive locks (created with the :func:`threading.RLock` API) now benefit
1677 from a C implementation which makes them as fast as regular locks, and between
1678 10x and 15x faster than their previous pure Python implementation.
1679
1680 (Contributed by Antoine Pitrou; :issue:`3001`.)
1681
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001682* The fast-search algorithm in stringlib is now used by the :meth:`split`,
1683 :meth:`rsplit`, :meth:`splitlines` and :meth:`replace` methods on
1684 :class:`bytes`, :class:`bytearray` and :class:`str` objects. Likewise, the
1685 algorithm is also used by :meth:`rfind`, :meth:`rindex`, :meth:`rsplit` and
1686 :meth:`rpartition`.
1687
1688 (Patch by Florent Xicluna in :issue:`7622` and :issue:`7462`.)
1689
Raymond Hettinger480ed782010-12-15 22:07:15 +00001690
1691* String to integer conversions now work two "digits" at a time, reducing the
1692 number of division and modulo operations.
1693
1694 (:issue:`6713` by Gawain Bolton, Mark Dickinson, and Victor Stinner.)
1695
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +00001696There were several other minor optimizations. Set differencing now runs faster
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001697when one operand is much larger than the other (patch by Andress Bennetts in
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +00001698:issue:`8685`). The :meth:`array.repeat` method has a faster implementation
1699(:issue:`1569291` by Alexander Belopolsky). The :class:`BaseHTTPRequestHandler`
1700has more efficient buffering (:issue:`3709` by Andrew Schaaf). The
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001701multi-argument form of :func:`operator.attrgetter` function now runs slightly
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +00001702faster (:issue:`10160` by Christos Georgiou). And :class:`ConfigParser` loads
1703multi-line arguments a bit faster (:issue:`7113` by Łukasz Langa).
1704
Antoine Pitroud3052002010-09-15 15:09:40 +00001705
Victor Stinner47ce9652010-10-29 00:57:35 +00001706Unicode
1707=======
Victor Stinner94908bb2010-08-18 21:23:25 +00001708
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001709Python has been updated to Unicode 6.0.0. The new features of the
1710Unicode Standard that will affect Python users include:
1711
Alexander Belopolsky84cc0622010-12-08 21:38:46 +00001712* addition of 2,088 characters, including over 1,000 additional
1713 symbols—chief among them the additional emoji symbols, which are
1714 especially important for mobile phones;
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001715
Alexander Belopolsky84cc0622010-12-08 21:38:46 +00001716* changes to character properties for existing characters including
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001717
Raymond Hettingerc74d5182010-12-02 01:38:25 +00001718 - a general category change to two Kannada characters (U+0CF1,
1719 U+0CF2), which has the effect of making them newly eligible for
1720 inclusion in identifiers;
1721
1722 - a general category change to one New Tai Lue numeric character
Alexander Belopolsky84cc0622010-12-08 21:38:46 +00001723 (U+19DA), which has the effect of disqualifying it from
1724 inclusion in identifiers.
1725
1726 For more information, see `Unicode Character Database Changes
1727 <http://www.unicode.org/versions/Unicode6.0.0/#Database_Changes>`_
1728 at the `Unicode Consortium <http://www.unicode.org/>`_ web site.
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001729
Éric Araujo4234ad42010-09-05 17:32:25 +00001730The :mod:`os` module has two new functions: :func:`~os.fsencode` and
Victor Stinner47ce9652010-10-29 00:57:35 +00001731:func:`~os.fsdecode`. Add :data:`os.environb`: bytes version of
1732:data:`os.environ`, :func:`os.getenvb` function and
1733:data:`os.supports_bytes_environ` constant.
Victor Stinnere8d51452010-08-19 01:05:19 +00001734
Raymond Hettinger23ab1012011-01-18 20:25:04 +00001735MBCS encoding doesn't ignore the error handler argument any more. By
Victor Stinner47ce9652010-10-29 00:57:35 +00001736default (strict mode), it raises an UnicodeDecodeError on undecodable byte
Raymond Hettinger23ab1012011-01-18 20:25:04 +00001737sequence and UnicodeEncodeError on unencodable character. To get the MBCS
Victor Stinner47ce9652010-10-29 00:57:35 +00001738encoding of Python 3.1, use ``'ignore'`` error handler to decode and
Raymond Hettinger23ab1012011-01-18 20:25:04 +00001739``'replace'`` error handler to encode. The MBCS codec supports ``'strict'`` and
Victor Stinner47ce9652010-10-29 00:57:35 +00001740``'ignore'`` error handlers for decoding, and ``'strict'`` and ``'replace'``
1741for encoding.
1742
1743On Mac OS X, Python uses ``'utf-8'`` to decode the command line arguments,
1744instead of the locale encoding (which is ISO-8859-1 if the ``LANG`` environment
1745variable is not set).
1746
1747By default, tarfile uses ``'utf-8'`` encoding on Windows (instead of
1748``'mbcs'``), and the ``'surrogateescape'`` error handler on all operating
1749systems.
Antoine Pitroud3052002010-09-15 15:09:40 +00001750
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001751Also, support was added for *cp720* Arabic DOS encoding (:issue:`1616979`).
Raymond Hettinger480ed782010-12-15 22:07:15 +00001752
Victor Stinner94908bb2010-08-18 21:23:25 +00001753
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001754Documentation
1755=============
1756
1757The documentation continues to be improved.
1758
1759A table of quick links has been added to the top of lengthy sections such as
1760:ref:`built-in-funcs`. In the case of :mod:`itertools`, the links are
1761accompanied by tables of cheatsheet-style summaries to provide an overview and
1762memory jog without having to read all of the docs.
1763
Raymond Hettinger51e21072011-01-10 23:38:15 +00001764In some cases, the pure Python source code can be a helpful adjunct to the
1765documentation, so now many modules now feature quick links to the latest version
1766of the source code. For example, the :mod:`functools` module documentation has
1767a quick link at the top labeled: **Source code** :source:`Lib/functools.py`.
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001768
1769The docs now contain more examples and recipes. In particular, :mod:`re` module
1770has an extensive section, :ref:`re-examples`. Likewise, the :mod:`itertools`
1771module continues to be updated with new :ref:`itertools-recipes`.
1772
Raymond Hettinger677e10a2010-12-07 06:45:30 +00001773The :mod:`datetime` module now has an auxiliary implementation in pure Python.
1774No functionality was changed. This just provides an easier-to-read
1775alternate implementation. (Contributed by Alexander Belopolsky.)
1776
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001777The unmaintained :file:`Demo` directory has been removed. Some demos were
1778integrated into the documentation, some were moved to the :file:`Tools/demo`
1779directory, and others were removed altogether. (Contributed by Georg Brandl.)
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001780
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001781
1782IDLE
1783====
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001784
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001785* The format menu now has an option to clean source files by stripping
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001786 trailing whitespace.
1787
1788 (Contributed by Raymond Hettinger; :issue:`5150`.)
1789
1790* IDLE on Mac OS X now works with both Carbon AquaTk and Cocoa AquaTk.
1791
1792 (Contributed by Kevin Walzer, Ned Deily, and Ronald Oussoren; :issue:`6075`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001793
1794
1795Build and C API Changes
1796=======================
1797
1798Changes to Python's build process and to the C API include:
1799
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001800* The *idle*, *pydoc* and *2to3* scripts are now installed with a
1801 version-specific suffix on ``make altinstall`` (:issue:`10679`).
1802
Georg Brandlda0a2112010-09-05 11:28:33 +00001803* The C functions that access the Unicode Database now accept and return
1804 characters from the full Unicode range, even on narrow unicode builds
Raymond Hettinger1784ff02010-09-05 01:00:19 +00001805 (Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and others). A visible difference
Georg Brandlda0a2112010-09-05 11:28:33 +00001806 in Python is that :func:`unicodedata.numeric` now returns the correct value
1807 for large code points, and :func:`repr` may consider more characters as
1808 printable.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001809
Raymond Hettinger1784ff02010-09-05 01:00:19 +00001810 (Reported by Bupjoe Lee and fixed by Amaury Forgeot D'Arc; :issue:`5127`.)
1811
Georg Brandlda0a2112010-09-05 11:28:33 +00001812* Computed gotos are now enabled by default on supported compilers (which are
Raymond Hettingerdb9044e2010-09-06 01:29:23 +00001813 detected by the configure script). They can still be disabled selectively by
Georg Brandlda0a2112010-09-05 11:28:33 +00001814 specifying ``--without-computed-gotos``.
Raymond Hettinger1784ff02010-09-05 01:00:19 +00001815
Georg Brandlda0a2112010-09-05 11:28:33 +00001816 (Contributed by Antoine Pitrou; :issue:`9203`.)
1817
Amaury Forgeot d'Arcfeb73072010-09-12 22:42:57 +00001818* The option ``--with-wctype-functions`` was removed. The built-in unicode
1819 database is now used for all functions.
1820
1821 (Contributed by Amaury Forgeot D'Arc; :issue:`9210`.)
1822
Raymond Hettinger480ed782010-12-15 22:07:15 +00001823* Hash values are now values of a new type, :c:type:`Py_hash_t`, which is
1824 defined to be the same size as a pointer. Previously they were of type long,
1825 which on some 64-bit operating systems is still only 32 bits long. As a
1826 result of this fix, :class:`set` and :class:`dict` can now hold more than
1827 ``2**32`` entries on builds with 64-bit pointers (previously, they could grow
1828 to that size but their performance degraded catastrophically).
Skip Montanaro961aaf52010-10-17 22:22:24 +00001829
Raymond Hettinger480ed782010-12-15 22:07:15 +00001830 (Suggested by Raymond Hettinger and implemented by Benjamin Peterson;
1831 :issue:`9778`.)
1832
1833* A new macro :c:macro:`Py_VA_COPY` copies the state of the variable argument
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001834 list. It is equivalent to C99 *va_copy* but available on all Python platforms
Raymond Hettinger480ed782010-12-15 22:07:15 +00001835 (:issue:`2443`).
1836
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001837* A new C API function :c:func:`PySys_SetArgvEx` allows an embedded interpreter
1838 to set :attr:`sys.argv` without also modifying :attr:`sys.path`
Raymond Hettinger480ed782010-12-15 22:07:15 +00001839 (:issue:`5753`).
1840
1841* :c:macro:`PyEval_CallObject` is now only available in macro form. The
1842 function declaration, which was kept for backwards compatibility reasons, is
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001843 now removed -- the macro was introduced in 1997 (:issue:`8276`).
Raymond Hettinger480ed782010-12-15 22:07:15 +00001844
1845* The is a new function :c:func:`PyLong_AsLongLongAndOverflow` which
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001846 is analogous to :c:func:`PyLong_AsLongAndOverflow`. They both serve to
Raymond Hettinger480ed782010-12-15 22:07:15 +00001847 convert Python :class:`int` into a native fixed-width type while providing
1848 detection of cases where the conversion won't fit (:issue:`7767`).
1849
1850* The :c:func:`PyUnicode_CompareWithASCIIString` now returns *not equal*
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001851 if the Python string is *NUL* terminated.
Raymond Hettinger480ed782010-12-15 22:07:15 +00001852
1853* There is a new function :c:func:`PyErr_NewExceptionWithDoc` that is
1854 like :c:func:`PyErr_NewException` but allows a docstring to be specified.
1855 This lets C exceptions have the same self-documenting capabilities as
1856 their pure Python counterparts (:issue:`7033`).
1857
1858* When compiled with the ``--with-valgrind`` option, the pymalloc
1859 allocator will be automatically disabled when running under Valgrind. This
1860 gives improved memory leak detection when running under Valgrind, while taking
1861 advantage of pymalloc at other times (:issue:`2422`).
1862
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001863* Removed the ``O?`` format from the *PyArg_Parse* functions. The format is no
Raymond Hettinger480ed782010-12-15 22:07:15 +00001864 longer used and it had never been documented (:issue:`8837`).
1865
1866There were a number of other small changes to the C-API. See the
1867:file:`Misc/NEWS` file for a complete list.
Skip Montanaro961aaf52010-10-17 22:22:24 +00001868
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001869
Raymond Hettingerf558ddd2009-06-28 21:37:08 +00001870Porting to Python 3.2
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001871=====================
1872
Georg Brandlda0a2112010-09-05 11:28:33 +00001873This section lists previously described changes and other bugfixes that may
1874require changes to your code:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001875
Raymond Hettingerd73be672010-12-18 10:48:26 +00001876* The :mod:`configparser` module has a number of clean-ups. The major change is
1877 to replace the old :class:`ConfigParser` class with long-standing preferred
1878 alternative :class:`SafeConfigParser`. In addition there are a number of
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001879 smaller incompatibilities:
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001880
Raymond Hettingerd73be672010-12-18 10:48:26 +00001881 * The interpolation syntax is now validated on
1882 :meth:`~configparser.ConfigParser.get` and
1883 :meth:`~configparser.ConfigParser.set` operations. In the default
1884 interpolation scheme, only two tokens with percent signs are valid: ``%(name)s``
1885 and ``%%``, the latter being an escaped percent sign.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001886
Raymond Hettingerd73be672010-12-18 10:48:26 +00001887 * The :meth:`~configparser.ConfigParser.set` and
1888 :meth:`~configparser.ConfigParser.add_section` methods now verify that
1889 values are actual strings. Formerly, unsupported types could be introduced
1890 unintentionally.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001891
Raymond Hettinger2b8861f2010-12-18 11:20:52 +00001892 * Duplicate sections or options from a single source now raise either
Raymond Hettingerd73be672010-12-18 10:48:26 +00001893 :exc:`~configparser.DuplicateSectionError` or
1894 :exc:`~configparser.DuplicateOptionError`. Formerly, duplicates would
1895 silently overwrite a previous entry.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001896
Raymond Hettingerd73be672010-12-18 10:48:26 +00001897 * Inline comments are now disabled by default so now the **;** character
1898 can be safely used in values.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001899
Raymond Hettingerd73be672010-12-18 10:48:26 +00001900 * Comments now can be indented. Consequently, for **;** or **#** to appear at
1901 the start of a line in multiline values, it has to be interpolated. This
Raymond Hettinger2b8861f2010-12-18 11:20:52 +00001902 keeps comment prefix characters in values from being mistaken as comments.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001903
Raymond Hettingerd73be672010-12-18 10:48:26 +00001904 * ``""`` is now a valid value and is no longer automatically converted to an
1905 empty string. For empty strings, use ``"option ="`` in a line.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001906
Antoine Pitroucd889af2010-10-06 21:13:56 +00001907* The :mod:`nntplib` module was reworked extensively, meaning that its APIs
1908 are often incompatible with the 3.1 APIs.
1909
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001910* :class:`bytearray` objects can no longer be used as filenames; instead,
1911 they should be converted to :class:`bytes`.
Victor Stinnerdcb24032010-04-22 12:08:36 +00001912
Raymond Hettinger51e21072011-01-10 23:38:15 +00001913* ``PyArg_Parse*()`` functions:
Victor Stinner3dcb5ac2010-06-08 22:54:19 +00001914
Victor Stinner25e8ec42010-06-25 00:02:38 +00001915 * "t#" format has been removed: use "s#" or "s*" instead
1916 * "w" and "w#" formats has been removed: use "w*" instead
1917
Georg Brandl60203b42010-10-06 10:11:56 +00001918* The :c:type:`PyCObject` type, deprecated in 3.1, has been removed. To wrap
1919 opaque C pointers in Python objects, the :c:type:`PyCapsule` API should be used
Éric Araujo4234ad42010-09-05 17:32:25 +00001920 instead; the new type has a well-defined interface for passing typing safety
Georg Brandlda0a2112010-09-05 11:28:33 +00001921 information and a less complicated signature for calling a destructor.
Victor Stinner0cbec572010-09-12 20:32:57 +00001922
Raymond Hettingere0a96002010-12-15 17:54:13 +00001923* The :func:`sys.setfilesystemencoding` function was removed because
1924 it had a flawed design.
Raymond Hettinger3fcf0022010-12-08 01:13:53 +00001925
Raymond Hettingere0a96002010-12-15 17:54:13 +00001926* The :func:`random.seed` function and method now salt string seeds with an
1927 sha512 hash function. To access the previous version of *seed* in order to
1928 reproduce Python 3.1 sequences, set the *version* argument to *1*,
1929 ``random.seed(s, version=1)``.
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001930
Raymond Hettinger522cc0a2010-12-10 01:19:15 +00001931* The previously deprecated :func:`string.maketrans` function has been removed
Raymond Hettinger51e21072011-01-10 23:38:15 +00001932 in favor of the static methods :meth:`bytes.maketrans` and
Raymond Hettinger522cc0a2010-12-10 01:19:15 +00001933 :meth:`bytearray.maketrans`. This change solves the confusion around which
1934 types were supported by the :mod:`string` module. Now, :class:`str`,
1935 :class:`bytes`, and :class:`bytearray` each have their own **maketrans** and
1936 **translate** methods with intermediate translation tables of the appropriate
1937 type.
1938
1939 (Contributed by Georg Brandl; :issue:`5675`.)
1940
1941* The previously deprecated :func:`contextlib.nested` function has been removed
1942 in favor of a plain :keyword:`with` statement which can accept multiple
1943 context managers. The latter technique is faster (because it is built-in),
1944 and it does a better job finalizing multiple context managers when one of them
1945 raises an exception::
1946
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001947 with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
1948 for line in infile:
1949 if '<critical>' in line:
1950 outfile.write(line)
Raymond Hettinger522cc0a2010-12-10 01:19:15 +00001951
1952 (Contributed by Georg Brandl and Mattias Brändström;
1953 `appspot issue 53094 <http://codereview.appspot.com/53094>`_.)
Victor Stinnerda9ec992010-12-28 13:26:42 +00001954
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001955* :func:`struct.pack` now only allows bytes for the ``s`` string pack code.
1956 Formerly, it would accept text arguments and implicitly encode them to bytes
1957 using UTF-8. This was problematic because it made assumptions about the
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001958 correct encoding and because a variable-length encoding can fail when writing
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001959 to fixed length segment of a structure.
Victor Stinnerda9ec992010-12-28 13:26:42 +00001960
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001961 Code such as ``struct.pack('<6sHHBBB', 'GIF87a', x, y)`` should be rewritten
1962 with to use bytes instead of text, ``struct.pack('<6sHHBBB', b'GIF87a', x, y)``.
1963
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001964 (Discovered by David Beazley and fixed by Victor Stinner; :issue:`10783`.)
Raymond Hettingere40808a2011-01-05 23:00:00 +00001965
1966* The :class:`xml.etree.ElementTree` class now raises an
1967 :exc:`xml.etree.ElementTree.ParseError` when a parse fails. Previously it
1968 raised a :exc:`xml.parsers.expat.ExpatError`.
1969
1970* The new, longer :func:`str` value on floats may break doctests which rely on
1971 the old output format.
Antoine Pitroubcba4342011-01-16 18:29:34 +00001972
1973* In :class:`subprocess.Popen`, the default value for *close_fds* is now
1974 ``True`` under Unix; under Windows, it is ``True`` if the three standard
1975 streams are set to ``None``, ``False`` otherwise. Previously, *close_fds*
1976 was always ``False`` by default, which produced difficult to solve bugs
1977 or race conditions when open file descriptors would leak into the child
1978 process.
1979
Antoine Pitrouf7fb7622011-01-16 18:34:09 +00001980* Support for legacy HTTP 0.9 has been removed from :mod:`urllib.request`
1981 and :mod:`http.client`. Such support is still present on the server side
1982 (in :mod:`http.server`).
1983
1984 (Contributed by Antoine Pitrou, :issue:`10711`.)
1985
Antoine Pitrou2e8ec222011-01-16 18:41:36 +00001986* SSL sockets in timeout mode now raise :exc:`socket.timeout` when a timeout
1987 occurs, rather than a generic :exc:`~ssl.SSLError`.
1988
1989 (Contributed by Antoine Pitrou, :issue:`10272`.)
Antoine Pitrouebeb9032011-01-16 18:45:17 +00001990
1991* The misleading functions :c:func:`PyEval_AcquireLock()` and
1992 :c:func:`PyEval_ReleaseLock()` have been officially deprecated. The
1993 thread-state aware APIs (such as :c:func:`PyEval_SaveThread()`
1994 and :c:func:`PyEval_RestoreThread()`) should be used instead.