11. 标准库简要介绍 — 第 II 部分

本篇第二部分介绍了更多支持专业编程需求的进阶模块。这些模块在小型脚本中很少出现。

11.1. 输出格式化

The reprlib 模块提供了一个 repr() 的版本,该版本针对大型或深度嵌套容器的简略显示进行了定制。

>>> import reprlib
>>> reprlib.repr(set('supercalifragilisticexpialidocious'))
"{'a', 'c', 'd', 'e', 'f', 'g', ...}"

The pprint 模块提供了更复杂的控制,可以以解释器可读的方式打印内置对象和用户定义对象。当结果超过一行时,“漂亮打印机”会添加换行符和缩进,以更清晰地显示数据结构。

>>> import pprint
>>> t = [[[['black', 'cyan'], 'white', ['green', 'red']], [['magenta',
...     'yellow'], 'blue']]]
...
>>> pprint.pprint(t, width=30)
[[[['black', 'cyan'],
   'white',
   ['green', 'red']],
  [['magenta', 'yellow'],
   'blue']]]

The textwrap 模块将文本段落格式化为适合给定屏幕宽度。

>>> import textwrap
>>> doc = """The wrap() method is just like fill() except that it returns
... a list of strings instead of one big string with newlines to separate
... the wrapped lines."""
...
>>> print(textwrap.fill(doc, width=40))
The wrap() method is just like fill()
except that it returns a list of strings
instead of one big string with newlines
to separate the wrapped lines.

The locale 模块访问文化特定数据格式的数据库。locale 的 format 函数的 grouping 属性提供了一种直接的方式来格式化带有组分隔符的数字。

>>> import locale
>>> locale.setlocale(locale.LC_ALL, 'English_United States.1252')
'English_United States.1252'
>>> conv = locale.localeconv()          # get a mapping of conventions
>>> x = 1234567.8
>>> locale.format_string("%d", x, grouping=True)
'1,234,567'
>>> locale.format_string("%s%.*f", (conv['currency_symbol'],
...                      conv['frac_digits'], x), grouping=True)
'$1,234,567.80'

11.2. 模板

The string 模块包含一个通用的 Template 类,它具有简化的语法,适合最终用户编辑。这允许用户自定义他们的应用程序,而无需更改应用程序本身。

该格式使用由 $ 形成的占位符名称,并使用有效的 Python 标识符(字母数字字符和下划线)。用大括号包围占位符允许它后面跟着更多字母数字字符,中间没有空格。编写 $$ 会创建一个转义的 $

>>> from string import Template
>>> t = Template('${village}folk send $$10 to $cause.')
>>> t.substitute(village='Nottingham', cause='the ditch fund')
'Nottinghamfolk send $10 to the ditch fund.'

The substitute() 方法在字典或关键字参数中没有提供占位符时会引发 KeyError。对于邮件合并类型的应用程序,用户提供的数据可能不完整,因此 safe_substitute() 方法可能更合适——如果数据缺失,它将保留占位符不变。

>>> t = Template('Return the $item to $owner.')
>>> d = dict(item='unladen swallow')
>>> t.substitute(d)
Traceback (most recent call last):
  ...
KeyError: 'owner'
>>> t.safe_substitute(d)
'Return the unladen swallow to $owner.'

Template 子类可以指定自定义分隔符。例如,照片浏览器用于批量重命名的实用程序可以选择使用百分号作为占位符,例如当前日期、图像序列号或文件格式。

>>> import time, os.path
>>> photofiles = ['img_1074.jpg', 'img_1076.jpg', 'img_1077.jpg']
>>> class BatchRename(Template):
...     delimiter = '%'
...
>>> fmt = input('Enter rename style (%d-date %n-seqnum %f-format):  ')
Enter rename style (%d-date %n-seqnum %f-format):  Ashley_%n%f

>>> t = BatchRename(fmt)
>>> date = time.strftime('%d%b%y')
>>> for i, filename in enumerate(photofiles):
...     base, ext = os.path.splitext(filename)
...     newname = t.substitute(d=date, n=i, f=ext)
...     print('{0} --> {1}'.format(filename, newname))

img_1074.jpg --> Ashley_0.jpg
img_1076.jpg --> Ashley_1.jpg
img_1077.jpg --> Ashley_2.jpg

