blob: 518ea50f09dbfd53e4032a938d5b2ffd367104b4 [file] [log] [blame]
Raymond Hettingerd73be672010-12-18 10:48:26 +00001****************************
Raymond Hettingerf558ddd2009-06-28 21:37:08 +00002 What's New In Python 3.2
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00003****************************
4
5:Author: Raymond Hettinger
6:Release: |release|
7:Date: |today|
8
9.. $Id$
10 Rules for maintenance:
11
12 * Anyone can add text to this document. Do not spend very much time
13 on the wording of your changes, because your text will probably
Raymond Hettinger6f04adc2010-12-04 22:56:25 +000014 get rewritten.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +000015
16 * The maintainer will go through Misc/NEWS periodically and add
17 changes; it's therefore more important to add your changes to
18 Misc/NEWS than to this file.
19
20 * This is not a complete list of every single change; completeness
21 is the purpose of Misc/NEWS. Some changes I consider too small
22 or esoteric to include. If such a change is added to the text,
23 I'll just remove it. (This is another reason you shouldn't spend
24 too much time on writing your addition.)
25
26 * If you want to draw your new text to the attention of the
27 maintainer, add 'XXX' to the beginning of the paragraph or
28 section.
29
30 * It's OK to just add a fragmentary note about a change. For
31 example: "XXX Describe the transmogrify() function added to the
32 socket module." The maintainer will research the change and
33 write the necessary text.
34
35 * You can comment out your additions if you like, but it's not
36 necessary (especially when a final release is some months away).
37
38 * Credit the author of a patch or bugfix. Just the name is
Georg Brandlda0a2112010-09-05 11:28:33 +000039 sufficient; the e-mail address isn't necessary. It's helpful to
40 add the issue number:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +000041
Éric Araujo4234ad42010-09-05 17:32:25 +000042 XXX Describe the transmogrify() function added to the socket
43 module.
44
45 (Contributed by P.Y. Developer; :issue:`12345`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +000046
47 This saves the maintainer the effort of going through the SVN log
48 when researching a change.
49
Raymond Hettingerffad35e2010-12-14 21:12:03 +000050This article explains the new features in Python 3.2 as compared to 3.1. It
51focuses on a few highlights and gives a few examples. For full details, see the
52:source:`Misc/NEWS <Misc/NEWS>` file.
Raymond Hettinger2c1ecc32010-12-07 09:55:02 +000053
Raymond Hettinger6778fa92010-12-21 20:09:55 +000054.. seealso::
55
56 :pep:`392` - Python 3.2 Release Schedule
Raymond Hettinger6e6565b2009-06-28 20:56:11 +000057
Raymond Hettingerca904be2011-01-18 00:02:40 +000058
Martin v. Löwis932e49e2010-12-04 13:49:32 +000059PEP 384: Defining a Stable ABI
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000060==============================
61
62In the past, extension modules built for one Python version were often
63not usable with other Python versions. Particularly on Windows, every
64feature release of Python required rebuilding all extension modules that
65one wanted to use. This requirement was the result of the free access to
66Python interpreter internals that extension modules could use.
67
68With Python 3.2, an alternative approach becomes available: extension
Raymond Hettinger6f04adc2010-12-04 22:56:25 +000069modules which restrict themselves to a limited API (by defining
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000070Py_LIMITED_API) cannot use many of the internals, but are constrained
71to a set of API functions that are promised to be stable for several
72releases. As a consequence, extension modules built for 3.2 in that
73mode will also work with 3.3, 3.4, and so on. Extension modules that
74make use of details of memory structures can still be built, but will
75need to be recompiled for every feature release.
76
Raymond Hettinger6f04adc2010-12-04 22:56:25 +000077.. seealso::
78
Georg Brandl65b2eb92010-12-05 11:42:38 +000079 :pep:`384` - Defining a Stable ABI
Raymond Hettinger2c1ecc32010-12-07 09:55:02 +000080 PEP written by Martin von Löwis.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +000081
Raymond Hettingerca904be2011-01-18 00:02:40 +000082
Raymond Hettingera5a35542010-12-05 00:39:18 +000083PEP 389: Argparse Command Line Parsing Module
84=============================================
85
86A new module for command line parsing, :mod:`argparse`, was introduced to
87overcome the limitations of :mod:`optparse` which did not provide support for
Raymond Hettinger677e10a2010-12-07 06:45:30 +000088positional arguments (not just options), subcommands, required options and other
Raymond Hettinger413abbc2010-12-05 07:06:47 +000089common patterns of specifying and validating options.
Raymond Hettingera5a35542010-12-05 00:39:18 +000090
Raymond Hettingerc8a16862011-01-18 09:01:34 +000091This module has already has widespread success in the community as a
Raymond Hettingerb1ff4022010-12-08 11:19:45 +000092third-party module. Being more fully featured than its predecessor, the
93:mod:`argparse` module is now the preferred module for command-line processing.
94The older module is still being kept available because of the substantial amount
95of legacy code that depends on it.
Raymond Hettingera5a35542010-12-05 00:39:18 +000096
Raymond Hettinger677e10a2010-12-07 06:45:30 +000097Here's an annotated example parser showing features like limiting results to a
98set of choices, specifying a *metavar* in the help screen, validating that one
Raymond Hettinger68f1e8d2010-12-07 09:24:30 +000099or more positional arguments is present, and making a required option::
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000100
101 import argparse
102 parser = argparse.ArgumentParser(
103 description = 'Manage servers', # main description for help
104 epilog = 'Tested on Solaris and Linux') # displayed after help
105 parser.add_argument('action', # argument name
Raymond Hettinger92977092011-01-16 09:18:59 +0000106 choices = ['deploy', 'start', 'stop'], # three allowed values
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000107 help = 'action on each target') # help msg
108 parser.add_argument('targets',
109 metavar = 'HOSTNAME', # var name used in help msg
Raymond Hettinger92977092011-01-16 09:18:59 +0000110 nargs = '+', # require one or more targets
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000111 help = 'url for target machines') # help msg explanation
112 parser.add_argument('-u', '--user', # -u or --user option
Georg Brandl52a43b52011-01-16 09:11:45 +0000113 required = True, # make it a required argument
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000114 help = 'login as user')
115
116Example of calling the parser on a command string::
117
118 >>> cmd = 'deploy sneezy.example.com sleepy.example.com -u skycaptain'
119 >>> result = parser.parse_args(cmd.split())
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000120 >>> result.action
121 'deploy'
122 >>> result.targets
123 ['sneezy.example.com', 'sleepy.example.com']
124 >>> result.user
125 'skycaptain'
126
127Example of the parser's automatically generated help::
128
129 >>> parser.parse_args('-h'.split())
130
Raymond Hettinger3fcf0022010-12-08 01:13:53 +0000131 usage: manage_cloud.py [-h] -u USER
132 {deploy,start,stop} HOSTNAME [HOSTNAME ...]
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000133
134 Manage servers
135
136 positional arguments:
137 {deploy,start,stop} action on each target
138 HOSTNAME url for target machines
139
140 optional arguments:
141 -h, --help show this help message and exit
142 -u USER, --user USER login as user
143
144 Tested on Solaris and Linux
145
Raymond Hettingerb1ff4022010-12-08 11:19:45 +0000146An especially nice :mod:`argparse` feature is the ability to define subparsers,
147each with their own argument patterns and help displays::
148
149 import argparse
150 parser = argparse.ArgumentParser(prog='HELM')
151 subparsers = parser.add_subparsers()
152
153 parser_l = subparsers.add_parser('launch', help='Launch Control') # first subgroup
Raymond Hettingerbb9686f2010-12-16 00:53:05 +0000154 parser_l.add_argument('-m', '--missiles', action='store_true')
Raymond Hettingerb1ff4022010-12-08 11:19:45 +0000155 parser_l.add_argument('-t', '--torpedos', action='store_true')
156
Raymond Hettinger3094ed82010-12-18 09:41:32 +0000157 parser_m = subparsers.add_parser('move', help='Move Vessel', # second subgroup
158 aliases=('steer', 'turn')) # equivalent names
Raymond Hettingerb1ff4022010-12-08 11:19:45 +0000159 parser_m.add_argument('-c', '--course', type=int, required=True)
160 parser_m.add_argument('-s', '--speed', type=int, default=0)
161
162 $ ./helm.py --help # top level help (launch and move)
163 $ ./helm.py launch --help # help for launch options
164 $ ./helm.py launch --missiles # set missiles=True and torpedos=False
Raymond Hettinger3094ed82010-12-18 09:41:32 +0000165 $ ./helm.py steer --course 180 --speed 5 # set movement parameters
Raymond Hettingera5a35542010-12-05 00:39:18 +0000166
167.. seealso::
168
169 :pep:`389` - New Command Line Parsing Module
170 PEP written by Steven Bethard.
171
Raymond Hettingerbe9994e2011-01-19 08:44:33 +0000172 :ref:`upgrading-optparse-code` for details on the differences from :mod:`optparse`.
Raymond Hettinger677e10a2010-12-07 06:45:30 +0000173
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000174
Éric Araujo4234ad42010-09-05 17:32:25 +0000175PEP 391: Dictionary Based Configuration for Logging
176====================================================
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000177
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000178The :mod:`logging` module provided two kinds of configuration, one style with
179function calls for each option or another style driven by an external file saved
180in a :mod:`ConfigParser` format. Those options did not provide the flexibility
Georg Brandl9e75cad2010-09-06 06:45:47 +0000181to create configurations from JSON or YAML files, nor did they support
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000182incremental configuration, which is needed for specifying logger options from a
183command line.
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000184
185To support a more flexible style, the module now offers
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000186:func:`logging.config.dictConfig` for specifying logging configuration with
187plain Python dictionaries. The configuration options include formatters,
188handlers, filters, and loggers. Here's a working example of a configuration
189dictionary::
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000190
Georg Brandlda0a2112010-09-05 11:28:33 +0000191 {"version": 1,
192 "formatters": {"brief": {"format": "%(levelname)-8s: %(name)-15s: %(message)s"},
193 "full": {"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"},
194 },
195 "handlers": {"console": {
196 "class": "logging.StreamHandler",
197 "formatter": "brief",
198 "level": "INFO",
199 "stream": "ext://sys.stdout"},
200 "console_priority": {
201 "class": "logging.StreamHandler",
202 "formatter": "full",
203 "level": "ERROR",
204 "stream": "ext://sys.stderr"},
205 },
206 "root": {"level": "DEBUG", "handlers": ["console", "console_priority"]}}
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000207
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000208
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000209If that dictionary is stored in a file called :file:`conf.json`, it can be
210loaded and called with code like this::
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000211
Raymond Hettingerca904be2011-01-18 00:02:40 +0000212 >>> import json, logging.config
213 >>> with open('conf.json', 'rb') as f:
214 conf = json.load(f)
215 >>> logging.config.dictConfig(conf)
216 >>> logging.info("Transaction completed normally")
217 >>> logging.critical("Abnormal termination")
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000218
Raymond Hettingeref2335c2010-09-05 08:35:38 +0000219.. seealso::
220
221 :pep:`391` - Dictionary Based Configuration for Logging
222 PEP written by Vinay Sajip.
223
Raymond Hettingerca904be2011-01-18 00:02:40 +0000224
Georg Brandl97b20da2010-11-16 15:15:29 +0000225PEP 3148: The ``concurrent.futures`` module
226============================================
227
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000228Code for creating and managing concurrency is being collected in a new top-level
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000229namespace, *concurrent*. Its first member is a *futures* package which provides
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000230a uniform high-level interface for managing threads and processes.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000231
232The design for :mod:`concurrent.futures` was inspired by
233*java.util.concurrent.package*. In that model, a running call and its result
Raymond Hettingerc136b042011-01-18 07:15:39 +0000234are represented by a :class:`~concurrent.futures.Future` object that abstracts
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000235features common to threads, processes, and remote procedure calls. That object
236supports status checks (running or done), timeouts, cancellations, adding
Raymond Hettinger24a09412010-12-08 06:50:02 +0000237callbacks, and access to results or exceptions.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000238
239The primary offering of the new module is a pair of executor classes for
240launching and managing calls. The goal of the executors is to make it easier to
241use existing tools for making parallel calls. They save the effort needed to
242setup a pool of resources, launch the calls, create a results queue, add
243time-out handling, and limit the total number of threads, processes, or remote
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000244procedure calls.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000245
246Ideally, each application should share a single executor across multiple
247components so that process and thread limits can be centrally managed. This
248solves the design challenge that arises when each component has its own
249competing strategy for resource management.
250
Raymond Hettingerb1055192010-12-08 06:42:41 +0000251Both classes share a common interface with three methods:
252:meth:`~concurrent.futures.Executor.submit` for scheduling a callable and
253returning a :class:`~concurrent.futures.Future` object;
254:meth:`~concurrent.futures.Executor.map` for scheduling many asynchronous calls
Raymond Hettinger83d80792010-12-08 06:48:33 +0000255at a time, and :meth:`~concurrent.futures.Executor.shutdown` for freeing
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000256resources. The class is a :term:`context manager` and can be used in a
Raymond Hettinger83d80792010-12-08 06:48:33 +0000257:keyword:`with` statement to assure that resources are automatically released
258when currently pending futures are done executing.
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000259
Raymond Hettingerb1055192010-12-08 06:42:41 +0000260A simple of example of :class:`~concurrent.futures.ThreadPoolExecutor` is a
Raymond Hettinger83d80792010-12-08 06:48:33 +0000261launch of four parallel threads for copying files::
Raymond Hettingerb1055192010-12-08 06:42:41 +0000262
263 import shutil
264 with ThreadPoolExecutor(max_workers=4) as e:
265 e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
266 e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
267 e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
268 e.submit(shutil.copy, 'src3.txt', 'dest4.txt')
269
Raymond Hettinger6f04adc2010-12-04 22:56:25 +0000270.. seealso::
271
Raymond Hettingera5a35542010-12-05 00:39:18 +0000272 :pep:`3148` - Futures -- Execute Computations Asynchronously
Andrew M. Kuchling42877fe2010-12-15 02:37:01 +0000273 PEP written by Brian Quinlan.
Georg Brandl97b20da2010-11-16 15:15:29 +0000274
Raymond Hettinger83d80792010-12-08 06:48:33 +0000275 :ref:`Code for Threaded Parallel URL reads<threadpoolexecutor-example>`, an
276 example using threads to fetch multiple web pages in parallel.
277
278 :ref:`Code for computing prime numbers in
279 parallel<processpoolexecutor-example>`, an example demonstrating
280 :class:`~concurrent.futures.ProcessPoolExecutor`.
281
282
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000283PEP 3147: PYC Repository Directories
284=====================================
285
David Malcolm778645a2010-12-07 00:32:04 +0000286Python's scheme for caching bytecode in *.pyc* files did not work well in
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000287environments with multiple Python interpreters. If one interpreter encountered
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000288a cached file created by another interpreter, it would recompile the source and
289overwrite the cached file, thus losing the benefits of caching.
290
291The issue of "pyc fights" has become more pronounced as it has become
Éric Araujo4234ad42010-09-05 17:32:25 +0000292commonplace for Linux distributions to ship with multiple versions of Python.
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000293These conflicts also arise with CPython alternatives such as Unladen Swallow.
294
295To solve this problem, Python's import machinery has been extended to use
Éric Araujo4234ad42010-09-05 17:32:25 +0000296distinct filenames for each interpreter. Instead of Python 3.2 and Python 3.3 and
297Unladen Swallow each competing for a file called "mymodule.pyc", they will now
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000298look for "mymodule.cpython-32.pyc", "mymodule.cpython-33.pyc", and
Éric Araujo4234ad42010-09-05 17:32:25 +0000299"mymodule.unladen10.pyc". And to prevent all of these new files from
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000300cluttering source directories, the *pyc* files are now collected in a
301"__pycache__" directory stored under the package directory.
302
303Aside from the filenames and target directories, the new scheme has a few
304aspects that are visible to the programmer:
305
Georg Brandlda0a2112010-09-05 11:28:33 +0000306* Imported modules now have a :attr:`__cached__` attribute which stores the name
307 of the actual file that was imported:
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000308
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000309 >>> import collections
310 >>> collections.__cached__
311 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000312
313* The tag that is unique to each interpreter is accessible from the :mod:`imp`
Georg Brandlda0a2112010-09-05 11:28:33 +0000314 module:
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000315
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000316 >>> import imp
317 >>> imp.get_tag()
318 'cpython-32'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000319
320* Scripts that try to deduce source filename from the imported file now need to
321 be smarter. It is no longer sufficient to simply strip the "c" from a ".pyc"
322 filename. Instead, use the new functions in the :mod:`imp` module:
323
Georg Brandlda0a2112010-09-05 11:28:33 +0000324 >>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc')
325 'c:/py32/lib/collections.py'
326 >>> imp.cache_from_source('c:/py32/lib/collections.py')
327 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000328
329* The :mod:`py_compile` and :mod:`compileall` modules have been updated to
330 reflect the new naming convention and target directory.
331
Raymond Hettinger1dcc84e2011-01-17 21:55:40 +0000332* The :mod:`importlib.abc` module has been updated with new :term:`abstract base
Raymond Hettinger66352d22011-01-17 22:33:11 +0000333 classes <abstract base class>` for the loading bytecode files. The obsolete
334 ABCs, :class:`~importlib.abc.PyLoader` and
Raymond Hettinger1dcc84e2011-01-17 21:55:40 +0000335 :class:`~importlib.abc.PyPycLoader`, have been deprecated (instructions on how
Raymond Hettinger66352d22011-01-17 22:33:11 +0000336 to stay Python 3.1 compatible are included with the documentation).
Brett Cannon83a682d2011-01-16 21:02:09 +0000337
Raymond Hettingerf95b1992010-09-04 23:53:24 +0000338.. seealso::
339
340 :pep:`3147` - PYC Repository Directories
341 PEP written by Barry Warsaw.
342
Georg Brandlda0a2112010-09-05 11:28:33 +0000343
Georg Brandl3ad46752010-12-05 07:59:29 +0000344PEP 3149: ABI Version Tagged .so Files
345======================================
Georg Brandlf11c6c42010-09-03 22:20:58 +0000346
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000347The PYC repository directory allows multiple bytecode cache files to be
348co-located. This PEP implements a similar mechanism for shared object files by
349giving them a common directory and distinct names for each version.
Georg Brandlf11c6c42010-09-03 22:20:58 +0000350
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000351The common directory is "pyshared" and the file names are made distinct by
352identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the
353major and minor version numbers, and optional build flags (such as "d" for
Éric Araujo4234ad42010-09-05 17:32:25 +0000354debug, "m" for pymalloc, "u" for wide-unicode). For an arbitrary package "foo",
Raymond Hettingerebea6fa2010-09-05 00:27:25 +0000355you may see these files when the distribution package is installed::
356
357 /usr/share/pyshared/foo.cpython-32m.so
358 /usr/share/pyshared/foo.cpython-33md.so
359
360In Python itself, the tags are accessible from functions in the :mod:`sysconfig`
361module::
362
363 >>> import sysconfig
364 >>> sysconfig.get_config_var('SOABI') # find the version tag
365 'cpython-32mu'
366 >>> sysconfig.get_config_var('SO') # find the full filename extension
367 'cpython-32mu.so'
368
369.. seealso::
370
371 :pep:`3149` - ABI Version Tagged .so Files
372 PEP written by Barry Warsaw.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000373
Raymond Hettingerca904be2011-01-18 00:02:40 +0000374
Raymond Hettinger3df46212011-01-06 02:01:26 +0000375PEP 3333: Python Web Server Gateway Interface v1.0.1
376=====================================================
377
378This informational PEP clarifies how bytes/text issues are to be handled by the
379WGSI protocol. The challenge is that string handling in Python 3 is most
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000380conveniently handled with the :class:`str` type even though the HTTP protocol
Raymond Hettinger3df46212011-01-06 02:01:26 +0000381is itself bytes oriented.
382
383The PEP differentiates so-called *native strings* that are used for
384request/response headers and metadata versus *byte strings* which are used for
385the bodies of requests and responses.
386
387The *native strings* are always of type :class:`str` but are restricted to code
Georg Brandl52a43b52011-01-16 09:11:45 +0000388points between *U+0000* through *U+00FF* which are translatable to bytes using
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000389*Latin-1* encoding. These strings are used for the keys and values in the
390environ dictionary and for response headers and statuses in the
391:func:`start_response` function. They must follow :rfc:`2616` with respect to
Raymond Hettinger3df46212011-01-06 02:01:26 +0000392encoding. That is, they must either be *ISO-8859-1* characters or use
393:rfc:`2047` MIME encoding.
394
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000395For developers porting WSGI applications from Python 2, here are the salient
396points:
397
398* If the app already used strings for headers in Python 2, no change is needed.
399
400* If instead, the app encoded output headers or decoded input headers, then the
401 headers will need to be re-encoded to Latin-1. For example, an output header
402 encoded in utf-8 was using ``h.encode('utf-8')`` now needs to convert from
403 bytes to native strings using ``h.encode('utf-8').decode('latin-1')``.
404
405* Values yielded by an application or sent using the :meth:`write` method
Raymond Hettinger51e21072011-01-10 23:38:15 +0000406 must be byte strings. The :func:`start_response` function and environ
407 must use native strings. The two cannot be mixed.
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000408
409For server implementers writing CGI-to-WSGI pathways or other CGI-style
410protocols, the users must to be able access the environment using native strings
Raymond Hettingerc136b042011-01-18 07:15:39 +0000411even though the underlying platform may have a different convention. To bridge
Raymond Hettinger32e8fea2011-01-07 21:04:30 +0000412this gap, the :mod:`wsgiref` module has a new function,
413:func:`wsgiref.handlers.read_environ` for transcoding CGI variables from
414:attr:`os.environ` into native strings and returning a new dictionary.
Raymond Hettinger3df46212011-01-06 02:01:26 +0000415
416.. seealso::
417
418 :pep:`3333` - Python Web Server Gateway Interface v1.0.1
419 PEP written by Phillip Eby.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000420
Raymond Hettingerca904be2011-01-18 00:02:40 +0000421
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000422Other Language Changes
423======================
424
425Some smaller changes made to the core Python language are:
426
Raymond Hettingere5e1a982010-12-05 08:35:21 +0000427* String formatting for :func:`format` and :meth:`str.format` gained new
428 capabilities for the format character **#**. Previously, for integers in
429 binary, octal, or hexadecimal, it caused the output to be prefixed with '0b',
430 '0o', or '0x' respectively. Now it can also handle floats, complex, and
431 Decimal, causing the output to always have a decimal point even when no digits
432 follow it.
Raymond Hettingere5e728b2010-12-05 06:35:16 +0000433
434 >>> format(20, '#o')
435 '0o24'
436 >>> format(12.34, '#5.0f')
437 ' 12.'
438
439 (Suggested by Mark Dickinson and implemented by Eric Smith in :issue:`7094`.)
Raymond Hettinger43b5a852010-12-05 04:04:21 +0000440
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000441* The interpreter can now be started with a quiet option, ``-q``, to suppress
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000442 the copyright and version information from being displayed in the interactive
443 mode. The option can be introspected using the :attr:`sys.flags` attribute::
Raymond Hettinger7d967712011-01-05 20:24:08 +0000444
445 $ python -q
446 >>> sys.flags
447 sys.flags(debug=0, division_warning=0, inspect=0, interactive=0,
448 optimize=0, dont_write_bytecode=0, no_user_site=0, no_site=0,
449 ignore_environment=0, verbose=0, bytes_warning=0, quiet=1)
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000450
Raymond Hettinger51e21072011-01-10 23:38:15 +0000451 (Contributed by Marcin Wojdyr in :issue:`1772833`).
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000452
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000453* The :func:`hasattr` function works by calling :func:`getattr` and detecting
454 whether an exception is raised. This technique allows it to detect methods
455 created dynamically by :meth:`__getattr__` or :meth:`__getattribute__` which
Raymond Hettinger90a4b312011-01-06 02:08:30 +0000456 would otherwise be absent from the class dictionary. Formerly, *hasattr*
457 would catch any exception, possibly masking genuine errors. Now, *hasattr*
458 has been tightened to only catch :exc:`AttributeError` and let other
459 exceptions pass through.
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000460
Raymond Hettingera55ffbc2010-12-15 18:31:57 +0000461 (Discovered by Yury Selivanov and fixed by Benjamin Peterson; :issue:`9666`.)
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000462
Éric Araujo4234ad42010-09-05 17:32:25 +0000463* The :func:`str` of a float or complex number is now the same as its
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000464 :func:`repr`. Previously, the :func:`str` form was shorter but that just
Éric Araujo4234ad42010-09-05 17:32:25 +0000465 caused confusion and is no longer needed now that the shortest possible
Georg Brandlda0a2112010-09-05 11:28:33 +0000466 :func:`repr` is displayed by default:
Raymond Hettingerbb734c62010-09-05 05:56:44 +0000467
Raymond Hettinger92ba2862010-09-06 01:16:46 +0000468 >>> repr(math.pi)
469 '3.141592653589793'
470 >>> str(math.pi)
471 '3.141592653589793'
Raymond Hettinger1784ff02010-09-05 01:00:19 +0000472
Georg Brandlda0a2112010-09-05 11:28:33 +0000473 (Proposed and implemented by Mark Dickinson; :issue:`9337`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000474
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +0000475* :class:`memoryview` objects now have a :meth:`~memoryview.release()` method
476 and they also now support the context manager protocol. This allows timely
477 release of any resources that were acquired when requesting a buffer from the
478 original object.
Antoine Pitroud3052002010-09-15 15:09:40 +0000479
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000480 >>> with memoryview(b'abcdefgh') as v:
481 ... print(v.tolist())
482 ...
483 [97, 98, 99, 100, 101, 102, 103, 104]
484
Antoine Pitroud3052002010-09-15 15:09:40 +0000485 (Added by Antoine Pitrou; :issue:`9757`.)
486
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000487* Previously it was illegal to delete a name from the local namespace if it
488 occurs as a free variable in a nested block::
489
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000490 def outer(x):
491 def inner():
492 return x
493 inner()
494 del x
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000495
496 This is now allowed. Remember that the target of an :keyword:`except` clause
497 is cleared, so this code which used to work with Python 2.6, raised a
498 :exc:`SyntaxError` with Python 3.1 and now works again::
499
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000500 def f():
501 def print_error():
502 print(e)
503 try:
504 something
505 except Exception as e:
506 print_error()
507 # implicit "del e" here
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000508
509 (See :issue:`4617`.)
510
Raymond Hettinger480ed782010-12-15 22:07:15 +0000511* The internal :c:type:`structsequence` tool now creates subclasses of tuple.
Raymond Hettinger51e21072011-01-10 23:38:15 +0000512 This means that C structures like those returned by :func:`os.stat`,
Raymond Hettingera275c982011-01-20 04:03:19 +0000513 :func:`time.gmtime`, and :attr:`sys.version_info` now work like a
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000514 :term:`named tuple` and now work with functions and methods that
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000515 expect a tuple as an argument. This is a big step forward in making the C
Raymond Hettingera275c982011-01-20 04:03:19 +0000516 structures as flexible as their pure Python counterparts:
517
518 >>> isinstance(sys.version_info, tuple)
519 True
520 >>> 'Version %d.%d.%d %s(%d)' % sys.version_info
521 'Version 3.2.0 final(0)'
Raymond Hettinger480ed782010-12-15 22:07:15 +0000522
523 (Suggested by Arfrever Frehtes Taifersar Arahesis and implemented
524 by Benjamin Peterson in :issue:`8413`.)
525
Raymond Hettingerc8a16862011-01-18 09:01:34 +0000526* Warnings are now easier to control using the :envvar:`PYTHONWARNINGS`
Raymond Hettingera275c982011-01-20 04:03:19 +0000527 environment variable as an alternative to using ``-W`` at the command line::
528
529 $ export PYTHONWARNINGS='ignore::RuntimeWarning::,once::UnicodeWarning::'
Raymond Hettinger480ed782010-12-15 22:07:15 +0000530
531 (Suggested by Barry Warsaw and implemented by Philip Jenvey in :issue:`7301`.)
532
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000533* A new warning category, :exc:`ResourceWarning`, has been added. It is
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000534 emitted when potential issues with resource consumption or cleanup
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000535 are detected. It is silenced by default in normal release builds but
Raymond Hettingerc269ae82010-12-05 01:01:52 +0000536 can be enabled through the means provided by the :mod:`warnings`
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000537 module, or on the command line.
538
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000539 A :exc:`ResourceWarning` is issued at interpreter shutdown if the
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000540 :data:`gc.garbage` list isn't empty. This is meant to make the programmer
541 aware that their code contains object finalization issues.
542
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000543 A :exc:`ResourceWarning` is also issued when a :term:`file object` is destroyed
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000544 without having been explicitly closed. While the deallocator for such
545 object ensures it closes the underlying operating system resource
546 (usually, a file descriptor), the delay in deallocating the object could
547 produce various issues, especially under Windows. Here is an example
548 of enabling the warning from the command line::
549
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000550 $ python -q -Wdefault
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000551 >>> f = open("foo", "wb")
552 >>> del f
553 __main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000554
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000555 (Added by Antoine Pitrou and Georg Brandl in :issue:`10093` and :issue:`477863`.)
Antoine Pitrou7d15a722010-11-05 22:13:55 +0000556
Raymond Hettingera0266332010-12-07 08:52:41 +0000557* :class:`range` objects now support *index* and *count* methods. This is part
558 of an effort to make more objects fully implement the
559 :class:`collections.Sequence` :term:`abstract base class`. As a result, the
560 language will have a more uniform API. In addition, :class:`range` objects
Raymond Hettingerb9656292011-01-16 18:22:06 +0000561 now support slicing and negative indices, even with values larger than
562 :attr:`sys.maxsize`. This makes *range* more interoperable with lists::
Raymond Hettinger2ffa6712010-12-08 10:18:21 +0000563
564 >>> range(0, 100, 2).count(10)
565 1
566 >>> range(0, 100, 2).index(10)
567 5
568 >>> range(0, 100, 2)[5]
569 10
570 >>> range(0, 100, 2)[0:5]
571 range(0, 10, 2)
Raymond Hettingerdadf93c2010-12-05 02:56:21 +0000572
Raymond Hettingerb9656292011-01-16 18:22:06 +0000573 (Contributed by Daniel Stutzbach in :issue:`9213`, by Alexander Belopolsky
574 in :issue:`2690`, and by Nick Coghlan in :issue:`10889`.)
Nick Coghlan37ee8502010-12-03 14:26:13 +0000575
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000576* The :func:`callable` builtin function from Py2.x was resurrected. It provides
Raymond Hettingerb87ba262010-12-06 04:31:40 +0000577 a concise, readable alternative to using an :term:`abstract base class` in an
Raymond Hettinger792c0762010-12-09 16:41:54 +0000578 expression like ``isinstance(x, collections.Callable)``:
579
580 >>> callable(max)
581 True
582 >>> callable(20)
583 False
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +0000584
585 (See :issue:`10518`.)
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000586
Raymond Hettinger93c8cad2011-01-18 00:30:24 +0000587* Python's import mechanism can now load modules installed in directories with
Raymond Hettingera275c982011-01-20 04:03:19 +0000588 non-ASCII characters in the path name:
589
590 >>> import møøse.bites
Raymond Hettinger070ec702010-12-10 17:45:13 +0000591
592 (Required extensive work by Victor Stinner in :issue:`9425`.)
593
594
Raymond Hettinger6e6565b2009-06-28 20:56:11 +0000595New, Improved, and Deprecated Modules
596=====================================
597
Raymond Hettinger99db3fd2010-12-15 19:33:49 +0000598Python's standard library has undergone significant maintenance efforts and
599quality improvements.
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000600
601The biggest news for Python 3.2 is that the :mod:`email` package and
Raymond Hettinger99db3fd2010-12-15 19:33:49 +0000602:mod:`nntplib` modules now work correctly with the bytes/text model in Python 3.
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000603For the first time, there is correct handling of inputs with mixed encodings.
604
Raymond Hettinger6046e222010-12-16 00:21:08 +0000605Throughout the standard library, there has been more careful attention to
606encodings and text versus bytes issues. In particular, interactions with the
607operating system are now better able to pass non-ASCII data using the Windows
Raymond Hettingerba5512f2011-01-18 08:28:01 +0000608MBCS encoding, locale-aware encodings, or UTF-8.
Raymond Hettinger6046e222010-12-16 00:21:08 +0000609
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000610Another significant win is the addition of substantially better support for
611*SSL* connections and security certificates.
612
Raymond Hettinger51e21072011-01-10 23:38:15 +0000613In addition, more classes now implement a :term:`context manager` to support
Raymond Hettingerc136b042011-01-18 07:15:39 +0000614convenient and reliable resource clean-up using a :keyword:`with` statement.
Raymond Hettingere434b3b2010-12-15 19:20:01 +0000615
Raymond Hettinger0358a172010-12-15 19:00:38 +0000616email
617-----
618
619The usability of the :mod:`email` package in Python 3 has been mostly fixed by
620the extensive efforts of R. David Murray. The problem was that emails are
621typically read and stored in the form of :class:`bytes` rather than :class:`str`
622text, and they may contain multiple encodings within a single email. So, the
623email package had to be extended to parse and generate email messages in bytes
624format.
625
626* New functions :func:`~email.message_from_bytes` and
627 :func:`~email.message_from_binary_file`, and new classes
628 :class:`~email.parser.BytesFeedParser` and :class:`~email.parser.BytesParser`
629 allow binary message data to be parsed into model objects.
630
631* Given bytes input to the model, :meth:`~email.message.Message.get_payload`
632 will by default decode a message body that has a
633 :mailheader:`Content-Transfer-Encoding` of *8bit* using the charset
634 specified in the MIME headers and return the resulting string.
635
636* Given bytes input to the model, :class:`~email.generator.Generator` will
637 convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of
638 *8bit* to instead have a *7bit* :mailheader:`Content-Transfer-Encoding`.
Raymond Hettingerc08ea612011-01-08 10:32:31 +0000639
Raymond Hettingercf8a3822011-01-11 21:20:20 +0000640 Headers with unencoded non-ASCII bytes are deemed to be :rfc:`2047`\ -encoded
641 using the *unknown-8bit* character set.
Raymond Hettinger0358a172010-12-15 19:00:38 +0000642
643* A new class :class:`~email.generator.BytesGenerator` produces bytes as output,
644 preserving any unchanged non-ASCII data that was present in the input used to
645 build the model, including message bodies with a
646 :mailheader:`Content-Transfer-Encoding` of *8bit*.
647
648* The :mod:`smtplib` :class:`~smtplib.SMTP` class now accepts a byte string
649 for the *msg* argument to the :meth:`~smtplib.SMTP.sendmail` method,
650 and a new method, :meth:`~smtplib.SMTP.send_message` accepts a
651 :class:`~email.message.Message` object and can optionally obtain the
652 *from_addr* and *to_addrs* addresses directly from the object.
653
Raymond Hettinger0358a172010-12-15 19:00:38 +0000654(Proposed and implemented by R. David Murray, :issue:`4661` and :issue:`10321`.)
655
Raymond Hettinger6046e222010-12-16 00:21:08 +0000656elementtree
657-----------
658
Georg Brandl5d53fdd2010-12-18 11:58:12 +0000659The :mod:`xml.etree.ElementTree` package and its :mod:`xml.etree.cElementTree`
Raymond Hettinger6046e222010-12-16 00:21:08 +0000660counterpart have been updated to version 1.3.
661
662Several new and useful functions and methods have been added:
663
664* :func:`xml.etree.ElementTree.fromstringlist` which builds an XML document
665 from a sequence of fragments
666* :func:`xml.etree.ElementTree.register_namespace` for registering a global
667 namespace prefix
668* :func:`xml.etree.ElementTree.tostringlist` for string representation
669 including all sublists
670* :meth:`xml.etree.ElementTree.Element.extend` for appending a sequence of zero
671 or more elements
672* :meth:`xml.etree.ElementTree.Element.iterfind` searches an element and
673 subelements
674* :meth:`xml.etree.ElementTree.Element.itertext` creates a text iterator over
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000675 an element and its subelements
Raymond Hettinger6046e222010-12-16 00:21:08 +0000676* :meth:`xml.etree.ElementTree.TreeBuilder.end` closes the current element
677* :meth:`xml.etree.ElementTree.TreeBuilder.doctype` handles a doctype
678 declaration
679
680Two methods have been deprecated:
681
682* :meth:`xml.etree.ElementTree.getchildren` use ``list(elem)`` instead.
683* :meth:`xml.etree.ElementTree.getiterator` use ``Element.iter`` instead.
684
685For details of the update, see `Introducing ElementTree
686<http://effbot.org/zone/elementtree-13-intro.htm>`_ on Fredrik Lundh's website.
687
Antoine Pitrou12de8ac2010-12-16 13:33:56 +0000688(Contributed by Florent Xicluna and Fredrik Lundh, :issue:`6472`.)
Raymond Hettinger0358a172010-12-15 19:00:38 +0000689
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000690functools
691---------
692
Éric Araujo4234ad42010-09-05 17:32:25 +0000693* The :mod:`functools` module includes a new decorator for caching function
Georg Brandlda0a2112010-09-05 11:28:33 +0000694 calls. :func:`functools.lru_cache` can save repeated queries to an external
695 resource whenever the results are expected to be the same.
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000696
Raymond Hettinger86f96132010-08-06 23:23:49 +0000697 For example, adding a caching decorator to a database query function can save
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000698 database accesses for popular searches:
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000699
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000700 >>> @functools.lru_cache(maxsize=300)
701 >>> def get_phone_number(name):
702 c = conn.cursor()
703 c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,))
704 return c.fetchone()[0]
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000705
Georg Brandlda0a2112010-09-05 11:28:33 +0000706 >>> for name in user_requests:
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000707 get_phone_number(name) # cached lookup
Raymond Hettinger7496b412010-11-30 19:15:45 +0000708
709 To help with choosing an effective cache size, the wrapped function is
710 instrumented for tracking cache statistics:
711
Raymond Hettinger5e20bab2010-11-30 07:13:04 +0000712 >>> get_phone_number.cache_info()
Raymond Hettinger7496b412010-11-30 19:15:45 +0000713 CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300)
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000714
Raymond Hettingerf3098282010-08-15 03:30:45 +0000715 If the phonelist table gets updated, the outdated contents of the cache can be
Georg Brandlda0a2112010-09-05 11:28:33 +0000716 cleared with:
Raymond Hettingerf3098282010-08-15 03:30:45 +0000717
Georg Brandlda0a2112010-09-05 11:28:33 +0000718 >>> get_phone_number.cache_clear()
Raymond Hettingerf3098282010-08-15 03:30:45 +0000719
Raymond Hettinger6e353942010-12-04 23:42:12 +0000720 (Contributed by Raymond Hettinger and incorporating design ideas from
Raymond Hettingerb87ba262010-12-06 04:31:40 +0000721 Jim Baker, Miki Tebeka, and Nick Coghlan.)
Raymond Hettingeraed05eb2010-08-02 01:43:41 +0000722
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000723* The :func:`functools.wraps` decorator now adds a :attr:`__wrapped__` attribute
724 pointing to the original callable function. This allows wrapped functions to
725 be introspected. It also copies :attr:`__annotations__` if defined. And now
726 it also gracefully skips over missing attributes such as :attr:`__doc__` which
Raymond Hettinger5eb63902010-12-09 23:43:34 +0000727 might not be defined for the wrapped callable.
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000728
729 (By Nick Coghlan and Terrence Cole; :issue:`9567`, :issue:`3445`, and
730 :issue:`8814`.)
731
Raymond Hettinger6046e222010-12-16 00:21:08 +0000732* To help write classes with rich comparison methods, a new decorator
733 :func:`functools.total_ordering` will use a existing equality and inequality
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000734 methods to fill in the remaining methods.
Raymond Hettinger6046e222010-12-16 00:21:08 +0000735
736 For example, supplying *__eq__* and *__lt__* will enable
737 :func:`~functools.total_ordering` to fill-in *__le__*, *__gt__* and *__ge__*::
738
739 @total_ordering
740 class Student:
741 def __eq__(self, other):
742 return ((self.lastname.lower(), self.firstname.lower()) ==
743 (other.lastname.lower(), other.firstname.lower()))
744 def __lt__(self, other):
745 return ((self.lastname.lower(), self.firstname.lower()) <
746 (other.lastname.lower(), other.firstname.lower()))
747
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000748 With the *total_ordering* decorator, the remaining comparison methods
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000749 are filled in automatically.
Raymond Hettinger6046e222010-12-16 00:21:08 +0000750
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000751 (Contributed by Raymond Hettinger.)
Raymond Hettingerf35a34c2010-12-22 09:11:54 +0000752
Raymond Hettinger4bea9782011-01-19 04:14:34 +0000753* To aid in porting programs from Python 2, the :func:`functools.cmp_to_key`
Raymond Hettingerbb9686f2010-12-16 00:53:05 +0000754 function converts an old-style comparison function to
Raymond Hettinger6046e222010-12-16 00:21:08 +0000755 modern :term:`key function`:
756
757 >>> # locale-aware sort order
758 >>> sorted(iterable, key=cmp_to_key(locale.strcoll))
759
760 For sorting examples and a brief sorting tutorial, see the `Sorting HowTo
761 <http://wiki.python.org/moin/HowTo/Sorting/>`_ tutorial.
762
763 (Contributed by Raymond Hettinger.)
764
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000765itertools
766---------
767
Raymond Hettinger673ccf22010-12-07 09:37:11 +0000768* The :mod:`itertools` module has a new :func:`~itertools.accumulate` function
Raymond Hettinger4bea9782011-01-19 04:14:34 +0000769 modeled on APL's *scan* operator and Numpy's *accumulate* function:
Raymond Hettinger6e353942010-12-04 23:42:12 +0000770
771 >>> list(accumulate(8, 2, 50))
772 [8, 10, 60]
773
774 >>> prob_dist = [0.1, 0.4, 0.2, 0.3]
775 >>> list(accumulate(prob_dist)) # cumulative probability distribution
776 [0.1, 0.5, 0.7, 1.0]
777
778 For an example using :func:`~itertools.accumulate`, see the :ref:`examples for
779 the random module <random-examples>`.
780
781 (Contributed by Raymond Hettinger and incorporating design suggestions
782 from Mark Dickinson.)
783
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000784collections
785-----------
786
Raymond Hettinger792c0762010-12-09 16:41:54 +0000787* The :class:`collections.Counter` class now has two forms of in-place
788 subtraction, the existing *-=* operator for `saturating subtraction
789 <http://en.wikipedia.org/wiki/Saturation_arithmetic>`_ and the new
790 :meth:`~collections.Counter.subtract` method for regular subtraction. The
791 former is suitable for `multisets <http://en.wikipedia.org/wiki/Multiset>`_
Raymond Hettingerffad35e2010-12-14 21:12:03 +0000792 which only have positive counts, and the latter is more suitable for use cases
Raymond Hettinger792c0762010-12-09 16:41:54 +0000793 that allow negative counts:
Alexander Belopolsky72572312010-12-08 21:21:56 +0000794
Raymond Hettinger792c0762010-12-09 16:41:54 +0000795 >>> tally = Counter(dogs=5, cat=3)
796 >>> tally -= Counter(dogs=2, cats=8) # saturating subtraction
797 >>> tally
798 Counter({'dogs': 3})
Alexander Belopolsky72572312010-12-08 21:21:56 +0000799
Raymond Hettinger792c0762010-12-09 16:41:54 +0000800 >>> tally = Counter(dogs=5, cats=3)
801 >>> tally.subtract(dogs=2, cats=8) # regular subtraction
802 >>> tally
803 Counter({'dogs': 3, 'cats': -5})
Alexander Belopolsky72572312010-12-08 21:21:56 +0000804
Raymond Hettinger792c0762010-12-09 16:41:54 +0000805 (Contributed by Raymond Hettinger.)
Alexander Belopolsky72572312010-12-08 21:21:56 +0000806
Raymond Hettingere0a96002010-12-15 17:54:13 +0000807* The :class:`collections.OrderedDict` class has a new method
808 :meth:`~collections.OrderedDict.move_to_end` which takes an existing key and
Raymond Hettinger23ab1012011-01-18 20:25:04 +0000809 moves it to either the first or last position in the ordered sequence.
810
811 The default is to move an item to the last position. This is equivalent of
812 renewing an entry with ``od[k] = od.pop(k)``.
813
814 A fast move-to-end operation is useful for resequencing entries. For example,
815 an ordered dictionary can being used to track access order by aging entries
816 from oldest to most recently accessed.
Raymond Hettingere0a96002010-12-15 17:54:13 +0000817
818 >>> d = OrderedDict.fromkeys(['a', 'b', 'X', 'd', 'e'])
819 >>> list(d)
820 ['a', 'b', 'X', 'd', 'e']
Raymond Hettinger23ab1012011-01-18 20:25:04 +0000821 >>> d.move_to_end('X')
Raymond Hettingere0a96002010-12-15 17:54:13 +0000822 >>> list(d)
823 ['a', 'b', 'd', 'e', 'X']
Raymond Hettingere0a96002010-12-15 17:54:13 +0000824
Raymond Hettinger6046e222010-12-16 00:21:08 +0000825 (Contributed by Raymond Hettinger.)
826
Raymond Hettinger7ec790d2011-01-18 00:19:30 +0000827* The :class:`collections.deque` class grew two new methods
828 :meth:`~collections.deque.count` and :meth:`~collections.deque.reverse` that
829 make them more substitutable for :class:`list` objects:
Raymond Hettinger6046e222010-12-16 00:21:08 +0000830
831 >>> d = deque('simsalabim')
832 >>> d.count('s')
833 2
834 >>> d.reverse()
835 >>> d
836 deque(['m', 'i', 'b', 'a', 'l', 'a', 's', 'm', 'i', 's'])
837
838 (Contributed by Raymond Hettinger.)
839
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000840threading
841---------
842
843The :mod:`threading` module has a new :class:`~threading.Barrier`
844synchronization class for making multiple threads wait until all of them have
845reached a common barrier point. Barriers are useful for making sure that a task
846with multiple preconditions does not run until all of the predecessor tasks are
847complete.
848
849Barriers can work with an arbitrary number of threads. This is a generalization
850of a `Rendezvous <http://en.wikipedia.org/wiki/Synchronous_rendezvous>`_ which
851is defined for only two threads.
852
Raymond Hettinger15b47c52011-01-17 21:05:07 +0000853Implemented as a two-phase cyclic barrier, :class:`~threading.Barrier` objects
854are suitable for use in loops. The separate *filling* and *draining* phases
Raymond Hettingere0f1f322011-01-18 21:14:27 +0000855assure that all threads get released (drained) before any one of them can loop
856back and re-enter the barrier. The barrier fully resets after each cycle.
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000857
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000858Example of using barriers::
859
860 def get_votes(site):
861 ballots = conduct_election(site)
862 all_polls_closed.wait() # do not count until all polls are closed
Raymond Hettinger97673652011-01-11 21:13:26 +0000863 totals = summarize(ballots)
864 publish(site, totals)
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000865
866 all_polls_closed = Barrier(len(sites))
Raymond Hettinger3a8ae5f2011-01-11 20:51:45 +0000867 for site in sites:
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000868 Thread(target=get_votes, args=(site,)).start()
869
870In this example, the barrier enforces a rule that votes cannot be counted at any
871polling site until all polls are closed. Notice how a solution with a barrier
872is similar to one with :meth:`threading.Thread.join`, but the threads stay alive
873and continue to do work (summarizing ballots) after the barrier point is
874crossed.
875
Raymond Hettinger2c3865b2011-01-18 22:58:33 +0000876If any of the predecessor tasks can hang or be delayed, a barrier can be created
877with an optional *timeout* parameter. Then if the timeout period elapses before
878all the predecessor tasks reach the barrier point, all waiting threads are
879released and a :exc:`~threading.BrokenBarrierError` exception is raised::
880
881 def get_votes(site):
882 ballots = conduct_election(site)
883 try:
884 all_polls_closed.wait(timeout = midnight - time.now())
David Malcolm49348642011-01-18 23:45:53 +0000885 except BrokenBarrierError:
Raymond Hettinger2c3865b2011-01-18 22:58:33 +0000886 lockbox = seal_ballots(ballots)
887 queue.put(lockbox)
888 else:
889 totals = summarize(ballots)
890 publish(site, totals)
891
892In this example, the barrier enforces a more robust rule. If some election
893sites do not finish before midnight, the barrier times-out and the ballots are
894sealed and deposited in a queue for later handling.
895
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000896See `Barrier Synchronization Patterns
Raymond Hettinger3a8ae5f2011-01-11 20:51:45 +0000897<http://parlab.eecs.berkeley.edu/wiki/_media/patterns/paraplop_g1_3.pdf>`_ for
898more examples of how barriers can be used in parallel computing. Also, there is
899a simple but thorough explanation of barriers in `The Little Book of Semaphores
900<http://greenteapress.com/semaphores/downey08semaphores.pdf>`_, *section 3.6*.
Raymond Hettinger5cee47f2011-01-11 19:59:46 +0000901
Raymond Hettinger3a8ae5f2011-01-11 20:51:45 +0000902(Contributed by Kristján Valur Jónsson with an API review by Jeffrey Yasskin in
903:issue:`8777`.)
Raymond Hettinger6655d112011-01-11 08:49:10 +0000904
Raymond Hettinger97673652011-01-11 21:13:26 +0000905datetime and time
906-----------------
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000907
Raymond Hettinger792c0762010-12-09 16:41:54 +0000908* The :mod:`datetime` module has a new type :class:`~datetime.timezone` that
909 implements the :class:`~datetime.tzinfo` interface by returning a fixed UTC
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000910 offset and timezone name. This makes it easier to create timezone-aware
Raymond Hettinger792c0762010-12-09 16:41:54 +0000911 datetime objects:
Alexander Belopolsky72572312010-12-08 21:21:56 +0000912
Raymond Hettinger792c0762010-12-09 16:41:54 +0000913 >>> datetime.now(timezone.utc)
914 datetime.datetime(2010, 12, 8, 21, 4, 2, 923754, tzinfo=datetime.timezone.utc)
Alexander Belopolsky72572312010-12-08 21:21:56 +0000915
Raymond Hettinger792c0762010-12-09 16:41:54 +0000916 >>> datetime.strptime("01/01/2000 12:00 +0000", "%m/%d/%Y %H:%M %z")
917 datetime.datetime(2000, 1, 1, 12, 0, tzinfo=datetime.timezone.utc)
Alexander Belopolsky72572312010-12-08 21:21:56 +0000918
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000919* Also, :class:`~datetime.timedelta` objects can now be multiplied by
Raymond Hettinger792c0762010-12-09 16:41:54 +0000920 :class:`float` and divided by :class:`float` and :class:`int` objects.
Raymond Hettinger2169ee22011-01-05 22:27:49 +0000921 And :class:`~datetime.timedelta` objects can now divide one another.
Raymond Hettinger792c0762010-12-09 16:41:54 +0000922
Raymond Hettingerca904be2011-01-18 00:02:40 +0000923* The :meth:`datetime.date.strftime` method is no longer restricted to years
924 after 1900. The new supported year range is from 1000 to 9999 inclusive.
Alexander Belopolsky72572312010-12-08 21:21:56 +0000925
Raymond Hettinger97673652011-01-11 21:13:26 +0000926* The rules for two-digit years in time tuples have changed. Now, the
927 :func:`time.asctime` and :func:`time.strftime` functions will format any year
928 when :attr:`time.accept2dyear` is false and will accept four-digit years
929 otherwise. The :func:`time.mktime` and :func:`time.strftime` functions now
930 accept full range supported by the operating system. Conversion of two-digit
931 years to four-digit is deprecated.
Alexander Belopolskybd96b062011-01-10 21:55:34 +0000932
Raymond Hettinger97673652011-01-11 21:13:26 +0000933(Contributed by Alexander Belopolsky and Victor Stinner.)
Alexander Belopolskybd96b062011-01-10 21:55:34 +0000934
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000935abc
936---
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000937
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000938The :mod:`abc` module now supports :func:`~abc.abstractclassmethod` and
939:func:`~abc.abstractstaticmethod`.
Raymond Hettingera5a35542010-12-05 00:39:18 +0000940
Raymond Hettinger7ec790d2011-01-18 00:19:30 +0000941These tools make it possible to define an :term:`abstract base class` that
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000942requires a particular :func:`classmethod` or :func:`staticmethod` to be
Raymond Hettinger7ec790d2011-01-18 00:19:30 +0000943implemented::
944
945 class Temperature(metaclass=ABCMeta):
946 @abc.abstractclassmethod
947 def from_farenheit(self, t):
948 ...
949 @abc.abstractclassmethod
950 def from_celsium(self, t):
951 ...
Antoine Pitrou7d49bc92010-09-15 15:13:17 +0000952
Raymond Hettingerbba537b2010-12-15 18:20:19 +0000953(Patch submitted by Daniel Urban; :issue:`5867`.)
Raymond Hettingerbcbd6962010-09-05 08:46:36 +0000954
Raymond Hettinger480ed782010-12-15 22:07:15 +0000955contextlib
956----------
957
958There is a new and slightly mind-blowing tool
959:class:`~contextlib.ContextDecorator` that is helpful for creating a
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000960:term:`context manager` that does double duty as a function decorator.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000961
962As a convenience, this new functionality is used by
963:func:`~contextlib.contextmanager` so that no extra effort is needed to support
964both roles.
965
966The basic idea is that both context managers and function decorators can be used
967for pre-action and post-action wrappers. Context managers wrap a group of
Raymond Hettingerc136b042011-01-18 07:15:39 +0000968statements using a :keyword:`with` statement, and function decorators wrap a
Raymond Hettinger480ed782010-12-15 22:07:15 +0000969group of statements enclosed in a function. So, occasionally there is a need to
Raymond Hettingerde2e6182011-01-10 05:40:57 +0000970write a pre-action or post-action wrapper that can be used in either role.
Raymond Hettinger480ed782010-12-15 22:07:15 +0000971
972For example, it is sometimes useful to wrap functions or groups of statements
973with a logger that can track the time of entry and time of exit. Rather than
974writing both a function decorator and a context manager for the task, the
975:func:`~contextlib.contextmanager` provides both capabilities in a single
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000976definition::
Raymond Hettinger480ed782010-12-15 22:07:15 +0000977
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000978 import logging
979 logging.basicConfig(level=logging.INFO)
980 @contextmanager
981 def track_entry_and_exit(name):
982 logging.info('Entering: {}'.format(name))
983 yield
984 logging.info('Exiting: {}'.format(name))
Raymond Hettinger480ed782010-12-15 22:07:15 +0000985
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000986Formerly, this would have only been usable as a context manager::
Raymond Hettinger480ed782010-12-15 22:07:15 +0000987
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000988 with track_entry_and_exit('widget loader'):
989 print('Some time consuming activity goes here')
990 load_widget()
Raymond Hettinger480ed782010-12-15 22:07:15 +0000991
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000992Now, it can be used as a decorator as well::
Raymond Hettinger480ed782010-12-15 22:07:15 +0000993
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +0000994 @track_entry_and_exit('widget loader')
995 def activity():
996 print('Some time consuming activity goes here')
997 load_widget()
Raymond Hettinger480ed782010-12-15 22:07:15 +0000998
999Trying to fulfill two roles at once places some limitations on the technique.
1000Context managers normally have the flexibility to return an argument usable by
Raymond Hettingerc136b042011-01-18 07:15:39 +00001001a :keyword:`with` statement, but there is no parallel for function decorators.
Raymond Hettinger480ed782010-12-15 22:07:15 +00001002
Raymond Hettinger9743e4f2010-12-16 02:24:12 +00001003In the above example, there is not a clean way for the *track_entry_and_exit*
Raymond Hettinger388af4b2011-01-06 20:55:29 +00001004context manager to return a logging instance for use in the body of enclosed
1005statements.
Raymond Hettinger480ed782010-12-15 22:07:15 +00001006
1007(Contributed by Michael Foord in :issue:`9110`.)
1008
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001009decimal and fractions
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001010---------------------
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001011
1012Mark Dickinson crafted an elegant and efficient scheme for assuring that
1013different numeric datatypes will have the same hash value whenever their actual
1014values are equal (:issue:`8188`)::
1015
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001016 assert hash(Fraction(3, 2)) == hash(1.5) == \
1017 hash(Decimal("1.5")) == hash(complex(1.5, 0))
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001018
1019An early decision to limit the inter-operability of various numeric types has
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001020been relaxed. It is still unsupported (and ill-advised) to have implicit
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001021mixing in arithmetic expressions such as ``Decimal('1.1') + float('1.1')``
1022because the latter loses information in the process of constructing the binary
1023float. However, since existing floating point value can be converted losslessly
1024to either a decimal or rational representation, it makes sense to add them to
1025the constructor and to support mixed-type comparisons.
1026
Raymond Hettingerbb9686f2010-12-16 00:53:05 +00001027* The :class:`decimal.Decimal` constructor now accepts :class:`float` objects
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001028 directly so there in no longer a need to use the :meth:`~decimal.Decimal.from_float`
Raymond Hettinger6046e222010-12-16 00:21:08 +00001029 method (:issue:`8257`).
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001030
1031* Mixed type comparisons are now fully supported so that
1032 :class:`~decimal.Decimal` objects can be directly compared with :class:`float`
Raymond Hettinger6046e222010-12-16 00:21:08 +00001033 and :class:`fractions.Fraction` (:issue:`2531` and :issue:`8188`).
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001034
1035Similar changes were made to :class:`fractions.Fraction` so that the
1036:meth:`~fractions.Fraction.from_float()` and :meth:`~fractions.Fraction.from_decimal`
Raymond Hettinger6046e222010-12-16 00:21:08 +00001037methods are no longer needed (:issue:`8294`):
1038
1039>>> Decimal(1.1)
1040Decimal('1.100000000000000088817841970012523233890533447265625')
1041>>> Fraction(1.1)
1042Fraction(2476979795053773, 2251799813685248)
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001043
1044Another useful change for the :mod:`decimal` module is that the
1045:attr:`Context.clamp` attribute is now public. This is useful in creating
1046contexts that correspond to the decimal interchange formats specified in IEEE
1047754 (see :issue:`8540`).
1048
Raymond Hettinger6046e222010-12-16 00:21:08 +00001049(Contributed by Mark Dickinson and Raymond Hettinger.)
Raymond Hettinger07a605b2010-12-15 22:35:03 +00001050
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001051ftp
1052---
Raymond Hettingerbcbd6962010-09-05 08:46:36 +00001053
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001054The :class:`ftplib.FTP` class now supports the context manager protocol to
1055unconditionally consume :exc:`socket.error` exceptions and to close the FTP
1056connection when done::
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +00001057
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001058 >>> from ftplib import FTP
1059 >>> with FTP("ftp1.at.proftpd.org") as ftp:
1060 ... ftp.login()
1061 ... ftp.dir()
1062 ...
1063 '230 Anonymous login ok, restrictions apply.'
1064 dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .
1065 dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 ..
1066 dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS
1067 dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora
Georg Brandlda0a2112010-09-05 11:28:33 +00001068
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001069Other file-like objects such as :class:`mmap.mmap` and :func:`fileinput.input`
1070also grew auto-closing context managers::
1071
1072 with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
1073 for line in f:
1074 process(line)
1075
1076(Contributed by Tarek Ziadé and Giampaolo Rodolà in :issue:`4972`, and
1077by Georg Brandl in :issue:`8046` and :issue:`1286`.)
Antoine Pitrou696e0352010-08-08 22:18:46 +00001078
Antoine Pitroubcba4342011-01-16 18:29:34 +00001079The :class:`~ftplib.FTP_TLS` class now accepts a *context* parameter, which is a
1080:class:`ssl.SSLContext` object allowing bundling SSL configuration options,
Raymond Hettinger4854d142011-01-17 21:29:58 +00001081certificates and private keys into a single (potentially long-lived) structure.
Antoine Pitroubcba4342011-01-16 18:29:34 +00001082
1083(Contributed by Giampaolo Rodolà; :issue:`8806`.)
1084
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001085popen
1086-----
1087
1088The :func:`os.popen` and :func:`subprocess.Popen` functions now support
Raymond Hettingerc136b042011-01-18 07:15:39 +00001089:keyword:`with` statements for auto-closing of the file descriptors.
Georg Brandl3ad46752010-12-05 07:59:29 +00001090
Raymond Hettinger6046e222010-12-16 00:21:08 +00001091gzip and zipfile
1092----------------
Antoine Pitroucd889af2010-10-06 21:13:56 +00001093
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001094:class:`gzip.GzipFile` now implements the :class:`io.BufferedIOBase`
1095:term:`abstract base class` (except for ``truncate()``). It also has a
1096:meth:`~gzip.GzipFile.peek` method and supports unseekable as well as
1097zero-padded file objects.
Raymond Hettingera0266332010-12-07 08:52:41 +00001098
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001099The :mod:`gzip` module also gains the :func:`~gzip.compress` and
1100:func:`~gzip.decompress` functions for easier in-memory compression and
Raymond Hettinger51e21072011-01-10 23:38:15 +00001101decompression. Keep in mind that text needs to be encoded as :class:`bytes`
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001102before compressing and decompressing:
Raymond Hettingera0266332010-12-07 08:52:41 +00001103
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001104>>> s = 'Three shall be the number thou shalt count, '
1105>>> s += 'and the number of the counting shall be three'
1106>>> b = s.encode() # convert to utf-8
1107>>> len(b)
110889
1109>>> c = gzip.compress(b)
1110>>> len(c)
111177
1112>>> gzip.decompress(c).decode()[:42] # decompress and convert to text
1113'Three shall be the number thou shalt count,'
Antoine Pitroucd889af2010-10-06 21:13:56 +00001114
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001115(Contributed by Anand B. Pillai in :issue:`3488`; and by Antoine Pitrou, Nir
1116Aides and Brian Curtin in :issue:`9962`, :issue:`1675951`, :issue:`7471` and
1117:issue:`2846`.)
1118
Raymond Hettinger6046e222010-12-16 00:21:08 +00001119Also, the :class:`zipfile.ZipExtFile` class was reworked internally to represent
1120files stored inside an archive. The new implementation is significantly faster
1121and can be wrapped in a :class:`io.BufferedReader` object for more speedups. It
1122also solves an issue where interleaved calls to *read* and *readline* gave the
1123wrong results.
1124
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001125(Patch submitted by Nir Aides in :issue:`7610`.)
Raymond Hettinger6046e222010-12-16 00:21:08 +00001126
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001127shutil
1128------
1129
1130The :func:`shutil.copytree` function has two new options:
Antoine Pitroud67075e2010-07-31 22:48:02 +00001131
Antoine Pitrou121a0552011-01-16 18:16:52 +00001132* *ignore_dangling_symlinks*: when ``symlinks=False`` so that the function
Raymond Hettingerc136b042011-01-18 07:15:39 +00001133 copies a file pointed to by a symlink, not the symlink itself. This option
1134 will silence the error raised if the file doesn't exist.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001135
Antoine Pitrou121a0552011-01-16 18:16:52 +00001136* *copy_function*: is a callable that will be used to copy files.
1137 :func:`shutil.copy2` is used by default.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001138
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001139(Contributed by Tarek Ziadé.)
Antoine Pitroud67075e2010-07-31 22:48:02 +00001140
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001141sqlite3
1142-------
Antoine Pitroue43f9d02010-08-08 23:24:50 +00001143
Raymond Hettinger6046e222010-12-16 00:21:08 +00001144The :mod:`sqlite3` module was updated to version 2.6.0. It has two new capabilities.
Antoine Pitroue43f9d02010-08-08 23:24:50 +00001145
Raymond Hettinger0358a172010-12-15 19:00:38 +00001146* The :attr:`sqlite3.Connection.in_transit` attribute is true if there is an
1147 active transaction for uncommitted changes.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001148
Raymond Hettinger0358a172010-12-15 19:00:38 +00001149* The :meth:`sqlite3.Connection.enable_load_extension` and
1150 :meth:`sqlite3.Connection.load_extension` methods allows you to load SQLite
1151 extensions from ".so" files. One well-known extension is the fulltext-search
1152 extension distributed with SQLite.
Antoine Pitroud67075e2010-07-31 22:48:02 +00001153
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001154(Contributed by R. David Murray and Shashwat Anand; :issue:`8845`.)
1155
1156socket
1157------
1158
1159The :mod:`socket` module has two new improvements.
1160
1161* Socket objects now have a :meth:`~socket.socket.detach()` method which puts
1162 the socket into closed state without actually closing the underlying file
1163 descriptor. The latter can then be reused for other purposes.
1164 (Added by Antoine Pitrou; :issue:`8524`.)
1165
1166* :func:`socket.create_connection` now supports the context manager protocol
1167 to unconditionally consume :exc:`socket.error` exceptions and to close the
1168 socket when done.
1169 (Contributed by Giampaolo Rodolà; :issue:`9794`.)
1170
1171ssl
1172---
Antoine Pitroud67075e2010-07-31 22:48:02 +00001173
Raymond Hettinger4854d142011-01-17 21:29:58 +00001174The :mod:`ssl` module added a number of features to satisfy common requirements
1175for secure (encrypted, authenticated) internet connections:
Antoine Pitrou33da1d62011-01-16 18:16:09 +00001176
Raymond Hettinger4854d142011-01-17 21:29:58 +00001177* A new class, :class:`~ssl.SSLContext`, serves as a container for persistent
1178 SSL data, such as protocol settings, certificates, private keys, and various
1179 other options. It includes a :meth:`~ssl.SSLContext.wrap_socket` for creating
1180 an SSL socket from an SSL context.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001181
Raymond Hettinger4854d142011-01-17 21:29:58 +00001182* A new function, :func:`ssl.match_hostname`, supports server identity
1183 verification for higher-level protocols by implementing the rules of HTTPS
1184 (from :rfc:`2818`) which are also suitable for other protocols.
Antoine Pitrou0ee4c9f2010-10-08 16:46:17 +00001185
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001186* The :func:`ssl.wrap_socket` constructor function now takes a *ciphers*
Raymond Hettinger4854d142011-01-17 21:29:58 +00001187 argument. The *ciphers* string lists the allowed encryption algorithms using
1188 the format described in the `OpenSSL documentation
1189 <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT>`__.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001190
Raymond Hettinger4854d142011-01-17 21:29:58 +00001191* When linked against recent versions of OpenSSL, the :mod:`ssl` module now
1192 supports the Server Name Indication extension to the TLS protocol, allowing
1193 multiple "virtual hosts" using different certificates on a single IP port.
1194 This extension is only supported in client mode, and is activated by passing
1195 the *server_hostname* argument to :meth:`ssl.SSLContext.wrap_socket`.
Antoine Pitrou7d15a722010-11-05 22:13:55 +00001196
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001197* Various options have been added to the :mod:`ssl` module, such as
Raymond Hettinger4854d142011-01-17 21:29:58 +00001198 :data:`~ssl.OP_NO_SSLv2` which disables the insecure and obsolete SSLv2
1199 protocol.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001200
Raymond Hettinger4854d142011-01-17 21:29:58 +00001201* The extension now loads all the OpenSSL ciphers and digest algorithms. If
1202 some SSL certificates cannot be verified, they are reported as an "unknown
1203 algorithm" error.
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001204
Raymond Hettinger4854d142011-01-17 21:29:58 +00001205* The version of OpenSSL being used is now accessible using the module
1206 attributes :data:`ssl.OPENSSL_VERSION` (a string),
1207 :data:`ssl.OPENSSL_VERSION_INFO` (a 5-tuple), and
1208 :data:`ssl.OPENSSL_VERSION_NUMBER` (an integer).
1209
1210(Contributed by Antoine Pitrou in :issue:`8850`, :issue:`1589`, :issue:`8322`,
1211:issue:`5639`, :issue:`4870`, :issue:`8484`, and :issue:`8321`.)
Antoine Pitrou4f2a0a82010-07-31 18:08:33 +00001212
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001213nntp
1214----
Raymond Hettinger070ec702010-12-10 17:45:13 +00001215
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001216The :mod:`nntplib` module has a revamped implementation with better bytes and
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001217text semantics as well as more practical APIs. These improvements break
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001218compatibility with the nntplib version in Python 3.1, which was partly
1219dysfunctional in itself.
Raymond Hettinger070ec702010-12-10 17:45:13 +00001220
Antoine Pitrou33da1d62011-01-16 18:16:09 +00001221Support for secure connections through both implicit (using
1222:class:`nntplib.NNTP_SSL`) and explicit (using :meth:`nntplib.NNTP.starttls`)
1223TLS has also been added.
1224
1225(Contributed by Antoine Pitrou in :issue:`9360` and Andrew Vant in :issue:`1926`.)
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001226
1227certificates
1228------------
1229
1230:class:`http.client.HTTPSConnection`, :class:`urllib.request.HTTPSHandler`
1231and :func:`urllib.request.urlopen` now take optional arguments to allow for
1232server certificate checking against a set of Certificate Authorities,
1233as recommended in public uses of HTTPS.
1234
1235(Added by Antoine Pitrou, :issue:`9003`.)
1236
Antoine Pitrou2e8ec222011-01-16 18:41:36 +00001237imaplib
1238-------
1239
1240Support for explicit TLS on standard IMAP4 connections has been added through
1241the new :mod:`imaplib.IMAP4.starttls` method.
1242
1243(Contributed by Lorenzo M. Catucci and Antoine Pitrou, :issue:`4471`.)
1244
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001245unittest
1246--------
Antoine Pitrouafb078d2010-11-05 22:18:28 +00001247
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001248The unittest module has a number of improvements supporting test discovery for
1249packages, easier experimentation at the interactive prompt, new testcase
1250methods, improved diagnostic messages for test failures, and better method
1251names.
1252
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001253* The command-line call ``python -m unittest`` can now accept file paths
Raymond Hettingera0266332010-12-07 08:52:41 +00001254 instead of module names for running specific tests (:issue:`10620`). The new
1255 test discovery can find tests within packages, locating any test importable
Raymond Hettingerc136b042011-01-18 07:15:39 +00001256 from the top-level directory. The top-level directory can be specified with
Raymond Hettingera0266332010-12-07 08:52:41 +00001257 the `-t` option, a pattern for matching files with ``-p``, and a directory to
1258 start discovery with ``-s``::
1259
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001260 $ python -m unittest discover -s my_proj_dir -p _test.py
Raymond Hettingera0266332010-12-07 08:52:41 +00001261
1262 (Contributed by Michael Foord.)
Antoine Pitroud3052002010-09-15 15:09:40 +00001263
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001264* Experimentation at the interactive prompt is now easier because the
1265 :class:`unittest.case.TestCase` class can now be instantiated without
1266 arguments:
1267
1268 >>> TestCase().assertEqual(pow(2, 3), 8)
1269
1270 (Contributed by Michael Foord.)
1271
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001272* The :mod:`unittest` module has two new methods,
1273 :meth:`~unittest.TestCase.assertWarns` and
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001274 :meth:`~unittest.TestCase.assertWarnsRegex` to verify that a given warning type
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001275 is triggered by the code under test::
Antoine Pitroud3052002010-09-15 15:09:40 +00001276
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001277 with self.assertWarns(DeprecationWarning):
1278 legacy_function('XYZ')
Ezio Melotti2baf1a62010-11-22 12:56:58 +00001279
Antoine Pitroueec6dbf2011-01-16 18:21:12 +00001280 (Contributed by Antoine Pitrou, :issue:`9754`.)
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001281
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001282 Another new method, :meth:`~unittest.TestCase.assertCountEqual` is used to
Raymond Hettingerffad35e2010-12-14 21:12:03 +00001283 compare two iterables to determine if their element counts are equal (whether
1284 the same elements are present with the same number of occurrences regardless
1285 of order)::
Raymond Hettingera0266332010-12-07 08:52:41 +00001286
1287 def test_anagram(self):
1288 self.assertCountEqual('algorithm', 'logarithm')
1289
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001290 (Contributed by Raymond Hettinger.)
1291
1292* A principal feature of the unittest module is an effort to produce meaningful
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001293 diagnostics when a test fails. When possible, the failure is recorded along
Raymond Hettingera0266332010-12-07 08:52:41 +00001294 with a diff of the output. This is especially helpful for analyzing log files
1295 of failed test runs. However, since diffs can sometime be voluminous, there is
1296 a new :attr:`~unittest.TestCase.maxDiff` attribute which sets maximum length of
1297 diffs.
1298
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001299* In addition, the method names in the module have undergone a number of clean-ups.
1300
1301 For example, :meth:`~unittest.TestCase.assertRegex` is the new name for
Raymond Hettingera0266332010-12-07 08:52:41 +00001302 :meth:`~unittest.TestCase.assertRegexpMatches` which was misnamed because the
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001303 test uses :func:`re.search`, not :func:`re.match`. Other methods using
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001304 regular expressions are now named using short form "Regex" in preference to
1305 "Regexp" -- this matches the names used in other unittest implementations,
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001306 matches Python's old name for the :mod:`re` module, and it has unambiguous
1307 camel-casing.
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001308
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001309 (Contributed by Raymond Hettinger and implemented by Ezio Melotti.)
1310
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001311* To improve consistency, some long-standing method aliases are being
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001312 deprecated in favor of the preferred names:
1313
Raymond Hettingerc1dfa2e2011-01-19 04:24:57 +00001314 =============================== ==============================
1315 Old Name Preferred Name
1316 =============================== ==============================
1317 :meth:`assert_` :meth:`.assertTrue`
1318 :meth:`assertEquals` :meth:`.assertEqual`
1319 :meth:`assertNotEquals` :meth:`.assertNotEqual`
1320 :meth:`assertAlmostEquals` :meth:`.assertAlmostEqual`
1321 :meth:`assertNotAlmostEquals` :meth:`.assertNotAlmostEqual`
1322 =============================== ==============================
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001323
1324 Likewise, the ``TestCase.fail*`` methods deprecated in Python 3.1 are expected
Raymond Hettingerc1dfa2e2011-01-19 04:24:57 +00001325 to be removed in Python 3.3. Also see the :ref:`deprecated-aliases` section in
Raymond Hettingerdc2f9b52010-12-05 07:02:45 +00001326 the :mod:`unittest` documentation.
Ezio Melotti2baf1a62010-11-22 12:56:58 +00001327
1328 (Contributed by Ezio Melotti; :issue:`9424`.)
Antoine Pitroud3052002010-09-15 15:09:40 +00001329
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001330* The :meth:`~unittest.TestCase.assertDictContainsSubset` method was deprecated
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001331 because it was misimplemented with the arguments in the wrong order. This
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001332 created hard-to-debug optical illusions where tests like
1333 ``TestCase().assertDictContainsSubset({'a':1, 'b':2}, {'a':1})`` would fail.
1334
1335 (Contributed by Raymond Hettinger.)
1336
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001337random
1338------
Raymond Hettingere0a96002010-12-15 17:54:13 +00001339
Raymond Hettinger0358a172010-12-15 19:00:38 +00001340The integer methods in the :mod:`random` module now do a better job of producing
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001341uniform distributions. Previously, they computed selections with
1342``int(n*random())`` which had a slight bias whenever *n* was not a power of two.
Raymond Hettingerc136b042011-01-18 07:15:39 +00001343Now, multiple selections are made from a range up to the next power of two and a
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001344selection is kept only when it falls within the range ``0 <= x < n``. The
1345functions and methods affected are :func:`~random.randrange`,
1346:func:`~random.randint`, :func:`~random.choice`, :func:`~random.shuffle` and
1347:func:`~random.sample`.
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001348
1349(Contributed by Raymond Hettinger; :issue:`9025`.)
1350
1351poplib
1352------
Raymond Hettingere0a96002010-12-15 17:54:13 +00001353
Giampaolo Rodolà42382fe2010-08-17 16:09:53 +00001354* :class:`~poplib.POP3_SSL` class now accepts a *context* parameter, which is a
1355 :class:`ssl.SSLContext` object allowing bundling SSL configuration options,
1356 certificates and private keys into a single (potentially long-lived)
1357 structure.
1358
1359 (Contributed by Giampaolo Rodolà; :issue:`8807`.)
1360
Giampaolo Rodolà977c7072010-10-04 21:08:36 +00001361* :class:`asyncore.dispatcher` now provides a
1362 :meth:`~asyncore.dispatcher.handle_accepted()` method
1363 returning a `(sock, addr)` pair which is called when a connection has actually
1364 been established with a new remote endpoint. This is supposed to be used as a
1365 replacement for old :meth:`~asyncore.dispatcher.handle_accept()` and avoids
1366 the user to call :meth:`~asyncore.dispatcher.accept()` directly.
1367
1368 (Contributed by Giampaolo Rodolà; :issue:`6706`.)
Georg Brandlda0a2112010-09-05 11:28:33 +00001369
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001370tempfile
1371--------
Raymond Hettingera0266332010-12-07 08:52:41 +00001372
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001373The :mod:`tempfile` module has a new context manager,
1374:class:`~tempfile.TemporaryDirectory` which provides easy deterministic
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001375cleanup of temporary directories::
Nick Coghlan543af752010-10-24 11:23:25 +00001376
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001377 with tempfile.TemporaryDirectory() as tmpdirname:
1378 print('created temporary dir:', tmpdirname)
Nick Coghlan543af752010-10-24 11:23:25 +00001379
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001380(Contributed by Neil Schemenauer and Nick Coghlan; :issue:`5178`.)
Nick Coghlane0f04652010-11-21 03:44:04 +00001381
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001382inspect
1383-------
1384
Raymond Hettinger0358a172010-12-15 19:00:38 +00001385* The :mod:`inspect` module has a new function
1386 :func:`~inspect.getgeneratorstate` to easily identify the current state of a
Raymond Hettingera275c982011-01-20 04:03:19 +00001387 generator-iterator::
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001388
Raymond Hettingera275c982011-01-20 04:03:19 +00001389 >>> from inspect import getgeneratorstate
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001390 >>> def gen():
Raymond Hettingera275c982011-01-20 04:03:19 +00001391 yield 'demo'
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001392 >>> g = gen()
Raymond Hettingera275c982011-01-20 04:03:19 +00001393 >>> getgeneratorstate(g)
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001394 'GEN_CREATED'
1395 >>> next(g)
Raymond Hettingera275c982011-01-20 04:03:19 +00001396 'demo'
1397 >>> getgeneratorstate(g)
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001398 'GEN_SUSPENDED'
Raymond Hettingera275c982011-01-20 04:03:19 +00001399 >>> next(g, None)
1400 >>> getgeneratorstate(g)
1401 'GEN_CLOSED'
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001402
1403 (Contributed by Rodolpho Eckhardt and Nick Coghlan, :issue:`10220`.)
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001404
Raymond Hettingera55ffbc2010-12-15 18:31:57 +00001405* To support lookups without the possibility of activating a dynamic attribute,
1406 the :mod:`inspect` module has a new function, :func:`~inspect.getattr_static`.
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001407 Unlike :func:`hasattr`, this is a true read-only search, guaranteed not to
Raymond Hettinger4bea9782011-01-19 04:14:34 +00001408 change state while it is searching::
1409
1410 >>> class A:
1411 @property
1412 def f(self):
1413 print('Running')
1414 return 10
1415
1416 >>> a = A()
1417 >>> getattr(a, 'f')
1418 Running
1419 10
1420 >>> inspect.getattr_static(a, 'f')
1421 <property object at 0x1022bd788>
1422
1423 (Contributed by Michael Foord.)
Nick Coghlane0f04652010-11-21 03:44:04 +00001424
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001425pydoc
1426-----
Nick Coghlan7bb30b72010-12-03 09:29:11 +00001427
Raymond Hettinger89c1cd12011-01-19 04:43:45 +00001428The :mod:`pydoc` module now provides a much-improved Web server interface, as
1429well as a new command-line option ``-b`` to automatically open a browser window
1430to display that server::
1431
1432 $ pydoc3.2 -b
Nick Coghlan7bb30b72010-12-03 09:29:11 +00001433
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001434(Contributed by Ron Adam; :issue:`2001`.)
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001435
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001436sysconfig
1437---------
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001438
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001439The new :mod:`sysconfig` module makes it straightforward to discover
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001440installation paths and configuration variables which vary across platforms and
1441installations.
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001442
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001443The module offers access simple access functions for platform and version
1444information:
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001445
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001446* :func:`~sysconfig.get_platform` returning values like *linux-i586* or
1447 *macosx-10.6-ppc*.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001448* :func:`~sysconfig.get_python_version` returns a Python version string
1449 such as "3.2".
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001450
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001451It also provides access to the paths and variables corresponding to one of
1452seven named schemes used by :mod:`distutils`. Those include *posix_prefix*,
1453*posix_home*, *posix_user*, *nt*, *nt_user*, *os2*, *os2_home*:
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001454
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001455* :func:`~sysconfig.get_paths` makes a dictionary containing installation paths
1456 for the current installation scheme.
1457* :func:`~sysconfig.get_config_vars` returns a dictionary of platform specific
1458 variables.
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001459
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001460There is also a convenient command-line interface::
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001461
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001462 C:\Python32>python -m sysconfig
1463 Platform: "win32"
1464 Python version: "3.2"
1465 Current installation scheme: "nt"
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001466
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001467 Paths:
1468 data = "C:\Python32"
Łukasz Langa79a06ed2010-12-17 22:05:46 +00001469 include = "C:\Python32\Include"
1470 platinclude = "C:\Python32\Include"
1471 platlib = "C:\Python32\Lib\site-packages"
1472 platstdlib = "C:\Python32\Lib"
1473 purelib = "C:\Python32\Lib\site-packages"
1474 scripts = "C:\Python32\Scripts"
1475 stdlib = "C:\Python32\Lib"
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001476
1477 Variables:
1478 BINDIR = "C:\Python32"
Łukasz Langa79a06ed2010-12-17 22:05:46 +00001479 BINLIBDEST = "C:\Python32\Lib"
1480 EXE = ".exe"
1481 INCLUDEPY = "C:\Python32\Include"
1482 LIBDEST = "C:\Python32\Lib"
1483 SO = ".pyd"
1484 VERSION = "32"
1485 abiflags = ""
1486 base = "C:\Python32"
1487 exec_prefix = "C:\Python32"
1488 platbase = "C:\Python32"
1489 prefix = "C:\Python32"
1490 projectbase = "C:\Python32"
1491 py_version = "3.2"
1492 py_version_nodot = "32"
1493 py_version_short = "3.2"
1494 srcdir = "C:\Python32"
1495 userbase = "C:\Documents and Settings\Raymond\Application Data\Python"
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001496
1497pdb
1498---
1499
1500The :mod:`pdb` debugger module gained a number of usability improvements:
Raymond Hettingerb5d79332010-12-07 02:04:56 +00001501
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001502* :file:`pdb.py` now has a ``-c`` option that executes commands as given in a
1503 :file:`.pdbrc` script file.
1504* A :file:`.pdbrc` script file can contain ``continue`` and ``next`` commands
1505 that continue debugging.
1506* The :class:`Pdb` class constructor now accepts a *nosigint* argument.
Raymond Hettinger51e21072011-01-10 23:38:15 +00001507* New commands: ``l(list)``, ``ll(long list)`` and ``source`` for
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001508 listing source code.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001509* New commands: ``display`` and ``undisplay`` for showing or hiding
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001510 the value of an expression if it has changed.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001511* New command: ``interact`` for starting an interactive interpreter containing
Raymond Hettinger99db3fd2010-12-15 19:33:49 +00001512 the global and local names found in the current scope.
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001513* Breakpoints can be cleared by breakpoint number.
Raymond Hettingerb5d79332010-12-07 02:04:56 +00001514
Georg Brandl101234b2010-12-18 11:53:25 +00001515(Contributed by Georg Brandl, Antonio Cuni and Ilya Sandler.)
1516
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001517configparser
1518------------
Raymond Hettinger3f9734c2010-12-07 01:47:52 +00001519
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001520The :mod:`configparser` module was modified to improve usability and
1521predictability of the default parser and its supported INI syntax. The old
1522:class:`ConfigParser` class was removed in favor of :class:`SafeConfigParser`
Raymond Hettinger04129742010-12-18 10:57:50 +00001523which has in turn been renamed to :class:`~configparser.ConfigParser`. Support
1524for inline comments is now turned off by default and section or option
1525duplicates are not allowed in a single configuration source.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001526
1527Config parsers gained a new API based on the mapping protocol::
1528
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001529 >>> parser = ConfigParser()
1530 >>> parser.read_string("""
1531 [DEFAULT]
1532 location = upper left
1533 visible = yes
1534 editable = no
1535 color = blue
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001536
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001537 [main]
1538 title = Main Menu
1539 color = green
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001540
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001541 [options]
1542 title = Options
1543 """)
1544 >>> parser['main']['color']
1545 'green'
1546 >>> parser['main']['editable']
1547 'no'
1548 >>> section = parser['options']
1549 >>> section['title']
1550 'Options'
1551 >>> section['title'] = 'Options (editable: %(editable)s)'
1552 >>> section['title']
1553 'Options (editable: no)'
1554
1555The new API is implemented on top of the classical API, so custom parser
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001556subclasses should be able to use it without modifications.
1557
1558The INI file structure accepted by config parsers can now be customized. Users
Raymond Hettinger04129742010-12-18 10:57:50 +00001559can specify alternative option/value delimiters and comment prefixes, change the
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001560name of the *DEFAULT* section or switch the interpolation syntax.
1561
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001562There is support for pluggable interpolation including an additional interpolation
Raymond Hettinger02dd70b2011-01-17 23:39:39 +00001563handler :class:`~configparser.ExtendedInterpolation`::
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001564
1565 >>> parser = ConfigParser(interpolation=ExtendedInterpolation())
1566 >>> parser.read_dict({'buildout': {'directory': '/home/ambv/zope9'},
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001567 'custom': {'prefix': '/usr/local'}})
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001568 >>> parser.read_string("""
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001569 [buildout]
1570 parts =
1571 zope9
1572 instance
1573 find-links =
1574 ${buildout:directory}/downloads/dist
1575
1576 [zope9]
1577 recipe = plone.recipe.zope9install
1578 location = /opt/zope
1579
1580 [instance]
1581 recipe = plone.recipe.zope9instance
1582 zope9-location = ${zope9:location}
1583 zope-conf = ${custom:prefix}/etc/zope.conf
1584 """)
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001585 >>> parser['buildout']['find-links']
1586 '\n/home/ambv/zope9/downloads/dist'
1587 >>> parser['instance']['zope-conf']
1588 '/usr/local/etc/zope.conf'
1589 >>> instance = parser['instance']
1590 >>> instance['zope-conf']
1591 '/usr/local/etc/zope.conf'
1592 >>> instance['zope9-location']
1593 '/opt/zope'
1594
1595A number of smaller features were also introduced, like support for specifying
Raymond Hettinger04129742010-12-18 10:57:50 +00001596encoding in read operations, specifying fallback values for get-functions, or
1597reading directly from dictionaries and strings.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001598
1599(All changes contributed by Łukasz Langa.)
1600
Raymond Hettingera55ffbc2010-12-15 18:31:57 +00001601.. XXX: Mention urllib.parse changes
1602 Issue 9873 (Nick Coghlan):
1603 - ASCII byte sequence support in URL parsing
1604 - named tuple for urldefrag return value
1605 Issue 5468 (Dan Mahn) for urlencode:
1606 - bytes input support
1607 - non-UTF8 percent encoding of non-ASCII characters
1608 Issue 2987 for IPv6 (RFC2732) support in urlparse
Raymond Hettinger3df46212011-01-06 02:01:26 +00001609
Raymond Hettingera55ffbc2010-12-15 18:31:57 +00001610
Antoine Pitroud42bc512009-11-10 23:18:31 +00001611Multi-threading
1612===============
1613
Georg Brandlda0a2112010-09-05 11:28:33 +00001614* The mechanism for serializing execution of concurrently running Python threads
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001615 (generally known as the :term:`GIL` or :term:`Global Interpreter Lock`) has
1616 been rewritten. Among the objectives were more predictable switching
1617 intervals and reduced overhead due to lock contention and the number of
1618 ensuing system calls. The notion of a "check interval" to allow thread
1619 switches has been abandoned and replaced by an absolute duration expressed in
1620 seconds. This parameter is tunable through :func:`sys.setswitchinterval()`.
1621 It currently defaults to 5 milliseconds.
Antoine Pitroud42bc512009-11-10 23:18:31 +00001622
1623 Additional details about the implementation can be read from a `python-dev
1624 mailing-list message
1625 <http://mail.python.org/pipermail/python-dev/2009-October/093321.html>`_
Georg Brandlda0a2112010-09-05 11:28:33 +00001626 (however, "priority requests" as exposed in this message have not been kept
1627 for inclusion).
Antoine Pitroud42bc512009-11-10 23:18:31 +00001628
Georg Brandl5e73a812010-04-22 07:02:51 +00001629 (Contributed by Antoine Pitrou.)
Antoine Pitroud42bc512009-11-10 23:18:31 +00001630
Georg Brandlda0a2112010-09-05 11:28:33 +00001631* Regular and recursive locks now accept an optional *timeout* argument to their
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001632 :meth:`~threading.Lock.acquire` method. (Contributed by Antoine Pitrou;
1633 :issue:`7316`.)
Georg Brandlda0a2112010-09-05 11:28:33 +00001634
Raymond Hettingerbba537b2010-12-15 18:20:19 +00001635* Similarly, :meth:`threading.Semaphore.acquire` also gained a *timeout*
Georg Brandlda0a2112010-09-05 11:28:33 +00001636 argument. (Contributed by Torsten Landschoff; :issue:`850728`.)
Antoine Pitroue95a9ff2010-05-04 23:31:41 +00001637
Antoine Pitrou810023d2010-12-15 22:59:16 +00001638* Regular and recursive lock acquisitions can now be interrupted by signals on
Raymond Hettingerc136b042011-01-18 07:15:39 +00001639 platforms using Pthreads. This means that Python programs that deadlock while
Antoine Pitrou810023d2010-12-15 22:59:16 +00001640 acquiring locks can be successfully killed by repeatedly sending SIGINT to the
Georg Brandleebb2522010-12-18 12:01:15 +00001641 process (by pressing :kbd:`Ctrl+C` in most shells).
Antoine Pitrou810023d2010-12-15 22:59:16 +00001642 (Contributed by Reid Kleckner; :issue:`8844`.)
1643
Antoine Pitroud42bc512009-11-10 23:18:31 +00001644
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001645Optimizations
1646=============
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001647
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001648A number of small performance enhancements have been added:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001649
Antoine Pitroud3052002010-09-15 15:09:40 +00001650* Python's peephole optimizer now recognizes patterns such ``x in {1, 2, 3}`` as
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001651 being a test for membership in a set of constants. The optimizer recasts the
1652 :class:`set` as a :class:`frozenset` and stores the pre-built constant.
1653
1654 Now that the speed penalty is gone, it is practical to start writing
1655 membership tests using set-notation. This style is both semantically clear
1656 and operationally fast::
1657
1658 extension = name.rpartition('.')[2]
1659 if extension in {'xml', 'html', 'xhtml', 'css'}:
1660 handle(name)
1661
Raymond Hettingerc136b042011-01-18 07:15:39 +00001662 (Patch and additional tests contributed by Dave Malcolm; :issue:`6690`).
Raymond Hettinger92ba2862010-09-06 01:16:46 +00001663
Antoine Pitroud3052002010-09-15 15:09:40 +00001664* Serializing and unserializing data using the :mod:`pickle` module is now
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001665 several times faster.
1666
1667 (Contributed by Alexandre Vassalotti, Antoine Pitrou
Antoine Pitrouff150f22010-10-22 21:41:05 +00001668 and the Unladen Swallow team in :issue:`9410` and :issue:`3873`.)
Antoine Pitroud3052002010-09-15 15:09:40 +00001669
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001670* The `Timsort algorithm <http://en.wikipedia.org/wiki/Timsort>`_ used in
Raymond Hettingerffad35e2010-12-14 21:12:03 +00001671 :meth:`list.sort` and :func:`sorted` now runs faster and uses less memory
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001672 when called with a :term:`key function`. Previously, every element of
1673 a list was wrapped with a temporary object that remembered the key value
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001674 associated with each element. Now, two arrays of keys and values are
Raymond Hettingerc136b042011-01-18 07:15:39 +00001675 sorted in parallel. This saves the memory consumed by the sort wrappers,
1676 and it saves time lost to delegating comparisons.
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001677
Raymond Hettingereb70b902011-01-10 21:26:49 +00001678 (Patch by Daniel Stutzbach in :issue:`9915`.)
Raymond Hettingerc269ae82010-12-05 01:01:52 +00001679
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001680* JSON decoding performance is improved and memory consumption is reduced
Raymond Hettinger413abbc2010-12-05 07:06:47 +00001681 whenever the same string is repeated for multiple keys. Also, JSON encoding
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001682 now uses the C speedups when the ``sort_keys`` argument is true.
1683
1684 (Contributed by Antoine Pitrou in :issue:`7451` and by Raymond Hettinger and
1685 Antoine Pitrou in :issue:`10314`.)
1686
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001687* Recursive locks (created with the :func:`threading.RLock` API) now benefit
1688 from a C implementation which makes them as fast as regular locks, and between
1689 10x and 15x faster than their previous pure Python implementation.
1690
1691 (Contributed by Antoine Pitrou; :issue:`3001`.)
1692
Raymond Hettingerdadf93c2010-12-05 02:56:21 +00001693* The fast-search algorithm in stringlib is now used by the :meth:`split`,
1694 :meth:`rsplit`, :meth:`splitlines` and :meth:`replace` methods on
1695 :class:`bytes`, :class:`bytearray` and :class:`str` objects. Likewise, the
1696 algorithm is also used by :meth:`rfind`, :meth:`rindex`, :meth:`rsplit` and
1697 :meth:`rpartition`.
1698
1699 (Patch by Florent Xicluna in :issue:`7622` and :issue:`7462`.)
1700
Raymond Hettinger480ed782010-12-15 22:07:15 +00001701
1702* String to integer conversions now work two "digits" at a time, reducing the
1703 number of division and modulo operations.
1704
1705 (:issue:`6713` by Gawain Bolton, Mark Dickinson, and Victor Stinner.)
1706
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +00001707There were several other minor optimizations. Set differencing now runs faster
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001708when one operand is much larger than the other (patch by Andress Bennetts in
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +00001709:issue:`8685`). The :meth:`array.repeat` method has a faster implementation
1710(:issue:`1569291` by Alexander Belopolsky). The :class:`BaseHTTPRequestHandler`
1711has more efficient buffering (:issue:`3709` by Andrew Schaaf). The
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001712multi-argument form of :func:`operator.attrgetter` function now runs slightly
Raymond Hettingerd8fae4e2010-12-05 05:39:54 +00001713faster (:issue:`10160` by Christos Georgiou). And :class:`ConfigParser` loads
1714multi-line arguments a bit faster (:issue:`7113` by Łukasz Langa).
1715
Antoine Pitroud3052002010-09-15 15:09:40 +00001716
Victor Stinner47ce9652010-10-29 00:57:35 +00001717Unicode
1718=======
Victor Stinner94908bb2010-08-18 21:23:25 +00001719
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001720Python has been updated to Unicode 6.0.0. The new features of the
1721Unicode Standard that will affect Python users include:
1722
Alexander Belopolsky84cc0622010-12-08 21:38:46 +00001723* addition of 2,088 characters, including over 1,000 additional
1724 symbols—chief among them the additional emoji symbols, which are
1725 especially important for mobile phones;
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001726
Alexander Belopolsky84cc0622010-12-08 21:38:46 +00001727* changes to character properties for existing characters including
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001728
Raymond Hettingerc74d5182010-12-02 01:38:25 +00001729 - a general category change to two Kannada characters (U+0CF1,
1730 U+0CF2), which has the effect of making them newly eligible for
1731 inclusion in identifiers;
1732
1733 - a general category change to one New Tai Lue numeric character
Alexander Belopolsky84cc0622010-12-08 21:38:46 +00001734 (U+19DA), which has the effect of disqualifying it from
1735 inclusion in identifiers.
1736
1737 For more information, see `Unicode Character Database Changes
1738 <http://www.unicode.org/versions/Unicode6.0.0/#Database_Changes>`_
1739 at the `Unicode Consortium <http://www.unicode.org/>`_ web site.
Alexander Belopolsky507e3f82010-12-02 00:05:57 +00001740
Éric Araujo4234ad42010-09-05 17:32:25 +00001741The :mod:`os` module has two new functions: :func:`~os.fsencode` and
Victor Stinner47ce9652010-10-29 00:57:35 +00001742:func:`~os.fsdecode`. Add :data:`os.environb`: bytes version of
1743:data:`os.environ`, :func:`os.getenvb` function and
1744:data:`os.supports_bytes_environ` constant.
Victor Stinnere8d51452010-08-19 01:05:19 +00001745
Raymond Hettinger23ab1012011-01-18 20:25:04 +00001746MBCS encoding doesn't ignore the error handler argument any more. By
Victor Stinner47ce9652010-10-29 00:57:35 +00001747default (strict mode), it raises an UnicodeDecodeError on undecodable byte
Raymond Hettinger23ab1012011-01-18 20:25:04 +00001748sequence and UnicodeEncodeError on unencodable character. To get the MBCS
Victor Stinner47ce9652010-10-29 00:57:35 +00001749encoding of Python 3.1, use ``'ignore'`` error handler to decode and
Raymond Hettinger23ab1012011-01-18 20:25:04 +00001750``'replace'`` error handler to encode. The MBCS codec supports ``'strict'`` and
Victor Stinner47ce9652010-10-29 00:57:35 +00001751``'ignore'`` error handlers for decoding, and ``'strict'`` and ``'replace'``
1752for encoding.
1753
1754On Mac OS X, Python uses ``'utf-8'`` to decode the command line arguments,
1755instead of the locale encoding (which is ISO-8859-1 if the ``LANG`` environment
1756variable is not set).
1757
1758By default, tarfile uses ``'utf-8'`` encoding on Windows (instead of
1759``'mbcs'``), and the ``'surrogateescape'`` error handler on all operating
1760systems.
Antoine Pitroud3052002010-09-15 15:09:40 +00001761
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001762Also, support was added for *cp720* Arabic DOS encoding (:issue:`1616979`).
Raymond Hettinger480ed782010-12-15 22:07:15 +00001763
Victor Stinner94908bb2010-08-18 21:23:25 +00001764
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001765Documentation
1766=============
1767
1768The documentation continues to be improved.
1769
1770A table of quick links has been added to the top of lengthy sections such as
1771:ref:`built-in-funcs`. In the case of :mod:`itertools`, the links are
1772accompanied by tables of cheatsheet-style summaries to provide an overview and
1773memory jog without having to read all of the docs.
1774
Raymond Hettinger51e21072011-01-10 23:38:15 +00001775In some cases, the pure Python source code can be a helpful adjunct to the
1776documentation, so now many modules now feature quick links to the latest version
1777of the source code. For example, the :mod:`functools` module documentation has
1778a quick link at the top labeled: **Source code** :source:`Lib/functools.py`.
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001779
1780The docs now contain more examples and recipes. In particular, :mod:`re` module
1781has an extensive section, :ref:`re-examples`. Likewise, the :mod:`itertools`
1782module continues to be updated with new :ref:`itertools-recipes`.
1783
Raymond Hettinger677e10a2010-12-07 06:45:30 +00001784The :mod:`datetime` module now has an auxiliary implementation in pure Python.
1785No functionality was changed. This just provides an easier-to-read
1786alternate implementation. (Contributed by Alexander Belopolsky.)
1787
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001788The unmaintained :file:`Demo` directory has been removed. Some demos were
1789integrated into the documentation, some were moved to the :file:`Tools/demo`
1790directory, and others were removed altogether. (Contributed by Georg Brandl.)
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001791
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001792
1793IDLE
1794====
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001795
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001796* The format menu now has an option to clean source files by stripping
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001797 trailing whitespace.
1798
1799 (Contributed by Raymond Hettinger; :issue:`5150`.)
1800
1801* IDLE on Mac OS X now works with both Carbon AquaTk and Cocoa AquaTk.
1802
1803 (Contributed by Kevin Walzer, Ned Deily, and Ronald Oussoren; :issue:`6075`.)
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001804
1805
1806Build and C API Changes
1807=======================
1808
1809Changes to Python's build process and to the C API include:
1810
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001811* The *idle*, *pydoc* and *2to3* scripts are now installed with a
1812 version-specific suffix on ``make altinstall`` (:issue:`10679`).
1813
Georg Brandlda0a2112010-09-05 11:28:33 +00001814* The C functions that access the Unicode Database now accept and return
1815 characters from the full Unicode range, even on narrow unicode builds
Raymond Hettinger1784ff02010-09-05 01:00:19 +00001816 (Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and others). A visible difference
Georg Brandlda0a2112010-09-05 11:28:33 +00001817 in Python is that :func:`unicodedata.numeric` now returns the correct value
1818 for large code points, and :func:`repr` may consider more characters as
1819 printable.
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001820
Raymond Hettinger1784ff02010-09-05 01:00:19 +00001821 (Reported by Bupjoe Lee and fixed by Amaury Forgeot D'Arc; :issue:`5127`.)
1822
Georg Brandlda0a2112010-09-05 11:28:33 +00001823* Computed gotos are now enabled by default on supported compilers (which are
Raymond Hettingerdb9044e2010-09-06 01:29:23 +00001824 detected by the configure script). They can still be disabled selectively by
Georg Brandlda0a2112010-09-05 11:28:33 +00001825 specifying ``--without-computed-gotos``.
Raymond Hettinger1784ff02010-09-05 01:00:19 +00001826
Georg Brandlda0a2112010-09-05 11:28:33 +00001827 (Contributed by Antoine Pitrou; :issue:`9203`.)
1828
Amaury Forgeot d'Arcfeb73072010-09-12 22:42:57 +00001829* The option ``--with-wctype-functions`` was removed. The built-in unicode
1830 database is now used for all functions.
1831
1832 (Contributed by Amaury Forgeot D'Arc; :issue:`9210`.)
1833
Raymond Hettinger480ed782010-12-15 22:07:15 +00001834* Hash values are now values of a new type, :c:type:`Py_hash_t`, which is
1835 defined to be the same size as a pointer. Previously they were of type long,
1836 which on some 64-bit operating systems is still only 32 bits long. As a
1837 result of this fix, :class:`set` and :class:`dict` can now hold more than
1838 ``2**32`` entries on builds with 64-bit pointers (previously, they could grow
1839 to that size but their performance degraded catastrophically).
Skip Montanaro961aaf52010-10-17 22:22:24 +00001840
Raymond Hettinger480ed782010-12-15 22:07:15 +00001841 (Suggested by Raymond Hettinger and implemented by Benjamin Peterson;
1842 :issue:`9778`.)
1843
1844* A new macro :c:macro:`Py_VA_COPY` copies the state of the variable argument
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001845 list. It is equivalent to C99 *va_copy* but available on all Python platforms
Raymond Hettinger480ed782010-12-15 22:07:15 +00001846 (:issue:`2443`).
1847
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001848* A new C API function :c:func:`PySys_SetArgvEx` allows an embedded interpreter
1849 to set :attr:`sys.argv` without also modifying :attr:`sys.path`
Raymond Hettinger480ed782010-12-15 22:07:15 +00001850 (:issue:`5753`).
1851
1852* :c:macro:`PyEval_CallObject` is now only available in macro form. The
1853 function declaration, which was kept for backwards compatibility reasons, is
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001854 now removed -- the macro was introduced in 1997 (:issue:`8276`).
Raymond Hettinger480ed782010-12-15 22:07:15 +00001855
1856* The is a new function :c:func:`PyLong_AsLongLongAndOverflow` which
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001857 is analogous to :c:func:`PyLong_AsLongAndOverflow`. They both serve to
Raymond Hettinger480ed782010-12-15 22:07:15 +00001858 convert Python :class:`int` into a native fixed-width type while providing
1859 detection of cases where the conversion won't fit (:issue:`7767`).
1860
1861* The :c:func:`PyUnicode_CompareWithASCIIString` now returns *not equal*
Raymond Hettingerba5512f2011-01-18 08:28:01 +00001862 if the Python string is *NUL* terminated.
Raymond Hettinger480ed782010-12-15 22:07:15 +00001863
1864* There is a new function :c:func:`PyErr_NewExceptionWithDoc` that is
1865 like :c:func:`PyErr_NewException` but allows a docstring to be specified.
1866 This lets C exceptions have the same self-documenting capabilities as
1867 their pure Python counterparts (:issue:`7033`).
1868
1869* When compiled with the ``--with-valgrind`` option, the pymalloc
1870 allocator will be automatically disabled when running under Valgrind. This
1871 gives improved memory leak detection when running under Valgrind, while taking
1872 advantage of pymalloc at other times (:issue:`2422`).
1873
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001874* Removed the ``O?`` format from the *PyArg_Parse* functions. The format is no
Raymond Hettinger480ed782010-12-15 22:07:15 +00001875 longer used and it had never been documented (:issue:`8837`).
1876
1877There were a number of other small changes to the C-API. See the
1878:file:`Misc/NEWS` file for a complete list.
Skip Montanaro961aaf52010-10-17 22:22:24 +00001879
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001880
Raymond Hettingerf558ddd2009-06-28 21:37:08 +00001881Porting to Python 3.2
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001882=====================
1883
Georg Brandlda0a2112010-09-05 11:28:33 +00001884This section lists previously described changes and other bugfixes that may
1885require changes to your code:
Raymond Hettinger6e6565b2009-06-28 20:56:11 +00001886
Raymond Hettingerd73be672010-12-18 10:48:26 +00001887* The :mod:`configparser` module has a number of clean-ups. The major change is
1888 to replace the old :class:`ConfigParser` class with long-standing preferred
1889 alternative :class:`SafeConfigParser`. In addition there are a number of
Raymond Hettingerc8a16862011-01-18 09:01:34 +00001890 smaller incompatibilities:
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001891
Raymond Hettingerd73be672010-12-18 10:48:26 +00001892 * The interpolation syntax is now validated on
1893 :meth:`~configparser.ConfigParser.get` and
1894 :meth:`~configparser.ConfigParser.set` operations. In the default
1895 interpolation scheme, only two tokens with percent signs are valid: ``%(name)s``
1896 and ``%%``, the latter being an escaped percent sign.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001897
Raymond Hettingerd73be672010-12-18 10:48:26 +00001898 * The :meth:`~configparser.ConfigParser.set` and
1899 :meth:`~configparser.ConfigParser.add_section` methods now verify that
1900 values are actual strings. Formerly, unsupported types could be introduced
1901 unintentionally.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001902
Raymond Hettinger2b8861f2010-12-18 11:20:52 +00001903 * Duplicate sections or options from a single source now raise either
Raymond Hettingerd73be672010-12-18 10:48:26 +00001904 :exc:`~configparser.DuplicateSectionError` or
1905 :exc:`~configparser.DuplicateOptionError`. Formerly, duplicates would
1906 silently overwrite a previous entry.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001907
Raymond Hettingerd73be672010-12-18 10:48:26 +00001908 * Inline comments are now disabled by default so now the **;** character
1909 can be safely used in values.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001910
Raymond Hettingerd73be672010-12-18 10:48:26 +00001911 * Comments now can be indented. Consequently, for **;** or **#** to appear at
1912 the start of a line in multiline values, it has to be interpolated. This
Raymond Hettinger2b8861f2010-12-18 11:20:52 +00001913 keeps comment prefix characters in values from being mistaken as comments.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001914
Raymond Hettingerd73be672010-12-18 10:48:26 +00001915 * ``""`` is now a valid value and is no longer automatically converted to an
1916 empty string. For empty strings, use ``"option ="`` in a line.
Łukasz Langa2b38b6c2010-12-17 21:57:32 +00001917
Antoine Pitroucd889af2010-10-06 21:13:56 +00001918* The :mod:`nntplib` module was reworked extensively, meaning that its APIs
1919 are often incompatible with the 3.1 APIs.
1920
Raymond Hettinger1fa76822010-12-06 23:31:36 +00001921* :class:`bytearray` objects can no longer be used as filenames; instead,
1922 they should be converted to :class:`bytes`.
Victor Stinnerdcb24032010-04-22 12:08:36 +00001923
Raymond Hettinger51e21072011-01-10 23:38:15 +00001924* ``PyArg_Parse*()`` functions:
Victor Stinner3dcb5ac2010-06-08 22:54:19 +00001925
Victor Stinner25e8ec42010-06-25 00:02:38 +00001926 * "t#" format has been removed: use "s#" or "s*" instead
1927 * "w" and "w#" formats has been removed: use "w*" instead
1928
Georg Brandl60203b42010-10-06 10:11:56 +00001929* The :c:type:`PyCObject` type, deprecated in 3.1, has been removed. To wrap
1930 opaque C pointers in Python objects, the :c:type:`PyCapsule` API should be used
Éric Araujo4234ad42010-09-05 17:32:25 +00001931 instead; the new type has a well-defined interface for passing typing safety
Georg Brandlda0a2112010-09-05 11:28:33 +00001932 information and a less complicated signature for calling a destructor.
Victor Stinner0cbec572010-09-12 20:32:57 +00001933
Raymond Hettingere0a96002010-12-15 17:54:13 +00001934* The :func:`sys.setfilesystemencoding` function was removed because
1935 it had a flawed design.
Raymond Hettinger3fcf0022010-12-08 01:13:53 +00001936
Raymond Hettingere0a96002010-12-15 17:54:13 +00001937* The :func:`random.seed` function and method now salt string seeds with an
1938 sha512 hash function. To access the previous version of *seed* in order to
1939 reproduce Python 3.1 sequences, set the *version* argument to *1*,
1940 ``random.seed(s, version=1)``.
Raymond Hettinger21ec4bc2010-12-10 01:09:01 +00001941
Raymond Hettinger522cc0a2010-12-10 01:19:15 +00001942* The previously deprecated :func:`string.maketrans` function has been removed
Raymond Hettinger51e21072011-01-10 23:38:15 +00001943 in favor of the static methods :meth:`bytes.maketrans` and
Raymond Hettinger522cc0a2010-12-10 01:19:15 +00001944 :meth:`bytearray.maketrans`. This change solves the confusion around which
1945 types were supported by the :mod:`string` module. Now, :class:`str`,
1946 :class:`bytes`, and :class:`bytearray` each have their own **maketrans** and
1947 **translate** methods with intermediate translation tables of the appropriate
1948 type.
1949
1950 (Contributed by Georg Brandl; :issue:`5675`.)
1951
1952* The previously deprecated :func:`contextlib.nested` function has been removed
1953 in favor of a plain :keyword:`with` statement which can accept multiple
1954 context managers. The latter technique is faster (because it is built-in),
1955 and it does a better job finalizing multiple context managers when one of them
1956 raises an exception::
1957
Raymond Hettinger6f0d59b2011-01-17 23:10:55 +00001958 with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
1959 for line in infile:
1960 if '<critical>' in line:
1961 outfile.write(line)
Raymond Hettinger522cc0a2010-12-10 01:19:15 +00001962
1963 (Contributed by Georg Brandl and Mattias Brändström;
1964 `appspot issue 53094 <http://codereview.appspot.com/53094>`_.)
Victor Stinnerda9ec992010-12-28 13:26:42 +00001965
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001966* :func:`struct.pack` now only allows bytes for the ``s`` string pack code.
1967 Formerly, it would accept text arguments and implicitly encode them to bytes
1968 using UTF-8. This was problematic because it made assumptions about the
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001969 correct encoding and because a variable-length encoding can fail when writing
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001970 to fixed length segment of a structure.
Victor Stinnerda9ec992010-12-28 13:26:42 +00001971
Raymond Hettinger2169ee22011-01-05 22:27:49 +00001972 Code such as ``struct.pack('<6sHHBBB', 'GIF87a', x, y)`` should be rewritten
1973 with to use bytes instead of text, ``struct.pack('<6sHHBBB', b'GIF87a', x, y)``.
1974
Raymond Hettingerde2e6182011-01-10 05:40:57 +00001975 (Discovered by David Beazley and fixed by Victor Stinner; :issue:`10783`.)
Raymond Hettingere40808a2011-01-05 23:00:00 +00001976
1977* The :class:`xml.etree.ElementTree` class now raises an
1978 :exc:`xml.etree.ElementTree.ParseError` when a parse fails. Previously it
1979 raised a :exc:`xml.parsers.expat.ExpatError`.
1980
1981* The new, longer :func:`str` value on floats may break doctests which rely on
1982 the old output format.
Antoine Pitroubcba4342011-01-16 18:29:34 +00001983
1984* In :class:`subprocess.Popen`, the default value for *close_fds* is now
1985 ``True`` under Unix; under Windows, it is ``True`` if the three standard
1986 streams are set to ``None``, ``False`` otherwise. Previously, *close_fds*
1987 was always ``False`` by default, which produced difficult to solve bugs
1988 or race conditions when open file descriptors would leak into the child
1989 process.
1990
Antoine Pitrouf7fb7622011-01-16 18:34:09 +00001991* Support for legacy HTTP 0.9 has been removed from :mod:`urllib.request`
1992 and :mod:`http.client`. Such support is still present on the server side
1993 (in :mod:`http.server`).
1994
1995 (Contributed by Antoine Pitrou, :issue:`10711`.)
1996
Antoine Pitrou2e8ec222011-01-16 18:41:36 +00001997* SSL sockets in timeout mode now raise :exc:`socket.timeout` when a timeout
1998 occurs, rather than a generic :exc:`~ssl.SSLError`.
1999
2000 (Contributed by Antoine Pitrou, :issue:`10272`.)
Antoine Pitrouebeb9032011-01-16 18:45:17 +00002001
2002* The misleading functions :c:func:`PyEval_AcquireLock()` and
2003 :c:func:`PyEval_ReleaseLock()` have been officially deprecated. The
2004 thread-state aware APIs (such as :c:func:`PyEval_SaveThread()`
2005 and :c:func:`PyEval_RestoreThread()`) should be used instead.