Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1 | **************************** |
Raymond Hettinger | f558ddd | 2009-06-28 21:37:08 +0000 | [diff] [blame] | 2 | What's New In Python 3.2 |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 3 | **************************** |
| 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 Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 14 | get rewritten. |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 15 | |
| 16 | * The maintainer will go through Misc/NEWS periodically and add |
| 17 | changes; it's therefore more important to add your changes to |
| 18 | Misc/NEWS than to this file. |
| 19 | |
| 20 | * This is not a complete list of every single change; completeness |
| 21 | is the purpose of Misc/NEWS. Some changes I consider too small |
| 22 | or esoteric to include. If such a change is added to the text, |
| 23 | I'll just remove it. (This is another reason you shouldn't spend |
| 24 | too much time on writing your addition.) |
| 25 | |
| 26 | * If you want to draw your new text to the attention of the |
| 27 | maintainer, add 'XXX' to the beginning of the paragraph or |
| 28 | section. |
| 29 | |
| 30 | * It's OK to just add a fragmentary note about a change. For |
| 31 | example: "XXX Describe the transmogrify() function added to the |
| 32 | socket module." The maintainer will research the change and |
| 33 | write the necessary text. |
| 34 | |
| 35 | * You can comment out your additions if you like, but it's not |
| 36 | necessary (especially when a final release is some months away). |
| 37 | |
| 38 | * Credit the author of a patch or bugfix. Just the name is |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 39 | sufficient; the e-mail address isn't necessary. It's helpful to |
| 40 | add the issue number: |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 41 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 42 | XXX Describe the transmogrify() function added to the socket |
| 43 | module. |
| 44 | |
| 45 | (Contributed by P.Y. Developer; :issue:`12345`.) |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 46 | |
| 47 | This saves the maintainer the effort of going through the SVN log |
| 48 | when researching a change. |
| 49 | |
| 50 | This article explains the new features in Python 3.2, compared to 3.1. |
Raymond Hettinger | 2c1ecc3 | 2010-12-07 09:55:02 +0000 | [diff] [blame] | 51 | It focuses on a few highlights and gives a few examples. For full details, |
| 52 | see the :file:`Misc/NEWS` file. |
| 53 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 54 | |
Martin v. Löwis | 932e49e | 2010-12-04 13:49:32 +0000 | [diff] [blame] | 55 | PEP 384: Defining a Stable ABI |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 56 | ============================== |
| 57 | |
| 58 | In the past, extension modules built for one Python version were often |
| 59 | not usable with other Python versions. Particularly on Windows, every |
| 60 | feature release of Python required rebuilding all extension modules that |
| 61 | one wanted to use. This requirement was the result of the free access to |
| 62 | Python interpreter internals that extension modules could use. |
| 63 | |
| 64 | With Python 3.2, an alternative approach becomes available: extension |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 65 | modules which restrict themselves to a limited API (by defining |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 66 | Py_LIMITED_API) cannot use many of the internals, but are constrained |
| 67 | to a set of API functions that are promised to be stable for several |
| 68 | releases. As a consequence, extension modules built for 3.2 in that |
| 69 | mode will also work with 3.3, 3.4, and so on. Extension modules that |
| 70 | make use of details of memory structures can still be built, but will |
| 71 | need to be recompiled for every feature release. |
| 72 | |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 73 | .. seealso:: |
| 74 | |
Georg Brandl | 65b2eb9 | 2010-12-05 11:42:38 +0000 | [diff] [blame] | 75 | :pep:`384` - Defining a Stable ABI |
Raymond Hettinger | 2c1ecc3 | 2010-12-07 09:55:02 +0000 | [diff] [blame] | 76 | PEP written by Martin von Löwis. |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 77 | |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 78 | PEP 389: Argparse Command Line Parsing Module |
| 79 | ============================================= |
| 80 | |
| 81 | A new module for command line parsing, :mod:`argparse`, was introduced to |
| 82 | overcome the limitations of :mod:`optparse` which did not provide support for |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 83 | positional arguments (not just options), subcommands, required options and other |
Raymond Hettinger | 413abbc | 2010-12-05 07:06:47 +0000 | [diff] [blame] | 84 | common patterns of specifying and validating options. |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 85 | |
| 86 | This module has already has wide-spread success in the community as a |
| 87 | third-party module. Being more fully featured than its predecessor, |
| 88 | :mod:`argparse`, is now the preferred module for command-line processing. The |
| 89 | older module is still being kept available because of the substantial amount of |
| 90 | legacy code that depends on it. |
| 91 | |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 92 | Here's an annotated example parser showing features like limiting results to a |
| 93 | set of choices, specifying a *metavar* in the help screen, validating that one |
Raymond Hettinger | 68f1e8d | 2010-12-07 09:24:30 +0000 | [diff] [blame] | 94 | or more positional arguments is present, and making a required option:: |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 95 | |
| 96 | import argparse |
| 97 | parser = argparse.ArgumentParser( |
| 98 | description = 'Manage servers', # main description for help |
| 99 | epilog = 'Tested on Solaris and Linux') # displayed after help |
| 100 | parser.add_argument('action', # argument name |
| 101 | choices = ['deploy', 'start', 'stop'], # one of four allowed values |
| 102 | help = 'action on each target') # help msg |
| 103 | parser.add_argument('targets', |
| 104 | metavar = 'HOSTNAME', # var name used in help msg |
| 105 | nargs = '+', # require 1 or more targets |
| 106 | help = 'url for target machines') # help msg explanation |
| 107 | parser.add_argument('-u', '--user', # -u or --user option |
| 108 | required = True, # make this a required argument |
| 109 | help = 'login as user') |
| 110 | |
| 111 | Example of calling the parser on a command string:: |
| 112 | |
| 113 | >>> cmd = 'deploy sneezy.example.com sleepy.example.com -u skycaptain' |
| 114 | >>> result = parser.parse_args(cmd.split()) |
| 115 | |
| 116 | >>> # parsed variable are stored in the attributes |
| 117 | >>> result.action |
| 118 | 'deploy' |
| 119 | >>> result.targets |
| 120 | ['sneezy.example.com', 'sleepy.example.com'] |
| 121 | >>> result.user |
| 122 | 'skycaptain' |
| 123 | |
| 124 | Example of the parser's automatically generated help:: |
| 125 | |
| 126 | >>> parser.parse_args('-h'.split()) |
| 127 | |
Raymond Hettinger | 3fcf002 | 2010-12-08 01:13:53 +0000 | [diff] [blame^] | 128 | usage: manage_cloud.py [-h] -u USER |
| 129 | {deploy,start,stop} HOSTNAME [HOSTNAME ...] |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 130 | |
| 131 | Manage servers |
| 132 | |
| 133 | positional arguments: |
| 134 | {deploy,start,stop} action on each target |
| 135 | HOSTNAME url for target machines |
| 136 | |
| 137 | optional arguments: |
| 138 | -h, --help show this help message and exit |
| 139 | -u USER, --user USER login as user |
| 140 | |
| 141 | Tested on Solaris and Linux |
| 142 | |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 143 | |
| 144 | .. seealso:: |
| 145 | |
| 146 | :pep:`389` - New Command Line Parsing Module |
| 147 | PEP written by Steven Bethard. |
| 148 | |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 149 | :ref:`upgrading-optparse-code` for details on the differences from |
| 150 | :mod:`optparse`. |
| 151 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 152 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 153 | PEP 391: Dictionary Based Configuration for Logging |
| 154 | ==================================================== |
Raymond Hettinger | ef2335c | 2010-09-05 08:35:38 +0000 | [diff] [blame] | 155 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 156 | The :mod:`logging` module provided two kinds of configuration, one style with |
| 157 | function calls for each option or another style driven by an external file saved |
| 158 | in a :mod:`ConfigParser` format. Those options did not provide the flexibility |
Georg Brandl | 9e75cad | 2010-09-06 06:45:47 +0000 | [diff] [blame] | 159 | to create configurations from JSON or YAML files, nor did they support |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 160 | incremental configuration, which is needed for specifying logger options from a |
| 161 | command line. |
Raymond Hettinger | ef2335c | 2010-09-05 08:35:38 +0000 | [diff] [blame] | 162 | |
| 163 | To support a more flexible style, the module now offers |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 164 | :func:`logging.config.dictConfig` for specifying logging configuration with |
| 165 | plain Python dictionaries. The configuration options include formatters, |
| 166 | handlers, filters, and loggers. Here's a working example of a configuration |
| 167 | dictionary:: |
Raymond Hettinger | ef2335c | 2010-09-05 08:35:38 +0000 | [diff] [blame] | 168 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 169 | {"version": 1, |
| 170 | "formatters": {"brief": {"format": "%(levelname)-8s: %(name)-15s: %(message)s"}, |
| 171 | "full": {"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"}, |
| 172 | }, |
| 173 | "handlers": {"console": { |
| 174 | "class": "logging.StreamHandler", |
| 175 | "formatter": "brief", |
| 176 | "level": "INFO", |
| 177 | "stream": "ext://sys.stdout"}, |
| 178 | "console_priority": { |
| 179 | "class": "logging.StreamHandler", |
| 180 | "formatter": "full", |
| 181 | "level": "ERROR", |
| 182 | "stream": "ext://sys.stderr"}, |
| 183 | }, |
| 184 | "root": {"level": "DEBUG", "handlers": ["console", "console_priority"]}} |
Raymond Hettinger | ef2335c | 2010-09-05 08:35:38 +0000 | [diff] [blame] | 185 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 186 | |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 187 | If that dictionary is stored in a file called :file:`conf.json`, it can loaded |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 188 | and called with code like this:: |
| 189 | |
| 190 | >>> import logging.config |
| 191 | >>> logging.config.dictConfig(json.load(open('conf.json', 'rb'))) |
| 192 | >>> logging.info("Transaction completed normally") |
| 193 | >>> logging.critical("Abnormal termination") |
| 194 | |
Raymond Hettinger | ef2335c | 2010-09-05 08:35:38 +0000 | [diff] [blame] | 195 | .. seealso:: |
| 196 | |
| 197 | :pep:`391` - Dictionary Based Configuration for Logging |
| 198 | PEP written by Vinay Sajip. |
| 199 | |
Georg Brandl | 97b20da | 2010-11-16 15:15:29 +0000 | [diff] [blame] | 200 | PEP 3148: The ``concurrent.futures`` module |
| 201 | ============================================ |
| 202 | |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 203 | Code for creating and managing concurrency is being collected in a new toplevel |
| 204 | namespace, *concurrent*. Its first member is a *futures* package which provides |
| 205 | a uniform high level interface for managing threads and processes. |
| 206 | |
| 207 | The design for :mod:`concurrent.futures` was inspired by |
| 208 | *java.util.concurrent.package*. In that model, a running call and its result |
| 209 | are represented by a :class:`~concurrent.futures.Future` object which abstracts |
| 210 | features common to threads, processes, and remote procedure calls. That object |
| 211 | supports status checks (running or done), timeouts, cancellations, adding |
| 212 | callbacks, and access to results or exceptions.XS |
| 213 | |
| 214 | The primary offering of the new module is a pair of executor classes for |
| 215 | launching and managing calls. The goal of the executors is to make it easier to |
| 216 | use existing tools for making parallel calls. They save the effort needed to |
| 217 | setup a pool of resources, launch the calls, create a results queue, add |
| 218 | time-out handling, and limit the total number of threads, processes, or remote |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 219 | procedure calls. |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 220 | |
| 221 | Ideally, each application should share a single executor across multiple |
| 222 | components so that process and thread limits can be centrally managed. This |
| 223 | solves the design challenge that arises when each component has its own |
| 224 | competing strategy for resource management. |
| 225 | |
| 226 | For an example of :class:`~concurrent.futures.ThreadPoolExecutor`, |
| 227 | see :ref:`code for threaded parallel URL reads<threadpoolexecutor-example>`. |
| 228 | |
| 229 | For an example of :class:`~concurrent.futures.ProcessPoolExecutor`, |
| 230 | see :ref:`code for computing prime numbers in parallel<processpoolexecutor-example>`. |
| 231 | |
| 232 | .. seealso:: |
| 233 | |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 234 | :pep:`3148` - Futures -- Execute Computations Asynchronously |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 235 | PEP written by Brain Quinlan. |
Georg Brandl | 97b20da | 2010-11-16 15:15:29 +0000 | [diff] [blame] | 236 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 237 | |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 238 | PEP 3147: PYC Repository Directories |
| 239 | ===================================== |
| 240 | |
David Malcolm | 778645a | 2010-12-07 00:32:04 +0000 | [diff] [blame] | 241 | Python's scheme for caching bytecode in *.pyc* files did not work well in |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 242 | environments with multiple python interpreters. If one interpreter encountered |
| 243 | a cached file created by another interpreter, it would recompile the source and |
| 244 | overwrite the cached file, thus losing the benefits of caching. |
| 245 | |
| 246 | The issue of "pyc fights" has become more pronounced as it has become |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 247 | commonplace for Linux distributions to ship with multiple versions of Python. |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 248 | These conflicts also arise with CPython alternatives such as Unladen Swallow. |
| 249 | |
| 250 | To solve this problem, Python's import machinery has been extended to use |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 251 | distinct filenames for each interpreter. Instead of Python 3.2 and Python 3.3 and |
| 252 | Unladen Swallow each competing for a file called "mymodule.pyc", they will now |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 253 | look for "mymodule.cpython-32.pyc", "mymodule.cpython-33.pyc", and |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 254 | "mymodule.unladen10.pyc". And to prevent all of these new files from |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 255 | cluttering source directories, the *pyc* files are now collected in a |
| 256 | "__pycache__" directory stored under the package directory. |
| 257 | |
| 258 | Aside from the filenames and target directories, the new scheme has a few |
| 259 | aspects that are visible to the programmer: |
| 260 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 261 | * Imported modules now have a :attr:`__cached__` attribute which stores the name |
| 262 | of the actual file that was imported: |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 263 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 264 | >>> import collections |
| 265 | >>> collections.__cached__ |
| 266 | 'c:/py32/lib/__pycache__/collections.cpython-32.pyc' |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 267 | |
| 268 | * The tag that is unique to each interpreter is accessible from the :mod:`imp` |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 269 | module: |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 270 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 271 | >>> import imp |
| 272 | >>> imp.get_tag() |
| 273 | 'cpython-32' |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 274 | |
| 275 | * Scripts that try to deduce source filename from the imported file now need to |
| 276 | be smarter. It is no longer sufficient to simply strip the "c" from a ".pyc" |
| 277 | filename. Instead, use the new functions in the :mod:`imp` module: |
| 278 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 279 | >>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc') |
| 280 | 'c:/py32/lib/collections.py' |
| 281 | >>> imp.cache_from_source('c:/py32/lib/collections.py') |
| 282 | 'c:/py32/lib/__pycache__/collections.cpython-32.pyc' |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 283 | |
| 284 | * The :mod:`py_compile` and :mod:`compileall` modules have been updated to |
| 285 | reflect the new naming convention and target directory. |
| 286 | |
| 287 | .. seealso:: |
| 288 | |
| 289 | :pep:`3147` - PYC Repository Directories |
| 290 | PEP written by Barry Warsaw. |
| 291 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 292 | |
Georg Brandl | 3ad4675 | 2010-12-05 07:59:29 +0000 | [diff] [blame] | 293 | PEP 3149: ABI Version Tagged .so Files |
| 294 | ====================================== |
Georg Brandl | f11c6c4 | 2010-09-03 22:20:58 +0000 | [diff] [blame] | 295 | |
Raymond Hettinger | ebea6fa | 2010-09-05 00:27:25 +0000 | [diff] [blame] | 296 | The PYC repository directory allows multiple bytecode cache files to be |
| 297 | co-located. This PEP implements a similar mechanism for shared object files by |
| 298 | giving them a common directory and distinct names for each version. |
Georg Brandl | f11c6c4 | 2010-09-03 22:20:58 +0000 | [diff] [blame] | 299 | |
Raymond Hettinger | ebea6fa | 2010-09-05 00:27:25 +0000 | [diff] [blame] | 300 | The common directory is "pyshared" and the file names are made distinct by |
| 301 | identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the |
| 302 | major and minor version numbers, and optional build flags (such as "d" for |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 303 | debug, "m" for pymalloc, "u" for wide-unicode). For an arbitrary package "foo", |
Raymond Hettinger | ebea6fa | 2010-09-05 00:27:25 +0000 | [diff] [blame] | 304 | you may see these files when the distribution package is installed:: |
| 305 | |
| 306 | /usr/share/pyshared/foo.cpython-32m.so |
| 307 | /usr/share/pyshared/foo.cpython-33md.so |
| 308 | |
| 309 | In Python itself, the tags are accessible from functions in the :mod:`sysconfig` |
| 310 | module:: |
| 311 | |
| 312 | >>> import sysconfig |
| 313 | >>> sysconfig.get_config_var('SOABI') # find the version tag |
| 314 | 'cpython-32mu' |
| 315 | >>> sysconfig.get_config_var('SO') # find the full filename extension |
| 316 | 'cpython-32mu.so' |
| 317 | |
| 318 | .. seealso:: |
| 319 | |
| 320 | :pep:`3149` - ABI Version Tagged .so Files |
| 321 | PEP written by Barry Warsaw. |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 322 | |
| 323 | |
Raymond Hettinger | 3fcf002 | 2010-12-08 01:13:53 +0000 | [diff] [blame^] | 324 | Email |
| 325 | ===== |
R. David Murray | 7c0a227 | 2010-10-08 21:37:39 +0000 | [diff] [blame] | 326 | |
Raymond Hettinger | 3fcf002 | 2010-12-08 01:13:53 +0000 | [diff] [blame^] | 327 | The email package has been extended to parse and generate email messages |
R. David Murray | 7c0a227 | 2010-10-08 21:37:39 +0000 | [diff] [blame] | 328 | in bytes format. |
| 329 | |
| 330 | * New functions :func:`~email.message_from_bytes` and |
| 331 | :func:`~email.message_from_binary_file`, and new classes |
| 332 | :class:`~email.parser.BytesFeedParser` and :class:`~email.parser.BytesParser` |
| 333 | allow binary message data to be parsed into model objects. |
| 334 | |
| 335 | * Given bytes input to the model, :meth:`~email.message.Message.get_payload` |
| 336 | will by default decode a message body that has a |
Senthil Kumaran | 8227045 | 2010-10-15 13:29:33 +0000 | [diff] [blame] | 337 | :mailheader:`Content-Transfer-Encoding` of ``8bit`` using the charset |
| 338 | specified in the MIME headers and return the resulting string. |
R. David Murray | 7c0a227 | 2010-10-08 21:37:39 +0000 | [diff] [blame] | 339 | |
| 340 | * Given bytes input to the model, :class:`~email.generator.Generator` will |
| 341 | convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of |
| 342 | 8bit to instead have a 7bit Content-Transfer-Encoding. |
| 343 | |
| 344 | * New class :class:`~email.generator.BytesGenerator` produces bytes |
| 345 | as output, preserving any unchanged non-ASCII data that was |
| 346 | present in the input used to build the model, including message bodies |
| 347 | with a :mailheader:`Content-Transfer-Encoding` of 8bit. |
| 348 | |
| 349 | (Proposed and implemented by R. David Murray, :issue:`4661`.) |
| 350 | |
| 351 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 352 | Other Language Changes |
| 353 | ====================== |
| 354 | |
| 355 | Some smaller changes made to the core Python language are: |
| 356 | |
Raymond Hettinger | 68f1e8d | 2010-12-07 09:24:30 +0000 | [diff] [blame] | 357 | * :class:`bytes` and :class:`str` now have two net methods, *transform* and *untransform*. |
Raymond Hettinger | 43b5a85 | 2010-12-05 04:04:21 +0000 | [diff] [blame] | 358 | These provided analogues to *encode* and *decode* but are used for general purpose |
| 359 | string-to-string and bytes-to-bytes transformations rather than Unicode codecs. |
| 360 | |
| 361 | Along with the new methods, several non-unicode codecs been restored from Python 2.x |
| 362 | including *base64*, *bz2*, *hex*, *quopri*, *rot13*, *uu*, and *zlib*. |
| 363 | |
| 364 | >>> t = b'which witch had which witches wrist watch' |
| 365 | >>> t.transform('quopri') |
| 366 | b'which=20witch=20had=20which=20witches=20wrist=20watch' |
| 367 | |
| 368 | >>> short = t.transform('zlib_codec') |
| 369 | >>> len(t), len(short) |
| 370 | (41, 38) |
| 371 | >>> short.untransform('zlib_codec') |
| 372 | b'which witch had which witches wrist watch' |
| 373 | |
Raymond Hettinger | e5e728b | 2010-12-05 06:35:16 +0000 | [diff] [blame] | 374 | (From multiple contributors in :issue:`7475`.) |
| 375 | |
Raymond Hettinger | e5e1a98 | 2010-12-05 08:35:21 +0000 | [diff] [blame] | 376 | * String formatting for :func:`format` and :meth:`str.format` gained new |
| 377 | capabilities for the format character **#**. Previously, for integers in |
| 378 | binary, octal, or hexadecimal, it caused the output to be prefixed with '0b', |
| 379 | '0o', or '0x' respectively. Now it can also handle floats, complex, and |
| 380 | Decimal, causing the output to always have a decimal point even when no digits |
| 381 | follow it. |
Raymond Hettinger | e5e728b | 2010-12-05 06:35:16 +0000 | [diff] [blame] | 382 | |
| 383 | >>> format(20, '#o') |
| 384 | '0o24' |
| 385 | >>> format(12.34, '#5.0f') |
| 386 | ' 12.' |
| 387 | |
| 388 | (Suggested by Mark Dickinson and implemented by Eric Smith in :issue:`7094`.) |
Raymond Hettinger | 43b5a85 | 2010-12-05 04:04:21 +0000 | [diff] [blame] | 389 | |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 390 | * The interpreter can now be started with a quiet option, ``-q``, to suppress |
| 391 | the copyright and version information in an interactive mode. |
| 392 | |
| 393 | (Contributed by Marcin Wojdyr in issue:`1772833`). |
| 394 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 395 | * The :func:`hasattr` function used to catch and suppress any Exception. Now, |
| 396 | it only catches :exc:`AttributeError`. Under the hood, :func:`hasattr` works |
| 397 | by calling :func:`getattr` and throwing away the results. This is necessary |
| 398 | because dynamic attribute creation is possible using :meth:`__getattribute__` |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 399 | or :meth:`__getattr__`. If :func:`hasattr` were to just scan instance and class |
Éric Araujo | cc6aac6 | 2010-09-07 21:35:35 +0000 | [diff] [blame] | 400 | dictionaries it would miss the dynamic methods and make it difficult to |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 401 | implement proxy objects. |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 402 | |
| 403 | (Discovered by Yury Selivanov and fixed by Benjamin Peterson; :issue:`9666`.) |
| 404 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 405 | * The :func:`str` of a float or complex number is now the same as its |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 406 | :func:`repr`. Previously, the :func:`str` form was shorter but that just |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 407 | caused confusion and is no longer needed now that the shortest possible |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 408 | :func:`repr` is displayed by default: |
Raymond Hettinger | bb734c6 | 2010-09-05 05:56:44 +0000 | [diff] [blame] | 409 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 410 | >>> repr(math.pi) |
| 411 | '3.141592653589793' |
| 412 | >>> str(math.pi) |
| 413 | '3.141592653589793' |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 414 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 415 | (Proposed and implemented by Mark Dickinson; :issue:`9337`.) |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 416 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 417 | * :class:`memoryview` objects now have a :meth:`release()` method and support |
| 418 | the context manager protocol. This allows timely release of any resources |
| 419 | that were acquired when requesting a buffer from the original object. |
| 420 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 421 | >>> with memoryview(b'abcdefgh') as v: |
| 422 | ... print(v.tolist()) |
| 423 | ... |
| 424 | [97, 98, 99, 100, 101, 102, 103, 104] |
| 425 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 426 | (Added by Antoine Pitrou; :issue:`9757`.) |
| 427 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 428 | * Mark Dickinson crafted an elegant and efficient scheme for assuring that |
| 429 | different numeric datatypes will have the same hash value whenever their |
| 430 | actual values are equal:: |
| 431 | |
| 432 | >>> assert hash(Fraction(3, 2)) == hash(1.5) == \ |
| 433 | hash(Decimal("1.5")) == hash(complex(1.5, 0)) |
| 434 | |
| 435 | (See :issue:`8188`.) |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 436 | |
Amaury Forgeot d'Arc | ba117ef | 2010-09-10 21:39:53 +0000 | [diff] [blame] | 437 | * Previously it was illegal to delete a name from the local namespace if it |
| 438 | occurs as a free variable in a nested block:: |
| 439 | |
| 440 | >>> def outer(x): |
| 441 | ... def inner(): |
| 442 | ... return x |
| 443 | ... inner() |
| 444 | ... del x |
| 445 | |
| 446 | This is now allowed. Remember that the target of an :keyword:`except` clause |
| 447 | is cleared, so this code which used to work with Python 2.6, raised a |
| 448 | :exc:`SyntaxError` with Python 3.1 and now works again:: |
| 449 | |
| 450 | >>> def f(): |
| 451 | ... def print_error(): |
| 452 | ... print(e) |
| 453 | ... try: |
| 454 | ... something |
| 455 | ... except Exception as e: |
| 456 | ... print_error() |
| 457 | ... # implicit "del e" here |
| 458 | |
| 459 | (See :issue:`4617`.) |
| 460 | |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 461 | * A new warning category, :exc:`ResourceWarning`, has been added. It is |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 462 | emitted when potential issues with resource consumption or cleanup |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 463 | are detected. It is silenced by default in normal release builds, but |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 464 | can be enabled through the means provided by the :mod:`warnings` |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 465 | module, or on the command line. |
| 466 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 467 | A :exc:`ResourceWarning` is issued at interpreter shutdown if the |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 468 | :data:`gc.garbage` list isn't empty. This is meant to make the programmer |
| 469 | aware that their code contains object finalization issues. |
| 470 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 471 | A :exc:`ResourceWarning` is also issued when a :term:`file object` is destroyed |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 472 | without having been explicitly closed. While the deallocator for such |
| 473 | object ensures it closes the underlying operating system resource |
| 474 | (usually, a file descriptor), the delay in deallocating the object could |
| 475 | produce various issues, especially under Windows. Here is an example |
| 476 | of enabling the warning from the command line:: |
| 477 | |
Raymond Hettinger | 673ccf2 | 2010-12-07 09:37:11 +0000 | [diff] [blame] | 478 | $ ./python -q -Wdefault |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 479 | >>> f = open("foo", "wb") |
| 480 | >>> del f |
| 481 | __main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'> |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 482 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 483 | (Added by Antoine Pitrou and Georg Brandl in :issue:`10093` and :issue:`477863`.) |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 484 | |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 485 | * :class:`range` objects now support *index* and *count* methods. This is part |
| 486 | of an effort to make more objects fully implement the |
| 487 | :class:`collections.Sequence` :term:`abstract base class`. As a result, the |
| 488 | language will have a more uniform API. In addition, :class:`range` objects |
| 489 | now support slicing and negative indices. This makes *range* more |
| 490 | interoperable with lists. |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 491 | |
| 492 | (Contributed by Daniel Stuzback in :issue:`9213` and by Alexander Belopolsky |
| 493 | in :issue:`2690`.) |
Nick Coghlan | 37ee850 | 2010-12-03 14:26:13 +0000 | [diff] [blame] | 494 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 495 | * The :func:`callable` builtin function from Py2.x was resurrected. It provides |
Raymond Hettinger | b87ba26 | 2010-12-06 04:31:40 +0000 | [diff] [blame] | 496 | a concise, readable alternative to using an :term:`abstract base class` in an |
| 497 | expression like ``isinstance(x, collections.Callable)``. |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 498 | |
| 499 | (See :issue:`10518`.) |
Amaury Forgeot d'Arc | ba117ef | 2010-09-10 21:39:53 +0000 | [diff] [blame] | 500 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 501 | New, Improved, and Deprecated Modules |
| 502 | ===================================== |
| 503 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 504 | * The :mod:`functools` module includes a new decorator for caching function |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 505 | calls. :func:`functools.lru_cache` can save repeated queries to an external |
| 506 | resource whenever the results are expected to be the same. |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 507 | |
Raymond Hettinger | 86f9613 | 2010-08-06 23:23:49 +0000 | [diff] [blame] | 508 | For example, adding a caching decorator to a database query function can save |
| 509 | database accesses for popular searches:: |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 510 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 511 | @functools.lru_cache(maxsize=300) |
| 512 | def get_phone_number(name): |
| 513 | c = conn.cursor() |
| 514 | c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,)) |
| 515 | return c.fetchone()[0] |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 516 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 517 | >>> for name in user_requests: |
Raymond Hettinger | 7496b41 | 2010-11-30 19:15:45 +0000 | [diff] [blame] | 518 | ... get_phone_number(name) # cached lookup |
| 519 | |
| 520 | To help with choosing an effective cache size, the wrapped function is |
| 521 | instrumented for tracking cache statistics: |
| 522 | |
Raymond Hettinger | 5e20bab | 2010-11-30 07:13:04 +0000 | [diff] [blame] | 523 | >>> get_phone_number.cache_info() |
Raymond Hettinger | 7496b41 | 2010-11-30 19:15:45 +0000 | [diff] [blame] | 524 | CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300) |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 525 | |
Raymond Hettinger | f309828 | 2010-08-15 03:30:45 +0000 | [diff] [blame] | 526 | If the phonelist table gets updated, the outdated contents of the cache can be |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 527 | cleared with: |
Raymond Hettinger | f309828 | 2010-08-15 03:30:45 +0000 | [diff] [blame] | 528 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 529 | >>> get_phone_number.cache_clear() |
Raymond Hettinger | f309828 | 2010-08-15 03:30:45 +0000 | [diff] [blame] | 530 | |
Raymond Hettinger | 6e35394 | 2010-12-04 23:42:12 +0000 | [diff] [blame] | 531 | (Contributed by Raymond Hettinger and incorporating design ideas from |
Raymond Hettinger | b87ba26 | 2010-12-06 04:31:40 +0000 | [diff] [blame] | 532 | Jim Baker, Miki Tebeka, and Nick Coghlan.) |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 533 | |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 534 | * The :func:`functools.wraps` decorator now adds a :attr:`__wrapped__` attribute |
| 535 | pointing to the original callable function. This allows wrapped functions to |
| 536 | be introspected. It also copies :attr:`__annotations__` if defined. And now |
| 537 | it also gracefully skips over missing attributes such as :attr:`__doc__` which |
| 538 | might not be defined for the wrapped callable. |
| 539 | |
| 540 | (By Nick Coghlan and Terrence Cole; :issue:`9567`, :issue:`3445`, and |
| 541 | :issue:`8814`.) |
| 542 | |
Raymond Hettinger | 673ccf2 | 2010-12-07 09:37:11 +0000 | [diff] [blame] | 543 | * The :mod:`itertools` module has a new :func:`~itertools.accumulate` function |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 544 | modeled on APL's *scan* operator and on Numpy's *accumulate* function: |
Raymond Hettinger | 6e35394 | 2010-12-04 23:42:12 +0000 | [diff] [blame] | 545 | |
| 546 | >>> list(accumulate(8, 2, 50)) |
| 547 | [8, 10, 60] |
| 548 | |
| 549 | >>> prob_dist = [0.1, 0.4, 0.2, 0.3] |
| 550 | >>> list(accumulate(prob_dist)) # cumulative probability distribution |
| 551 | [0.1, 0.5, 0.7, 1.0] |
| 552 | |
| 553 | For an example using :func:`~itertools.accumulate`, see the :ref:`examples for |
| 554 | the random module <random-examples>`. |
| 555 | |
| 556 | (Contributed by Raymond Hettinger and incorporating design suggestions |
| 557 | from Mark Dickinson.) |
| 558 | |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 559 | * The :mod:`nntplib` module gets a revamped implementation with better bytes and |
| 560 | unicode semantics as well as more practical APIs. These improvements break |
| 561 | compatibility with the nntplib version in Python 3.1, which was partly |
| 562 | dysfunctional in itself. |
Antoine Pitrou | cd889af | 2010-10-06 21:13:56 +0000 | [diff] [blame] | 563 | |
| 564 | (Contributed by Antoine Pitrou in :issue:`9360`) |
| 565 | |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 566 | * The :mod:`abc` module now supports :func:`~abc.abstractclassmethod` and |
| 567 | :func:`~abc.abstractstaticmethod`. |
| 568 | |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 569 | These tools make it possible to define an :term:`Abstract Base Class` that |
| 570 | requires a particular :func:`classmethod` or :func:`staticmethod` to be |
| 571 | implemented. |
| 572 | |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 573 | (Patch submitted by Daniel Urban; :issue:`5867`.) |
| 574 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 575 | * The previously deprecated :func:`contextlib.nested` function has been removed |
| 576 | in favor of a plain :keyword:`with` statement which can accept multiple |
| 577 | context managers. The latter technique is faster (because it is built-in), |
| 578 | and it does a better job finalizing multiple context managers when one of them |
Raymond Hettinger | 673ccf2 | 2010-12-07 09:37:11 +0000 | [diff] [blame] | 579 | raises an exception:: |
| 580 | |
| 581 | >>> with open('mylog.txt') as infile, open('a.out', 'w') as outfile: |
| 582 | ... for line in infile: |
| 583 | ... if '<critical>' in line: |
| 584 | ... outfile.write(line) |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 585 | |
| 586 | (Contributed by Georg Brandl and Mattias Brändström; |
| 587 | `appspot issue 53094 <http://codereview.appspot.com/53094>`_.) |
| 588 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 589 | * The :class:`ftplib.FTP` class now supports the context manager protocol to |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 590 | unconditionally consume :exc:`socket.error` exceptions and to close the FTP |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 591 | connection when done:: |
Raymond Hettinger | bcbd696 | 2010-09-05 08:46:36 +0000 | [diff] [blame] | 592 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 593 | >>> from ftplib import FTP |
| 594 | >>> with FTP("ftp1.at.proftpd.org") as ftp: |
| 595 | ... ftp.login() |
| 596 | ... ftp.dir() |
| 597 | ... |
| 598 | '230 Anonymous login ok, restrictions apply.' |
| 599 | dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 . |
| 600 | dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .. |
| 601 | dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS |
| 602 | dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora |
Raymond Hettinger | bcbd696 | 2010-09-05 08:46:36 +0000 | [diff] [blame] | 603 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 604 | Other file-like objects such as :class:`mmap.mmap` and :func:`fileinput.input` |
| 605 | also grew auto-closing context managers:: |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 606 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 607 | with fileinput.input(files=('log1.txt', 'log2.txt')) as f: |
| 608 | for line in f: |
| 609 | process(line) |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 610 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 611 | (Contributed by Tarek Ziadé and Giampaolo Rodolà in :issue:`4972`, and |
| 612 | by Georg Brandl in :issue:`8046` and :issue:`1286`.) |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 613 | |
Georg Brandl | 3ad4675 | 2010-12-05 07:59:29 +0000 | [diff] [blame] | 614 | .. mention os.popen and subprocess.Popen auto-closing of fds |
| 615 | |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 616 | * :class:`gzip.GzipFile` now implements the :class:`io.BufferedIOBase` |
| 617 | :term:`abstract base class` (except for ``truncate()``). It also has a |
| 618 | :meth:`~gzip.GzipFile.peek` method and supports unseekable as well as |
| 619 | zero-padded file objects. |
Antoine Pitrou | cd889af | 2010-10-06 21:13:56 +0000 | [diff] [blame] | 620 | |
| 621 | The :mod:`gzip` module also gains the :func:`~gzip.compress` and |
| 622 | :func:`~gzip.decompress` functions for easier in-memory compression and |
| 623 | decompression. |
| 624 | |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 625 | Keep in mind that text needs to be encoded in to bytes before compressing |
| 626 | and decompressing: |
| 627 | |
| 628 | >>> s = 'Three shall be the number thou shalt count, ' |
| 629 | >>> s += 'and the number of the counting shall be three' |
| 630 | >>> b = s.encode() # convert to utf-8 |
| 631 | >>> len(b) |
| 632 | 89 |
| 633 | >>> c = gzip.compress(b) |
| 634 | >>> len(c) |
| 635 | 77 |
| 636 | >>> gzip.decompress(c).decode()[:43] # decompress and convert to text |
| 637 | 'Three shall be the number thou shalt count, ' |
| 638 | |
| 639 | (Contributed by Anand B. Pillai in :issue:`3488`; and by Antoine Pitrou, Nir |
| 640 | Aides and Brian Curtin in :issue:`9962`, :issue:`1675951`, :issue:`7471` and |
| 641 | :issue:`2846`.) |
Antoine Pitrou | cd889af | 2010-10-06 21:13:56 +0000 | [diff] [blame] | 642 | |
Andrew M. Kuchling | 4ea04a3 | 2010-08-18 22:30:34 +0000 | [diff] [blame] | 643 | * The :mod:`os` module now has the :const:`ST_RDONLY` and :const:`ST_NOSUID` |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 644 | constants for use with the :func:`~os.statvfs` function. |
Raymond Hettinger | bcbd696 | 2010-09-05 08:46:36 +0000 | [diff] [blame] | 645 | |
Andrew M. Kuchling | 4ea04a3 | 2010-08-18 22:30:34 +0000 | [diff] [blame] | 646 | (Patch by Adam Jackson; :issue:`7647`.) |
| 647 | |
Amaury Forgeot d'Arc | 4b6fdf3 | 2010-09-07 21:31:17 +0000 | [diff] [blame] | 648 | * :func:`os.getppid` is now supported on Windows. Note that it will continue to |
| 649 | return the same pid even after the parent process has exited. |
| 650 | |
| 651 | (Patch by Jon Anglin; :issue:`6394`.) |
| 652 | |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 653 | * The :func:`shutil.copytree` function has two new options: |
| 654 | |
Raymond Hettinger | db9044e | 2010-09-06 01:29:23 +0000 | [diff] [blame] | 655 | * *ignore_dangling_symlinks*: when ``symlinks=False`` so that the function |
| 656 | copies the file pointed to by the symlink, not the symlink itself. This |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 657 | option will silence the error raised if the file doesn't exist. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 658 | |
Raymond Hettinger | db9044e | 2010-09-06 01:29:23 +0000 | [diff] [blame] | 659 | * *copy_function*: is a callable that will be used to copy files. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 660 | :func:`shutil.copy2` is used by default. |
| 661 | |
| 662 | (Contributed by Tarek Ziadé.) |
| 663 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 664 | * Socket objects now have a :meth:`~socket.socket.detach()` method which puts |
| 665 | the socket into closed state without actually closing the underlying file |
| 666 | descriptor. The latter can then be reused for other purposes. |
Antoine Pitrou | e43f9d0 | 2010-08-08 23:24:50 +0000 | [diff] [blame] | 667 | |
| 668 | (Added by Antoine Pitrou; :issue:`8524`.) |
| 669 | |
Raymond Hettinger | d881f31 | 2010-09-05 08:54:32 +0000 | [diff] [blame] | 670 | * The :mod:`sqlite3` module has two new capabilities. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 671 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 672 | The :attr:`Connection.in_transit` attribute is true if there is an active |
| 673 | transaction for uncommitted changes. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 674 | |
Raymond Hettinger | d881f31 | 2010-09-05 08:54:32 +0000 | [diff] [blame] | 675 | The :meth:`Connection.enable_load_extension` and |
| 676 | :meth:`Connection.load_extension` methods allows you to load SQLite extensions |
| 677 | from ".so" files. One well-known extension is the fulltext-search extension |
| 678 | distributed with SQLite. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 679 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 680 | (Contributed by R. David Murray and Shashwat Anand; :issue:`8845`.) |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 681 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 682 | * The :mod:`ssl` module has a new class, :class:`~ssl.SSLContext` which serves |
| 683 | as a container for various persistent SSL data, such as protocol settings, |
| 684 | certificates, private keys, and various other options. The |
| 685 | :meth:`~ssl.SSLContext.wrap_socket` method allows to create an SSL socket from |
| 686 | such an SSL context. (Added by Antoine Pitrou; :issue:`8550`.) |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 687 | |
Antoine Pitrou | 0ee4c9f | 2010-10-08 16:46:17 +0000 | [diff] [blame] | 688 | A new function, :func:`ssl.match_hostname`, helps implement server identity |
| 689 | verification for higher-level protocols by implementing the rules of |
| 690 | HTTPS (from :rfc:`2818`), which are also suitable for other protocols. |
| 691 | (Added by Antoine Pitrou, :issue:`1589`). |
| 692 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 693 | The :func:`ssl.wrap_socket` constructor function now takes a *ciphers* |
| 694 | argument that's a string listing the encryption algorithms to be allowed; the |
| 695 | format of the string is described `in the OpenSSL documentation |
| 696 | <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT>`__. (Added |
| 697 | by Antoine Pitrou; :issue:`8322`.) |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 698 | |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 699 | When linked against a recent enough version of OpenSSL, the :mod:`ssl` |
| 700 | module now supports the Server Name Indication extension to the TLS |
| 701 | protocol, allowing for several "virtual hosts" using different certificates |
| 702 | on a single IP/port. This extension is only supported in client mode, |
| 703 | and is activated by passing the *server_hostname* argument to |
| 704 | :meth:`SSLContext.wrap_socket`. |
| 705 | (Added by Antoine Pitrou, :issue:`5639`.) |
| 706 | |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 707 | Various options have been added to the :mod:`ssl` module, such as |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 708 | :data:`~ssl.OP_NO_SSLv2` which allows to force disabling of the insecure and |
| 709 | obsolete SSLv2 protocol. (Added by Antoine Pitrou; :issue:`4870`.) |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 710 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 711 | Another change makes the extension load all of OpenSSL's ciphers and digest |
| 712 | algorithms so that they're all available. Some SSL certificates couldn't be |
| 713 | verified, reporting an "unknown algorithm" error. (Reported by Beda Kosata, |
| 714 | and fixed by Antoine Pitrou; :issue:`8484`.) |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 715 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 716 | The version of OpenSSL being used is now available as the module attributes |
| 717 | :data:`ssl.OPENSSL_VERSION` (a string), :data:`ssl.OPENSSL_VERSION_INFO` (a |
| 718 | 5-tuple), and :data:`ssl.OPENSSL_VERSION_NUMBER` (an integer). (Added by |
| 719 | Antoine Pitrou; :issue:`8321`.) |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 720 | |
Antoine Pitrou | afb078d | 2010-11-05 22:18:28 +0000 | [diff] [blame] | 721 | * :class:`http.client.HTTPSConnection`, :class:`urllib.request.HTTPSHandler` |
| 722 | and :func:`urllib.request.urlopen` now take optional arguments to allow for |
| 723 | server certificate checking against a set of Certificate Authorities, |
| 724 | as recommended in public uses of HTTPS. |
| 725 | (Added by Antoine Pitrou, :issue:`9003`.) |
| 726 | |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 727 | * The command-line call, ``python -m unittest`` can now accept file paths |
| 728 | instead of module names for running specific tests (:issue:`10620`). The new |
| 729 | test discovery can find tests within packages, locating any test importable |
| 730 | from the top level directory. The top level directory can be specified with |
| 731 | the `-t` option, a pattern for matching files with ``-p``, and a directory to |
| 732 | start discovery with ``-s``:: |
| 733 | |
| 734 | $ python -m unittest discover -s my_proj_dir -p '_test.py' |
| 735 | |
| 736 | (Contributed by Michael Foord.) |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 737 | |
Raymond Hettinger | dc2f9b5 | 2010-12-05 07:02:45 +0000 | [diff] [blame] | 738 | * The :mod:`unittest` module has two new methods, |
| 739 | :meth:`~unittest.TestCase.assertWarns` and |
| 740 | :meth:`~unittest.TestCase.assertWarnsRegex` to check that a given warning type |
Raymond Hettinger | 413abbc | 2010-12-05 07:06:47 +0000 | [diff] [blame] | 741 | is triggered by the code under test: |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 742 | |
Raymond Hettinger | dc2f9b5 | 2010-12-05 07:02:45 +0000 | [diff] [blame] | 743 | >>> with self.assertWarns(DeprecationWarning): |
| 744 | ... legacy_function('XYZ') |
Ezio Melotti | 2baf1a6 | 2010-11-22 12:56:58 +0000 | [diff] [blame] | 745 | |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 746 | Another new method, :meth:`~unittest.TestCase.assertCountEqual` is used to compare two iterables |
| 747 | to determine if their element counts are equal (are the same elements present |
| 748 | the same number of times:: |
| 749 | |
| 750 | def test_anagram(self): |
| 751 | self.assertCountEqual('algorithm', 'logarithm') |
| 752 | |
| 753 | A principal feature of the unittest module is an effort to produce meaningful |
| 754 | diagnostics when a test fails. When possible the failure is recorded along |
| 755 | with a diff of the output. This is especially helpful for analyzing log files |
| 756 | of failed test runs. However, since diffs can sometime be voluminous, there is |
| 757 | a new :attr:`~unittest.TestCase.maxDiff` attribute which sets maximum length of |
| 758 | diffs. |
| 759 | |
Raymond Hettinger | 68f1e8d | 2010-12-07 09:24:30 +0000 | [diff] [blame] | 760 | In addition the naming in the module has undergone a number of clean-ups. For |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 761 | example, :meth:`~unittest.TestCase.assertRegex` is the new name for |
| 762 | :meth:`~unittest.TestCase.assertRegexpMatches` which was misnamed because the |
| 763 | test uses :func:`re.search`, not :func:`re.match`. |
Raymond Hettinger | dc2f9b5 | 2010-12-05 07:02:45 +0000 | [diff] [blame] | 764 | |
| 765 | To improve consistency, some of long-standing method aliases are being |
| 766 | deprecated in favor of the preferred names: |
| 767 | |
| 768 | - replace :meth:`assert_` with :meth:`.assertTrue` |
| 769 | - replace :meth:`assertEquals` with :meth:`.assertEqual` |
| 770 | - replace :meth:`assertNotEquals` with :meth:`.assertNotEqual` |
| 771 | - replace :meth:`assertAlmostEquals` with :meth:`.assertAlmostEqual` |
| 772 | - replace :meth:`assertNotAlmostEquals` with :meth:`.assertNotAlmostEqual` |
| 773 | |
| 774 | Likewise, the ``TestCase.fail*`` methods deprecated in Python 3.1 are expected |
| 775 | to be removed in Python 3.3. See also the :ref:`deprecated-aliases` section in |
| 776 | the :mod:`unittest` documentation. |
Ezio Melotti | 2baf1a6 | 2010-11-22 12:56:58 +0000 | [diff] [blame] | 777 | |
| 778 | (Contributed by Ezio Melotti; :issue:`9424`.) |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 779 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 780 | * The previously deprecated :func:`string.maketrans` function has been removed |
| 781 | in favor of the static methods, :meth:`bytes.maketrans` and |
Raymond Hettinger | f558ddd | 2009-06-28 21:37:08 +0000 | [diff] [blame] | 782 | :meth:`bytearray.maketrans`. This change solves the confusion around which |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 783 | types were supported by the :mod:`string` module. Now, :class:`str`, |
Raymond Hettinger | f558ddd | 2009-06-28 21:37:08 +0000 | [diff] [blame] | 784 | :class:`bytes`, and :class:`bytearray` each have their own **maketrans** and |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 785 | **translate** methods with intermediate translation tables of the appropriate |
| 786 | type. |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 787 | |
Raymond Hettinger | f558ddd | 2009-06-28 21:37:08 +0000 | [diff] [blame] | 788 | (Contributed by Georg Brandl; :issue:`5675`.) |
| 789 | |
Giampaolo Rodolà | 42382fe | 2010-08-17 16:09:53 +0000 | [diff] [blame] | 790 | * :class:`~poplib.POP3_SSL` class now accepts a *context* parameter, which is a |
| 791 | :class:`ssl.SSLContext` object allowing bundling SSL configuration options, |
| 792 | certificates and private keys into a single (potentially long-lived) |
| 793 | structure. |
| 794 | |
| 795 | (Contributed by Giampaolo Rodolà; :issue:`8807`.) |
| 796 | |
Giampaolo Rodolà | b383dbb | 2010-09-08 22:44:12 +0000 | [diff] [blame] | 797 | * :func:`socket.create_connection` now supports the context manager protocol |
| 798 | to unconditionally consume :exc:`socket.error` exceptions and to close the |
| 799 | socket when done. |
| 800 | |
| 801 | (Contributed by Giampaolo Rodolà; :issue:`9794`.) |
| 802 | |
Giampaolo Rodolà | 977c707 | 2010-10-04 21:08:36 +0000 | [diff] [blame] | 803 | * :class:`asyncore.dispatcher` now provides a |
| 804 | :meth:`~asyncore.dispatcher.handle_accepted()` method |
| 805 | returning a `(sock, addr)` pair which is called when a connection has actually |
| 806 | been established with a new remote endpoint. This is supposed to be used as a |
| 807 | replacement for old :meth:`~asyncore.dispatcher.handle_accept()` and avoids |
| 808 | the user to call :meth:`~asyncore.dispatcher.accept()` directly. |
| 809 | |
| 810 | (Contributed by Giampaolo Rodolà; :issue:`6706`.) |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 811 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 812 | * The :mod:`tempfile` module has a new context manager, |
| 813 | :class:`~tempfile.TemporaryDirectory` which provides easy deterministic |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 814 | cleanup of temporary directories: |
| 815 | |
| 816 | >>> with tempfile.TemporaryDirectory() as tmpdirname: |
| 817 | ... print 'created temporary directory', tmpdirname |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 818 | |
| 819 | (Contributed by Neil Schemenauer and Nick Coghlan; :issue:`5178`.) |
| 820 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 821 | * The :mod:`smtplib` :class:`~smtplib.SMTP` class now accepts a byte string |
| 822 | for the *msg* argument to the :meth:`~smtplib.SMTP.sendmail` method, |
| 823 | and a new method, :meth:`~smtplib.SMTP.send_message` accepts a |
| 824 | :class:`~email.message.Message` object and can optionally obtain the |
| 825 | *from_addr* and *to_addrs* addresses directly from the object. |
| 826 | |
| 827 | (Contributed by R. David Murray, :issue:`10321`.) |
| 828 | |
Nick Coghlan | e0f0465 | 2010-11-21 03:44:04 +0000 | [diff] [blame] | 829 | * The :mod:`inspect` module has a new function :func:`getgenatorstate` |
| 830 | to easily identify the current state of a generator as one of |
| 831 | ``GEN_CREATED``, ``GEN_RUNNING``, ``GEN_SUSPENDED`` or ``GEN_CLOSED``. |
| 832 | |
| 833 | (Contributed by Rodolpho Eckhardt and Nick Coghlan, :issue:`10220`.) |
| 834 | |
Raymond Hettinger | 3fcf002 | 2010-12-08 01:13:53 +0000 | [diff] [blame^] | 835 | .. XXX: notes on new random.seed() version 2 |
Raymond Hettinger | e5e1a98 | 2010-12-05 08:35:21 +0000 | [diff] [blame] | 836 | .. XXX: Create a new section for all changes relating to context managers. |
| 837 | .. XXX: Various ConfigParser changes |
Nick Coghlan | e0f0465 | 2010-11-21 03:44:04 +0000 | [diff] [blame] | 838 | .. XXX: Mention inspect.getattr_static (Michael Foord) |
Nick Coghlan | 9fc443c | 2010-11-30 15:48:08 +0000 | [diff] [blame] | 839 | .. XXX: Mention urllib.parse changes |
| 840 | Issue 9873 (Nick Coghlan): |
| 841 | - ASCII byte sequence support in URL parsing |
| 842 | - named tuple for urldefrag return value |
| 843 | Issue 5468 (Dan Mahn) for urlencode: |
| 844 | - bytes input support |
| 845 | - non-UTF8 percent encoding of non-ASCII characters |
| 846 | Issue 2987 for IPv6 (RFC2732) support in urlparse |
Nick Coghlan | e0f0465 | 2010-11-21 03:44:04 +0000 | [diff] [blame] | 847 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 848 | * The :mod:`pydoc` module now provides a much improved Web server interface, |
| 849 | as well as a new command-line option to automatically open a browser |
| 850 | window to display that server. |
| 851 | |
| 852 | (Contributed by Ron Adam; :issue:`2001`.) |
| 853 | |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 854 | * The new :mod:`sysconfig` module makes it straight-forward to discover |
| 855 | installation paths and configuration variables which vary across platforms and |
| 856 | installs. |
| 857 | |
| 858 | The module offers access simple access functions for platform and version |
| 859 | information: |
| 860 | |
| 861 | * :func:`~sysconfig.get_platform` returning values like *linux-i586* or |
| 862 | *macosx-10.6-ppc*. |
| 863 | * :func:`~sysconfig.get_python_version` returns a Python version string in |
| 864 | the form, "3.2". |
| 865 | |
| 866 | It also provides access to the paths and variables corresponding to one of |
| 867 | seven named schemes used by :mod:`distutils`. Those include *posix_prefix*, |
| 868 | *posix_home*, *posix_user*, *nt*, *nt_user*, *os2*, *os2_home*: |
| 869 | |
| 870 | * :func:`~sysconfig.get_paths` makes a dictionary containing installation paths |
| 871 | for the current installation scheme. |
| 872 | * :func:`~sysconfig.get_config_vars` returns a dictionary of platform specific |
| 873 | variables. |
| 874 | |
| 875 | There is also a convenient command-line interface:: |
| 876 | |
| 877 | C:\Python32>python -m sysconfig |
| 878 | Platform: "win32" |
| 879 | Python version: "3.2" |
| 880 | Current installation scheme: "nt" |
| 881 | |
| 882 | Paths: |
| 883 | data = "C:\Python32" |
| 884 | include = "C:\Python32\Include" |
| 885 | platinclude = "C:\Python32\Include" |
| 886 | platlib = "C:\Python32\Lib\site-packages" |
| 887 | platstdlib = "C:\Python32\Lib" |
| 888 | purelib = "C:\Python32\Lib\site-packages" |
| 889 | scripts = "C:\Python32\Scripts" |
| 890 | stdlib = "C:\Python32\Lib" |
| 891 | |
| 892 | Variables: |
| 893 | BINDIR = "C:\Python32" |
| 894 | BINLIBDEST = "C:\Python32\Lib" |
| 895 | EXE = ".exe" |
| 896 | INCLUDEPY = "C:\Python32\Include" |
| 897 | LIBDEST = "C:\Python32\Lib" |
| 898 | SO = ".pyd" |
| 899 | VERSION = "32" |
| 900 | abiflags = "" |
| 901 | base = "C:\Python32" |
| 902 | exec_prefix = "C:\Python32" |
| 903 | platbase = "C:\Python32" |
| 904 | prefix = "C:\Python32" |
| 905 | projectbase = "C:\Python32" |
Raymond Hettinger | 3fcf002 | 2010-12-08 01:13:53 +0000 | [diff] [blame^] | 906 | py_version = "3.2" |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 907 | py_version_nodot = "32" |
| 908 | py_version_short = "3.2" |
| 909 | srcdir = "C:\Python32" |
| 910 | userbase = "C:\Documents and Settings\Raymond\Application Data\Python" |
| 911 | |
Raymond Hettinger | b5d7933 | 2010-12-07 02:04:56 +0000 | [diff] [blame] | 912 | * The :mod:`pdb` debugger module gained a number of usability improvements: |
| 913 | |
| 914 | - :file:`pdb.py` now has a ``-c`` option that executes commands as given in a |
| 915 | :file:`.pdbrc` script file. |
| 916 | - A :file:`.pdbrc` script file can contain ``continue`` and ``next`` commands |
| 917 | that continue debugging. |
| 918 | - The :class:`Pdb` class constructor now accepts a *nosigint* argument. |
| 919 | - new commands: ``l(list)``, ``ll(long list`` and ``source`` for |
| 920 | listing source code. |
| 921 | - new commands: ``display`` and ``undisplay`` for showing or hiding |
| 922 | the value of an expression if it has changed. |
Raymond Hettinger | 68f1e8d | 2010-12-07 09:24:30 +0000 | [diff] [blame] | 923 | - new command: ``interact`` for starting an interactive interpreter containing |
Raymond Hettinger | b5d7933 | 2010-12-07 02:04:56 +0000 | [diff] [blame] | 924 | the global and local names found in the current scope. |
| 925 | - breakpoints can be cleared by breakpoint number |
| 926 | |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 927 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 928 | Multi-threading |
| 929 | =============== |
| 930 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 931 | * The mechanism for serializing execution of concurrently running Python threads |
| 932 | (generally known as the GIL or Global Interpreter Lock) has been rewritten. |
| 933 | Among the objectives were more predictable switching intervals and reduced |
| 934 | overhead due to lock contention and the number of ensuing system calls. The |
| 935 | notion of a "check interval" to allow thread switches has been abandoned and |
| 936 | replaced by an absolute duration expressed in seconds. This parameter is |
| 937 | tunable through :func:`sys.setswitchinterval()`. It currently defaults to 5 |
| 938 | milliseconds. |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 939 | |
| 940 | Additional details about the implementation can be read from a `python-dev |
| 941 | mailing-list message |
| 942 | <http://mail.python.org/pipermail/python-dev/2009-October/093321.html>`_ |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 943 | (however, "priority requests" as exposed in this message have not been kept |
| 944 | for inclusion). |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 945 | |
Georg Brandl | 5e73a81 | 2010-04-22 07:02:51 +0000 | [diff] [blame] | 946 | (Contributed by Antoine Pitrou.) |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 947 | |
Antoine Pitrou | 5bab508 | 2009-11-13 22:58:45 +0000 | [diff] [blame] | 948 | * Recursive locks (created with the :func:`threading.RLock` API) now benefit |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 949 | from a C implementation which makes them as fast as regular locks, and between |
| 950 | 10x and 15x faster than their previous pure Python implementation. |
Antoine Pitrou | 5bab508 | 2009-11-13 22:58:45 +0000 | [diff] [blame] | 951 | |
| 952 | (Contributed by Antoine Pitrou; :issue:`3001`.) |
| 953 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 954 | * Regular and recursive locks now accept an optional *timeout* argument to their |
Raymond Hettinger | 09e4ebb | 2010-09-06 19:55:51 +0000 | [diff] [blame] | 955 | :meth:`acquire` method. (Contributed by Antoine Pitrou; :issue:`7316`.) |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 956 | |
Antoine Pitrou | e95a9ff | 2010-05-04 23:31:41 +0000 | [diff] [blame] | 957 | Similarly, :meth:`threading.Semaphore.acquire` also gains a *timeout* |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 958 | argument. (Contributed by Torsten Landschoff; :issue:`850728`.) |
Antoine Pitrou | e95a9ff | 2010-05-04 23:31:41 +0000 | [diff] [blame] | 959 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 960 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 961 | Optimizations |
| 962 | ============= |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 963 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 964 | A number of small performance enhancements have been added: |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 965 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 966 | * Python's peephole optimizer now recognizes patterns such ``x in {1, 2, 3}`` as |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 967 | being a test for membership in a set of constants. The optimizer recasts the |
| 968 | :class:`set` as a :class:`frozenset` and stores the pre-built constant. |
| 969 | |
| 970 | Now that the speed penalty is gone, it is practical to start writing |
| 971 | membership tests using set-notation. This style is both semantically clear |
| 972 | and operationally fast:: |
| 973 | |
| 974 | extension = name.rpartition('.')[2] |
| 975 | if extension in {'xml', 'html', 'xhtml', 'css'}: |
| 976 | handle(name) |
| 977 | |
| 978 | (Patch and additional tests by Dave Malcolm; :issue:`6690`). |
| 979 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 980 | * Serializing and unserializing data using the :mod:`pickle` module is now |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 981 | several times faster. |
| 982 | |
| 983 | (Contributed by Alexandre Vassalotti, Antoine Pitrou |
Antoine Pitrou | ff150f2 | 2010-10-22 21:41:05 +0000 | [diff] [blame] | 984 | and the Unladen Swallow team in :issue:`9410` and :issue:`3873`.) |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 985 | |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 986 | * The `Timsort algorithm <http://en.wikipedia.org/wiki/Timsort>`_ used in |
| 987 | :meth:`list.sort` and :func:`sorted` now runs faster and used less memory |
| 988 | when called with a :term:`key function`. Previously, every element of |
| 989 | a list was wrapped with a temporary object that remembered the key value |
| 990 | associated with each element. Now, an array of keys and values are |
| 991 | sorted in parallel. This save the memory consumed by the sort wrappers, |
| 992 | and it saves time lost from during comparisons which where delegated |
| 993 | by the sort wrappers. |
| 994 | |
| 995 | (Patch by Daniel Stuzback in :issue:`9915`.) |
| 996 | |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 997 | * JSON decoding performance is improved and memory consumption is reduced |
Raymond Hettinger | 413abbc | 2010-12-05 07:06:47 +0000 | [diff] [blame] | 998 | whenever the same string is repeated for multiple keys. Also, JSON encoding |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 999 | now uses the C speedups when the ``sort_keys`` argument is true. |
| 1000 | |
| 1001 | (Contributed by Antoine Pitrou in :issue:`7451` and by Raymond Hettinger and |
| 1002 | Antoine Pitrou in :issue:`10314`.) |
| 1003 | |
| 1004 | * The fast-search algorithm in stringlib is now used by the :meth:`split`, |
| 1005 | :meth:`rsplit`, :meth:`splitlines` and :meth:`replace` methods on |
| 1006 | :class:`bytes`, :class:`bytearray` and :class:`str` objects. Likewise, the |
| 1007 | algorithm is also used by :meth:`rfind`, :meth:`rindex`, :meth:`rsplit` and |
| 1008 | :meth:`rpartition`. |
| 1009 | |
| 1010 | (Patch by Florent Xicluna in :issue:`7622` and :issue:`7462`.) |
| 1011 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 1012 | There were several other minor optimizations. Set differencing now runs faster |
| 1013 | when one operand is much larger than the other (Patch by Andress Bennetts in |
| 1014 | :issue:`8685`). The :meth:`array.repeat` method has a faster implementation |
| 1015 | (:issue:`1569291` by Alexander Belopolsky). The :class:`BaseHTTPRequestHandler` |
| 1016 | has more efficient buffering (:issue:`3709` by Andrew Schaaf). The |
| 1017 | multi-argument form of :func:`operator.attrgetter` now function runs slightly |
| 1018 | faster (:issue:`10160` by Christos Georgiou). And :class:`ConfigParser` loads |
| 1019 | multi-line arguments a bit faster (:issue:`7113` by Łukasz Langa). |
| 1020 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1021 | |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 1022 | Unicode |
| 1023 | ======= |
Victor Stinner | 94908bb | 2010-08-18 21:23:25 +0000 | [diff] [blame] | 1024 | |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 1025 | Python has been updated to Unicode 6.0.0. The new features of the |
| 1026 | Unicode Standard that will affect Python users include: |
| 1027 | |
| 1028 | * adds 2,088 characters, including over 1,000 additional symbols—chief |
Raymond Hettinger | c74d518 | 2010-12-02 01:38:25 +0000 | [diff] [blame] | 1029 | among them the additional emoji symbols, which are especially |
| 1030 | important for mobile phones; |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 1031 | |
| 1032 | * corrects character properties for existing characters including |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 1033 | |
Raymond Hettinger | c74d518 | 2010-12-02 01:38:25 +0000 | [diff] [blame] | 1034 | - a general category change to two Kannada characters (U+0CF1, |
| 1035 | U+0CF2), which has the effect of making them newly eligible for |
| 1036 | inclusion in identifiers; |
| 1037 | |
| 1038 | - a general category change to one New Tai Lue numeric character |
| 1039 | (U+19DA), which would have the effect of disqualifying it from |
| 1040 | inclusion in identifiers unless grandfathering measures are in place |
| 1041 | for the defining identifier syntax. |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 1042 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 1043 | The :mod:`os` module has two new functions: :func:`~os.fsencode` and |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 1044 | :func:`~os.fsdecode`. Add :data:`os.environb`: bytes version of |
| 1045 | :data:`os.environ`, :func:`os.getenvb` function and |
| 1046 | :data:`os.supports_bytes_environ` constant. |
Victor Stinner | e8d5145 | 2010-08-19 01:05:19 +0000 | [diff] [blame] | 1047 | |
Georg Brandl | 326c57d | 2010-11-26 12:10:06 +0000 | [diff] [blame] | 1048 | ``'mbcs'`` encoding doesn't ignore the error handler argument any more. By |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 1049 | default (strict mode), it raises an UnicodeDecodeError on undecodable byte |
| 1050 | sequence and UnicodeEncodeError on unencodable character. To get the ``'mbcs'`` |
| 1051 | encoding of Python 3.1, use ``'ignore'`` error handler to decode and |
| 1052 | ``'replace'`` error handler to encode. ``'mbcs'`` supports ``'strict'`` and |
| 1053 | ``'ignore'`` error handlers for decoding, and ``'strict'`` and ``'replace'`` |
| 1054 | for encoding. |
| 1055 | |
| 1056 | On Mac OS X, Python uses ``'utf-8'`` to decode the command line arguments, |
| 1057 | instead of the locale encoding (which is ISO-8859-1 if the ``LANG`` environment |
| 1058 | variable is not set). |
| 1059 | |
| 1060 | By default, tarfile uses ``'utf-8'`` encoding on Windows (instead of |
| 1061 | ``'mbcs'``), and the ``'surrogateescape'`` error handler on all operating |
| 1062 | systems. |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1063 | |
Victor Stinner | 94908bb | 2010-08-18 21:23:25 +0000 | [diff] [blame] | 1064 | |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 1065 | Documentation |
| 1066 | ============= |
| 1067 | |
| 1068 | The documentation continues to be improved. |
| 1069 | |
| 1070 | A table of quick links has been added to the top of lengthy sections such as |
| 1071 | :ref:`built-in-funcs`. In the case of :mod:`itertools`, the links are |
| 1072 | accompanied by tables of cheatsheet-style summaries to provide an overview and |
| 1073 | memory jog without having to read all of the docs. |
| 1074 | |
| 1075 | In some cases, the pure python source code can be helpful adjunct to the docs, |
| 1076 | so now some modules feature quick links to the latest version of the source |
| 1077 | code. For example, the :mod:`functools` module documentation has a quick link |
| 1078 | at the top labeled :source:`functools Python source code <Lib/functools.py>`. |
| 1079 | |
| 1080 | The docs now contain more examples and recipes. In particular, :mod:`re` module |
| 1081 | has an extensive section, :ref:`re-examples`. Likewise, the :mod:`itertools` |
| 1082 | module continues to be updated with new :ref:`itertools-recipes`. |
| 1083 | |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 1084 | The :mod:`datetime` module now has an auxiliary implementation in pure Python. |
| 1085 | No functionality was changed. This just provides an easier-to-read |
| 1086 | alternate implementation. (Contributed by Alexander Belopolsky.) |
| 1087 | |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 1088 | |
| 1089 | IDLE |
| 1090 | ==== |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1091 | |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 1092 | * The format menu now has an option to clean-up source files by strip trailing |
| 1093 | whitespace (:issue:`5150`). |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1094 | |
| 1095 | |
| 1096 | Build and C API Changes |
| 1097 | ======================= |
| 1098 | |
| 1099 | Changes to Python's build process and to the C API include: |
| 1100 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1101 | * The C functions that access the Unicode Database now accept and return |
| 1102 | characters from the full Unicode range, even on narrow unicode builds |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 1103 | (Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and others). A visible difference |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1104 | in Python is that :func:`unicodedata.numeric` now returns the correct value |
| 1105 | for large code points, and :func:`repr` may consider more characters as |
| 1106 | printable. |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1107 | |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 1108 | (Reported by Bupjoe Lee and fixed by Amaury Forgeot D'Arc; :issue:`5127`.) |
| 1109 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1110 | * Computed gotos are now enabled by default on supported compilers (which are |
Raymond Hettinger | db9044e | 2010-09-06 01:29:23 +0000 | [diff] [blame] | 1111 | detected by the configure script). They can still be disabled selectively by |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1112 | specifying ``--without-computed-gotos``. |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 1113 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1114 | (Contributed by Antoine Pitrou; :issue:`9203`.) |
| 1115 | |
Amaury Forgeot d'Arc | feb7307 | 2010-09-12 22:42:57 +0000 | [diff] [blame] | 1116 | * The option ``--with-wctype-functions`` was removed. The built-in unicode |
| 1117 | database is now used for all functions. |
| 1118 | |
| 1119 | (Contributed by Amaury Forgeot D'Arc; :issue:`9210`.) |
| 1120 | |
Skip Montanaro | 961aaf5 | 2010-10-17 22:22:24 +0000 | [diff] [blame] | 1121 | * Hash values are now values of a new type, Py_hash_t, which is defined to |
| 1122 | be the same size as a pointer. Previously they were of type long, which |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 1123 | on some 64-bit operating systems is still only 32 bits long. As a result |
| 1124 | of this fix, :class:`set` and :class:`dict` can now hold more than ``2**32`` |
| 1125 | entries on builds with 64-bit pointers (previously, they could grow to |
| 1126 | that size but their performance degraded catastrophically). |
Skip Montanaro | 961aaf5 | 2010-10-17 22:22:24 +0000 | [diff] [blame] | 1127 | |
| 1128 | (Contributed by Benjamin Peterson; :issue:`9778`.) |
| 1129 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1130 | |
Raymond Hettinger | f558ddd | 2009-06-28 21:37:08 +0000 | [diff] [blame] | 1131 | Porting to Python 3.2 |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1132 | ===================== |
| 1133 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1134 | This section lists previously described changes and other bugfixes that may |
| 1135 | require changes to your code: |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1136 | |
Antoine Pitrou | cd889af | 2010-10-06 21:13:56 +0000 | [diff] [blame] | 1137 | * The :mod:`nntplib` module was reworked extensively, meaning that its APIs |
| 1138 | are often incompatible with the 3.1 APIs. |
| 1139 | |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 1140 | * :class:`bytearray` objects can no longer be used as filenames; instead, |
| 1141 | they should be converted to :class:`bytes`. |
Victor Stinner | dcb2403 | 2010-04-22 12:08:36 +0000 | [diff] [blame] | 1142 | |
Victor Stinner | 25e8ec4 | 2010-06-25 00:02:38 +0000 | [diff] [blame] | 1143 | * PyArg_Parse*() functions: |
Victor Stinner | 3dcb5ac | 2010-06-08 22:54:19 +0000 | [diff] [blame] | 1144 | |
Victor Stinner | 25e8ec4 | 2010-06-25 00:02:38 +0000 | [diff] [blame] | 1145 | * "t#" format has been removed: use "s#" or "s*" instead |
| 1146 | * "w" and "w#" formats has been removed: use "w*" instead |
| 1147 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1148 | * The :c:type:`PyCObject` type, deprecated in 3.1, has been removed. To wrap |
| 1149 | opaque C pointers in Python objects, the :c:type:`PyCapsule` API should be used |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 1150 | instead; the new type has a well-defined interface for passing typing safety |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1151 | information and a less complicated signature for calling a destructor. |
Victor Stinner | 0cbec57 | 2010-09-12 20:32:57 +0000 | [diff] [blame] | 1152 | |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 1153 | * The :func:`sys.setfilesystemencoding` function was removed because |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 1154 | it had a flawed design. |
Raymond Hettinger | 3fcf002 | 2010-12-08 01:13:53 +0000 | [diff] [blame^] | 1155 | |
| 1156 | * The :func:`random.seed` function and method now performing salting for |
| 1157 | string seeds. To access the previous version of *seed* in order to |
| 1158 | reproduce Python 3.1 sequences, set the *version* argument to *1*, |
| 1159 | ``random.seed(s, version=1)``. |