collections —- 容器数据类型

Source code:Lib/collections/init.py

这个模块实现了特定目标的容器，以提供Python标准内建容器 dict , list , set , 和 tuple 的替代选择。

namedtuple()创建命名元组子类的工厂函数
deque类似列表(list)的容器，实现了在两端快速添加(append)和弹出(pop)
ChainMap类似字典(dict)的容器类，将多个映射集合到一个视图里面
Counter字典的子类，提供了可哈希对象的计数功能
OrderedDict字典的子类，保存了他们被添加的顺序
defaultdict字典的子类，提供了一个工厂函数，为字典查询提供一个默认值
UserDict封装了字典对象，简化了字典子类化
UserList封装了列表对象，简化了列表子类化
UserString封装了列表对象，简化了字符串子类化

Deprecated since version 3.3, will be removed in version 3.9: 已将 容器抽象基类 移至 collections.abc 模块。 为了保持向下兼容性，它们在 Python 3.8 版的这个模块中仍然存在.

ChainMap 对象

3.3 新版功能.

一个 ChainMap 类是为了将多个映射快速的链接到一起，这样它们就可以作为一个单元处理。它通常比创建一个新字典和多次调用 update() 要快很多。

这个类可以用于模拟嵌套作用域，并且在模版化的时候比较有用。

  • class collections.ChainMap(*maps)
  • 一个 ChainMap 将多个字典或者其他映射组合在一起，创建一个单独的可更新的视图。 如果没有 maps 被指定，就提供一个默认的空字典，这样一个新链至少有一个映射。

底层映射被存储在一个列表中。这个列表是公开的，可以通过 maps 属性存取和更新。没有其他的状态。

搜索查询底层映射，直到一个键被找到。不同的是，写，更新和删除只操作第一个映射。

一个 ChainMap 通过引用合并底层映射。 所以，如果一个底层映射更新了，这些更改会反映到 ChainMap 。

支持所有常用字典方法。另外还有一个 maps 属性(attribute)，一个创建子上下文的方法(method)， 一个存取它们首个映射的属性(property):

  • maps

  • 一个可以更新的映射列表。这个列表是按照第一次搜索到最后一次搜索的顺序组织的。它是仅有的存储状态，可以被修改。列表最少包含一个映射。

  • newchild(_m=None)

  • 返回一个新的 ChainMap 类，包含了一个新映射(map)，后面跟随当前实例的全部映射(map)。如果 m 被指定，它就成为不同新的实例，就是在所有映射前加上 m，如果没有指定，就加上一个空字典，这样的话一个 d.new_child() 调用等价于 ChainMap({}, *d.maps) 。这个方法用于创建子上下文，不改变任何父映射的值。

在 3.4 版更改: 添加了 m 可选参数。

  • parents
  • 属性返回一个新的 ChainMap 包含所有的当前实例的映射，除了第一个。这样可以在搜索的时候跳过第一个映射。 使用的场景类似在 nested scopes 嵌套作用域中使用 nonlocal 关键词。用例也可以类比内建函数 super() 。一个 d.parents 的引用等价于 ChainMap(*d.maps[1:]) 。

注意，一个 ChainMap() 的迭代顺序是通过扫描最后的映射来确定的:

  1. >>> baseline = {'music': 'bach', 'art': 'rembrandt'}
  2. >>> adjustments = {'art': 'van gogh', 'opera': 'carmen'}
  3. >>> list(ChainMap(adjustments, baseline))
  4. ['music', 'art', 'opera']

这给出了与 dict.update() 调用序列相同的顺序，从最后一个映射开始:

  1. >>> combined = baseline.copy()
  2. >>> combined.update(adjustments)
  3. >>> list(combined)
  4. ['music', 'art', 'opera']

参见

ChainMap 例子和方法

这一节提供了多个使用链映射的案例。

模拟Python内部lookup链的例子

  1. import builtins
  2. pylookup = ChainMap(locals(), globals(), vars(builtins))

让用户指定的命令行参数优先于环境变量，优先于默认值的例子

  1. import os, argparse
  2.  
  3. defaults = {'color': 'red', 'user': 'guest'}
  4.  
  5. parser = argparse.ArgumentParser()
  6. parser.add_argument('-u', '--user')
  7. parser.add_argument('-c', '--color')
  8. namespace = parser.parse_args()
  9. command_line_args = {k: v for k, v in vars(namespace).items() if v is not None}
  10.  
  11. combined = ChainMap(command_line_args, os.environ, defaults)
  12. print(combined['color'])
  13. print(combined['user'])

