blob: 89d3a912ea52ae18a8e45462aa2c2b843020e63b [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 Hettinger677e10a2010-12-07 06:45:30 +0000172 :ref:`upgrading-optparse-code` for details on the differences from
173 :mod:`optparse`.
174
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000175
Éric Araujo4234ad42010-09-05 17:32:25 +0000176PEP 391: Dictionary Based Configuration for Logging
177====================================================
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000178
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000179The :mod:`logging` module provided two kinds of configuration, one style with
180function calls for each option or another style driven by an external file saved
181in a :mod:`ConfigParser` format. Those options did not provide the flexibility
Georg Brandl9e75cad2010-09-06 06:45:47 +0000182to create configurations from JSON or YAML files, nor did they support
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000183incremental configuration, which is needed for specifying logger options from a
184command line.
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000185
186To support a more flexible style, the module now offers
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000187:func:`logging.config.dictConfig` for specifying logging configuration with
188plain Python dictionaries. The configuration options include formatters,
189handlers, filters, and loggers. Here's a working example of a configuration
190dictionary::
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000191
Georg Brandlda0a2112010-09-05 11:28:33 +0000192 {"version": 1,
193 "formatters": {"brief": {"format": "%(levelname)-8s: %(name)-15s: %(message)s"},
194 "full": {"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"},
195 },
196 "handlers": {"console": {
197 "class": "logging.StreamHandler",
198 "formatter": "brief",
199 "level": "INFO",
200 "stream": "ext://sys.stdout"},
201 "console_priority": {
202 "class": "logging.StreamHandler",
203 "formatter": "full",
204 "level": "ERROR",
205 "stream": "ext://sys.stderr"},
206 },
207 "root": {"level": "DEBUG", "handlers": ["console", "console_priority"]}}
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000208
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000209
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000210If that dictionary is stored in a file called :file:`conf.json`, it can be
211loaded and called with code like this::
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000212
Raymond Hettingerca904be2011-01-18 00:02:40 +0000213 >>> import json, logging.config
214 >>> with open('conf.json', 'rb') as f:
215 conf = json.load(f)
216 >>> logging.config.dictConfig(conf)
217 >>> logging.info("Transaction completed normally")
218 >>> logging.critical("Abnormal termination")
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000219
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000220.. seealso::
221
222 :pep:`391` - Dictionary Based Configuration for Logging
223 PEP written by Vinay Sajip.
224
Raymond Hettingerca904be2011-01-18 00:02:40 +0000225
Georg Brandl97b20da2010-11-16 15:15:29 +0000226PEP 3148: The ``concurrent.futures`` module
227============================================
228
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000229Code for creating and managing concurrency is being collected in a new top-level
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000230namespace, *concurrent*. Its first member is a *futures* package which provides
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000231a uniform high-level interface for managing threads and processes.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000232
233The design for :mod:`concurrent.futures` was inspired by
234*java.util.concurrent.package*. In that model, a running call and its result
Raymond Hettingerc136b042011-01-18 07:15:39 +0000235are represented by a :class:`~concurrent.futures.Future` object that abstracts
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000236features common to threads, processes, and remote procedure calls. That object
237supports status checks (running or done), timeouts, cancellations, adding
Raymond Hettinger24a09412010-12-08 06:50:02 +0000238callbacks, and access to results or exceptions.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000239
240The primary offering of the new module is a pair of executor classes for
241launching and managing calls. The goal of the executors is to make it easier to
242use existing tools for making parallel calls. They save the effort needed to
243setup a pool of resources, launch the calls, create a results queue, add
244time-out handling, and limit the total number of threads, processes, or remote
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000245procedure calls.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000246
247Ideally, each application should share a single executor across multiple
248components so that process and thread limits can be centrally managed. This
249solves the design challenge that arises when each component has its own
250competing strategy for resource management.
251
Raymond Hettingerb1055192010-12-08 06:42:41 +0000252Both classes share a common interface with three methods:
253:meth:`~concurrent.futures.Executor.submit` for scheduling a callable and
254returning a :class:`~concurrent.futures.Future` object;
255:meth:`~concurrent.futures.Executor.map` for scheduling many asynchronous calls
Raymond Hettinger83d80792010-12-08 06:48:33 +0000256at a time, and :meth:`~concurrent.futures.Executor.shutdown` for freeing
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000257resources. The class is a :term:`context manager` and can be used in a
Raymond Hettinger83d80792010-12-08 06:48:33 +0000258:keyword:`with` statement to assure that resources are automatically released
259when currently pending futures are done executing.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000260
Raymond Hettingerb1055192010-12-08 06:42:41 +0000261A simple of example of :class:`~concurrent.futures.ThreadPoolExecutor` is a
Raymond Hettinger83d80792010-12-08 06:48:33 +0000262launch of four parallel threads for copying files::
Raymond Hettingerb1055192010-12-08 06:42:41 +0000263
264 import shutil
265 with ThreadPoolExecutor(max_workers=4) as e:
266 e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
267 e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
268 e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
269 e.submit(shutil.copy, 'src3.txt', 'dest4.txt')
270
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000271.. seealso::
272
Raymond Hettingera5a35542010-12-05 00:39:18 +0000273 :pep:`3148` - Futures -- Execute Computations Asynchronously
Andrew M. Kuchling42877fe2010-12-15 02:37:01 +0000274 PEP written by Brian Quinlan.
Georg Brandl97b20da2010-11-16 15:15:29 +0000275
Raymond Hettinger83d80792010-12-08 06:48:33 +0000276 :ref:`Code for Threaded Parallel URL reads<threadpoolexecutor-example>`, an
277 example using threads to fetch multiple web pages in parallel.
278
279 :ref:`Code for computing prime numbers in
280 parallel<processpoolexecutor-example>`, an example demonstrating
281 :class:`~concurrent.futures.ProcessPoolExecutor`.
282
283
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000284PEP 3147: PYC Repository Directories
285=====================================
286
David Malcolm778645a2010-12-07 00:32:04 +0000287Python's scheme for caching bytecode in *.pyc* files did not work well in
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000288environments with multiple Python interpreters. If one interpreter encountered
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000289a cached file created by another interpreter, it would recompile the source and
290overwrite the cached file, thus losing the benefits of caching.
291
292The issue of "pyc fights" has become more pronounced as it has become
Éric Araujo4234ad42010-09-05 17:32:25 +0000293commonplace for Linux distributions to ship with multiple versions of Python.
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000294These conflicts also arise with CPython alternatives such as Unladen Swallow.
295
296To solve this problem, Python's import machinery has been extended to use
Éric Araujo4234ad42010-09-05 17:32:25 +0000297distinct filenames for each interpreter. Instead of Python 3.2 and Python 3.3 and
298Unladen Swallow each competing for a file called "mymodule.pyc", they will now
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000299look for "mymodule.cpython-32.pyc", "mymodule.cpython-33.pyc", and
Éric Araujo4234ad42010-09-05 17:32:25 +0000300"mymodule.unladen10.pyc". And to prevent all of these new files from
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000301cluttering source directories, the *pyc* files are now collected in a
302"__pycache__" directory stored under the package directory.
303
304Aside from the filenames and target directories, the new scheme has a few
305aspects that are visible to the programmer:
306
Georg Brandlda0a2112010-09-05 11:28:33 +0000307* Imported modules now have a :attr:`__cached__` attribute which stores the name
308 of the actual file that was imported:
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000309
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000310 >>> import collections
311 >>> collections.__cached__
312 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000313
314* The tag that is unique to each interpreter is accessible from the :mod:`imp`
Georg Brandlda0a2112010-09-05 11:28:33 +0000315 module:
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000316
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000317 >>> import imp
318 >>> imp.get_tag()
319 'cpython-32'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000320
321* Scripts that try to deduce source filename from the imported file now need to
322 be smarter. It is no longer sufficient to simply strip the "c" from a ".pyc"
323 filename. Instead, use the new functions in the :mod:`imp` module:
324
Georg Brandlda0a2112010-09-05 11:28:33 +0000325 >>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc')
326 'c:/py32/lib/collections.py'
327 >>> imp.cache_from_source('c:/py32/lib/collections.py')
328 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000329
330* The :mod:`py_compile` and :mod:`compileall` modules have been updated to
331 reflect the new naming convention and target directory.
332
Raymond Hettinger1dcc84e2011-01-17 21:55:40 +0000333* The :mod:`importlib.abc` module has been updated with new :term:`abstract base
Raymond Hettinger66352d22011-01-17 22:33:11 +0000334 classes <abstract base class>` for the loading bytecode files. The obsolete
335 ABCs, :class:`~importlib.abc.PyLoader` and
Raymond Hettinger1dcc84e2011-01-17 21:55:40 +0000336 :class:`~importlib.abc.PyPycLoader`, have been deprecated (instructions on how
Raymond Hettinger66352d22011-01-17 22:33:11 +0000337 to stay Python 3.1 compatible are included with the documentation).
Brett Cannon83a682d2011-01-16 21:02:09 +0000338
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000339.. seealso::
340
341 :pep:`3147` - PYC Repository Directories
342 PEP written by Barry Warsaw.
343
Georg Brandlda0a2112010-09-05 11:28:33 +0000344
Georg Brandl3ad46752010-12-05 07:59:29 +0000345PEP 3149: ABI Version Tagged .so Files
346======================================
Georg Brandlf11c6c42010-09-03 22:20:58 +0000347
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000348The PYC repository directory allows multiple bytecode cache files to be
349co-located. This PEP implements a similar mechanism for shared object files by
350giving them a common directory and distinct names for each version.
Georg Brandlf11c6c42010-09-03 22:20:58 +0000351
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000352The common directory is "pyshared" and the file names are made distinct by
353identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the
354major and minor version numbers, and optional build flags (such as "d" for
Éric Araujo4234ad42010-09-05 17:32:25 +0000355debug, "m" for pymalloc, "u" for wide-unicode). For an arbitrary package "foo",
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000356you may see these files when the distribution package is installed::
357
358 /usr/share/pyshared/foo.cpython-32m.so
359 /usr/share/pyshared/foo.cpython-33md.so
360
361In Python itself, the tags are accessible from functions in the :mod:`sysconfig`
362module::
363
364 >>> import sysconfig
365 >>> sysconfig.get_config_var('SOABI') # find the version tag
366 'cpython-32mu'
367 >>> sysconfig.get_config_var('SO') # find the full filename extension
368 'cpython-32mu.so'
369
370.. seealso::
371
372 :pep:`3149` - ABI Version Tagged .so Files
373 PEP written by Barry Warsaw.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000374
Raymond Hettingerca904be2011-01-18 00:02:40 +0000375
Raymond Hettinger3df46212011-01-06 02:01:26 +0000376PEP 3333: Python Web Server Gateway Interface v1.0.1
377=====================================================
378
379This informational PEP clarifies how bytes/text issues are to be handled by the
380WGSI protocol. The challenge is that string handling in Python 3 is most
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000381conveniently handled with the :class:`str` type even though the HTTP protocol
Raymond Hettinger3df46212011-01-06 02:01:26 +0000382is itself bytes oriented.
383
384The PEP differentiates so-called *native strings* that are used for
385request/response headers and metadata versus *byte strings* which are used for
386the bodies of requests and responses.
387
388The *native strings* are always of type :class:`str` but are restricted to code
Georg Brandl52a43b52011-01-16 09:11:45 +0000389points between *U+0000* through *U+00FF* which are translatable to bytes using
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000390*Latin-1* encoding. These strings are used for the keys and values in the
391environ dictionary and for response headers and statuses in the
392:func:`start_response` function. They must follow :rfc:`2616` with respect to
Raymond Hettinger3df46212011-01-06 02:01:26 +0000393encoding. That is, they must either be *ISO-8859-1* characters or use
394:rfc:`2047` MIME encoding.
395
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000396For developers porting WSGI applications from Python 2, here are the salient
397points:
398
399* If the app already used strings for headers in Python 2, no change is needed.
400
401* If instead, the app encoded output headers or decoded input headers, then the
402 headers will need to be re-encoded to Latin-1. For example, an output header
403 encoded in utf-8 was using ``h.encode('utf-8')`` now needs to convert from
404 bytes to native strings using ``h.encode('utf-8').decode('latin-1')``.
405
406* Values yielded by an application or sent using the :meth:`write` method
Raymond Hettinger51e21072011-01-10 23:38:15 +0000407 must be byte strings. The :func:`start_response` function and environ
408 must use native strings. The two cannot be mixed.
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000409
410For server implementers writing CGI-to-WSGI pathways or other CGI-style
411protocols, the users must to be able access the environment using native strings
Raymond Hettingerc136b042011-01-18 07:15:39 +0000412even though the underlying platform may have a different convention. To bridge
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000413this gap, the :mod:`wsgiref` module has a new function,
414:func:`wsgiref.handlers.read_environ` for transcoding CGI variables from
415:attr:`os.environ` into native strings and returning a new dictionary.
Raymond Hettinger3df46212011-01-06 02:01:26 +0000416
417.. seealso::
418
419 :pep:`3333` - Python Web Server Gateway Interface v1.0.1
420 PEP written by Phillip Eby.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000421
Raymond Hettingerca904be2011-01-18 00:02:40 +0000422
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000423Other Language Changes
424======================
425
426Some smaller changes made to the core Python language are:
427
Raymond Hettingere5e1a982010-12-05 08:35:21 +0000428* String formatting for :func:`format` and :meth:`str.format` gained new
429 capabilities for the format character **#**. Previously, for integers in
430 binary, octal, or hexadecimal, it caused the output to be prefixed with '0b',
431 '0o', or '0x' respectively. Now it can also handle floats, complex, and
432 Decimal, causing the output to always have a decimal point even when no digits
433 follow it.
Raymond Hettingere5e728b2010-12-05 06:35:16 +0000434
435 >>> format(20, '#o')
436 '0o24'
437 >>> format(12.34, '#5.0f')
438 ' 12.'
439
440 (Suggested by Mark Dickinson and implemented by Eric Smith in :issue:`7094`.)
Raymond Hettinger43b5a852010-12-05 04:04:21 +0000441
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000442* The interpreter can now be started with a quiet option, ``-q``, to suppress
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000443 the copyright and version information from being displayed in the interactive
444 mode. The option can be introspected using the :attr:`sys.flags` attribute::
Raymond Hettinger7d967712011-01-05 20:24:08 +0000445
446 $ python -q
447 >>> sys.flags
448 sys.flags(debug=0, division_warning=0, inspect=0, interactive=0,
449 optimize=0, dont_write_bytecode=0, no_user_site=0, no_site=0,
450 ignore_environment=0, verbose=0, bytes_warning=0, quiet=1)
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000451
Raymond Hettinger51e21072011-01-10 23:38:15 +0000452 (Contributed by Marcin Wojdyr in :issue:`1772833`).
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000453
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000454* The :func:`hasattr` function works by calling :func:`getattr` and detecting
455 whether an exception is raised. This technique allows it to detect methods
456 created dynamically by :meth:`__getattr__` or :meth:`__getattribute__` which
Raymond Hettinger90a4b312011-01-06 02:08:30 +0000457 would otherwise be absent from the class dictionary. Formerly, *hasattr*
458 would catch any exception, possibly masking genuine errors. Now, *hasattr*
459 has been tightened to only catch :exc:`AttributeError` and let other
460 exceptions pass through.
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000461
Raymond Hettingera55ffbc2010-12-15 18:31:57 +0000462 (Discovered by Yury Selivanov and fixed by Benjamin Peterson; :issue:`9666`.)
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000463
Éric Araujo4234ad42010-09-05 17:32:25 +0000464* The :func:`str` of a float or complex number is now the same as its
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000465 :func:`repr`. Previously, the :func:`str` form was shorter but that just
Éric Araujo4234ad42010-09-05 17:32:25 +0000466 caused confusion and is no longer needed now that the shortest possible
Georg Brandlda0a2112010-09-05 11:28:33 +0000467 :func:`repr` is displayed by default:
Raymond Hettingerbb734c62010-09-05 05:56:44 +0000468
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000469 >>> repr(math.pi)
470 '3.141592653589793'
471 >>> str(math.pi)
472 '3.141592653589793'
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000473
Georg Brandlda0a2112010-09-05 11:28:33 +0000474 (Proposed and implemented by Mark Dickinson; :issue:`9337`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000475
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +0000476* :class:`memoryview` objects now have a :meth:`~memoryview.release()` method
477 and they also now support the context manager protocol. This allows timely
478 release of any resources that were acquired when requesting a buffer from the
479 original object.
Antoine Pitroud3052002010-09-15 15:09:40 +0000480
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000481 >>> with memoryview(b'abcdefgh') as v:
482 ... print(v.tolist())
483 ...
484 [97, 98, 99, 100, 101, 102, 103, 104]
485
Antoine Pitroud3052002010-09-15 15:09:40 +0000486 (Added by Antoine Pitrou; :issue:`9757`.)
487
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000488* Previously it was illegal to delete a name from the local namespace if it
489 occurs as a free variable in a nested block::
490
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000491 def outer(x):
492 def inner():
493 return x
494 inner()
495 del x
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000496
497 This is now allowed. Remember that the target of an :keyword:`except` clause
498 is cleared, so this code which used to work with Python 2.6, raised a
499 :exc:`SyntaxError` with Python 3.1 and now works again::
500
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000501 def f():
502 def print_error():
503 print(e)
504 try:
505 something
506 except Exception as e:
507 print_error()
508 # implicit "del e" here
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000509
510 (See :issue:`4617`.)
511
Raymond Hettinger480ed782010-12-15 22:07:15 +0000512* The internal :c:type:`structsequence` tool now creates subclasses of tuple.
Raymond Hettinger51e21072011-01-10 23:38:15 +0000513 This means that C structures like those returned by :func:`os.stat`,
Raymond Hettinger480ed782010-12-15 22:07:15 +0000514 :func:`time.gmtime`, and :func:`sys.version_info` now work like a
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000515 :term:`named tuple` and now work with functions and methods that
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000516 expect a tuple as an argument. This is a big step forward in making the C
Raymond Hettinger480ed782010-12-15 22:07:15 +0000517 structures as flexible as their pure Python counterparts.
518
519 (Suggested by Arfrever Frehtes Taifersar Arahesis and implemented
520 by Benjamin Peterson in :issue:`8413`.)
521
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000522* Warnings are now easier to control using the :envvar:`PYTHONWARNINGS`
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000523 environment variable as an alternative to using ``-W`` at the command line.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000524
525 (Suggested by Barry Warsaw and implemented by Philip Jenvey in :issue:`7301`.)
526
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000527* A new warning category, :exc:`ResourceWarning`, has been added. It is
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000528 emitted when potential issues with resource consumption or cleanup
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000529 are detected. It is silenced by default in normal release builds but
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000530 can be enabled through the means provided by the :mod:`warnings`
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000531 module, or on the command line.
532
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000533 A :exc:`ResourceWarning` is issued at interpreter shutdown if the
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000534 :data:`gc.garbage` list isn't empty. This is meant to make the programmer
535 aware that their code contains object finalization issues.
536
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000537 A :exc:`ResourceWarning` is also issued when a :term:`file object` is destroyed
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000538 without having been explicitly closed. While the deallocator for such
539 object ensures it closes the underlying operating system resource
540 (usually, a file descriptor), the delay in deallocating the object could
541 produce various issues, especially under Windows. Here is an example
542 of enabling the warning from the command line::
543
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000544 $ python -q -Wdefault
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000545 >>> f = open("foo", "wb")
546 >>> del f
547 __main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000548
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000549 (Added by Antoine Pitrou and Georg Brandl in :issue:`10093` and :issue:`477863`.)
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000550
Raymond Hettingera0266332010-12-07 08:52:41 +0000551* :class:`range` objects now support *index* and *count* methods. This is part
552 of an effort to make more objects fully implement the
553 :class:`collections.Sequence` :term:`abstract base class`. As a result, the
554 language will have a more uniform API. In addition, :class:`range` objects
Raymond Hettingerb9656292011-01-16 18:22:06 +0000555 now support slicing and negative indices, even with values larger than
556 :attr:`sys.maxsize`. This makes *range* more interoperable with lists::
Raymond Hettinger2ffa6712010-12-08 10:18:21 +0000557
558 >>> range(0, 100, 2).count(10)
559 1
560 >>> range(0, 100, 2).index(10)
561 5
562 >>> range(0, 100, 2)[5]
563 10
564 >>> range(0, 100, 2)[0:5]
565 range(0, 10, 2)
Raymond Hettingerdadf93c2010-12-05 02:56:21 +0000566
Raymond Hettingerb9656292011-01-16 18:22:06 +0000567 (Contributed by Daniel Stutzbach in :issue:`9213`, by Alexander Belopolsky
568 in :issue:`2690`, and by Nick Coghlan in :issue:`10889`.)
Nick Coghlan37ee8502010-12-03 14:26:13 +0000569
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000570* The :func:`callable` builtin function from Py2.x was resurrected. It provides
Raymond Hettingerb87ba262010-12-06 04:31:40 +0000571 a concise, readable alternative to using an :term:`abstract base class` in an
Raymond Hettinger792c0762010-12-09 16:41:54 +0000572 expression like ``isinstance(x, collections.Callable)``:
573
574 >>> callable(max)
575 True
576 >>> callable(20)
577 False
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000578
579 (See :issue:`10518`.)
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000580
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000581* Python's import mechanism can now load modules installed in directories with
Raymond Hettinger070ec702010-12-10 17:45:13 +0000582 non-ASCII characters in the path name.
583
584 (Required extensive work by Victor Stinner in :issue:`9425`.)
585
586
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000587New, Improved, and Deprecated Modules
588=====================================
589
Raymond Hettinger99db3fd2010-12-15 19:33:49 +0000590Python's standard library has undergone significant maintenance efforts and
591quality improvements.
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000592
593The biggest news for Python 3.2 is that the :mod:`email` package and
Raymond Hettinger99db3fd2010-12-15 19:33:49 +0000594:mod:`nntplib` modules now work correctly with the bytes/text model in Python 3.
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000595For the first time, there is correct handling of inputs with mixed encodings.
596
Raymond Hettinger6046e222010-12-16 00:21:08 +0000597Throughout the standard library, there has been more careful attention to
598encodings and text versus bytes issues. In particular, interactions with the
599operating system are now better able to pass non-ASCII data using the Windows
Raymond Hettingerba5512f2011-01-18 08:28:01 +0000600MBCS encoding, locale-aware encodings, or UTF-8.
Raymond Hettinger6046e222010-12-16 00:21:08 +0000601
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000602Another significant win is the addition of substantially better support for
603*SSL* connections and security certificates.
604
Raymond Hettinger51e21072011-01-10 23:38:15 +0000605In addition, more classes now implement a :term:`context manager` to support
Raymond Hettingerc136b042011-01-18 07:15:39 +0000606convenient and reliable resource clean-up using a :keyword:`with` statement.
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000607
Raymond Hettinger0358a172010-12-15 19:00:38 +0000608email
609-----
610
611The usability of the :mod:`email` package in Python 3 has been mostly fixed by
612the extensive efforts of R. David Murray. The problem was that emails are
613typically read and stored in the form of :class:`bytes` rather than :class:`str`
614text, and they may contain multiple encodings within a single email. So, the
615email package had to be extended to parse and generate email messages in bytes
616format.
617
618* New functions :func:`~email.message_from_bytes` and
619 :func:`~email.message_from_binary_file`, and new classes
620 :class:`~email.parser.BytesFeedParser` and :class:`~email.parser.BytesParser`
621 allow binary message data to be parsed into model objects.
622
623* Given bytes input to the model, :meth:`~email.message.Message.get_payload`
624 will by default decode a message body that has a
625 :mailheader:`Content-Transfer-Encoding` of *8bit* using the charset
626 specified in the MIME headers and return the resulting string.
627
628* Given bytes input to the model, :class:`~email.generator.Generator` will
629 convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of
630 *8bit* to instead have a *7bit* :mailheader:`Content-Transfer-Encoding`.
Raymond Hettingerc08ea612011-01-08 10:32:31 +0000631
Raymond Hettingercf8a3822011-01-11 21:20:20 +0000632 Headers with unencoded non-ASCII bytes are deemed to be :rfc:`2047`\ -encoded
633 using the *unknown-8bit* character set.
Raymond Hettinger0358a172010-12-15 19:00:38 +0000634
635* A new class :class:`~email.generator.BytesGenerator` produces bytes as output,
636 preserving any unchanged non-ASCII data that was present in the input used to
637 build the model, including message bodies with a
638 :mailheader:`Content-Transfer-Encoding` of *8bit*.
639
640* The :mod:`smtplib` :class:`~smtplib.SMTP` class now accepts a byte string
641 for the *msg* argument to the :meth:`~smtplib.SMTP.sendmail` method,
642 and a new method, :meth:`~smtplib.SMTP.send_message` accepts a
643 :class:`~email.message.Message` object and can optionally obtain the
644 *from_addr* and *to_addrs* addresses directly from the object.
645
Raymond Hettinger0358a172010-12-15 19:00:38 +0000646(Proposed and implemented by R. David Murray, :issue:`4661` and :issue:`10321`.)
647
Raymond Hettinger6046e222010-12-16 00:21:08 +0000648elementtree
649-----------
650
Georg Brandl5d53fdd2010-12-18 11:58:12 +0000651The :mod:`xml.etree.ElementTree` package and its :mod:`xml.etree.cElementTree`
Raymond Hettinger6046e222010-12-16 00:21:08 +0000652counterpart have been updated to version 1.3.
653
654Several new and useful functions and methods have been added:
655
656* :func:`xml.etree.ElementTree.fromstringlist` which builds an XML document
657 from a sequence of fragments
658* :func:`xml.etree.ElementTree.register_namespace` for registering a global
659 namespace prefix
660* :func:`xml.etree.ElementTree.tostringlist` for string representation
661 including all sublists
662* :meth:`xml.etree.ElementTree.Element.extend` for appending a sequence of zero
663 or more elements
664* :meth:`xml.etree.ElementTree.Element.iterfind` searches an element and
665 subelements
666* :meth:`xml.etree.ElementTree.Element.itertext` creates a text iterator over
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000667 an element and its subelements
Raymond Hettinger6046e222010-12-16 00:21:08 +0000668* :meth:`xml.etree.ElementTree.TreeBuilder.end` closes the current element
669* :meth:`xml.etree.ElementTree.TreeBuilder.doctype` handles a doctype
670 declaration
671
672Two methods have been deprecated:
673
674* :meth:`xml.etree.ElementTree.getchildren` use ``list(elem)`` instead.
675* :meth:`xml.etree.ElementTree.getiterator` use ``Element.iter`` instead.
676
677For details of the update, see `Introducing ElementTree
678<http://effbot.org/zone/elementtree-13-intro.htm>`_ on Fredrik Lundh's website.
679
Antoine Pitrou12de8ac2010-12-16 13:33:56 +0000680(Contributed by Florent Xicluna and Fredrik Lundh, :issue:`6472`.)
Raymond Hettinger0358a172010-12-15 19:00:38 +0000681
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000682functools
683---------
684
Éric Araujo4234ad42010-09-05 17:32:25 +0000685* The :mod:`functools` module includes a new decorator for caching function
Georg Brandlda0a2112010-09-05 11:28:33 +0000686 calls. :func:`functools.lru_cache` can save repeated queries to an external
687 resource whenever the results are expected to be the same.
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000688
Raymond Hettinger86f96132010-08-06 23:23:49 +0000689 For example, adding a caching decorator to a database query function can save
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000690 database accesses for popular searches:
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000691
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000692 >>> @functools.lru_cache(maxsize=300)
693 >>> def get_phone_number(name):
694 c = conn.cursor()
695 c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,))
696 return c.fetchone()[0]
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000697
Georg Brandlda0a2112010-09-05 11:28:33 +0000698 >>> for name in user_requests:
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000699 get_phone_number(name) # cached lookup
Raymond Hettinger7496b412010-11-30 19:15:45 +0000700
701 To help with choosing an effective cache size, the wrapped function is
702 instrumented for tracking cache statistics:
703
Raymond Hettinger5e20bab2010-11-30 07:13:04 +0000704 >>> get_phone_number.cache_info()
Raymond Hettinger7496b412010-11-30 19:15:45 +0000705 CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300)
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000706
Raymond Hettingerf3098282010-08-15 03:30:45 +0000707 If the phonelist table gets updated, the outdated contents of the cache can be
Georg Brandlda0a2112010-09-05 11:28:33 +0000708 cleared with:
Raymond Hettingerf3098282010-08-15 03:30:45 +0000709
Georg Brandlda0a2112010-09-05 11:28:33 +0000710 >>> get_phone_number.cache_clear()
Raymond Hettingerf3098282010-08-15 03:30:45 +0000711
Raymond Hettinger6e353942010-12-04 23:42:12 +0000712 (Contributed by Raymond Hettinger and incorporating design ideas from
Raymond Hettingerb87ba262010-12-06 04:31:40 +0000713 Jim Baker, Miki Tebeka, and Nick Coghlan.)
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000714
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000715* The :func:`functools.wraps` decorator now adds a :attr:`__wrapped__` attribute
716 pointing to the original callable function. This allows wrapped functions to
717 be introspected. It also copies :attr:`__annotations__` if defined. And now
718 it also gracefully skips over missing attributes such as :attr:`__doc__` which
Raymond Hettinger5eb63902010-12-09 23:43:34 +0000719 might not be defined for the wrapped callable.
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000720
721 (By Nick Coghlan and Terrence Cole; :issue:`9567`, :issue:`3445`, and
722 :issue:`8814`.)
723
Raymond Hettinger6046e222010-12-16 00:21:08 +0000724* To help write classes with rich comparison methods, a new decorator
725 :func:`functools.total_ordering` will use a existing equality and inequality
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000726 methods to fill in the remaining methods.
Raymond Hettinger6046e222010-12-16 00:21:08 +0000727
728 For example, supplying *__eq__* and *__lt__* will enable
729 :func:`~functools.total_ordering` to fill-in *__le__*, *__gt__* and *__ge__*::
730
731 @total_ordering
732 class Student:
733 def __eq__(self, other):
734 return ((self.lastname.lower(), self.firstname.lower()) ==
735 (other.lastname.lower(), other.firstname.lower()))
736 def __lt__(self, other):
737 return ((self.lastname.lower(), self.firstname.lower()) <
738 (other.lastname.lower(), other.firstname.lower()))
739
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000740 With the *total_ordering* decorator, the remaining comparison methods
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000741 are filled in automatically.
Raymond Hettinger6046e222010-12-16 00:21:08 +0000742
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000743 (Contributed by Raymond Hettinger.)
Raymond Hettingerf35a34c2010-12-22 09:11:54 +0000744
Raymond Hettinger4bea9782011-01-19 04:14:34 +0000745* To aid in porting programs from Python 2, the :func:`functools.cmp_to_key`
Raymond Hettingerbb9686f2010-12-16 00:53:05 +0000746 function converts an old-style comparison function to
Raymond Hettinger6046e222010-12-16 00:21:08 +0000747 modern :term:`key function`:
748
749 >>> # locale-aware sort order
750 >>> sorted(iterable, key=cmp_to_key(locale.strcoll))
751
752 For sorting examples and a brief sorting tutorial, see the `Sorting HowTo
753 <http://wiki.python.org/moin/HowTo/Sorting/>`_ tutorial.
754
755 (Contributed by Raymond Hettinger.)
756
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000757itertools
758---------
759
Raymond Hettinger673ccf22010-12-07 09:37:11 +0000760* The :mod:`itertools` module has a new :func:`~itertools.accumulate` function
Raymond Hettinger4bea9782011-01-19 04:14:34 +0000761 modeled on APL's *scan* operator and Numpy's *accumulate* function:
Raymond Hettinger6e353942010-12-04 23:42:12 +0000762
763 >>> list(accumulate(8, 2, 50))
764 [8, 10, 60]
765
766 >>> prob_dist = [0.1, 0.4, 0.2, 0.3]
767 >>> list(accumulate(prob_dist)) # cumulative probability distribution
768 [0.1, 0.5, 0.7, 1.0]
769
770 For an example using :func:`~itertools.accumulate`, see the :ref:`examples for
771 the random module <random-examples>`.
772
773 (Contributed by Raymond Hettinger and incorporating design suggestions
774 from Mark Dickinson.)
775
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000776collections
777-----------
778
Raymond Hettinger792c0762010-12-09 16:41:54 +0000779* The :class:`collections.Counter` class now has two forms of in-place
780 subtraction, the existing *-=* operator for `saturating subtraction
781 <http://en.wikipedia.org/wiki/Saturation_arithmetic>`_ and the new
782 :meth:`~collections.Counter.subtract` method for regular subtraction. The
783 former is suitable for `multisets <http://en.wikipedia.org/wiki/Multiset>`_
Raymond Hettingerffad35e2010-12-14 21:12:03 +0000784 which only have positive counts, and the latter is more suitable for use cases
Raymond Hettinger792c0762010-12-09 16:41:54 +0000785 that allow negative counts:
Alexander Belopolsky72572312010-12-08 21:21:56 +0000786
Raymond Hettinger792c0762010-12-09 16:41:54 +0000787 >>> tally = Counter(dogs=5, cat=3)
788 >>> tally -= Counter(dogs=2, cats=8) # saturating subtraction
789 >>> tally
790 Counter({'dogs': 3})
Alexander Belopolsky72572312010-12-08 21:21:56 +0000791
Raymond Hettinger792c0762010-12-09 16:41:54 +0000792 >>> tally = Counter(dogs=5, cats=3)
793 >>> tally.subtract(dogs=2, cats=8) # regular subtraction
794 >>> tally
795 Counter({'dogs': 3, 'cats': -5})
Alexander Belopolsky72572312010-12-08 21:21:56 +0000796
Raymond Hettinger792c0762010-12-09 16:41:54 +0000797 (Contributed by Raymond Hettinger.)
Alexander Belopolsky72572312010-12-08 21:21:56 +0000798
Raymond Hettingere0a96002010-12-15 17:54:13 +0000799* The :class:`collections.OrderedDict` class has a new method
800 :meth:`~collections.OrderedDict.move_to_end` which takes an existing key and
Raymond Hettinger23ab1012011-01-18 20:25:04 +0000801 moves it to either the first or last position in the ordered sequence.
802
803 The default is to move an item to the last position. This is equivalent of
804 renewing an entry with ``od[k] = od.pop(k)``.
805
806 A fast move-to-end operation is useful for resequencing entries. For example,
807 an ordered dictionary can being used to track access order by aging entries
808 from oldest to most recently accessed.
Raymond Hettingere0a96002010-12-15 17:54:13 +0000809
810 >>> d = OrderedDict.fromkeys(['a', 'b', 'X', 'd', 'e'])
811 >>> list(d)
812 ['a', 'b', 'X', 'd', 'e']
Raymond Hettinger23ab1012011-01-18 20:25:04 +0000813 >>> d.move_to_end('X')
Raymond Hettingere0a96002010-12-15 17:54:13 +0000814 >>> list(d)
815 ['a', 'b', 'd', 'e', 'X']
Raymond Hettingere0a96002010-12-15 17:54:13 +0000816
Raymond Hettinger6046e222010-12-16 00:21:08 +0000817 (Contributed by Raymond Hettinger.)
818
Raymond Hettinger7ec790d2011-01-18 00:19:30 +0000819* The :class:`collections.deque` class grew two new methods
820 :meth:`~collections.deque.count` and :meth:`~collections.deque.reverse` that
821 make them more substitutable for :class:`list` objects:
Raymond Hettinger6046e222010-12-16 00:21:08 +0000822
823 >>> d = deque('simsalabim')
824 >>> d.count('s')
825 2
826 >>> d.reverse()
827 >>> d
828 deque(['m', 'i', 'b', 'a', 'l', 'a', 's', 'm', 'i', 's'])
829
830 (Contributed by Raymond Hettinger.)
831
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000832threading
833---------
834
835The :mod:`threading` module has a new :class:`~threading.Barrier`
836synchronization class for making multiple threads wait until all of them have
837reached a common barrier point. Barriers are useful for making sure that a task
838with multiple preconditions does not run until all of the predecessor tasks are
839complete.
840
841Barriers can work with an arbitrary number of threads. This is a generalization
842of a `Rendezvous <http://en.wikipedia.org/wiki/Synchronous_rendezvous>`_ which
843is defined for only two threads.
844
Raymond Hettinger15b47c52011-01-17 21:05:07 +0000845Implemented as a two-phase cyclic barrier, :class:`~threading.Barrier` objects
846are suitable for use in loops. The separate *filling* and *draining* phases
Raymond Hettingere0f1f322011-01-18 21:14:27 +0000847assure that all threads get released (drained) before any one of them can loop
848back and re-enter the barrier. The barrier fully resets after each cycle.
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000849
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000850Example of using barriers::
851
852 def get_votes(site):
853 ballots = conduct_election(site)
854 all_polls_closed.wait() # do not count until all polls are closed
Raymond Hettinger97673652011-01-11 21:13:26 +0000855 totals = summarize(ballots)
856 publish(site, totals)
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000857
858 all_polls_closed = Barrier(len(sites))
Raymond Hettinger3a8ae5f2011-01-11 20:51:45 +0000859 for site in sites:
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000860 Thread(target=get_votes, args=(site,)).start()
861
862In this example, the barrier enforces a rule that votes cannot be counted at any
863polling site until all polls are closed. Notice how a solution with a barrier
864is similar to one with :meth:`threading.Thread.join`, but the threads stay alive
865and continue to do work (summarizing ballots) after the barrier point is
866crossed.
867
Raymond Hettinger2c3865b2011-01-18 22:58:33 +0000868If any of the predecessor tasks can hang or be delayed, a barrier can be created
869with an optional *timeout* parameter. Then if the timeout period elapses before
870all the predecessor tasks reach the barrier point, all waiting threads are
871released and a :exc:`~threading.BrokenBarrierError` exception is raised::
872
873 def get_votes(site):
874 ballots = conduct_election(site)
875 try:
876 all_polls_closed.wait(timeout = midnight - time.now())
David Malcolm49348642011-01-18 23:45:53 +0000877 except BrokenBarrierError:
Raymond Hettinger2c3865b2011-01-18 22:58:33 +0000878 lockbox = seal_ballots(ballots)
879 queue.put(lockbox)
880 else:
881 totals = summarize(ballots)
882 publish(site, totals)
883
884In this example, the barrier enforces a more robust rule. If some election
885sites do not finish before midnight, the barrier times-out and the ballots are
886sealed and deposited in a queue for later handling.
887
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000888See `Barrier Synchronization Patterns
Raymond Hettinger3a8ae5f2011-01-11 20:51:45 +0000889<http://parlab.eecs.berkeley.edu/wiki/_media/patterns/paraplop_g1_3.pdf>`_ for
890more examples of how barriers can be used in parallel computing. Also, there is
891a simple but thorough explanation of barriers in `The Little Book of Semaphores
892<http://greenteapress.com/semaphores/downey08semaphores.pdf>`_, *section 3.6*.
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000893
Raymond Hettinger3a8ae5f2011-01-11 20:51:45 +0000894(Contributed by Kristján Valur Jónsson with an API review by Jeffrey Yasskin in
895:issue:`8777`.)
Raymond Hettinger6655d112011-01-11 08:49:10 +0000896
Raymond Hettinger97673652011-01-11 21:13:26 +0000897datetime and time
898-----------------
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000899
Raymond Hettinger792c0762010-12-09 16:41:54 +0000900* The :mod:`datetime` module has a new type :class:`~datetime.timezone` that
901 implements the :class:`~datetime.tzinfo` interface by returning a fixed UTC
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000902 offset and timezone name. This makes it easier to create timezone-aware
Raymond Hettinger792c0762010-12-09 16:41:54 +0000903 datetime objects:
Alexander Belopolsky72572312010-12-08 21:21:56 +0000904
Raymond Hettinger792c0762010-12-09 16:41:54 +0000905 >>> datetime.now(timezone.utc)
906 datetime.datetime(2010, 12, 8, 21, 4, 2, 923754, tzinfo=datetime.timezone.utc)
Alexander Belopolsky72572312010-12-08 21:21:56 +0000907
Raymond Hettinger792c0762010-12-09 16:41:54 +0000908 >>> datetime.strptime("01/01/2000 12:00 +0000", "%m/%d/%Y %H:%M %z")
909 datetime.datetime(2000, 1, 1, 12, 0, tzinfo=datetime.timezone.utc)
Alexander Belopolsky72572312010-12-08 21:21:56 +0000910
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000911* Also, :class:`~datetime.timedelta` objects can now be multiplied by
Raymond Hettinger792c0762010-12-09 16:41:54 +0000912 :class:`float` and divided by :class:`float` and :class:`int` objects.
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000913 And :class:`~datetime.timedelta` objects can now divide one another.
Raymond Hettinger792c0762010-12-09 16:41:54 +0000914
Raymond Hettingerca904be2011-01-18 00:02:40 +0000915* The :meth:`datetime.date.strftime` method is no longer restricted to years
916 after 1900. The new supported year range is from 1000 to 9999 inclusive.
Alexander Belopolsky72572312010-12-08 21:21:56 +0000917
Raymond Hettinger97673652011-01-11 21:13:26 +0000918* The rules for two-digit years in time tuples have changed. Now, the
919 :func:`time.asctime` and :func:`time.strftime` functions will format any year
920 when :attr:`time.accept2dyear` is false and will accept four-digit years
921 otherwise. The :func:`time.mktime` and :func:`time.strftime` functions now
922 accept full range supported by the operating system. Conversion of two-digit
923 years to four-digit is deprecated.
Alexander Belopolskybd96b062011-01-10 21:55:34 +0000924
Raymond Hettinger97673652011-01-11 21:13:26 +0000925(Contributed by Alexander Belopolsky and Victor Stinner.)
Alexander Belopolskybd96b062011-01-10 21:55:34 +0000926
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000927abc
928---
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000929
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000930The :mod:`abc` module now supports :func:`~abc.abstractclassmethod` and
931:func:`~abc.abstractstaticmethod`.
Raymond Hettingera5a35542010-12-05 00:39:18 +0000932
Raymond Hettinger7ec790d2011-01-18 00:19:30 +0000933These tools make it possible to define an :term:`abstract base class` that
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000934requires a particular :func:`classmethod` or :func:`staticmethod` to be
Raymond Hettinger7ec790d2011-01-18 00:19:30 +0000935implemented::
936
937 class Temperature(metaclass=ABCMeta):
938 @abc.abstractclassmethod
939 def from_farenheit(self, t):
940 ...
941 @abc.abstractclassmethod
942 def from_celsium(self, t):
943 ...
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000944
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000945(Patch submitted by Daniel Urban; :issue:`5867`.)
Raymond Hettingerbcbd6962010-09-05 08:46:36 +0000946
Raymond Hettinger480ed782010-12-15 22:07:15 +0000947contextlib
948----------
949
950There is a new and slightly mind-blowing tool
951:class:`~contextlib.ContextDecorator` that is helpful for creating a
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000952:term:`context manager` that does double duty as a function decorator.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000953
954As a convenience, this new functionality is used by
955:func:`~contextlib.contextmanager` so that no extra effort is needed to support
956both roles.
957
958The basic idea is that both context managers and function decorators can be used
959for pre-action and post-action wrappers. Context managers wrap a group of
Raymond Hettingerc136b042011-01-18 07:15:39 +0000960statements using a :keyword:`with` statement, and function decorators wrap a
Raymond Hettinger480ed782010-12-15 22:07:15 +0000961group of statements enclosed in a function. So, occasionally there is a need to
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000962write a pre-action or post-action wrapper that can be used in either role.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000963
964For example, it is sometimes useful to wrap functions or groups of statements
965with a logger that can track the time of entry and time of exit. Rather than
966writing both a function decorator and a context manager for the task, the
967:func:`~contextlib.contextmanager` provides both capabilities in a single
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000968definition::
Raymond Hettinger480ed782010-12-15 22:07:15 +0000969
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000970 import logging
971 logging.basicConfig(level=logging.INFO)
972 @contextmanager
973 def track_entry_and_exit(name):
974 logging.info('Entering: {}'.format(name))
975 yield
976 logging.info('Exiting: {}'.format(name))
Raymond Hettinger480ed782010-12-15 22:07:15 +0000977
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000978Formerly, this would have only been usable as a context manager::
Raymond Hettinger480ed782010-12-15 22:07:15 +0000979
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000980 with track_entry_and_exit('widget loader'):
981 print('Some time consuming activity goes here')
982 load_widget()
Raymond Hettinger480ed782010-12-15 22:07:15 +0000983
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000984Now, it can be used as a decorator as well::
Raymond Hettinger480ed782010-12-15 22:07:15 +0000985
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000986 @track_entry_and_exit('widget loader')
987 def activity():
988 print('Some time consuming activity goes here')
989 load_widget()
Raymond Hettinger480ed782010-12-15 22:07:15 +0000990
991Trying to fulfill two roles at once places some limitations on the technique.
992Context managers normally have the flexibility to return an argument usable by
Raymond Hettingerc136b042011-01-18 07:15:39 +0000993a :keyword:`with` statement, but there is no parallel for function decorators.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000994
Raymond Hettinger9743e4f2010-12-16 02:24:12 +0000995In the above example, there is not a clean way for the *track_entry_and_exit*
Raymond Hettinger388af4b2011-01-06 20:55:29 +0000996context manager to return a logging instance for use in the body of enclosed
997statements.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000998
999(Contributed by Michael Foord in :issue:`9110`.)
1000
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001001decimal and fractions
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001002---------------------
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001003
1004Mark Dickinson crafted an elegant and efficient scheme for assuring that
1005different numeric datatypes will have the same hash value whenever their actual
1006values are equal (:issue:`8188`)::
1007
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001008 assert hash(Fraction(3, 2)) == hash(1.5) == \
1009 hash(Decimal("1.5")) == hash(complex(1.5, 0))
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001010
1011An early decision to limit the inter-operability of various numeric types has
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001012been relaxed. It is still unsupported (and ill-advised) to have implicit
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001013mixing in arithmetic expressions such as ``Decimal('1.1') + float('1.1')``
1014because the latter loses information in the process of constructing the binary
1015float. However, since existing floating point value can be converted losslessly
1016to either a decimal or rational representation, it makes sense to add them to
1017the constructor and to support mixed-type comparisons.
1018
Raymond Hettingerbb9686f2010-12-16 00:53:05 +00001019* The :class:`decimal.Decimal` constructor now accepts :class:`float` objects
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001020 directly so there in no longer a need to use the :meth:`~decimal.Decimal.from_float`
Raymond Hettinger6046e222010-12-16 00:21:08 +00001021 method (:issue:`8257`).
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001022
1023* Mixed type comparisons are now fully supported so that
1024 :class:`~decimal.Decimal` objects can be directly compared with :class:`float`
Raymond Hettinger6046e222010-12-16 00:21:08 +00001025 and :class:`fractions.Fraction` (:issue:`2531` and :issue:`8188`).
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001026
1027Similar changes were made to :class:`fractions.Fraction` so that the
1028:meth:`~fractions.Fraction.from_float()` and :meth:`~fractions.Fraction.from_decimal`
Raymond Hettinger6046e222010-12-16 00:21:08 +00001029methods are no longer needed (:issue:`8294`):
1030
1031>>> Decimal(1.1)
1032Decimal('1.100000000000000088817841970012523233890533447265625')
1033>>> Fraction(1.1)
1034Fraction(2476979795053773, 2251799813685248)
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001035
1036Another useful change for the :mod:`decimal` module is that the
1037:attr:`Context.clamp` attribute is now public. This is useful in creating
1038contexts that correspond to the decimal interchange formats specified in IEEE
1039754 (see :issue:`8540`).
1040
Raymond Hettinger6046e222010-12-16 00:21:08 +00001041(Contributed by Mark Dickinson and Raymond Hettinger.)
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001042
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001043ftp
1044---
Raymond Hettingerbcbd6962010-09-05 08:46:36 +00001045
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001046The :class:`ftplib.FTP` class now supports the context manager protocol to
1047unconditionally consume :exc:`socket.error` exceptions and to close the FTP
1048connection when done::
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +00001049
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001050 >>> from ftplib import FTP
1051 >>> with FTP("ftp1.at.proftpd.org") as ftp:
1052 ... ftp.login()
1053 ... ftp.dir()
1054 ...
1055 '230 Anonymous login ok, restrictions apply.'
1056 dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .
1057 dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 ..
1058 dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS
1059 dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora
Georg Brandlda0a2112010-09-05 11:28:33 +00001060
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001061Other file-like objects such as :class:`mmap.mmap` and :func:`fileinput.input`
1062also grew auto-closing context managers::
1063
1064 with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
1065 for line in f:
1066 process(line)
1067
1068(Contributed by Tarek Ziadé and Giampaolo Rodolà in :issue:`4972`, and
1069by Georg Brandl in :issue:`8046` and :issue:`1286`.)
Antoine Pitrou696e0352010-08-08 22:18:46 +00001070
Antoine Pitroubcba4342011-01-16 18:29:34 +00001071The :class:`~ftplib.FTP_TLS` class now accepts a *context* parameter, which is a
1072:class:`ssl.SSLContext` object allowing bundling SSL configuration options,
Raymond Hettinger4854d142011-01-17 21:29:58 +00001073certificates and private keys into a single (potentially long-lived) structure.
Antoine Pitroubcba4342011-01-16 18:29:34 +00001074
1075(Contributed by Giampaolo Rodolà; :issue:`8806`.)
1076
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001077popen
1078-----
1079
1080The :func:`os.popen` and :func:`subprocess.Popen` functions now support
Raymond Hettingerc136b042011-01-18 07:15:39 +00001081:keyword:`with` statements for auto-closing of the file descriptors.
Georg Brandl3ad46752010-12-05 07:59:29 +00001082
Raymond Hettinger6046e222010-12-16 00:21:08 +00001083gzip and zipfile
1084----------------
Antoine Pitroucd889af2010-10-06 21:13:56 +00001085
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001086:class:`gzip.GzipFile` now implements the :class:`io.BufferedIOBase`
1087:term:`abstract base class` (except for ``truncate()``). It also has a
1088:meth:`~gzip.GzipFile.peek` method and supports unseekable as well as
1089zero-padded file objects.
Raymond Hettingera0266332010-12-07 08:52:41 +00001090
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001091The :mod:`gzip` module also gains the :func:`~gzip.compress` and
1092:func:`~gzip.decompress` functions for easier in-memory compression and
Raymond Hettinger51e21072011-01-10 23:38:15 +00001093decompression. Keep in mind that text needs to be encoded as :class:`bytes`
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001094before compressing and decompressing:
Raymond Hettingera0266332010-12-07 08:52:41 +00001095
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001096>>> s = 'Three shall be the number thou shalt count, '
1097>>> s += 'and the number of the counting shall be three'
1098>>> b = s.encode() # convert to utf-8
1099>>> len(b)
110089
1101>>> c = gzip.compress(b)
1102>>> len(c)
110377
1104>>> gzip.decompress(c).decode()[:42] # decompress and convert to text
1105'Three shall be the number thou shalt count,'
Antoine Pitroucd889af2010-10-06 21:13:56 +00001106
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001107(Contributed by Anand B. Pillai in :issue:`3488`; and by Antoine Pitrou, Nir
1108Aides and Brian Curtin in :issue:`9962`, :issue:`1675951`, :issue:`7471` and
1109:issue:`2846`.)
1110
Raymond Hettinger6046e222010-12-16 00:21:08 +00001111Also, the :class:`zipfile.ZipExtFile` class was reworked internally to represent
1112files stored inside an archive. The new implementation is significantly faster
1113and can be wrapped in a :class:`io.BufferedReader` object for more speedups. It
1114also solves an issue where interleaved calls to *read* and *readline* gave the
1115wrong results.
1116
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001117(Patch submitted by Nir Aides in :issue:`7610`.)
Raymond Hettinger6046e222010-12-16 00:21:08 +00001118
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001119shutil
1120------
1121
1122The :func:`shutil.copytree` function has two new options:
Antoine Pitroud67075e2010-07-31 22:48:02 +00001123
Antoine Pitrou121a0552011-01-16 18:16:52 +00001124* *ignore_dangling_symlinks*: when ``symlinks=False`` so that the function
Raymond Hettingerc136b042011-01-18 07:15:39 +00001125 copies a file pointed to by a symlink, not the symlink itself. This option
1126 will silence the error raised if the file doesn't exist.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001127
Antoine Pitrou121a0552011-01-16 18:16:52 +00001128* *copy_function*: is a callable that will be used to copy files.
1129 :func:`shutil.copy2` is used by default.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001130
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001131(Contributed by Tarek Ziadé.)
Antoine Pitroud67075e2010-07-31 22:48:02 +00001132
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001133sqlite3
1134-------
Antoine Pitroue43f9d02010-08-08 23:24:50 +00001135
Raymond Hettinger6046e222010-12-16 00:21:08 +00001136The :mod:`sqlite3` module was updated to version 2.6.0. It has two new capabilities.
Antoine Pitroue43f9d02010-08-08 23:24:50 +00001137
Raymond Hettinger0358a172010-12-15 19:00:38 +00001138* The :attr:`sqlite3.Connection.in_transit` attribute is true if there is an
1139 active transaction for uncommitted changes.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001140
Raymond Hettinger0358a172010-12-15 19:00:38 +00001141* The :meth:`sqlite3.Connection.enable_load_extension` and
1142 :meth:`sqlite3.Connection.load_extension` methods allows you to load SQLite
1143 extensions from ".so" files. One well-known extension is the fulltext-search
1144 extension distributed with SQLite.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001145
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001146(Contributed by R. David Murray and Shashwat Anand; :issue:`8845`.)
1147
1148socket
1149------
1150
1151The :mod:`socket` module has two new improvements.
1152
1153* Socket objects now have a :meth:`~socket.socket.detach()` method which puts
1154 the socket into closed state without actually closing the underlying file
1155 descriptor. The latter can then be reused for other purposes.
1156 (Added by Antoine Pitrou; :issue:`8524`.)
1157
1158* :func:`socket.create_connection` now supports the context manager protocol
1159 to unconditionally consume :exc:`socket.error` exceptions and to close the
1160 socket when done.
1161 (Contributed by Giampaolo Rodolà; :issue:`9794`.)
1162
1163ssl
1164---
Antoine Pitroud67075e2010-07-31 22:48:02 +00001165
Raymond Hettinger4854d142011-01-17 21:29:58 +00001166The :mod:`ssl` module added a number of features to satisfy common requirements
1167for secure (encrypted, authenticated) internet connections:
Antoine Pitrou33da1d62011-01-16 18:16:09 +00001168
Raymond Hettinger4854d142011-01-17 21:29:58 +00001169* A new class, :class:`~ssl.SSLContext`, serves as a container for persistent
1170 SSL data, such as protocol settings, certificates, private keys, and various
1171 other options. It includes a :meth:`~ssl.SSLContext.wrap_socket` for creating
1172 an SSL socket from an SSL context.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001173
Raymond Hettinger4854d142011-01-17 21:29:58 +00001174* A new function, :func:`ssl.match_hostname`, supports server identity
1175 verification for higher-level protocols by implementing the rules of HTTPS
1176 (from :rfc:`2818`) which are also suitable for other protocols.
Antoine Pitrou0ee4c9f2010-10-08 16:46:17 +00001177
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001178* The :func:`ssl.wrap_socket` constructor function now takes a *ciphers*
Raymond Hettinger4854d142011-01-17 21:29:58 +00001179 argument. The *ciphers* string lists the allowed encryption algorithms using
1180 the format described in the `OpenSSL documentation
1181 <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT>`__.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001182
Raymond Hettinger4854d142011-01-17 21:29:58 +00001183* When linked against recent versions of OpenSSL, the :mod:`ssl` module now
1184 supports the Server Name Indication extension to the TLS protocol, allowing
1185 multiple "virtual hosts" using different certificates on a single IP port.
1186 This extension is only supported in client mode, and is activated by passing
1187 the *server_hostname* argument to :meth:`ssl.SSLContext.wrap_socket`.
Antoine Pitrou7d15a722010-11-05 22:13:55 +00001188
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001189* Various options have been added to the :mod:`ssl` module, such as
Raymond Hettinger4854d142011-01-17 21:29:58 +00001190 :data:`~ssl.OP_NO_SSLv2` which disables the insecure and obsolete SSLv2
1191 protocol.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001192
Raymond Hettinger4854d142011-01-17 21:29:58 +00001193* The extension now loads all the OpenSSL ciphers and digest algorithms. If
1194 some SSL certificates cannot be verified, they are reported as an "unknown
1195 algorithm" error.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001196
Raymond Hettinger4854d142011-01-17 21:29:58 +00001197* The version of OpenSSL being used is now accessible using the module
1198 attributes :data:`ssl.OPENSSL_VERSION` (a string),
1199 :data:`ssl.OPENSSL_VERSION_INFO` (a 5-tuple), and
1200 :data:`ssl.OPENSSL_VERSION_NUMBER` (an integer).
1201
1202(Contributed by Antoine Pitrou in :issue:`8850`, :issue:`1589`, :issue:`8322`,
1203:issue:`5639`, :issue:`4870`, :issue:`8484`, and :issue:`8321`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001204
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001205nntp
1206----
Raymond Hettinger070ec702010-12-10 17:45:13 +00001207
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001208The :mod:`nntplib` module has a revamped implementation with better bytes and
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001209text semantics as well as more practical APIs. These improvements break
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001210compatibility with the nntplib version in Python 3.1, which was partly
1211dysfunctional in itself.
Raymond Hettinger070ec702010-12-10 17:45:13 +00001212
Antoine Pitrou33da1d62011-01-16 18:16:09 +00001213Support for secure connections through both implicit (using
1214:class:`nntplib.NNTP_SSL`) and explicit (using :meth:`nntplib.NNTP.starttls`)
1215TLS has also been added.
1216
1217(Contributed by Antoine Pitrou in :issue:`9360` and Andrew Vant in :issue:`1926`.)
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001218
1219certificates
1220------------
1221
1222:class:`http.client.HTTPSConnection`, :class:`urllib.request.HTTPSHandler`
1223and :func:`urllib.request.urlopen` now take optional arguments to allow for
1224server certificate checking against a set of Certificate Authorities,
1225as recommended in public uses of HTTPS.
1226
1227(Added by Antoine Pitrou, :issue:`9003`.)
1228
Antoine Pitrou2e8ec222011-01-16 18:41:36 +00001229imaplib
1230-------
1231
1232Support for explicit TLS on standard IMAP4 connections has been added through
1233the new :mod:`imaplib.IMAP4.starttls` method.
1234
1235(Contributed by Lorenzo M. Catucci and Antoine Pitrou, :issue:`4471`.)
1236
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001237unittest
1238--------
Antoine Pitrouafb078d2010-11-05 22:18:28 +00001239
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001240The unittest module has a number of improvements supporting test discovery for
1241packages, easier experimentation at the interactive prompt, new testcase
1242methods, improved diagnostic messages for test failures, and better method
1243names.
1244
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001245* The command-line call ``python -m unittest`` can now accept file paths
Raymond Hettingera0266332010-12-07 08:52:41 +00001246 instead of module names for running specific tests (:issue:`10620`). The new
1247 test discovery can find tests within packages, locating any test importable
Raymond Hettingerc136b042011-01-18 07:15:39 +00001248 from the top-level directory. The top-level directory can be specified with
Raymond Hettingera0266332010-12-07 08:52:41 +00001249 the `-t` option, a pattern for matching files with ``-p``, and a directory to
1250 start discovery with ``-s``::
1251
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001252 $ python -m unittest discover -s my_proj_dir -p _test.py
Raymond Hettingera0266332010-12-07 08:52:41 +00001253
1254 (Contributed by Michael Foord.)
Antoine Pitroud3052002010-09-15 15:09:40 +00001255
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001256* Experimentation at the interactive prompt is now easier because the
1257 :class:`unittest.case.TestCase` class can now be instantiated without
1258 arguments:
1259
1260 >>> TestCase().assertEqual(pow(2, 3), 8)
1261
1262 (Contributed by Michael Foord.)
1263
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001264* The :mod:`unittest` module has two new methods,
1265 :meth:`~unittest.TestCase.assertWarns` and
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001266 :meth:`~unittest.TestCase.assertWarnsRegex` to verify that a given warning type
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001267 is triggered by the code under test::
Antoine Pitroud3052002010-09-15 15:09:40 +00001268
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001269 with self.assertWarns(DeprecationWarning):
1270 legacy_function('XYZ')
Ezio Melotti2baf1a62010-11-22 12:56:58 +00001271
Antoine Pitroueec6dbf2011-01-16 18:21:12 +00001272 (Contributed by Antoine Pitrou, :issue:`9754`.)
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001273
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001274 Another new method, :meth:`~unittest.TestCase.assertCountEqual` is used to
Raymond Hettingerffad35e2010-12-14 21:12:03 +00001275 compare two iterables to determine if their element counts are equal (whether
1276 the same elements are present with the same number of occurrences regardless
1277 of order)::
Raymond Hettingera0266332010-12-07 08:52:41 +00001278
1279 def test_anagram(self):
1280 self.assertCountEqual('algorithm', 'logarithm')
1281
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001282 (Contributed by Raymond Hettinger.)
1283
1284* A principal feature of the unittest module is an effort to produce meaningful
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001285 diagnostics when a test fails. When possible, the failure is recorded along
Raymond Hettingera0266332010-12-07 08:52:41 +00001286 with a diff of the output. This is especially helpful for analyzing log files
1287 of failed test runs. However, since diffs can sometime be voluminous, there is
1288 a new :attr:`~unittest.TestCase.maxDiff` attribute which sets maximum length of
1289 diffs.
1290
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001291* In addition, the method names in the module have undergone a number of clean-ups.
1292
1293 For example, :meth:`~unittest.TestCase.assertRegex` is the new name for
Raymond Hettingera0266332010-12-07 08:52:41 +00001294 :meth:`~unittest.TestCase.assertRegexpMatches` which was misnamed because the
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001295 test uses :func:`re.search`, not :func:`re.match`. Other methods using
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001296 regular expressions are now named using short form "Regex" in preference to
1297 "Regexp" -- this matches the names used in other unittest implementations,
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001298 matches Python's old name for the :mod:`re` module, and it has unambiguous
1299 camel-casing.
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001300
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001301 (Contributed by Raymond Hettinger and implemented by Ezio Melotti.)
1302
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001303* To improve consistency, some long-standing method aliases are being
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001304 deprecated in favor of the preferred names:
1305
Raymond Hettingerc1dfa2e2011-01-19 04:24:57 +00001306 =============================== ==============================
1307 Old Name Preferred Name
1308 =============================== ==============================
1309 :meth:`assert_` :meth:`.assertTrue`
1310 :meth:`assertEquals` :meth:`.assertEqual`
1311 :meth:`assertNotEquals` :meth:`.assertNotEqual`
1312 :meth:`assertAlmostEquals` :meth:`.assertAlmostEqual`
1313 :meth:`assertNotAlmostEquals` :meth:`.assertNotAlmostEqual`
1314 =============================== ==============================
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001315
1316 Likewise, the ``TestCase.fail*`` methods deprecated in Python 3.1 are expected
Raymond Hettingerc1dfa2e2011-01-19 04:24:57 +00001317 to be removed in Python 3.3. Also see the :ref:`deprecated-aliases` section in
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001318 the :mod:`unittest` documentation.
Ezio Melotti2baf1a62010-11-22 12:56:58 +00001319
1320 (Contributed by Ezio Melotti; :issue:`9424`.)
Antoine Pitroud3052002010-09-15 15:09:40 +00001321
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001322* The :meth:`~unittest.TestCase.assertDictContainsSubset` method was deprecated
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001323 because it was misimplemented with the arguments in the wrong order. This
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001324 created hard-to-debug optical illusions where tests like
1325 ``TestCase().assertDictContainsSubset({'a':1, 'b':2}, {'a':1})`` would fail.
1326
1327 (Contributed by Raymond Hettinger.)
1328
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001329random
1330------
Raymond Hettingere0a96002010-12-15 17:54:13 +00001331
Raymond Hettinger0358a172010-12-15 19:00:38 +00001332The integer methods in the :mod:`random` module now do a better job of producing
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001333uniform distributions. Previously, they computed selections with
1334``int(n*random())`` which had a slight bias whenever *n* was not a power of two.
Raymond Hettingerc136b042011-01-18 07:15:39 +00001335Now, multiple selections are made from a range up to the next power of two and a
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001336selection is kept only when it falls within the range ``0 <= x < n``. The
1337functions and methods affected are :func:`~random.randrange`,
1338:func:`~random.randint`, :func:`~random.choice`, :func:`~random.shuffle` and
1339:func:`~random.sample`.
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001340
1341(Contributed by Raymond Hettinger; :issue:`9025`.)
1342
1343poplib
1344------
Raymond Hettingere0a96002010-12-15 17:54:13 +00001345
Giampaolo Rodolà42382fe2010-08-17 16:09:53 +00001346* :class:`~poplib.POP3_SSL` class now accepts a *context* parameter, which is a
1347 :class:`ssl.SSLContext` object allowing bundling SSL configuration options,
1348 certificates and private keys into a single (potentially long-lived)
1349 structure.
1350
1351 (Contributed by Giampaolo Rodolà; :issue:`8807`.)
1352
Giampaolo Rodolà977c7072010-10-04 21:08:36 +00001353* :class:`asyncore.dispatcher` now provides a
1354 :meth:`~asyncore.dispatcher.handle_accepted()` method
1355 returning a `(sock, addr)` pair which is called when a connection has actually
1356 been established with a new remote endpoint. This is supposed to be used as a
1357 replacement for old :meth:`~asyncore.dispatcher.handle_accept()` and avoids
1358 the user to call :meth:`~asyncore.dispatcher.accept()` directly.
1359
1360 (Contributed by Giampaolo Rodolà; :issue:`6706`.)
Georg Brandlda0a2112010-09-05 11:28:33 +00001361
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001362tempfile
1363--------
Raymond Hettingera0266332010-12-07 08:52:41 +00001364
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001365The :mod:`tempfile` module has a new context manager,
1366:class:`~tempfile.TemporaryDirectory` which provides easy deterministic
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001367cleanup of temporary directories::
Nick Coghlan543af752010-10-24 11:23:25 +00001368
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001369 with tempfile.TemporaryDirectory() as tmpdirname:
1370 print('created temporary dir:', tmpdirname)
Nick Coghlan543af752010-10-24 11:23:25 +00001371
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001372(Contributed by Neil Schemenauer and Nick Coghlan; :issue:`5178`.)
Nick Coghlane0f04652010-11-21 03:44:04 +00001373
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001374inspect
1375-------
1376
Raymond Hettinger0358a172010-12-15 19:00:38 +00001377* The :mod:`inspect` module has a new function
1378 :func:`~inspect.getgeneratorstate` to easily identify the current state of a
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001379 generator as one of *GEN_CREATED*, *GEN_RUNNING*, *GEN_SUSPENDED* or
1380 *GEN_CLOSED*::
1381
1382 >>> def gen():
1383 yield 'one'
1384 yield 'two'
1385 >>> g = gen()
1386 >>> inspect.getgeneratorstate(g)
1387 'GEN_CREATED'
1388 >>> next(g)
1389 'one'
1390 >>> inspect.getgeneratorstate(g)
1391 'GEN_SUSPENDED'
1392
1393 (Contributed by Rodolpho Eckhardt and Nick Coghlan, :issue:`10220`.)
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001394
Raymond Hettingera55ffbc2010-12-15 18:31:57 +00001395* To support lookups without the possibility of activating a dynamic attribute,
1396 the :mod:`inspect` module has a new function, :func:`~inspect.getattr_static`.
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001397 Unlike :func:`hasattr`, this is a true read-only search, guaranteed not to
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001398 change state while it is searching::
1399
1400 >>> class A:
1401 @property
1402 def f(self):
1403 print('Running')
1404 return 10
1405
1406 >>> a = A()
1407 >>> getattr(a, 'f')
1408 Running
1409 10
1410 >>> inspect.getattr_static(a, 'f')
1411 <property object at 0x1022bd788>
1412
1413 (Contributed by Michael Foord.)
Nick Coghlane0f04652010-11-21 03:44:04 +00001414
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001415pydoc
1416-----
Nick Coghlan7bb30b72010-12-03 09:29:11 +00001417
Raymond Hettingerc136b042011-01-18 07:15:39 +00001418The :mod:`pydoc` module now provides a much-improved Web server interface,
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001419as well as a new command-line option to automatically open a browser
1420window to display that server.
Nick Coghlan7bb30b72010-12-03 09:29:11 +00001421
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001422(Contributed by Ron Adam; :issue:`2001`.)
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001423
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001424sysconfig
1425---------
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001426
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001427The new :mod:`sysconfig` module makes it straightforward to discover
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001428installation paths and configuration variables which vary across platforms and
1429installations.
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001430
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001431The module offers access simple access functions for platform and version
1432information:
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001433
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001434* :func:`~sysconfig.get_platform` returning values like *linux-i586* or
1435 *macosx-10.6-ppc*.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001436* :func:`~sysconfig.get_python_version` returns a Python version string
1437 such as "3.2".
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001438
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001439It also provides access to the paths and variables corresponding to one of
1440seven named schemes used by :mod:`distutils`. Those include *posix_prefix*,
1441*posix_home*, *posix_user*, *nt*, *nt_user*, *os2*, *os2_home*:
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001442
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001443* :func:`~sysconfig.get_paths` makes a dictionary containing installation paths
1444 for the current installation scheme.
1445* :func:`~sysconfig.get_config_vars` returns a dictionary of platform specific
1446 variables.
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001447
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001448There is also a convenient command-line interface::
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001449
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001450 C:\Python32>python -m sysconfig
1451 Platform: "win32"
1452 Python version: "3.2"
1453 Current installation scheme: "nt"
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001454
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001455 Paths:
1456 data = "C:\Python32"
Łukasz Langa79a06ed2010-12-17 22:05:46 +00001457 include = "C:\Python32\Include"
1458 platinclude = "C:\Python32\Include"
1459 platlib = "C:\Python32\Lib\site-packages"
1460 platstdlib = "C:\Python32\Lib"
1461 purelib = "C:\Python32\Lib\site-packages"
1462 scripts = "C:\Python32\Scripts"
1463 stdlib = "C:\Python32\Lib"
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001464
1465 Variables:
1466 BINDIR = "C:\Python32"
Łukasz Langa79a06ed2010-12-17 22:05:46 +00001467 BINLIBDEST = "C:\Python32\Lib"
1468 EXE = ".exe"
1469 INCLUDEPY = "C:\Python32\Include"
1470 LIBDEST = "C:\Python32\Lib"
1471 SO = ".pyd"
1472 VERSION = "32"
1473 abiflags = ""
1474 base = "C:\Python32"
1475 exec_prefix = "C:\Python32"
1476 platbase = "C:\Python32"
1477 prefix = "C:\Python32"
1478 projectbase = "C:\Python32"
1479 py_version = "3.2"
1480 py_version_nodot = "32"
1481 py_version_short = "3.2"
1482 srcdir = "C:\Python32"
1483 userbase = "C:\Documents and Settings\Raymond\Application Data\Python"
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001484
1485pdb
1486---
1487
1488The :mod:`pdb` debugger module gained a number of usability improvements:
Raymond Hettingerb5d79332010-12-07 02:04:56 +00001489
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001490* :file:`pdb.py` now has a ``-c`` option that executes commands as given in a
1491 :file:`.pdbrc` script file.
1492* A :file:`.pdbrc` script file can contain ``continue`` and ``next`` commands
1493 that continue debugging.
1494* The :class:`Pdb` class constructor now accepts a *nosigint* argument.
Raymond Hettinger51e21072011-01-10 23:38:15 +00001495* New commands: ``l(list)``, ``ll(long list)`` and ``source`` for
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001496 listing source code.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001497* New commands: ``display`` and ``undisplay`` for showing or hiding
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001498 the value of an expression if it has changed.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001499* New command: ``interact`` for starting an interactive interpreter containing
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001500 the global and local names found in the current scope.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001501* Breakpoints can be cleared by breakpoint number.
Raymond Hettingerb5d79332010-12-07 02:04:56 +00001502
Georg Brandl101234b2010-12-18 11:53:25 +00001503(Contributed by Georg Brandl, Antonio Cuni and Ilya Sandler.)
1504
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001505configparser
1506------------
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001507
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001508The :mod:`configparser` module was modified to improve usability and
1509predictability of the default parser and its supported INI syntax. The old
1510:class:`ConfigParser` class was removed in favor of :class:`SafeConfigParser`
Raymond Hettinger04129742010-12-18 10:57:50 +00001511which has in turn been renamed to :class:`~configparser.ConfigParser`. Support
1512for inline comments is now turned off by default and section or option
1513duplicates are not allowed in a single configuration source.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001514
1515Config parsers gained a new API based on the mapping protocol::
1516
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001517 >>> parser = ConfigParser()
1518 >>> parser.read_string("""
1519 [DEFAULT]
1520 location = upper left
1521 visible = yes
1522 editable = no
1523 color = blue
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001524
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001525 [main]
1526 title = Main Menu
1527 color = green
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001528
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001529 [options]
1530 title = Options
1531 """)
1532 >>> parser['main']['color']
1533 'green'
1534 >>> parser['main']['editable']
1535 'no'
1536 >>> section = parser['options']
1537 >>> section['title']
1538 'Options'
1539 >>> section['title'] = 'Options (editable: %(editable)s)'
1540 >>> section['title']
1541 'Options (editable: no)'
1542
1543The new API is implemented on top of the classical API, so custom parser
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001544subclasses should be able to use it without modifications.
1545
1546The INI file structure accepted by config parsers can now be customized. Users
Raymond Hettinger04129742010-12-18 10:57:50 +00001547can specify alternative option/value delimiters and comment prefixes, change the
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001548name of the *DEFAULT* section or switch the interpolation syntax.
1549
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001550There is support for pluggable interpolation including an additional interpolation
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001551handler :class:`~configparser.ExtendedInterpolation`::
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001552
1553 >>> parser = ConfigParser(interpolation=ExtendedInterpolation())
1554 >>> parser.read_dict({'buildout': {'directory': '/home/ambv/zope9'},
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001555 'custom': {'prefix': '/usr/local'}})
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001556 >>> parser.read_string("""
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001557 [buildout]
1558 parts =
1559 zope9
1560 instance
1561 find-links =
1562 ${buildout:directory}/downloads/dist
1563
1564 [zope9]
1565 recipe = plone.recipe.zope9install
1566 location = /opt/zope
1567
1568 [instance]
1569 recipe = plone.recipe.zope9instance
1570 zope9-location = ${zope9:location}
1571 zope-conf = ${custom:prefix}/etc/zope.conf
1572 """)
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001573 >>> parser['buildout']['find-links']
1574 '\n/home/ambv/zope9/downloads/dist'
1575 >>> parser['instance']['zope-conf']
1576 '/usr/local/etc/zope.conf'
1577 >>> instance = parser['instance']
1578 >>> instance['zope-conf']
1579 '/usr/local/etc/zope.conf'
1580 >>> instance['zope9-location']
1581 '/opt/zope'
1582
1583A number of smaller features were also introduced, like support for specifying
Raymond Hettinger04129742010-12-18 10:57:50 +00001584encoding in read operations, specifying fallback values for get-functions, or
1585reading directly from dictionaries and strings.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001586
1587(All changes contributed by Łukasz Langa.)
1588
Raymond Hettingera55ffbc2010-12-15 18:31:57 +00001589.. XXX: Mention urllib.parse changes
1590 Issue 9873 (Nick Coghlan):
1591 - ASCII byte sequence support in URL parsing
1592 - named tuple for urldefrag return value
1593 Issue 5468 (Dan Mahn) for urlencode:
1594 - bytes input support
1595 - non-UTF8 percent encoding of non-ASCII characters
1596 Issue 2987 for IPv6 (RFC2732) support in urlparse
Raymond Hettinger3df46212011-01-06 02:01:26 +00001597
Raymond Hettingera55ffbc2010-12-15 18:31:57 +00001598
Antoine Pitroud42bc512009-11-10 23:18:31 +00001599Multi-threading
1600===============
1601
Georg Brandlda0a2112010-09-05 11:28:33 +00001602* The mechanism for serializing execution of concurrently running Python threads
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001603 (generally known as the :term:`GIL` or :term:`Global Interpreter Lock`) has
1604 been rewritten. Among the objectives were more predictable switching
1605 intervals and reduced overhead due to lock contention and the number of
1606 ensuing system calls. The notion of a "check interval" to allow thread
1607 switches has been abandoned and replaced by an absolute duration expressed in
1608 seconds. This parameter is tunable through :func:`sys.setswitchinterval()`.
1609 It currently defaults to 5 milliseconds.
Antoine Pitroud42bc512009-11-10 23:18:31 +00001610
1611 Additional details about the implementation can be read from a `python-dev
1612 mailing-list message
1613 <http://mail.python.org/pipermail/python-dev/2009-October/093321.html>`_
Georg Brandlda0a2112010-09-05 11:28:33 +00001614 (however, "priority requests" as exposed in this message have not been kept
1615 for inclusion).
Antoine Pitroud42bc512009-11-10 23:18:31 +00001616
Georg Brandl5e73a812010-04-22 07:02:51 +00001617 (Contributed by Antoine Pitrou.)
Antoine Pitroud42bc512009-11-10 23:18:31 +00001618
Georg Brandlda0a2112010-09-05 11:28:33 +00001619* Regular and recursive locks now accept an optional *timeout* argument to their
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001620 :meth:`~threading.Lock.acquire` method. (Contributed by Antoine Pitrou;
1621 :issue:`7316`.)
Georg Brandlda0a2112010-09-05 11:28:33 +00001622
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001623* Similarly, :meth:`threading.Semaphore.acquire` also gained a *timeout*
Georg Brandlda0a2112010-09-05 11:28:33 +00001624 argument. (Contributed by Torsten Landschoff; :issue:`850728`.)
Antoine Pitroue95a9ff2010-05-04 23:31:41 +00001625
Antoine Pitrou810023d2010-12-15 22:59:16 +00001626* Regular and recursive lock acquisitions can now be interrupted by signals on
Raymond Hettingerc136b042011-01-18 07:15:39 +00001627 platforms using Pthreads. This means that Python programs that deadlock while
Antoine Pitrou810023d2010-12-15 22:59:16 +00001628 acquiring locks can be successfully killed by repeatedly sending SIGINT to the
Georg Brandleebb2522010-12-18 12:01:15 +00001629 process (by pressing :kbd:`Ctrl+C` in most shells).
Antoine Pitrou810023d2010-12-15 22:59:16 +00001630 (Contributed by Reid Kleckner; :issue:`8844`.)
1631
Antoine Pitroud42bc512009-11-10 23:18:31 +00001632
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001633Optimizations
1634=============
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001635
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001636A number of small performance enhancements have been added:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001637
Antoine Pitroud3052002010-09-15 15:09:40 +00001638* Python's peephole optimizer now recognizes patterns such ``x in {1, 2, 3}`` as
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001639 being a test for membership in a set of constants. The optimizer recasts the
1640 :class:`set` as a :class:`frozenset` and stores the pre-built constant.
1641
1642 Now that the speed penalty is gone, it is practical to start writing
1643 membership tests using set-notation. This style is both semantically clear
1644 and operationally fast::
1645
1646 extension = name.rpartition('.')[2]
1647 if extension in {'xml', 'html', 'xhtml', 'css'}:
1648 handle(name)
1649
Raymond Hettingerc136b042011-01-18 07:15:39 +00001650 (Patch and additional tests contributed by Dave Malcolm; :issue:`6690`).
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001651
Antoine Pitroud3052002010-09-15 15:09:40 +00001652* Serializing and unserializing data using the :mod:`pickle` module is now
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001653 several times faster.
1654
1655 (Contributed by Alexandre Vassalotti, Antoine Pitrou
Antoine Pitrouff150f22010-10-22 21:41:05 +00001656 and the Unladen Swallow team in :issue:`9410` and :issue:`3873`.)
Antoine Pitroud3052002010-09-15 15:09:40 +00001657
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001658* The `Timsort algorithm <http://en.wikipedia.org/wiki/Timsort>`_ used in
Raymond Hettingerffad35e2010-12-14 21:12:03 +00001659 :meth:`list.sort` and :func:`sorted` now runs faster and uses less memory
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001660 when called with a :term:`key function`. Previously, every element of
1661 a list was wrapped with a temporary object that remembered the key value
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001662 associated with each element. Now, two arrays of keys and values are
Raymond Hettingerc136b042011-01-18 07:15:39 +00001663 sorted in parallel. This saves the memory consumed by the sort wrappers,
1664 and it saves time lost to delegating comparisons.
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001665
Raymond Hettingereb70b902011-01-10 21:26:49 +00001666 (Patch by Daniel Stutzbach in :issue:`9915`.)
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001667
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001668* JSON decoding performance is improved and memory consumption is reduced
Raymond Hettinger413abbc2010-12-05 07:06:47 +00001669 whenever the same string is repeated for multiple keys. Also, JSON encoding
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001670 now uses the C speedups when the ``sort_keys`` argument is true.
1671
1672 (Contributed by Antoine Pitrou in :issue:`7451` and by Raymond Hettinger and
1673 Antoine Pitrou in :issue:`10314`.)
1674
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001675* Recursive locks (created with the :func:`threading.RLock` API) now benefit
1676 from a C implementation which makes them as fast as regular locks, and between
1677 10x and 15x faster than their previous pure Python implementation.
1678
1679 (Contributed by Antoine Pitrou; :issue:`3001`.)
1680
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001681* The fast-search algorithm in stringlib is now used by the :meth:`split`,
1682 :meth:`rsplit`, :meth:`splitlines` and :meth:`replace` methods on
1683 :class:`bytes`, :class:`bytearray` and :class:`str` objects. Likewise, the
1684 algorithm is also used by :meth:`rfind`, :meth:`rindex`, :meth:`rsplit` and
1685 :meth:`rpartition`.
1686
1687 (Patch by Florent Xicluna in :issue:`7622` and :issue:`7462`.)
1688
Raymond Hettinger480ed782010-12-15 22:07:15 +00001689
1690* String to integer conversions now work two "digits" at a time, reducing the
1691 number of division and modulo operations.
1692
1693 (:issue:`6713` by Gawain Bolton, Mark Dickinson, and Victor Stinner.)
1694
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +00001695There were several other minor optimizations. Set differencing now runs faster
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001696when one operand is much larger than the other (patch by Andress Bennetts in
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +00001697:issue:`8685`). The :meth:`array.repeat` method has a faster implementation
1698(:issue:`1569291` by Alexander Belopolsky). The :class:`BaseHTTPRequestHandler`
1699has more efficient buffering (:issue:`3709` by Andrew Schaaf). The
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001700multi-argument form of :func:`operator.attrgetter` function now runs slightly
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +00001701faster (:issue:`10160` by Christos Georgiou). And :class:`ConfigParser` loads
1702multi-line arguments a bit faster (:issue:`7113` by Łukasz Langa).
1703
Antoine Pitroud3052002010-09-15 15:09:40 +00001704
Victor Stinner47ce9652010-10-29 00:57:35 +00001705Unicode
1706=======
Victor Stinner94908bb2010-08-18 21:23:25 +00001707
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001708Python has been updated to Unicode 6.0.0. The new features of the
1709Unicode Standard that will affect Python users include:
1710
Alexander Belopolsky84cc0622010-12-08 21:38:46 +00001711* addition of 2,088 characters, including over 1,000 additional
1712 symbols—chief among them the additional emoji symbols, which are
1713 especially important for mobile phones;
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001714
Alexander Belopolsky84cc0622010-12-08 21:38:46 +00001715* changes to character properties for existing characters including
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001716
Raymond Hettingerc74d5182010-12-02 01:38:25 +00001717 - a general category change to two Kannada characters (U+0CF1,
1718 U+0CF2), which has the effect of making them newly eligible for
1719 inclusion in identifiers;
1720
1721 - a general category change to one New Tai Lue numeric character
Alexander Belopolsky84cc0622010-12-08 21:38:46 +00001722 (U+19DA), which has the effect of disqualifying it from
1723 inclusion in identifiers.
1724
1725 For more information, see `Unicode Character Database Changes
1726 <http://www.unicode.org/versions/Unicode6.0.0/#Database_Changes>`_
1727 at the `Unicode Consortium <http://www.unicode.org/>`_ web site.
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001728
Éric Araujo4234ad42010-09-05 17:32:25 +00001729The :mod:`os` module has two new functions: :func:`~os.fsencode` and
Victor Stinner47ce9652010-10-29 00:57:35 +00001730:func:`~os.fsdecode`. Add :data:`os.environb`: bytes version of
1731:data:`os.environ`, :func:`os.getenvb` function and
1732:data:`os.supports_bytes_environ` constant.
Victor Stinnere8d51452010-08-19 01:05:19 +00001733
Raymond Hettinger23ab1012011-01-18 20:25:04 +00001734MBCS encoding doesn't ignore the error handler argument any more. By
Victor Stinner47ce9652010-10-29 00:57:35 +00001735default (strict mode), it raises an UnicodeDecodeError on undecodable byte
Raymond Hettinger23ab1012011-01-18 20:25:04 +00001736sequence and UnicodeEncodeError on unencodable character. To get the MBCS
Victor Stinner47ce9652010-10-29 00:57:35 +00001737encoding of Python 3.1, use ``'ignore'`` error handler to decode and
Raymond Hettinger23ab1012011-01-18 20:25:04 +00001738``'replace'`` error handler to encode. The MBCS codec supports ``'strict'`` and
Victor Stinner47ce9652010-10-29 00:57:35 +00001739``'ignore'`` error handlers for decoding, and ``'strict'`` and ``'replace'``
1740for encoding.
1741
1742On Mac OS X, Python uses ``'utf-8'`` to decode the command line arguments,
1743instead of the locale encoding (which is ISO-8859-1 if the ``LANG`` environment
1744variable is not set).
1745
1746By default, tarfile uses ``'utf-8'`` encoding on Windows (instead of
1747``'mbcs'``), and the ``'surrogateescape'`` error handler on all operating
1748systems.
Antoine Pitroud3052002010-09-15 15:09:40 +00001749
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001750Also, support was added for *cp720* Arabic DOS encoding (:issue:`1616979`).
Raymond Hettinger480ed782010-12-15 22:07:15 +00001751
Victor Stinner94908bb2010-08-18 21:23:25 +00001752
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001753Documentation
1754=============
1755
1756The documentation continues to be improved.
1757
1758A table of quick links has been added to the top of lengthy sections such as
1759:ref:`built-in-funcs`. In the case of :mod:`itertools`, the links are
1760accompanied by tables of cheatsheet-style summaries to provide an overview and
1761memory jog without having to read all of the docs.
1762
Raymond Hettinger51e21072011-01-10 23:38:15 +00001763In some cases, the pure Python source code can be a helpful adjunct to the
1764documentation, so now many modules now feature quick links to the latest version
1765of the source code. For example, the :mod:`functools` module documentation has
1766a quick link at the top labeled: **Source code** :source:`Lib/functools.py`.
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001767
1768The docs now contain more examples and recipes. In particular, :mod:`re` module
1769has an extensive section, :ref:`re-examples`. Likewise, the :mod:`itertools`
1770module continues to be updated with new :ref:`itertools-recipes`.
1771
Raymond Hettinger677e10a2010-12-07 06:45:30 +00001772The :mod:`datetime` module now has an auxiliary implementation in pure Python.
1773No functionality was changed. This just provides an easier-to-read
1774alternate implementation. (Contributed by Alexander Belopolsky.)
1775
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001776The unmaintained :file:`Demo` directory has been removed. Some demos were
1777integrated into the documentation, some were moved to the :file:`Tools/demo`
1778directory, and others were removed altogether. (Contributed by Georg Brandl.)
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001779
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001780
1781IDLE
1782====
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001783
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001784* The format menu now has an option to clean source files by stripping
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001785 trailing whitespace.
1786
1787 (Contributed by Raymond Hettinger; :issue:`5150`.)
1788
1789* IDLE on Mac OS X now works with both Carbon AquaTk and Cocoa AquaTk.
1790
1791 (Contributed by Kevin Walzer, Ned Deily, and Ronald Oussoren; :issue:`6075`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001792
1793
1794Build and C API Changes
1795=======================
1796
1797Changes to Python's build process and to the C API include:
1798
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001799* The *idle*, *pydoc* and *2to3* scripts are now installed with a
1800 version-specific suffix on ``make altinstall`` (:issue:`10679`).
1801
Georg Brandlda0a2112010-09-05 11:28:33 +00001802* The C functions that access the Unicode Database now accept and return
1803 characters from the full Unicode range, even on narrow unicode builds
Raymond Hettinger1784ff02010-09-05 01:00:19 +00001804 (Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and others). A visible difference
Georg Brandlda0a2112010-09-05 11:28:33 +00001805 in Python is that :func:`unicodedata.numeric` now returns the correct value
1806 for large code points, and :func:`repr` may consider more characters as
1807 printable.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001808
Raymond Hettinger1784ff02010-09-05 01:00:19 +00001809 (Reported by Bupjoe Lee and fixed by Amaury Forgeot D'Arc; :issue:`5127`.)
1810
Georg Brandlda0a2112010-09-05 11:28:33 +00001811* Computed gotos are now enabled by default on supported compilers (which are
Raymond Hettingerdb9044e2010-09-06 01:29:23 +00001812 detected by the configure script). They can still be disabled selectively by
Georg Brandlda0a2112010-09-05 11:28:33 +00001813 specifying ``--without-computed-gotos``.
Raymond Hettinger1784ff02010-09-05 01:00:19 +00001814
Georg Brandlda0a2112010-09-05 11:28:33 +00001815 (Contributed by Antoine Pitrou; :issue:`9203`.)
1816
Amaury Forgeot d'Arcfeb73072010-09-12 22:42:57 +00001817* The option ``--with-wctype-functions`` was removed. The built-in unicode
1818 database is now used for all functions.
1819
1820 (Contributed by Amaury Forgeot D'Arc; :issue:`9210`.)
1821
Raymond Hettinger480ed782010-12-15 22:07:15 +00001822* Hash values are now values of a new type, :c:type:`Py_hash_t`, which is
1823 defined to be the same size as a pointer. Previously they were of type long,
1824 which on some 64-bit operating systems is still only 32 bits long. As a
1825 result of this fix, :class:`set` and :class:`dict` can now hold more than
1826 ``2**32`` entries on builds with 64-bit pointers (previously, they could grow
1827 to that size but their performance degraded catastrophically).
Skip Montanaro961aaf52010-10-17 22:22:24 +00001828
Raymond Hettinger480ed782010-12-15 22:07:15 +00001829 (Suggested by Raymond Hettinger and implemented by Benjamin Peterson;
1830 :issue:`9778`.)
1831
1832* A new macro :c:macro:`Py_VA_COPY` copies the state of the variable argument
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001833 list. It is equivalent to C99 *va_copy* but available on all Python platforms
Raymond Hettinger480ed782010-12-15 22:07:15 +00001834 (:issue:`2443`).
1835
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001836* A new C API function :c:func:`PySys_SetArgvEx` allows an embedded interpreter
1837 to set :attr:`sys.argv` without also modifying :attr:`sys.path`
Raymond Hettinger480ed782010-12-15 22:07:15 +00001838 (:issue:`5753`).
1839
1840* :c:macro:`PyEval_CallObject` is now only available in macro form. The
1841 function declaration, which was kept for backwards compatibility reasons, is
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001842 now removed -- the macro was introduced in 1997 (:issue:`8276`).
Raymond Hettinger480ed782010-12-15 22:07:15 +00001843
1844* The is a new function :c:func:`PyLong_AsLongLongAndOverflow` which
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001845 is analogous to :c:func:`PyLong_AsLongAndOverflow`. They both serve to
Raymond Hettinger480ed782010-12-15 22:07:15 +00001846 convert Python :class:`int` into a native fixed-width type while providing
1847 detection of cases where the conversion won't fit (:issue:`7767`).
1848
1849* The :c:func:`PyUnicode_CompareWithASCIIString` now returns *not equal*
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001850 if the Python string is *NUL* terminated.
Raymond Hettinger480ed782010-12-15 22:07:15 +00001851
1852* There is a new function :c:func:`PyErr_NewExceptionWithDoc` that is
1853 like :c:func:`PyErr_NewException` but allows a docstring to be specified.
1854 This lets C exceptions have the same self-documenting capabilities as
1855 their pure Python counterparts (:issue:`7033`).
1856
1857* When compiled with the ``--with-valgrind`` option, the pymalloc
1858 allocator will be automatically disabled when running under Valgrind. This
1859 gives improved memory leak detection when running under Valgrind, while taking
1860 advantage of pymalloc at other times (:issue:`2422`).
1861
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001862* Removed the ``O?`` format from the *PyArg_Parse* functions. The format is no
Raymond Hettinger480ed782010-12-15 22:07:15 +00001863 longer used and it had never been documented (:issue:`8837`).
1864
1865There were a number of other small changes to the C-API. See the
1866:file:`Misc/NEWS` file for a complete list.
Skip Montanaro961aaf52010-10-17 22:22:24 +00001867
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001868
Raymond Hettingerf558ddd2009-06-28 21:37:08 +00001869Porting to Python 3.2
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001870=====================
1871
Georg Brandlda0a2112010-09-05 11:28:33 +00001872This section lists previously described changes and other bugfixes that may
1873require changes to your code:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001874
Raymond Hettingerd73be672010-12-18 10:48:26 +00001875* The :mod:`configparser` module has a number of clean-ups. The major change is
1876 to replace the old :class:`ConfigParser` class with long-standing preferred
1877 alternative :class:`SafeConfigParser`. In addition there are a number of
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001878 smaller incompatibilities:
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001879
Raymond Hettingerd73be672010-12-18 10:48:26 +00001880 * The interpolation syntax is now validated on
1881 :meth:`~configparser.ConfigParser.get` and
1882 :meth:`~configparser.ConfigParser.set` operations. In the default
1883 interpolation scheme, only two tokens with percent signs are valid: ``%(name)s``
1884 and ``%%``, the latter being an escaped percent sign.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001885
Raymond Hettingerd73be672010-12-18 10:48:26 +00001886 * The :meth:`~configparser.ConfigParser.set` and
1887 :meth:`~configparser.ConfigParser.add_section` methods now verify that
1888 values are actual strings. Formerly, unsupported types could be introduced
1889 unintentionally.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001890
Raymond Hettinger2b8861f2010-12-18 11:20:52 +00001891 * Duplicate sections or options from a single source now raise either
Raymond Hettingerd73be672010-12-18 10:48:26 +00001892 :exc:`~configparser.DuplicateSectionError` or
1893 :exc:`~configparser.DuplicateOptionError`. Formerly, duplicates would
1894 silently overwrite a previous entry.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001895
Raymond Hettingerd73be672010-12-18 10:48:26 +00001896 * Inline comments are now disabled by default so now the **;** character
1897 can be safely used in values.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001898
Raymond Hettingerd73be672010-12-18 10:48:26 +00001899 * Comments now can be indented. Consequently, for **;** or **#** to appear at
1900 the start of a line in multiline values, it has to be interpolated. This
Raymond Hettinger2b8861f2010-12-18 11:20:52 +00001901 keeps comment prefix characters in values from being mistaken as comments.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001902
Raymond Hettingerd73be672010-12-18 10:48:26 +00001903 * ``""`` is now a valid value and is no longer automatically converted to an
1904 empty string. For empty strings, use ``"option ="`` in a line.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001905
Antoine Pitroucd889af2010-10-06 21:13:56 +00001906* The :mod:`nntplib` module was reworked extensively, meaning that its APIs
1907 are often incompatible with the 3.1 APIs.
1908
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001909* :class:`bytearray` objects can no longer be used as filenames; instead,
1910 they should be converted to :class:`bytes`.
Victor Stinnerdcb24032010-04-22 12:08:36 +00001911
Raymond Hettinger51e21072011-01-10 23:38:15 +00001912* ``PyArg_Parse*()`` functions:
Victor Stinner3dcb5ac2010-06-08 22:54:19 +00001913
Victor Stinner25e8ec42010-06-25 00:02:38 +00001914 * "t#" format has been removed: use "s#" or "s*" instead
1915 * "w" and "w#" formats has been removed: use "w*" instead
1916
Georg Brandl60203b42010-10-06 10:11:56 +00001917* The :c:type:`PyCObject` type, deprecated in 3.1, has been removed. To wrap
1918 opaque C pointers in Python objects, the :c:type:`PyCapsule` API should be used
Éric Araujo4234ad42010-09-05 17:32:25 +00001919 instead; the new type has a well-defined interface for passing typing safety
Georg Brandlda0a2112010-09-05 11:28:33 +00001920 information and a less complicated signature for calling a destructor.
Victor Stinner0cbec572010-09-12 20:32:57 +00001921
Raymond Hettingere0a96002010-12-15 17:54:13 +00001922* The :func:`sys.setfilesystemencoding` function was removed because
1923 it had a flawed design.
Raymond Hettinger3fcf0022010-12-08 01:13:53 +00001924
Raymond Hettingere0a96002010-12-15 17:54:13 +00001925* The :func:`random.seed` function and method now salt string seeds with an
1926 sha512 hash function. To access the previous version of *seed* in order to
1927 reproduce Python 3.1 sequences, set the *version* argument to *1*,
1928 ``random.seed(s, version=1)``.
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001929
Raymond Hettinger522cc0a2010-12-10 01:19:15 +00001930* The previously deprecated :func:`string.maketrans` function has been removed
Raymond Hettinger51e21072011-01-10 23:38:15 +00001931 in favor of the static methods :meth:`bytes.maketrans` and
Raymond Hettinger522cc0a2010-12-10 01:19:15 +00001932 :meth:`bytearray.maketrans`. This change solves the confusion around which
1933 types were supported by the :mod:`string` module. Now, :class:`str`,
1934 :class:`bytes`, and :class:`bytearray` each have their own **maketrans** and
1935 **translate** methods with intermediate translation tables of the appropriate
1936 type.
1937
1938 (Contributed by Georg Brandl; :issue:`5675`.)
1939
1940* The previously deprecated :func:`contextlib.nested` function has been removed
1941 in favor of a plain :keyword:`with` statement which can accept multiple
1942 context managers. The latter technique is faster (because it is built-in),
1943 and it does a better job finalizing multiple context managers when one of them
1944 raises an exception::
1945
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001946 with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
1947 for line in infile:
1948 if '<critical>' in line:
1949 outfile.write(line)
Raymond Hettinger522cc0a2010-12-10 01:19:15 +00001950
1951 (Contributed by Georg Brandl and Mattias Brändström;
1952 `appspot issue 53094 <http://codereview.appspot.com/53094>`_.)
Victor Stinnerda9ec992010-12-28 13:26:42 +00001953
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001954* :func:`struct.pack` now only allows bytes for the ``s`` string pack code.
1955 Formerly, it would accept text arguments and implicitly encode them to bytes
1956 using UTF-8. This was problematic because it made assumptions about the
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001957 correct encoding and because a variable-length encoding can fail when writing
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001958 to fixed length segment of a structure.
Victor Stinnerda9ec992010-12-28 13:26:42 +00001959
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001960 Code such as ``struct.pack('<6sHHBBB', 'GIF87a', x, y)`` should be rewritten
1961 with to use bytes instead of text, ``struct.pack('<6sHHBBB', b'GIF87a', x, y)``.
1962
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001963 (Discovered by David Beazley and fixed by Victor Stinner; :issue:`10783`.)
Raymond Hettingere40808a2011-01-05 23:00:00 +00001964
1965* The :class:`xml.etree.ElementTree` class now raises an
1966 :exc:`xml.etree.ElementTree.ParseError` when a parse fails. Previously it
1967 raised a :exc:`xml.parsers.expat.ExpatError`.
1968
1969* The new, longer :func:`str` value on floats may break doctests which rely on
1970 the old output format.
Antoine Pitroubcba4342011-01-16 18:29:34 +00001971
1972* In :class:`subprocess.Popen`, the default value for *close_fds* is now
1973 ``True`` under Unix; under Windows, it is ``True`` if the three standard
1974 streams are set to ``None``, ``False`` otherwise. Previously, *close_fds*
1975 was always ``False`` by default, which produced difficult to solve bugs
1976 or race conditions when open file descriptors would leak into the child
1977 process.
1978
Antoine Pitrouf7fb7622011-01-16 18:34:09 +00001979* Support for legacy HTTP 0.9 has been removed from :mod:`urllib.request`
1980 and :mod:`http.client`. Such support is still present on the server side
1981 (in :mod:`http.server`).
1982
1983 (Contributed by Antoine Pitrou, :issue:`10711`.)
1984
Antoine Pitrou2e8ec222011-01-16 18:41:36 +00001985* SSL sockets in timeout mode now raise :exc:`socket.timeout` when a timeout
1986 occurs, rather than a generic :exc:`~ssl.SSLError`.
1987
1988 (Contributed by Antoine Pitrou, :issue:`10272`.)
Antoine Pitrouebeb9032011-01-16 18:45:17 +00001989
1990* The misleading functions :c:func:`PyEval_AcquireLock()` and
1991 :c:func:`PyEval_ReleaseLock()` have been officially deprecated. The
1992 thread-state aware APIs (such as :c:func:`PyEval_SaveThread()`
1993 and :c:func:`PyEval_RestoreThread()`) should be used instead.