Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +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 | |
Raymond Hettinger | ffad35e | 2010-12-14 21:12:03 +0000 | [diff] [blame] | 50 | This article explains the new features in Python 3.2 as compared to 3.1. It |
| 51 | focuses on a few highlights and gives a few examples. For full details, see the |
| 52 | :source:`Misc/NEWS <Misc/NEWS>` file. |
Raymond Hettinger | 2c1ecc3 | 2010-12-07 09:55:02 +0000 | [diff] [blame] | 53 | |
Raymond Hettinger | 6778fa9 | 2010-12-21 20:09:55 +0000 | [diff] [blame] | 54 | .. seealso:: |
| 55 | |
| 56 | :pep:`392` - Python 3.2 Release Schedule |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 57 | |
Raymond Hettinger | ca904be | 2011-01-18 00:02:40 +0000 | [diff] [blame] | 58 | |
Martin v. Löwis | 932e49e | 2010-12-04 13:49:32 +0000 | [diff] [blame] | 59 | PEP 384: Defining a Stable ABI |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 60 | ============================== |
| 61 | |
| 62 | In the past, extension modules built for one Python version were often |
| 63 | not usable with other Python versions. Particularly on Windows, every |
| 64 | feature release of Python required rebuilding all extension modules that |
| 65 | one wanted to use. This requirement was the result of the free access to |
| 66 | Python interpreter internals that extension modules could use. |
| 67 | |
| 68 | With Python 3.2, an alternative approach becomes available: extension |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 69 | modules which restrict themselves to a limited API (by defining |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 70 | Py_LIMITED_API) cannot use many of the internals, but are constrained |
| 71 | to a set of API functions that are promised to be stable for several |
| 72 | releases. As a consequence, extension modules built for 3.2 in that |
| 73 | mode will also work with 3.3, 3.4, and so on. Extension modules that |
| 74 | make use of details of memory structures can still be built, but will |
| 75 | need to be recompiled for every feature release. |
| 76 | |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 77 | .. seealso:: |
| 78 | |
Georg Brandl | 65b2eb9 | 2010-12-05 11:42:38 +0000 | [diff] [blame] | 79 | :pep:`384` - Defining a Stable ABI |
Raymond Hettinger | 2c1ecc3 | 2010-12-07 09:55:02 +0000 | [diff] [blame] | 80 | PEP written by Martin von Löwis. |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 81 | |
Raymond Hettinger | ca904be | 2011-01-18 00:02:40 +0000 | [diff] [blame] | 82 | |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 83 | PEP 389: Argparse Command Line Parsing Module |
| 84 | ============================================= |
| 85 | |
| 86 | A new module for command line parsing, :mod:`argparse`, was introduced to |
| 87 | overcome the limitations of :mod:`optparse` which did not provide support for |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 88 | positional arguments (not just options), subcommands, required options and other |
Raymond Hettinger | 413abbc | 2010-12-05 07:06:47 +0000 | [diff] [blame] | 89 | common patterns of specifying and validating options. |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 90 | |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 91 | This module has already has widespread success in the community as a |
Raymond Hettinger | b1ff402 | 2010-12-08 11:19:45 +0000 | [diff] [blame] | 92 | third-party module. Being more fully featured than its predecessor, the |
| 93 | :mod:`argparse` module is now the preferred module for command-line processing. |
| 94 | The older module is still being kept available because of the substantial amount |
| 95 | of legacy code that depends on it. |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 96 | |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 97 | Here's an annotated example parser showing features like limiting results to a |
| 98 | 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] | 99 | or more positional arguments is present, and making a required option:: |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 100 | |
| 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 Hettinger | 9297709 | 2011-01-16 09:18:59 +0000 | [diff] [blame] | 106 | choices = ['deploy', 'start', 'stop'], # three allowed values |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 107 | help = 'action on each target') # help msg |
| 108 | parser.add_argument('targets', |
| 109 | metavar = 'HOSTNAME', # var name used in help msg |
Raymond Hettinger | 9297709 | 2011-01-16 09:18:59 +0000 | [diff] [blame] | 110 | nargs = '+', # require one or more targets |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 111 | help = 'url for target machines') # help msg explanation |
| 112 | parser.add_argument('-u', '--user', # -u or --user option |
Georg Brandl | 52a43b5 | 2011-01-16 09:11:45 +0000 | [diff] [blame] | 113 | required = True, # make it a required argument |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 114 | help = 'login as user') |
| 115 | |
| 116 | Example 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 Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 120 | >>> result.action |
| 121 | 'deploy' |
| 122 | >>> result.targets |
| 123 | ['sneezy.example.com', 'sleepy.example.com'] |
| 124 | >>> result.user |
| 125 | 'skycaptain' |
| 126 | |
| 127 | Example of the parser's automatically generated help:: |
| 128 | |
| 129 | >>> parser.parse_args('-h'.split()) |
| 130 | |
Raymond Hettinger | 3fcf002 | 2010-12-08 01:13:53 +0000 | [diff] [blame] | 131 | usage: manage_cloud.py [-h] -u USER |
| 132 | {deploy,start,stop} HOSTNAME [HOSTNAME ...] |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 133 | |
| 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 Hettinger | b1ff402 | 2010-12-08 11:19:45 +0000 | [diff] [blame] | 146 | An especially nice :mod:`argparse` feature is the ability to define subparsers, |
| 147 | each 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 Hettinger | bb9686f | 2010-12-16 00:53:05 +0000 | [diff] [blame] | 154 | parser_l.add_argument('-m', '--missiles', action='store_true') |
Raymond Hettinger | b1ff402 | 2010-12-08 11:19:45 +0000 | [diff] [blame] | 155 | parser_l.add_argument('-t', '--torpedos', action='store_true') |
| 156 | |
Raymond Hettinger | 3094ed8 | 2010-12-18 09:41:32 +0000 | [diff] [blame] | 157 | parser_m = subparsers.add_parser('move', help='Move Vessel', # second subgroup |
| 158 | aliases=('steer', 'turn')) # equivalent names |
Raymond Hettinger | b1ff402 | 2010-12-08 11:19:45 +0000 | [diff] [blame] | 159 | 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 Hettinger | 3094ed8 | 2010-12-18 09:41:32 +0000 | [diff] [blame] | 165 | $ ./helm.py steer --course 180 --speed 5 # set movement parameters |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 166 | |
| 167 | .. seealso:: |
| 168 | |
| 169 | :pep:`389` - New Command Line Parsing Module |
| 170 | PEP written by Steven Bethard. |
| 171 | |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 172 | :ref:`upgrading-optparse-code` for details on the differences from |
| 173 | :mod:`optparse`. |
| 174 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 175 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 176 | PEP 391: Dictionary Based Configuration for Logging |
| 177 | ==================================================== |
Raymond Hettinger | ef2335c | 2010-09-05 08:35:38 +0000 | [diff] [blame] | 178 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 179 | The :mod:`logging` module provided two kinds of configuration, one style with |
| 180 | function calls for each option or another style driven by an external file saved |
| 181 | in a :mod:`ConfigParser` format. Those options did not provide the flexibility |
Georg Brandl | 9e75cad | 2010-09-06 06:45:47 +0000 | [diff] [blame] | 182 | to create configurations from JSON or YAML files, nor did they support |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 183 | incremental configuration, which is needed for specifying logger options from a |
| 184 | command line. |
Raymond Hettinger | ef2335c | 2010-09-05 08:35:38 +0000 | [diff] [blame] | 185 | |
| 186 | To support a more flexible style, the module now offers |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 187 | :func:`logging.config.dictConfig` for specifying logging configuration with |
| 188 | plain Python dictionaries. The configuration options include formatters, |
| 189 | handlers, filters, and loggers. Here's a working example of a configuration |
| 190 | dictionary:: |
Raymond Hettinger | ef2335c | 2010-09-05 08:35:38 +0000 | [diff] [blame] | 191 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 192 | {"version": 1, |
| 193 | "formatters": {"brief": {"format": "%(levelname)-8s: %(name)-15s: %(message)s"}, |
| 194 | "full": {"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"}, |
| 195 | }, |
| 196 | "handlers": {"console": { |
| 197 | "class": "logging.StreamHandler", |
| 198 | "formatter": "brief", |
| 199 | "level": "INFO", |
| 200 | "stream": "ext://sys.stdout"}, |
| 201 | "console_priority": { |
| 202 | "class": "logging.StreamHandler", |
| 203 | "formatter": "full", |
| 204 | "level": "ERROR", |
| 205 | "stream": "ext://sys.stderr"}, |
| 206 | }, |
| 207 | "root": {"level": "DEBUG", "handlers": ["console", "console_priority"]}} |
Raymond Hettinger | ef2335c | 2010-09-05 08:35:38 +0000 | [diff] [blame] | 208 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 209 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 210 | If that dictionary is stored in a file called :file:`conf.json`, it can be |
| 211 | loaded and called with code like this:: |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 212 | |
Raymond Hettinger | ca904be | 2011-01-18 00:02:40 +0000 | [diff] [blame] | 213 | >>> import json, logging.config |
| 214 | >>> with open('conf.json', 'rb') as f: |
| 215 | conf = json.load(f) |
| 216 | >>> logging.config.dictConfig(conf) |
| 217 | >>> logging.info("Transaction completed normally") |
| 218 | >>> logging.critical("Abnormal termination") |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 219 | |
Raymond Hettinger | ef2335c | 2010-09-05 08:35:38 +0000 | [diff] [blame] | 220 | .. seealso:: |
| 221 | |
| 222 | :pep:`391` - Dictionary Based Configuration for Logging |
| 223 | PEP written by Vinay Sajip. |
| 224 | |
Raymond Hettinger | ca904be | 2011-01-18 00:02:40 +0000 | [diff] [blame] | 225 | |
Georg Brandl | 97b20da | 2010-11-16 15:15:29 +0000 | [diff] [blame] | 226 | PEP 3148: The ``concurrent.futures`` module |
| 227 | ============================================ |
| 228 | |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 229 | Code for creating and managing concurrency is being collected in a new top-level |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 230 | namespace, *concurrent*. Its first member is a *futures* package which provides |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 231 | a uniform high-level interface for managing threads and processes. |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 232 | |
| 233 | The design for :mod:`concurrent.futures` was inspired by |
| 234 | *java.util.concurrent.package*. In that model, a running call and its result |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 235 | are represented by a :class:`~concurrent.futures.Future` object that abstracts |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 236 | features common to threads, processes, and remote procedure calls. That object |
| 237 | supports status checks (running or done), timeouts, cancellations, adding |
Raymond Hettinger | 24a0941 | 2010-12-08 06:50:02 +0000 | [diff] [blame] | 238 | callbacks, and access to results or exceptions. |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 239 | |
| 240 | The primary offering of the new module is a pair of executor classes for |
| 241 | launching and managing calls. The goal of the executors is to make it easier to |
| 242 | use existing tools for making parallel calls. They save the effort needed to |
| 243 | setup a pool of resources, launch the calls, create a results queue, add |
| 244 | 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] | 245 | procedure calls. |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 246 | |
| 247 | Ideally, each application should share a single executor across multiple |
| 248 | components so that process and thread limits can be centrally managed. This |
| 249 | solves the design challenge that arises when each component has its own |
| 250 | competing strategy for resource management. |
| 251 | |
Raymond Hettinger | b105519 | 2010-12-08 06:42:41 +0000 | [diff] [blame] | 252 | Both classes share a common interface with three methods: |
| 253 | :meth:`~concurrent.futures.Executor.submit` for scheduling a callable and |
| 254 | returning a :class:`~concurrent.futures.Future` object; |
| 255 | :meth:`~concurrent.futures.Executor.map` for scheduling many asynchronous calls |
Raymond Hettinger | 83d8079 | 2010-12-08 06:48:33 +0000 | [diff] [blame] | 256 | at a time, and :meth:`~concurrent.futures.Executor.shutdown` for freeing |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 257 | resources. The class is a :term:`context manager` and can be used in a |
Raymond Hettinger | 83d8079 | 2010-12-08 06:48:33 +0000 | [diff] [blame] | 258 | :keyword:`with` statement to assure that resources are automatically released |
| 259 | when currently pending futures are done executing. |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 260 | |
Raymond Hettinger | b105519 | 2010-12-08 06:42:41 +0000 | [diff] [blame] | 261 | A simple of example of :class:`~concurrent.futures.ThreadPoolExecutor` is a |
Raymond Hettinger | 83d8079 | 2010-12-08 06:48:33 +0000 | [diff] [blame] | 262 | launch of four parallel threads for copying files:: |
Raymond Hettinger | b105519 | 2010-12-08 06:42:41 +0000 | [diff] [blame] | 263 | |
| 264 | import shutil |
| 265 | with ThreadPoolExecutor(max_workers=4) as e: |
| 266 | e.submit(shutil.copy, 'src1.txt', 'dest1.txt') |
| 267 | e.submit(shutil.copy, 'src2.txt', 'dest2.txt') |
| 268 | e.submit(shutil.copy, 'src3.txt', 'dest3.txt') |
| 269 | e.submit(shutil.copy, 'src3.txt', 'dest4.txt') |
| 270 | |
Raymond Hettinger | 6f04adc | 2010-12-04 22:56:25 +0000 | [diff] [blame] | 271 | .. seealso:: |
| 272 | |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 273 | :pep:`3148` - Futures -- Execute Computations Asynchronously |
Andrew M. Kuchling | 42877fe | 2010-12-15 02:37:01 +0000 | [diff] [blame] | 274 | PEP written by Brian Quinlan. |
Georg Brandl | 97b20da | 2010-11-16 15:15:29 +0000 | [diff] [blame] | 275 | |
Raymond Hettinger | 83d8079 | 2010-12-08 06:48:33 +0000 | [diff] [blame] | 276 | :ref:`Code for Threaded Parallel URL reads<threadpoolexecutor-example>`, an |
| 277 | example using threads to fetch multiple web pages in parallel. |
| 278 | |
| 279 | :ref:`Code for computing prime numbers in |
| 280 | parallel<processpoolexecutor-example>`, an example demonstrating |
| 281 | :class:`~concurrent.futures.ProcessPoolExecutor`. |
| 282 | |
| 283 | |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 284 | PEP 3147: PYC Repository Directories |
| 285 | ===================================== |
| 286 | |
David Malcolm | 778645a | 2010-12-07 00:32:04 +0000 | [diff] [blame] | 287 | Python's scheme for caching bytecode in *.pyc* files did not work well in |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 288 | environments with multiple Python interpreters. If one interpreter encountered |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 289 | a cached file created by another interpreter, it would recompile the source and |
| 290 | overwrite the cached file, thus losing the benefits of caching. |
| 291 | |
| 292 | 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] | 293 | commonplace for Linux distributions to ship with multiple versions of Python. |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 294 | These conflicts also arise with CPython alternatives such as Unladen Swallow. |
| 295 | |
| 296 | 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] | 297 | distinct filenames for each interpreter. Instead of Python 3.2 and Python 3.3 and |
| 298 | 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] | 299 | look for "mymodule.cpython-32.pyc", "mymodule.cpython-33.pyc", and |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 300 | "mymodule.unladen10.pyc". And to prevent all of these new files from |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 301 | cluttering source directories, the *pyc* files are now collected in a |
| 302 | "__pycache__" directory stored under the package directory. |
| 303 | |
| 304 | Aside from the filenames and target directories, the new scheme has a few |
| 305 | aspects that are visible to the programmer: |
| 306 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 307 | * Imported modules now have a :attr:`__cached__` attribute which stores the name |
| 308 | of the actual file that was imported: |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 309 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 310 | >>> import collections |
| 311 | >>> collections.__cached__ |
| 312 | 'c:/py32/lib/__pycache__/collections.cpython-32.pyc' |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 313 | |
| 314 | * 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] | 315 | module: |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 316 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 317 | >>> import imp |
| 318 | >>> imp.get_tag() |
| 319 | 'cpython-32' |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 320 | |
| 321 | * Scripts that try to deduce source filename from the imported file now need to |
| 322 | be smarter. It is no longer sufficient to simply strip the "c" from a ".pyc" |
| 323 | filename. Instead, use the new functions in the :mod:`imp` module: |
| 324 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 325 | >>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc') |
| 326 | 'c:/py32/lib/collections.py' |
| 327 | >>> imp.cache_from_source('c:/py32/lib/collections.py') |
| 328 | 'c:/py32/lib/__pycache__/collections.cpython-32.pyc' |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 329 | |
| 330 | * The :mod:`py_compile` and :mod:`compileall` modules have been updated to |
| 331 | reflect the new naming convention and target directory. |
| 332 | |
Raymond Hettinger | 1dcc84e | 2011-01-17 21:55:40 +0000 | [diff] [blame] | 333 | * The :mod:`importlib.abc` module has been updated with new :term:`abstract base |
Raymond Hettinger | 66352d2 | 2011-01-17 22:33:11 +0000 | [diff] [blame] | 334 | classes <abstract base class>` for the loading bytecode files. The obsolete |
| 335 | ABCs, :class:`~importlib.abc.PyLoader` and |
Raymond Hettinger | 1dcc84e | 2011-01-17 21:55:40 +0000 | [diff] [blame] | 336 | :class:`~importlib.abc.PyPycLoader`, have been deprecated (instructions on how |
Raymond Hettinger | 66352d2 | 2011-01-17 22:33:11 +0000 | [diff] [blame] | 337 | to stay Python 3.1 compatible are included with the documentation). |
Brett Cannon | 83a682d | 2011-01-16 21:02:09 +0000 | [diff] [blame] | 338 | |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 339 | .. seealso:: |
| 340 | |
| 341 | :pep:`3147` - PYC Repository Directories |
| 342 | PEP written by Barry Warsaw. |
| 343 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 344 | |
Georg Brandl | 3ad4675 | 2010-12-05 07:59:29 +0000 | [diff] [blame] | 345 | PEP 3149: ABI Version Tagged .so Files |
| 346 | ====================================== |
Georg Brandl | f11c6c4 | 2010-09-03 22:20:58 +0000 | [diff] [blame] | 347 | |
Raymond Hettinger | ebea6fa | 2010-09-05 00:27:25 +0000 | [diff] [blame] | 348 | The PYC repository directory allows multiple bytecode cache files to be |
| 349 | co-located. This PEP implements a similar mechanism for shared object files by |
| 350 | giving them a common directory and distinct names for each version. |
Georg Brandl | f11c6c4 | 2010-09-03 22:20:58 +0000 | [diff] [blame] | 351 | |
Raymond Hettinger | ebea6fa | 2010-09-05 00:27:25 +0000 | [diff] [blame] | 352 | The common directory is "pyshared" and the file names are made distinct by |
| 353 | identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the |
| 354 | 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] | 355 | 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] | 356 | you may see these files when the distribution package is installed:: |
| 357 | |
| 358 | /usr/share/pyshared/foo.cpython-32m.so |
| 359 | /usr/share/pyshared/foo.cpython-33md.so |
| 360 | |
| 361 | In Python itself, the tags are accessible from functions in the :mod:`sysconfig` |
| 362 | module:: |
| 363 | |
| 364 | >>> import sysconfig |
| 365 | >>> sysconfig.get_config_var('SOABI') # find the version tag |
| 366 | 'cpython-32mu' |
| 367 | >>> sysconfig.get_config_var('SO') # find the full filename extension |
| 368 | 'cpython-32mu.so' |
| 369 | |
| 370 | .. seealso:: |
| 371 | |
| 372 | :pep:`3149` - ABI Version Tagged .so Files |
| 373 | PEP written by Barry Warsaw. |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 374 | |
Raymond Hettinger | ca904be | 2011-01-18 00:02:40 +0000 | [diff] [blame] | 375 | |
Raymond Hettinger | 3df4621 | 2011-01-06 02:01:26 +0000 | [diff] [blame] | 376 | PEP 3333: Python Web Server Gateway Interface v1.0.1 |
| 377 | ===================================================== |
| 378 | |
| 379 | This informational PEP clarifies how bytes/text issues are to be handled by the |
| 380 | WGSI protocol. The challenge is that string handling in Python 3 is most |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 381 | conveniently handled with the :class:`str` type even though the HTTP protocol |
Raymond Hettinger | 3df4621 | 2011-01-06 02:01:26 +0000 | [diff] [blame] | 382 | is itself bytes oriented. |
| 383 | |
| 384 | The PEP differentiates so-called *native strings* that are used for |
| 385 | request/response headers and metadata versus *byte strings* which are used for |
| 386 | the bodies of requests and responses. |
| 387 | |
| 388 | The *native strings* are always of type :class:`str` but are restricted to code |
Georg Brandl | 52a43b5 | 2011-01-16 09:11:45 +0000 | [diff] [blame] | 389 | points between *U+0000* through *U+00FF* which are translatable to bytes using |
Raymond Hettinger | 32e8fea | 2011-01-07 21:04:30 +0000 | [diff] [blame] | 390 | *Latin-1* encoding. These strings are used for the keys and values in the |
| 391 | environ dictionary and for response headers and statuses in the |
| 392 | :func:`start_response` function. They must follow :rfc:`2616` with respect to |
Raymond Hettinger | 3df4621 | 2011-01-06 02:01:26 +0000 | [diff] [blame] | 393 | encoding. That is, they must either be *ISO-8859-1* characters or use |
| 394 | :rfc:`2047` MIME encoding. |
| 395 | |
Raymond Hettinger | 32e8fea | 2011-01-07 21:04:30 +0000 | [diff] [blame] | 396 | For developers porting WSGI applications from Python 2, here are the salient |
| 397 | points: |
| 398 | |
| 399 | * If the app already used strings for headers in Python 2, no change is needed. |
| 400 | |
| 401 | * If instead, the app encoded output headers or decoded input headers, then the |
| 402 | headers will need to be re-encoded to Latin-1. For example, an output header |
| 403 | encoded in utf-8 was using ``h.encode('utf-8')`` now needs to convert from |
| 404 | bytes to native strings using ``h.encode('utf-8').decode('latin-1')``. |
| 405 | |
| 406 | * Values yielded by an application or sent using the :meth:`write` method |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 407 | must be byte strings. The :func:`start_response` function and environ |
| 408 | must use native strings. The two cannot be mixed. |
Raymond Hettinger | 32e8fea | 2011-01-07 21:04:30 +0000 | [diff] [blame] | 409 | |
| 410 | For server implementers writing CGI-to-WSGI pathways or other CGI-style |
| 411 | protocols, the users must to be able access the environment using native strings |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 412 | even though the underlying platform may have a different convention. To bridge |
Raymond Hettinger | 32e8fea | 2011-01-07 21:04:30 +0000 | [diff] [blame] | 413 | this gap, the :mod:`wsgiref` module has a new function, |
| 414 | :func:`wsgiref.handlers.read_environ` for transcoding CGI variables from |
| 415 | :attr:`os.environ` into native strings and returning a new dictionary. |
Raymond Hettinger | 3df4621 | 2011-01-06 02:01:26 +0000 | [diff] [blame] | 416 | |
| 417 | .. seealso:: |
| 418 | |
| 419 | :pep:`3333` - Python Web Server Gateway Interface v1.0.1 |
| 420 | PEP written by Phillip Eby. |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 421 | |
Raymond Hettinger | ca904be | 2011-01-18 00:02:40 +0000 | [diff] [blame] | 422 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 423 | Other Language Changes |
| 424 | ====================== |
| 425 | |
| 426 | Some smaller changes made to the core Python language are: |
| 427 | |
Raymond Hettinger | e5e1a98 | 2010-12-05 08:35:21 +0000 | [diff] [blame] | 428 | * String formatting for :func:`format` and :meth:`str.format` gained new |
| 429 | capabilities for the format character **#**. Previously, for integers in |
| 430 | binary, octal, or hexadecimal, it caused the output to be prefixed with '0b', |
| 431 | '0o', or '0x' respectively. Now it can also handle floats, complex, and |
| 432 | Decimal, causing the output to always have a decimal point even when no digits |
| 433 | follow it. |
Raymond Hettinger | e5e728b | 2010-12-05 06:35:16 +0000 | [diff] [blame] | 434 | |
| 435 | >>> format(20, '#o') |
| 436 | '0o24' |
| 437 | >>> format(12.34, '#5.0f') |
| 438 | ' 12.' |
| 439 | |
| 440 | (Suggested by Mark Dickinson and implemented by Eric Smith in :issue:`7094`.) |
Raymond Hettinger | 43b5a85 | 2010-12-05 04:04:21 +0000 | [diff] [blame] | 441 | |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 442 | * The interpreter can now be started with a quiet option, ``-q``, to suppress |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 443 | the copyright and version information from being displayed in the interactive |
| 444 | mode. The option can be introspected using the :attr:`sys.flags` attribute:: |
Raymond Hettinger | 7d96771 | 2011-01-05 20:24:08 +0000 | [diff] [blame] | 445 | |
| 446 | $ python -q |
| 447 | >>> sys.flags |
| 448 | sys.flags(debug=0, division_warning=0, inspect=0, interactive=0, |
| 449 | optimize=0, dont_write_bytecode=0, no_user_site=0, no_site=0, |
| 450 | ignore_environment=0, verbose=0, bytes_warning=0, quiet=1) |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 451 | |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 452 | (Contributed by Marcin Wojdyr in :issue:`1772833`). |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 453 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 454 | * The :func:`hasattr` function works by calling :func:`getattr` and detecting |
| 455 | whether an exception is raised. This technique allows it to detect methods |
| 456 | created dynamically by :meth:`__getattr__` or :meth:`__getattribute__` which |
Raymond Hettinger | 90a4b31 | 2011-01-06 02:08:30 +0000 | [diff] [blame] | 457 | would otherwise be absent from the class dictionary. Formerly, *hasattr* |
| 458 | would catch any exception, possibly masking genuine errors. Now, *hasattr* |
| 459 | has been tightened to only catch :exc:`AttributeError` and let other |
| 460 | exceptions pass through. |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 461 | |
Raymond Hettinger | a55ffbc | 2010-12-15 18:31:57 +0000 | [diff] [blame] | 462 | (Discovered by Yury Selivanov and fixed by Benjamin Peterson; :issue:`9666`.) |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 463 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 464 | * 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] | 465 | :func:`repr`. Previously, the :func:`str` form was shorter but that just |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 466 | caused confusion and is no longer needed now that the shortest possible |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 467 | :func:`repr` is displayed by default: |
Raymond Hettinger | bb734c6 | 2010-09-05 05:56:44 +0000 | [diff] [blame] | 468 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 469 | >>> repr(math.pi) |
| 470 | '3.141592653589793' |
| 471 | >>> str(math.pi) |
| 472 | '3.141592653589793' |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 473 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 474 | (Proposed and implemented by Mark Dickinson; :issue:`9337`.) |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 475 | |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 476 | * :class:`memoryview` objects now have a :meth:`~memoryview.release()` method |
| 477 | and they also now support the context manager protocol. This allows timely |
| 478 | release of any resources that were acquired when requesting a buffer from the |
| 479 | original object. |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 480 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 481 | >>> with memoryview(b'abcdefgh') as v: |
| 482 | ... print(v.tolist()) |
| 483 | ... |
| 484 | [97, 98, 99, 100, 101, 102, 103, 104] |
| 485 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 486 | (Added by Antoine Pitrou; :issue:`9757`.) |
| 487 | |
Amaury Forgeot d'Arc | ba117ef | 2010-09-10 21:39:53 +0000 | [diff] [blame] | 488 | * Previously it was illegal to delete a name from the local namespace if it |
| 489 | occurs as a free variable in a nested block:: |
| 490 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 491 | def outer(x): |
| 492 | def inner(): |
| 493 | return x |
| 494 | inner() |
| 495 | del x |
Amaury Forgeot d'Arc | ba117ef | 2010-09-10 21:39:53 +0000 | [diff] [blame] | 496 | |
| 497 | This is now allowed. Remember that the target of an :keyword:`except` clause |
| 498 | is cleared, so this code which used to work with Python 2.6, raised a |
| 499 | :exc:`SyntaxError` with Python 3.1 and now works again:: |
| 500 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 501 | def f(): |
| 502 | def print_error(): |
| 503 | print(e) |
| 504 | try: |
| 505 | something |
| 506 | except Exception as e: |
| 507 | print_error() |
| 508 | # implicit "del e" here |
Amaury Forgeot d'Arc | ba117ef | 2010-09-10 21:39:53 +0000 | [diff] [blame] | 509 | |
| 510 | (See :issue:`4617`.) |
| 511 | |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 512 | * The internal :c:type:`structsequence` tool now creates subclasses of tuple. |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 513 | This means that C structures like those returned by :func:`os.stat`, |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 514 | :func:`time.gmtime`, and :func:`sys.version_info` now work like a |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 515 | :term:`named tuple` and now work with functions and methods that |
Raymond Hettinger | 93c8cad | 2011-01-18 00:30:24 +0000 | [diff] [blame] | 516 | expect a tuple as an argument. This is a big step forward in making the C |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 517 | structures as flexible as their pure Python counterparts. |
| 518 | |
| 519 | (Suggested by Arfrever Frehtes Taifersar Arahesis and implemented |
| 520 | by Benjamin Peterson in :issue:`8413`.) |
| 521 | |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 522 | * Warnings are now easier to control using the :envvar:`PYTHONWARNINGS` |
Raymond Hettinger | 93c8cad | 2011-01-18 00:30:24 +0000 | [diff] [blame] | 523 | environment variable as an alternative to using ``-W`` at the command line. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 524 | |
| 525 | (Suggested by Barry Warsaw and implemented by Philip Jenvey in :issue:`7301`.) |
| 526 | |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 527 | * A new warning category, :exc:`ResourceWarning`, has been added. It is |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 528 | emitted when potential issues with resource consumption or cleanup |
Raymond Hettinger | 93c8cad | 2011-01-18 00:30:24 +0000 | [diff] [blame] | 529 | are detected. It is silenced by default in normal release builds but |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 530 | can be enabled through the means provided by the :mod:`warnings` |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 531 | module, or on the command line. |
| 532 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 533 | A :exc:`ResourceWarning` is issued at interpreter shutdown if the |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 534 | :data:`gc.garbage` list isn't empty. This is meant to make the programmer |
| 535 | aware that their code contains object finalization issues. |
| 536 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 537 | 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] | 538 | without having been explicitly closed. While the deallocator for such |
| 539 | object ensures it closes the underlying operating system resource |
| 540 | (usually, a file descriptor), the delay in deallocating the object could |
| 541 | produce various issues, especially under Windows. Here is an example |
| 542 | of enabling the warning from the command line:: |
| 543 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 544 | $ python -q -Wdefault |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 545 | >>> f = open("foo", "wb") |
| 546 | >>> del f |
| 547 | __main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'> |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 548 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 549 | (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] | 550 | |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 551 | * :class:`range` objects now support *index* and *count* methods. This is part |
| 552 | of an effort to make more objects fully implement the |
| 553 | :class:`collections.Sequence` :term:`abstract base class`. As a result, the |
| 554 | language will have a more uniform API. In addition, :class:`range` objects |
Raymond Hettinger | b965629 | 2011-01-16 18:22:06 +0000 | [diff] [blame] | 555 | now support slicing and negative indices, even with values larger than |
| 556 | :attr:`sys.maxsize`. This makes *range* more interoperable with lists:: |
Raymond Hettinger | 2ffa671 | 2010-12-08 10:18:21 +0000 | [diff] [blame] | 557 | |
| 558 | >>> range(0, 100, 2).count(10) |
| 559 | 1 |
| 560 | >>> range(0, 100, 2).index(10) |
| 561 | 5 |
| 562 | >>> range(0, 100, 2)[5] |
| 563 | 10 |
| 564 | >>> range(0, 100, 2)[0:5] |
| 565 | range(0, 10, 2) |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 566 | |
Raymond Hettinger | b965629 | 2011-01-16 18:22:06 +0000 | [diff] [blame] | 567 | (Contributed by Daniel Stutzbach in :issue:`9213`, by Alexander Belopolsky |
| 568 | in :issue:`2690`, and by Nick Coghlan in :issue:`10889`.) |
Nick Coghlan | 37ee850 | 2010-12-03 14:26:13 +0000 | [diff] [blame] | 569 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 570 | * The :func:`callable` builtin function from Py2.x was resurrected. It provides |
Raymond Hettinger | b87ba26 | 2010-12-06 04:31:40 +0000 | [diff] [blame] | 571 | a concise, readable alternative to using an :term:`abstract base class` in an |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 572 | expression like ``isinstance(x, collections.Callable)``: |
| 573 | |
| 574 | >>> callable(max) |
| 575 | True |
| 576 | >>> callable(20) |
| 577 | False |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 578 | |
| 579 | (See :issue:`10518`.) |
Amaury Forgeot d'Arc | ba117ef | 2010-09-10 21:39:53 +0000 | [diff] [blame] | 580 | |
Raymond Hettinger | 93c8cad | 2011-01-18 00:30:24 +0000 | [diff] [blame] | 581 | * Python's import mechanism can now load modules installed in directories with |
Raymond Hettinger | 070ec70 | 2010-12-10 17:45:13 +0000 | [diff] [blame] | 582 | non-ASCII characters in the path name. |
| 583 | |
| 584 | (Required extensive work by Victor Stinner in :issue:`9425`.) |
| 585 | |
| 586 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 587 | New, Improved, and Deprecated Modules |
| 588 | ===================================== |
| 589 | |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 590 | Python's standard library has undergone significant maintenance efforts and |
| 591 | quality improvements. |
Raymond Hettinger | e434b3b | 2010-12-15 19:20:01 +0000 | [diff] [blame] | 592 | |
| 593 | The biggest news for Python 3.2 is that the :mod:`email` package and |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 594 | :mod:`nntplib` modules now work correctly with the bytes/text model in Python 3. |
Raymond Hettinger | e434b3b | 2010-12-15 19:20:01 +0000 | [diff] [blame] | 595 | For the first time, there is correct handling of inputs with mixed encodings. |
| 596 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 597 | Throughout the standard library, there has been more careful attention to |
| 598 | encodings and text versus bytes issues. In particular, interactions with the |
| 599 | operating system are now better able to pass non-ASCII data using the Windows |
Raymond Hettinger | ba5512f | 2011-01-18 08:28:01 +0000 | [diff] [blame] | 600 | MBCS encoding, locale-aware encodings, or UTF-8. |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 601 | |
Raymond Hettinger | e434b3b | 2010-12-15 19:20:01 +0000 | [diff] [blame] | 602 | Another significant win is the addition of substantially better support for |
| 603 | *SSL* connections and security certificates. |
| 604 | |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 605 | In addition, more classes now implement a :term:`context manager` to support |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 606 | convenient and reliable resource clean-up using a :keyword:`with` statement. |
Raymond Hettinger | e434b3b | 2010-12-15 19:20:01 +0000 | [diff] [blame] | 607 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 608 | email |
| 609 | ----- |
| 610 | |
| 611 | The usability of the :mod:`email` package in Python 3 has been mostly fixed by |
| 612 | the extensive efforts of R. David Murray. The problem was that emails are |
| 613 | typically read and stored in the form of :class:`bytes` rather than :class:`str` |
| 614 | text, and they may contain multiple encodings within a single email. So, the |
| 615 | email package had to be extended to parse and generate email messages in bytes |
| 616 | format. |
| 617 | |
| 618 | * New functions :func:`~email.message_from_bytes` and |
| 619 | :func:`~email.message_from_binary_file`, and new classes |
| 620 | :class:`~email.parser.BytesFeedParser` and :class:`~email.parser.BytesParser` |
| 621 | allow binary message data to be parsed into model objects. |
| 622 | |
| 623 | * Given bytes input to the model, :meth:`~email.message.Message.get_payload` |
| 624 | will by default decode a message body that has a |
| 625 | :mailheader:`Content-Transfer-Encoding` of *8bit* using the charset |
| 626 | specified in the MIME headers and return the resulting string. |
| 627 | |
| 628 | * Given bytes input to the model, :class:`~email.generator.Generator` will |
| 629 | convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of |
| 630 | *8bit* to instead have a *7bit* :mailheader:`Content-Transfer-Encoding`. |
Raymond Hettinger | c08ea61 | 2011-01-08 10:32:31 +0000 | [diff] [blame] | 631 | |
Raymond Hettinger | cf8a382 | 2011-01-11 21:20:20 +0000 | [diff] [blame] | 632 | Headers with unencoded non-ASCII bytes are deemed to be :rfc:`2047`\ -encoded |
| 633 | using the *unknown-8bit* character set. |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 634 | |
| 635 | * A new class :class:`~email.generator.BytesGenerator` produces bytes as output, |
| 636 | preserving any unchanged non-ASCII data that was present in the input used to |
| 637 | build the model, including message bodies with a |
| 638 | :mailheader:`Content-Transfer-Encoding` of *8bit*. |
| 639 | |
| 640 | * The :mod:`smtplib` :class:`~smtplib.SMTP` class now accepts a byte string |
| 641 | for the *msg* argument to the :meth:`~smtplib.SMTP.sendmail` method, |
| 642 | and a new method, :meth:`~smtplib.SMTP.send_message` accepts a |
| 643 | :class:`~email.message.Message` object and can optionally obtain the |
| 644 | *from_addr* and *to_addrs* addresses directly from the object. |
| 645 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 646 | (Proposed and implemented by R. David Murray, :issue:`4661` and :issue:`10321`.) |
| 647 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 648 | elementtree |
| 649 | ----------- |
| 650 | |
Georg Brandl | 5d53fdd | 2010-12-18 11:58:12 +0000 | [diff] [blame] | 651 | The :mod:`xml.etree.ElementTree` package and its :mod:`xml.etree.cElementTree` |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 652 | counterpart have been updated to version 1.3. |
| 653 | |
| 654 | Several new and useful functions and methods have been added: |
| 655 | |
| 656 | * :func:`xml.etree.ElementTree.fromstringlist` which builds an XML document |
| 657 | from a sequence of fragments |
| 658 | * :func:`xml.etree.ElementTree.register_namespace` for registering a global |
| 659 | namespace prefix |
| 660 | * :func:`xml.etree.ElementTree.tostringlist` for string representation |
| 661 | including all sublists |
| 662 | * :meth:`xml.etree.ElementTree.Element.extend` for appending a sequence of zero |
| 663 | or more elements |
| 664 | * :meth:`xml.etree.ElementTree.Element.iterfind` searches an element and |
| 665 | subelements |
| 666 | * :meth:`xml.etree.ElementTree.Element.itertext` creates a text iterator over |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 667 | an element and its subelements |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 668 | * :meth:`xml.etree.ElementTree.TreeBuilder.end` closes the current element |
| 669 | * :meth:`xml.etree.ElementTree.TreeBuilder.doctype` handles a doctype |
| 670 | declaration |
| 671 | |
| 672 | Two methods have been deprecated: |
| 673 | |
| 674 | * :meth:`xml.etree.ElementTree.getchildren` use ``list(elem)`` instead. |
| 675 | * :meth:`xml.etree.ElementTree.getiterator` use ``Element.iter`` instead. |
| 676 | |
| 677 | For details of the update, see `Introducing ElementTree |
| 678 | <http://effbot.org/zone/elementtree-13-intro.htm>`_ on Fredrik Lundh's website. |
| 679 | |
Antoine Pitrou | 12de8ac | 2010-12-16 13:33:56 +0000 | [diff] [blame] | 680 | (Contributed by Florent Xicluna and Fredrik Lundh, :issue:`6472`.) |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 681 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 682 | functools |
| 683 | --------- |
| 684 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 685 | * The :mod:`functools` module includes a new decorator for caching function |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 686 | calls. :func:`functools.lru_cache` can save repeated queries to an external |
| 687 | resource whenever the results are expected to be the same. |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 688 | |
Raymond Hettinger | 86f9613 | 2010-08-06 23:23:49 +0000 | [diff] [blame] | 689 | For example, adding a caching decorator to a database query function can save |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 690 | database accesses for popular searches: |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 691 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 692 | >>> @functools.lru_cache(maxsize=300) |
| 693 | >>> def get_phone_number(name): |
| 694 | c = conn.cursor() |
| 695 | c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,)) |
| 696 | return c.fetchone()[0] |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 697 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 698 | >>> for name in user_requests: |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 699 | get_phone_number(name) # cached lookup |
Raymond Hettinger | 7496b41 | 2010-11-30 19:15:45 +0000 | [diff] [blame] | 700 | |
| 701 | To help with choosing an effective cache size, the wrapped function is |
| 702 | instrumented for tracking cache statistics: |
| 703 | |
Raymond Hettinger | 5e20bab | 2010-11-30 07:13:04 +0000 | [diff] [blame] | 704 | >>> get_phone_number.cache_info() |
Raymond Hettinger | 7496b41 | 2010-11-30 19:15:45 +0000 | [diff] [blame] | 705 | CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300) |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 706 | |
Raymond Hettinger | f309828 | 2010-08-15 03:30:45 +0000 | [diff] [blame] | 707 | 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] | 708 | cleared with: |
Raymond Hettinger | f309828 | 2010-08-15 03:30:45 +0000 | [diff] [blame] | 709 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 710 | >>> get_phone_number.cache_clear() |
Raymond Hettinger | f309828 | 2010-08-15 03:30:45 +0000 | [diff] [blame] | 711 | |
Raymond Hettinger | 6e35394 | 2010-12-04 23:42:12 +0000 | [diff] [blame] | 712 | (Contributed by Raymond Hettinger and incorporating design ideas from |
Raymond Hettinger | b87ba26 | 2010-12-06 04:31:40 +0000 | [diff] [blame] | 713 | Jim Baker, Miki Tebeka, and Nick Coghlan.) |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 714 | |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 715 | * The :func:`functools.wraps` decorator now adds a :attr:`__wrapped__` attribute |
| 716 | pointing to the original callable function. This allows wrapped functions to |
| 717 | be introspected. It also copies :attr:`__annotations__` if defined. And now |
| 718 | it also gracefully skips over missing attributes such as :attr:`__doc__` which |
Raymond Hettinger | 5eb6390 | 2010-12-09 23:43:34 +0000 | [diff] [blame] | 719 | might not be defined for the wrapped callable. |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 720 | |
| 721 | (By Nick Coghlan and Terrence Cole; :issue:`9567`, :issue:`3445`, and |
| 722 | :issue:`8814`.) |
| 723 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 724 | * To help write classes with rich comparison methods, a new decorator |
| 725 | :func:`functools.total_ordering` will use a existing equality and inequality |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 726 | methods to fill in the remaining methods. |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 727 | |
| 728 | For example, supplying *__eq__* and *__lt__* will enable |
| 729 | :func:`~functools.total_ordering` to fill-in *__le__*, *__gt__* and *__ge__*:: |
| 730 | |
| 731 | @total_ordering |
| 732 | class Student: |
| 733 | def __eq__(self, other): |
| 734 | return ((self.lastname.lower(), self.firstname.lower()) == |
| 735 | (other.lastname.lower(), other.firstname.lower())) |
| 736 | def __lt__(self, other): |
| 737 | return ((self.lastname.lower(), self.firstname.lower()) < |
| 738 | (other.lastname.lower(), other.firstname.lower())) |
| 739 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 740 | With the *total_ordering* decorator, the remaining comparison methods |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 741 | are filled in automatically. |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 742 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 743 | (Contributed by Raymond Hettinger.) |
Raymond Hettinger | f35a34c | 2010-12-22 09:11:54 +0000 | [diff] [blame] | 744 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 745 | * To aid in porting programs from Python 2, the :func:`~functools.cmp_to_key` |
Raymond Hettinger | bb9686f | 2010-12-16 00:53:05 +0000 | [diff] [blame] | 746 | function converts an old-style comparison function to |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 747 | modern :term:`key function`: |
| 748 | |
| 749 | >>> # locale-aware sort order |
| 750 | >>> sorted(iterable, key=cmp_to_key(locale.strcoll)) |
| 751 | |
| 752 | For sorting examples and a brief sorting tutorial, see the `Sorting HowTo |
| 753 | <http://wiki.python.org/moin/HowTo/Sorting/>`_ tutorial. |
| 754 | |
| 755 | (Contributed by Raymond Hettinger.) |
| 756 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 757 | itertools |
| 758 | --------- |
| 759 | |
Raymond Hettinger | 673ccf2 | 2010-12-07 09:37:11 +0000 | [diff] [blame] | 760 | * The :mod:`itertools` module has a new :func:`~itertools.accumulate` function |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 761 | modeled on APL's *scan* operator and on Numpy's *accumulate* function: |
Raymond Hettinger | 6e35394 | 2010-12-04 23:42:12 +0000 | [diff] [blame] | 762 | |
| 763 | >>> list(accumulate(8, 2, 50)) |
| 764 | [8, 10, 60] |
| 765 | |
| 766 | >>> prob_dist = [0.1, 0.4, 0.2, 0.3] |
| 767 | >>> list(accumulate(prob_dist)) # cumulative probability distribution |
| 768 | [0.1, 0.5, 0.7, 1.0] |
| 769 | |
| 770 | For an example using :func:`~itertools.accumulate`, see the :ref:`examples for |
| 771 | the random module <random-examples>`. |
| 772 | |
| 773 | (Contributed by Raymond Hettinger and incorporating design suggestions |
| 774 | from Mark Dickinson.) |
| 775 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 776 | collections |
| 777 | ----------- |
| 778 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 779 | * The :class:`collections.Counter` class now has two forms of in-place |
| 780 | subtraction, the existing *-=* operator for `saturating subtraction |
| 781 | <http://en.wikipedia.org/wiki/Saturation_arithmetic>`_ and the new |
| 782 | :meth:`~collections.Counter.subtract` method for regular subtraction. The |
| 783 | former is suitable for `multisets <http://en.wikipedia.org/wiki/Multiset>`_ |
Raymond Hettinger | ffad35e | 2010-12-14 21:12:03 +0000 | [diff] [blame] | 784 | which only have positive counts, and the latter is more suitable for use cases |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 785 | that allow negative counts: |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 786 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 787 | >>> tally = Counter(dogs=5, cat=3) |
| 788 | >>> tally -= Counter(dogs=2, cats=8) # saturating subtraction |
| 789 | >>> tally |
| 790 | Counter({'dogs': 3}) |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 791 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 792 | >>> tally = Counter(dogs=5, cats=3) |
| 793 | >>> tally.subtract(dogs=2, cats=8) # regular subtraction |
| 794 | >>> tally |
| 795 | Counter({'dogs': 3, 'cats': -5}) |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 796 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 797 | (Contributed by Raymond Hettinger.) |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 798 | |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 799 | * The :class:`collections.OrderedDict` class has a new method |
| 800 | :meth:`~collections.OrderedDict.move_to_end` which takes an existing key and |
Raymond Hettinger | 23ab101 | 2011-01-18 20:25:04 +0000 | [diff] [blame^] | 801 | moves it to either the first or last position in the ordered sequence. |
| 802 | |
| 803 | The default is to move an item to the last position. This is equivalent of |
| 804 | renewing an entry with ``od[k] = od.pop(k)``. |
| 805 | |
| 806 | A fast move-to-end operation is useful for resequencing entries. For example, |
| 807 | an ordered dictionary can being used to track access order by aging entries |
| 808 | from oldest to most recently accessed. |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 809 | |
| 810 | >>> d = OrderedDict.fromkeys(['a', 'b', 'X', 'd', 'e']) |
| 811 | >>> list(d) |
| 812 | ['a', 'b', 'X', 'd', 'e'] |
Raymond Hettinger | 23ab101 | 2011-01-18 20:25:04 +0000 | [diff] [blame^] | 813 | >>> d.move_to_end('X') |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 814 | >>> list(d) |
| 815 | ['a', 'b', 'd', 'e', 'X'] |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 816 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 817 | (Contributed by Raymond Hettinger.) |
| 818 | |
Raymond Hettinger | 7ec790d | 2011-01-18 00:19:30 +0000 | [diff] [blame] | 819 | * The :class:`collections.deque` class grew two new methods |
| 820 | :meth:`~collections.deque.count` and :meth:`~collections.deque.reverse` that |
| 821 | make them more substitutable for :class:`list` objects: |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 822 | |
| 823 | >>> d = deque('simsalabim') |
| 824 | >>> d.count('s') |
| 825 | 2 |
| 826 | >>> d.reverse() |
| 827 | >>> d |
| 828 | deque(['m', 'i', 'b', 'a', 'l', 'a', 's', 'm', 'i', 's']) |
| 829 | |
| 830 | (Contributed by Raymond Hettinger.) |
| 831 | |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 832 | threading |
| 833 | --------- |
| 834 | |
| 835 | The :mod:`threading` module has a new :class:`~threading.Barrier` |
| 836 | synchronization class for making multiple threads wait until all of them have |
| 837 | reached a common barrier point. Barriers are useful for making sure that a task |
| 838 | with multiple preconditions does not run until all of the predecessor tasks are |
| 839 | complete. |
| 840 | |
| 841 | Barriers can work with an arbitrary number of threads. This is a generalization |
| 842 | of a `Rendezvous <http://en.wikipedia.org/wiki/Synchronous_rendezvous>`_ which |
| 843 | is defined for only two threads. |
| 844 | |
Raymond Hettinger | 15b47c5 | 2011-01-17 21:05:07 +0000 | [diff] [blame] | 845 | Implemented as a two-phase cyclic barrier, :class:`~threading.Barrier` objects |
| 846 | are suitable for use in loops. The separate *filling* and *draining* phases |
| 847 | assure that all threads get released (drained) before any one them can loop back |
| 848 | and re-enter the barrier. The barrier fully resets after each cycle. |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 849 | |
| 850 | If any of the predecessor tasks can hang or be delayed, a barrier can be created |
| 851 | with an optional *timeout* parameter. Then if the timeout period elapses before |
| 852 | all the predecessor tasks reach the barrier point, all waiting threads are |
| 853 | released and a :exc:`~threading.BrokenBarrierError` exception is raised. |
| 854 | |
| 855 | Example of using barriers:: |
| 856 | |
| 857 | def get_votes(site): |
| 858 | ballots = conduct_election(site) |
| 859 | all_polls_closed.wait() # do not count until all polls are closed |
Raymond Hettinger | 9767365 | 2011-01-11 21:13:26 +0000 | [diff] [blame] | 860 | totals = summarize(ballots) |
| 861 | publish(site, totals) |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 862 | |
| 863 | all_polls_closed = Barrier(len(sites)) |
Raymond Hettinger | 3a8ae5f | 2011-01-11 20:51:45 +0000 | [diff] [blame] | 864 | for site in sites: |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 865 | Thread(target=get_votes, args=(site,)).start() |
| 866 | |
| 867 | In this example, the barrier enforces a rule that votes cannot be counted at any |
| 868 | polling site until all polls are closed. Notice how a solution with a barrier |
| 869 | is similar to one with :meth:`threading.Thread.join`, but the threads stay alive |
| 870 | and continue to do work (summarizing ballots) after the barrier point is |
| 871 | crossed. |
| 872 | |
| 873 | See `Barrier Synchronization Patterns |
Raymond Hettinger | 3a8ae5f | 2011-01-11 20:51:45 +0000 | [diff] [blame] | 874 | <http://parlab.eecs.berkeley.edu/wiki/_media/patterns/paraplop_g1_3.pdf>`_ for |
| 875 | more examples of how barriers can be used in parallel computing. Also, there is |
| 876 | a simple but thorough explanation of barriers in `The Little Book of Semaphores |
| 877 | <http://greenteapress.com/semaphores/downey08semaphores.pdf>`_, *section 3.6*. |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 878 | |
Raymond Hettinger | 3a8ae5f | 2011-01-11 20:51:45 +0000 | [diff] [blame] | 879 | (Contributed by Kristján Valur Jónsson with an API review by Jeffrey Yasskin in |
| 880 | :issue:`8777`.) |
Raymond Hettinger | 6655d11 | 2011-01-11 08:49:10 +0000 | [diff] [blame] | 881 | |
Raymond Hettinger | 9767365 | 2011-01-11 21:13:26 +0000 | [diff] [blame] | 882 | datetime and time |
| 883 | ----------------- |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 884 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 885 | * The :mod:`datetime` module has a new type :class:`~datetime.timezone` that |
| 886 | implements the :class:`~datetime.tzinfo` interface by returning a fixed UTC |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 887 | offset and timezone name. This makes it easier to create timezone-aware |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 888 | datetime objects: |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 889 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 890 | >>> datetime.now(timezone.utc) |
| 891 | datetime.datetime(2010, 12, 8, 21, 4, 2, 923754, tzinfo=datetime.timezone.utc) |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 892 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 893 | >>> datetime.strptime("01/01/2000 12:00 +0000", "%m/%d/%Y %H:%M %z") |
| 894 | datetime.datetime(2000, 1, 1, 12, 0, tzinfo=datetime.timezone.utc) |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 895 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 896 | * Also, :class:`~datetime.timedelta` objects can now be multiplied by |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 897 | :class:`float` and divided by :class:`float` and :class:`int` objects. |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 898 | And :class:`~datetime.timedelta` objects can now divide one another. |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 899 | |
Raymond Hettinger | ca904be | 2011-01-18 00:02:40 +0000 | [diff] [blame] | 900 | * The :meth:`datetime.date.strftime` method is no longer restricted to years |
| 901 | after 1900. The new supported year range is from 1000 to 9999 inclusive. |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 902 | |
Raymond Hettinger | 9767365 | 2011-01-11 21:13:26 +0000 | [diff] [blame] | 903 | * The rules for two-digit years in time tuples have changed. Now, the |
| 904 | :func:`time.asctime` and :func:`time.strftime` functions will format any year |
| 905 | when :attr:`time.accept2dyear` is false and will accept four-digit years |
| 906 | otherwise. The :func:`time.mktime` and :func:`time.strftime` functions now |
| 907 | accept full range supported by the operating system. Conversion of two-digit |
| 908 | years to four-digit is deprecated. |
Alexander Belopolsky | bd96b06 | 2011-01-10 21:55:34 +0000 | [diff] [blame] | 909 | |
Raymond Hettinger | 9767365 | 2011-01-11 21:13:26 +0000 | [diff] [blame] | 910 | (Contributed by Alexander Belopolsky and Victor Stinner.) |
Alexander Belopolsky | bd96b06 | 2011-01-10 21:55:34 +0000 | [diff] [blame] | 911 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 912 | abc |
| 913 | --- |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 914 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 915 | The :mod:`abc` module now supports :func:`~abc.abstractclassmethod` and |
| 916 | :func:`~abc.abstractstaticmethod`. |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 917 | |
Raymond Hettinger | 7ec790d | 2011-01-18 00:19:30 +0000 | [diff] [blame] | 918 | These tools make it possible to define an :term:`abstract base class` that |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 919 | requires a particular :func:`classmethod` or :func:`staticmethod` to be |
Raymond Hettinger | 7ec790d | 2011-01-18 00:19:30 +0000 | [diff] [blame] | 920 | implemented:: |
| 921 | |
| 922 | class Temperature(metaclass=ABCMeta): |
| 923 | @abc.abstractclassmethod |
| 924 | def from_farenheit(self, t): |
| 925 | ... |
| 926 | @abc.abstractclassmethod |
| 927 | def from_celsium(self, t): |
| 928 | ... |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 929 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 930 | (Patch submitted by Daniel Urban; :issue:`5867`.) |
Raymond Hettinger | bcbd696 | 2010-09-05 08:46:36 +0000 | [diff] [blame] | 931 | |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 932 | contextlib |
| 933 | ---------- |
| 934 | |
| 935 | There is a new and slightly mind-blowing tool |
| 936 | :class:`~contextlib.ContextDecorator` that is helpful for creating a |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 937 | :term:`context manager` that does double duty as a function decorator. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 938 | |
| 939 | As a convenience, this new functionality is used by |
| 940 | :func:`~contextlib.contextmanager` so that no extra effort is needed to support |
| 941 | both roles. |
| 942 | |
| 943 | The basic idea is that both context managers and function decorators can be used |
| 944 | for pre-action and post-action wrappers. Context managers wrap a group of |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 945 | statements using a :keyword:`with` statement, and function decorators wrap a |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 946 | group of statements enclosed in a function. So, occasionally there is a need to |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 947 | write a pre-action or post-action wrapper that can be used in either role. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 948 | |
| 949 | For example, it is sometimes useful to wrap functions or groups of statements |
| 950 | with a logger that can track the time of entry and time of exit. Rather than |
| 951 | writing both a function decorator and a context manager for the task, the |
| 952 | :func:`~contextlib.contextmanager` provides both capabilities in a single |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 953 | definition:: |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 954 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 955 | import logging |
| 956 | logging.basicConfig(level=logging.INFO) |
| 957 | @contextmanager |
| 958 | def track_entry_and_exit(name): |
| 959 | logging.info('Entering: {}'.format(name)) |
| 960 | yield |
| 961 | logging.info('Exiting: {}'.format(name)) |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 962 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 963 | Formerly, this would have only been usable as a context manager:: |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 964 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 965 | with track_entry_and_exit('widget loader'): |
| 966 | print('Some time consuming activity goes here') |
| 967 | load_widget() |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 968 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 969 | Now, it can be used as a decorator as well:: |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 970 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 971 | @track_entry_and_exit('widget loader') |
| 972 | def activity(): |
| 973 | print('Some time consuming activity goes here') |
| 974 | load_widget() |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 975 | |
| 976 | Trying to fulfill two roles at once places some limitations on the technique. |
| 977 | Context managers normally have the flexibility to return an argument usable by |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 978 | a :keyword:`with` statement, but there is no parallel for function decorators. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 979 | |
Raymond Hettinger | 9743e4f | 2010-12-16 02:24:12 +0000 | [diff] [blame] | 980 | In the above example, there is not a clean way for the *track_entry_and_exit* |
Raymond Hettinger | 388af4b | 2011-01-06 20:55:29 +0000 | [diff] [blame] | 981 | context manager to return a logging instance for use in the body of enclosed |
| 982 | statements. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 983 | |
| 984 | (Contributed by Michael Foord in :issue:`9110`.) |
| 985 | |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 986 | decimal and fractions |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 987 | --------------------- |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 988 | |
| 989 | Mark Dickinson crafted an elegant and efficient scheme for assuring that |
| 990 | different numeric datatypes will have the same hash value whenever their actual |
| 991 | values are equal (:issue:`8188`):: |
| 992 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 993 | assert hash(Fraction(3, 2)) == hash(1.5) == \ |
| 994 | hash(Decimal("1.5")) == hash(complex(1.5, 0)) |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 995 | |
| 996 | An early decision to limit the inter-operability of various numeric types has |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 997 | been relaxed. It is still unsupported (and ill-advised) to have implicit |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 998 | mixing in arithmetic expressions such as ``Decimal('1.1') + float('1.1')`` |
| 999 | because the latter loses information in the process of constructing the binary |
| 1000 | float. However, since existing floating point value can be converted losslessly |
| 1001 | to either a decimal or rational representation, it makes sense to add them to |
| 1002 | the constructor and to support mixed-type comparisons. |
| 1003 | |
Raymond Hettinger | bb9686f | 2010-12-16 00:53:05 +0000 | [diff] [blame] | 1004 | * The :class:`decimal.Decimal` constructor now accepts :class:`float` objects |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1005 | directly so there in no longer a need to use the :meth:`~decimal.Decimal.from_float` |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1006 | method (:issue:`8257`). |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1007 | |
| 1008 | * Mixed type comparisons are now fully supported so that |
| 1009 | :class:`~decimal.Decimal` objects can be directly compared with :class:`float` |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1010 | and :class:`fractions.Fraction` (:issue:`2531` and :issue:`8188`). |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1011 | |
| 1012 | Similar changes were made to :class:`fractions.Fraction` so that the |
| 1013 | :meth:`~fractions.Fraction.from_float()` and :meth:`~fractions.Fraction.from_decimal` |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1014 | methods are no longer needed (:issue:`8294`): |
| 1015 | |
| 1016 | >>> Decimal(1.1) |
| 1017 | Decimal('1.100000000000000088817841970012523233890533447265625') |
| 1018 | >>> Fraction(1.1) |
| 1019 | Fraction(2476979795053773, 2251799813685248) |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1020 | |
| 1021 | Another useful change for the :mod:`decimal` module is that the |
| 1022 | :attr:`Context.clamp` attribute is now public. This is useful in creating |
| 1023 | contexts that correspond to the decimal interchange formats specified in IEEE |
| 1024 | 754 (see :issue:`8540`). |
| 1025 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1026 | (Contributed by Mark Dickinson and Raymond Hettinger.) |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1027 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1028 | ftp |
| 1029 | --- |
Raymond Hettinger | bcbd696 | 2010-09-05 08:46:36 +0000 | [diff] [blame] | 1030 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1031 | The :class:`ftplib.FTP` class now supports the context manager protocol to |
| 1032 | unconditionally consume :exc:`socket.error` exceptions and to close the FTP |
| 1033 | connection when done:: |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 1034 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1035 | >>> from ftplib import FTP |
| 1036 | >>> with FTP("ftp1.at.proftpd.org") as ftp: |
| 1037 | ... ftp.login() |
| 1038 | ... ftp.dir() |
| 1039 | ... |
| 1040 | '230 Anonymous login ok, restrictions apply.' |
| 1041 | dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 . |
| 1042 | dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .. |
| 1043 | dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS |
| 1044 | dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1045 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1046 | Other file-like objects such as :class:`mmap.mmap` and :func:`fileinput.input` |
| 1047 | also grew auto-closing context managers:: |
| 1048 | |
| 1049 | with fileinput.input(files=('log1.txt', 'log2.txt')) as f: |
| 1050 | for line in f: |
| 1051 | process(line) |
| 1052 | |
| 1053 | (Contributed by Tarek Ziadé and Giampaolo Rodolà in :issue:`4972`, and |
| 1054 | by Georg Brandl in :issue:`8046` and :issue:`1286`.) |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 1055 | |
Antoine Pitrou | bcba434 | 2011-01-16 18:29:34 +0000 | [diff] [blame] | 1056 | The :class:`~ftplib.FTP_TLS` class now accepts a *context* parameter, which is a |
| 1057 | :class:`ssl.SSLContext` object allowing bundling SSL configuration options, |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1058 | certificates and private keys into a single (potentially long-lived) structure. |
Antoine Pitrou | bcba434 | 2011-01-16 18:29:34 +0000 | [diff] [blame] | 1059 | |
| 1060 | (Contributed by Giampaolo Rodolà; :issue:`8806`.) |
| 1061 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1062 | popen |
| 1063 | ----- |
| 1064 | |
| 1065 | The :func:`os.popen` and :func:`subprocess.Popen` functions now support |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1066 | :keyword:`with` statements for auto-closing of the file descriptors. |
Georg Brandl | 3ad4675 | 2010-12-05 07:59:29 +0000 | [diff] [blame] | 1067 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1068 | gzip and zipfile |
| 1069 | ---------------- |
Antoine Pitrou | cd889af | 2010-10-06 21:13:56 +0000 | [diff] [blame] | 1070 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1071 | :class:`gzip.GzipFile` now implements the :class:`io.BufferedIOBase` |
| 1072 | :term:`abstract base class` (except for ``truncate()``). It also has a |
| 1073 | :meth:`~gzip.GzipFile.peek` method and supports unseekable as well as |
| 1074 | zero-padded file objects. |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1075 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1076 | The :mod:`gzip` module also gains the :func:`~gzip.compress` and |
| 1077 | :func:`~gzip.decompress` functions for easier in-memory compression and |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 1078 | decompression. Keep in mind that text needs to be encoded as :class:`bytes` |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1079 | before compressing and decompressing: |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1080 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1081 | >>> s = 'Three shall be the number thou shalt count, ' |
| 1082 | >>> s += 'and the number of the counting shall be three' |
| 1083 | >>> b = s.encode() # convert to utf-8 |
| 1084 | >>> len(b) |
| 1085 | 89 |
| 1086 | >>> c = gzip.compress(b) |
| 1087 | >>> len(c) |
| 1088 | 77 |
| 1089 | >>> gzip.decompress(c).decode()[:42] # decompress and convert to text |
| 1090 | 'Three shall be the number thou shalt count,' |
Antoine Pitrou | cd889af | 2010-10-06 21:13:56 +0000 | [diff] [blame] | 1091 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1092 | (Contributed by Anand B. Pillai in :issue:`3488`; and by Antoine Pitrou, Nir |
| 1093 | Aides and Brian Curtin in :issue:`9962`, :issue:`1675951`, :issue:`7471` and |
| 1094 | :issue:`2846`.) |
| 1095 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1096 | Also, the :class:`zipfile.ZipExtFile` class was reworked internally to represent |
| 1097 | files stored inside an archive. The new implementation is significantly faster |
| 1098 | and can be wrapped in a :class:`io.BufferedReader` object for more speedups. It |
| 1099 | also solves an issue where interleaved calls to *read* and *readline* gave the |
| 1100 | wrong results. |
| 1101 | |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 1102 | (Patch submitted by Nir Aides in :issue:`7610`.) |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1103 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1104 | shutil |
| 1105 | ------ |
| 1106 | |
| 1107 | The :func:`shutil.copytree` function has two new options: |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1108 | |
Antoine Pitrou | 121a055 | 2011-01-16 18:16:52 +0000 | [diff] [blame] | 1109 | * *ignore_dangling_symlinks*: when ``symlinks=False`` so that the function |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1110 | copies a file pointed to by a symlink, not the symlink itself. This option |
| 1111 | will silence the error raised if the file doesn't exist. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1112 | |
Antoine Pitrou | 121a055 | 2011-01-16 18:16:52 +0000 | [diff] [blame] | 1113 | * *copy_function*: is a callable that will be used to copy files. |
| 1114 | :func:`shutil.copy2` is used by default. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1115 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1116 | (Contributed by Tarek Ziadé.) |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1117 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1118 | sqlite3 |
| 1119 | ------- |
Antoine Pitrou | e43f9d0 | 2010-08-08 23:24:50 +0000 | [diff] [blame] | 1120 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1121 | The :mod:`sqlite3` module was updated to version 2.6.0. It has two new capabilities. |
Antoine Pitrou | e43f9d0 | 2010-08-08 23:24:50 +0000 | [diff] [blame] | 1122 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 1123 | * The :attr:`sqlite3.Connection.in_transit` attribute is true if there is an |
| 1124 | active transaction for uncommitted changes. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1125 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 1126 | * The :meth:`sqlite3.Connection.enable_load_extension` and |
| 1127 | :meth:`sqlite3.Connection.load_extension` methods allows you to load SQLite |
| 1128 | extensions from ".so" files. One well-known extension is the fulltext-search |
| 1129 | extension distributed with SQLite. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1130 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1131 | (Contributed by R. David Murray and Shashwat Anand; :issue:`8845`.) |
| 1132 | |
| 1133 | socket |
| 1134 | ------ |
| 1135 | |
| 1136 | The :mod:`socket` module has two new improvements. |
| 1137 | |
| 1138 | * Socket objects now have a :meth:`~socket.socket.detach()` method which puts |
| 1139 | the socket into closed state without actually closing the underlying file |
| 1140 | descriptor. The latter can then be reused for other purposes. |
| 1141 | (Added by Antoine Pitrou; :issue:`8524`.) |
| 1142 | |
| 1143 | * :func:`socket.create_connection` now supports the context manager protocol |
| 1144 | to unconditionally consume :exc:`socket.error` exceptions and to close the |
| 1145 | socket when done. |
| 1146 | (Contributed by Giampaolo Rodolà; :issue:`9794`.) |
| 1147 | |
| 1148 | ssl |
| 1149 | --- |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1150 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1151 | The :mod:`ssl` module added a number of features to satisfy common requirements |
| 1152 | for secure (encrypted, authenticated) internet connections: |
Antoine Pitrou | 33da1d6 | 2011-01-16 18:16:09 +0000 | [diff] [blame] | 1153 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1154 | * A new class, :class:`~ssl.SSLContext`, serves as a container for persistent |
| 1155 | SSL data, such as protocol settings, certificates, private keys, and various |
| 1156 | other options. It includes a :meth:`~ssl.SSLContext.wrap_socket` for creating |
| 1157 | an SSL socket from an SSL context. |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 1158 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1159 | * A new function, :func:`ssl.match_hostname`, supports server identity |
| 1160 | verification for higher-level protocols by implementing the rules of HTTPS |
| 1161 | (from :rfc:`2818`) which are also suitable for other protocols. |
Antoine Pitrou | 0ee4c9f | 2010-10-08 16:46:17 +0000 | [diff] [blame] | 1162 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1163 | * The :func:`ssl.wrap_socket` constructor function now takes a *ciphers* |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1164 | argument. The *ciphers* string lists the allowed encryption algorithms using |
| 1165 | the format described in the `OpenSSL documentation |
| 1166 | <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT>`__. |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 1167 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1168 | * When linked against recent versions of OpenSSL, the :mod:`ssl` module now |
| 1169 | supports the Server Name Indication extension to the TLS protocol, allowing |
| 1170 | multiple "virtual hosts" using different certificates on a single IP port. |
| 1171 | This extension is only supported in client mode, and is activated by passing |
| 1172 | the *server_hostname* argument to :meth:`ssl.SSLContext.wrap_socket`. |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 1173 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1174 | * Various options have been added to the :mod:`ssl` module, such as |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1175 | :data:`~ssl.OP_NO_SSLv2` which disables the insecure and obsolete SSLv2 |
| 1176 | protocol. |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 1177 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1178 | * The extension now loads all the OpenSSL ciphers and digest algorithms. If |
| 1179 | some SSL certificates cannot be verified, they are reported as an "unknown |
| 1180 | algorithm" error. |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 1181 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1182 | * The version of OpenSSL being used is now accessible using the module |
| 1183 | attributes :data:`ssl.OPENSSL_VERSION` (a string), |
| 1184 | :data:`ssl.OPENSSL_VERSION_INFO` (a 5-tuple), and |
| 1185 | :data:`ssl.OPENSSL_VERSION_NUMBER` (an integer). |
| 1186 | |
| 1187 | (Contributed by Antoine Pitrou in :issue:`8850`, :issue:`1589`, :issue:`8322`, |
| 1188 | :issue:`5639`, :issue:`4870`, :issue:`8484`, and :issue:`8321`.) |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 1189 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1190 | nntp |
| 1191 | ---- |
Raymond Hettinger | 070ec70 | 2010-12-10 17:45:13 +0000 | [diff] [blame] | 1192 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1193 | The :mod:`nntplib` module has a revamped implementation with better bytes and |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1194 | text semantics as well as more practical APIs. These improvements break |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1195 | compatibility with the nntplib version in Python 3.1, which was partly |
| 1196 | dysfunctional in itself. |
Raymond Hettinger | 070ec70 | 2010-12-10 17:45:13 +0000 | [diff] [blame] | 1197 | |
Antoine Pitrou | 33da1d6 | 2011-01-16 18:16:09 +0000 | [diff] [blame] | 1198 | Support for secure connections through both implicit (using |
| 1199 | :class:`nntplib.NNTP_SSL`) and explicit (using :meth:`nntplib.NNTP.starttls`) |
| 1200 | TLS has also been added. |
| 1201 | |
| 1202 | (Contributed by Antoine Pitrou in :issue:`9360` and Andrew Vant in :issue:`1926`.) |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1203 | |
| 1204 | certificates |
| 1205 | ------------ |
| 1206 | |
| 1207 | :class:`http.client.HTTPSConnection`, :class:`urllib.request.HTTPSHandler` |
| 1208 | and :func:`urllib.request.urlopen` now take optional arguments to allow for |
| 1209 | server certificate checking against a set of Certificate Authorities, |
| 1210 | as recommended in public uses of HTTPS. |
| 1211 | |
| 1212 | (Added by Antoine Pitrou, :issue:`9003`.) |
| 1213 | |
Antoine Pitrou | 2e8ec22 | 2011-01-16 18:41:36 +0000 | [diff] [blame] | 1214 | imaplib |
| 1215 | ------- |
| 1216 | |
| 1217 | Support for explicit TLS on standard IMAP4 connections has been added through |
| 1218 | the new :mod:`imaplib.IMAP4.starttls` method. |
| 1219 | |
| 1220 | (Contributed by Lorenzo M. Catucci and Antoine Pitrou, :issue:`4471`.) |
| 1221 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1222 | unittest |
| 1223 | -------- |
Antoine Pitrou | afb078d | 2010-11-05 22:18:28 +0000 | [diff] [blame] | 1224 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1225 | The unittest module has a number of improvements supporting test discovery for |
| 1226 | packages, easier experimentation at the interactive prompt, new testcase |
| 1227 | methods, improved diagnostic messages for test failures, and better method |
| 1228 | names. |
| 1229 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1230 | * The command-line call ``python -m unittest`` can now accept file paths |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1231 | instead of module names for running specific tests (:issue:`10620`). The new |
| 1232 | test discovery can find tests within packages, locating any test importable |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1233 | from the top-level directory. The top-level directory can be specified with |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1234 | the `-t` option, a pattern for matching files with ``-p``, and a directory to |
| 1235 | start discovery with ``-s``:: |
| 1236 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1237 | $ python -m unittest discover -s my_proj_dir -p _test.py |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1238 | |
| 1239 | (Contributed by Michael Foord.) |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1240 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1241 | * Experimentation at the interactive prompt is now easier because the |
| 1242 | :class:`unittest.case.TestCase` class can now be instantiated without |
| 1243 | arguments: |
| 1244 | |
| 1245 | >>> TestCase().assertEqual(pow(2, 3), 8) |
| 1246 | |
| 1247 | (Contributed by Michael Foord.) |
| 1248 | |
Raymond Hettinger | dc2f9b5 | 2010-12-05 07:02:45 +0000 | [diff] [blame] | 1249 | * The :mod:`unittest` module has two new methods, |
| 1250 | :meth:`~unittest.TestCase.assertWarns` and |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1251 | :meth:`~unittest.TestCase.assertWarnsRegex` to verify that a given warning type |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1252 | is triggered by the code under test:: |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1253 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1254 | with self.assertWarns(DeprecationWarning): |
| 1255 | legacy_function('XYZ') |
Ezio Melotti | 2baf1a6 | 2010-11-22 12:56:58 +0000 | [diff] [blame] | 1256 | |
Antoine Pitrou | eec6dbf | 2011-01-16 18:21:12 +0000 | [diff] [blame] | 1257 | (Contributed by Antoine Pitrou, :issue:`9754`.) |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1258 | |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 1259 | Another new method, :meth:`~unittest.TestCase.assertCountEqual` is used to |
Raymond Hettinger | ffad35e | 2010-12-14 21:12:03 +0000 | [diff] [blame] | 1260 | compare two iterables to determine if their element counts are equal (whether |
| 1261 | the same elements are present with the same number of occurrences regardless |
| 1262 | of order):: |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1263 | |
| 1264 | def test_anagram(self): |
| 1265 | self.assertCountEqual('algorithm', 'logarithm') |
| 1266 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1267 | (Contributed by Raymond Hettinger.) |
| 1268 | |
| 1269 | * A principal feature of the unittest module is an effort to produce meaningful |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1270 | diagnostics when a test fails. When possible, the failure is recorded along |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1271 | with a diff of the output. This is especially helpful for analyzing log files |
| 1272 | of failed test runs. However, since diffs can sometime be voluminous, there is |
| 1273 | a new :attr:`~unittest.TestCase.maxDiff` attribute which sets maximum length of |
| 1274 | diffs. |
| 1275 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1276 | * In addition, the method names in the module have undergone a number of clean-ups. |
| 1277 | |
| 1278 | For example, :meth:`~unittest.TestCase.assertRegex` is the new name for |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1279 | :meth:`~unittest.TestCase.assertRegexpMatches` which was misnamed because the |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 1280 | test uses :func:`re.search`, not :func:`re.match`. Other methods using |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1281 | regular expressions are now named using short form "Regex" in preference to |
| 1282 | "Regexp" -- this matches the names used in other unittest implementations, |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 1283 | matches Python's old name for the :mod:`re` module, and it has unambiguous |
| 1284 | camel-casing. |
Raymond Hettinger | dc2f9b5 | 2010-12-05 07:02:45 +0000 | [diff] [blame] | 1285 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1286 | (Contributed by Raymond Hettinger and implemented by Ezio Melotti.) |
| 1287 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1288 | * To improve consistency, some long-standing method aliases are being |
Raymond Hettinger | dc2f9b5 | 2010-12-05 07:02:45 +0000 | [diff] [blame] | 1289 | deprecated in favor of the preferred names: |
| 1290 | |
| 1291 | - replace :meth:`assert_` with :meth:`.assertTrue` |
| 1292 | - replace :meth:`assertEquals` with :meth:`.assertEqual` |
| 1293 | - replace :meth:`assertNotEquals` with :meth:`.assertNotEqual` |
| 1294 | - replace :meth:`assertAlmostEquals` with :meth:`.assertAlmostEqual` |
| 1295 | - replace :meth:`assertNotAlmostEquals` with :meth:`.assertNotAlmostEqual` |
| 1296 | |
| 1297 | Likewise, the ``TestCase.fail*`` methods deprecated in Python 3.1 are expected |
| 1298 | to be removed in Python 3.3. See also the :ref:`deprecated-aliases` section in |
| 1299 | the :mod:`unittest` documentation. |
Ezio Melotti | 2baf1a6 | 2010-11-22 12:56:58 +0000 | [diff] [blame] | 1300 | |
| 1301 | (Contributed by Ezio Melotti; :issue:`9424`.) |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1302 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1303 | * The :meth:`~unittest.TestCase.assertDictContainsSubset` method was deprecated |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 1304 | because it was misimplemented with the arguments in the wrong order. This |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1305 | created hard-to-debug optical illusions where tests like |
| 1306 | ``TestCase().assertDictContainsSubset({'a':1, 'b':2}, {'a':1})`` would fail. |
| 1307 | |
| 1308 | (Contributed by Raymond Hettinger.) |
| 1309 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1310 | random |
| 1311 | ------ |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 1312 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 1313 | The integer methods in the :mod:`random` module now do a better job of producing |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 1314 | uniform distributions. Previously, they computed selections with |
| 1315 | ``int(n*random())`` which had a slight bias whenever *n* was not a power of two. |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1316 | Now, multiple selections are made from a range up to the next power of two and a |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 1317 | selection is kept only when it falls within the range ``0 <= x < n``. The |
| 1318 | functions and methods affected are :func:`~random.randrange`, |
| 1319 | :func:`~random.randint`, :func:`~random.choice`, :func:`~random.shuffle` and |
| 1320 | :func:`~random.sample`. |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1321 | |
| 1322 | (Contributed by Raymond Hettinger; :issue:`9025`.) |
| 1323 | |
| 1324 | poplib |
| 1325 | ------ |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 1326 | |
Giampaolo Rodolà | 42382fe | 2010-08-17 16:09:53 +0000 | [diff] [blame] | 1327 | * :class:`~poplib.POP3_SSL` class now accepts a *context* parameter, which is a |
| 1328 | :class:`ssl.SSLContext` object allowing bundling SSL configuration options, |
| 1329 | certificates and private keys into a single (potentially long-lived) |
| 1330 | structure. |
| 1331 | |
| 1332 | (Contributed by Giampaolo Rodolà; :issue:`8807`.) |
| 1333 | |
Giampaolo Rodolà | 977c707 | 2010-10-04 21:08:36 +0000 | [diff] [blame] | 1334 | * :class:`asyncore.dispatcher` now provides a |
| 1335 | :meth:`~asyncore.dispatcher.handle_accepted()` method |
| 1336 | returning a `(sock, addr)` pair which is called when a connection has actually |
| 1337 | been established with a new remote endpoint. This is supposed to be used as a |
| 1338 | replacement for old :meth:`~asyncore.dispatcher.handle_accept()` and avoids |
| 1339 | the user to call :meth:`~asyncore.dispatcher.accept()` directly. |
| 1340 | |
| 1341 | (Contributed by Giampaolo Rodolà; :issue:`6706`.) |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1342 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1343 | tempfile |
| 1344 | -------- |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1345 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1346 | The :mod:`tempfile` module has a new context manager, |
| 1347 | :class:`~tempfile.TemporaryDirectory` which provides easy deterministic |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1348 | cleanup of temporary directories:: |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1349 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1350 | with tempfile.TemporaryDirectory() as tmpdirname: |
| 1351 | print('created temporary dir:', tmpdirname) |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1352 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1353 | (Contributed by Neil Schemenauer and Nick Coghlan; :issue:`5178`.) |
Nick Coghlan | e0f0465 | 2010-11-21 03:44:04 +0000 | [diff] [blame] | 1354 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1355 | inspect |
| 1356 | ------- |
| 1357 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 1358 | * The :mod:`inspect` module has a new function |
| 1359 | :func:`~inspect.getgeneratorstate` to easily identify the current state of a |
| 1360 | generator as one of ``GEN_CREATED``, ``GEN_RUNNING``, ``GEN_SUSPENDED`` or |
| 1361 | ``GEN_CLOSED``. (Contributed by Rodolpho Eckhardt and Nick Coghlan, |
| 1362 | :issue:`10220`.) |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1363 | |
Raymond Hettinger | a55ffbc | 2010-12-15 18:31:57 +0000 | [diff] [blame] | 1364 | * To support lookups without the possibility of activating a dynamic attribute, |
| 1365 | the :mod:`inspect` module has a new function, :func:`~inspect.getattr_static`. |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 1366 | Unlike :func:`hasattr`, this is a true read-only search, guaranteed not to |
Raymond Hettinger | a55ffbc | 2010-12-15 18:31:57 +0000 | [diff] [blame] | 1367 | change state while it is searching. (Contributed by Michael Foord.) |
Nick Coghlan | e0f0465 | 2010-11-21 03:44:04 +0000 | [diff] [blame] | 1368 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1369 | pydoc |
| 1370 | ----- |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 1371 | |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1372 | The :mod:`pydoc` module now provides a much-improved Web server interface, |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1373 | as well as a new command-line option to automatically open a browser |
| 1374 | window to display that server. |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 1375 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1376 | (Contributed by Ron Adam; :issue:`2001`.) |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1377 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1378 | sysconfig |
| 1379 | --------- |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1380 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1381 | The new :mod:`sysconfig` module makes it straightforward to discover |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1382 | installation paths and configuration variables which vary across platforms and |
| 1383 | installations. |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1384 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1385 | The module offers access simple access functions for platform and version |
| 1386 | information: |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1387 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1388 | * :func:`~sysconfig.get_platform` returning values like *linux-i586* or |
| 1389 | *macosx-10.6-ppc*. |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1390 | * :func:`~sysconfig.get_python_version` returns a Python version string |
| 1391 | such as "3.2". |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1392 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1393 | It also provides access to the paths and variables corresponding to one of |
| 1394 | seven named schemes used by :mod:`distutils`. Those include *posix_prefix*, |
| 1395 | *posix_home*, *posix_user*, *nt*, *nt_user*, *os2*, *os2_home*: |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1396 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1397 | * :func:`~sysconfig.get_paths` makes a dictionary containing installation paths |
| 1398 | for the current installation scheme. |
| 1399 | * :func:`~sysconfig.get_config_vars` returns a dictionary of platform specific |
| 1400 | variables. |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1401 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1402 | There is also a convenient command-line interface:: |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1403 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1404 | C:\Python32>python -m sysconfig |
| 1405 | Platform: "win32" |
| 1406 | Python version: "3.2" |
| 1407 | Current installation scheme: "nt" |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1408 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1409 | Paths: |
| 1410 | data = "C:\Python32" |
Łukasz Langa | 79a06ed | 2010-12-17 22:05:46 +0000 | [diff] [blame] | 1411 | include = "C:\Python32\Include" |
| 1412 | platinclude = "C:\Python32\Include" |
| 1413 | platlib = "C:\Python32\Lib\site-packages" |
| 1414 | platstdlib = "C:\Python32\Lib" |
| 1415 | purelib = "C:\Python32\Lib\site-packages" |
| 1416 | scripts = "C:\Python32\Scripts" |
| 1417 | stdlib = "C:\Python32\Lib" |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1418 | |
| 1419 | Variables: |
| 1420 | BINDIR = "C:\Python32" |
Łukasz Langa | 79a06ed | 2010-12-17 22:05:46 +0000 | [diff] [blame] | 1421 | BINLIBDEST = "C:\Python32\Lib" |
| 1422 | EXE = ".exe" |
| 1423 | INCLUDEPY = "C:\Python32\Include" |
| 1424 | LIBDEST = "C:\Python32\Lib" |
| 1425 | SO = ".pyd" |
| 1426 | VERSION = "32" |
| 1427 | abiflags = "" |
| 1428 | base = "C:\Python32" |
| 1429 | exec_prefix = "C:\Python32" |
| 1430 | platbase = "C:\Python32" |
| 1431 | prefix = "C:\Python32" |
| 1432 | projectbase = "C:\Python32" |
| 1433 | py_version = "3.2" |
| 1434 | py_version_nodot = "32" |
| 1435 | py_version_short = "3.2" |
| 1436 | srcdir = "C:\Python32" |
| 1437 | userbase = "C:\Documents and Settings\Raymond\Application Data\Python" |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1438 | |
| 1439 | pdb |
| 1440 | --- |
| 1441 | |
| 1442 | The :mod:`pdb` debugger module gained a number of usability improvements: |
Raymond Hettinger | b5d7933 | 2010-12-07 02:04:56 +0000 | [diff] [blame] | 1443 | |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 1444 | * :file:`pdb.py` now has a ``-c`` option that executes commands as given in a |
| 1445 | :file:`.pdbrc` script file. |
| 1446 | * A :file:`.pdbrc` script file can contain ``continue`` and ``next`` commands |
| 1447 | that continue debugging. |
| 1448 | * The :class:`Pdb` class constructor now accepts a *nosigint* argument. |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 1449 | * New commands: ``l(list)``, ``ll(long list)`` and ``source`` for |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 1450 | listing source code. |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1451 | * New commands: ``display`` and ``undisplay`` for showing or hiding |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 1452 | the value of an expression if it has changed. |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1453 | * New command: ``interact`` for starting an interactive interpreter containing |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 1454 | the global and local names found in the current scope. |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1455 | * Breakpoints can be cleared by breakpoint number. |
Raymond Hettinger | b5d7933 | 2010-12-07 02:04:56 +0000 | [diff] [blame] | 1456 | |
Georg Brandl | 101234b | 2010-12-18 11:53:25 +0000 | [diff] [blame] | 1457 | (Contributed by Georg Brandl, Antonio Cuni and Ilya Sandler.) |
| 1458 | |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1459 | configparser |
| 1460 | ------------ |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1461 | |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1462 | The :mod:`configparser` module was modified to improve usability and |
| 1463 | predictability of the default parser and its supported INI syntax. The old |
| 1464 | :class:`ConfigParser` class was removed in favor of :class:`SafeConfigParser` |
Raymond Hettinger | 0412974 | 2010-12-18 10:57:50 +0000 | [diff] [blame] | 1465 | which has in turn been renamed to :class:`~configparser.ConfigParser`. Support |
| 1466 | for inline comments is now turned off by default and section or option |
| 1467 | duplicates are not allowed in a single configuration source. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1468 | |
| 1469 | Config parsers gained a new API based on the mapping protocol:: |
| 1470 | |
Raymond Hettinger | 02dd70b | 2011-01-17 23:39:39 +0000 | [diff] [blame] | 1471 | >>> parser = ConfigParser() |
| 1472 | >>> parser.read_string(""" |
| 1473 | [DEFAULT] |
| 1474 | location = upper left |
| 1475 | visible = yes |
| 1476 | editable = no |
| 1477 | color = blue |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1478 | |
Raymond Hettinger | 02dd70b | 2011-01-17 23:39:39 +0000 | [diff] [blame] | 1479 | [main] |
| 1480 | title = Main Menu |
| 1481 | color = green |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1482 | |
Raymond Hettinger | 02dd70b | 2011-01-17 23:39:39 +0000 | [diff] [blame] | 1483 | [options] |
| 1484 | title = Options |
| 1485 | """) |
| 1486 | >>> parser['main']['color'] |
| 1487 | 'green' |
| 1488 | >>> parser['main']['editable'] |
| 1489 | 'no' |
| 1490 | >>> section = parser['options'] |
| 1491 | >>> section['title'] |
| 1492 | 'Options' |
| 1493 | >>> section['title'] = 'Options (editable: %(editable)s)' |
| 1494 | >>> section['title'] |
| 1495 | 'Options (editable: no)' |
| 1496 | |
| 1497 | The new API is implemented on top of the classical API, so custom parser |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1498 | subclasses should be able to use it without modifications. |
| 1499 | |
| 1500 | The INI file structure accepted by config parsers can now be customized. Users |
Raymond Hettinger | 0412974 | 2010-12-18 10:57:50 +0000 | [diff] [blame] | 1501 | can specify alternative option/value delimiters and comment prefixes, change the |
Raymond Hettinger | 02dd70b | 2011-01-17 23:39:39 +0000 | [diff] [blame] | 1502 | name of the *DEFAULT* section or switch the interpolation syntax. |
| 1503 | |
Raymond Hettinger | ba5512f | 2011-01-18 08:28:01 +0000 | [diff] [blame] | 1504 | There is support for pluggable interpolation including an additional interpolation |
Raymond Hettinger | 02dd70b | 2011-01-17 23:39:39 +0000 | [diff] [blame] | 1505 | handler :class:`~configparser.ExtendedInterpolation`:: |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1506 | |
| 1507 | >>> parser = ConfigParser(interpolation=ExtendedInterpolation()) |
| 1508 | >>> parser.read_dict({'buildout': {'directory': '/home/ambv/zope9'}, |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1509 | 'custom': {'prefix': '/usr/local'}}) |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1510 | >>> parser.read_string(""" |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1511 | [buildout] |
| 1512 | parts = |
| 1513 | zope9 |
| 1514 | instance |
| 1515 | find-links = |
| 1516 | ${buildout:directory}/downloads/dist |
| 1517 | |
| 1518 | [zope9] |
| 1519 | recipe = plone.recipe.zope9install |
| 1520 | location = /opt/zope |
| 1521 | |
| 1522 | [instance] |
| 1523 | recipe = plone.recipe.zope9instance |
| 1524 | zope9-location = ${zope9:location} |
| 1525 | zope-conf = ${custom:prefix}/etc/zope.conf |
| 1526 | """) |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1527 | >>> parser['buildout']['find-links'] |
| 1528 | '\n/home/ambv/zope9/downloads/dist' |
| 1529 | >>> parser['instance']['zope-conf'] |
| 1530 | '/usr/local/etc/zope.conf' |
| 1531 | >>> instance = parser['instance'] |
| 1532 | >>> instance['zope-conf'] |
| 1533 | '/usr/local/etc/zope.conf' |
| 1534 | >>> instance['zope9-location'] |
| 1535 | '/opt/zope' |
| 1536 | |
| 1537 | A number of smaller features were also introduced, like support for specifying |
Raymond Hettinger | 0412974 | 2010-12-18 10:57:50 +0000 | [diff] [blame] | 1538 | encoding in read operations, specifying fallback values for get-functions, or |
| 1539 | reading directly from dictionaries and strings. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1540 | |
| 1541 | (All changes contributed by Łukasz Langa.) |
| 1542 | |
Raymond Hettinger | a55ffbc | 2010-12-15 18:31:57 +0000 | [diff] [blame] | 1543 | .. XXX: Mention urllib.parse changes |
| 1544 | Issue 9873 (Nick Coghlan): |
| 1545 | - ASCII byte sequence support in URL parsing |
| 1546 | - named tuple for urldefrag return value |
| 1547 | Issue 5468 (Dan Mahn) for urlencode: |
| 1548 | - bytes input support |
| 1549 | - non-UTF8 percent encoding of non-ASCII characters |
| 1550 | Issue 2987 for IPv6 (RFC2732) support in urlparse |
Raymond Hettinger | 3df4621 | 2011-01-06 02:01:26 +0000 | [diff] [blame] | 1551 | |
Raymond Hettinger | a55ffbc | 2010-12-15 18:31:57 +0000 | [diff] [blame] | 1552 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 1553 | Multi-threading |
| 1554 | =============== |
| 1555 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1556 | * The mechanism for serializing execution of concurrently running Python threads |
Raymond Hettinger | ba5512f | 2011-01-18 08:28:01 +0000 | [diff] [blame] | 1557 | (generally known as the :term:`GIL` or :term:`Global Interpreter Lock`) has |
| 1558 | been rewritten. Among the objectives were more predictable switching |
| 1559 | intervals and reduced overhead due to lock contention and the number of |
| 1560 | ensuing system calls. The notion of a "check interval" to allow thread |
| 1561 | switches has been abandoned and replaced by an absolute duration expressed in |
| 1562 | seconds. This parameter is tunable through :func:`sys.setswitchinterval()`. |
| 1563 | It currently defaults to 5 milliseconds. |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 1564 | |
| 1565 | Additional details about the implementation can be read from a `python-dev |
| 1566 | mailing-list message |
| 1567 | <http://mail.python.org/pipermail/python-dev/2009-October/093321.html>`_ |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1568 | (however, "priority requests" as exposed in this message have not been kept |
| 1569 | for inclusion). |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 1570 | |
Georg Brandl | 5e73a81 | 2010-04-22 07:02:51 +0000 | [diff] [blame] | 1571 | (Contributed by Antoine Pitrou.) |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 1572 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1573 | * Regular and recursive locks now accept an optional *timeout* argument to their |
Raymond Hettinger | ba5512f | 2011-01-18 08:28:01 +0000 | [diff] [blame] | 1574 | :meth:`~threading.Lock.acquire` method. (Contributed by Antoine Pitrou; |
| 1575 | :issue:`7316`.) |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1576 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1577 | * Similarly, :meth:`threading.Semaphore.acquire` also gained a *timeout* |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1578 | argument. (Contributed by Torsten Landschoff; :issue:`850728`.) |
Antoine Pitrou | e95a9ff | 2010-05-04 23:31:41 +0000 | [diff] [blame] | 1579 | |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 1580 | * Regular and recursive lock acquisitions can now be interrupted by signals on |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1581 | platforms using Pthreads. This means that Python programs that deadlock while |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 1582 | acquiring locks can be successfully killed by repeatedly sending SIGINT to the |
Georg Brandl | eebb252 | 2010-12-18 12:01:15 +0000 | [diff] [blame] | 1583 | process (by pressing :kbd:`Ctrl+C` in most shells). |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 1584 | (Contributed by Reid Kleckner; :issue:`8844`.) |
| 1585 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 1586 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 1587 | Optimizations |
| 1588 | ============= |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1589 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 1590 | A number of small performance enhancements have been added: |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1591 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1592 | * 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] | 1593 | being a test for membership in a set of constants. The optimizer recasts the |
| 1594 | :class:`set` as a :class:`frozenset` and stores the pre-built constant. |
| 1595 | |
| 1596 | Now that the speed penalty is gone, it is practical to start writing |
| 1597 | membership tests using set-notation. This style is both semantically clear |
| 1598 | and operationally fast:: |
| 1599 | |
| 1600 | extension = name.rpartition('.')[2] |
| 1601 | if extension in {'xml', 'html', 'xhtml', 'css'}: |
| 1602 | handle(name) |
| 1603 | |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1604 | (Patch and additional tests contributed by Dave Malcolm; :issue:`6690`). |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 1605 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1606 | * Serializing and unserializing data using the :mod:`pickle` module is now |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 1607 | several times faster. |
| 1608 | |
| 1609 | (Contributed by Alexandre Vassalotti, Antoine Pitrou |
Antoine Pitrou | ff150f2 | 2010-10-22 21:41:05 +0000 | [diff] [blame] | 1610 | and the Unladen Swallow team in :issue:`9410` and :issue:`3873`.) |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1611 | |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 1612 | * The `Timsort algorithm <http://en.wikipedia.org/wiki/Timsort>`_ used in |
Raymond Hettinger | ffad35e | 2010-12-14 21:12:03 +0000 | [diff] [blame] | 1613 | :meth:`list.sort` and :func:`sorted` now runs faster and uses less memory |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 1614 | when called with a :term:`key function`. Previously, every element of |
| 1615 | a list was wrapped with a temporary object that remembered the key value |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1616 | associated with each element. Now, two arrays of keys and values are |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1617 | sorted in parallel. This saves the memory consumed by the sort wrappers, |
| 1618 | and it saves time lost to delegating comparisons. |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 1619 | |
Raymond Hettinger | eb70b90 | 2011-01-10 21:26:49 +0000 | [diff] [blame] | 1620 | (Patch by Daniel Stutzbach in :issue:`9915`.) |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 1621 | |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 1622 | * JSON decoding performance is improved and memory consumption is reduced |
Raymond Hettinger | 413abbc | 2010-12-05 07:06:47 +0000 | [diff] [blame] | 1623 | whenever the same string is repeated for multiple keys. Also, JSON encoding |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 1624 | now uses the C speedups when the ``sort_keys`` argument is true. |
| 1625 | |
| 1626 | (Contributed by Antoine Pitrou in :issue:`7451` and by Raymond Hettinger and |
| 1627 | Antoine Pitrou in :issue:`10314`.) |
| 1628 | |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 1629 | * Recursive locks (created with the :func:`threading.RLock` API) now benefit |
| 1630 | from a C implementation which makes them as fast as regular locks, and between |
| 1631 | 10x and 15x faster than their previous pure Python implementation. |
| 1632 | |
| 1633 | (Contributed by Antoine Pitrou; :issue:`3001`.) |
| 1634 | |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 1635 | * The fast-search algorithm in stringlib is now used by the :meth:`split`, |
| 1636 | :meth:`rsplit`, :meth:`splitlines` and :meth:`replace` methods on |
| 1637 | :class:`bytes`, :class:`bytearray` and :class:`str` objects. Likewise, the |
| 1638 | algorithm is also used by :meth:`rfind`, :meth:`rindex`, :meth:`rsplit` and |
| 1639 | :meth:`rpartition`. |
| 1640 | |
| 1641 | (Patch by Florent Xicluna in :issue:`7622` and :issue:`7462`.) |
| 1642 | |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1643 | |
| 1644 | * String to integer conversions now work two "digits" at a time, reducing the |
| 1645 | number of division and modulo operations. |
| 1646 | |
| 1647 | (:issue:`6713` by Gawain Bolton, Mark Dickinson, and Victor Stinner.) |
| 1648 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 1649 | There were several other minor optimizations. Set differencing now runs faster |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1650 | when one operand is much larger than the other (patch by Andress Bennetts in |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 1651 | :issue:`8685`). The :meth:`array.repeat` method has a faster implementation |
| 1652 | (:issue:`1569291` by Alexander Belopolsky). The :class:`BaseHTTPRequestHandler` |
| 1653 | has more efficient buffering (:issue:`3709` by Andrew Schaaf). The |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1654 | multi-argument form of :func:`operator.attrgetter` function now runs slightly |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 1655 | faster (:issue:`10160` by Christos Georgiou). And :class:`ConfigParser` loads |
| 1656 | multi-line arguments a bit faster (:issue:`7113` by Łukasz Langa). |
| 1657 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1658 | |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 1659 | Unicode |
| 1660 | ======= |
Victor Stinner | 94908bb | 2010-08-18 21:23:25 +0000 | [diff] [blame] | 1661 | |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 1662 | Python has been updated to Unicode 6.0.0. The new features of the |
| 1663 | Unicode Standard that will affect Python users include: |
| 1664 | |
Alexander Belopolsky | 84cc062 | 2010-12-08 21:38:46 +0000 | [diff] [blame] | 1665 | * addition of 2,088 characters, including over 1,000 additional |
| 1666 | symbols—chief among them the additional emoji symbols, which are |
| 1667 | especially important for mobile phones; |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 1668 | |
Alexander Belopolsky | 84cc062 | 2010-12-08 21:38:46 +0000 | [diff] [blame] | 1669 | * changes to character properties for existing characters including |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 1670 | |
Raymond Hettinger | c74d518 | 2010-12-02 01:38:25 +0000 | [diff] [blame] | 1671 | - a general category change to two Kannada characters (U+0CF1, |
| 1672 | U+0CF2), which has the effect of making them newly eligible for |
| 1673 | inclusion in identifiers; |
| 1674 | |
| 1675 | - a general category change to one New Tai Lue numeric character |
Alexander Belopolsky | 84cc062 | 2010-12-08 21:38:46 +0000 | [diff] [blame] | 1676 | (U+19DA), which has the effect of disqualifying it from |
| 1677 | inclusion in identifiers. |
| 1678 | |
| 1679 | For more information, see `Unicode Character Database Changes |
| 1680 | <http://www.unicode.org/versions/Unicode6.0.0/#Database_Changes>`_ |
| 1681 | at the `Unicode Consortium <http://www.unicode.org/>`_ web site. |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 1682 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 1683 | The :mod:`os` module has two new functions: :func:`~os.fsencode` and |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 1684 | :func:`~os.fsdecode`. Add :data:`os.environb`: bytes version of |
| 1685 | :data:`os.environ`, :func:`os.getenvb` function and |
| 1686 | :data:`os.supports_bytes_environ` constant. |
Victor Stinner | e8d5145 | 2010-08-19 01:05:19 +0000 | [diff] [blame] | 1687 | |
Raymond Hettinger | 23ab101 | 2011-01-18 20:25:04 +0000 | [diff] [blame^] | 1688 | MBCS encoding doesn't ignore the error handler argument any more. By |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 1689 | default (strict mode), it raises an UnicodeDecodeError on undecodable byte |
Raymond Hettinger | 23ab101 | 2011-01-18 20:25:04 +0000 | [diff] [blame^] | 1690 | sequence and UnicodeEncodeError on unencodable character. To get the MBCS |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 1691 | encoding of Python 3.1, use ``'ignore'`` error handler to decode and |
Raymond Hettinger | 23ab101 | 2011-01-18 20:25:04 +0000 | [diff] [blame^] | 1692 | ``'replace'`` error handler to encode. The MBCS codec supports ``'strict'`` and |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 1693 | ``'ignore'`` error handlers for decoding, and ``'strict'`` and ``'replace'`` |
| 1694 | for encoding. |
| 1695 | |
| 1696 | On Mac OS X, Python uses ``'utf-8'`` to decode the command line arguments, |
| 1697 | instead of the locale encoding (which is ISO-8859-1 if the ``LANG`` environment |
| 1698 | variable is not set). |
| 1699 | |
| 1700 | By default, tarfile uses ``'utf-8'`` encoding on Windows (instead of |
| 1701 | ``'mbcs'``), and the ``'surrogateescape'`` error handler on all operating |
| 1702 | systems. |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1703 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1704 | Also, support was added for *cp720* Arabic DOS encoding (:issue:`1616979`). |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1705 | |
Victor Stinner | 94908bb | 2010-08-18 21:23:25 +0000 | [diff] [blame] | 1706 | |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 1707 | Documentation |
| 1708 | ============= |
| 1709 | |
| 1710 | The documentation continues to be improved. |
| 1711 | |
| 1712 | A table of quick links has been added to the top of lengthy sections such as |
| 1713 | :ref:`built-in-funcs`. In the case of :mod:`itertools`, the links are |
| 1714 | accompanied by tables of cheatsheet-style summaries to provide an overview and |
| 1715 | memory jog without having to read all of the docs. |
| 1716 | |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 1717 | In some cases, the pure Python source code can be a helpful adjunct to the |
| 1718 | documentation, so now many modules now feature quick links to the latest version |
| 1719 | of the source code. For example, the :mod:`functools` module documentation has |
| 1720 | a quick link at the top labeled: **Source code** :source:`Lib/functools.py`. |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 1721 | |
| 1722 | The docs now contain more examples and recipes. In particular, :mod:`re` module |
| 1723 | has an extensive section, :ref:`re-examples`. Likewise, the :mod:`itertools` |
| 1724 | module continues to be updated with new :ref:`itertools-recipes`. |
| 1725 | |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 1726 | The :mod:`datetime` module now has an auxiliary implementation in pure Python. |
| 1727 | No functionality was changed. This just provides an easier-to-read |
| 1728 | alternate implementation. (Contributed by Alexander Belopolsky.) |
| 1729 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1730 | The unmaintained :file:`Demo` directory has been removed. Some demos were |
| 1731 | integrated into the documentation, some were moved to the :file:`Tools/demo` |
| 1732 | directory, and others were removed altogether. (Contributed by Georg Brandl.) |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1733 | |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 1734 | |
| 1735 | IDLE |
| 1736 | ==== |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1737 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1738 | * The format menu now has an option to clean source files by stripping |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1739 | trailing whitespace. |
| 1740 | |
| 1741 | (Contributed by Raymond Hettinger; :issue:`5150`.) |
| 1742 | |
| 1743 | * IDLE on Mac OS X now works with both Carbon AquaTk and Cocoa AquaTk. |
| 1744 | |
| 1745 | (Contributed by Kevin Walzer, Ned Deily, and Ronald Oussoren; :issue:`6075`.) |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1746 | |
| 1747 | |
| 1748 | Build and C API Changes |
| 1749 | ======================= |
| 1750 | |
| 1751 | Changes to Python's build process and to the C API include: |
| 1752 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1753 | * The *idle*, *pydoc* and *2to3* scripts are now installed with a |
| 1754 | version-specific suffix on ``make altinstall`` (:issue:`10679`). |
| 1755 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1756 | * The C functions that access the Unicode Database now accept and return |
| 1757 | characters from the full Unicode range, even on narrow unicode builds |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 1758 | (Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and others). A visible difference |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1759 | in Python is that :func:`unicodedata.numeric` now returns the correct value |
| 1760 | for large code points, and :func:`repr` may consider more characters as |
| 1761 | printable. |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1762 | |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 1763 | (Reported by Bupjoe Lee and fixed by Amaury Forgeot D'Arc; :issue:`5127`.) |
| 1764 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1765 | * Computed gotos are now enabled by default on supported compilers (which are |
Raymond Hettinger | db9044e | 2010-09-06 01:29:23 +0000 | [diff] [blame] | 1766 | detected by the configure script). They can still be disabled selectively by |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1767 | specifying ``--without-computed-gotos``. |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 1768 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1769 | (Contributed by Antoine Pitrou; :issue:`9203`.) |
| 1770 | |
Amaury Forgeot d'Arc | feb7307 | 2010-09-12 22:42:57 +0000 | [diff] [blame] | 1771 | * The option ``--with-wctype-functions`` was removed. The built-in unicode |
| 1772 | database is now used for all functions. |
| 1773 | |
| 1774 | (Contributed by Amaury Forgeot D'Arc; :issue:`9210`.) |
| 1775 | |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1776 | * Hash values are now values of a new type, :c:type:`Py_hash_t`, which is |
| 1777 | defined to be the same size as a pointer. Previously they were of type long, |
| 1778 | which on some 64-bit operating systems is still only 32 bits long. As a |
| 1779 | result of this fix, :class:`set` and :class:`dict` can now hold more than |
| 1780 | ``2**32`` entries on builds with 64-bit pointers (previously, they could grow |
| 1781 | to that size but their performance degraded catastrophically). |
Skip Montanaro | 961aaf5 | 2010-10-17 22:22:24 +0000 | [diff] [blame] | 1782 | |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1783 | (Suggested by Raymond Hettinger and implemented by Benjamin Peterson; |
| 1784 | :issue:`9778`.) |
| 1785 | |
| 1786 | * A new macro :c:macro:`Py_VA_COPY` copies the state of the variable argument |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1787 | list. It is equivalent to C99 *va_copy* but available on all Python platforms |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1788 | (:issue:`2443`). |
| 1789 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1790 | * A new C API function :c:func:`PySys_SetArgvEx` allows an embedded interpreter |
| 1791 | to set :attr:`sys.argv` without also modifying :attr:`sys.path` |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1792 | (:issue:`5753`). |
| 1793 | |
| 1794 | * :c:macro:`PyEval_CallObject` is now only available in macro form. The |
| 1795 | function declaration, which was kept for backwards compatibility reasons, is |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1796 | now removed -- the macro was introduced in 1997 (:issue:`8276`). |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1797 | |
| 1798 | * The is a new function :c:func:`PyLong_AsLongLongAndOverflow` which |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1799 | is analogous to :c:func:`PyLong_AsLongAndOverflow`. They both serve to |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1800 | convert Python :class:`int` into a native fixed-width type while providing |
| 1801 | detection of cases where the conversion won't fit (:issue:`7767`). |
| 1802 | |
| 1803 | * The :c:func:`PyUnicode_CompareWithASCIIString` now returns *not equal* |
Raymond Hettinger | ba5512f | 2011-01-18 08:28:01 +0000 | [diff] [blame] | 1804 | if the Python string is *NUL* terminated. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1805 | |
| 1806 | * There is a new function :c:func:`PyErr_NewExceptionWithDoc` that is |
| 1807 | like :c:func:`PyErr_NewException` but allows a docstring to be specified. |
| 1808 | This lets C exceptions have the same self-documenting capabilities as |
| 1809 | their pure Python counterparts (:issue:`7033`). |
| 1810 | |
| 1811 | * When compiled with the ``--with-valgrind`` option, the pymalloc |
| 1812 | allocator will be automatically disabled when running under Valgrind. This |
| 1813 | gives improved memory leak detection when running under Valgrind, while taking |
| 1814 | advantage of pymalloc at other times (:issue:`2422`). |
| 1815 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1816 | * Removed the ``O?`` format from the *PyArg_Parse* functions. The format is no |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1817 | longer used and it had never been documented (:issue:`8837`). |
| 1818 | |
| 1819 | There were a number of other small changes to the C-API. See the |
| 1820 | :file:`Misc/NEWS` file for a complete list. |
Skip Montanaro | 961aaf5 | 2010-10-17 22:22:24 +0000 | [diff] [blame] | 1821 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1822 | |
Raymond Hettinger | f558ddd | 2009-06-28 21:37:08 +0000 | [diff] [blame] | 1823 | Porting to Python 3.2 |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1824 | ===================== |
| 1825 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1826 | This section lists previously described changes and other bugfixes that may |
| 1827 | require changes to your code: |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 1828 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 1829 | * The :mod:`configparser` module has a number of clean-ups. The major change is |
| 1830 | to replace the old :class:`ConfigParser` class with long-standing preferred |
| 1831 | alternative :class:`SafeConfigParser`. In addition there are a number of |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 1832 | smaller incompatibilities: |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1833 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 1834 | * The interpolation syntax is now validated on |
| 1835 | :meth:`~configparser.ConfigParser.get` and |
| 1836 | :meth:`~configparser.ConfigParser.set` operations. In the default |
| 1837 | interpolation scheme, only two tokens with percent signs are valid: ``%(name)s`` |
| 1838 | and ``%%``, the latter being an escaped percent sign. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1839 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 1840 | * The :meth:`~configparser.ConfigParser.set` and |
| 1841 | :meth:`~configparser.ConfigParser.add_section` methods now verify that |
| 1842 | values are actual strings. Formerly, unsupported types could be introduced |
| 1843 | unintentionally. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1844 | |
Raymond Hettinger | 2b8861f | 2010-12-18 11:20:52 +0000 | [diff] [blame] | 1845 | * Duplicate sections or options from a single source now raise either |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 1846 | :exc:`~configparser.DuplicateSectionError` or |
| 1847 | :exc:`~configparser.DuplicateOptionError`. Formerly, duplicates would |
| 1848 | silently overwrite a previous entry. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1849 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 1850 | * Inline comments are now disabled by default so now the **;** character |
| 1851 | can be safely used in values. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1852 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 1853 | * Comments now can be indented. Consequently, for **;** or **#** to appear at |
| 1854 | the start of a line in multiline values, it has to be interpolated. This |
Raymond Hettinger | 2b8861f | 2010-12-18 11:20:52 +0000 | [diff] [blame] | 1855 | keeps comment prefix characters in values from being mistaken as comments. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1856 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 1857 | * ``""`` is now a valid value and is no longer automatically converted to an |
| 1858 | empty string. For empty strings, use ``"option ="`` in a line. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1859 | |
Antoine Pitrou | cd889af | 2010-10-06 21:13:56 +0000 | [diff] [blame] | 1860 | * The :mod:`nntplib` module was reworked extensively, meaning that its APIs |
| 1861 | are often incompatible with the 3.1 APIs. |
| 1862 | |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 1863 | * :class:`bytearray` objects can no longer be used as filenames; instead, |
| 1864 | they should be converted to :class:`bytes`. |
Victor Stinner | dcb2403 | 2010-04-22 12:08:36 +0000 | [diff] [blame] | 1865 | |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 1866 | * ``PyArg_Parse*()`` functions: |
Victor Stinner | 3dcb5ac | 2010-06-08 22:54:19 +0000 | [diff] [blame] | 1867 | |
Victor Stinner | 25e8ec4 | 2010-06-25 00:02:38 +0000 | [diff] [blame] | 1868 | * "t#" format has been removed: use "s#" or "s*" instead |
| 1869 | * "w" and "w#" formats has been removed: use "w*" instead |
| 1870 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1871 | * The :c:type:`PyCObject` type, deprecated in 3.1, has been removed. To wrap |
| 1872 | 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] | 1873 | 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] | 1874 | information and a less complicated signature for calling a destructor. |
Victor Stinner | 0cbec57 | 2010-09-12 20:32:57 +0000 | [diff] [blame] | 1875 | |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 1876 | * The :func:`sys.setfilesystemencoding` function was removed because |
| 1877 | it had a flawed design. |
Raymond Hettinger | 3fcf002 | 2010-12-08 01:13:53 +0000 | [diff] [blame] | 1878 | |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 1879 | * The :func:`random.seed` function and method now salt string seeds with an |
| 1880 | sha512 hash function. To access the previous version of *seed* in order to |
| 1881 | reproduce Python 3.1 sequences, set the *version* argument to *1*, |
| 1882 | ``random.seed(s, version=1)``. |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 1883 | |
Raymond Hettinger | 522cc0a | 2010-12-10 01:19:15 +0000 | [diff] [blame] | 1884 | * The previously deprecated :func:`string.maketrans` function has been removed |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 1885 | in favor of the static methods :meth:`bytes.maketrans` and |
Raymond Hettinger | 522cc0a | 2010-12-10 01:19:15 +0000 | [diff] [blame] | 1886 | :meth:`bytearray.maketrans`. This change solves the confusion around which |
| 1887 | types were supported by the :mod:`string` module. Now, :class:`str`, |
| 1888 | :class:`bytes`, and :class:`bytearray` each have their own **maketrans** and |
| 1889 | **translate** methods with intermediate translation tables of the appropriate |
| 1890 | type. |
| 1891 | |
| 1892 | (Contributed by Georg Brandl; :issue:`5675`.) |
| 1893 | |
| 1894 | * The previously deprecated :func:`contextlib.nested` function has been removed |
| 1895 | in favor of a plain :keyword:`with` statement which can accept multiple |
| 1896 | context managers. The latter technique is faster (because it is built-in), |
| 1897 | and it does a better job finalizing multiple context managers when one of them |
| 1898 | raises an exception:: |
| 1899 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1900 | with open('mylog.txt') as infile, open('a.out', 'w') as outfile: |
| 1901 | for line in infile: |
| 1902 | if '<critical>' in line: |
| 1903 | outfile.write(line) |
Raymond Hettinger | 522cc0a | 2010-12-10 01:19:15 +0000 | [diff] [blame] | 1904 | |
| 1905 | (Contributed by Georg Brandl and Mattias Brändström; |
| 1906 | `appspot issue 53094 <http://codereview.appspot.com/53094>`_.) |
Victor Stinner | da9ec99 | 2010-12-28 13:26:42 +0000 | [diff] [blame] | 1907 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1908 | * :func:`struct.pack` now only allows bytes for the ``s`` string pack code. |
| 1909 | Formerly, it would accept text arguments and implicitly encode them to bytes |
| 1910 | using UTF-8. This was problematic because it made assumptions about the |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1911 | correct encoding and because a variable-length encoding can fail when writing |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1912 | to fixed length segment of a structure. |
Victor Stinner | da9ec99 | 2010-12-28 13:26:42 +0000 | [diff] [blame] | 1913 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1914 | Code such as ``struct.pack('<6sHHBBB', 'GIF87a', x, y)`` should be rewritten |
| 1915 | with to use bytes instead of text, ``struct.pack('<6sHHBBB', b'GIF87a', x, y)``. |
| 1916 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1917 | (Discovered by David Beazley and fixed by Victor Stinner; :issue:`10783`.) |
Raymond Hettinger | e40808a | 2011-01-05 23:00:00 +0000 | [diff] [blame] | 1918 | |
| 1919 | * The :class:`xml.etree.ElementTree` class now raises an |
| 1920 | :exc:`xml.etree.ElementTree.ParseError` when a parse fails. Previously it |
| 1921 | raised a :exc:`xml.parsers.expat.ExpatError`. |
| 1922 | |
| 1923 | * The new, longer :func:`str` value on floats may break doctests which rely on |
| 1924 | the old output format. |
Antoine Pitrou | bcba434 | 2011-01-16 18:29:34 +0000 | [diff] [blame] | 1925 | |
| 1926 | * In :class:`subprocess.Popen`, the default value for *close_fds* is now |
| 1927 | ``True`` under Unix; under Windows, it is ``True`` if the three standard |
| 1928 | streams are set to ``None``, ``False`` otherwise. Previously, *close_fds* |
| 1929 | was always ``False`` by default, which produced difficult to solve bugs |
| 1930 | or race conditions when open file descriptors would leak into the child |
| 1931 | process. |
| 1932 | |
Antoine Pitrou | f7fb762 | 2011-01-16 18:34:09 +0000 | [diff] [blame] | 1933 | * Support for legacy HTTP 0.9 has been removed from :mod:`urllib.request` |
| 1934 | and :mod:`http.client`. Such support is still present on the server side |
| 1935 | (in :mod:`http.server`). |
| 1936 | |
| 1937 | (Contributed by Antoine Pitrou, :issue:`10711`.) |
| 1938 | |
Antoine Pitrou | 2e8ec22 | 2011-01-16 18:41:36 +0000 | [diff] [blame] | 1939 | * SSL sockets in timeout mode now raise :exc:`socket.timeout` when a timeout |
| 1940 | occurs, rather than a generic :exc:`~ssl.SSLError`. |
| 1941 | |
| 1942 | (Contributed by Antoine Pitrou, :issue:`10272`.) |
Antoine Pitrou | ebeb903 | 2011-01-16 18:45:17 +0000 | [diff] [blame] | 1943 | |
| 1944 | * The misleading functions :c:func:`PyEval_AcquireLock()` and |
| 1945 | :c:func:`PyEval_ReleaseLock()` have been officially deprecated. The |
| 1946 | thread-state aware APIs (such as :c:func:`PyEval_SaveThread()` |
| 1947 | and :c:func:`PyEval_RestoreThread()`) should be used instead. |