用 ChainMap 类模拟嵌套上下文的例子

  1. c = ChainMap()        # Create root context
  2. d = c.new_child()     # Create nested child context
  3. e = c.new_child()     # Child of c, independent from d
  4. e.maps[0]             # Current context dictionary -- like Python's locals()
  5. e.maps[-1]            # Root context -- like Python's globals()
  6. e.parents             # Enclosing context chain -- like Python's nonlocals
  7.  
  8. d['x'] = 1            # Set value in current context
  9. d['x']                # Get first key in the chain of contexts
  10. del d['x']            # Delete from current context
  11. list(d)               # All nested values
  12. k in d                # Check all nested values
  13. len(d)                # Number of nested values
  14. d.items()             # All nested items
  15. dict(d)               # Flatten into a regular dictionary

ChainMap 类只更新链中的第一个映射，但lookup会搜索整个链。 然而，如果需要深度写和删除，也可以很容易的通过定义一个子类来实现它

  1. class DeepChainMap(ChainMap):
  2.     'Variant of ChainMap that allows direct updates to inner scopes'
  3.  
  4.     def __setitem__(self, key, value):
  5.         for mapping in self.maps:
  6.             if key in mapping:
  7.                 mapping[key] = value
  8.                 return
  9.         self.maps[0][key] = value
  10.  
  11.     def __delitem__(self, key):
  12.         for mapping in self.maps:
  13.             if key in mapping:
  14.                 del mapping[key]
  15.                 return
  16.         raise KeyError(key)
  17.  
  18. >>> d = DeepChainMap({'zebra': 'black'}, {'elephant': 'blue'}, {'lion': 'yellow'})
  19. >>> d['lion'] = 'orange'         # update an existing key two levels down
  20. >>> d['snake'] = 'red'           # new keys get added to the topmost dict
  21. >>> del d['elephant']            # remove an existing key one level down
  22. >>> d                            # display result
  23. DeepChainMap({'zebra': 'black', 'snake': 'red'}, {}, {'lion': 'orange'})

Counter 对象

一个计数器工具提供快速和方便的计数。比如

  1. >>> # Tally occurrences of words in a list
  2. >>> cnt = Counter()
  3. >>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']:
  4. ...     cnt[word] += 1
  5. >>> cnt
  6. Counter({'blue': 3, 'red': 2, 'green': 1})
  7.  
  8. >>> # Find the ten most common words in Hamlet
  9. >>> import re
  10. >>> words = re.findall(r'\w+', open('hamlet.txt').read().lower())
  11. >>> Counter(words).most_common(10)
  12. [('the', 1143), ('and', 966), ('to', 762), ('of', 669), ('i', 631),
  13.  ('you', 554),  ('a', 546), ('my', 514), ('hamlet', 471), ('in', 451)]
  • class collections.Counter([iterable-or-mapping])
  • 一个 Counter 是一个 dict 的子类，用于计数可哈希对象。它是一个集合，元素像字典键(key)一样存储，它们的计数存储为值。计数可以是任何整数值，包括0和负数。 Counter 类有点像其他语言中的 bags或multisets。

元素从一个 iterable 被计数或从其他的 mapping (or counter)初始化：

  1. >>> c = Counter()                           # a new, empty counter
  2. >>> c = Counter('gallahad')                 # a new counter from an iterable
  3. >>> c = Counter({'red': 4, 'blue': 2})      # a new counter from a mapping
  4. >>> c = Counter(cats=4, dogs=8)             # a new counter from keyword args

Counter对象有一个字典接口，如果引用的键没有任何记录，就返回一个0，而不是弹出一个 KeyError :

  1. >>> c = Counter(['eggs', 'ham'])
  2. >>> c['bacon']                              # count of a missing element is zero
  3. 0

设置一个计数为0不会从计数器中移去一个元素。使用 del 来删除它:

  1. >>> c['sausage'] = 0                        # counter entry with a zero count
  2. >>> del c['sausage']                        # del actually removes the entry

3.1 新版功能.

在 3.7 版更改: 作为 dict 的子类，Counter 继承了记住插入顺序的功能。 Counter 对象进行数学运算时同样会保持顺序。 结果会先按每个元素在运算符左边的出现时间排序，然后再按其在运算符右边的出现时间排序。

计数器对象除了字典方法以外，还提供了三个其他的方法：

  • elements()
  • 返回一个迭代器，其中每个元素将重复出现计数值所指定次。 元素会按首次出现的顺序返回。 如果一个元素的计数值小于一，elements() 将会忽略它。
  1. >>> c = Counter(a=4, b=2, c=0, d=-2)
  2. >>> sorted(c.elements())
  3. ['a', 'a', 'a', 'a', 'b', 'b']
  • mostcommon([_n])
  • 返回一个列表，其中包含 n 个最常见的元素及出现次数，按常见程度由高到低排序。 如果 n 被省略或为 None，most_common() 将返回计数器中的 所有 元素。 计数值相等的元素按首次出现的顺序排序：
  1. >>> Counter('abracadabra').most_common(3)
  2. [('a', 5), ('b', 2), ('r', 2)]
  • subtract([iterable-or-mapping])
  • 从 迭代对象 或 映射对象 减去元素。像 dict.update() 但是是减去，而不是替换。输入和输出都可以是0或者负数。
  1. >>> c = Counter(a=4, b=2, c=0, d=-2)
  2. >>> d = Counter(a=1, b=2, c=3, d=4)
  3. >>> c.subtract(d)
  4. >>> c
  5. Counter({'a': 3, 'b': 0, 'c': -3, 'd': -6})

