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 |
Raymond Hettinger | 50307b6 | 2011-01-24 01:18:30 +0000 | [diff] [blame] | 330 | reflect the new naming convention and target directory. The command-line |
| 331 | invocation of *compileall* has new command-line options include ``-i`` for |
| 332 | specifying a list of files and directories to compile, and ``-b`` which causes |
| 333 | bytecode files to be written to their legacy location rather than |
| 334 | *__pycache__*. |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 335 | |
Raymond Hettinger | 1dcc84e | 2011-01-17 21:55:40 +0000 | [diff] [blame] | 336 | * 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] | 337 | classes <abstract base class>` for the loading bytecode files. The obsolete |
| 338 | ABCs, :class:`~importlib.abc.PyLoader` and |
Raymond Hettinger | 1dcc84e | 2011-01-17 21:55:40 +0000 | [diff] [blame] | 339 | :class:`~importlib.abc.PyPycLoader`, have been deprecated (instructions on how |
Raymond Hettinger | 66352d2 | 2011-01-17 22:33:11 +0000 | [diff] [blame] | 340 | to stay Python 3.1 compatible are included with the documentation). |
Brett Cannon | 83a682d | 2011-01-16 21:02:09 +0000 | [diff] [blame] | 341 | |
Raymond Hettinger | f95b199 | 2010-09-04 23:53:24 +0000 | [diff] [blame] | 342 | .. seealso:: |
| 343 | |
| 344 | :pep:`3147` - PYC Repository Directories |
| 345 | PEP written by Barry Warsaw. |
| 346 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 347 | |
Georg Brandl | 3ad4675 | 2010-12-05 07:59:29 +0000 | [diff] [blame] | 348 | PEP 3149: ABI Version Tagged .so Files |
| 349 | ====================================== |
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 PYC repository directory allows multiple bytecode cache files to be |
| 352 | co-located. This PEP implements a similar mechanism for shared object files by |
| 353 | giving them a common directory and distinct names for each version. |
Georg Brandl | f11c6c4 | 2010-09-03 22:20:58 +0000 | [diff] [blame] | 354 | |
Raymond Hettinger | ebea6fa | 2010-09-05 00:27:25 +0000 | [diff] [blame] | 355 | The common directory is "pyshared" and the file names are made distinct by |
| 356 | identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the |
| 357 | 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] | 358 | 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] | 359 | you may see these files when the distribution package is installed:: |
| 360 | |
| 361 | /usr/share/pyshared/foo.cpython-32m.so |
| 362 | /usr/share/pyshared/foo.cpython-33md.so |
| 363 | |
| 364 | In Python itself, the tags are accessible from functions in the :mod:`sysconfig` |
| 365 | module:: |
| 366 | |
| 367 | >>> import sysconfig |
| 368 | >>> sysconfig.get_config_var('SOABI') # find the version tag |
| 369 | 'cpython-32mu' |
| 370 | >>> sysconfig.get_config_var('SO') # find the full filename extension |
| 371 | 'cpython-32mu.so' |
| 372 | |
| 373 | .. seealso:: |
| 374 | |
| 375 | :pep:`3149` - ABI Version Tagged .so Files |
| 376 | PEP written by Barry Warsaw. |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 377 | |
Raymond Hettinger | ca904be | 2011-01-18 00:02:40 +0000 | [diff] [blame] | 378 | |
Raymond Hettinger | 3df4621 | 2011-01-06 02:01:26 +0000 | [diff] [blame] | 379 | PEP 3333: Python Web Server Gateway Interface v1.0.1 |
| 380 | ===================================================== |
| 381 | |
| 382 | This informational PEP clarifies how bytes/text issues are to be handled by the |
| 383 | 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] | 384 | conveniently handled with the :class:`str` type even though the HTTP protocol |
Raymond Hettinger | 3df4621 | 2011-01-06 02:01:26 +0000 | [diff] [blame] | 385 | is itself bytes oriented. |
| 386 | |
| 387 | The PEP differentiates so-called *native strings* that are used for |
| 388 | request/response headers and metadata versus *byte strings* which are used for |
| 389 | the bodies of requests and responses. |
| 390 | |
| 391 | 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] | 392 | 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] | 393 | *Latin-1* encoding. These strings are used for the keys and values in the |
| 394 | environ dictionary and for response headers and statuses in the |
| 395 | :func:`start_response` function. They must follow :rfc:`2616` with respect to |
Raymond Hettinger | 3df4621 | 2011-01-06 02:01:26 +0000 | [diff] [blame] | 396 | encoding. That is, they must either be *ISO-8859-1* characters or use |
| 397 | :rfc:`2047` MIME encoding. |
| 398 | |
Raymond Hettinger | 32e8fea | 2011-01-07 21:04:30 +0000 | [diff] [blame] | 399 | For developers porting WSGI applications from Python 2, here are the salient |
| 400 | points: |
| 401 | |
| 402 | * If the app already used strings for headers in Python 2, no change is needed. |
| 403 | |
| 404 | * If instead, the app encoded output headers or decoded input headers, then the |
| 405 | headers will need to be re-encoded to Latin-1. For example, an output header |
| 406 | encoded in utf-8 was using ``h.encode('utf-8')`` now needs to convert from |
| 407 | bytes to native strings using ``h.encode('utf-8').decode('latin-1')``. |
| 408 | |
| 409 | * Values yielded by an application or sent using the :meth:`write` method |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 410 | must be byte strings. The :func:`start_response` function and environ |
| 411 | must use native strings. The two cannot be mixed. |
Raymond Hettinger | 32e8fea | 2011-01-07 21:04:30 +0000 | [diff] [blame] | 412 | |
| 413 | For server implementers writing CGI-to-WSGI pathways or other CGI-style |
| 414 | 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] | 415 | even though the underlying platform may have a different convention. To bridge |
Raymond Hettinger | 32e8fea | 2011-01-07 21:04:30 +0000 | [diff] [blame] | 416 | this gap, the :mod:`wsgiref` module has a new function, |
| 417 | :func:`wsgiref.handlers.read_environ` for transcoding CGI variables from |
| 418 | :attr:`os.environ` into native strings and returning a new dictionary. |
Raymond Hettinger | 3df4621 | 2011-01-06 02:01:26 +0000 | [diff] [blame] | 419 | |
| 420 | .. seealso:: |
| 421 | |
| 422 | :pep:`3333` - Python Web Server Gateway Interface v1.0.1 |
| 423 | PEP written by Phillip Eby. |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 424 | |
Raymond Hettinger | ca904be | 2011-01-18 00:02:40 +0000 | [diff] [blame] | 425 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 426 | Other Language Changes |
| 427 | ====================== |
| 428 | |
| 429 | Some smaller changes made to the core Python language are: |
| 430 | |
Raymond Hettinger | e5e1a98 | 2010-12-05 08:35:21 +0000 | [diff] [blame] | 431 | * String formatting for :func:`format` and :meth:`str.format` gained new |
| 432 | capabilities for the format character **#**. Previously, for integers in |
| 433 | binary, octal, or hexadecimal, it caused the output to be prefixed with '0b', |
| 434 | '0o', or '0x' respectively. Now it can also handle floats, complex, and |
| 435 | Decimal, causing the output to always have a decimal point even when no digits |
| 436 | follow it. |
Raymond Hettinger | e5e728b | 2010-12-05 06:35:16 +0000 | [diff] [blame] | 437 | |
| 438 | >>> format(20, '#o') |
| 439 | '0o24' |
| 440 | >>> format(12.34, '#5.0f') |
| 441 | ' 12.' |
| 442 | |
| 443 | (Suggested by Mark Dickinson and implemented by Eric Smith in :issue:`7094`.) |
Raymond Hettinger | 43b5a85 | 2010-12-05 04:04:21 +0000 | [diff] [blame] | 444 | |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 445 | * 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] | 446 | the copyright and version information from being displayed in the interactive |
| 447 | mode. The option can be introspected using the :attr:`sys.flags` attribute:: |
Raymond Hettinger | 7d96771 | 2011-01-05 20:24:08 +0000 | [diff] [blame] | 448 | |
| 449 | $ python -q |
| 450 | >>> sys.flags |
| 451 | sys.flags(debug=0, division_warning=0, inspect=0, interactive=0, |
| 452 | optimize=0, dont_write_bytecode=0, no_user_site=0, no_site=0, |
| 453 | ignore_environment=0, verbose=0, bytes_warning=0, quiet=1) |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 454 | |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 455 | (Contributed by Marcin Wojdyr in :issue:`1772833`). |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 456 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 457 | * The :func:`hasattr` function works by calling :func:`getattr` and detecting |
| 458 | whether an exception is raised. This technique allows it to detect methods |
| 459 | created dynamically by :meth:`__getattr__` or :meth:`__getattribute__` which |
Raymond Hettinger | 90a4b31 | 2011-01-06 02:08:30 +0000 | [diff] [blame] | 460 | would otherwise be absent from the class dictionary. Formerly, *hasattr* |
| 461 | would catch any exception, possibly masking genuine errors. Now, *hasattr* |
| 462 | has been tightened to only catch :exc:`AttributeError` and let other |
Raymond Hettinger | 03ca1a9 | 2011-01-20 04:12:37 +0000 | [diff] [blame] | 463 | exceptions pass through:: |
| 464 | |
| 465 | >>> class A: |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 466 | @property |
| 467 | def f(self): |
| 468 | return 1 // 0 |
Raymond Hettinger | 03ca1a9 | 2011-01-20 04:12:37 +0000 | [diff] [blame] | 469 | |
| 470 | >>> a = A() |
| 471 | >>> hasattr(a, 'f') |
| 472 | Traceback (most recent call last): |
| 473 | ... |
| 474 | ZeroDivisionError: integer division or modulo by zero |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 475 | |
Raymond Hettinger | a55ffbc | 2010-12-15 18:31:57 +0000 | [diff] [blame] | 476 | (Discovered by Yury Selivanov and fixed by Benjamin Peterson; :issue:`9666`.) |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 477 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 478 | * 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] | 479 | :func:`repr`. Previously, the :func:`str` form was shorter but that just |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 480 | caused confusion and is no longer needed now that the shortest possible |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 481 | :func:`repr` is displayed by default: |
Raymond Hettinger | bb734c6 | 2010-09-05 05:56:44 +0000 | [diff] [blame] | 482 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 483 | >>> repr(math.pi) |
| 484 | '3.141592653589793' |
| 485 | >>> str(math.pi) |
| 486 | '3.141592653589793' |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 487 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 488 | (Proposed and implemented by Mark Dickinson; :issue:`9337`.) |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 489 | |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 490 | * :class:`memoryview` objects now have a :meth:`~memoryview.release()` method |
| 491 | and they also now support the context manager protocol. This allows timely |
| 492 | release of any resources that were acquired when requesting a buffer from the |
| 493 | original object. |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 494 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 495 | >>> with memoryview(b'abcdefgh') as v: |
Raymond Hettinger | f1dae31 | 2011-01-21 03:00:00 +0000 | [diff] [blame] | 496 | print(v.tolist()) |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 497 | [97, 98, 99, 100, 101, 102, 103, 104] |
| 498 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 499 | (Added by Antoine Pitrou; :issue:`9757`.) |
| 500 | |
Amaury Forgeot d'Arc | ba117ef | 2010-09-10 21:39:53 +0000 | [diff] [blame] | 501 | * Previously it was illegal to delete a name from the local namespace if it |
| 502 | occurs as a free variable in a nested block:: |
| 503 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 504 | def outer(x): |
| 505 | def inner(): |
| 506 | return x |
| 507 | inner() |
| 508 | del x |
Amaury Forgeot d'Arc | ba117ef | 2010-09-10 21:39:53 +0000 | [diff] [blame] | 509 | |
| 510 | This is now allowed. Remember that the target of an :keyword:`except` clause |
| 511 | is cleared, so this code which used to work with Python 2.6, raised a |
| 512 | :exc:`SyntaxError` with Python 3.1 and now works again:: |
| 513 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 514 | def f(): |
| 515 | def print_error(): |
| 516 | print(e) |
| 517 | try: |
| 518 | something |
| 519 | except Exception as e: |
| 520 | print_error() |
| 521 | # implicit "del e" here |
Amaury Forgeot d'Arc | ba117ef | 2010-09-10 21:39:53 +0000 | [diff] [blame] | 522 | |
| 523 | (See :issue:`4617`.) |
| 524 | |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 525 | * The internal :c:type:`structsequence` tool now creates subclasses of tuple. |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 526 | This means that C structures like those returned by :func:`os.stat`, |
Raymond Hettinger | a275c98 | 2011-01-20 04:03:19 +0000 | [diff] [blame] | 527 | :func:`time.gmtime`, and :attr:`sys.version_info` now work like a |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 528 | :term:`named tuple` and now work with functions and methods that |
Raymond Hettinger | 93c8cad | 2011-01-18 00:30:24 +0000 | [diff] [blame] | 529 | 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] | 530 | structures as flexible as their pure Python counterparts: |
| 531 | |
| 532 | >>> isinstance(sys.version_info, tuple) |
| 533 | True |
| 534 | >>> 'Version %d.%d.%d %s(%d)' % sys.version_info |
| 535 | 'Version 3.2.0 final(0)' |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 536 | |
| 537 | (Suggested by Arfrever Frehtes Taifersar Arahesis and implemented |
| 538 | by Benjamin Peterson in :issue:`8413`.) |
| 539 | |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 540 | * Warnings are now easier to control using the :envvar:`PYTHONWARNINGS` |
Raymond Hettinger | a275c98 | 2011-01-20 04:03:19 +0000 | [diff] [blame] | 541 | environment variable as an alternative to using ``-W`` at the command line:: |
| 542 | |
| 543 | $ export PYTHONWARNINGS='ignore::RuntimeWarning::,once::UnicodeWarning::' |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 544 | |
| 545 | (Suggested by Barry Warsaw and implemented by Philip Jenvey in :issue:`7301`.) |
| 546 | |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 547 | * A new warning category, :exc:`ResourceWarning`, has been added. It is |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 548 | emitted when potential issues with resource consumption or cleanup |
Raymond Hettinger | 93c8cad | 2011-01-18 00:30:24 +0000 | [diff] [blame] | 549 | are detected. It is silenced by default in normal release builds but |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 550 | can be enabled through the means provided by the :mod:`warnings` |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 551 | module, or on the command line. |
| 552 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 553 | A :exc:`ResourceWarning` is issued at interpreter shutdown if the |
Raymond Hettinger | d0d59b1 | 2011-01-24 05:07:13 +0000 | [diff] [blame] | 554 | :data:`gc.garbage` list isn't empty, and if :attr:`gc.DEBUG_UNCOLLECTABLE` is |
| 555 | set, all uncollectable objects are printed. This is meant to make the |
| 556 | programmer aware that their code contains object finalization issues. |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 557 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 558 | 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] | 559 | without having been explicitly closed. While the deallocator for such |
| 560 | object ensures it closes the underlying operating system resource |
| 561 | (usually, a file descriptor), the delay in deallocating the object could |
| 562 | produce various issues, especially under Windows. Here is an example |
| 563 | of enabling the warning from the command line:: |
| 564 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 565 | $ python -q -Wdefault |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 566 | >>> f = open("foo", "wb") |
| 567 | >>> del f |
| 568 | __main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'> |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 569 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 570 | (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] | 571 | |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 572 | * :class:`range` objects now support *index* and *count* methods. This is part |
| 573 | of an effort to make more objects fully implement the |
| 574 | :class:`collections.Sequence` :term:`abstract base class`. As a result, the |
| 575 | language will have a more uniform API. In addition, :class:`range` objects |
Raymond Hettinger | b965629 | 2011-01-16 18:22:06 +0000 | [diff] [blame] | 576 | now support slicing and negative indices, even with values larger than |
| 577 | :attr:`sys.maxsize`. This makes *range* more interoperable with lists:: |
Raymond Hettinger | 2ffa671 | 2010-12-08 10:18:21 +0000 | [diff] [blame] | 578 | |
| 579 | >>> range(0, 100, 2).count(10) |
| 580 | 1 |
| 581 | >>> range(0, 100, 2).index(10) |
| 582 | 5 |
| 583 | >>> range(0, 100, 2)[5] |
| 584 | 10 |
| 585 | >>> range(0, 100, 2)[0:5] |
| 586 | range(0, 10, 2) |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 587 | |
Raymond Hettinger | b965629 | 2011-01-16 18:22:06 +0000 | [diff] [blame] | 588 | (Contributed by Daniel Stutzbach in :issue:`9213`, by Alexander Belopolsky |
| 589 | in :issue:`2690`, and by Nick Coghlan in :issue:`10889`.) |
Nick Coghlan | 37ee850 | 2010-12-03 14:26:13 +0000 | [diff] [blame] | 590 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 591 | * The :func:`callable` builtin function from Py2.x was resurrected. It provides |
Raymond Hettinger | b87ba26 | 2010-12-06 04:31:40 +0000 | [diff] [blame] | 592 | 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] | 593 | expression like ``isinstance(x, collections.Callable)``: |
| 594 | |
| 595 | >>> callable(max) |
| 596 | True |
| 597 | >>> callable(20) |
| 598 | False |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 599 | |
| 600 | (See :issue:`10518`.) |
Amaury Forgeot d'Arc | ba117ef | 2010-09-10 21:39:53 +0000 | [diff] [blame] | 601 | |
Raymond Hettinger | 93c8cad | 2011-01-18 00:30:24 +0000 | [diff] [blame] | 602 | * Python's import mechanism can now load modules installed in directories with |
Raymond Hettinger | a275c98 | 2011-01-20 04:03:19 +0000 | [diff] [blame] | 603 | non-ASCII characters in the path name: |
| 604 | |
| 605 | >>> import møøse.bites |
Raymond Hettinger | 070ec70 | 2010-12-10 17:45:13 +0000 | [diff] [blame] | 606 | |
| 607 | (Required extensive work by Victor Stinner in :issue:`9425`.) |
| 608 | |
| 609 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 610 | New, Improved, and Deprecated Modules |
| 611 | ===================================== |
| 612 | |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 613 | Python's standard library has undergone significant maintenance efforts and |
| 614 | quality improvements. |
Raymond Hettinger | e434b3b | 2010-12-15 19:20:01 +0000 | [diff] [blame] | 615 | |
| 616 | 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] | 617 | :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] | 618 | For the first time, there is correct handling of inputs with mixed encodings. |
| 619 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 620 | Throughout the standard library, there has been more careful attention to |
| 621 | encodings and text versus bytes issues. In particular, interactions with the |
| 622 | 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] | 623 | MBCS encoding, locale-aware encodings, or UTF-8. |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 624 | |
Raymond Hettinger | e434b3b | 2010-12-15 19:20:01 +0000 | [diff] [blame] | 625 | Another significant win is the addition of substantially better support for |
| 626 | *SSL* connections and security certificates. |
| 627 | |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 628 | In addition, more classes now implement a :term:`context manager` to support |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 629 | convenient and reliable resource clean-up using a :keyword:`with` statement. |
Raymond Hettinger | e434b3b | 2010-12-15 19:20:01 +0000 | [diff] [blame] | 630 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 631 | email |
| 632 | ----- |
| 633 | |
| 634 | The usability of the :mod:`email` package in Python 3 has been mostly fixed by |
| 635 | the extensive efforts of R. David Murray. The problem was that emails are |
| 636 | typically read and stored in the form of :class:`bytes` rather than :class:`str` |
| 637 | text, and they may contain multiple encodings within a single email. So, the |
| 638 | email package had to be extended to parse and generate email messages in bytes |
| 639 | format. |
| 640 | |
| 641 | * New functions :func:`~email.message_from_bytes` and |
| 642 | :func:`~email.message_from_binary_file`, and new classes |
| 643 | :class:`~email.parser.BytesFeedParser` and :class:`~email.parser.BytesParser` |
| 644 | allow binary message data to be parsed into model objects. |
| 645 | |
| 646 | * Given bytes input to the model, :meth:`~email.message.Message.get_payload` |
| 647 | will by default decode a message body that has a |
| 648 | :mailheader:`Content-Transfer-Encoding` of *8bit* using the charset |
| 649 | specified in the MIME headers and return the resulting string. |
| 650 | |
| 651 | * Given bytes input to the model, :class:`~email.generator.Generator` will |
| 652 | convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of |
| 653 | *8bit* to instead have a *7bit* :mailheader:`Content-Transfer-Encoding`. |
Raymond Hettinger | c08ea61 | 2011-01-08 10:32:31 +0000 | [diff] [blame] | 654 | |
Raymond Hettinger | cf8a382 | 2011-01-11 21:20:20 +0000 | [diff] [blame] | 655 | Headers with unencoded non-ASCII bytes are deemed to be :rfc:`2047`\ -encoded |
| 656 | using the *unknown-8bit* character set. |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 657 | |
| 658 | * A new class :class:`~email.generator.BytesGenerator` produces bytes as output, |
| 659 | preserving any unchanged non-ASCII data that was present in the input used to |
| 660 | build the model, including message bodies with a |
| 661 | :mailheader:`Content-Transfer-Encoding` of *8bit*. |
| 662 | |
| 663 | * The :mod:`smtplib` :class:`~smtplib.SMTP` class now accepts a byte string |
| 664 | for the *msg* argument to the :meth:`~smtplib.SMTP.sendmail` method, |
| 665 | and a new method, :meth:`~smtplib.SMTP.send_message` accepts a |
| 666 | :class:`~email.message.Message` object and can optionally obtain the |
| 667 | *from_addr* and *to_addrs* addresses directly from the object. |
| 668 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 669 | (Proposed and implemented by R. David Murray, :issue:`4661` and :issue:`10321`.) |
| 670 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 671 | elementtree |
| 672 | ----------- |
| 673 | |
Georg Brandl | 5d53fdd | 2010-12-18 11:58:12 +0000 | [diff] [blame] | 674 | The :mod:`xml.etree.ElementTree` package and its :mod:`xml.etree.cElementTree` |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 675 | counterpart have been updated to version 1.3. |
| 676 | |
| 677 | Several new and useful functions and methods have been added: |
| 678 | |
| 679 | * :func:`xml.etree.ElementTree.fromstringlist` which builds an XML document |
| 680 | from a sequence of fragments |
| 681 | * :func:`xml.etree.ElementTree.register_namespace` for registering a global |
| 682 | namespace prefix |
| 683 | * :func:`xml.etree.ElementTree.tostringlist` for string representation |
| 684 | including all sublists |
| 685 | * :meth:`xml.etree.ElementTree.Element.extend` for appending a sequence of zero |
| 686 | or more elements |
| 687 | * :meth:`xml.etree.ElementTree.Element.iterfind` searches an element and |
| 688 | subelements |
| 689 | * :meth:`xml.etree.ElementTree.Element.itertext` creates a text iterator over |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 690 | an element and its subelements |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 691 | * :meth:`xml.etree.ElementTree.TreeBuilder.end` closes the current element |
| 692 | * :meth:`xml.etree.ElementTree.TreeBuilder.doctype` handles a doctype |
| 693 | declaration |
| 694 | |
| 695 | Two methods have been deprecated: |
| 696 | |
| 697 | * :meth:`xml.etree.ElementTree.getchildren` use ``list(elem)`` instead. |
| 698 | * :meth:`xml.etree.ElementTree.getiterator` use ``Element.iter`` instead. |
| 699 | |
| 700 | For details of the update, see `Introducing ElementTree |
| 701 | <http://effbot.org/zone/elementtree-13-intro.htm>`_ on Fredrik Lundh's website. |
| 702 | |
Antoine Pitrou | 12de8ac | 2010-12-16 13:33:56 +0000 | [diff] [blame] | 703 | (Contributed by Florent Xicluna and Fredrik Lundh, :issue:`6472`.) |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 704 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 705 | functools |
| 706 | --------- |
| 707 | |
Éric Araujo | 4234ad4 | 2010-09-05 17:32:25 +0000 | [diff] [blame] | 708 | * The :mod:`functools` module includes a new decorator for caching function |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 709 | calls. :func:`functools.lru_cache` can save repeated queries to an external |
| 710 | resource whenever the results are expected to be the same. |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 711 | |
Raymond Hettinger | 86f9613 | 2010-08-06 23:23:49 +0000 | [diff] [blame] | 712 | 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] | 713 | database accesses for popular searches: |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 714 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 715 | >>> @functools.lru_cache(maxsize=300) |
| 716 | >>> def get_phone_number(name): |
| 717 | c = conn.cursor() |
| 718 | c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,)) |
| 719 | return c.fetchone()[0] |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 720 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 721 | >>> for name in user_requests: |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 722 | get_phone_number(name) # cached lookup |
Raymond Hettinger | 7496b41 | 2010-11-30 19:15:45 +0000 | [diff] [blame] | 723 | |
| 724 | To help with choosing an effective cache size, the wrapped function is |
| 725 | instrumented for tracking cache statistics: |
| 726 | |
Raymond Hettinger | 5e20bab | 2010-11-30 07:13:04 +0000 | [diff] [blame] | 727 | >>> get_phone_number.cache_info() |
Raymond Hettinger | 7496b41 | 2010-11-30 19:15:45 +0000 | [diff] [blame] | 728 | CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300) |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 729 | |
Raymond Hettinger | f309828 | 2010-08-15 03:30:45 +0000 | [diff] [blame] | 730 | 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] | 731 | cleared with: |
Raymond Hettinger | f309828 | 2010-08-15 03:30:45 +0000 | [diff] [blame] | 732 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 733 | >>> get_phone_number.cache_clear() |
Raymond Hettinger | f309828 | 2010-08-15 03:30:45 +0000 | [diff] [blame] | 734 | |
Raymond Hettinger | 6e35394 | 2010-12-04 23:42:12 +0000 | [diff] [blame] | 735 | (Contributed by Raymond Hettinger and incorporating design ideas from |
Raymond Hettinger | b87ba26 | 2010-12-06 04:31:40 +0000 | [diff] [blame] | 736 | Jim Baker, Miki Tebeka, and Nick Coghlan.) |
Raymond Hettinger | aed05eb | 2010-08-02 01:43:41 +0000 | [diff] [blame] | 737 | |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 738 | * The :func:`functools.wraps` decorator now adds a :attr:`__wrapped__` attribute |
| 739 | pointing to the original callable function. This allows wrapped functions to |
| 740 | be introspected. It also copies :attr:`__annotations__` if defined. And now |
| 741 | it also gracefully skips over missing attributes such as :attr:`__doc__` which |
Raymond Hettinger | 5eb6390 | 2010-12-09 23:43:34 +0000 | [diff] [blame] | 742 | might not be defined for the wrapped callable. |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 743 | |
Raymond Hettinger | 7a168d9 | 2011-01-21 04:59:00 +0000 | [diff] [blame] | 744 | In the above example, the cache can be removed by recovering the original |
| 745 | function: |
| 746 | |
| 747 | >>> get_phone_number = get_phone_number.__wrapped__ # uncached function |
| 748 | |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 749 | (By Nick Coghlan and Terrence Cole; :issue:`9567`, :issue:`3445`, and |
| 750 | :issue:`8814`.) |
| 751 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 752 | * To help write classes with rich comparison methods, a new decorator |
| 753 | :func:`functools.total_ordering` will use a existing equality and inequality |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 754 | methods to fill in the remaining methods. |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 755 | |
| 756 | For example, supplying *__eq__* and *__lt__* will enable |
| 757 | :func:`~functools.total_ordering` to fill-in *__le__*, *__gt__* and *__ge__*:: |
| 758 | |
| 759 | @total_ordering |
| 760 | class Student: |
| 761 | def __eq__(self, other): |
| 762 | return ((self.lastname.lower(), self.firstname.lower()) == |
| 763 | (other.lastname.lower(), other.firstname.lower())) |
| 764 | def __lt__(self, other): |
| 765 | return ((self.lastname.lower(), self.firstname.lower()) < |
| 766 | (other.lastname.lower(), other.firstname.lower())) |
| 767 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 768 | With the *total_ordering* decorator, the remaining comparison methods |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 769 | are filled in automatically. |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 770 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 771 | (Contributed by Raymond Hettinger.) |
Raymond Hettinger | f35a34c | 2010-12-22 09:11:54 +0000 | [diff] [blame] | 772 | |
Raymond Hettinger | 4bea978 | 2011-01-19 04:14:34 +0000 | [diff] [blame] | 773 | * 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] | 774 | function converts an old-style comparison function to |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 775 | modern :term:`key function`: |
| 776 | |
| 777 | >>> # locale-aware sort order |
| 778 | >>> sorted(iterable, key=cmp_to_key(locale.strcoll)) |
| 779 | |
| 780 | For sorting examples and a brief sorting tutorial, see the `Sorting HowTo |
| 781 | <http://wiki.python.org/moin/HowTo/Sorting/>`_ tutorial. |
| 782 | |
| 783 | (Contributed by Raymond Hettinger.) |
| 784 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 785 | itertools |
| 786 | --------- |
| 787 | |
Raymond Hettinger | 673ccf2 | 2010-12-07 09:37:11 +0000 | [diff] [blame] | 788 | * The :mod:`itertools` module has a new :func:`~itertools.accumulate` function |
Raymond Hettinger | 4bea978 | 2011-01-19 04:14:34 +0000 | [diff] [blame] | 789 | modeled on APL's *scan* operator and Numpy's *accumulate* function: |
Raymond Hettinger | 6e35394 | 2010-12-04 23:42:12 +0000 | [diff] [blame] | 790 | |
| 791 | >>> list(accumulate(8, 2, 50)) |
| 792 | [8, 10, 60] |
| 793 | |
| 794 | >>> prob_dist = [0.1, 0.4, 0.2, 0.3] |
| 795 | >>> list(accumulate(prob_dist)) # cumulative probability distribution |
| 796 | [0.1, 0.5, 0.7, 1.0] |
| 797 | |
| 798 | For an example using :func:`~itertools.accumulate`, see the :ref:`examples for |
| 799 | the random module <random-examples>`. |
| 800 | |
| 801 | (Contributed by Raymond Hettinger and incorporating design suggestions |
| 802 | from Mark Dickinson.) |
| 803 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 804 | collections |
| 805 | ----------- |
| 806 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 807 | * The :class:`collections.Counter` class now has two forms of in-place |
| 808 | subtraction, the existing *-=* operator for `saturating subtraction |
| 809 | <http://en.wikipedia.org/wiki/Saturation_arithmetic>`_ and the new |
| 810 | :meth:`~collections.Counter.subtract` method for regular subtraction. The |
| 811 | former is suitable for `multisets <http://en.wikipedia.org/wiki/Multiset>`_ |
Raymond Hettinger | ffad35e | 2010-12-14 21:12:03 +0000 | [diff] [blame] | 812 | 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] | 813 | that allow negative counts: |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 814 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 815 | >>> tally = Counter(dogs=5, cat=3) |
| 816 | >>> tally -= Counter(dogs=2, cats=8) # saturating subtraction |
| 817 | >>> tally |
| 818 | Counter({'dogs': 3}) |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 819 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 820 | >>> tally = Counter(dogs=5, cats=3) |
| 821 | >>> tally.subtract(dogs=2, cats=8) # regular subtraction |
| 822 | >>> tally |
| 823 | Counter({'dogs': 3, 'cats': -5}) |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 824 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 825 | (Contributed by Raymond Hettinger.) |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 826 | |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 827 | * The :class:`collections.OrderedDict` class has a new method |
| 828 | :meth:`~collections.OrderedDict.move_to_end` which takes an existing key and |
Raymond Hettinger | 23ab101 | 2011-01-18 20:25:04 +0000 | [diff] [blame] | 829 | moves it to either the first or last position in the ordered sequence. |
| 830 | |
| 831 | The default is to move an item to the last position. This is equivalent of |
| 832 | renewing an entry with ``od[k] = od.pop(k)``. |
| 833 | |
| 834 | A fast move-to-end operation is useful for resequencing entries. For example, |
Raymond Hettinger | 00db6aa | 2011-01-20 09:47:04 +0000 | [diff] [blame] | 835 | an ordered dictionary can be used to track order of access by aging entries |
| 836 | from the oldest to the most recently accessed. |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 837 | |
| 838 | >>> d = OrderedDict.fromkeys(['a', 'b', 'X', 'd', 'e']) |
| 839 | >>> list(d) |
| 840 | ['a', 'b', 'X', 'd', 'e'] |
Raymond Hettinger | 23ab101 | 2011-01-18 20:25:04 +0000 | [diff] [blame] | 841 | >>> d.move_to_end('X') |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 842 | >>> list(d) |
| 843 | ['a', 'b', 'd', 'e', 'X'] |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 844 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 845 | (Contributed by Raymond Hettinger.) |
| 846 | |
Raymond Hettinger | 7ec790d | 2011-01-18 00:19:30 +0000 | [diff] [blame] | 847 | * The :class:`collections.deque` class grew two new methods |
| 848 | :meth:`~collections.deque.count` and :meth:`~collections.deque.reverse` that |
| 849 | make them more substitutable for :class:`list` objects: |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 850 | |
| 851 | >>> d = deque('simsalabim') |
| 852 | >>> d.count('s') |
| 853 | 2 |
| 854 | >>> d.reverse() |
| 855 | >>> d |
| 856 | deque(['m', 'i', 'b', 'a', 'l', 'a', 's', 'm', 'i', 's']) |
| 857 | |
| 858 | (Contributed by Raymond Hettinger.) |
| 859 | |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 860 | threading |
| 861 | --------- |
| 862 | |
| 863 | The :mod:`threading` module has a new :class:`~threading.Barrier` |
| 864 | synchronization class for making multiple threads wait until all of them have |
| 865 | reached a common barrier point. Barriers are useful for making sure that a task |
| 866 | with multiple preconditions does not run until all of the predecessor tasks are |
| 867 | complete. |
| 868 | |
| 869 | Barriers can work with an arbitrary number of threads. This is a generalization |
| 870 | of a `Rendezvous <http://en.wikipedia.org/wiki/Synchronous_rendezvous>`_ which |
| 871 | is defined for only two threads. |
| 872 | |
Raymond Hettinger | 15b47c5 | 2011-01-17 21:05:07 +0000 | [diff] [blame] | 873 | Implemented as a two-phase cyclic barrier, :class:`~threading.Barrier` objects |
| 874 | are suitable for use in loops. The separate *filling* and *draining* phases |
Raymond Hettinger | e0f1f32 | 2011-01-18 21:14:27 +0000 | [diff] [blame] | 875 | assure that all threads get released (drained) before any one of them can loop |
| 876 | 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] | 877 | |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 878 | Example of using barriers:: |
| 879 | |
| 880 | def get_votes(site): |
| 881 | ballots = conduct_election(site) |
| 882 | all_polls_closed.wait() # do not count until all polls are closed |
Raymond Hettinger | 9767365 | 2011-01-11 21:13:26 +0000 | [diff] [blame] | 883 | totals = summarize(ballots) |
| 884 | publish(site, totals) |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 885 | |
| 886 | all_polls_closed = Barrier(len(sites)) |
Raymond Hettinger | 3a8ae5f | 2011-01-11 20:51:45 +0000 | [diff] [blame] | 887 | for site in sites: |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 888 | Thread(target=get_votes, args=(site,)).start() |
| 889 | |
| 890 | In this example, the barrier enforces a rule that votes cannot be counted at any |
| 891 | polling site until all polls are closed. Notice how a solution with a barrier |
| 892 | is similar to one with :meth:`threading.Thread.join`, but the threads stay alive |
| 893 | and continue to do work (summarizing ballots) after the barrier point is |
| 894 | crossed. |
| 895 | |
Raymond Hettinger | 2c3865b | 2011-01-18 22:58:33 +0000 | [diff] [blame] | 896 | If any of the predecessor tasks can hang or be delayed, a barrier can be created |
| 897 | with an optional *timeout* parameter. Then if the timeout period elapses before |
| 898 | all the predecessor tasks reach the barrier point, all waiting threads are |
| 899 | released and a :exc:`~threading.BrokenBarrierError` exception is raised:: |
| 900 | |
| 901 | def get_votes(site): |
| 902 | ballots = conduct_election(site) |
| 903 | try: |
| 904 | all_polls_closed.wait(timeout = midnight - time.now()) |
David Malcolm | 4934864 | 2011-01-18 23:45:53 +0000 | [diff] [blame] | 905 | except BrokenBarrierError: |
Raymond Hettinger | 2c3865b | 2011-01-18 22:58:33 +0000 | [diff] [blame] | 906 | lockbox = seal_ballots(ballots) |
| 907 | queue.put(lockbox) |
| 908 | else: |
| 909 | totals = summarize(ballots) |
| 910 | publish(site, totals) |
| 911 | |
| 912 | In this example, the barrier enforces a more robust rule. If some election |
| 913 | sites do not finish before midnight, the barrier times-out and the ballots are |
| 914 | sealed and deposited in a queue for later handling. |
| 915 | |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 916 | See `Barrier Synchronization Patterns |
Raymond Hettinger | 3a8ae5f | 2011-01-11 20:51:45 +0000 | [diff] [blame] | 917 | <http://parlab.eecs.berkeley.edu/wiki/_media/patterns/paraplop_g1_3.pdf>`_ for |
| 918 | more examples of how barriers can be used in parallel computing. Also, there is |
| 919 | a simple but thorough explanation of barriers in `The Little Book of Semaphores |
| 920 | <http://greenteapress.com/semaphores/downey08semaphores.pdf>`_, *section 3.6*. |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 921 | |
Raymond Hettinger | 3a8ae5f | 2011-01-11 20:51:45 +0000 | [diff] [blame] | 922 | (Contributed by Kristján Valur Jónsson with an API review by Jeffrey Yasskin in |
| 923 | :issue:`8777`.) |
Raymond Hettinger | 6655d11 | 2011-01-11 08:49:10 +0000 | [diff] [blame] | 924 | |
Raymond Hettinger | 9767365 | 2011-01-11 21:13:26 +0000 | [diff] [blame] | 925 | datetime and time |
| 926 | ----------------- |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 927 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 928 | * The :mod:`datetime` module has a new type :class:`~datetime.timezone` that |
| 929 | implements the :class:`~datetime.tzinfo` interface by returning a fixed UTC |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 930 | offset and timezone name. This makes it easier to create timezone-aware |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 931 | datetime objects: |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 932 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 933 | >>> datetime.now(timezone.utc) |
| 934 | 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] | 935 | |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 936 | >>> datetime.strptime("01/01/2000 12:00 +0000", "%m/%d/%Y %H:%M %z") |
| 937 | datetime.datetime(2000, 1, 1, 12, 0, tzinfo=datetime.timezone.utc) |
Alexander Belopolsky | 7257231 | 2010-12-08 21:21:56 +0000 | [diff] [blame] | 938 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 939 | * Also, :class:`~datetime.timedelta` objects can now be multiplied by |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 940 | :class:`float` and divided by :class:`float` and :class:`int` objects. |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 941 | And :class:`~datetime.timedelta` objects can now divide one another. |
Raymond Hettinger | 792c076 | 2010-12-09 16:41:54 +0000 | [diff] [blame] | 942 | |
Raymond Hettinger | ca904be | 2011-01-18 00:02:40 +0000 | [diff] [blame] | 943 | * The :meth:`datetime.date.strftime` method is no longer restricted to years |
| 944 | 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] | 945 | |
Raymond Hettinger | f1dae31 | 2011-01-21 03:00:00 +0000 | [diff] [blame] | 946 | * Whenever a two-digit year is used in a time tuple, the interpretation has been |
| 947 | governed by :attr:`time.accept2dyear`. The default is *True* which means that |
| 948 | for a two-digit year, the century is guessed according to the POSIX rules |
| 949 | governing the ``%y`` strptime format. |
Alexander Belopolsky | 9ee94de | 2011-01-20 19:51:31 +0000 | [diff] [blame] | 950 | |
Raymond Hettinger | f1dae31 | 2011-01-21 03:00:00 +0000 | [diff] [blame] | 951 | Starting with Py3.2, use of the century guessing heuristic will emit a |
| 952 | :exc:`DeprecationWarning`. Instead, it is recommended that |
| 953 | :attr:`time.accept2dyear` be set to *False* so that large date ranges |
| 954 | can be used without guesswork: |
| 955 | |
Raymond Hettinger | 7a168d9 | 2011-01-21 04:59:00 +0000 | [diff] [blame] | 956 | >>> warnings.resetwarnings() # remove the default warning filters |
| 957 | >>> time.accept2dyear = True # guess whether 11 means 11 or 2011 |
Raymond Hettinger | f1dae31 | 2011-01-21 03:00:00 +0000 | [diff] [blame] | 958 | >>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0)) |
Raymond Hettinger | 7a168d9 | 2011-01-21 04:59:00 +0000 | [diff] [blame] | 959 | Warning (from warnings module): |
| 960 | ... |
| 961 | DeprecationWarning: Century info guessed for a 2-digit year. |
Raymond Hettinger | f1dae31 | 2011-01-21 03:00:00 +0000 | [diff] [blame] | 962 | 'Fri Jan 1 12:34:56 2011' |
Raymond Hettinger | 7a168d9 | 2011-01-21 04:59:00 +0000 | [diff] [blame] | 963 | >>> time.accept2dyear = False # use the full range of allowable dates |
Raymond Hettinger | f1dae31 | 2011-01-21 03:00:00 +0000 | [diff] [blame] | 964 | >>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0)) |
| 965 | 'Fri Jan 1 12:34:56 11' |
| 966 | |
| 967 | Several functions now have significantly expanded date ranges. When |
| 968 | :attr:`time.accept2dyear` is false, the :func:`time.asctime` function will |
| 969 | accept any year that fits in a C int, while the :func:`time.mktime` and |
| 970 | :func:`time.strftime` functions will accept the full range supported by the |
| 971 | corresponding operating system functions. |
Alexander Belopolsky | bd96b06 | 2011-01-10 21:55:34 +0000 | [diff] [blame] | 972 | |
Raymond Hettinger | 9767365 | 2011-01-11 21:13:26 +0000 | [diff] [blame] | 973 | (Contributed by Alexander Belopolsky and Victor Stinner.) |
Alexander Belopolsky | bd96b06 | 2011-01-10 21:55:34 +0000 | [diff] [blame] | 974 | |
Raymond Hettinger | a4cfb42 | 2011-01-25 02:35:58 +0000 | [diff] [blame] | 975 | math |
| 976 | ---- |
| 977 | |
Raymond Hettinger | 902f320 | 2011-01-25 08:01:01 +0000 | [diff] [blame^] | 978 | The :mod:`math` module has been updated with six new functions inspired by the |
Raymond Hettinger | a4cfb42 | 2011-01-25 02:35:58 +0000 | [diff] [blame] | 979 | C99 standard. |
| 980 | |
| 981 | The :func:`~math.isfinite` function provides a reliable and fast way to detect |
| 982 | special values. It returns *True* for regular numbers and *False* for *Nan* or |
| 983 | *Infinity*: |
| 984 | |
| 985 | >>> [isfinite(x) for x in (123, 4.56, float('Nan'), float('Inf'))] |
| 986 | [True, True, False, False] |
| 987 | |
| 988 | The :func:`~math.expm1` function computes ``e**x-1`` for small values of *x* |
| 989 | without incuring the loss of precision that usually accompanies the subtraction |
| 990 | of nearly equal quantities: |
| 991 | |
| 992 | >>> expm1(0.013671875) # more accurate way to compute e**x-1 for a small x |
| 993 | 0.013765762467652909 |
| 994 | |
Raymond Hettinger | f9b8a19 | 2011-01-25 05:53:27 +0000 | [diff] [blame] | 995 | The :func:`~math.erf` function computes a probability integral or `Gaussian |
Raymond Hettinger | 2f707c9 | 2011-01-25 06:58:01 +0000 | [diff] [blame] | 996 | error function <http://en.wikipedia.org/wiki/Error_function>`_. The |
| 997 | complementary error function, :func:`~math.erfc`, is ``1 - erf(x)``: |
Raymond Hettinger | a4cfb42 | 2011-01-25 02:35:58 +0000 | [diff] [blame] | 998 | |
| 999 | >>> erf(1.0/sqrt(2.0)) # portion of normal distribution within 1 standard deviation |
| 1000 | 0.682689492137086 |
Raymond Hettinger | 2f707c9 | 2011-01-25 06:58:01 +0000 | [diff] [blame] | 1001 | >>> erfc(1.0/sqrt(2.0)) # portion of normal distribution outside 1 standard deviation |
| 1002 | 0.31731050786291404 |
| 1003 | >>> erf(1.0/sqrt(2.0)) + erfc(1.0/sqrt(2.0)) |
| 1004 | 1.0 |
Raymond Hettinger | a4cfb42 | 2011-01-25 02:35:58 +0000 | [diff] [blame] | 1005 | |
Raymond Hettinger | 2c63906 | 2011-01-25 02:38:59 +0000 | [diff] [blame] | 1006 | The :func:`~math.gamma` function is a continuous extension of the factorial |
| 1007 | function. See http://en.wikipedia.org/wiki/Gamma_function for details. Because |
| 1008 | the function is related to factorials, it grows large even for small values of |
| 1009 | *x*, so there is also a :func:`~math.lgamma` function for computing the natural |
| 1010 | logarithm of the gamma function: |
Raymond Hettinger | a4cfb42 | 2011-01-25 02:35:58 +0000 | [diff] [blame] | 1011 | |
| 1012 | >>> gamma(7.0) # six factorial |
| 1013 | 720.0 |
| 1014 | >>> lgamma(801.0) # log(800 factorial) |
| 1015 | 4551.950730698041 |
| 1016 | |
| 1017 | (Contributed by Mark Dickinson.) |
| 1018 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1019 | abc |
| 1020 | --- |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 1021 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1022 | The :mod:`abc` module now supports :func:`~abc.abstractclassmethod` and |
| 1023 | :func:`~abc.abstractstaticmethod`. |
Raymond Hettinger | a5a3554 | 2010-12-05 00:39:18 +0000 | [diff] [blame] | 1024 | |
Raymond Hettinger | 7ec790d | 2011-01-18 00:19:30 +0000 | [diff] [blame] | 1025 | 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] | 1026 | requires a particular :func:`classmethod` or :func:`staticmethod` to be |
Raymond Hettinger | 7ec790d | 2011-01-18 00:19:30 +0000 | [diff] [blame] | 1027 | implemented:: |
| 1028 | |
| 1029 | class Temperature(metaclass=ABCMeta): |
| 1030 | @abc.abstractclassmethod |
Raymond Hettinger | a80ab10 | 2011-01-24 18:19:01 +0000 | [diff] [blame] | 1031 | def from_fahrenheit(self, t): |
Raymond Hettinger | 7ec790d | 2011-01-18 00:19:30 +0000 | [diff] [blame] | 1032 | ... |
| 1033 | @abc.abstractclassmethod |
Raymond Hettinger | a80ab10 | 2011-01-24 18:19:01 +0000 | [diff] [blame] | 1034 | def from_celsius(self, t): |
Raymond Hettinger | 7ec790d | 2011-01-18 00:19:30 +0000 | [diff] [blame] | 1035 | ... |
Antoine Pitrou | 7d49bc9 | 2010-09-15 15:13:17 +0000 | [diff] [blame] | 1036 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1037 | (Patch submitted by Daniel Urban; :issue:`5867`.) |
Raymond Hettinger | bcbd696 | 2010-09-05 08:46:36 +0000 | [diff] [blame] | 1038 | |
Raymond Hettinger | f4f0e6c | 2011-01-24 22:14:42 +0000 | [diff] [blame] | 1039 | io |
| 1040 | -- |
| 1041 | |
| 1042 | The :class:`io.BytesIO` has a new method, :meth:`~io.BytesIO.getbuffer`, which |
| 1043 | provides functionality similar to :func:`memoryview`. It creates an editable |
| 1044 | view of the data without making a copy. The buffer's random access and support |
| 1045 | for slice notation are well-suited to in-place editing:: |
| 1046 | |
| 1047 | import io |
| 1048 | |
| 1049 | REC_LEN, LOC_START, LOC_LEN = 34, 7, 11 |
| 1050 | |
| 1051 | def change_location(buffer, record_number, location): |
| 1052 | start = record_number * REC_LEN + LOC_START |
| 1053 | buffer[start: start+LOC_LEN] = location |
| 1054 | |
| 1055 | >>> byte_stream = io.BytesIO( |
| 1056 | b'G3805 storeroom Main chassis ' |
| 1057 | b'X7899 shipping Reserve cog ' |
| 1058 | b'L6988 receiving Primary sprocket' |
| 1059 | ) |
| 1060 | >>> buffer = byte_stream.getbuffer() |
| 1061 | >>> change_location(buffer, 1, b'warehouse ') |
| 1062 | >>> change_location(buffer, 0, b'showroom ') |
| 1063 | >>> print(byte_stream.getvalue()) |
| 1064 | b'G3805 showroom Main chassis ' -> |
| 1065 | b'X7899 warehouse Reserve cog ' -> |
| 1066 | b'L6988 receiving Primary sprocket' |
| 1067 | |
Raymond Hettinger | 98b140c | 2011-01-23 21:05:46 +0000 | [diff] [blame] | 1068 | reprlib |
| 1069 | ------- |
| 1070 | |
| 1071 | When writing a :meth:`__repr__` method for a custom container, it is easy to |
| 1072 | forget to handle the case where a member refers back to the container itself. |
| 1073 | Python's builtin objects such as :class:`list` and :class:`set` handle |
| 1074 | self-reference by displaying "..." in the recursive part of the representation |
| 1075 | string. |
| 1076 | |
| 1077 | To help write such :meth:`__repr__` methods, the :mod:`reprlib` module has a new |
Raymond Hettinger | cbc903b | 2011-01-23 21:13:27 +0000 | [diff] [blame] | 1078 | decorator, :func:`~reprlib.recursive_repr`, for detecting recursive calls to |
Raymond Hettinger | 98b140c | 2011-01-23 21:05:46 +0000 | [diff] [blame] | 1079 | :meth:`__repr__` and substituting a placeholder string instead: |
| 1080 | |
| 1081 | >>> class MyList(list): |
| 1082 | @recursive_repr() |
| 1083 | def __repr__(self): |
| 1084 | return '<' + '|'.join(map(repr, self)) + '>' |
| 1085 | |
| 1086 | >>> m = MyList('abc') |
| 1087 | >>> m.append(m) |
| 1088 | >>> m.append('x') |
| 1089 | >>> print(m) |
| 1090 | <'a'|'b'|'c'|...|'x'> |
| 1091 | |
Raymond Hettinger | cbc903b | 2011-01-23 21:13:27 +0000 | [diff] [blame] | 1092 | (Contributed by Raymond Hettinger in :issue:`9826` and :issue:`9840`.) |
Raymond Hettinger | 98b140c | 2011-01-23 21:05:46 +0000 | [diff] [blame] | 1093 | |
Raymond Hettinger | 50307b6 | 2011-01-24 01:18:30 +0000 | [diff] [blame] | 1094 | csv |
| 1095 | --- |
| 1096 | |
| 1097 | The :mod:`csv` module now supports a new dialect, :class:`~csv.unix_dialect`, |
| 1098 | which applies quoting for all fields and a traditional Unix style with ``'\n'`` as |
| 1099 | the line terminator. The registered dialect name is ``unix``. |
| 1100 | |
| 1101 | The :class:`csv.DictWriter` has a new method, |
| 1102 | :meth:`~csv.DictWriter.writeheader` for writing-out an initial row to document |
| 1103 | the field names:: |
| 1104 | |
| 1105 | >>> import csv, sys |
| 1106 | >>> w = csv.DictWriter(sys.stdout, ['name', 'dept'], dialect='unix') |
| 1107 | >>> w.writeheader() |
| 1108 | "name","dept" |
| 1109 | >>> w.writerows([ |
| 1110 | {'name': 'tom', 'dept': 'accounting'}, |
| 1111 | {'name': 'susan', 'dept': 'Salesl'}]) |
| 1112 | "tom","accounting" |
| 1113 | "susan","sales" |
| 1114 | |
| 1115 | (New dialect suggested by Jay Talbot in :issue:`5975`, and the new method |
| 1116 | suggested by Ed Abraham in :issue:`1537721`.) |
| 1117 | |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1118 | contextlib |
| 1119 | ---------- |
| 1120 | |
| 1121 | There is a new and slightly mind-blowing tool |
| 1122 | :class:`~contextlib.ContextDecorator` that is helpful for creating a |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1123 | :term:`context manager` that does double duty as a function decorator. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1124 | |
| 1125 | As a convenience, this new functionality is used by |
| 1126 | :func:`~contextlib.contextmanager` so that no extra effort is needed to support |
| 1127 | both roles. |
| 1128 | |
| 1129 | The basic idea is that both context managers and function decorators can be used |
| 1130 | 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] | 1131 | statements using a :keyword:`with` statement, and function decorators wrap a |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1132 | 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] | 1133 | 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] | 1134 | |
| 1135 | For example, it is sometimes useful to wrap functions or groups of statements |
| 1136 | with a logger that can track the time of entry and time of exit. Rather than |
| 1137 | writing both a function decorator and a context manager for the task, the |
| 1138 | :func:`~contextlib.contextmanager` provides both capabilities in a single |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1139 | definition:: |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1140 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1141 | import logging |
| 1142 | logging.basicConfig(level=logging.INFO) |
| 1143 | @contextmanager |
| 1144 | def track_entry_and_exit(name): |
| 1145 | logging.info('Entering: {}'.format(name)) |
| 1146 | yield |
| 1147 | logging.info('Exiting: {}'.format(name)) |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1148 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1149 | Formerly, this would have only been usable as a context manager:: |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1150 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1151 | with track_entry_and_exit('widget loader'): |
| 1152 | print('Some time consuming activity goes here') |
| 1153 | load_widget() |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1154 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1155 | Now, it can be used as a decorator as well:: |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1156 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1157 | @track_entry_and_exit('widget loader') |
| 1158 | def activity(): |
| 1159 | print('Some time consuming activity goes here') |
| 1160 | load_widget() |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1161 | |
| 1162 | Trying to fulfill two roles at once places some limitations on the technique. |
| 1163 | Context managers normally have the flexibility to return an argument usable by |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1164 | a :keyword:`with` statement, but there is no parallel for function decorators. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1165 | |
Raymond Hettinger | 9743e4f | 2010-12-16 02:24:12 +0000 | [diff] [blame] | 1166 | 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] | 1167 | context manager to return a logging instance for use in the body of enclosed |
| 1168 | statements. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 1169 | |
| 1170 | (Contributed by Michael Foord in :issue:`9110`.) |
| 1171 | |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1172 | decimal and fractions |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1173 | --------------------- |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1174 | |
| 1175 | Mark Dickinson crafted an elegant and efficient scheme for assuring that |
| 1176 | different numeric datatypes will have the same hash value whenever their actual |
| 1177 | values are equal (:issue:`8188`):: |
| 1178 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1179 | assert hash(Fraction(3, 2)) == hash(1.5) == \ |
| 1180 | hash(Decimal("1.5")) == hash(complex(1.5, 0)) |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1181 | |
Raymond Hettinger | e7dfe74 | 2011-01-24 09:17:24 +0000 | [diff] [blame] | 1182 | Some of the hashing details are exposed through a new attribute, |
| 1183 | :attr:`sys.hash_info`, which describes the bit width of the hash value, the |
| 1184 | prime modulus, the hash values for *infinity* and *nan*, and the multiplier |
| 1185 | used for the imaginary part of a number: |
| 1186 | |
| 1187 | >>> sys.hash_info |
| 1188 | sys.hash_info(width=64, modulus=2305843009213693951, inf=314159, nan=0, imag=1000003) |
| 1189 | |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1190 | 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] | 1191 | been relaxed. It is still unsupported (and ill-advised) to have implicit |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1192 | mixing in arithmetic expressions such as ``Decimal('1.1') + float('1.1')`` |
| 1193 | because the latter loses information in the process of constructing the binary |
| 1194 | float. However, since existing floating point value can be converted losslessly |
| 1195 | to either a decimal or rational representation, it makes sense to add them to |
| 1196 | the constructor and to support mixed-type comparisons. |
| 1197 | |
Raymond Hettinger | bb9686f | 2010-12-16 00:53:05 +0000 | [diff] [blame] | 1198 | * The :class:`decimal.Decimal` constructor now accepts :class:`float` objects |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1199 | 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] | 1200 | method (:issue:`8257`). |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1201 | |
| 1202 | * Mixed type comparisons are now fully supported so that |
| 1203 | :class:`~decimal.Decimal` objects can be directly compared with :class:`float` |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1204 | and :class:`fractions.Fraction` (:issue:`2531` and :issue:`8188`). |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1205 | |
| 1206 | Similar changes were made to :class:`fractions.Fraction` so that the |
| 1207 | :meth:`~fractions.Fraction.from_float()` and :meth:`~fractions.Fraction.from_decimal` |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1208 | methods are no longer needed (:issue:`8294`): |
| 1209 | |
| 1210 | >>> Decimal(1.1) |
| 1211 | Decimal('1.100000000000000088817841970012523233890533447265625') |
| 1212 | >>> Fraction(1.1) |
| 1213 | Fraction(2476979795053773, 2251799813685248) |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1214 | |
| 1215 | Another useful change for the :mod:`decimal` module is that the |
| 1216 | :attr:`Context.clamp` attribute is now public. This is useful in creating |
| 1217 | contexts that correspond to the decimal interchange formats specified in IEEE |
| 1218 | 754 (see :issue:`8540`). |
| 1219 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1220 | (Contributed by Mark Dickinson and Raymond Hettinger.) |
Raymond Hettinger | 07a605b | 2010-12-15 22:35:03 +0000 | [diff] [blame] | 1221 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1222 | ftp |
| 1223 | --- |
Raymond Hettinger | bcbd696 | 2010-09-05 08:46:36 +0000 | [diff] [blame] | 1224 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1225 | The :class:`ftplib.FTP` class now supports the context manager protocol to |
| 1226 | unconditionally consume :exc:`socket.error` exceptions and to close the FTP |
| 1227 | connection when done:: |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 1228 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1229 | >>> from ftplib import FTP |
| 1230 | >>> with FTP("ftp1.at.proftpd.org") as ftp: |
| 1231 | ... ftp.login() |
| 1232 | ... ftp.dir() |
| 1233 | ... |
| 1234 | '230 Anonymous login ok, restrictions apply.' |
| 1235 | dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 . |
| 1236 | dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .. |
| 1237 | dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS |
| 1238 | dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1239 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1240 | Other file-like objects such as :class:`mmap.mmap` and :func:`fileinput.input` |
| 1241 | also grew auto-closing context managers:: |
| 1242 | |
| 1243 | with fileinput.input(files=('log1.txt', 'log2.txt')) as f: |
| 1244 | for line in f: |
| 1245 | process(line) |
| 1246 | |
| 1247 | (Contributed by Tarek Ziadé and Giampaolo Rodolà in :issue:`4972`, and |
| 1248 | by Georg Brandl in :issue:`8046` and :issue:`1286`.) |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 1249 | |
Antoine Pitrou | bcba434 | 2011-01-16 18:29:34 +0000 | [diff] [blame] | 1250 | The :class:`~ftplib.FTP_TLS` class now accepts a *context* parameter, which is a |
| 1251 | :class:`ssl.SSLContext` object allowing bundling SSL configuration options, |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1252 | certificates and private keys into a single (potentially long-lived) structure. |
Antoine Pitrou | bcba434 | 2011-01-16 18:29:34 +0000 | [diff] [blame] | 1253 | |
| 1254 | (Contributed by Giampaolo Rodolà; :issue:`8806`.) |
| 1255 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1256 | popen |
| 1257 | ----- |
| 1258 | |
| 1259 | The :func:`os.popen` and :func:`subprocess.Popen` functions now support |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1260 | :keyword:`with` statements for auto-closing of the file descriptors. |
Georg Brandl | 3ad4675 | 2010-12-05 07:59:29 +0000 | [diff] [blame] | 1261 | |
Raymond Hettinger | da4a05d | 2011-01-25 07:46:07 +0000 | [diff] [blame] | 1262 | select |
| 1263 | ------ |
| 1264 | |
| 1265 | The :mod:`select` module now exposes a new, constant attribute, |
| 1266 | :attr:`~select.PIPE_BUF`, which gives the minimum number of files that are |
| 1267 | guaranteed to not block on a write by the :func:`~select.select` or |
| 1268 | :func:`~select.poll` functions. |
| 1269 | |
| 1270 | >>> import select |
| 1271 | >>> select.PIPE_BUF |
| 1272 | 512 |
| 1273 | |
| 1274 | (Available on Unix systems.) |
| 1275 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1276 | gzip and zipfile |
| 1277 | ---------------- |
Antoine Pitrou | cd889af | 2010-10-06 21:13:56 +0000 | [diff] [blame] | 1278 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1279 | :class:`gzip.GzipFile` now implements the :class:`io.BufferedIOBase` |
| 1280 | :term:`abstract base class` (except for ``truncate()``). It also has a |
| 1281 | :meth:`~gzip.GzipFile.peek` method and supports unseekable as well as |
| 1282 | zero-padded file objects. |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1283 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1284 | The :mod:`gzip` module also gains the :func:`~gzip.compress` and |
| 1285 | :func:`~gzip.decompress` functions for easier in-memory compression and |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 1286 | 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] | 1287 | before compressing and decompressing: |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1288 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1289 | >>> s = 'Three shall be the number thou shalt count, ' |
| 1290 | >>> s += 'and the number of the counting shall be three' |
| 1291 | >>> b = s.encode() # convert to utf-8 |
| 1292 | >>> len(b) |
| 1293 | 89 |
| 1294 | >>> c = gzip.compress(b) |
| 1295 | >>> len(c) |
| 1296 | 77 |
| 1297 | >>> gzip.decompress(c).decode()[:42] # decompress and convert to text |
| 1298 | 'Three shall be the number thou shalt count,' |
Antoine Pitrou | cd889af | 2010-10-06 21:13:56 +0000 | [diff] [blame] | 1299 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1300 | (Contributed by Anand B. Pillai in :issue:`3488`; and by Antoine Pitrou, Nir |
| 1301 | Aides and Brian Curtin in :issue:`9962`, :issue:`1675951`, :issue:`7471` and |
| 1302 | :issue:`2846`.) |
| 1303 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1304 | Also, the :class:`zipfile.ZipExtFile` class was reworked internally to represent |
| 1305 | files stored inside an archive. The new implementation is significantly faster |
| 1306 | and can be wrapped in a :class:`io.BufferedReader` object for more speedups. It |
| 1307 | also solves an issue where interleaved calls to *read* and *readline* gave the |
| 1308 | wrong results. |
| 1309 | |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 1310 | (Patch submitted by Nir Aides in :issue:`7610`.) |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1311 | |
Raymond Hettinger | d0d59b1 | 2011-01-24 05:07:13 +0000 | [diff] [blame] | 1312 | hashlib |
| 1313 | ------- |
| 1314 | |
| 1315 | The :mod:`hashlib` module has two new constant attributes listing the hashing |
| 1316 | algorithms guaranteed to be present in all implementations and those available |
| 1317 | on the current implementation: |
| 1318 | |
| 1319 | >>> import hashlib |
| 1320 | >>> hashlib.algorithms_guaranteed |
| 1321 | {'sha1', 'sha224', 'sha384', 'sha256', 'sha512', 'md5'} |
| 1322 | >>> hashlib.algorithms_available |
| 1323 | {'md2', 'SHA256', 'SHA512', 'dsaWithSHA', 'mdc2', 'SHA224', 'MD4', 'sha256', |
| 1324 | 'sha512', 'ripemd160', 'SHA1', 'MDC2', 'SHA', 'SHA384', 'MD2', |
| 1325 | 'ecdsa-with-SHA1','md4', 'md5', 'sha1', 'DSA-SHA', 'sha224', |
| 1326 | 'dsaEncryption', 'DSA', 'RIPEMD160', 'sha', 'MD5', 'sha384'} |
| 1327 | |
| 1328 | (Suggested by Carl Chenet in :issue:`7418`.) |
| 1329 | |
Raymond Hettinger | 50307b6 | 2011-01-24 01:18:30 +0000 | [diff] [blame] | 1330 | ast |
| 1331 | --- |
| 1332 | |
| 1333 | The :mod:`ast` module has a wonderful a general-purpose tool for safely |
| 1334 | evaluating strings containing Python expressions using the Python literal |
| 1335 | syntax. The :func:`ast.literal_eval` function serves as a secure alternative to |
| 1336 | the builtin :func:`eval` function which is easily abused. Python 3.2 adds |
| 1337 | :class:`bytes` and :class:`set` literals to the list of supported types: |
| 1338 | strings, bytes, numbers, tuples, lists, dicts, sets, booleans, and None. |
| 1339 | |
| 1340 | :: |
| 1341 | |
| 1342 | >>> request = "{'req': 3, 'func': 'pow', 'args': (2, 0.5)}" |
| 1343 | >>> literal_eval(request) |
| 1344 | {'args': (2, 0.5), 'req': 3, 'func': 'pow'} |
| 1345 | |
| 1346 | >>> request = "os.system('do something harmful')" |
| 1347 | >>> literal_eval(request) |
| 1348 | Traceback (most recent call last): |
| 1349 | ... |
| 1350 | ValueError: malformed node or string: <_ast.Call object at 0x101739a10> |
| 1351 | |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 1352 | os |
| 1353 | -- |
| 1354 | |
| 1355 | Different operating systems use various encodings for filenames and environment |
| 1356 | variables. The :mod:`os` module provides two new functions, |
| 1357 | :func:`~os.fsencode` and :func:`~os.fsdecode`, for encoding and decoding |
| 1358 | filenames: |
| 1359 | |
Raymond Hettinger | 2e042d3 | 2011-01-21 09:18:19 +0000 | [diff] [blame] | 1360 | >>> filename = 'Sehenswürdigkeiten' |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 1361 | >>> os.fsencode(filename) |
Raymond Hettinger | 2e042d3 | 2011-01-21 09:18:19 +0000 | [diff] [blame] | 1362 | b'Sehensw\xc3\xbcrdigkeiten' |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 1363 | |
| 1364 | Some operating systems allow direct access to the unencoded bytes in the |
| 1365 | environment. If so, the :attr:`os.supports_bytes_environ` constant will be |
| 1366 | true. |
| 1367 | |
| 1368 | For direct access to unencoded environment variables (if available), |
| 1369 | use the new :func:`os.getenvb` function or use :data:`os.environb` |
| 1370 | which is a bytes version of :data:`os.environ`. |
| 1371 | |
| 1372 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1373 | shutil |
| 1374 | ------ |
| 1375 | |
| 1376 | The :func:`shutil.copytree` function has two new options: |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1377 | |
Antoine Pitrou | 121a055 | 2011-01-16 18:16:52 +0000 | [diff] [blame] | 1378 | * *ignore_dangling_symlinks*: when ``symlinks=False`` so that the function |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1379 | copies a file pointed to by a symlink, not the symlink itself. This option |
| 1380 | will silence the error raised if the file doesn't exist. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1381 | |
Antoine Pitrou | 121a055 | 2011-01-16 18:16:52 +0000 | [diff] [blame] | 1382 | * *copy_function*: is a callable that will be used to copy files. |
| 1383 | :func:`shutil.copy2` is used by default. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1384 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1385 | (Contributed by Tarek Ziadé.) |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1386 | |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 1387 | In addition, the :mod:`shutil` module now supports :ref:`archiving operations |
| 1388 | <archiving-operations>` for zipfiles, uncompressed tarfiles, gzipped tarfiles, |
| 1389 | and bzipped tarfiles. And there are functions for registering additional |
| 1390 | archiving file formats (such as xz compressed tarfiles or custom formats). |
| 1391 | |
| 1392 | The principal functions are :func:`~shutil.make_archive` and |
| 1393 | :func:`~shutil.unpack_archive`. By default, both operate on the current |
| 1394 | directory (which can be set by :func:`os.chdir`) and on any sub-directories. |
| 1395 | The archive filename needs to specified with a full pathname. The archiving |
| 1396 | step is non-destructive (the original files are left unchanged). |
| 1397 | |
| 1398 | :: |
| 1399 | |
| 1400 | >>> import shutil, pprint |
| 1401 | >>> os.chdir('mydata') # change to the source directory |
| 1402 | >>> f = make_archive('/var/backup/mydata', 'zip') # archive the current directory |
| 1403 | >>> f # show the name of archive |
| 1404 | '/var/backup/mydata.zip' |
| 1405 | >>> os.chdir('tmp') # change to an unpacking |
| 1406 | >>> shutil.unpack_archive('/var/backup/mydata.zip') # recover the data |
| 1407 | >>> pprint.pprint(shutil.get_archive_formats()) # display known formats |
| 1408 | [('bztar', "bzip2'ed tar-file"), |
| 1409 | ('gztar', "gzip'ed tar-file"), |
| 1410 | ('tar', 'uncompressed tar file'), |
| 1411 | ('zip', 'ZIP file')] |
| 1412 | >>> shutil.register_archive_format( # register a new archive format |
| 1413 | name = 'xz', |
| 1414 | function = 'xz.compress', |
| 1415 | extra_args = [('level', 8)], |
| 1416 | description = 'xz compression' |
| 1417 | ) |
| 1418 | |
| 1419 | (Contributed by Tarek Ziadé.) |
| 1420 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1421 | sqlite3 |
| 1422 | ------- |
Antoine Pitrou | e43f9d0 | 2010-08-08 23:24:50 +0000 | [diff] [blame] | 1423 | |
Raymond Hettinger | 6046e22 | 2010-12-16 00:21:08 +0000 | [diff] [blame] | 1424 | 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] | 1425 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 1426 | * The :attr:`sqlite3.Connection.in_transit` attribute is true if there is an |
| 1427 | active transaction for uncommitted changes. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1428 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 1429 | * The :meth:`sqlite3.Connection.enable_load_extension` and |
| 1430 | :meth:`sqlite3.Connection.load_extension` methods allows you to load SQLite |
| 1431 | extensions from ".so" files. One well-known extension is the fulltext-search |
| 1432 | extension distributed with SQLite. |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1433 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1434 | (Contributed by R. David Murray and Shashwat Anand; :issue:`8845`.) |
| 1435 | |
Raymond Hettinger | a3b7a14 | 2011-01-24 05:26:00 +0000 | [diff] [blame] | 1436 | html |
| 1437 | ---- |
| 1438 | |
| 1439 | A new :mod:`html` module was introduced with only a single function, |
| 1440 | :func:`~html.escape`, which is used for escaping reserved characters from HTML |
| 1441 | markup: |
| 1442 | |
| 1443 | >>> import html |
| 1444 | >>> html.escape('x > 2 && x < 7') |
| 1445 | 'x > 2 && x < 7' |
| 1446 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1447 | socket |
| 1448 | ------ |
| 1449 | |
| 1450 | The :mod:`socket` module has two new improvements. |
| 1451 | |
| 1452 | * Socket objects now have a :meth:`~socket.socket.detach()` method which puts |
| 1453 | the socket into closed state without actually closing the underlying file |
| 1454 | descriptor. The latter can then be reused for other purposes. |
| 1455 | (Added by Antoine Pitrou; :issue:`8524`.) |
| 1456 | |
| 1457 | * :func:`socket.create_connection` now supports the context manager protocol |
| 1458 | to unconditionally consume :exc:`socket.error` exceptions and to close the |
| 1459 | socket when done. |
| 1460 | (Contributed by Giampaolo Rodolà; :issue:`9794`.) |
| 1461 | |
| 1462 | ssl |
| 1463 | --- |
Antoine Pitrou | d67075e | 2010-07-31 22:48:02 +0000 | [diff] [blame] | 1464 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1465 | The :mod:`ssl` module added a number of features to satisfy common requirements |
| 1466 | for secure (encrypted, authenticated) internet connections: |
Antoine Pitrou | 33da1d6 | 2011-01-16 18:16:09 +0000 | [diff] [blame] | 1467 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1468 | * A new class, :class:`~ssl.SSLContext`, serves as a container for persistent |
| 1469 | SSL data, such as protocol settings, certificates, private keys, and various |
| 1470 | other options. It includes a :meth:`~ssl.SSLContext.wrap_socket` for creating |
| 1471 | an SSL socket from an SSL context. |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 1472 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1473 | * A new function, :func:`ssl.match_hostname`, supports server identity |
| 1474 | verification for higher-level protocols by implementing the rules of HTTPS |
| 1475 | (from :rfc:`2818`) which are also suitable for other protocols. |
Antoine Pitrou | 0ee4c9f | 2010-10-08 16:46:17 +0000 | [diff] [blame] | 1476 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1477 | * The :func:`ssl.wrap_socket` constructor function now takes a *ciphers* |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1478 | argument. The *ciphers* string lists the allowed encryption algorithms using |
| 1479 | the format described in the `OpenSSL documentation |
| 1480 | <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT>`__. |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 1481 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1482 | * When linked against recent versions of OpenSSL, the :mod:`ssl` module now |
| 1483 | supports the Server Name Indication extension to the TLS protocol, allowing |
| 1484 | multiple "virtual hosts" using different certificates on a single IP port. |
| 1485 | This extension is only supported in client mode, and is activated by passing |
| 1486 | the *server_hostname* argument to :meth:`ssl.SSLContext.wrap_socket`. |
Antoine Pitrou | 7d15a72 | 2010-11-05 22:13:55 +0000 | [diff] [blame] | 1487 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1488 | * Various options have been added to the :mod:`ssl` module, such as |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1489 | :data:`~ssl.OP_NO_SSLv2` which disables the insecure and obsolete SSLv2 |
| 1490 | protocol. |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 1491 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1492 | * The extension now loads all the OpenSSL ciphers and digest algorithms. If |
| 1493 | some SSL certificates cannot be verified, they are reported as an "unknown |
| 1494 | algorithm" error. |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 1495 | |
Raymond Hettinger | 4854d14 | 2011-01-17 21:29:58 +0000 | [diff] [blame] | 1496 | * The version of OpenSSL being used is now accessible using the module |
| 1497 | attributes :data:`ssl.OPENSSL_VERSION` (a string), |
| 1498 | :data:`ssl.OPENSSL_VERSION_INFO` (a 5-tuple), and |
| 1499 | :data:`ssl.OPENSSL_VERSION_NUMBER` (an integer). |
| 1500 | |
| 1501 | (Contributed by Antoine Pitrou in :issue:`8850`, :issue:`1589`, :issue:`8322`, |
| 1502 | :issue:`5639`, :issue:`4870`, :issue:`8484`, and :issue:`8321`.) |
Antoine Pitrou | 4f2a0a8 | 2010-07-31 18:08:33 +0000 | [diff] [blame] | 1503 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1504 | nntp |
| 1505 | ---- |
Raymond Hettinger | 070ec70 | 2010-12-10 17:45:13 +0000 | [diff] [blame] | 1506 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1507 | The :mod:`nntplib` module has a revamped implementation with better bytes and |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1508 | text semantics as well as more practical APIs. These improvements break |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1509 | compatibility with the nntplib version in Python 3.1, which was partly |
| 1510 | dysfunctional in itself. |
Raymond Hettinger | 070ec70 | 2010-12-10 17:45:13 +0000 | [diff] [blame] | 1511 | |
Antoine Pitrou | 33da1d6 | 2011-01-16 18:16:09 +0000 | [diff] [blame] | 1512 | Support for secure connections through both implicit (using |
| 1513 | :class:`nntplib.NNTP_SSL`) and explicit (using :meth:`nntplib.NNTP.starttls`) |
| 1514 | TLS has also been added. |
| 1515 | |
| 1516 | (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] | 1517 | |
| 1518 | certificates |
| 1519 | ------------ |
| 1520 | |
| 1521 | :class:`http.client.HTTPSConnection`, :class:`urllib.request.HTTPSHandler` |
| 1522 | and :func:`urllib.request.urlopen` now take optional arguments to allow for |
| 1523 | server certificate checking against a set of Certificate Authorities, |
| 1524 | as recommended in public uses of HTTPS. |
| 1525 | |
| 1526 | (Added by Antoine Pitrou, :issue:`9003`.) |
| 1527 | |
Antoine Pitrou | 2e8ec22 | 2011-01-16 18:41:36 +0000 | [diff] [blame] | 1528 | imaplib |
| 1529 | ------- |
| 1530 | |
| 1531 | Support for explicit TLS on standard IMAP4 connections has been added through |
| 1532 | the new :mod:`imaplib.IMAP4.starttls` method. |
| 1533 | |
| 1534 | (Contributed by Lorenzo M. Catucci and Antoine Pitrou, :issue:`4471`.) |
| 1535 | |
Raymond Hettinger | 399bf7b | 2011-01-24 10:11:12 +0000 | [diff] [blame] | 1536 | .. XXX sys._xoptions http://bugs.python.org/issue10089 |
| 1537 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1538 | unittest |
| 1539 | -------- |
Antoine Pitrou | afb078d | 2010-11-05 22:18:28 +0000 | [diff] [blame] | 1540 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1541 | The unittest module has a number of improvements supporting test discovery for |
| 1542 | packages, easier experimentation at the interactive prompt, new testcase |
| 1543 | methods, improved diagnostic messages for test failures, and better method |
| 1544 | names. |
| 1545 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1546 | * The command-line call ``python -m unittest`` can now accept file paths |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1547 | instead of module names for running specific tests (:issue:`10620`). The new |
| 1548 | test discovery can find tests within packages, locating any test importable |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 1549 | 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] | 1550 | the `-t` option, a pattern for matching files with ``-p``, and a directory to |
| 1551 | start discovery with ``-s``:: |
| 1552 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1553 | $ python -m unittest discover -s my_proj_dir -p _test.py |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1554 | |
| 1555 | (Contributed by Michael Foord.) |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1556 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1557 | * Experimentation at the interactive prompt is now easier because the |
| 1558 | :class:`unittest.case.TestCase` class can now be instantiated without |
| 1559 | arguments: |
| 1560 | |
| 1561 | >>> TestCase().assertEqual(pow(2, 3), 8) |
| 1562 | |
| 1563 | (Contributed by Michael Foord.) |
| 1564 | |
Raymond Hettinger | dc2f9b5 | 2010-12-05 07:02:45 +0000 | [diff] [blame] | 1565 | * The :mod:`unittest` module has two new methods, |
| 1566 | :meth:`~unittest.TestCase.assertWarns` and |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1567 | :meth:`~unittest.TestCase.assertWarnsRegex` to verify that a given warning type |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1568 | is triggered by the code under test:: |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1569 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1570 | with self.assertWarns(DeprecationWarning): |
| 1571 | legacy_function('XYZ') |
Ezio Melotti | 2baf1a6 | 2010-11-22 12:56:58 +0000 | [diff] [blame] | 1572 | |
Antoine Pitrou | eec6dbf | 2011-01-16 18:21:12 +0000 | [diff] [blame] | 1573 | (Contributed by Antoine Pitrou, :issue:`9754`.) |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1574 | |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 1575 | Another new method, :meth:`~unittest.TestCase.assertCountEqual` is used to |
Raymond Hettinger | ffad35e | 2010-12-14 21:12:03 +0000 | [diff] [blame] | 1576 | compare two iterables to determine if their element counts are equal (whether |
| 1577 | the same elements are present with the same number of occurrences regardless |
| 1578 | of order):: |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1579 | |
| 1580 | def test_anagram(self): |
| 1581 | self.assertCountEqual('algorithm', 'logarithm') |
| 1582 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1583 | (Contributed by Raymond Hettinger.) |
| 1584 | |
| 1585 | * 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] | 1586 | diagnostics when a test fails. When possible, the failure is recorded along |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1587 | with a diff of the output. This is especially helpful for analyzing log files |
| 1588 | of failed test runs. However, since diffs can sometime be voluminous, there is |
| 1589 | a new :attr:`~unittest.TestCase.maxDiff` attribute which sets maximum length of |
| 1590 | diffs. |
| 1591 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1592 | * In addition, the method names in the module have undergone a number of clean-ups. |
| 1593 | |
| 1594 | For example, :meth:`~unittest.TestCase.assertRegex` is the new name for |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1595 | :meth:`~unittest.TestCase.assertRegexpMatches` which was misnamed because the |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 1596 | test uses :func:`re.search`, not :func:`re.match`. Other methods using |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1597 | regular expressions are now named using short form "Regex" in preference to |
| 1598 | "Regexp" -- this matches the names used in other unittest implementations, |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 1599 | matches Python's old name for the :mod:`re` module, and it has unambiguous |
| 1600 | camel-casing. |
Raymond Hettinger | dc2f9b5 | 2010-12-05 07:02:45 +0000 | [diff] [blame] | 1601 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1602 | (Contributed by Raymond Hettinger and implemented by Ezio Melotti.) |
| 1603 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1604 | * To improve consistency, some long-standing method aliases are being |
Raymond Hettinger | dc2f9b5 | 2010-12-05 07:02:45 +0000 | [diff] [blame] | 1605 | deprecated in favor of the preferred names: |
| 1606 | |
Raymond Hettinger | c1dfa2e | 2011-01-19 04:24:57 +0000 | [diff] [blame] | 1607 | =============================== ============================== |
| 1608 | Old Name Preferred Name |
| 1609 | =============================== ============================== |
| 1610 | :meth:`assert_` :meth:`.assertTrue` |
| 1611 | :meth:`assertEquals` :meth:`.assertEqual` |
| 1612 | :meth:`assertNotEquals` :meth:`.assertNotEqual` |
| 1613 | :meth:`assertAlmostEquals` :meth:`.assertAlmostEqual` |
| 1614 | :meth:`assertNotAlmostEquals` :meth:`.assertNotAlmostEqual` |
| 1615 | =============================== ============================== |
Raymond Hettinger | dc2f9b5 | 2010-12-05 07:02:45 +0000 | [diff] [blame] | 1616 | |
| 1617 | Likewise, the ``TestCase.fail*`` methods deprecated in Python 3.1 are expected |
Raymond Hettinger | c1dfa2e | 2011-01-19 04:24:57 +0000 | [diff] [blame] | 1618 | 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] | 1619 | the :mod:`unittest` documentation. |
Ezio Melotti | 2baf1a6 | 2010-11-22 12:56:58 +0000 | [diff] [blame] | 1620 | |
| 1621 | (Contributed by Ezio Melotti; :issue:`9424`.) |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 1622 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1623 | * The :meth:`~unittest.TestCase.assertDictContainsSubset` method was deprecated |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 1624 | because it was misimplemented with the arguments in the wrong order. This |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 1625 | created hard-to-debug optical illusions where tests like |
| 1626 | ``TestCase().assertDictContainsSubset({'a':1, 'b':2}, {'a':1})`` would fail. |
| 1627 | |
| 1628 | (Contributed by Raymond Hettinger.) |
| 1629 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1630 | random |
| 1631 | ------ |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 1632 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 1633 | 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] | 1634 | uniform distributions. Previously, they computed selections with |
| 1635 | ``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] | 1636 | 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] | 1637 | selection is kept only when it falls within the range ``0 <= x < n``. The |
| 1638 | functions and methods affected are :func:`~random.randrange`, |
| 1639 | :func:`~random.randint`, :func:`~random.choice`, :func:`~random.shuffle` and |
| 1640 | :func:`~random.sample`. |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1641 | |
| 1642 | (Contributed by Raymond Hettinger; :issue:`9025`.) |
| 1643 | |
| 1644 | poplib |
| 1645 | ------ |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 1646 | |
Giampaolo Rodolà | 42382fe | 2010-08-17 16:09:53 +0000 | [diff] [blame] | 1647 | * :class:`~poplib.POP3_SSL` class now accepts a *context* parameter, which is a |
| 1648 | :class:`ssl.SSLContext` object allowing bundling SSL configuration options, |
| 1649 | certificates and private keys into a single (potentially long-lived) |
| 1650 | structure. |
| 1651 | |
| 1652 | (Contributed by Giampaolo Rodolà; :issue:`8807`.) |
| 1653 | |
Giampaolo Rodolà | 977c707 | 2010-10-04 21:08:36 +0000 | [diff] [blame] | 1654 | * :class:`asyncore.dispatcher` now provides a |
| 1655 | :meth:`~asyncore.dispatcher.handle_accepted()` method |
| 1656 | returning a `(sock, addr)` pair which is called when a connection has actually |
| 1657 | been established with a new remote endpoint. This is supposed to be used as a |
| 1658 | replacement for old :meth:`~asyncore.dispatcher.handle_accept()` and avoids |
| 1659 | the user to call :meth:`~asyncore.dispatcher.accept()` directly. |
| 1660 | |
| 1661 | (Contributed by Giampaolo Rodolà; :issue:`6706`.) |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 1662 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1663 | tempfile |
| 1664 | -------- |
Raymond Hettinger | a026633 | 2010-12-07 08:52:41 +0000 | [diff] [blame] | 1665 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1666 | The :mod:`tempfile` module has a new context manager, |
| 1667 | :class:`~tempfile.TemporaryDirectory` which provides easy deterministic |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1668 | cleanup of temporary directories:: |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1669 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1670 | with tempfile.TemporaryDirectory() as tmpdirname: |
| 1671 | print('created temporary dir:', tmpdirname) |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1672 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1673 | (Contributed by Neil Schemenauer and Nick Coghlan; :issue:`5178`.) |
Nick Coghlan | e0f0465 | 2010-11-21 03:44:04 +0000 | [diff] [blame] | 1674 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1675 | inspect |
| 1676 | ------- |
| 1677 | |
Raymond Hettinger | 0358a17 | 2010-12-15 19:00:38 +0000 | [diff] [blame] | 1678 | * The :mod:`inspect` module has a new function |
| 1679 | :func:`~inspect.getgeneratorstate` to easily identify the current state of a |
Raymond Hettinger | a275c98 | 2011-01-20 04:03:19 +0000 | [diff] [blame] | 1680 | generator-iterator:: |
Raymond Hettinger | 4bea978 | 2011-01-19 04:14:34 +0000 | [diff] [blame] | 1681 | |
Raymond Hettinger | a275c98 | 2011-01-20 04:03:19 +0000 | [diff] [blame] | 1682 | >>> from inspect import getgeneratorstate |
Raymond Hettinger | 4bea978 | 2011-01-19 04:14:34 +0000 | [diff] [blame] | 1683 | >>> def gen(): |
Raymond Hettinger | a275c98 | 2011-01-20 04:03:19 +0000 | [diff] [blame] | 1684 | yield 'demo' |
Raymond Hettinger | 4bea978 | 2011-01-19 04:14:34 +0000 | [diff] [blame] | 1685 | >>> g = gen() |
Raymond Hettinger | a275c98 | 2011-01-20 04:03:19 +0000 | [diff] [blame] | 1686 | >>> getgeneratorstate(g) |
Raymond Hettinger | 4bea978 | 2011-01-19 04:14:34 +0000 | [diff] [blame] | 1687 | 'GEN_CREATED' |
| 1688 | >>> next(g) |
Raymond Hettinger | a275c98 | 2011-01-20 04:03:19 +0000 | [diff] [blame] | 1689 | 'demo' |
| 1690 | >>> getgeneratorstate(g) |
Raymond Hettinger | 4bea978 | 2011-01-19 04:14:34 +0000 | [diff] [blame] | 1691 | 'GEN_SUSPENDED' |
Raymond Hettinger | a275c98 | 2011-01-20 04:03:19 +0000 | [diff] [blame] | 1692 | >>> next(g, None) |
| 1693 | >>> getgeneratorstate(g) |
| 1694 | 'GEN_CLOSED' |
Raymond Hettinger | 4bea978 | 2011-01-19 04:14:34 +0000 | [diff] [blame] | 1695 | |
| 1696 | (Contributed by Rodolpho Eckhardt and Nick Coghlan, :issue:`10220`.) |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1697 | |
Raymond Hettinger | a55ffbc | 2010-12-15 18:31:57 +0000 | [diff] [blame] | 1698 | * To support lookups without the possibility of activating a dynamic attribute, |
| 1699 | the :mod:`inspect` module has a new function, :func:`~inspect.getattr_static`. |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 1700 | 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] | 1701 | change state while it is searching:: |
| 1702 | |
| 1703 | >>> class A: |
| 1704 | @property |
| 1705 | def f(self): |
| 1706 | print('Running') |
| 1707 | return 10 |
| 1708 | |
| 1709 | >>> a = A() |
| 1710 | >>> getattr(a, 'f') |
| 1711 | Running |
| 1712 | 10 |
| 1713 | >>> inspect.getattr_static(a, 'f') |
| 1714 | <property object at 0x1022bd788> |
| 1715 | |
| 1716 | (Contributed by Michael Foord.) |
Nick Coghlan | e0f0465 | 2010-11-21 03:44:04 +0000 | [diff] [blame] | 1717 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1718 | pydoc |
| 1719 | ----- |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 1720 | |
Raymond Hettinger | 89c1cd1 | 2011-01-19 04:43:45 +0000 | [diff] [blame] | 1721 | The :mod:`pydoc` module now provides a much-improved Web server interface, as |
| 1722 | well as a new command-line option ``-b`` to automatically open a browser window |
| 1723 | to display that server:: |
| 1724 | |
| 1725 | $ pydoc3.2 -b |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 1726 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1727 | (Contributed by Ron Adam; :issue:`2001`.) |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1728 | |
Raymond Hettinger | acff595 | 2011-01-24 01:51:49 +0000 | [diff] [blame] | 1729 | dis |
| 1730 | --- |
| 1731 | |
| 1732 | The :mod:`dis` module gained two new functions for inspecting code, |
| 1733 | :func:`~dis.code_info` and :func:`~dis.show_code`. Both provide detailed code |
| 1734 | object information for the supplied function, method, source code string or code |
| 1735 | object. The former returns a string and the latter prints it:: |
| 1736 | |
| 1737 | >>> import dis, random |
| 1738 | >>> show_code(random.choice) |
| 1739 | Name: choice |
| 1740 | Filename: /Library/Frameworks/Python.framework/Versions/3.2/lib/python3.2/random.py |
| 1741 | Argument count: 2 |
| 1742 | Kw-only arguments: 0 |
| 1743 | Number of locals: 3 |
| 1744 | Stack size: 11 |
| 1745 | Flags: OPTIMIZED, NEWLOCALS, NOFREE |
| 1746 | Constants: |
| 1747 | 0: 'Choose a random element from a non-empty sequence.' |
| 1748 | 1: 'Cannot choose from an empty sequence' |
| 1749 | Names: |
| 1750 | 0: _randbelow |
| 1751 | 1: len |
| 1752 | 2: ValueError |
| 1753 | 3: IndexError |
| 1754 | Variable names: |
| 1755 | 0: self |
| 1756 | 1: seq |
| 1757 | 2: i |
| 1758 | |
| 1759 | (Contributed by Nick Coghlan in :issue:`9147`.) |
| 1760 | |
| 1761 | dbm |
| 1762 | --- |
| 1763 | |
| 1764 | All database modules now support :meth:`get` and :meth:`setdefault` are now |
| 1765 | available in all database modules |
| 1766 | |
| 1767 | (Suggested by Ray Allen in :issue:`9523`.) |
| 1768 | |
| 1769 | ctypes |
| 1770 | ------ |
| 1771 | |
| 1772 | A new type, :class:`ctypes.c_ssize_t` represents the C :c:type:`ssize_t` datatype. |
| 1773 | |
Raymond Hettinger | da4a05d | 2011-01-25 07:46:07 +0000 | [diff] [blame] | 1774 | site |
| 1775 | ---- |
| 1776 | |
| 1777 | The :mod:`site` module has three new functions useful for reporting on the |
| 1778 | details of a given Python installation. |
| 1779 | |
| 1780 | * :func:`~site.getsitepackages` lists all global site-packages directories. |
| 1781 | |
| 1782 | * :func:`~site.getuserbase` reports on the user's base directory where data can |
| 1783 | be stored. |
| 1784 | |
| 1785 | * :func:`~site.getusersitepackages` reveals the user-specific site-packages |
| 1786 | directory path. |
| 1787 | |
| 1788 | :: |
| 1789 | |
| 1790 | >>> site.getsitepackages() |
| 1791 | ['/Library/Frameworks/Python.framework/Versions/3.2/lib/python3.2/site-packages', |
| 1792 | '/Library/Frameworks/Python.framework/Versions/3.2/lib/site-python', |
| 1793 | '/Library/Python/3.2/site-packages'] |
| 1794 | >>> site.getuserbase() |
| 1795 | '/Users/raymondhettinger/Library/Python/3.2' |
| 1796 | >>> site.getusersitepackages() |
| 1797 | '/Users/raymondhettinger/Library/Python/3.2/lib/python/site-packages' |
| 1798 | |
| 1799 | Conveniently, some of site's functionality is accessible directly from the |
| 1800 | command-line:: |
| 1801 | |
| 1802 | $ python -m site --user-base |
| 1803 | /Users/raymondhettinger/.local |
| 1804 | $ python -m site --user-site |
| 1805 | /Users/raymondhettinger/.local/lib/python3.2/site-packages |
| 1806 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1807 | sysconfig |
| 1808 | --------- |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1809 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1810 | The new :mod:`sysconfig` module makes it straightforward to discover |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1811 | installation paths and configuration variables which vary across platforms and |
| 1812 | installations. |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1813 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1814 | The module offers access simple access functions for platform and version |
| 1815 | information: |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1816 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1817 | * :func:`~sysconfig.get_platform` returning values like *linux-i586* or |
| 1818 | *macosx-10.6-ppc*. |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1819 | * :func:`~sysconfig.get_python_version` returns a Python version string |
| 1820 | such as "3.2". |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1821 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1822 | It also provides access to the paths and variables corresponding to one of |
| 1823 | seven named schemes used by :mod:`distutils`. Those include *posix_prefix*, |
| 1824 | *posix_home*, *posix_user*, *nt*, *nt_user*, *os2*, *os2_home*: |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1825 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1826 | * :func:`~sysconfig.get_paths` makes a dictionary containing installation paths |
| 1827 | for the current installation scheme. |
| 1828 | * :func:`~sysconfig.get_config_vars` returns a dictionary of platform specific |
| 1829 | variables. |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1830 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1831 | There is also a convenient command-line interface:: |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1832 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1833 | C:\Python32>python -m sysconfig |
| 1834 | Platform: "win32" |
| 1835 | Python version: "3.2" |
| 1836 | Current installation scheme: "nt" |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1837 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1838 | Paths: |
| 1839 | data = "C:\Python32" |
Łukasz Langa | 79a06ed | 2010-12-17 22:05:46 +0000 | [diff] [blame] | 1840 | include = "C:\Python32\Include" |
| 1841 | platinclude = "C:\Python32\Include" |
| 1842 | platlib = "C:\Python32\Lib\site-packages" |
| 1843 | platstdlib = "C:\Python32\Lib" |
| 1844 | purelib = "C:\Python32\Lib\site-packages" |
| 1845 | scripts = "C:\Python32\Scripts" |
| 1846 | stdlib = "C:\Python32\Lib" |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1847 | |
| 1848 | Variables: |
| 1849 | BINDIR = "C:\Python32" |
Łukasz Langa | 79a06ed | 2010-12-17 22:05:46 +0000 | [diff] [blame] | 1850 | BINLIBDEST = "C:\Python32\Lib" |
| 1851 | EXE = ".exe" |
| 1852 | INCLUDEPY = "C:\Python32\Include" |
| 1853 | LIBDEST = "C:\Python32\Lib" |
| 1854 | SO = ".pyd" |
| 1855 | VERSION = "32" |
| 1856 | abiflags = "" |
| 1857 | base = "C:\Python32" |
| 1858 | exec_prefix = "C:\Python32" |
| 1859 | platbase = "C:\Python32" |
| 1860 | prefix = "C:\Python32" |
| 1861 | projectbase = "C:\Python32" |
| 1862 | py_version = "3.2" |
| 1863 | py_version_nodot = "32" |
| 1864 | py_version_short = "3.2" |
| 1865 | srcdir = "C:\Python32" |
| 1866 | userbase = "C:\Documents and Settings\Raymond\Application Data\Python" |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 1867 | |
| 1868 | pdb |
| 1869 | --- |
| 1870 | |
| 1871 | The :mod:`pdb` debugger module gained a number of usability improvements: |
Raymond Hettinger | b5d7933 | 2010-12-07 02:04:56 +0000 | [diff] [blame] | 1872 | |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 1873 | * :file:`pdb.py` now has a ``-c`` option that executes commands as given in a |
| 1874 | :file:`.pdbrc` script file. |
| 1875 | * A :file:`.pdbrc` script file can contain ``continue`` and ``next`` commands |
| 1876 | that continue debugging. |
| 1877 | * The :class:`Pdb` class constructor now accepts a *nosigint* argument. |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 1878 | * New commands: ``l(list)``, ``ll(long list)`` and ``source`` for |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 1879 | listing source code. |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1880 | * New commands: ``display`` and ``undisplay`` for showing or hiding |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 1881 | the value of an expression if it has changed. |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1882 | * New command: ``interact`` for starting an interactive interpreter containing |
Raymond Hettinger | 99db3fd | 2010-12-15 19:33:49 +0000 | [diff] [blame] | 1883 | the global and local names found in the current scope. |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 1884 | * Breakpoints can be cleared by breakpoint number. |
Raymond Hettinger | b5d7933 | 2010-12-07 02:04:56 +0000 | [diff] [blame] | 1885 | |
Georg Brandl | 101234b | 2010-12-18 11:53:25 +0000 | [diff] [blame] | 1886 | (Contributed by Georg Brandl, Antonio Cuni and Ilya Sandler.) |
| 1887 | |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1888 | configparser |
| 1889 | ------------ |
Raymond Hettinger | 3f9734c | 2010-12-07 01:47:52 +0000 | [diff] [blame] | 1890 | |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1891 | The :mod:`configparser` module was modified to improve usability and |
| 1892 | predictability of the default parser and its supported INI syntax. The old |
| 1893 | :class:`ConfigParser` class was removed in favor of :class:`SafeConfigParser` |
Raymond Hettinger | 0412974 | 2010-12-18 10:57:50 +0000 | [diff] [blame] | 1894 | which has in turn been renamed to :class:`~configparser.ConfigParser`. Support |
| 1895 | for inline comments is now turned off by default and section or option |
| 1896 | duplicates are not allowed in a single configuration source. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1897 | |
| 1898 | Config parsers gained a new API based on the mapping protocol:: |
| 1899 | |
Raymond Hettinger | 02dd70b | 2011-01-17 23:39:39 +0000 | [diff] [blame] | 1900 | >>> parser = ConfigParser() |
| 1901 | >>> parser.read_string(""" |
| 1902 | [DEFAULT] |
| 1903 | location = upper left |
| 1904 | visible = yes |
| 1905 | editable = no |
| 1906 | color = blue |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1907 | |
Raymond Hettinger | 02dd70b | 2011-01-17 23:39:39 +0000 | [diff] [blame] | 1908 | [main] |
| 1909 | title = Main Menu |
| 1910 | color = green |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1911 | |
Raymond Hettinger | 02dd70b | 2011-01-17 23:39:39 +0000 | [diff] [blame] | 1912 | [options] |
| 1913 | title = Options |
| 1914 | """) |
| 1915 | >>> parser['main']['color'] |
| 1916 | 'green' |
| 1917 | >>> parser['main']['editable'] |
| 1918 | 'no' |
| 1919 | >>> section = parser['options'] |
| 1920 | >>> section['title'] |
| 1921 | 'Options' |
| 1922 | >>> section['title'] = 'Options (editable: %(editable)s)' |
| 1923 | >>> section['title'] |
| 1924 | 'Options (editable: no)' |
| 1925 | |
| 1926 | 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] | 1927 | subclasses should be able to use it without modifications. |
| 1928 | |
| 1929 | 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] | 1930 | can specify alternative option/value delimiters and comment prefixes, change the |
Raymond Hettinger | 02dd70b | 2011-01-17 23:39:39 +0000 | [diff] [blame] | 1931 | name of the *DEFAULT* section or switch the interpolation syntax. |
| 1932 | |
Raymond Hettinger | ba5512f | 2011-01-18 08:28:01 +0000 | [diff] [blame] | 1933 | There is support for pluggable interpolation including an additional interpolation |
Raymond Hettinger | 02dd70b | 2011-01-17 23:39:39 +0000 | [diff] [blame] | 1934 | handler :class:`~configparser.ExtendedInterpolation`:: |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1935 | |
| 1936 | >>> parser = ConfigParser(interpolation=ExtendedInterpolation()) |
| 1937 | >>> parser.read_dict({'buildout': {'directory': '/home/ambv/zope9'}, |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1938 | 'custom': {'prefix': '/usr/local'}}) |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1939 | >>> parser.read_string(""" |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 1940 | [buildout] |
| 1941 | parts = |
| 1942 | zope9 |
| 1943 | instance |
| 1944 | find-links = |
| 1945 | ${buildout:directory}/downloads/dist |
| 1946 | |
| 1947 | [zope9] |
| 1948 | recipe = plone.recipe.zope9install |
| 1949 | location = /opt/zope |
| 1950 | |
| 1951 | [instance] |
| 1952 | recipe = plone.recipe.zope9instance |
| 1953 | zope9-location = ${zope9:location} |
| 1954 | zope-conf = ${custom:prefix}/etc/zope.conf |
| 1955 | """) |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1956 | >>> parser['buildout']['find-links'] |
| 1957 | '\n/home/ambv/zope9/downloads/dist' |
| 1958 | >>> parser['instance']['zope-conf'] |
| 1959 | '/usr/local/etc/zope.conf' |
| 1960 | >>> instance = parser['instance'] |
| 1961 | >>> instance['zope-conf'] |
| 1962 | '/usr/local/etc/zope.conf' |
| 1963 | >>> instance['zope9-location'] |
| 1964 | '/opt/zope' |
| 1965 | |
| 1966 | A number of smaller features were also introduced, like support for specifying |
Raymond Hettinger | 0412974 | 2010-12-18 10:57:50 +0000 | [diff] [blame] | 1967 | encoding in read operations, specifying fallback values for get-functions, or |
| 1968 | reading directly from dictionaries and strings. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 1969 | |
| 1970 | (All changes contributed by Łukasz Langa.) |
| 1971 | |
Raymond Hettinger | 9a236b0 | 2011-01-24 09:01:27 +0000 | [diff] [blame] | 1972 | urllib.parse |
| 1973 | ------------ |
| 1974 | |
| 1975 | A number of usability improvements were made for the :mod:`urllib.parse` module. |
| 1976 | |
| 1977 | The :func:`~urllib.parse.urlparse` function now supports `IPv6 |
| 1978 | <http://en.wikipedia.org/wiki/IPv6>`_ addresses as described in :rfc:`2732`: |
| 1979 | |
| 1980 | >>> import urllib.parse |
| 1981 | >>> urllib.parse.urlparse('http://[dead:beef:cafe:5417:affe:8FA3:deaf:feed]/foo/') |
| 1982 | ParseResult(scheme='http', |
| 1983 | netloc='[dead:beef:cafe:5417:affe:8FA3:deaf:feed]', |
| 1984 | path='/foo/', |
| 1985 | params='', |
| 1986 | query='', |
| 1987 | fragment='') |
| 1988 | |
| 1989 | The :func:`~urllib.parse.urldefrag` function now returns a :term:`named tuple`:: |
| 1990 | |
| 1991 | >>> r = urllib.parse.urldefrag('http://python.org/about/#target') |
| 1992 | >>> r |
| 1993 | DefragResult(url='http://python.org/about/', fragment='target') |
| 1994 | >>> r[0] |
| 1995 | 'http://python.org/about/ |
| 1996 | >>> r.fragment |
| 1997 | 'target' |
| 1998 | |
| 1999 | And, the :func:`~urllib.parse.urlencode` function is now much more flexible, |
| 2000 | accepting either a string or bytes type for the *query* argument. If it is a |
| 2001 | string, then the *safe*, *encoding*, and *error* parameters are sent to |
| 2002 | :func:`~urllib.parse.quote_plus` for encoding:: |
| 2003 | |
| 2004 | >>> urllib.parse.urlencode([ |
| 2005 | ('type', 'telenovela'), |
| 2006 | ('name', '¿Dónde Está Elisa?')], |
| 2007 | encoding='latin-1') |
| 2008 | 'type=telenovela&name=%BFD%F3nde+Est%E1+Elisa%3F' |
| 2009 | |
Georg Brandl | 009a6bd | 2011-01-24 19:59:08 +0000 | [diff] [blame] | 2010 | As detailed in :ref:`parsing-ascii-encoded-bytes`, all the :mod:`urllib.parse` |
Raymond Hettinger | 9a236b0 | 2011-01-24 09:01:27 +0000 | [diff] [blame] | 2011 | functions now accept ASCII-encoded byte strings as input, so long as they are |
| 2012 | not mixed with regular strings. If ASCII-encoded byte strings are given as |
| 2013 | parameters, the return types will also be an ASCII-encoded byte strings: |
| 2014 | |
| 2015 | >>> urllib.parse.urlparse(b'http://www.python.org:80/about/') |
| 2016 | ParseResultBytes(scheme=b'http', netloc=b'www.python.org:80', |
| 2017 | path=b'/about/', params=b'', query=b'', fragment=b'') |
| 2018 | |
| 2019 | (Work by Nick Coghlan, Dan Mahn, and Senthil Kumaran in :issue:`2987`, |
| 2020 | :issue:`5468`, and :issue:`9873`.) |
| 2021 | |
Raymond Hettinger | 2f707c9 | 2011-01-25 06:58:01 +0000 | [diff] [blame] | 2022 | turtledemo |
| 2023 | ---------- |
| 2024 | |
| 2025 | The demonstration code for the :mod:`turtle` module was moved from the *Demo* |
| 2026 | directory to main library. It includes over a dozen sample scripts with |
| 2027 | lively displays. Being on :attr:`sys.path`, it can now be run directly |
| 2028 | from the command-line:: |
| 2029 | |
| 2030 | $ python -m turtledemo |
| 2031 | |
Raymond Hettinger | 3df4621 | 2011-01-06 02:01:26 +0000 | [diff] [blame] | 2032 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 2033 | Multi-threading |
| 2034 | =============== |
| 2035 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2036 | * The mechanism for serializing execution of concurrently running Python threads |
Raymond Hettinger | ba5512f | 2011-01-18 08:28:01 +0000 | [diff] [blame] | 2037 | (generally known as the :term:`GIL` or :term:`Global Interpreter Lock`) has |
| 2038 | been rewritten. Among the objectives were more predictable switching |
| 2039 | intervals and reduced overhead due to lock contention and the number of |
| 2040 | ensuing system calls. The notion of a "check interval" to allow thread |
| 2041 | switches has been abandoned and replaced by an absolute duration expressed in |
| 2042 | seconds. This parameter is tunable through :func:`sys.setswitchinterval()`. |
| 2043 | It currently defaults to 5 milliseconds. |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 2044 | |
| 2045 | Additional details about the implementation can be read from a `python-dev |
| 2046 | mailing-list message |
| 2047 | <http://mail.python.org/pipermail/python-dev/2009-October/093321.html>`_ |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2048 | (however, "priority requests" as exposed in this message have not been kept |
| 2049 | for inclusion). |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 2050 | |
Georg Brandl | 5e73a81 | 2010-04-22 07:02:51 +0000 | [diff] [blame] | 2051 | (Contributed by Antoine Pitrou.) |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 2052 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2053 | * Regular and recursive locks now accept an optional *timeout* argument to their |
Raymond Hettinger | ba5512f | 2011-01-18 08:28:01 +0000 | [diff] [blame] | 2054 | :meth:`~threading.Lock.acquire` method. (Contributed by Antoine Pitrou; |
| 2055 | :issue:`7316`.) |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2056 | |
Raymond Hettinger | bba537b | 2010-12-15 18:20:19 +0000 | [diff] [blame] | 2057 | * Similarly, :meth:`threading.Semaphore.acquire` also gained a *timeout* |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2058 | argument. (Contributed by Torsten Landschoff; :issue:`850728`.) |
Antoine Pitrou | e95a9ff | 2010-05-04 23:31:41 +0000 | [diff] [blame] | 2059 | |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 2060 | * Regular and recursive lock acquisitions can now be interrupted by signals on |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 2061 | platforms using Pthreads. This means that Python programs that deadlock while |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 2062 | acquiring locks can be successfully killed by repeatedly sending SIGINT to the |
Georg Brandl | eebb252 | 2010-12-18 12:01:15 +0000 | [diff] [blame] | 2063 | process (by pressing :kbd:`Ctrl+C` in most shells). |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 2064 | (Contributed by Reid Kleckner; :issue:`8844`.) |
| 2065 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 2066 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 2067 | Optimizations |
| 2068 | ============= |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 2069 | |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 2070 | A number of small performance enhancements have been added: |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 2071 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 2072 | * 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] | 2073 | being a test for membership in a set of constants. The optimizer recasts the |
| 2074 | :class:`set` as a :class:`frozenset` and stores the pre-built constant. |
| 2075 | |
| 2076 | Now that the speed penalty is gone, it is practical to start writing |
| 2077 | membership tests using set-notation. This style is both semantically clear |
| 2078 | and operationally fast:: |
| 2079 | |
| 2080 | extension = name.rpartition('.')[2] |
| 2081 | if extension in {'xml', 'html', 'xhtml', 'css'}: |
| 2082 | handle(name) |
| 2083 | |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 2084 | (Patch and additional tests contributed by Dave Malcolm; :issue:`6690`). |
Raymond Hettinger | 92ba286 | 2010-09-06 01:16:46 +0000 | [diff] [blame] | 2085 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 2086 | * Serializing and unserializing data using the :mod:`pickle` module is now |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 2087 | several times faster. |
| 2088 | |
| 2089 | (Contributed by Alexandre Vassalotti, Antoine Pitrou |
Antoine Pitrou | ff150f2 | 2010-10-22 21:41:05 +0000 | [diff] [blame] | 2090 | and the Unladen Swallow team in :issue:`9410` and :issue:`3873`.) |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 2091 | |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 2092 | * The `Timsort algorithm <http://en.wikipedia.org/wiki/Timsort>`_ used in |
Raymond Hettinger | ffad35e | 2010-12-14 21:12:03 +0000 | [diff] [blame] | 2093 | :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] | 2094 | when called with a :term:`key function`. Previously, every element of |
| 2095 | 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] | 2096 | associated with each element. Now, two arrays of keys and values are |
Raymond Hettinger | c136b04 | 2011-01-18 07:15:39 +0000 | [diff] [blame] | 2097 | sorted in parallel. This saves the memory consumed by the sort wrappers, |
| 2098 | and it saves time lost to delegating comparisons. |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 2099 | |
Raymond Hettinger | eb70b90 | 2011-01-10 21:26:49 +0000 | [diff] [blame] | 2100 | (Patch by Daniel Stutzbach in :issue:`9915`.) |
Raymond Hettinger | c269ae8 | 2010-12-05 01:01:52 +0000 | [diff] [blame] | 2101 | |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 2102 | * JSON decoding performance is improved and memory consumption is reduced |
Raymond Hettinger | 413abbc | 2010-12-05 07:06:47 +0000 | [diff] [blame] | 2103 | whenever the same string is repeated for multiple keys. Also, JSON encoding |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 2104 | now uses the C speedups when the ``sort_keys`` argument is true. |
| 2105 | |
| 2106 | (Contributed by Antoine Pitrou in :issue:`7451` and by Raymond Hettinger and |
| 2107 | Antoine Pitrou in :issue:`10314`.) |
| 2108 | |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 2109 | * Recursive locks (created with the :func:`threading.RLock` API) now benefit |
| 2110 | from a C implementation which makes them as fast as regular locks, and between |
| 2111 | 10x and 15x faster than their previous pure Python implementation. |
| 2112 | |
| 2113 | (Contributed by Antoine Pitrou; :issue:`3001`.) |
| 2114 | |
Raymond Hettinger | dadf93c | 2010-12-05 02:56:21 +0000 | [diff] [blame] | 2115 | * The fast-search algorithm in stringlib is now used by the :meth:`split`, |
| 2116 | :meth:`rsplit`, :meth:`splitlines` and :meth:`replace` methods on |
| 2117 | :class:`bytes`, :class:`bytearray` and :class:`str` objects. Likewise, the |
| 2118 | algorithm is also used by :meth:`rfind`, :meth:`rindex`, :meth:`rsplit` and |
| 2119 | :meth:`rpartition`. |
| 2120 | |
| 2121 | (Patch by Florent Xicluna in :issue:`7622` and :issue:`7462`.) |
| 2122 | |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 2123 | |
| 2124 | * String to integer conversions now work two "digits" at a time, reducing the |
| 2125 | number of division and modulo operations. |
| 2126 | |
| 2127 | (:issue:`6713` by Gawain Bolton, Mark Dickinson, and Victor Stinner.) |
| 2128 | |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 2129 | There were several other minor optimizations. Set differencing now runs faster |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 2130 | 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] | 2131 | :issue:`8685`). The :meth:`array.repeat` method has a faster implementation |
| 2132 | (:issue:`1569291` by Alexander Belopolsky). The :class:`BaseHTTPRequestHandler` |
| 2133 | has more efficient buffering (:issue:`3709` by Andrew Schaaf). The |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 2134 | multi-argument form of :func:`operator.attrgetter` function now runs slightly |
Raymond Hettinger | d8fae4e | 2010-12-05 05:39:54 +0000 | [diff] [blame] | 2135 | faster (:issue:`10160` by Christos Georgiou). And :class:`ConfigParser` loads |
| 2136 | multi-line arguments a bit faster (:issue:`7113` by Łukasz Langa). |
| 2137 | |
Antoine Pitrou | d305200 | 2010-09-15 15:09:40 +0000 | [diff] [blame] | 2138 | |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 2139 | Unicode |
| 2140 | ======= |
Victor Stinner | 94908bb | 2010-08-18 21:23:25 +0000 | [diff] [blame] | 2141 | |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 2142 | Python has been updated to `Unicode 6.0.0 |
| 2143 | <http://unicode.org/versions/Unicode6.0.0/>`_. The update to the standard adds |
| 2144 | over 2,000 new characters including `emoji <http://en.wikipedia.org/wiki/Emoji>`_ |
| 2145 | symbols which are important for mobile phones. |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 2146 | |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 2147 | In addition, the updated standard has altered the character properties for two |
| 2148 | Kannada characters (U+0CF1, U+0CF2) and one New Tai Lue numeric character |
| 2149 | (U+19DA), making the former eligible for use in identifiers while disqualifying |
| 2150 | the latter. For more information, see `Unicode Character Database Changes |
| 2151 | <http://www.unicode.org/versions/Unicode6.0.0/#Database_Changes>`_. |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 2152 | |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 2153 | |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 2154 | Codecs |
| 2155 | ====== |
Raymond Hettinger | c74d518 | 2010-12-02 01:38:25 +0000 | [diff] [blame] | 2156 | |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 2157 | Support was added for *cp720* Arabic DOS encoding (:issue:`1616979`). |
Alexander Belopolsky | 84cc062 | 2010-12-08 21:38:46 +0000 | [diff] [blame] | 2158 | |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 2159 | MBCS encoding no longer ignores the error handler argument. In the default |
| 2160 | strict mode, it raises an :exc:`UnicodeDecodeError` when it encounters an |
| 2161 | undecodable byte sequence and an :exc:`UnicodeEncodeError` for an unencodable |
| 2162 | character. |
Alexander Belopolsky | 507e3f8 | 2010-12-02 00:05:57 +0000 | [diff] [blame] | 2163 | |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 2164 | The MBCS codec supports ``'strict'`` and ``'ignore'`` error handlers for |
| 2165 | decoding, and ``'strict'`` and ``'replace'`` for encoding. |
Victor Stinner | e8d5145 | 2010-08-19 01:05:19 +0000 | [diff] [blame] | 2166 | |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 2167 | To emulate Python3.1 MBCS encoding, select the ``'ignore'`` handler for decoding |
| 2168 | and the ``'replace'`` handler for encoding. |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 2169 | |
Raymond Hettinger | 2e042d3 | 2011-01-21 09:18:19 +0000 | [diff] [blame] | 2170 | On Mac OS X, Python decodes command line arguments with ``'utf-8'`` rather than |
Raymond Hettinger | 2270d58 | 2011-01-20 09:04:39 +0000 | [diff] [blame] | 2171 | the locale encoding. |
Victor Stinner | 47ce965 | 2010-10-29 00:57:35 +0000 | [diff] [blame] | 2172 | |
Raymond Hettinger | 00db6aa | 2011-01-20 09:47:04 +0000 | [diff] [blame] | 2173 | By default, :mod:`tarfile` uses ``'utf-8'`` encoding on Windows (instead of |
| 2174 | ``'mbcs'``) and the ``'surrogateescape'`` error handler on all operating |
| 2175 | systems. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 2176 | |
Victor Stinner | 94908bb | 2010-08-18 21:23:25 +0000 | [diff] [blame] | 2177 | |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 2178 | Documentation |
| 2179 | ============= |
| 2180 | |
| 2181 | The documentation continues to be improved. |
| 2182 | |
| 2183 | A table of quick links has been added to the top of lengthy sections such as |
| 2184 | :ref:`built-in-funcs`. In the case of :mod:`itertools`, the links are |
| 2185 | accompanied by tables of cheatsheet-style summaries to provide an overview and |
| 2186 | memory jog without having to read all of the docs. |
| 2187 | |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 2188 | In some cases, the pure Python source code can be a helpful adjunct to the |
| 2189 | documentation, so now many modules now feature quick links to the latest version |
| 2190 | of the source code. For example, the :mod:`functools` module documentation has |
| 2191 | 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] | 2192 | |
| 2193 | The docs now contain more examples and recipes. In particular, :mod:`re` module |
| 2194 | has an extensive section, :ref:`re-examples`. Likewise, the :mod:`itertools` |
| 2195 | module continues to be updated with new :ref:`itertools-recipes`. |
| 2196 | |
Raymond Hettinger | 677e10a | 2010-12-07 06:45:30 +0000 | [diff] [blame] | 2197 | The :mod:`datetime` module now has an auxiliary implementation in pure Python. |
| 2198 | No functionality was changed. This just provides an easier-to-read |
| 2199 | alternate implementation. (Contributed by Alexander Belopolsky.) |
| 2200 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 2201 | The unmaintained :file:`Demo` directory has been removed. Some demos were |
| 2202 | integrated into the documentation, some were moved to the :file:`Tools/demo` |
| 2203 | directory, and others were removed altogether. (Contributed by Georg Brandl.) |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 2204 | |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 2205 | |
| 2206 | IDLE |
| 2207 | ==== |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 2208 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 2209 | * 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] | 2210 | trailing whitespace. |
| 2211 | |
| 2212 | (Contributed by Raymond Hettinger; :issue:`5150`.) |
| 2213 | |
| 2214 | * IDLE on Mac OS X now works with both Carbon AquaTk and Cocoa AquaTk. |
| 2215 | |
| 2216 | (Contributed by Kevin Walzer, Ned Deily, and Ronald Oussoren; :issue:`6075`.) |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 2217 | |
Raymond Hettinger | 00db6aa | 2011-01-20 09:47:04 +0000 | [diff] [blame] | 2218 | Code Repository |
| 2219 | =============== |
| 2220 | |
| 2221 | In addition to the existing Subversion code repository at http://svn.python.org |
| 2222 | there is now a `Mercurial <http://mercurial.selenic.com/>`_ repository at |
| 2223 | http://hg.python.org/ . |
| 2224 | |
| 2225 | After the 3.2 release, there are plans to switch to Mercurial as the primary |
| 2226 | repository. This distributed version control system should make it easier for |
| 2227 | members of the community to create and share external changesets. See |
| 2228 | :pep:`385` for details. |
| 2229 | |
| 2230 | To learn to use the new version control system, see the `tutorial by Joel |
Raymond Hettinger | 2f707c9 | 2011-01-25 06:58:01 +0000 | [diff] [blame] | 2231 | Spolsky <http://hginit.com>`_ or the `Guide to Mercurial Workflows |
Raymond Hettinger | 00db6aa | 2011-01-20 09:47:04 +0000 | [diff] [blame] | 2232 | <http://mercurial.selenic.com/guide/>`_. |
| 2233 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 2234 | |
| 2235 | Build and C API Changes |
| 2236 | ======================= |
| 2237 | |
| 2238 | Changes to Python's build process and to the C API include: |
| 2239 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 2240 | * The *idle*, *pydoc* and *2to3* scripts are now installed with a |
| 2241 | version-specific suffix on ``make altinstall`` (:issue:`10679`). |
| 2242 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2243 | * The C functions that access the Unicode Database now accept and return |
| 2244 | characters from the full Unicode range, even on narrow unicode builds |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 2245 | (Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and others). A visible difference |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2246 | in Python is that :func:`unicodedata.numeric` now returns the correct value |
| 2247 | for large code points, and :func:`repr` may consider more characters as |
| 2248 | printable. |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 2249 | |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 2250 | (Reported by Bupjoe Lee and fixed by Amaury Forgeot D'Arc; :issue:`5127`.) |
| 2251 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2252 | * Computed gotos are now enabled by default on supported compilers (which are |
Raymond Hettinger | db9044e | 2010-09-06 01:29:23 +0000 | [diff] [blame] | 2253 | detected by the configure script). They can still be disabled selectively by |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2254 | specifying ``--without-computed-gotos``. |
Raymond Hettinger | 1784ff0 | 2010-09-05 01:00:19 +0000 | [diff] [blame] | 2255 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2256 | (Contributed by Antoine Pitrou; :issue:`9203`.) |
| 2257 | |
Amaury Forgeot d'Arc | feb7307 | 2010-09-12 22:42:57 +0000 | [diff] [blame] | 2258 | * The option ``--with-wctype-functions`` was removed. The built-in unicode |
| 2259 | database is now used for all functions. |
| 2260 | |
| 2261 | (Contributed by Amaury Forgeot D'Arc; :issue:`9210`.) |
| 2262 | |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 2263 | * Hash values are now values of a new type, :c:type:`Py_hash_t`, which is |
| 2264 | defined to be the same size as a pointer. Previously they were of type long, |
| 2265 | which on some 64-bit operating systems is still only 32 bits long. As a |
| 2266 | result of this fix, :class:`set` and :class:`dict` can now hold more than |
| 2267 | ``2**32`` entries on builds with 64-bit pointers (previously, they could grow |
| 2268 | to that size but their performance degraded catastrophically). |
Skip Montanaro | 961aaf5 | 2010-10-17 22:22:24 +0000 | [diff] [blame] | 2269 | |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 2270 | (Suggested by Raymond Hettinger and implemented by Benjamin Peterson; |
| 2271 | :issue:`9778`.) |
| 2272 | |
| 2273 | * 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] | 2274 | 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] | 2275 | (:issue:`2443`). |
| 2276 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 2277 | * A new C API function :c:func:`PySys_SetArgvEx` allows an embedded interpreter |
| 2278 | to set :attr:`sys.argv` without also modifying :attr:`sys.path` |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 2279 | (:issue:`5753`). |
| 2280 | |
| 2281 | * :c:macro:`PyEval_CallObject` is now only available in macro form. The |
| 2282 | function declaration, which was kept for backwards compatibility reasons, is |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 2283 | now removed -- the macro was introduced in 1997 (:issue:`8276`). |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 2284 | |
| 2285 | * The is a new function :c:func:`PyLong_AsLongLongAndOverflow` which |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 2286 | is analogous to :c:func:`PyLong_AsLongAndOverflow`. They both serve to |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 2287 | convert Python :class:`int` into a native fixed-width type while providing |
| 2288 | detection of cases where the conversion won't fit (:issue:`7767`). |
| 2289 | |
| 2290 | * The :c:func:`PyUnicode_CompareWithASCIIString` now returns *not equal* |
Raymond Hettinger | ba5512f | 2011-01-18 08:28:01 +0000 | [diff] [blame] | 2291 | if the Python string is *NUL* terminated. |
Raymond Hettinger | 480ed78 | 2010-12-15 22:07:15 +0000 | [diff] [blame] | 2292 | |
| 2293 | * There is a new function :c:func:`PyErr_NewExceptionWithDoc` that is |
| 2294 | like :c:func:`PyErr_NewException` but allows a docstring to be specified. |
| 2295 | This lets C exceptions have the same self-documenting capabilities as |
| 2296 | their pure Python counterparts (:issue:`7033`). |
| 2297 | |
| 2298 | * When compiled with the ``--with-valgrind`` option, the pymalloc |
| 2299 | allocator will be automatically disabled when running under Valgrind. This |
| 2300 | gives improved memory leak detection when running under Valgrind, while taking |
| 2301 | advantage of pymalloc at other times (:issue:`2422`). |
| 2302 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 2303 | * 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] | 2304 | longer used and it had never been documented (:issue:`8837`). |
| 2305 | |
| 2306 | There were a number of other small changes to the C-API. See the |
| 2307 | :file:`Misc/NEWS` file for a complete list. |
Skip Montanaro | 961aaf5 | 2010-10-17 22:22:24 +0000 | [diff] [blame] | 2308 | |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 2309 | |
Raymond Hettinger | f558ddd | 2009-06-28 21:37:08 +0000 | [diff] [blame] | 2310 | Porting to Python 3.2 |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 2311 | ===================== |
| 2312 | |
Georg Brandl | da0a211 | 2010-09-05 11:28:33 +0000 | [diff] [blame] | 2313 | This section lists previously described changes and other bugfixes that may |
| 2314 | require changes to your code: |
Raymond Hettinger | 6e6565b | 2009-06-28 20:56:11 +0000 | [diff] [blame] | 2315 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 2316 | * The :mod:`configparser` module has a number of clean-ups. The major change is |
| 2317 | to replace the old :class:`ConfigParser` class with long-standing preferred |
| 2318 | alternative :class:`SafeConfigParser`. In addition there are a number of |
Raymond Hettinger | c8a1686 | 2011-01-18 09:01:34 +0000 | [diff] [blame] | 2319 | smaller incompatibilities: |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 2320 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 2321 | * The interpolation syntax is now validated on |
| 2322 | :meth:`~configparser.ConfigParser.get` and |
| 2323 | :meth:`~configparser.ConfigParser.set` operations. In the default |
| 2324 | interpolation scheme, only two tokens with percent signs are valid: ``%(name)s`` |
| 2325 | and ``%%``, the latter being an escaped percent sign. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 2326 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 2327 | * The :meth:`~configparser.ConfigParser.set` and |
| 2328 | :meth:`~configparser.ConfigParser.add_section` methods now verify that |
| 2329 | values are actual strings. Formerly, unsupported types could be introduced |
| 2330 | unintentionally. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 2331 | |
Raymond Hettinger | 2b8861f | 2010-12-18 11:20:52 +0000 | [diff] [blame] | 2332 | * Duplicate sections or options from a single source now raise either |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 2333 | :exc:`~configparser.DuplicateSectionError` or |
| 2334 | :exc:`~configparser.DuplicateOptionError`. Formerly, duplicates would |
| 2335 | silently overwrite a previous entry. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 2336 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 2337 | * Inline comments are now disabled by default so now the **;** character |
| 2338 | can be safely used in values. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 2339 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 2340 | * Comments now can be indented. Consequently, for **;** or **#** to appear at |
| 2341 | 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] | 2342 | keeps comment prefix characters in values from being mistaken as comments. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 2343 | |
Raymond Hettinger | d73be67 | 2010-12-18 10:48:26 +0000 | [diff] [blame] | 2344 | * ``""`` is now a valid value and is no longer automatically converted to an |
| 2345 | empty string. For empty strings, use ``"option ="`` in a line. |
Łukasz Langa | 2b38b6c | 2010-12-17 21:57:32 +0000 | [diff] [blame] | 2346 | |
Antoine Pitrou | cd889af | 2010-10-06 21:13:56 +0000 | [diff] [blame] | 2347 | * The :mod:`nntplib` module was reworked extensively, meaning that its APIs |
| 2348 | are often incompatible with the 3.1 APIs. |
| 2349 | |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 2350 | * :class:`bytearray` objects can no longer be used as filenames; instead, |
| 2351 | they should be converted to :class:`bytes`. |
Victor Stinner | dcb2403 | 2010-04-22 12:08:36 +0000 | [diff] [blame] | 2352 | |
Raymond Hettinger | 399bf7b | 2011-01-24 10:11:12 +0000 | [diff] [blame] | 2353 | * The :meth:`array.tostring` and :meth:`array.fromstring` have been renamed to |
Raymond Hettinger | 50307b6 | 2011-01-24 01:18:30 +0000 | [diff] [blame] | 2354 | :meth:`array.tobytes` and :meth:`array.frombytes` for clarity. The old names |
| 2355 | have been deprecated. (See :issue:`8990`.) |
| 2356 | |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 2357 | * ``PyArg_Parse*()`` functions: |
Victor Stinner | 3dcb5ac | 2010-06-08 22:54:19 +0000 | [diff] [blame] | 2358 | |
Victor Stinner | 25e8ec4 | 2010-06-25 00:02:38 +0000 | [diff] [blame] | 2359 | * "t#" format has been removed: use "s#" or "s*" instead |
| 2360 | * "w" and "w#" formats has been removed: use "w*" instead |
| 2361 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 2362 | * The :c:type:`PyCObject` type, deprecated in 3.1, has been removed. To wrap |
| 2363 | 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] | 2364 | 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] | 2365 | information and a less complicated signature for calling a destructor. |
Victor Stinner | 0cbec57 | 2010-09-12 20:32:57 +0000 | [diff] [blame] | 2366 | |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 2367 | * The :func:`sys.setfilesystemencoding` function was removed because |
| 2368 | it had a flawed design. |
Raymond Hettinger | 3fcf002 | 2010-12-08 01:13:53 +0000 | [diff] [blame] | 2369 | |
Raymond Hettinger | e0a9600 | 2010-12-15 17:54:13 +0000 | [diff] [blame] | 2370 | * The :func:`random.seed` function and method now salt string seeds with an |
| 2371 | sha512 hash function. To access the previous version of *seed* in order to |
| 2372 | reproduce Python 3.1 sequences, set the *version* argument to *1*, |
| 2373 | ``random.seed(s, version=1)``. |
Raymond Hettinger | 21ec4bc | 2010-12-10 01:09:01 +0000 | [diff] [blame] | 2374 | |
Raymond Hettinger | 522cc0a | 2010-12-10 01:19:15 +0000 | [diff] [blame] | 2375 | * The previously deprecated :func:`string.maketrans` function has been removed |
Raymond Hettinger | 51e2107 | 2011-01-10 23:38:15 +0000 | [diff] [blame] | 2376 | in favor of the static methods :meth:`bytes.maketrans` and |
Raymond Hettinger | 522cc0a | 2010-12-10 01:19:15 +0000 | [diff] [blame] | 2377 | :meth:`bytearray.maketrans`. This change solves the confusion around which |
| 2378 | types were supported by the :mod:`string` module. Now, :class:`str`, |
| 2379 | :class:`bytes`, and :class:`bytearray` each have their own **maketrans** and |
| 2380 | **translate** methods with intermediate translation tables of the appropriate |
| 2381 | type. |
| 2382 | |
| 2383 | (Contributed by Georg Brandl; :issue:`5675`.) |
| 2384 | |
| 2385 | * The previously deprecated :func:`contextlib.nested` function has been removed |
| 2386 | in favor of a plain :keyword:`with` statement which can accept multiple |
| 2387 | context managers. The latter technique is faster (because it is built-in), |
| 2388 | and it does a better job finalizing multiple context managers when one of them |
| 2389 | raises an exception:: |
| 2390 | |
Raymond Hettinger | 6f0d59b | 2011-01-17 23:10:55 +0000 | [diff] [blame] | 2391 | with open('mylog.txt') as infile, open('a.out', 'w') as outfile: |
| 2392 | for line in infile: |
| 2393 | if '<critical>' in line: |
| 2394 | outfile.write(line) |
Raymond Hettinger | 522cc0a | 2010-12-10 01:19:15 +0000 | [diff] [blame] | 2395 | |
| 2396 | (Contributed by Georg Brandl and Mattias Brändström; |
| 2397 | `appspot issue 53094 <http://codereview.appspot.com/53094>`_.) |
Victor Stinner | da9ec99 | 2010-12-28 13:26:42 +0000 | [diff] [blame] | 2398 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 2399 | * :func:`struct.pack` now only allows bytes for the ``s`` string pack code. |
| 2400 | Formerly, it would accept text arguments and implicitly encode them to bytes |
| 2401 | using UTF-8. This was problematic because it made assumptions about the |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 2402 | correct encoding and because a variable-length encoding can fail when writing |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 2403 | to fixed length segment of a structure. |
Victor Stinner | da9ec99 | 2010-12-28 13:26:42 +0000 | [diff] [blame] | 2404 | |
Raymond Hettinger | 2169ee2 | 2011-01-05 22:27:49 +0000 | [diff] [blame] | 2405 | Code such as ``struct.pack('<6sHHBBB', 'GIF87a', x, y)`` should be rewritten |
| 2406 | with to use bytes instead of text, ``struct.pack('<6sHHBBB', b'GIF87a', x, y)``. |
| 2407 | |
Raymond Hettinger | de2e618 | 2011-01-10 05:40:57 +0000 | [diff] [blame] | 2408 | (Discovered by David Beazley and fixed by Victor Stinner; :issue:`10783`.) |
Raymond Hettinger | e40808a | 2011-01-05 23:00:00 +0000 | [diff] [blame] | 2409 | |
| 2410 | * The :class:`xml.etree.ElementTree` class now raises an |
| 2411 | :exc:`xml.etree.ElementTree.ParseError` when a parse fails. Previously it |
| 2412 | raised a :exc:`xml.parsers.expat.ExpatError`. |
| 2413 | |
| 2414 | * The new, longer :func:`str` value on floats may break doctests which rely on |
| 2415 | the old output format. |
Antoine Pitrou | bcba434 | 2011-01-16 18:29:34 +0000 | [diff] [blame] | 2416 | |
| 2417 | * In :class:`subprocess.Popen`, the default value for *close_fds* is now |
| 2418 | ``True`` under Unix; under Windows, it is ``True`` if the three standard |
| 2419 | streams are set to ``None``, ``False`` otherwise. Previously, *close_fds* |
| 2420 | was always ``False`` by default, which produced difficult to solve bugs |
| 2421 | or race conditions when open file descriptors would leak into the child |
| 2422 | process. |
| 2423 | |
Antoine Pitrou | f7fb762 | 2011-01-16 18:34:09 +0000 | [diff] [blame] | 2424 | * Support for legacy HTTP 0.9 has been removed from :mod:`urllib.request` |
| 2425 | and :mod:`http.client`. Such support is still present on the server side |
| 2426 | (in :mod:`http.server`). |
| 2427 | |
| 2428 | (Contributed by Antoine Pitrou, :issue:`10711`.) |
| 2429 | |
Antoine Pitrou | 2e8ec22 | 2011-01-16 18:41:36 +0000 | [diff] [blame] | 2430 | * SSL sockets in timeout mode now raise :exc:`socket.timeout` when a timeout |
| 2431 | occurs, rather than a generic :exc:`~ssl.SSLError`. |
| 2432 | |
| 2433 | (Contributed by Antoine Pitrou, :issue:`10272`.) |
Antoine Pitrou | ebeb903 | 2011-01-16 18:45:17 +0000 | [diff] [blame] | 2434 | |
| 2435 | * The misleading functions :c:func:`PyEval_AcquireLock()` and |
| 2436 | :c:func:`PyEval_ReleaseLock()` have been officially deprecated. The |
| 2437 | thread-state aware APIs (such as :c:func:`PyEval_SaveThread()` |
| 2438 | and :c:func:`PyEval_RestoreThread()`) should be used instead. |
Raymond Hettinger | 50307b6 | 2011-01-24 01:18:30 +0000 | [diff] [blame] | 2439 | |
| 2440 | * Due to security risks, :func:`asyncore.handle_accept` has been deprecated, and |
| 2441 | a new functions, :func:`asyncore.handle_accepted` was added to replace it. |
| 2442 | |
| 2443 | (Contributed by Giampaolo Rodola in :issue:`6706`.) |