模板的另一个应用是将程序逻辑与多种输出格式的细节分离。这使得可以为 XML 文件、纯文本报告和 HTML 网页报告替换自定义模板。

11.3. 使用二进制数据记录布局

struct 模块提供 pack()unpack() 函数,用于处理可变长度的二进制记录格式。以下示例展示了如何在不使用 zipfile 模块的情况下遍历 ZIP 文件中的头信息。打包代码 "H""I" 分别代表两个和四个字节的无符号数。 "<" 表示它们是标准大小且采用小端字节序

import struct

with open('myfile.zip', 'rb') as f:
    data = f.read()

start = 0
for i in range(3):                      # show the first 3 file headers
    start += 14
    fields = struct.unpack('<IIIHH', data[start:start+16])
    crc32, comp_size, uncomp_size, filenamesize, extra_size = fields

    start += 16
    filename = data[start:start+filenamesize]
    start += filenamesize
    extra = data[start:start+extra_size]
    print(filename, hex(crc32), comp_size, uncomp_size)

    start += extra_size + comp_size     # skip to the next header

11.4. 多线程

线程是一种解耦不依赖顺序的任务的技术。线程可用于提高接受用户输入的应用程序的响应能力,同时其他任务在后台运行。一个相关的用例是在另一个线程中并行运行 I/O 和计算。

以下代码展示了如何使用高级 threading 模块在后台运行任务,同时主程序继续运行

import threading, zipfile

class AsyncZip(threading.Thread):
    def __init__(self, infile, outfile):
        threading.Thread.__init__(self)
        self.infile = infile
        self.outfile = outfile

    def run(self):
        f = zipfile.ZipFile(self.outfile, 'w', zipfile.ZIP_DEFLATED)
        f.write(self.infile)
        f.close()
        print('Finished background zip of:', self.infile)

background = AsyncZip('mydata.txt', 'myarchive.zip')
background.start()
print('The main program continues to run in foreground.')

background.join()    # Wait for the background task to finish
print('Main program waited until background was done.')

多线程应用程序的主要挑战是协调共享数据或其他资源的线程。为此,threading 模块提供了一些同步原语,包括锁、事件、条件变量和信号量。

虽然这些工具功能强大,但轻微的设计错误会导致难以重现的问题。因此,首选的任务协调方法是将对资源的所有访问集中在一个线程中,然后使用 queue 模块从其他线程向该线程提供请求。使用 Queue 对象进行线程间通信和协调的应用程序更容易设计、更易读且更可靠。

11.5. 日志记录

logging 模块提供了一个功能齐全且灵活的日志记录系统。最简单的情况下,日志消息被发送到文件或 sys.stderr

import logging
logging.debug('Debugging information')
logging.info('Informational message')
logging.warning('Warning:config file %s not found', 'server.conf')
logging.error('Error occurred')
logging.critical('Critical error -- shutting down')

这将产生以下输出

WARNING:root:Warning:config file server.conf not found
ERROR:root:Error occurred
CRITICAL:root:Critical error -- shutting down

默认情况下,信息和调试消息被抑制,输出被发送到标准错误。其他输出选项包括通过电子邮件、数据报、套接字或 HTTP 服务器路由消息。新的过滤器可以根据消息优先级选择不同的路由: DEBUGINFOWARNINGERRORCRITICAL

日志记录系统可以直接从 Python 配置,也可以从用户可编辑的配置文件加载,以便在不修改应用程序的情况下进行自定义日志记录。

11.6. 弱引用

Python 进行自动内存管理(大多数对象的引用计数和 垃圾回收 用于消除循环)。内存将在最后一个对它的引用被消除后不久被释放。

这种方法适用于大多数应用程序,但有时需要仅在对象被其他内容使用时跟踪它们。不幸的是,仅仅跟踪它们就会创建一个引用,使它们永久存在。 weakref 模块提供了一些工具来跟踪对象,而不会创建引用。当不再需要该对象时,它会自动从弱引用表中删除,并为弱引用对象触发回调。典型的应用包括缓存创建成本高的对象