3.2 新版功能.

通常字典方法都可用于 Counter 对象，除了有两个方法工作方式与字典并不相同。

  • fromkeys(iterable)

  • 这个类方法没有在 Counter 中实现。

  • update([iterable-or-mapping])

  • 从 迭代对象 计数元素或者 从另一个 映射对象 (或计数器) 添加。 像 dict.update() 但是是加上，而不是替换。另外，迭代对象 应该是序列元素，而不是一个 (key, value) 对。

Counter 对象的常用案例

  1. sum(c.values())                 # total of all counts
  2. c.clear()                       # reset all counts
  3. list(c)                         # list unique elements
  4. set(c)                          # convert to a set
  5. dict(c)                         # convert to a regular dictionary
  6. c.items()                       # convert to a list of (elem, cnt) pairs
  7. Counter(dict(list_of_pairs))    # convert from a list of (elem, cnt) pairs
  8. c.most_common()[:-n-1:-1]       # n least common elements
  9. +c                              # remove zero and negative counts

提供了几个数学操作，可以结合 Counter 对象，以生产 multisets (计数器中大于0的元素）。 加和减，结合计数器，通过加上或者减去元素的相应计数。交集和并集返回相应计数的最小或最大值。每种操作都可以接受带符号的计数，但是输出会忽略掉结果为零或者小于零的计数。

  1. >>> c = Counter(a=3, b=1)
  2. >>> d = Counter(a=1, b=2)
  3. >>> c + d                       # add two counters together:  c[x] + d[x]
  4. Counter({'a': 4, 'b': 3})
  5. >>> c - d                       # subtract (keeping only positive counts)
  6. Counter({'a': 2})
  7. >>> c & d                       # intersection:  min(c[x], d[x]) # doctest: +SKIP
  8. Counter({'a': 1, 'b': 1})
  9. >>> c | d                       # union:  max(c[x], d[x])
  10. Counter({'a': 3, 'b': 2})

单目加和减（一元操作符）意思是从空计数器加或者减去。

  1. >>> c = Counter(a=2, b=-4)
  2. >>> +c
  3. Counter({'a': 2})
  4. >>> -c
  5. Counter({'b': 4})

3.3 新版功能: 添加了对一元加，一元减和位置集合操作的支持。

注解

计数器主要是为了表达运行的正的计数而设计；但是，小心不要预先排除负数或者其他类型。为了帮助这些用例，这一节记录了最小范围和类型限制。

  • Counter 类是一个字典的子类，不限制键和值。值用于表示计数，但你实际上 可以 存储任何其他值。

  • most_common() 方法在值需要排序的时候用。

  • 原地操作比如 c[key] += 1 ， 值类型只需要支持加和减。 所以分数，小数，和十进制都可以用，负值也可以支持。这两个方法 update() 和 subtract() 的输入和输出也一样支持负数和0。

  • Multiset多集合方法只为正值的使用情况设计。输入可以是负数或者0，但只输出计数为正的值。没有类型限制，但值类型需要支持加，减和比较操作。

  • elements() 方法要求正整数计数。忽略0和负数计数。

参见

  1. map(Counter, combinations_with_replacement('ABC', 2)) # --> AA AB AC BB BC CC

deque 对象

  • class collections.deque([iterable[, maxlen]])
  • 返回一个新的双向队列对象，从左到右初始化(用方法 append()) ，从 iterable （迭代对象) 数据创建。如果 iterable 没有指定，新队列为空。

Deque队列是由栈或者queue队列生成的（发音是 “deck”，”double-ended queue”的简称）。Deque 支持线程安全，内存高效添加(append)和弹出(pop)，从两端都可以，两个方向的大概开销都是 O(1) 复杂度。

虽然 list 对象也支持类似操作，不过这里优化了定长操作和 pop(0) 和 insert(0, v) 的开销。它们引起 O(n) 内存移动的操作，改变底层数据表达的大小和位置。

如果 maxlen 没有指定或者是 None ，deques 可以增长到任意长度。否则，deque就限定到指定最大长度。一旦限定长度的deque满了，当新项加入时，同样数量的项就从另一端弹出。限定长度deque提供类似Unix filter tail 的功能。它们同样可以用与追踪最近的交换和其他数据池活动。

双向队列(deque)对象支持以下方法：

  • append(x)

  • 添加 x 到右端。

  • appendleft(x)

  • 添加 x 到左端。

  • clear()

  • 移除所有元素，使其长度为0.

  • copy()

  • 创建一份浅拷贝。

3.5 新版功能.

  • count(x)
  • 计算deque中个数等于 x 的元素。

