Python 3.2 有什么新变化

  • 作者:
  • Raymond Hettinger(译者:wh2099 at outlook dot com)

这篇文章介绍了 Python 3.2 相比 3.1 新增的特性。 Python 3.2 发布于 2011 年 2 月 20 日。 文章聚焦于几个关键特性并给出了一些示例。 有关完整细节,请参阅 Misc/NEWS [https://github.com/python/cpython/blob/076ca6c3c8df3030307e548d9be792ce3c1c6eea/Misc/NEWS] 文件。

参见

PEP 392 [https://peps.python.org/pep-0392/] - Python 3.2 发布计划

PEP 384: 定义稳定的ABI

过去,为一个 Python 版本所构建的扩展模块通常无法用于其他 Python 版本。 特别是在 Windows 上,每一个 Python 新特性发布版都必须重新构建想要使用的所有扩展模块。 之所以有这样的要求是因为扩展模块可以任意访问 Python 解释器的内部对象。

在 Python 3.2 中,则有了一种替代方式:扩展模块将自己约束于一个受限 API(通过定义 Py_LIMITED_API)因而不能使用许多内部对象,仅限使用一组承诺会在多个发布版中保持稳定的 API 函数。 作为其结果,在这种模式下为 3.2 构建的扩展模块也将能在 3.3、3.4 等版本中运行。 使用了内存结构体细节数据的扩展模块仍然可以被构建,但将需要为每个新特性发布版重新编译。

参见

PEP 389: Argparse 命令行解析模块

A new module for command line parsing, argparse, was introduced to overcome the limitations of optparse which did not provide support for positional arguments (not just options), subcommands, required options and other common patterns of specifying and validating options.

This module has already had widespread success in the community as a third-party module. Being more fully featured than its predecessor, the argparse module is now the preferred module for command-line processing. The older module is still being kept available because of the substantial amount of legacy code that depends on it.

Here's an annotated example parser showing features like limiting results to a set of choices, specifying a metavar in the help screen, validating that one or more positional arguments is present, and making a required option:

  1. import argparse
  2. parser = argparse.ArgumentParser(
  3. description = 'Manage servers', # main description for help
  4. epilog = 'Tested on Solaris and Linux') # displayed after help
  5. parser.add_argument('action', # argument name
  6. choices = ['deploy', 'start', 'stop'], # three allowed values
  7. help = 'action on each target') # help msg
  8. parser.add_argument('targets',
  9. metavar = 'HOSTNAME', # var name used in help msg
  10. nargs = '+', # require one or more targets
  11. help = 'url for target machines') # help msg explanation
  12. parser.add_argument('-u', '--user', # -u or --user option
  13. required = True, # make it a required argument
  14. help = 'login as user')

在命令字符串中调用解析器的示例:

  1. >>> cmd = 'deploy sneezy.example.com sleepy.example.com -u skycaptain'
  2. >>> result = parser.parse_args(cmd.split())
  3. >>> result.action
  4. 'deploy'
  5. >>> result.targets
  6. ['sneezy.example.com', 'sleepy.example.com']
  7. >>> result.user
  8. 'skycaptain'

解释器自动生成的帮助示例:

  1. >>> parser.parse_args('-h'.split())
  2.  
  3. usage: manage_cloud.py [-h] -u USER
  4. {deploy,start,stop} HOSTNAME [HOSTNAME ...]
  5.  
  6. Manage servers
  7.  
  8. positional arguments:
  9. {deploy,start,stop} action on each target
  10. HOSTNAME url for target machines
  11.  
  12. optional arguments:
  13. -h, --help show this help message and exit
  14. -u USER, --user USER login as user
  15.  
  16. Tested on Solaris and Linux

一个非常好的 argparse 特性是可以定义子解析器,每个子解析器拥有它们自己的参数模式和帮助显示:

  1. import argparse
  2. parser = argparse.ArgumentParser(prog='HELM')
  3. subparsers = parser.add_subparsers()
  4.  
  5. parser_l = subparsers.add_parser('launch', help='Launch Control') # 第一个子分组
  6. parser_l.add_argument('-m', '--missiles', action='store_true')
  7. parser_l.add_argument('-t', '--torpedos', action='store_true')
  8.  
  9. parser_m = subparsers.add_parser('move', help='Move Vessel', # 第二个子分组
  10. aliases=('steer', 'turn')) # 等价的名称
  11. parser_m.add_argument('-c', '--course', type=int, required=True)
  12. parser_m.add_argument('-s', '--speed', type=int, default=0)
  1. $ ./helm.py --help # 最高层级的帮助 (launch 和 move)
  2. $ ./helm.py launch --help # launch 选项的帮助
  3. $ ./helm.py launch --missiles # 设置 missiles=True 及 torpedos=False
  4. $ ./helm.py steer --course 180 --speed 5 # 设置动作形参

参见

参阅 Migrating optparse code to argparse 了解与 optparse 的差异的细节。

PEP 391: 基于字典的日志配置

The logging module provided two kinds of configuration, one style with function calls for each option or another style driven by an external file saved in a configparser format. Those options did not provide the flexibility to create configurations from JSON or YAML files, nor did they support incremental configuration, which is needed for specifying logger options from a command line.

To support a more flexible style, the module now offers logging.config.dictConfig() for specifying logging configuration with plain Python dictionaries. The configuration options include formatters, handlers, filters, and loggers. Here's a working example of a configuration dictionary:

  1. {"version": 1,
  2. "formatters": {"brief": {"format": "%(levelname)-8s: %(name)-15s: %(message)s"},
  3. "full": {"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"}
  4. },
  5. "handlers": {"console": {
  6. "class": "logging.StreamHandler",
  7. "formatter": "brief",
  8. "level": "INFO",
  9. "stream": "ext://sys.stdout"},
  10. "console_priority": {
  11. "class": "logging.StreamHandler",
  12. "formatter": "full",
  13. "level": "ERROR",
  14. "stream": "ext://sys.stderr"}
  15. },
  16. "root": {"level": "DEBUG", "handlers": ["console", "console_priority"]}}

If that dictionary is stored in a file called conf.json, it can be loaded and called with code like this:

  1. >>> import json, logging.config
  2. >>> with open('conf.json') as f:
  3. ... conf = json.load(f)
  4. ...
  5. >>> logging.config.dictConfig(conf)
  6. >>> logging.info("Transaction completed normally")
  7. INFO : root : Transaction completed normally
  8. >>> logging.critical("Abnormal termination")
  9. 2011-02-17 11:14:36,694 root CRITICAL Abnormal termination

参见

PEP 3148: concurrent.futures 模块

Code for creating and managing concurrency is being collected in a new top-level namespace, concurrent. Its first member is a futures package which provides a uniform high-level interface for managing threads and processes.

The design for concurrent.futures was inspired by the java.util.concurrent package. In that model, a running call and its result are represented by a Future object that abstracts features common to threads, processes, and remote procedure calls. That object supports status checks (running or done), timeouts, cancellations, adding callbacks, and access to results or exceptions.

The primary offering of the new module is a pair of executor classes for launching and managing calls. The goal of the executors is to make it easier to use existing tools for making parallel calls. They save the effort needed to setup a pool of resources, launch the calls, create a results queue, add timeout handling, and limit the total number of threads, processes, or remote procedure calls.

Ideally, each application should share a single executor across multiple components so that process and thread limits can be centrally managed. This solves the design challenge that arises when each component has its own competing strategy for resource management.

Both classes share a common interface with three methods: submit() for scheduling a callable and returning a Future object; map() for scheduling many asynchronous calls at a time, and shutdown() for freeing resources. The class is a context manager and can be used in a with statement to assure that resources are automatically released when currently pending futures are done executing.

A simple of example of ThreadPoolExecutor is a launch of four parallel threads for copying files:

  1. import concurrent.futures, shutil
  2. with concurrent.futures.ThreadPoolExecutor(max_workers=4) as e:
  3. e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
  4. e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
  5. e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
  6. e.submit(shutil.copy, 'src3.txt', 'dest4.txt')

参见

Code for Threaded Parallel URL reads, an example using threads to fetch multiple web pages in parallel.

Code for computing prime numbers in parallel, an example demonstrating ProcessPoolExecutor.

PEP 3147: PYC 仓库目录

Python's scheme for caching bytecode in .pyc files did not work well in environments with multiple Python interpreters. If one interpreter encountered a cached file created by another interpreter, it would recompile the source and overwrite the cached file, thus losing the benefits of caching.

The issue of "pyc fights" has become more pronounced as it has become commonplace for Linux distributions to ship with multiple versions of Python. These conflicts also arise with CPython alternatives such as Unladen Swallow.

To solve this problem, Python's import machinery has been extended to use distinct filenames for each interpreter. Instead of Python 3.2 and Python 3.3 and Unladen Swallow each competing for a file called "mymodule.pyc", they will now look for "mymodule.cpython-32.pyc", "mymodule.cpython-33.pyc", and "mymodule.unladen10.pyc". And to prevent all of these new files from cluttering source directories, the pyc files are now collected in a "pycache" directory stored under the package directory.

Aside from the filenames and target directories, the new scheme has a few aspects that are visible to the programmer:

  • Imported modules now have a __cached__ attribute which stores the name of the actual file that was imported:
  1. >>> import collections
  2. >>> collections.__cached__
  3. 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
  • The tag that is unique to each interpreter is accessible from the imp module:
  1. >>> import imp
  2. >>> imp.get_tag()
  3. 'cpython-32'
  • Scripts that try to deduce source filename from the imported file now need to be smarter. It is no longer sufficient to simply strip the "c" from a ".pyc" filename. Instead, use the new functions in the imp module:
  1. >>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc')
  2. 'c:/py32/lib/collections.py'
  3. >>> imp.cache_from_source('c:/py32/lib/collections.py')
  4. 'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
  • The py_compile and compileall modules have been updated to reflect the new naming convention and target directory. The command-line invocation of compileall has new options: -i for specifying a list of files and directories to compile and -b which causes bytecode files to be written to their legacy location rather than pycache.

  • The importlib.abc module has been updated with new abstract base classes for loading bytecode files. The obsolete ABCs, PyLoader and PyPycLoader, have been deprecated (instructions on how to stay Python 3.1 compatible are included with the documentation).

参见

PEP 3149: 带有 ABI 版本标签的 .so 文件

The PYC repository directory allows multiple bytecode cache files to be co-located. This PEP implements a similar mechanism for shared object files by giving them a common directory and distinct names for each version.

The common directory is "pyshared" and the file names are made distinct by identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the major and minor version numbers, and optional build flags (such as "d" for debug, "m" for pymalloc, "u" for wide-unicode). For an arbitrary package "foo", you may see these files when the distribution package is installed:

  1. /usr/share/pyshared/foo.cpython-32m.so
  2. /usr/share/pyshared/foo.cpython-33md.so

对于 Python 本身,可以通过 sysconfig 模块中的函数来访问这些标签:

  1. >>> import sysconfig
  2. >>> sysconfig.get_config_var('SOABI') # 查找版本标签
  3. 'cpython-32mu'
  4. >>> sysconfig.get_config_var('EXT_SUFFIX') # 查找完整文件名扩展
  5. '.cpython-32mu.so'

参见

PEP 3333: Python Web服务器网关接口v1.0.1

This informational PEP clarifies how bytes/text issues are to be handled by the WSGI protocol. The challenge is that string handling in Python 3 is most conveniently handled with the str type even though the HTTP protocol is itself bytes oriented.

The PEP differentiates so-called native strings that are used for request/response headers and metadata versus byte strings which are used for the bodies of requests and responses.

The native strings are always of type str but are restricted to code points between U+0000 through U+00FF which are translatable to bytes using Latin-1 encoding. These strings are used for the keys and values in the environment dictionary and for response headers and statuses in the start_response() function. They must follow RFC 2616 [https://datatracker.ietf.org/doc/html/rfc2616.html] with respect to encoding. That is, they must either be ISO-8859-1 characters or use RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html] MIME encoding.

For developers porting WSGI applications from Python 2, here are the salient points:

  • If the app already used strings for headers in Python 2, no change is needed.

  • If instead, the app encoded output headers or decoded input headers, then the headers will need to be re-encoded to Latin-1. For example, an output header encoded in utf-8 was using h.encode('utf-8') now needs to convert from bytes to native strings using h.encode('utf-8').decode('latin-1').

  • Values yielded by an application or sent using the write() method must be byte strings. The start_response() function and environ must use native strings. The two cannot be mixed.

For server implementers writing CGI-to-WSGI pathways or other CGI-style protocols, the users must to be able access the environment using native strings even though the underlying platform may have a different convention. To bridge this gap, the wsgiref module has a new function, wsgiref.handlers.read_environ() for transcoding CGI variables from os.environ into native strings and returning a new dictionary.

参见

其他语言特性修改

对Python 语言核心进行的小改动:

  • String formatting for format() and str.format() gained new capabilities for the format character #. Previously, for integers in binary, octal, or hexadecimal, it caused the output to be prefixed with '0b', '0o', or '0x' respectively. Now it can also handle floats, complex, and Decimal, causing the output to always have a decimal point even when no digits follow it.
  1. >>> format(20, '#o')
  2. '0o24'
  3. >>> format(12.34, '#5.0f')
  4. ' 12.'

(Suggested by Mark Dickinson and implemented by Eric Smith in bpo-7094 [https://bugs.python.org/issue?@action=redirect&bpo=7094].)

  • There is also a new str.format_map() method that extends the capabilities of the existing str.format() method by accepting arbitrary mapping objects. This new method makes it possible to use string formatting with any of Python's many dictionary-like objects such as defaultdict, Shelf, ConfigParser, or dbm. It is also useful with custom dict subclasses that normalize keys before look-up or that supply a __missing__() method for unknown keys:
  1. >>> import shelve
  2. >>> d = shelve.open('tmp.shl')
  3. >>> 'The {project_name} status is {status} as of {date}'.format_map(d)
  4. 'The testing project status is green as of February 15, 2011'
  5.  
  6. >>> class LowerCasedDict(dict):
  7. ... def __getitem__(self, key):
  8. ... return dict.__getitem__(self, key.lower())
  9. ...
  10. >>> lcd = LowerCasedDict(text-part='widgets', quantity=10)
  11. >>> 'There are {QUANTITY} {Part} in stock'.format_map(lcd)
  12. 'There are 10 widgets in stock'
  13.  
  14. >>> class PlaceholderDict(dict):
  15. ... def __missing__(self, key):
  16. ... return '<{}>'.format(key)
  17. ...
  18. >>> 'Hello {name}, welcome to {location}'.format_map(PlaceholderDict())
  19. 'Hello <name>, welcome to <location>'

(由 Raymond Hettinger 提议并由 Eric Smith 在 bpo-6081 [https://bugs.python.org/issue?@action=redirect&bpo=6081] 中贡献。)

  • The interpreter can now be started with a quiet option, -q, to prevent the copyright and version information from being displayed in the interactive mode. The option can be introspected using the sys.flags attribute:
  1. $ python -q
  2. >>> sys.flags
  3. sys.flags(debug=0, division_warning=0, inspect=0, interactive=0,
  4. optimize=0, dont_write_bytecode=0, no_user_site=0, no_site=0,
  5. ignore_environment=0, verbose=0, bytes_warning=0, quiet=1)

(由 Marcin Wojdyr 在 bpo-1772833 [https://bugs.python.org/issue?@action=redirect&bpo=1772833] 中贡献。)

  • The hasattr() function works by calling getattr() and detecting whether an exception is raised. This technique allows it to detect methods created dynamically by __getattr__() or __getattribute__() which would otherwise be absent from the class dictionary. Formerly, hasattr would catch any exception, possibly masking genuine errors. Now, hasattr has been tightened to only catch AttributeError and let other exceptions pass through:
  1. >>> class A:
  2. ... @property
  3. ... def f(self):
  4. ... return 1 // 0
  5. ...
  6. >>> a = A()
  7. >>> hasattr(a, 'f')
  8. Traceback (most recent call last): ...
  9. ZeroDivisionError: integer division or modulo by zero

(由 Yury Selivanov 发现并由 Benjamin Peterson 修正;bpo-9666 [https://bugs.python.org/issue?@action=redirect&bpo=9666]。)

  • The str() of a float or complex number is now the same as its repr(). Previously, the str() form was shorter but that just caused confusion and is no longer needed now that the shortest possible repr() is displayed by default:
  1. >>> import math
  2. >>> repr(math.pi)
  3. '3.141592653589793'
  4. >>> str(math.pi)
  5. '3.141592653589793'

(由 Mark Dickinson 提议并实现;bpo-9337 [https://bugs.python.org/issue?@action=redirect&bpo=9337]。)

  • memoryview objects now have a release() method and they also now support the context management protocol. This allows timely release of any resources that were acquired when requesting a buffer from the original object.
  1. >>> with memoryview(b'abcdefgh') as v:
  2. ... print(v.tolist())
  3. [97, 98, 99, 100, 101, 102, 103, 104]

(由 Antoine Pitrou 添加;bpo-9757 [https://bugs.python.org/issue?@action=redirect&bpo=9757]。)

  • Previously it was illegal to delete a name from the local namespace if it occurs as a free variable in a nested block:
  1. def outer(x):
  2. def inner():
  3. return x
  4. inner()
  5. del x

This is now allowed. Remember that the target of an except clause is cleared, so this code which used to work with Python 2.6, raised a SyntaxError with Python 3.1 and now works again:

  1. def f():
  2. def print_error():
  3. print(e)
  4. try:
  5. something
  6. except Exception as e:
  7. print_error()
  8. # implicit "del e" here

(参见 bpo-4617 [https://bugs.python.org/issue?@action=redirect&bpo=4617]。)

  • Struct sequence types are now subclasses of tuple. This means that C structures like those returned by os.stat(), time.gmtime(), and sys.version_info now work like a named tuple and now work with functions and methods that expect a tuple as an argument. This is a big step forward in making the C structures as flexible as their pure Python counterparts:
  1. >>> import sys
  2. >>> isinstance(sys.version_info, tuple)
  3. True
  4. >>> 'Version %d.%d.%d %s(%d)' % sys.version_info
  5. 'Version 3.2.0 final(0)'

(Suggested by Arfrever Frehtes Taifersar Arahesis and implemented by Benjamin Peterson in bpo-8413 [https://bugs.python.org/issue?@action=redirect&bpo=8413].)

  • Warnings are now easier to control using the PYTHONWARNINGS environment variable as an alternative to using -W at the command line:
  1. $ export PYTHONWARNINGS='ignore::RuntimeWarning::,once::UnicodeWarning::'

(Suggested by Barry Warsaw and implemented by Philip Jenvey in bpo-7301 [https://bugs.python.org/issue?@action=redirect&bpo=7301].)

  • A new warning category, ResourceWarning, has been added. It is emitted when potential issues with resource consumption or cleanup are detected. It is silenced by default in normal release builds but can be enabled through the means provided by the warnings module, or on the command line.

A ResourceWarning is issued at interpreter shutdown if the gc.garbage list isn't empty, and if gc.DEBUG_UNCOLLECTABLE is set, all uncollectable objects are printed. This is meant to make the programmer aware that their code contains object finalization issues.

A ResourceWarning is also issued when a file object is destroyed without having been explicitly closed. While the deallocator for such object ensures it closes the underlying operating system resource (usually, a file descriptor), the delay in deallocating the object could produce various issues, especially under Windows. Here is an example of enabling the warning from the command line:

  1. $ python -q -Wdefault
  2. >>> f = open("foo", "wb")
  3. >>> del f
  4. __main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>

(Added by Antoine Pitrou and Georg Brandl in bpo-10093 [https://bugs.python.org/issue?@action=redirect&bpo=10093] and bpo-477863 [https://bugs.python.org/issue?@action=redirect&bpo=477863].)

  • range objects now support index and count methods. This is part of an effort to make more objects fully implement the collections.Sequence abstract base class. As a result, the language will have a more uniform API. In addition, range objects now support slicing and negative indices, even with values larger than sys.maxsize. This makes range more interoperable with lists:
  1. >>> range(0, 100, 2).count(10)
  2. 1
  3. >>> range(0, 100, 2).index(10)
  4. 5
  5. >>> range(0, 100, 2)[5]
  6. 10
  7. >>> range(0, 100, 2)[0:5]
  8. range(0, 10, 2)

(由 Daniel Stutzbach 在 bpo-9213 [https://bugs.python.org/issue?@action=redirect&bpo=9213] 中贡献,由 Alexander Belopolsky 在 bpo-2690 [https://bugs.python.org/issue?@action=redirect&bpo=2690] 中贡献,由 Nick Coghlan 在 bpo-10889 [https://bugs.python.org/issue?@action=redirect&bpo=10889] 中贡献。)

  • The callable() builtin function from Py2.x was resurrected. It provides a concise, readable alternative to using an abstract base class in an expression like isinstance(x, collections.Callable):
  1. >>> callable(max)
  2. True
  3. >>> callable(20)
  4. False

(参见 bpo-10518 [https://bugs.python.org/issue?@action=redirect&bpo=10518]。)

  • Python's import mechanism can now load modules installed in directories with non-ASCII characters in the path name. This solved an aggravating problem with home directories for users with non-ASCII characters in their usernames.

(需要 Victor Stinner 在 bpo-9425 [https://bugs.python.org/issue?@action=redirect&bpo=9425] 中做大量工作。)

新增,改进和弃用的模块

Python 标准库经过了大量的维护工作和质量改进。

The biggest news for Python 3.2 is that the email package, mailbox module, and nntplib modules now work correctly with the bytes/text model in Python 3. For the first time, there is correct handling of messages with mixed encodings.

Throughout the standard library, there has been more careful attention to encodings and text versus bytes issues. In particular, interactions with the operating system are now better able to exchange non-ASCII data using the Windows MBCS encoding, locale-aware encodings, or UTF-8.

Another significant win is the addition of substantially better support for SSL connections and security certificates.

In addition, more classes now implement a context manager to support convenient and reliable resource cleanup using a with statement.

email

The usability of the email package in Python 3 has been mostly fixed by the extensive efforts of R. David Murray. The problem was that emails are typically read and stored in the form of bytes rather than str text, and they may contain multiple encodings within a single email. So, the email package had to be extended to parse and generate email messages in bytes format.

  • New functions message_from_bytes() and message_from_binary_file(), and new classes BytesFeedParser and BytesParser allow binary message data to be parsed into model objects.

  • Given bytes input to the model, get_payload() will by default decode a message body that has a Content-Transfer-Encoding of 8bit using the charset specified in the MIME headers and return the resulting string.

  • Given bytes input to the model, Generator will convert message bodies that have a Content-Transfer-Encoding of 8bit to instead have a 7bit Content-Transfer-Encoding.

Headers with unencoded non-ASCII bytes are deemed to be RFC 2047 [https://datatracker.ietf.org/doc/html/rfc2047.html]-encoded using the unknown-8bit character set.

  • A new class BytesGenerator produces bytes as output, preserving any unchanged non-ASCII data that was present in the input used to build the model, including message bodies with a Content-Transfer-Encoding of 8bit.

  • The smtplib SMTP class now accepts a byte string for the msg argument to the sendmail() method, and a new method, send_message() accepts a Message object and can optionally obtain the from_addr and to_addrs addresses directly from the object.

(Proposed and implemented by R. David Murray, bpo-4661 [https://bugs.python.org/issue?@action=redirect&bpo=4661] and bpo-10321 [https://bugs.python.org/issue?@action=redirect&bpo=10321].)

elementtree

The xml.etree.ElementTree package and its xml.etree.cElementTree counterpart have been updated to version 1.3.

新增了几个有用的函数和方法:

两个方法被弃用:

  • xml.etree.ElementTree.getchildren() use list(elem) instead.

  • xml.etree.ElementTree.getiterator() use Element.iter instead.

For details of the update, see Introducing ElementTree [https://web.archive.org/web/20200703234532/http://effbot.org/zone/elementtree-13-intro.htm] on Fredrik Lundh's website.

(由 Florent Xicluna 和 Fredrik Lundh 在 bpo-6472 [https://bugs.python.org/issue?@action=redirect&bpo=6472] 中贡献。)

functools

  • The functools module includes a new decorator for caching function calls. functools.lru_cache() can save repeated queries to an external resource whenever the results are expected to be the same.

For example, adding a caching decorator to a database query function can save database accesses for popular searches:

  1. >>> import functools
  2. >>> @functools.lru_cache(maxsize=300)
  3. ... def get_phone_number(name):
  4. ... c = conn.cursor()
  5. ... c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,))
  6. ... return c.fetchone()[0]
  1. >>> for name in user_requests:
  2. ... get_phone_number(name) # cached lookup

To help with choosing an effective cache size, the wrapped function is instrumented for tracking cache statistics:

  1. >>> get_phone_number.cache_info()
  2. CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300)

If the phonelist table gets updated, the outdated contents of the cache can be cleared with:

  1. >>> get_phone_number.cache_clear()

(Contributed by Raymond Hettinger and incorporating design ideas from Jim Baker, Miki Tebeka, and Nick Coghlan; see recipe 498245 [https://code.activestate.com/recipes/498245-lru-and-lfu-cache-decorators/], recipe 577479 [https://code.activestate.com/recipes/577479-simple-caching-decorator/], bpo-10586 [https://bugs.python.org/issue?@action=redirect&bpo=10586], and bpo-10593 [https://bugs.python.org/issue?@action=redirect&bpo=10593].)

  • The functools.wraps() decorator now adds a __wrapped__ attribute pointing to the original callable function. This allows wrapped functions to be introspected. It also copies __annotations__ if defined. And now it also gracefully skips over missing attributes such as __doc__ which might not be defined for the wrapped callable.

In the above example, the cache can be removed by recovering the original function:

  1. >>> get_phone_number = get_phone_number.__wrapped__ # uncached function

(由 Nick Coghlan 和 Terrence Cole 在 bpo-9567 [https://bugs.python.org/issue?@action=redirect&bpo=9567], bpo-3445 [https://bugs.python.org/issue?@action=redirect&bpo=3445] 和 bpo-8814 [https://bugs.python.org/issue?@action=redirect&bpo=8814] 中贡献。)

  • 为帮助编写具有丰富比较方法的类,新增的装饰器 functools.total_ordering() 将使用现有的相等和不相等方法来填充其余的方法。

例如,提供 eq and lt 将启用 total_ordering() 来填充 le, gtge:

  1. @totalordering
  2. class Student:
  3. def _eq(self, other):
  4. return ((self.lastname.lower(), self.firstname.lower()) ==
  5. (other.lastname.lower(), other.firstname.lower()))

  6. def __lt__(self, other):
  7.     return ((self.lastname.lower(), self.firstname.lower()) &lt;
  8.             (other.lastname.lower(), other.firstname.lower()))

使用 total_ordering 装饰器时,将会自动填充其余的比较方法。

(由 Raymond Hettinger 贡献。)

  1. >>> # locale-aware sort order
  2. >>> sorted(iterable, key=cmp_to_key(locale.strcoll))

For sorting examples and a brief sorting tutorial, see the Sorting HowTo [https://wiki.python.org/moin/HowTo/Sorting/] tutorial.

(由 Raymond Hettinger 贡献。)

itertools

  • The itertools module has a new accumulate() function modeled on APL's scan operator and Numpy's accumulate function:
  1. >>> from itertools import accumulate
  2. >>> list(accumulate([8, 2, 50]))
  3. [8, 10, 60]
  1. >>> prob_dist = [0.1, 0.4, 0.2, 0.3]
  2. >>> list(accumulate(prob_dist)) # cumulative probability distribution
  3. [0.1, 0.5, 0.7, 1.0]

For an example using accumulate(), see the examples for the random module.

(Contributed by Raymond Hettinger and incorporating design suggestions from Mark Dickinson.)

collections

  1. >>> from collections import Counter
  2. >>> tally = Counter(dogs=5, cats=3)
  3. >>> tally -= Counter(dogs=2, cats=8) # saturating subtraction
  4. >>> tally
  5. Counter({'dogs': 3})
  1. >>> tally = Counter(dogs=5, cats=3)
  2. >>> tally.subtract(dogs=2, cats=8) # regular subtraction
  3. >>> tally
  4. Counter({'dogs': 3, 'cats': -5})

(由 Raymond Hettinger 贡献。)

The default is to move an item to the last position. This is equivalent of renewing an entry with od[k] = od.pop(k).

A fast move-to-end operation is useful for resequencing entries. For example, an ordered dictionary can be used to track order of access by aging entries from the oldest to the most recently accessed.

  1. >>> from collections import OrderedDict
  2. >>> d = OrderedDict.fromkeys(['a', 'b', 'X', 'd', 'e'])
  3. >>> list(d)
  4. ['a', 'b', 'X', 'd', 'e']
  5. >>> d.move_to_end('X')
  6. >>> list(d)
  7. ['a', 'b', 'd', 'e', 'X']

(由 Raymond Hettinger 贡献。)

  1. >>> from collections import deque
  2. >>> d = deque('simsalabim')
  3. >>> d.count('s')
  4. 2
  5. >>> d.reverse()
  6. >>> d
  7. deque(['m', 'i', 'b', 'a', 'l', 'a', 's', 'm', 'i', 's'])

(由 Raymond Hettinger 贡献。)

threading

The threading module has a new Barrier synchronization class for making multiple threads wait until all of them have reached a common barrier point. Barriers are useful for making sure that a task with multiple preconditions does not run until all of the predecessor tasks are complete.

Barriers can work with an arbitrary number of threads. This is a generalization of a Rendezvous [https://en.wikipedia.org/wiki/Synchronous_rendezvous] which is defined for only two threads.

Implemented as a two-phase cyclic barrier, Barrier objects are suitable for use in loops. The separate filling and draining phases assure that all threads get released (drained) before any one of them can loop back and reenter the barrier. The barrier fully resets after each cycle.

Example of using barriers:

  1. from threading import Barrier, Thread
  2.  
  3. def get_votes(site):
  4. ballots = conduct_election(site)
  5. all_polls_closed.wait() # do not count until all polls are closed
  6. totals = summarize(ballots)
  7. publish(site, totals)
  8.  
  9. all_polls_closed = Barrier(len(sites))
  10. for site in sites:
  11. Thread(target=get_votes, args=(site,)).start()

In this example, the barrier enforces a rule that votes cannot be counted at any polling site until all polls are closed. Notice how a solution with a barrier is similar to one with threading.Thread.join(), but the threads stay alive and continue to do work (summarizing ballots) after the barrier point is crossed.

If any of the predecessor tasks can hang or be delayed, a barrier can be created with an optional timeout parameter. Then if the timeout period elapses before all the predecessor tasks reach the barrier point, all waiting threads are released and a BrokenBarrierError exception is raised:

  1. def get_votes(site):
  2. ballots = conduct_election(site)
  3. try:
  4. all_polls_closed.wait(timeout=midnight - time.now())
  5. except BrokenBarrierError:
  6. lockbox = seal_ballots(ballots)
  7. queue.put(lockbox)
  8. else:
  9. totals = summarize(ballots)
  10. publish(site, totals)

In this example, the barrier enforces a more robust rule. If some election sites do not finish before midnight, the barrier times-out and the ballots are sealed and deposited in a queue for later handling.

See Barrier Synchronization Patterns [https://osl.cs.illinois.edu/media/papers/karmani-2009-barrier_synchronization_pattern.pdf] for more examples of how barriers can be used in parallel computing. Also, there is a simple but thorough explanation of barriers in The Little Book of Semaphores [https://greenteapress.com/semaphores/LittleBookOfSemaphores.pdf], section 3.6.

(Contributed by Kristján Valur Jónsson with an API review by Jeffrey Yasskin in bpo-8777 [https://bugs.python.org/issue?@action=redirect&bpo=8777].)

datetime 和 time

  • The datetime module has a new type timezone that implements the tzinfo interface by returning a fixed UTC offset and timezone name. This makes it easier to create timezone-aware datetime objects:
  1. >>> from datetime import datetime, timezone
  2.  
  3. >>> datetime.now(timezone.utc)
  4. datetime.datetime(2010, 12, 8, 21, 4, 2, 923754, tzinfo=datetime.timezone.utc)
  5.  
  6. >>> datetime.strptime("01/01/2000 12:00 +0000", "%m/%d/%Y %H:%M %z")
  7. datetime.datetime(2000, 1, 1, 12, 0, tzinfo=datetime.timezone.utc)
  • Also, timedelta objects can now be multiplied by float and divided by float and int objects. And timedelta objects can now divide one another.

  • The datetime.date.strftime() method is no longer restricted to years after 1900. The new supported year range is from 1000 to 9999 inclusive.

  • Whenever a two-digit year is used in a time tuple, the interpretation has been governed by time.accept2dyear. The default is True which means that for a two-digit year, the century is guessed according to the POSIX rules governing the %y strptime format.

Starting with Py3.2, use of the century guessing heuristic will emit a DeprecationWarning. Instead, it is recommended that time.accept2dyear be set to False so that large date ranges can be used without guesswork:

  1. >>> import time, warnings
  2. >>> warnings.resetwarnings() # remove the default warning filters
  3.  
  4. >>> time.accept2dyear = True # guess whether 11 means 11 or 2011
  5. >>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
  6. Warning (from warnings module):
  7. ...
  8. DeprecationWarning: Century info guessed for a 2-digit year.
  9. 'Fri Jan 1 12:34:56 2011'
  10.  
  11. >>> time.accept2dyear = False # use the full range of allowable dates
  12. >>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
  13. 'Fri Jan 1 12:34:56 11'

Several functions now have significantly expanded date ranges. When time.accept2dyear is false, the time.asctime() function will accept any year that fits in a C int, while the time.mktime() and time.strftime() functions will accept the full range supported by the corresponding operating system functions.

(由 Alexander Belopolsky 和 Victor Stinner 在 bpo-1289118 [https://bugs.python.org/issue?@action=redirect&bpo=1289118], bpo-5094 [https://bugs.python.org/issue?@action=redirect&bpo=5094], bpo-6641 [https://bugs.python.org/issue?@action=redirect&bpo=6641], bpo-2706 [https://bugs.python.org/issue?@action=redirect&bpo=2706], bpo-1777412 [https://bugs.python.org/issue?@action=redirect&bpo=1777412], bpo-8013 [https://bugs.python.org/issue?@action=redirect&bpo=8013] 和 bpo-10827 [https://bugs.python.org/issue?@action=redirect&bpo=10827] 中贡献。)

math

math 模块基于 C99 标准增加了六个新函数。

The isfinite() function provides a reliable and fast way to detect special values. It returns True for regular numbers and False for Nan or Infinity:

  1. >>> from math import isfinite
  2. >>> [isfinite(x) for x in (123, 4.56, float('Nan'), float('Inf'))]
  3. [True, True, False, False]

The expm1() function computes e**x-1 for small values of x without incurring the loss of precision that usually accompanies the subtraction of nearly equal quantities:

  1. >>> from math import expm1
  2. >>> expm1(0.013671875) # more accurate way to compute e**x-1 for a small x
  3. 0.013765762467652909

The erf() function computes a probability integral or Gaussian error function [https://en.wikipedia.org/wiki/Error_function]. The complementary error function, erfc(), is 1 - erf(x):

  1. >>> from math import erf, erfc, sqrt
  2. >>> erf(1.0/sqrt(2.0)) # portion of normal distribution within 1 standard deviation
  3. 0.682689492137086
  4. >>> erfc(1.0/sqrt(2.0)) # portion of normal distribution outside 1 standard deviation
  5. 0.31731050786291404
  6. >>> erf(1.0/sqrt(2.0)) + erfc(1.0/sqrt(2.0))
  7. 1.0

The gamma() function is a continuous extension of the factorial function. See https://en.wikipedia.org/wiki/Gamma_function for details. Because the function is related to factorials, it grows large even for small values of x, so there is also a lgamma() function for computing the natural logarithm of the gamma function:

  1. >>> from math import gamma, lgamma
  2. >>> gamma(7.0) # six factorial
  3. 720.0
  4. >>> lgamma(801.0) # log(800 factorial)
  5. 4551.950730698041

(由 Mark Dickinson 贡献)

abc

The abc module now supports abstractclassmethod() and abstractstaticmethod().

These tools make it possible to define an abstract base class that requires a particular classmethod() or staticmethod() to be implemented:

  1. class Temperature(metaclass=abc.ABCMeta):
  2. @abc.abstractclassmethod
  3. def from_fahrenheit(cls, t):
  4. ...
  5. @abc.abstractclassmethod
  6. def from_celsius(cls, t):
  7. ...

(Patch submitted by Daniel Urban; bpo-5867 [https://bugs.python.org/issue?@action=redirect&bpo=5867].)

io

The io.BytesIO has a new method, getbuffer(), which provides functionality similar to memoryview(). It creates an editable view of the data without making a copy. The buffer's random access and support for slice notation are well-suited to in-place editing:

  1. >>> REC_LEN, LOC_START, LOC_LEN = 34, 7, 11
  2.  
  3. >>> def change_location(buffer, record_number, location):
  4. ... start = record_number * REC_LEN + LOC_START
  5. ... buffer[start: start+LOC_LEN] = location
  6.  
  7. >>> import io
  8.  
  9. >>> byte_stream = io.BytesIO(
  10. ... b'G3805 storeroom Main chassis '
  11. ... b'X7899 shipping Reserve cog '
  12. ... b'L6988 receiving Primary sprocket'
  13. ... )
  14. >>> buffer = byte_stream.getbuffer()
  15. >>> change_location(buffer, 1, b'warehouse ')
  16. >>> change_location(buffer, 0, b'showroom ')
  17. >>> print(byte_stream.getvalue())
  18. b'G3805 showroom Main chassis '
  19. b'X7899 warehouse Reserve cog '
  20. b'L6988 receiving Primary sprocket'

(由 Antoine Pitrou 在 bpo-5506 [https://bugs.python.org/issue?@action=redirect&bpo=5506] 中贡献。)

reprlib

When writing a __repr__() method for a custom container, it is easy to forget to handle the case where a member refers back to the container itself. Python's builtin objects such as list and set handle self-reference by displaying "…" in the recursive part of the representation string.

To help write such __repr__() methods, the reprlib module has a new decorator, recursive_repr(), for detecting recursive calls to __repr__() and substituting a placeholder string instead:

  1. >>> class MyList(list):
  2. ... @recursive_repr()
  3. ... def __repr__(self):
  4. ... return '<' + '|'.join(map(repr, self)) + '>'
  5. ...
  6. >>> m = MyList('abc')
  7. >>> m.append(m)
  8. >>> m.append('x')
  9. >>> print(m)
  10. <'a'|'b'|'c'|...|'x'>

(由 Raymond Hettinger 在 bpo-9826 [https://bugs.python.org/issue?@action=redirect&bpo=9826] 和 bpo-9840 [https://bugs.python.org/issue?@action=redirect&bpo=9840] 中贡献。)

logging

In addition to dictionary-based configuration described above, the logging package has many other improvements.

The logging documentation has been augmented by a basic tutorial, an advanced tutorial, and a cookbook of logging recipes. These documents are the fastest way to learn about logging.

The logging.basicConfig() set-up function gained a style argument to support three different types of string formatting. It defaults to "%" for traditional %-formatting, can be set to "{" for the new str.format() style, or can be set to "$" for the shell-style formatting provided by string.Template. The following three configurations are equivalent:

  1. >>> from logging import basicConfig
  2. >>> basicConfig(style='%', format="%(name)s -> %(levelname)s: %(message)s")
  3. >>> basicConfig(style='{', format="{name} -> {levelname} {message}")
  4. >>> basicConfig(style='$', format="$name -> $levelname: $message")

If no configuration is set-up before a logging event occurs, there is now a default configuration using a StreamHandler directed to sys.stderr for events of WARNING level or higher. Formerly, an event occurring before a configuration was set-up would either raise an exception or silently drop the event depending on the value of logging.raiseExceptions. The new default handler is stored in logging.lastResort.

The use of filters has been simplified. Instead of creating a Filter object, the predicate can be any Python callable that returns True or False.

There were a number of other improvements that add flexibility and simplify configuration. See the module documentation for a full listing of changes in Python 3.2.

csv

The csv module now supports a new dialect, unix_dialect, which applies quoting for all fields and a traditional Unix style with '\n' as the line terminator. The registered dialect name is unix.

The csv.DictWriter has a new method, writeheader() for writing-out an initial row to document the field names:

  1. >>> import csv, sys
  2. >>> w = csv.DictWriter(sys.stdout, ['name', 'dept'], dialect='unix')
  3. >>> w.writeheader()
  4. "name","dept"
  5. >>> w.writerows([
  6. ... {'name': 'tom', 'dept': 'accounting'},
  7. ... {'name': 'susan', 'dept': 'Salesl'}])
  8. "tom","accounting"
  9. "susan","sales"

(New dialect suggested by Jay Talbot in bpo-5975 [https://bugs.python.org/issue?@action=redirect&bpo=5975], and the new method suggested by Ed Abraham in bpo-1537721 [https://bugs.python.org/issue?@action=redirect&bpo=1537721].)

contextlib

There is a new and slightly mind-blowing tool ContextDecorator that is helpful for creating a context manager that does double duty as a function decorator.

As a convenience, this new functionality is used by contextmanager() so that no extra effort is needed to support both roles.

The basic idea is that both context managers and function decorators can be used for pre-action and post-action wrappers. Context managers wrap a group of statements using a with statement, and function decorators wrap a group of statements enclosed in a function. So, occasionally there is a need to write a pre-action or post-action wrapper that can be used in either role.

For example, it is sometimes useful to wrap functions or groups of statements with a logger that can track the time of entry and time of exit. Rather than writing both a function decorator and a context manager for the task, the contextmanager() provides both capabilities in a single definition:

  1. from contextlib import contextmanager
  2. import logging
  3.  
  4. logging.basicConfig(level=logging.INFO)
  5.  
  6. @contextmanager
  7. def track_entry_and_exit(name):
  8. logging.info('Entering: %s', name)
  9. yield
  10. logging.info('Exiting: %s', name)

Formerly, this would have only been usable as a context manager:

  1. with track_entry_and_exit('widget loader'):
  2. print('Some time consuming activity goes here')
  3. load_widget()

Now, it can be used as a decorator as well:

  1. @track_entry_and_exit('widget loader')
  2. def activity():
  3. print('Some time consuming activity goes here')
  4. load_widget()

Trying to fulfill two roles at once places some limitations on the technique. Context managers normally have the flexibility to return an argument usable by a with statement, but there is no parallel for function decorators.

In the above example, there is not a clean way for the track_entry_and_exit context manager to return a logging instance for use in the body of enclosed statements.

(由 Michael Foord 在 bpo-9110 [https://bugs.python.org/issue?@action=redirect&bpo=9110] 中贡献。)

decimal and fractions

Mark Dickinson crafted an elegant and efficient scheme for assuring that different numeric datatypes will have the same hash value whenever their actual values are equal (bpo-8188 [https://bugs.python.org/issue?@action=redirect&bpo=8188]):

  1. assert hash(Fraction(3, 2)) == hash(1.5) == \
  2. hash(Decimal("1.5")) == hash(complex(1.5, 0))

Some of the hashing details are exposed through a new attribute, sys.hash_info, which describes the bit width of the hash value, the prime modulus, the hash values for infinity and nan, and the multiplier used for the imaginary part of a number:

  1. >>> sys.hash_info
  2. sys.hash_info(width=64, modulus=2305843009213693951, inf=314159, nan=0, imag=1000003)

An early decision to limit the interoperability of various numeric types has been relaxed. It is still unsupported (and ill-advised) to have implicit mixing in arithmetic expressions such as Decimal('1.1') + float('1.1') because the latter loses information in the process of constructing the binary float. However, since existing floating-point value can be converted losslessly to either a decimal or rational representation, it makes sense to add them to the constructor and to support mixed-type comparisons.

Similar changes were made to fractions.Fraction so that the from_float() and from_decimal() methods are no longer needed (bpo-8294 [https://bugs.python.org/issue?@action=redirect&bpo=8294]):

  1. >>> from decimal import Decimal
  2. >>> from fractions import Fraction
  3. >>> Decimal(1.1)
  4. Decimal('1.100000000000000088817841970012523233890533447265625')
  5. >>> Fraction(1.1)
  6. Fraction(2476979795053773, 2251799813685248)

Another useful change for the decimal module is that the Context.clamp attribute is now public. This is useful in creating contexts that correspond to the decimal interchange formats specified in IEEE 754 (see bpo-8540 [https://bugs.python.org/issue?@action=redirect&bpo=8540]).

(由 Mark Dickinson 和 Raymond Hettinger贡献。)

ftp

The ftplib.FTP class now supports the context management protocol to unconditionally consume socket.error exceptions and to close the FTP connection when done:

  1. >>> from ftplib import FTP
  2. >>> with FTP("ftp1.at.proftpd.org") as ftp:
  3. ftp.login()
  4. ftp.dir()
  5.  
  6. '230 Anonymous login ok, restrictions apply.'
  7. dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .
  8. dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 ..
  9. dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS
  10. dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora

其他文件型对象如 mmap.mmapfileinput.input() 也有了支持自动关闭的上下文管理器:

  1. with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
  2. for line in f:
  3. process(line)

(由 Tarek Ziadé 和 Giampaolo Rodolà 在 bpo-4972 [https://bugs.python.org/issue?@action=redirect&bpo=4972] 贡献,由 Georg Brandl 在 bpo-8046 [https://bugs.python.org/issue?@action=redirect&bpo=8046] 和 bpo-1286 [https://bugs.python.org/issue?@action=redirect&bpo=1286] 贡献。)

The FTP_TLS class now accepts a context parameter, which is a ssl.SSLContext object allowing bundling SSL configuration options, certificates and private keys into a single (potentially long-lived) structure.

(由 Giampaolo Rodolà 在 bpo-8806 [https://bugs.python.org/issue?@action=redirect&bpo=8806] 中贡献。)

popen

os.popen()subprocess.Popen() 函数现在支持使用 with 语句来自动关闭文件描述符。

(由 Antoine Pitrou 和 Brian Curtin 在 bpo-7461 [https://bugs.python.org/issue?@action=redirect&bpo=7461] 和 bpo-10554 [https://bugs.python.org/issue?@action=redirect&bpo=10554] 中贡献。)

select

The select module now exposes a new, constant attribute, PIPE_BUF, which gives the minimum number of bytes which are guaranteed not to block when select.select() says a pipe is ready for writing.

  1. >>> import select
  2. >>> select.PIPE_BUF
  3. 512

(在 Unix 系统上可用。 由 Sébastien Sablé 在 bpo-9862 [https://bugs.python.org/issue?@action=redirect&bpo=9862] 中提供补丁)

gzip 和 zipfile

gzip.GzipFile now implements the io.BufferedIOBase abstract base class (except for truncate()). It also has a peek() method and supports unseekable as well as zero-padded file objects.

The gzip module also gains the compress() and decompress() functions for easier in-memory compression and decompression. Keep in mind that text needs to be encoded as bytes before compressing and decompressing:

  1. >>> import gzip
  2. >>> s = 'Three shall be the number thou shalt count, '
  3. >>> s += 'and the number of the counting shall be three'
  4. >>> b = s.encode() # convert to utf-8
  5. >>> len(b)
  6. 89
  7. >>> c = gzip.compress(b)
  8. >>> len(c)
  9. 77
  10. >>> gzip.decompress(c).decode()[:42] # decompress and convert to text
  11. 'Three shall be the number thou shalt count'

(由 Anand B. Pillai 在 bpo-3488 [https://bugs.python.org/issue?@action=redirect&bpo=3488] 中贡献,由Antoine Pitrou, Nir Aides 和 Brian Curtin 在 bpo-9962 [https://bugs.python.org/issue?@action=redirect&bpo=9962],[bpo-1675951](https://bugs.python.org/issue?@action=redirect&bpo=1675951) [https://bugs.python.org/issue?@action=redirect&bpo=1675951] ,bpo-7471 [https://bugs.python.org/issue?@action=redirect&bpo=7471] 和 bpo-2846 [https://bugs.python.org/issue?@action=redirect&bpo=2846] 中贡献。)

Also, the zipfile.ZipExtFile class was reworked internally to represent files stored inside an archive. The new implementation is significantly faster and can be wrapped in an io.BufferedReader object for more speedups. It also solves an issue where interleaved calls to read and readline gave the wrong results.

(补丁由 Nir Aides 在 bpo-7610 [https://bugs.python.org/issue?@action=redirect&bpo=7610] 中提交。)

tarfile

The TarFile class can now be used as a context manager. In addition, its add() method has a new option, filter, that controls which files are added to the archive and allows the file metadata to be edited.

The new filter option replaces the older, less flexible exclude parameter which is now deprecated. If specified, the optional filter parameter needs to be a keyword argument. The user-supplied filter function accepts a TarInfo object and returns an updated TarInfo object, or if it wants the file to be excluded, the function can return None:

  1. >>> import tarfile, glob
  2.  
  3. >>> def myfilter(tarinfo):
  4. ... if tarinfo.isfile(): # only save real files
  5. ... tarinfo.uname = 'monty' # redact the user name
  6. ... return tarinfo
  7.  
  8. >>> with tarfile.open(name='myarchive.tar.gz', mode='w:gz') as tf:
  9. ... for filename in glob.glob('*.txt'):
  10. ... tf.add(filename, filter=myfilter)
  11. ... tf.list()
  12. -rw-r--r-- monty/501 902 2011-01-26 17:59:11 annotations.txt
  13. -rw-r--r-- monty/501 123 2011-01-26 17:59:11 general_questions.txt
  14. -rw-r--r-- monty/501 3514 2011-01-26 17:59:11 prion.txt
  15. -rw-r--r-- monty/501 124 2011-01-26 17:59:11 py_todo.txt
  16. -rw-r--r-- monty/501 1399 2011-01-26 17:59:11 semaphore_notes.txt

(由 Tarek Ziadé 提议并由 Lars Gustäbel 在 bpo-6856 [https://bugs.python.org/issue?@action=redirect&bpo=6856] 中实现。)

hashlib

The hashlib module has two new constant attributes listing the hashing algorithms guaranteed to be present in all implementations and those available on the current implementation:

  1. >>> import hashlib
  2.  
  3. >>> hashlib.algorithms_guaranteed
  4. {'sha1', 'sha224', 'sha384', 'sha256', 'sha512', 'md5'}
  5.  
  6. >>> hashlib.algorithms_available
  7. {'md2', 'SHA256', 'SHA512', 'dsaWithSHA', 'mdc2', 'SHA224', 'MD4', 'sha256',
  8. 'sha512', 'ripemd160', 'SHA1', 'MDC2', 'SHA', 'SHA384', 'MD2',
  9. 'ecdsa-with-SHA1','md4', 'md5', 'sha1', 'DSA-SHA', 'sha224',
  10. 'dsaEncryption', 'DSA', 'RIPEMD160', 'sha', 'MD5', 'sha384'}

(由 Carl Chenet 在 bpo-7418 [https://bugs.python.org/issue?@action=redirect&bpo=7418] 中建议。)

ast

The ast module has a wonderful a general-purpose tool for safely evaluating expression strings using the Python literal syntax. The ast.literal_eval() function serves as a secure alternative to the builtin eval() function which is easily abused. Python 3.2 adds bytes and set literals to the list of supported types: strings, bytes, numbers, tuples, lists, dicts, sets, booleans, and None.

  1. >>> from ast import literal_eval
  2.  
  3. >>> request = "{'req': 3, 'func': 'pow', 'args': (2, 0.5)}"
  4. >>> literal_eval(request)
  5. {'args': (2, 0.5), 'req': 3, 'func': 'pow'}
  6.  
  7. >>> request = "os.system('do something harmful')"
  8. >>> literal_eval(request)
  9. Traceback (most recent call last): ...
  10. ValueError: malformed node or string: <_ast.Call object at 0x101739a10>

(由Benjamin Peterson 和 Georg Brandl 实现。)

os

Different operating systems use various encodings for filenames and environment variables. The os module provides two new functions, fsencode() and fsdecode(), for encoding and decoding filenames:

  1. >>> import os
  2. >>> filename = 'Sehenswürdigkeiten'
  3. >>> os.fsencode(filename)
  4. b'Sehensw\xc3\xbcrdigkeiten'

Some operating systems allow direct access to encoded bytes in the environment. If so, the os.supports_bytes_environ constant will be true.

For direct access to encoded environment variables (if available), use the new os.getenvb() function or use os.environb which is a bytes version of os.environ.

(由 Victor Stinner 贡献。)

shutil

shutil.copytree() 函数增加了两个新选项:

  • ignore_dangling_symlinks: when symlinks=False so that the function copies a file pointed to by a symlink, not the symlink itself. This option will silence the error raised if the file doesn't exist.

  • copy_function: is a callable that will be used to copy files. shutil.copy2() is used by default.

(由 Tarek Ziadé 贡献。)

In addition, the shutil module now supports archiving operations for zipfiles, uncompressed tarfiles, gzipped tarfiles, and bzipped tarfiles. And there are functions for registering additional archiving file formats (such as xz compressed tarfiles or custom formats).

The principal functions are make_archive() and unpack_archive(). By default, both operate on the current directory (which can be set by os.chdir()) and on any sub-directories. The archive filename needs to be specified with a full pathname. The archiving step is non-destructive (the original files are left unchanged).

  1. >>> import shutil, pprint
  2.  
  3. >>> os.chdir('mydata') # change to the source directory
  4. >>> f = shutil.make_archive('varbackup/mydata',
  5. ... 'zip') # archive the current directory
  6. >>> f # show the name of archive
  7. 'varbackup/mydata.zip'
  8. >>> os.chdir('tmp') # change to an unpacking
  9. >>> shutil.unpack_archive('varbackup/mydata.zip') # recover the data
  10.  
  11. >>> pprint.pprint(shutil.get_archive_formats()) # display known formats
  12. [('bztar', "bzip2'ed tarfile"),
  13. ('gztar', "gzip'ed tarfile"),
  14. ('tar', 'uncompressed tar file'),
  15. ('zip', 'ZIP file')]
  16.  
  17. >>> shutil.register_archive_format( # register a new archive format
  18. ... name='xz',
  19. ... function=xz.compress, # callable archiving function
  20. ... extra_args=[('level', 8)], # arguments to the function
  21. ... description='xz compression'
  22. ... )

(由 Tarek Ziadé 贡献。)