>>> import weakref, gc
>>> class A:
...     def __init__(self, value):
...         self.value = value
...     def __repr__(self):
...         return str(self.value)
...
>>> a = A(10)                   # create a reference
>>> d = weakref.WeakValueDictionary()
>>> d['primary'] = a            # does not create a reference
>>> d['primary']                # fetch the object if it is still alive
10
>>> del a                       # remove the one reference
>>> gc.collect()                # run garbage collection right away
0
>>> d['primary']                # entry was automatically removed
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    d['primary']                # entry was automatically removed
  File "C:/python312/lib/weakref.py", line 46, in __getitem__
    o = self.data[key]()
KeyError: 'primary'

11.7. 用于处理列表的工具

许多数据结构需求可以通过内置的列表类型来满足。但是,有时需要具有不同性能权衡的替代实现。

array 模块提供了一个 array 对象,它类似于一个列表,但只存储同构数据,并且存储得更紧凑。以下示例显示了一个存储为两个字节无符号二进制数(类型代码 "H")的数字数组,而不是常规 Python int 对象列表的每个条目通常的 16 字节

>>> from array import array
>>> a = array('H', [4000, 10, 700, 22222])
>>> sum(a)
26932
>>> a[1:3]
array('H', [10, 700])

collections 模块提供了一个 deque 对象,它类似于一个列表,但从左侧追加和弹出速度更快,但在中间查找速度更慢。这些对象非常适合实现队列和广度优先树搜索

>>> from collections import deque
>>> d = deque(["task1", "task2", "task3"])
>>> d.append("task4")
>>> print("Handling", d.popleft())
Handling task1
unsearched = deque([starting_node])
def breadth_first_search(unsearched):
    node = unsearched.popleft()
    for m in gen_moves(node):
        if is_goal(m):
            return m
        unsearched.append(m)

除了替代列表实现之外,库还提供其他工具,例如 bisect 模块,其中包含用于操作排序列表的函数

>>> import bisect
>>> scores = [(100, 'perl'), (200, 'tcl'), (400, 'lua'), (500, 'python')]
>>> bisect.insort(scores, (300, 'ruby'))
>>> scores
[(100, 'perl'), (200, 'tcl'), (300, 'ruby'), (400, 'lua'), (500, 'python')]

heapq 模块提供了一些函数来实现基于常规列表的堆。最小值条目始终保存在位置零。这对于反复访问最小元素但不想运行完整列表排序的应用程序很有用

>>> from heapq import heapify, heappop, heappush
>>> data = [1, 3, 5, 7, 9, 2, 4, 6, 8, 0]
>>> heapify(data)                      # rearrange the list into heap order
>>> heappush(data, -5)                 # add a new entry
>>> [heappop(data) for i in range(3)]  # fetch the three smallest entries
[-5, 0, 1]

11.8. 十进制浮点运算

decimal 模块提供了一个 Decimal 数据类型,用于十进制浮点运算。与内置的 float 二进制浮点实现相比,该类在以下方面特别有用

  • 金融应用程序和其他需要精确十进制表示的用途,

  • 对精度的控制,

  • 对舍入的控制,以满足法律或监管要求,

  • 跟踪有效十进制位数,或

  • 用户期望结果与手工计算结果匹配的应用程序。

例如,计算 70 美分的电话费的 5% 税款,在十进制浮点和二进制浮点中得到不同的结果。如果结果四舍五入到最接近的美分,则差异会变得很大

>>> from decimal import *
>>> round(Decimal('0.70') * Decimal('1.05'), 2)
Decimal('0.74')
>>> round(.70 * 1.05, 2)
0.73

结果 Decimal 保留了尾随零,从具有两位有效数字的乘数自动推断出四位有效数字。Decimal 复制了手工进行的数学运算,并避免了二进制浮点数无法精确表示十进制数量时可能出现的问题。

精确表示使 Decimal 类能够执行不适合二进制浮点数的模运算和相等性测试。

>>> Decimal('1.00') % Decimal('.10')
Decimal('0.00')
>>> 1.00 % 0.10
0.09999999999999995

>>> sum([Decimal('0.1')]*10) == Decimal('1.0')
True
>>> 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 == 1.0
False

decimal 模块提供具有所需精度的算术运算。

>>> getcontext().prec = 36
>>> Decimal(1) / Decimal(7)
Decimal('0.142857142857142857142857142857142857')