3.2 新版功能.

  • extend(iterable)

  • 扩展deque的右侧，通过添加iterable参数中的元素。

  • extendleft(iterable)

  • 扩展deque的左侧，通过添加iterable参数中的元素。注意，左添加时，在结果中iterable参数中的顺序将被反过来添加。

  • index(x[, start[, stop]])

  • 返回第 x 个元素（从 start 开始计算，在 stop 之前）。返回第一个匹配，如果没找到的话，升起 ValueError 。

3.5 新版功能.

  • insert(i, x)
  • 在位置 i 插入 x 。

如果插入会导致一个限长deque超出长度 maxlen 的话，就升起一个 IndexError 。

3.5 新版功能.

  • pop()

  • 移去并且返回一个元素，deque最右侧的那一个。如果没有元素的话，就升起 IndexError 索引错误。

  • popleft()

  • 移去并且返回一个元素，deque最左侧的那一个。如果没有元素的话，就升起 IndexError 索引错误。

  • remove(value)

  • 移去找到的第一个 value。 如果没有的话就升起 ValueError 。

  • reverse()

  • 将deque逆序排列。返回 None 。

3.2 新版功能.

  • rotate(n=1)
  • 向右循环移动 n 步。 如果 n 是负数，就向左循环。

如果deque不是空的，向右循环移动一步就等价于 d.appendleft(d.pop()) ， 向左循环一步就等价于 d.append(d.popleft()) 。

Deque对象同样提供了一个只读属性:

  • maxlen
  • Deque的最大尺寸，如果没有限定的话就是 None 。

3.1 新版功能.

除了以上操作，deque 还支持迭代、封存、len(d)、reversed(d)、copy.copy(d)、copy.deepcopy(d)、成员检测运算符 in 以及下标引用例如通过 d[0] 访问首个元素等。 索引访问在两端的复杂度均为 O(1) 但在中间则会低至 O(n)。 如需快速随机访问，请改用列表。

Deque从版本3.5开始支持 add(), mul(), 和 imul() 。

示例:

  1. >>> from collections import deque
  2. >>> d = deque('ghi')                 # make a new deque with three items
  3. >>> for elem in d:                   # iterate over the deque's elements
  4. ...     print(elem.upper())
  5. G
  6. H
  7. I
  8.  
  9. >>> d.append('j')                    # add a new entry to the right side
  10. >>> d.appendleft('f')                # add a new entry to the left side
  11. >>> d                                # show the representation of the deque
  12. deque(['f', 'g', 'h', 'i', 'j'])
  13.  
  14. >>> d.pop()                          # return and remove the rightmost item
  15. 'j'
  16. >>> d.popleft()                      # return and remove the leftmost item
  17. 'f'
  18. >>> list(d)                          # list the contents of the deque
  19. ['g', 'h', 'i']
  20. >>> d[0]                             # peek at leftmost item
  21. 'g'
  22. >>> d[-1]                            # peek at rightmost item
  23. 'i'
  24.  
  25. >>> list(reversed(d))                # list the contents of a deque in reverse
  26. ['i', 'h', 'g']
  27. >>> 'h' in d                         # search the deque
  28. True
  29. >>> d.extend('jkl')                  # add multiple elements at once
  30. >>> d
  31. deque(['g', 'h', 'i', 'j', 'k', 'l'])
  32. >>> d.rotate(1)                      # right rotation
  33. >>> d
  34. deque(['l', 'g', 'h', 'i', 'j', 'k'])
  35. >>> d.rotate(-1)                     # left rotation
  36. >>> d
  37. deque(['g', 'h', 'i', 'j', 'k', 'l'])
  38.  
  39. >>> deque(reversed(d))               # make a new deque in reverse order
  40. deque(['l', 'k', 'j', 'i', 'h', 'g'])
  41. >>> d.clear()                        # empty the deque
  42. >>> d.pop()                          # cannot pop from an empty deque
  43. Traceback (most recent call last):
  44.     File "<pyshell#6>", line 1, in -toplevel-
  45.         d.pop()
  46. IndexError: pop from an empty deque
  47.  
  48. >>> d.extendleft('abc')              # extendleft() reverses the input order
  49. >>> d
  50. deque(['c', 'b', 'a'])

deque 用法

这一节展示了deque的多种用法。

限长deque提供了类似Unix tail 过滤功能

  1. def tail(filename, n=10):
  2.     'Return the last n lines of a file'
  3.     with open(filename) as f:
  4.         return deque(f, n)

另一个用法是维护一个近期添加元素的序列，通过从右边添加和从左边弹出

  1. def moving_average(iterable, n=3):
  2.     # moving_average([40, 30, 50, 46, 39, 44]) --> 40.0 42.0 45.0 43.0
  3.     # http://en.wikipedia.org/wiki/Moving_average
  4.     it = iter(iterable)
  5.     d = deque(itertools.islice(it, n-1))
  6.     d.appendleft(0)
  7.     s = sum(d)
  8.     for elem in it:
  9.         s += elem - d.popleft()
  10.         d.append(elem)
  11.         yield s / n

