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