一个 轮询调度器 可以通过在 deque 中放入迭代器来实现。值从当前迭代器的位置0被取出并暂存(yield)。 如果这个迭代器消耗完毕，就用 popleft() 将其从对列中移去；否则，就通过 rotate() 将它移到队列的末尾

  1. def roundrobin(*iterables):
  2.     "roundrobin('ABC', 'D', 'EF') --> A D E B F C"
  3.     iterators = deque(map(iter, iterables))
  4.     while iterators:
  5.         try:
  6.             while True:
  7.                 yield next(iterators[0])
  8.                 iterators.rotate(-1)
  9.         except StopIteration:
  10.             # Remove an exhausted iterator.
  11.             iterators.popleft()

rotate() 方法提供了一种方式来实现 deque 切片和删除。 例如， 一个纯的Python del d[n] 实现依赖于 rotate() 来定位要弹出的元素

  1. def delete_nth(d, n):
  2.     d.rotate(-n)
  3.     d.popleft()
  4.     d.rotate(n)

要实现 deque 切片， 使用一个类似的方法，应用 rotate() 将目标元素放到左边。通过 popleft() 移去老的条目（entries），通过 extend() 添加新的条目， 然后反向 rotate。这个方法可以最小代价实现命令式的栈操作，诸如 dup, drop, swap, over, pick, rot, 和 roll 。

defaultdict 对象

  • class collections.defaultdict([default_factory[, …]])
  • 返回一个新的类似字典的对象。 defaultdict 是内置 dict 类的子类。它重载了一个方法并添加了一个可写的实例变量。其余的功能与 dict 类相同，此处不再重复说明。

第一个参数 default_factory 提供了一个初始值。它默认为 None 。所有的其他参数都等同与 dict 构建器中的参数对待，包括关键词参数。

defaultdict 对象除了支持 dict 的操作，还支持下面的方法作为扩展:

如果 default_factory 不为 None ， 它就会会被调用，不带参数，为 key 提供一个默认值， 这个值和 key 作为一个对被插入到字典中，并返回。

如果调用 default_factory 升起了一个例外，这个例外就被扩散传递，不经过改变。

这个方法在查询键值失败时，会被 dict 中的 getitem() 调用。不管它是返回值或升起例外，都会被 getitem() 传递。

注意 missing()不会 被 getitem() 以外的其他方法调用。意思就是 get() 会向正常的dict那样返回 None ，而不是使用 default_factory 。

defaultdict 支持以下实例变量:

  • default_factory
  • 这个属性被 missing() 方法使用；它从构建器的第一个参数初始化，如果提供了的话，否则就是 None 。

defaultdict 例子

使用 list 作为 default_factory ，很容易将序列作为键值对加入字典:

  1. >>> s = [('yellow', 1), ('blue', 2), ('yellow', 3), ('blue', 4), ('red', 1)]
  2. >>> d = defaultdict(list)
  3. >>> for k, v in s:
  4. ...     d[k].append(v)
  5. ...
  6. >>> sorted(d.items())
  7. [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]

当每个键第一次遇见时，它还没有在字典里面；所以条目自动创建，通过 default_factory 方法，并返回一个空的 list 。 list.append() 操作添加值到这个新的列表里。当键再次被存取时，就正常操作， list.append() 添加另一个值到列表中。这个计数比它的等价方法 dict.setdefault() 要快速和简单:

  1. >>> d = {}
  2. >>> for k, v in s:
  3. ...     d.setdefault(k, []).append(v)
  4. ...
  5. >>> sorted(d.items())
  6. [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]

设置 default_factory 为 int ，使 defaultdict 在计数方面发挥好的作用（像其他语言中的bag或multiset）:

  1. >>> s = 'mississippi'
  2. >>> d = defaultdict(int)
  3. >>> for k in s:
  4. ...     d[k] += 1
  5. ...
  6. >>> sorted(d.items())
  7. [('i', 4), ('m', 1), ('p', 2), ('s', 4)]

当一个字母首次遇到时，它就查询失败，所以 default_factory 调用 int() 来提供一个整数0作为默认值。自增操作然后建立对每个字母的计数。

函数 int() 总是返回0，是常数函数的特殊情况。一个更快和灵活的方法是使用lambda函数，可以提供任何常量值(不只是0):

  1. >>> def constant_factory(value):
  2. ...     return lambda: value
  3. >>> d = defaultdict(constant_factory('<missing>'))
  4. >>> d.update(name='John', action='ran')
  5. >>> '%(name)s %(action)s to %(object)s' % d
  6. 'John ran to <missing>'

设置 default_factory 为 set 使 defaultdict 用于构建字典集合:

  1. >>> s = [('red', 1), ('blue', 2), ('red', 3), ('blue', 4), ('red', 1), ('blue', 4)]
  2. >>> d = defaultdict(set)
  3. >>> for k, v in s:
  4. ...     d[k].add(v)
  5. ...
  6. >>> sorted(d.items())
  7. [('blue', {2, 4}), ('red', {1, 3})]

namedtuple() 命名元组的工厂函数

命名元组赋予每个位置一个含义，提供可读性和自文档性。它们可以用于任何普通元组，并添加了通过名字获取值的能力，通过索引值也是可以的。

  • collections.namedtuple(typename, field_names, *, rename=False, defaults=None, module=None)
  • 返回一个新的元组子类，名为 typename 。这个新的子类用于创建类元组的对象，可以通过域名来获取属性值，同样也可以通过索引和迭代获取值。子类实例同样有文档字符串（类名和域名）另外一个有用的 repr() 方法，以 name=value 格式列明了元组内容。

field_names 是一个像 [‘x’, ‘y’] 一样的字符串序列。另外 field_names 可以是一个纯字符串，用空白或逗号分隔开元素名，比如 'x y' 或者 'x, y' 。

任何有效的Python 标识符都可以作为域名，除了下划线开头的那些。有效标识符由字母，数字，下划线组成，但首字母不能是数字或下划线，另外不能是关键词 keyword 比如 class, for, return, global, pass, 或 raise 。

如果 rename 为真， 无效域名会自动转换成位置名。比如 ['abc', 'def', 'ghi', 'abc'] 转换成 ['abc', '_1', 'ghi', '_3'] ， 消除关键词 def 和重复域名 abc 。

defaults 可以为 None 或者是一个默认值的 iterable 。如果一个默认值域必须跟其他没有默认值的域在一起出现，defaults 就应用到最右边的参数。比如如果域名 ['x', 'y', 'z'] 和默认值 (1, 2) ，那么 x 就必须指定一个参数值 ，y 默认值 1 ， z 默认值 2 。

如果 module 值有定义，命名元组的 module 属性值就被设置。

命名元组实例没有字典，所以它们要更轻量，并且占用更小内存。

在 3.1 版更改: 添加了对 rename 的支持。

在 3.6 版更改: verbose 和 rename 参数成为 仅限关键字参数.

在 3.6 版更改: 添加了 module 参数。

在 3.7 版更改: 移除了 verbose 形参和 _source 属性。

在 3.7 版更改: 添加了 defaults 参数和 _field_defaults 属性。

  1. >>> # Basic example
  2. >>> Point = namedtuple('Point', ['x', 'y'])
  3. >>> p = Point(11, y=22)     # instantiate with positional or keyword arguments
  4. >>> p[0] + p[1]             # indexable like the plain tuple (11, 22)
  5. 33
  6. >>> x, y = p                # unpack like a regular tuple
  7. >>> x, y
  8. (11, 22)
  9. >>> p.x + p.y               # fields also accessible by name
  10. 33
  11. >>> p                       # readable __repr__ with a name=value style
  12. Point(x=11, y=22)

命名元组尤其有用于赋值 csvsqlite3 模块返回的元组

  1. EmployeeRecord = namedtuple('EmployeeRecord', 'name, age, title, department, paygrade')
  2.  
  3. import csv
  4. for emp in map(EmployeeRecord._make, csv.reader(open("employees.csv", "rb"))):
  5.     print(emp.name, emp.title)
  6.  
  7. import sqlite3
  8. conn = sqlite3.connect('/companydata')
  9. cursor = conn.cursor()
  10. cursor.execute('SELECT name, age, title, department, paygrade FROM employees')
  11. for emp in map(EmployeeRecord._make, cursor.fetchall()):
  12.     print(emp.name, emp.title)

除了继承元组的方法，命名元组还支持三个额外的方法和两个属性。为了防止域名冲突，方法和属性以下划线开始。

  • classmethod somenamedtuple.make(_iterable)
  • 类方法从存在的序列或迭代实例创建一个新实例。
  1. >>> t = [11, 22]
  2. >>> Point._make(t)
  3. Point(x=11, y=22)
  • somenamedtuple._asdict()
  • 返回一个新的 dict ，它将字段名称映射到它们对应的值：
  1. >>> p = Point(x=11, y=22)
  2. >>> p._asdict()
  3. {'x': 11, 'y': 22}

在 3.1 版更改: 返回一个 OrderedDict 而不是 dict 。

在 3.8 版更改: 返回一个常规 dict 而不是 OrderedDict。 因为自 Python 3.7 起，常规字典已经保证有序。 如果需要 OrderedDict 的额外特性，推荐的解决方案是将结果转换为需要的类型: OrderedDict(nt._asdict())。

  • somenamedtuple.replace(**kwargs_)
  • 返回一个新的命名元组实例，并将指定域替换为新的值
  1. >>> p = Point(x=11, y=22)
  2. >>> p._replace(x=33)
  3. Point(x=33, y=22)
  4.  
  5. >>> for partnum, record in inventory.items():
  6. ...     inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now())
  • somenamedtuple._fields
  • 字符串元组列出了域名。用于提醒和从现有元组创建一个新的命名元组类型。
  1. >>> p._fields            # view the field names
  2. ('x', 'y')
  3.  
  4. >>> Color = namedtuple('Color', 'red green blue')
  5. >>> Pixel = namedtuple('Pixel', Point._fields + Color._fields)
  6. >>> Pixel(11, 22, 128, 255, 0)
  7. Pixel(x=11, y=22, red=128, green=255, blue=0)
  • somenamedtuple._field_defaults
  • 默认值的字典。
  1. >>> Account = namedtuple('Account', ['type', 'balance'], defaults=[0])
  2. >>> Account._field_defaults
  3. {'balance': 0}
  4. >>> Account('premium')
  5. Account(type='premium', balance=0)

要获取这个名字域的值，使用 getattr() 函数 :

  1. >>> getattr(p, 'x')
  2. 11

转换一个字典到命名元组，使用 ** 两星操作符 (所述如 解包参数列表):

  1. >>> d = {'x': 11, 'y': 22}
  2. >>> Point(**d)
  3. Point(x=11, y=22)

因为一个命名元组是一个正常的Python类，它可以很容易的通过子类更改功能。这里是如何添加一个计算域和定宽输出打印格式:

  1. >>> class Point(namedtuple('Point', ['x', 'y'])):
  2. ...     __slots__ = ()
  3. ...     @property
  4. ...     def hypot(self):
  5. ...         return (self.x ** 2 + self.y ** 2) ** 0.5
  6. ...     def __str__(self):
  7. ...         return 'Point: x=%6.3f  y=%6.3f  hypot=%6.3f' % (self.x, self.y, self.hypot)
  8.  
  9. >>> for p in Point(3, 4), Point(14, 5/7):
  10. ...     print(p)
  11. Point: x= 3.000  y= 4.000  hypot= 5.000
  12. Point: x=14.000  y= 0.714  hypot=14.018

上面的子类设置 slots 为一个空元组。通过阻止创建实例字典保持了较低的内存开销。

子类化对于添加和存储新的名字域是无效的。应当通过 _fields 创建一个新的命名元组来实现它:

  1. >>> Point3D = namedtuple('Point3D', Point._fields + ('z',))

文档字符串可以自定义，通过直接赋值给 doc 属性:

  1. >>> Book = namedtuple('Book', ['id', 'title', 'authors'])
  2. >>> Book.__doc__ += ': Hardcover book in active collection'
  3. >>> Book.id.__doc__ = '13-digit ISBN'
  4. >>> Book.title.__doc__ = 'Title of first printing'
  5. >>> Book.authors.__doc__ = 'List of authors sorted by last name'

在 3.5 版更改: 文档字符串属性变成可写。

参见

  • 请参阅 typing.NamedTuple ，以获取为命名元组添加类型提示的方法。 它还使用 class 关键字提供了一种优雅的符号:
  1. class Component(NamedTuple):
  2.     part_number: int
  3.     weight: float
  4.     description: Optional[str] = None

  • 对于以字典为底层的可变域名， 参考 types.SimpleNamespace() 。

  • dataclasses 模块提供了一个装饰器和一些函数，用于自动将生成的特殊方法添加到用户定义的类中。

OrderedDict 对象

有序词典就像常规词典一样，但有一些与排序操作相关的额外功能。由于内置的 dict 类获得了记住插入顺序的能力（在 Python 3.7 中保证了这种新行为），它们变得不那么重要了。

一些与 dict 的不同仍然存在：

  • 常规的 dict 被设计为非常擅长映射操作。 跟踪插入顺序是次要的。

  • OrderedDict 旨在擅长重新排序操作。 空间效率、迭代速度和更新操作的性能是次要的。

  • 算法上， OrderedDict 可以比 dict 更好地处理频繁的重新排序操作。 这使其适用于跟踪最近的访问（例如在 LRU cache 中）。

  • 对于 OrderedDict ，相等操作检查匹配顺序。

  • OrderedDict 类的 popitem() 方法有不同的签名。它接受一个可选参数来指定弹出哪个元素。

  • OrderedDict 类有一个 move_to_end() 方法，可以有效地将元素移动到任一端。

  • Python 3.8之前， dict 缺少 reversed() 方法。

  • class collections.OrderedDict([items])

  • 返回一个 dict 子类的实例，它具有专门用于重新排列字典顺序的方法。

3.1 新版功能.

  • popitem(last=True)

  • 有序字典的 popitem() 方法移除并返回一个 (key, value) 键值对。 如果 last 值为真，则按 LIFO 后进先出的顺序返回键值对，否则就按 FIFO 先进先出的顺序返回键值对。

  • moveto_end(_key, last=True)

  • 将现有 key 移动到有序字典的任一端。 如果 last 为真值（默认）则将元素移至末尾；如果 last 为假值则将元素移至开头。如果 key 不存在则会触发 KeyError:
  1. >>> d = OrderedDict.fromkeys('abcde')
  2. >>> d.move_to_end('b')
  3. >>> ''.join(d.keys())
  4. 'acdeb'
  5. >>> d.move_to_end('b', last=False)
  6. >>> ''.join(d.keys())
  7. 'bacde'

3.2 新版功能.

相对于通常的映射方法，有序字典还另外提供了逆序迭代的支持，通过 reversed() 。

OrderedDict 之间的相等测试是顺序敏感的，实现为 list(od1.items())==list(od2.items()) 。 OrderedDict 对象和其他的 Mapping 的相等测试，是顺序敏感的字典测试。这允许 OrderedDict 替换为任何字典可以使用的场所。

在 3.5 版更改: OrderedDict 的项(item)，键(key)和值(value) 视图 现在支持逆序迭代，通过 reversed() 。

在 3.6 版更改: PEP 468 赞成将关键词参数的顺序保留， 通过传递给 OrderedDict 构造器和它的 update() 方法。

OrderedDict 例子和用法

创建记住键值 最后 插入顺序的有序字典变体很简单。 如果新条目覆盖现有条目，则原始插入位置将更改并移至末尾:

  1. class LastUpdatedOrderedDict(OrderedDict):
  2.     'Store items in the order the keys were last added'
  3.  
  4.     def __setitem__(self, key, value):
  5.         super().__setitem__(key, value)
  6.         self.move_to_end(key)

一个 OrderedDict 对于实现 functools.lru_cache() 的变体也很有用:

  1. class LRU(OrderedDict):
  2.     'Limit size, evicting the least recently looked-up key when full'
  3.  
  4.     def __init__(self, maxsize=128, /, *args, **kwds):
  5.         self.maxsize = maxsize
  6.         super().__init__(*args, **kwds)
  7.  
  8.     def __getitem__(self, key):
  9.         value = super().__getitem__(key)
  10.         self.move_to_end(key)
  11.         return value
  12.  
  13.     def __setitem__(self, key, value):
  14.         super().__setitem__(key, value)
  15.         if len(self) > self.maxsize:
  16.             oldest = next(iter(self))
  17.             del self[oldest]

UserDict 对象

UserDict 类是用作字典对象的外包装。对这个类的需求已部分由直接创建 dict 的子类的功能所替代；不过，这个类处理起来更容易，因为底层的字典可以作为属性来访问。

  • class collections.UserDict([initialdata])
  • 模拟一个字典类。这个实例的内容保存为一个正常字典， 可以通过 UserDict 实例的 data 属性存取。如果提供了 initialdata 值， data 就被初始化为它的内容；注意一个 initialdata 的引用不会被保留作为其他用途。

UserDict 实例提供了以下属性作为扩展方法和操作的支持:

  • data
  • 一个真实的字典，用于保存 UserDict 类的内容。

UserList 对象

这个类封装了列表对象。它是一个有用的基础类，对于你想自定义的类似列表的类，可以继承和覆盖现有的方法，也可以添加新的方法。这样我们可以对列表添加新的行为。

对这个类的需求已部分由直接创建 list 的子类的功能所替代；不过，这个类处理起来更容易，因为底层的列表可以作为属性来访问。

  • class collections.UserList([list])
  • 模拟一个列表。这个实例的内容被保存为一个正常列表，通过 UserList 的 data 属性存取。实例内容被初始化为一个 list 的copy，默认为 [] 空列表。 list 可以是迭代对象，比如一个Python列表，或者一个 UserList 对象。

UserList 提供了以下属性作为可变序列的方法和操作的扩展:

子类化的要求:UserList 的子类需要提供一个构造器，可以无参数调用，或者一个参数调用。返回一个新序列的列表操作需要创建一个实现类的实例。它假定了构造器可以以一个参数进行调用，这个参数是一个序列对象，作为数据源。

如果一个分离的类不希望依照这个需求，所有的特殊方法就必须重写；请参照源代码进行修改。

UserString 对象

UserString 类是用作字符串对象的外包装。对这个类的需求已部分由直接创建 str 的子类的功能所替代；不过，这个类处理起来更容易，因为底层的字符串可以作为属性来访问。

  • class collections.UserString(seq)
  • 模拟一个字符串对象。这个实例对象的内容保存为一个正常字符串，通过 UserString 的 data 属性存取。实例内容初始化设置为 seq 的copy。seq 参数可以是任何可通过内建 str() 函数转换为字符串的对象。

UserString 提供了以下属性作为字符串方法和操作的额外支持：

  • data
  • 一个真正的 str 对象用来存放 UserString 类的内容。

在 3.5 版更改: 新方法 getnewargs, rmod, casefold, format_map, isprintable, 和 maketrans。