Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 1 | :mod:`collections` --- Container datatypes |
| 2 | ========================================== |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 3 | |
| 4 | .. module:: collections |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 5 | :synopsis: Container datatypes |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 6 | .. moduleauthor:: Raymond Hettinger <python@rcn.com> |
| 7 | .. sectionauthor:: Raymond Hettinger <python@rcn.com> |
| 8 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 9 | .. testsetup:: * |
| 10 | |
| 11 | from collections import * |
| 12 | import itertools |
| 13 | __name__ = '<doctest>' |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 14 | |
Raymond Hettinger | a199368 | 2011-01-27 01:20:32 +0000 | [diff] [blame] | 15 | **Source code:** :source:`Lib/collections.py` and :source:`Lib/_abcoll.py` |
Raymond Hettinger | 1048094 | 2011-01-10 03:26:08 +0000 | [diff] [blame] | 16 | |
Raymond Hettinger | 4f707fd | 2011-01-10 19:54:11 +0000 | [diff] [blame] | 17 | -------------- |
| 18 | |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 19 | This module implements specialized container datatypes providing alternatives to |
| 20 | Python's general purpose built-in containers, :class:`dict`, :class:`list`, |
| 21 | :class:`set`, and :class:`tuple`. |
Christian Heimes | 0bd4e11 | 2008-02-12 22:59:25 +0000 | [diff] [blame] | 22 | |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 23 | ===================== ==================================================================== |
| 24 | :func:`namedtuple` factory function for creating tuple subclasses with named fields |
| 25 | :class:`deque` list-like container with fast appends and pops on either end |
| 26 | :class:`Counter` dict subclass for counting hashable objects |
| 27 | :class:`OrderedDict` dict subclass that remembers the order entries were added |
| 28 | :class:`defaultdict` dict subclass that calls a factory function to supply missing values |
| 29 | :class:`UserDict` wrapper around dictionary objects for easier dict subclassing |
| 30 | :class:`UserList` wrapper around list objects for easier list subclassing |
| 31 | :class:`UserString` wrapper around string objects for easier string subclassing |
| 32 | ===================== ==================================================================== |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 33 | |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 34 | In addition to the concrete container classes, the collections module provides |
Éric Araujo | fa088db | 2011-06-04 18:42:38 +0200 | [diff] [blame] | 35 | :ref:`abstract base classes <collections-abstract-base-classes>` that can be |
| 36 | used to test whether a class provides a particular interface, for example, |
| 37 | whether it is hashable or a mapping. |
Mark Summerfield | 08898b4 | 2007-09-05 08:43:04 +0000 | [diff] [blame] | 38 | |
| 39 | |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 40 | :class:`Counter` objects |
| 41 | ------------------------ |
| 42 | |
| 43 | A counter tool is provided to support convenient and rapid tallies. |
| 44 | For example:: |
| 45 | |
Raymond Hettinger | 1c62dc9 | 2009-02-04 11:41:45 +0000 | [diff] [blame] | 46 | >>> # Tally occurrences of words in a list |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 47 | >>> cnt = Counter() |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 48 | >>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']: |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 49 | ... cnt[word] += 1 |
| 50 | >>> cnt |
| 51 | Counter({'blue': 3, 'red': 2, 'green': 1}) |
| 52 | |
Raymond Hettinger | 1c62dc9 | 2009-02-04 11:41:45 +0000 | [diff] [blame] | 53 | >>> # Find the ten most common words in Hamlet |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 54 | >>> import re |
| 55 | >>> words = re.findall('\w+', open('hamlet.txt').read().lower()) |
Raymond Hettinger | 0bae662 | 2009-01-20 13:00:59 +0000 | [diff] [blame] | 56 | >>> Counter(words).most_common(10) |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 57 | [('the', 1143), ('and', 966), ('to', 762), ('of', 669), ('i', 631), |
| 58 | ('you', 554), ('a', 546), ('my', 514), ('hamlet', 471), ('in', 451)] |
| 59 | |
| 60 | .. class:: Counter([iterable-or-mapping]) |
| 61 | |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 62 | A :class:`Counter` is a :class:`dict` subclass for counting hashable objects. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 63 | It is an unordered collection where elements are stored as dictionary keys |
| 64 | and their counts are stored as dictionary values. Counts are allowed to be |
| 65 | any integer value including zero or negative counts. The :class:`Counter` |
| 66 | class is similar to bags or multisets in other languages. |
| 67 | |
| 68 | Elements are counted from an *iterable* or initialized from another |
Benjamin Peterson | 25c95f1 | 2009-05-08 20:42:26 +0000 | [diff] [blame] | 69 | *mapping* (or counter): |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 70 | |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 71 | >>> c = Counter() # a new, empty counter |
| 72 | >>> c = Counter('gallahad') # a new counter from an iterable |
| 73 | >>> c = Counter({'red': 4, 'blue': 2}) # a new counter from a mapping |
| 74 | >>> c = Counter(cats=4, dogs=8) # a new counter from keyword args |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 75 | |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 76 | Counter objects have a dictionary interface except that they return a zero |
Benjamin Peterson | 25c95f1 | 2009-05-08 20:42:26 +0000 | [diff] [blame] | 77 | count for missing items instead of raising a :exc:`KeyError`: |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 78 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 79 | >>> c = Counter(['eggs', 'ham']) |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 80 | >>> c['bacon'] # count of a missing element is zero |
| 81 | 0 |
| 82 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 83 | Setting a count to zero does not remove an element from a counter. |
| 84 | Use ``del`` to remove it entirely: |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 85 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 86 | >>> c['sausage'] = 0 # counter entry with a zero count |
| 87 | >>> del c['sausage'] # del actually removes the entry |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 88 | |
Benjamin Peterson | d45bf58 | 2009-03-02 21:44:54 +0000 | [diff] [blame] | 89 | .. versionadded:: 3.1 |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 90 | |
| 91 | |
Ezio Melotti | 0be8b1c | 2010-04-04 06:53:44 +0000 | [diff] [blame] | 92 | Counter objects support three methods beyond those available for all |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 93 | dictionaries: |
| 94 | |
| 95 | .. method:: elements() |
| 96 | |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 97 | Return an iterator over elements repeating each as many times as its |
| 98 | count. Elements are returned in arbitrary order. If an element's count |
| 99 | is less than one, :meth:`elements` will ignore it. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 100 | |
Raymond Hettinger | 0bae662 | 2009-01-20 13:00:59 +0000 | [diff] [blame] | 101 | >>> c = Counter(a=4, b=2, c=0, d=-2) |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 102 | >>> list(c.elements()) |
| 103 | ['a', 'a', 'a', 'a', 'b', 'b'] |
| 104 | |
| 105 | .. method:: most_common([n]) |
| 106 | |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 107 | Return a list of the *n* most common elements and their counts from the |
Raymond Hettinger | d04fa31 | 2009-02-04 19:45:13 +0000 | [diff] [blame] | 108 | most common to the least. If *n* is not specified, :func:`most_common` |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 109 | returns *all* elements in the counter. Elements with equal counts are |
Benjamin Peterson | 25c95f1 | 2009-05-08 20:42:26 +0000 | [diff] [blame] | 110 | ordered arbitrarily: |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 111 | |
| 112 | >>> Counter('abracadabra').most_common(3) |
| 113 | [('a', 5), ('r', 2), ('b', 2)] |
| 114 | |
Raymond Hettinger | 9c01e44 | 2010-04-03 10:32:58 +0000 | [diff] [blame] | 115 | .. method:: subtract([iterable-or-mapping]) |
| 116 | |
| 117 | Elements are subtracted from an *iterable* or from another *mapping* |
| 118 | (or counter). Like :meth:`dict.update` but subtracts counts instead |
| 119 | of replacing them. Both inputs and outputs may be zero or negative. |
| 120 | |
| 121 | >>> c = Counter(a=4, b=2, c=0, d=-2) |
| 122 | >>> d = Counter(a=1, b=2, c=3, d=4) |
| 123 | >>> c.subtract(d) |
| 124 | Counter({'a': 3, 'b': 0, 'c': -3, 'd': -6}) |
| 125 | |
Ezio Melotti | 0be8b1c | 2010-04-04 06:53:44 +0000 | [diff] [blame] | 126 | .. versionadded:: 3.2 |
| 127 | |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 128 | The usual dictionary methods are available for :class:`Counter` objects |
| 129 | except for two which work differently for counters. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 130 | |
| 131 | .. method:: fromkeys(iterable) |
| 132 | |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 133 | This class method is not implemented for :class:`Counter` objects. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 134 | |
| 135 | .. method:: update([iterable-or-mapping]) |
| 136 | |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 137 | Elements are counted from an *iterable* or added-in from another |
| 138 | *mapping* (or counter). Like :meth:`dict.update` but adds counts |
| 139 | instead of replacing them. Also, the *iterable* is expected to be a |
| 140 | sequence of elements, not a sequence of ``(key, value)`` pairs. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 141 | |
| 142 | Common patterns for working with :class:`Counter` objects:: |
| 143 | |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 144 | sum(c.values()) # total of all counts |
| 145 | c.clear() # reset all counts |
| 146 | list(c) # list unique elements |
| 147 | set(c) # convert to a set |
| 148 | dict(c) # convert to a regular dictionary |
| 149 | c.items() # convert to a list of (elem, cnt) pairs |
| 150 | Counter(dict(list_of_pairs)) # convert from a list of (elem, cnt) pairs |
| 151 | c.most_common()[:-n:-1] # n least common elements |
| 152 | c += Counter() # remove zero and negative counts |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 153 | |
Raymond Hettinger | 72a95cc | 2009-02-25 22:51:40 +0000 | [diff] [blame] | 154 | Several mathematical operations are provided for combining :class:`Counter` |
| 155 | objects to produce multisets (counters that have counts greater than zero). |
| 156 | Addition and subtraction combine counters by adding or subtracting the counts |
| 157 | of corresponding elements. Intersection and union return the minimum and |
| 158 | maximum of corresponding counts. Each operation can accept inputs with signed |
| 159 | counts, but the output will exclude results with counts of zero or less. |
Raymond Hettinger | 4d2073a | 2009-01-20 03:41:22 +0000 | [diff] [blame] | 160 | |
Raymond Hettinger | e0d1b9f | 2009-01-21 20:36:27 +0000 | [diff] [blame] | 161 | >>> c = Counter(a=3, b=1) |
| 162 | >>> d = Counter(a=1, b=2) |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 163 | >>> c + d # add two counters together: c[x] + d[x] |
Raymond Hettinger | 4d2073a | 2009-01-20 03:41:22 +0000 | [diff] [blame] | 164 | Counter({'a': 4, 'b': 3}) |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 165 | >>> c - d # subtract (keeping only positive counts) |
Raymond Hettinger | 4d2073a | 2009-01-20 03:41:22 +0000 | [diff] [blame] | 166 | Counter({'a': 2}) |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 167 | >>> c & d # intersection: min(c[x], d[x]) |
Raymond Hettinger | 4d2073a | 2009-01-20 03:41:22 +0000 | [diff] [blame] | 168 | Counter({'a': 1, 'b': 1}) |
Raymond Hettinger | 73662a5 | 2009-01-27 02:38:22 +0000 | [diff] [blame] | 169 | >>> c | d # union: max(c[x], d[x]) |
Raymond Hettinger | 4d2073a | 2009-01-20 03:41:22 +0000 | [diff] [blame] | 170 | Counter({'a': 3, 'b': 2}) |
| 171 | |
Raymond Hettinger | 22f1885 | 2010-04-12 21:45:14 +0000 | [diff] [blame] | 172 | .. note:: |
| 173 | |
| 174 | Counters were primarily designed to work with positive integers to represent |
| 175 | running counts; however, care was taken to not unnecessarily preclude use |
| 176 | cases needing other types or negative values. To help with those use cases, |
| 177 | this section documents the minimum range and type restrictions. |
| 178 | |
| 179 | * The :class:`Counter` class itself is a dictionary subclass with no |
| 180 | restrictions on its keys and values. The values are intended to be numbers |
| 181 | representing counts, but you *could* store anything in the value field. |
| 182 | |
| 183 | * The :meth:`most_common` method requires only that the values be orderable. |
| 184 | |
| 185 | * For in-place operations such as ``c[key] += 1``, the value type need only |
| 186 | support addition and subtraction. So fractions, floats, and decimals would |
| 187 | work and negative values are supported. The same is also true for |
| 188 | :meth:`update` and :meth:`subtract` which allow negative and zero values |
| 189 | for both inputs and outputs. |
| 190 | |
| 191 | * The multiset methods are designed only for use cases with positive values. |
| 192 | The inputs may be negative or zero, but only outputs with positive values |
| 193 | are created. There are no type restrictions, but the value type needs to |
Ezio Melotti | e130a52 | 2011-10-19 10:58:56 +0300 | [diff] [blame] | 194 | support addition, subtraction, and comparison. |
Raymond Hettinger | 22f1885 | 2010-04-12 21:45:14 +0000 | [diff] [blame] | 195 | |
| 196 | * The :meth:`elements` method requires integer counts. It ignores zero and |
| 197 | negative counts. |
| 198 | |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 199 | .. seealso:: |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 200 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 201 | * `Counter class <http://code.activestate.com/recipes/576611/>`_ |
| 202 | adapted for Python 2.5 and an early `Bag recipe |
| 203 | <http://code.activestate.com/recipes/259174/>`_ for Python 2.4. |
| 204 | |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 205 | * `Bag class <http://www.gnu.org/software/smalltalk/manual-base/html_node/Bag.html>`_ |
| 206 | in Smalltalk. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 207 | |
Éric Araujo | 08c9bd5 | 2011-04-24 02:59:02 +0200 | [diff] [blame] | 208 | * Wikipedia entry for `Multisets <http://en.wikipedia.org/wiki/Multiset>`_. |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 209 | |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 210 | * `C++ multisets <http://www.demo2s.com/Tutorial/Cpp/0380__set-multiset/Catalog0380__set-multiset.htm>`_ |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 211 | tutorial with examples. |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 212 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 213 | * For mathematical operations on multisets and their use cases, see |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 214 | *Knuth, Donald. The Art of Computer Programming Volume II, |
Éric Araujo | 08c9bd5 | 2011-04-24 02:59:02 +0200 | [diff] [blame] | 215 | Section 4.6.3, Exercise 19*. |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 216 | |
Raymond Hettinger | 670eaec | 2009-01-21 23:14:07 +0000 | [diff] [blame] | 217 | * To enumerate all distinct multisets of a given size over a given set of |
Raymond Hettinger | d07d939 | 2009-01-27 04:20:44 +0000 | [diff] [blame] | 218 | elements, see :func:`itertools.combinations_with_replacement`. |
Raymond Hettinger | b14043c | 2009-01-20 23:44:31 +0000 | [diff] [blame] | 219 | |
Raymond Hettinger | 94adc8e | 2009-01-22 05:27:37 +0000 | [diff] [blame] | 220 | map(Counter, combinations_with_replacement('ABC', 2)) --> AA AB AC BB BC CC |
Raymond Hettinger | b8baf63 | 2009-01-14 02:20:07 +0000 | [diff] [blame] | 221 | |
| 222 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 223 | :class:`deque` objects |
| 224 | ---------------------- |
| 225 | |
Georg Brandl | c2a4f4f | 2009-04-10 09:03:43 +0000 | [diff] [blame] | 226 | .. class:: deque([iterable, [maxlen]]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 227 | |
| 228 | Returns a new deque object initialized left-to-right (using :meth:`append`) with |
| 229 | data from *iterable*. If *iterable* is not specified, the new deque is empty. |
| 230 | |
| 231 | Deques are a generalization of stacks and queues (the name is pronounced "deck" |
| 232 | and is short for "double-ended queue"). Deques support thread-safe, memory |
| 233 | efficient appends and pops from either side of the deque with approximately the |
| 234 | same O(1) performance in either direction. |
| 235 | |
| 236 | Though :class:`list` objects support similar operations, they are optimized for |
| 237 | fast fixed-length operations and incur O(n) memory movement costs for |
| 238 | ``pop(0)`` and ``insert(0, v)`` operations which change both the size and |
| 239 | position of the underlying data representation. |
| 240 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 241 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 242 | If *maxlen* is not specified or is *None*, deques may grow to an |
| 243 | arbitrary length. Otherwise, the deque is bounded to the specified maximum |
| 244 | length. Once a bounded length deque is full, when new items are added, a |
| 245 | corresponding number of items are discarded from the opposite end. Bounded |
| 246 | length deques provide functionality similar to the ``tail`` filter in |
| 247 | Unix. They are also useful for tracking transactions and other pools of data |
| 248 | where only the most recent activity is of interest. |
| 249 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 250 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 251 | Deque objects support the following methods: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 252 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 253 | .. method:: append(x) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 254 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 255 | Add *x* to the right side of the deque. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 256 | |
| 257 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 258 | .. method:: appendleft(x) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 259 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 260 | Add *x* to the left side of the deque. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 261 | |
| 262 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 263 | .. method:: clear() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 264 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 265 | Remove all elements from the deque leaving it with length 0. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 266 | |
| 267 | |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 268 | .. method:: count(x) |
| 269 | |
| 270 | Count the number of deque elements equal to *x*. |
| 271 | |
| 272 | .. versionadded:: 3.2 |
| 273 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 274 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 275 | .. method:: extend(iterable) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 276 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 277 | Extend the right side of the deque by appending elements from the iterable |
| 278 | argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 279 | |
| 280 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 281 | .. method:: extendleft(iterable) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 282 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 283 | Extend the left side of the deque by appending elements from *iterable*. |
| 284 | Note, the series of left appends results in reversing the order of |
| 285 | elements in the iterable argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 286 | |
| 287 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 288 | .. method:: pop() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 289 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 290 | Remove and return an element from the right side of the deque. If no |
| 291 | elements are present, raises an :exc:`IndexError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 292 | |
| 293 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 294 | .. method:: popleft() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 295 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 296 | Remove and return an element from the left side of the deque. If no |
| 297 | elements are present, raises an :exc:`IndexError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 298 | |
| 299 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 300 | .. method:: remove(value) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 301 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 302 | Removed the first occurrence of *value*. If not found, raises a |
| 303 | :exc:`ValueError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 304 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 305 | |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 306 | .. method:: reverse() |
| 307 | |
| 308 | Reverse the elements of the deque in-place and then return ``None``. |
| 309 | |
| 310 | .. versionadded:: 3.2 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 311 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 312 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 313 | .. method:: rotate(n) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 314 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 315 | Rotate the deque *n* steps to the right. If *n* is negative, rotate to |
| 316 | the left. Rotating one step to the right is equivalent to: |
| 317 | ``d.appendleft(d.pop())``. |
| 318 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 319 | |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 320 | Deque objects also provide one read-only attribute: |
| 321 | |
| 322 | .. attribute:: maxlen |
| 323 | |
| 324 | Maximum size of a deque or *None* if unbounded. |
| 325 | |
Raymond Hettinger | 150fb9c | 2009-03-10 22:48:06 +0000 | [diff] [blame] | 326 | .. versionadded:: 3.1 |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 327 | |
| 328 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 329 | In addition to the above, deques support iteration, pickling, ``len(d)``, |
| 330 | ``reversed(d)``, ``copy.copy(d)``, ``copy.deepcopy(d)``, membership testing with |
Benjamin Peterson | 206e307 | 2008-10-19 14:07:49 +0000 | [diff] [blame] | 331 | the :keyword:`in` operator, and subscript references such as ``d[-1]``. Indexed |
| 332 | access is O(1) at both ends but slows to O(n) in the middle. For fast random |
| 333 | access, use lists instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 334 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 335 | Example: |
| 336 | |
| 337 | .. doctest:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 338 | |
| 339 | >>> from collections import deque |
| 340 | >>> d = deque('ghi') # make a new deque with three items |
| 341 | >>> for elem in d: # iterate over the deque's elements |
Neal Norwitz | 752abd0 | 2008-05-13 04:55:24 +0000 | [diff] [blame] | 342 | ... print(elem.upper()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 343 | G |
| 344 | H |
| 345 | I |
| 346 | |
| 347 | >>> d.append('j') # add a new entry to the right side |
| 348 | >>> d.appendleft('f') # add a new entry to the left side |
| 349 | >>> d # show the representation of the deque |
| 350 | deque(['f', 'g', 'h', 'i', 'j']) |
| 351 | |
| 352 | >>> d.pop() # return and remove the rightmost item |
| 353 | 'j' |
| 354 | >>> d.popleft() # return and remove the leftmost item |
| 355 | 'f' |
| 356 | >>> list(d) # list the contents of the deque |
| 357 | ['g', 'h', 'i'] |
| 358 | >>> d[0] # peek at leftmost item |
| 359 | 'g' |
| 360 | >>> d[-1] # peek at rightmost item |
| 361 | 'i' |
| 362 | |
| 363 | >>> list(reversed(d)) # list the contents of a deque in reverse |
| 364 | ['i', 'h', 'g'] |
| 365 | >>> 'h' in d # search the deque |
| 366 | True |
| 367 | >>> d.extend('jkl') # add multiple elements at once |
| 368 | >>> d |
| 369 | deque(['g', 'h', 'i', 'j', 'k', 'l']) |
| 370 | >>> d.rotate(1) # right rotation |
| 371 | >>> d |
| 372 | deque(['l', 'g', 'h', 'i', 'j', 'k']) |
| 373 | >>> d.rotate(-1) # left rotation |
| 374 | >>> d |
| 375 | deque(['g', 'h', 'i', 'j', 'k', 'l']) |
| 376 | |
| 377 | >>> deque(reversed(d)) # make a new deque in reverse order |
| 378 | deque(['l', 'k', 'j', 'i', 'h', 'g']) |
| 379 | >>> d.clear() # empty the deque |
| 380 | >>> d.pop() # cannot pop from an empty deque |
| 381 | Traceback (most recent call last): |
| 382 | File "<pyshell#6>", line 1, in -toplevel- |
| 383 | d.pop() |
| 384 | IndexError: pop from an empty deque |
| 385 | |
| 386 | >>> d.extendleft('abc') # extendleft() reverses the input order |
| 387 | >>> d |
| 388 | deque(['c', 'b', 'a']) |
| 389 | |
| 390 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 391 | :class:`deque` Recipes |
| 392 | ^^^^^^^^^^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 393 | |
| 394 | This section shows various approaches to working with deques. |
| 395 | |
Raymond Hettinger | d2ee64d | 2009-03-31 22:52:48 +0000 | [diff] [blame] | 396 | Bounded length deques provide functionality similar to the ``tail`` filter |
| 397 | in Unix:: |
| 398 | |
| 399 | def tail(filename, n=10): |
| 400 | 'Return the last n lines of a file' |
| 401 | return deque(open(filename), n) |
| 402 | |
| 403 | Another approach to using deques is to maintain a sequence of recently |
| 404 | added elements by appending to the right and popping to the left:: |
| 405 | |
| 406 | def moving_average(iterable, n=3): |
| 407 | # moving_average([40, 30, 50, 46, 39, 44]) --> 40.0 42.0 45.0 43.0 |
| 408 | # http://en.wikipedia.org/wiki/Moving_average |
| 409 | it = iter(iterable) |
Raymond Hettinger | d40285a | 2009-05-22 01:11:26 +0000 | [diff] [blame] | 410 | d = deque(itertools.islice(it, n-1)) |
| 411 | d.appendleft(0) |
Raymond Hettinger | d2ee64d | 2009-03-31 22:52:48 +0000 | [diff] [blame] | 412 | s = sum(d) |
Raymond Hettinger | d2ee64d | 2009-03-31 22:52:48 +0000 | [diff] [blame] | 413 | for elem in it: |
| 414 | s += elem - d.popleft() |
| 415 | d.append(elem) |
| 416 | yield s / n |
| 417 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 418 | The :meth:`rotate` method provides a way to implement :class:`deque` slicing and |
Ezio Melotti | 0639d5a | 2009-12-19 23:26:38 +0000 | [diff] [blame] | 419 | deletion. For example, a pure Python implementation of ``del d[n]`` relies on |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 420 | the :meth:`rotate` method to position elements to be popped:: |
| 421 | |
| 422 | def delete_nth(d, n): |
| 423 | d.rotate(-n) |
| 424 | d.popleft() |
| 425 | d.rotate(n) |
| 426 | |
| 427 | To implement :class:`deque` slicing, use a similar approach applying |
| 428 | :meth:`rotate` to bring a target element to the left side of the deque. Remove |
| 429 | old entries with :meth:`popleft`, add new entries with :meth:`extend`, and then |
| 430 | reverse the rotation. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 431 | With minor variations on that approach, it is easy to implement Forth style |
| 432 | stack manipulations such as ``dup``, ``drop``, ``swap``, ``over``, ``pick``, |
| 433 | ``rot``, and ``roll``. |
| 434 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 435 | |
| 436 | :class:`defaultdict` objects |
| 437 | ---------------------------- |
| 438 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 439 | .. class:: defaultdict([default_factory[, ...]]) |
| 440 | |
| 441 | Returns a new dictionary-like object. :class:`defaultdict` is a subclass of the |
Georg Brandl | 22b3431 | 2009-07-26 14:54:51 +0000 | [diff] [blame] | 442 | built-in :class:`dict` class. It overrides one method and adds one writable |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 443 | instance variable. The remaining functionality is the same as for the |
| 444 | :class:`dict` class and is not documented here. |
| 445 | |
| 446 | The first argument provides the initial value for the :attr:`default_factory` |
| 447 | attribute; it defaults to ``None``. All remaining arguments are treated the same |
| 448 | as if they were passed to the :class:`dict` constructor, including keyword |
| 449 | arguments. |
| 450 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 451 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 452 | :class:`defaultdict` objects support the following method in addition to the |
| 453 | standard :class:`dict` operations: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 454 | |
Benjamin Peterson | d319ad5 | 2010-07-18 14:27:02 +0000 | [diff] [blame] | 455 | .. method:: __missing__(key) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 456 | |
Benjamin Peterson | 5478b47 | 2008-09-17 22:25:09 +0000 | [diff] [blame] | 457 | If the :attr:`default_factory` attribute is ``None``, this raises a |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 458 | :exc:`KeyError` exception with the *key* as argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 459 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 460 | If :attr:`default_factory` is not ``None``, it is called without arguments |
| 461 | to provide a default value for the given *key*, this value is inserted in |
| 462 | the dictionary for the *key*, and returned. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 463 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 464 | If calling :attr:`default_factory` raises an exception this exception is |
| 465 | propagated unchanged. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 466 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 467 | This method is called by the :meth:`__getitem__` method of the |
| 468 | :class:`dict` class when the requested key is not found; whatever it |
| 469 | returns or raises is then returned or raised by :meth:`__getitem__`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 470 | |
Benjamin Peterson | 871b9d1 | 2012-01-27 09:14:01 -0500 | [diff] [blame] | 471 | Note that :meth:`__missing__` is *not* called for any operations besides |
| 472 | :meth:`__getitem__`. This means that :meth:`get` will, like normal |
| 473 | dictionaries, return ``None`` as a default rather than using |
| 474 | :attr:`default_factory`. |
| 475 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 476 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 477 | :class:`defaultdict` objects support the following instance variable: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 478 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 479 | |
Benjamin Peterson | d319ad5 | 2010-07-18 14:27:02 +0000 | [diff] [blame] | 480 | .. attribute:: default_factory |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 481 | |
| 482 | This attribute is used by the :meth:`__missing__` method; it is |
| 483 | initialized from the first argument to the constructor, if present, or to |
| 484 | ``None``, if absent. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 485 | |
| 486 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 487 | :class:`defaultdict` Examples |
| 488 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 489 | |
| 490 | Using :class:`list` as the :attr:`default_factory`, it is easy to group a |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 491 | sequence of key-value pairs into a dictionary of lists: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 492 | |
| 493 | >>> s = [('yellow', 1), ('blue', 2), ('yellow', 3), ('blue', 4), ('red', 1)] |
| 494 | >>> d = defaultdict(list) |
| 495 | >>> for k, v in s: |
| 496 | ... d[k].append(v) |
| 497 | ... |
Ezio Melotti | c53a894 | 2009-09-12 01:52:05 +0000 | [diff] [blame] | 498 | >>> list(d.items()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 499 | [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])] |
| 500 | |
| 501 | When each key is encountered for the first time, it is not already in the |
| 502 | mapping; so an entry is automatically created using the :attr:`default_factory` |
| 503 | function which returns an empty :class:`list`. The :meth:`list.append` |
| 504 | operation then attaches the value to the new list. When keys are encountered |
| 505 | again, the look-up proceeds normally (returning the list for that key) and the |
| 506 | :meth:`list.append` operation adds another value to the list. This technique is |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 507 | simpler and faster than an equivalent technique using :meth:`dict.setdefault`: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 508 | |
| 509 | >>> d = {} |
| 510 | >>> for k, v in s: |
| 511 | ... d.setdefault(k, []).append(v) |
| 512 | ... |
Ezio Melotti | c53a894 | 2009-09-12 01:52:05 +0000 | [diff] [blame] | 513 | >>> list(d.items()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 514 | [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])] |
| 515 | |
| 516 | Setting the :attr:`default_factory` to :class:`int` makes the |
| 517 | :class:`defaultdict` useful for counting (like a bag or multiset in other |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 518 | languages): |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 519 | |
| 520 | >>> s = 'mississippi' |
| 521 | >>> d = defaultdict(int) |
| 522 | >>> for k in s: |
| 523 | ... d[k] += 1 |
| 524 | ... |
Ezio Melotti | c53a894 | 2009-09-12 01:52:05 +0000 | [diff] [blame] | 525 | >>> list(d.items()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 526 | [('i', 4), ('p', 2), ('s', 4), ('m', 1)] |
| 527 | |
| 528 | When a letter is first encountered, it is missing from the mapping, so the |
| 529 | :attr:`default_factory` function calls :func:`int` to supply a default count of |
| 530 | zero. The increment operation then builds up the count for each letter. |
| 531 | |
| 532 | The function :func:`int` which always returns zero is just a special case of |
| 533 | constant functions. A faster and more flexible way to create constant functions |
| 534 | is to use a lambda function which can supply any constant value (not just |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 535 | zero): |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 536 | |
| 537 | >>> def constant_factory(value): |
| 538 | ... return lambda: value |
| 539 | >>> d = defaultdict(constant_factory('<missing>')) |
| 540 | >>> d.update(name='John', action='ran') |
| 541 | >>> '%(name)s %(action)s to %(object)s' % d |
| 542 | 'John ran to <missing>' |
| 543 | |
| 544 | Setting the :attr:`default_factory` to :class:`set` makes the |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 545 | :class:`defaultdict` useful for building a dictionary of sets: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 546 | |
| 547 | >>> s = [('red', 1), ('blue', 2), ('red', 3), ('blue', 4), ('red', 1), ('blue', 4)] |
| 548 | >>> d = defaultdict(set) |
| 549 | >>> for k, v in s: |
| 550 | ... d[k].add(v) |
| 551 | ... |
Ezio Melotti | c53a894 | 2009-09-12 01:52:05 +0000 | [diff] [blame] | 552 | >>> list(d.items()) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 553 | [('blue', set([2, 4])), ('red', set([1, 3]))] |
| 554 | |
| 555 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 556 | :func:`namedtuple` Factory Function for Tuples with Named Fields |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 557 | ---------------------------------------------------------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 558 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 559 | Named tuples assign meaning to each position in a tuple and allow for more readable, |
| 560 | self-documenting code. They can be used wherever regular tuples are used, and |
| 561 | they add the ability to access fields by name instead of position index. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 562 | |
Georg Brandl | c2a4f4f | 2009-04-10 09:03:43 +0000 | [diff] [blame] | 563 | .. function:: namedtuple(typename, field_names, verbose=False, rename=False) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 564 | |
| 565 | Returns a new tuple subclass named *typename*. The new subclass is used to |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 566 | create tuple-like objects that have fields accessible by attribute lookup as |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 567 | well as being indexable and iterable. Instances of the subclass also have a |
Benjamin Peterson | 4469d0c | 2008-11-30 22:46:23 +0000 | [diff] [blame] | 568 | helpful docstring (with typename and field_names) and a helpful :meth:`__repr__` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 569 | method which lists the tuple contents in a ``name=value`` format. |
| 570 | |
Benjamin Peterson | 4469d0c | 2008-11-30 22:46:23 +0000 | [diff] [blame] | 571 | The *field_names* are a single string with each fieldname separated by whitespace |
| 572 | and/or commas, for example ``'x y'`` or ``'x, y'``. Alternatively, *field_names* |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 573 | can be a sequence of strings such as ``['x', 'y']``. |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 574 | |
| 575 | Any valid Python identifier may be used for a fieldname except for names |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 576 | starting with an underscore. Valid identifiers consist of letters, digits, |
| 577 | and underscores but do not start with a digit or underscore and cannot be |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 578 | a :mod:`keyword` such as *class*, *for*, *return*, *global*, *pass*, |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 579 | or *raise*. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 580 | |
Benjamin Peterson | a86f2c0 | 2009-02-10 02:41:10 +0000 | [diff] [blame] | 581 | If *rename* is true, invalid fieldnames are automatically replaced |
| 582 | with positional names. For example, ``['abc', 'def', 'ghi', 'abc']`` is |
Raymond Hettinger | 85737b8 | 2009-04-02 22:37:59 +0000 | [diff] [blame] | 583 | converted to ``['abc', '_1', 'ghi', '_3']``, eliminating the keyword |
Benjamin Peterson | a86f2c0 | 2009-02-10 02:41:10 +0000 | [diff] [blame] | 584 | ``def`` and the duplicate fieldname ``abc``. |
| 585 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 586 | If *verbose* is true, the class definition is printed just before being built. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 587 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 588 | Named tuple instances do not have per-instance dictionaries, so they are |
Thomas Wouters | 8ce81f7 | 2007-09-20 18:22:40 +0000 | [diff] [blame] | 589 | lightweight and require no more memory than regular tuples. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 590 | |
Raymond Hettinger | b62ad24 | 2009-03-02 22:16:43 +0000 | [diff] [blame] | 591 | .. versionchanged:: 3.1 |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 592 | Added support for *rename*. |
Benjamin Peterson | a86f2c0 | 2009-02-10 02:41:10 +0000 | [diff] [blame] | 593 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 594 | |
| 595 | .. doctest:: |
| 596 | :options: +NORMALIZE_WHITESPACE |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 597 | |
Raymond Hettinger | 0ef956f | 2010-11-21 23:23:29 +0000 | [diff] [blame] | 598 | >>> # Basic example |
Raymond Hettinger | 15aded8 | 2011-03-15 17:25:51 -0700 | [diff] [blame] | 599 | >>> Point = namedtuple('Point', ['x', 'y']) |
Raymond Hettinger | 0ef956f | 2010-11-21 23:23:29 +0000 | [diff] [blame] | 600 | >>> p = Point(x=10, y=11) |
| 601 | |
| 602 | >>> # Example using the verbose option to print the class definition |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 603 | >>> Point = namedtuple('Point', 'x y', verbose=True) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 604 | class Point(tuple): |
| 605 | 'Point(x, y)' |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 606 | <BLANKLINE> |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 607 | __slots__ = () |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 608 | <BLANKLINE> |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 609 | _fields = ('x', 'y') |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 610 | <BLANKLINE> |
Raymond Hettinger | 089ba7f | 2009-05-27 00:38:24 +0000 | [diff] [blame] | 611 | def __new__(_cls, x, y): |
Raymond Hettinger | 7b0d3c6 | 2010-04-02 18:54:02 +0000 | [diff] [blame] | 612 | 'Create a new instance of Point(x, y)' |
Raymond Hettinger | 089ba7f | 2009-05-27 00:38:24 +0000 | [diff] [blame] | 613 | return _tuple.__new__(_cls, (x, y)) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 614 | <BLANKLINE> |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 615 | @classmethod |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 616 | def _make(cls, iterable, new=tuple.__new__, len=len): |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 617 | 'Make a new Point object from a sequence or iterable' |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 618 | result = new(cls, iterable) |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 619 | if len(result) != 2: |
| 620 | raise TypeError('Expected 2 arguments, got %d' % len(result)) |
| 621 | return result |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 622 | <BLANKLINE> |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 623 | def __repr__(self): |
Raymond Hettinger | 7b0d3c6 | 2010-04-02 18:54:02 +0000 | [diff] [blame] | 624 | 'Return a nicely formatted representation string' |
Raymond Hettinger | d331ce9 | 2010-08-08 01:13:42 +0000 | [diff] [blame] | 625 | return self.__class__.__name__ + '(x=%r, y=%r)' % self |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 626 | <BLANKLINE> |
Raymond Hettinger | a4f52b1 | 2009-03-02 22:28:31 +0000 | [diff] [blame] | 627 | def _asdict(self): |
| 628 | 'Return a new OrderedDict which maps field names to their values' |
| 629 | return OrderedDict(zip(self._fields, self)) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 630 | <BLANKLINE> |
Raymond Hettinger | 3d89057 | 2011-06-02 23:40:24 -0700 | [diff] [blame] | 631 | __dict__ = property(_asdict) |
| 632 | <BLANKLINE> |
Raymond Hettinger | 089ba7f | 2009-05-27 00:38:24 +0000 | [diff] [blame] | 633 | def _replace(_self, **kwds): |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 634 | 'Return a new Point object replacing specified fields with new values' |
Raymond Hettinger | 089ba7f | 2009-05-27 00:38:24 +0000 | [diff] [blame] | 635 | result = _self._make(map(kwds.pop, ('x', 'y'), _self)) |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 636 | if kwds: |
Ezio Melotti | 8f7649e | 2009-09-13 04:48:45 +0000 | [diff] [blame] | 637 | raise ValueError('Got unexpected field names: %r' % list(kwds.keys())) |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 638 | return result |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 639 | <BLANKLINE> |
| 640 | def __getnewargs__(self): |
Raymond Hettinger | 7b0d3c6 | 2010-04-02 18:54:02 +0000 | [diff] [blame] | 641 | 'Return self as a plain tuple. Used by copy and pickle.' |
Benjamin Peterson | 4118174 | 2008-07-02 20:22:54 +0000 | [diff] [blame] | 642 | return tuple(self) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 643 | <BLANKLINE> |
Raymond Hettinger | 7b0d3c6 | 2010-04-02 18:54:02 +0000 | [diff] [blame] | 644 | x = _property(_itemgetter(0), doc='Alias for field number 0') |
| 645 | y = _property(_itemgetter(1), doc='Alias for field number 1') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 646 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 647 | >>> p = Point(11, y=22) # instantiate with positional or keyword arguments |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 648 | >>> p[0] + p[1] # indexable like the plain tuple (11, 22) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 649 | 33 |
| 650 | >>> x, y = p # unpack like a regular tuple |
| 651 | >>> x, y |
| 652 | (11, 22) |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 653 | >>> p.x + p.y # fields also accessible by name |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 654 | 33 |
| 655 | >>> p # readable __repr__ with a name=value style |
| 656 | Point(x=11, y=22) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 657 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 658 | Named tuples are especially useful for assigning field names to result tuples returned |
| 659 | by the :mod:`csv` or :mod:`sqlite3` modules:: |
| 660 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 661 | EmployeeRecord = namedtuple('EmployeeRecord', 'name, age, title, department, paygrade') |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 662 | |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 663 | import csv |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 664 | for emp in map(EmployeeRecord._make, csv.reader(open("employees.csv", "rb"))): |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 665 | print(emp.name, emp.title) |
| 666 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 667 | import sqlite3 |
| 668 | conn = sqlite3.connect('/companydata') |
| 669 | cursor = conn.cursor() |
| 670 | cursor.execute('SELECT name, age, title, department, paygrade FROM employees') |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 671 | for emp in map(EmployeeRecord._make, cursor.fetchall()): |
Christian Heimes | 0041223 | 2008-01-10 16:02:19 +0000 | [diff] [blame] | 672 | print(emp.name, emp.title) |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 673 | |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 674 | In addition to the methods inherited from tuples, named tuples support |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 675 | three additional methods and one attribute. To prevent conflicts with |
| 676 | field names, the method and attribute names start with an underscore. |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 677 | |
Benjamin Peterson | 0b9fb80 | 2010-07-18 14:23:36 +0000 | [diff] [blame] | 678 | .. classmethod:: somenamedtuple._make(iterable) |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 679 | |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 680 | Class method that makes a new instance from an existing sequence or iterable. |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 681 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 682 | .. doctest:: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 683 | |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 684 | >>> t = [11, 22] |
| 685 | >>> Point._make(t) |
| 686 | Point(x=11, y=22) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 687 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 688 | .. method:: somenamedtuple._asdict() |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 689 | |
Raymond Hettinger | a4f52b1 | 2009-03-02 22:28:31 +0000 | [diff] [blame] | 690 | Return a new :class:`OrderedDict` which maps field names to their corresponding |
| 691 | values:: |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 692 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 693 | >>> p._asdict() |
Raymond Hettinger | a4f52b1 | 2009-03-02 22:28:31 +0000 | [diff] [blame] | 694 | OrderedDict([('x', 11), ('y', 22)]) |
| 695 | |
Raymond Hettinger | a88e4da | 2009-03-03 05:12:27 +0000 | [diff] [blame] | 696 | .. versionchanged:: 3.1 |
Raymond Hettinger | a4f52b1 | 2009-03-02 22:28:31 +0000 | [diff] [blame] | 697 | Returns an :class:`OrderedDict` instead of a regular :class:`dict`. |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 698 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 699 | .. method:: somenamedtuple._replace(kwargs) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 700 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 701 | Return a new instance of the named tuple replacing specified fields with new |
| 702 | values: |
Thomas Wouters | 8ce81f7 | 2007-09-20 18:22:40 +0000 | [diff] [blame] | 703 | |
| 704 | :: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 705 | |
| 706 | >>> p = Point(x=11, y=22) |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 707 | >>> p._replace(x=33) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 708 | Point(x=33, y=22) |
| 709 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 710 | >>> for partnum, record in inventory.items(): |
Christian Heimes | 454f37b | 2008-01-10 00:10:02 +0000 | [diff] [blame] | 711 | ... inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now()) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 712 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 713 | .. attribute:: somenamedtuple._fields |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 714 | |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 715 | Tuple of strings listing the field names. Useful for introspection |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 716 | and for creating new named tuple types from existing named tuples. |
Thomas Wouters | 8ce81f7 | 2007-09-20 18:22:40 +0000 | [diff] [blame] | 717 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 718 | .. doctest:: |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 719 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 720 | >>> p._fields # view the field names |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 721 | ('x', 'y') |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 722 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 723 | >>> Color = namedtuple('Color', 'red green blue') |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 724 | >>> Pixel = namedtuple('Pixel', Point._fields + Color._fields) |
Thomas Wouters | 1b7f891 | 2007-09-19 03:06:30 +0000 | [diff] [blame] | 725 | >>> Pixel(11, 22, 128, 255, 0) |
Christian Heimes | 454f37b | 2008-01-10 00:10:02 +0000 | [diff] [blame] | 726 | Pixel(x=11, y=22, red=128, green=255, blue=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 727 | |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 728 | To retrieve a field whose name is stored in a string, use the :func:`getattr` |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 729 | function: |
Christian Heimes | 0449f63 | 2007-12-15 01:27:15 +0000 | [diff] [blame] | 730 | |
| 731 | >>> getattr(p, 'x') |
| 732 | 11 |
| 733 | |
Raymond Hettinger | 651453a | 2009-02-11 00:20:02 +0000 | [diff] [blame] | 734 | To convert a dictionary to a named tuple, use the double-star-operator |
| 735 | (as described in :ref:`tut-unpacking-arguments`): |
Christian Heimes | 99170a5 | 2007-12-19 02:07:34 +0000 | [diff] [blame] | 736 | |
| 737 | >>> d = {'x': 11, 'y': 22} |
| 738 | >>> Point(**d) |
| 739 | Point(x=11, y=22) |
| 740 | |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 741 | Since a named tuple is a regular Python class, it is easy to add or change |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 742 | functionality with a subclass. Here is how to add a calculated field and |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 743 | a fixed-width print format: |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 744 | |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 745 | >>> class Point(namedtuple('Point', 'x y')): |
Raymond Hettinger | 15aded8 | 2011-03-15 17:25:51 -0700 | [diff] [blame] | 746 | __slots__ = () |
| 747 | @property |
| 748 | def hypot(self): |
| 749 | return (self.x ** 2 + self.y ** 2) ** 0.5 |
| 750 | def __str__(self): |
| 751 | return 'Point: x=%6.3f y=%6.3f hypot=%6.3f' % (self.x, self.y, self.hypot) |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 752 | |
Georg Brandl | 0df7979 | 2008-10-04 18:33:26 +0000 | [diff] [blame] | 753 | >>> for p in Point(3, 4), Point(14, 5/7): |
Raymond Hettinger | 15aded8 | 2011-03-15 17:25:51 -0700 | [diff] [blame] | 754 | print(p) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 755 | Point: x= 3.000 y= 4.000 hypot= 5.000 |
| 756 | Point: x=14.000 y= 0.714 hypot=14.018 |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 757 | |
Georg Brandl | af5c238 | 2009-12-28 08:02:38 +0000 | [diff] [blame] | 758 | The subclass shown above sets ``__slots__`` to an empty tuple. This helps |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 759 | keep memory requirements low by preventing the creation of instance dictionaries. |
| 760 | |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 761 | |
| 762 | Subclassing is not useful for adding new, stored fields. Instead, simply |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 763 | create a new named tuple type from the :attr:`_fields` attribute: |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 764 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 765 | >>> Point3D = namedtuple('Point3D', Point._fields + ('z',)) |
Christian Heimes | 2380ac7 | 2008-01-09 00:17:24 +0000 | [diff] [blame] | 766 | |
| 767 | Default values can be implemented by using :meth:`_replace` to |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 768 | customize a prototype instance: |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 769 | |
| 770 | >>> Account = namedtuple('Account', 'owner balance transaction_count') |
Christian Heimes | 587c2bf | 2008-01-19 16:21:02 +0000 | [diff] [blame] | 771 | >>> default_account = Account('<owner name>', 0.0, 0) |
| 772 | >>> johns_account = default_account._replace(owner='John') |
Guido van Rossum | 3d392eb | 2007-11-16 00:35:22 +0000 | [diff] [blame] | 773 | |
Christian Heimes | e4ca815 | 2008-05-08 17:18:53 +0000 | [diff] [blame] | 774 | Enumerated constants can be implemented with named tuples, but it is simpler |
| 775 | and more efficient to use a simple class declaration: |
| 776 | |
| 777 | >>> Status = namedtuple('Status', 'open pending closed')._make(range(3)) |
| 778 | >>> Status.open, Status.pending, Status.closed |
| 779 | (0, 1, 2) |
| 780 | >>> class Status: |
Raymond Hettinger | 15aded8 | 2011-03-15 17:25:51 -0700 | [diff] [blame] | 781 | open, pending, closed = range(3) |
Christian Heimes | e4ca815 | 2008-05-08 17:18:53 +0000 | [diff] [blame] | 782 | |
Raymond Hettinger | 651453a | 2009-02-11 00:20:02 +0000 | [diff] [blame] | 783 | .. seealso:: |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 784 | |
Raymond Hettinger | 6c94e6f | 2011-03-31 15:46:06 -0700 | [diff] [blame] | 785 | * `Named tuple recipe <http://code.activestate.com/recipes/500261/>`_ |
| 786 | adapted for Python 2.4. |
| 787 | |
| 788 | * `Recipe for named tuple abstract base class with a metaclass mix-in |
| 789 | <http://code.activestate.com/recipes/577629-namedtupleabc-abstract-base-class-mix-in-for-named/>`_ |
| 790 | by Jan Kaliszewski. Besides providing an :term:`abstract base class` for |
| 791 | named tuples, it also supports an alternate :term:`metaclass`-based |
| 792 | constructor that is convenient for use cases where named tuples are being |
| 793 | subclassed. |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 794 | |
| 795 | |
Raymond Hettinger | 2d32f63 | 2009-03-02 21:24:57 +0000 | [diff] [blame] | 796 | :class:`OrderedDict` objects |
| 797 | ---------------------------- |
| 798 | |
| 799 | Ordered dictionaries are just like regular dictionaries but they remember the |
| 800 | order that items were inserted. When iterating over an ordered dictionary, |
| 801 | the items are returned in the order their keys were first added. |
| 802 | |
| 803 | .. class:: OrderedDict([items]) |
| 804 | |
| 805 | Return an instance of a dict subclass, supporting the usual :class:`dict` |
| 806 | methods. An *OrderedDict* is a dict that remembers the order that keys |
| 807 | were first inserted. If a new entry overwrites an existing entry, the |
| 808 | original insertion position is left unchanged. Deleting an entry and |
| 809 | reinserting it will move it to the end. |
| 810 | |
Benjamin Peterson | d45bf58 | 2009-03-02 21:44:54 +0000 | [diff] [blame] | 811 | .. versionadded:: 3.1 |
Raymond Hettinger | 2d32f63 | 2009-03-02 21:24:57 +0000 | [diff] [blame] | 812 | |
Benjamin Peterson | d319ad5 | 2010-07-18 14:27:02 +0000 | [diff] [blame] | 813 | .. method:: popitem(last=True) |
Raymond Hettinger | dc879f0 | 2009-03-19 20:30:56 +0000 | [diff] [blame] | 814 | |
Benjamin Peterson | d319ad5 | 2010-07-18 14:27:02 +0000 | [diff] [blame] | 815 | The :meth:`popitem` method for ordered dictionaries returns and removes a |
| 816 | (key, value) pair. The pairs are returned in LIFO order if *last* is true |
| 817 | or FIFO order if false. |
Raymond Hettinger | 2d32f63 | 2009-03-02 21:24:57 +0000 | [diff] [blame] | 818 | |
Raymond Hettinger | f45abc9 | 2010-09-06 21:26:09 +0000 | [diff] [blame] | 819 | .. method:: move_to_end(key, last=True) |
| 820 | |
| 821 | Move an existing *key* to either end of an ordered dictionary. The item |
| 822 | is moved to the right end if *last* is true (the default) or to the |
| 823 | beginning if *last* is false. Raises :exc:`KeyError` if the *key* does |
| 824 | not exist:: |
| 825 | |
| 826 | >>> d = OrderedDict.fromkeys('abcde') |
| 827 | >>> d.move_to_end('b') |
Raymond Hettinger | 4d5208d | 2011-06-25 11:39:00 +0200 | [diff] [blame] | 828 | >>> ''.join(d.keys()) |
Raymond Hettinger | f45abc9 | 2010-09-06 21:26:09 +0000 | [diff] [blame] | 829 | 'acdeb' |
Éric Araujo | 1cb25aa | 2010-11-06 07:03:07 +0000 | [diff] [blame] | 830 | >>> d.move_to_end('b', last=False) |
Raymond Hettinger | 4d5208d | 2011-06-25 11:39:00 +0200 | [diff] [blame] | 831 | >>> ''.join(d.keys()) |
Raymond Hettinger | f45abc9 | 2010-09-06 21:26:09 +0000 | [diff] [blame] | 832 | 'bacde' |
| 833 | |
| 834 | .. versionadded:: 3.2 |
| 835 | |
Raymond Hettinger | e909150 | 2009-05-19 17:40:07 +0000 | [diff] [blame] | 836 | In addition to the usual mapping methods, ordered dictionaries also support |
| 837 | reverse iteration using :func:`reversed`. |
| 838 | |
Raymond Hettinger | 2d32f63 | 2009-03-02 21:24:57 +0000 | [diff] [blame] | 839 | Equality tests between :class:`OrderedDict` objects are order-sensitive |
| 840 | and are implemented as ``list(od1.items())==list(od2.items())``. |
| 841 | Equality tests between :class:`OrderedDict` objects and other |
| 842 | :class:`Mapping` objects are order-insensitive like regular dictionaries. |
| 843 | This allows :class:`OrderedDict` objects to be substituted anywhere a |
| 844 | regular dictionary is used. |
| 845 | |
Raymond Hettinger | 3618078 | 2009-04-09 22:34:23 +0000 | [diff] [blame] | 846 | The :class:`OrderedDict` constructor and :meth:`update` method both accept |
| 847 | keyword arguments, but their order is lost because Python's function call |
| 848 | semantics pass-in keyword arguments using a regular unordered dictionary. |
| 849 | |
Raymond Hettinger | dc879f0 | 2009-03-19 20:30:56 +0000 | [diff] [blame] | 850 | .. seealso:: |
| 851 | |
| 852 | `Equivalent OrderedDict recipe <http://code.activestate.com/recipes/576693/>`_ |
| 853 | that runs on Python 2.4 or later. |
| 854 | |
Raymond Hettinger | 7bba683 | 2011-04-15 17:43:19 -0700 | [diff] [blame] | 855 | :class:`OrderedDict` Examples and Recipes |
| 856 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 857 | |
Raymond Hettinger | 0e31201 | 2009-11-10 18:35:46 +0000 | [diff] [blame] | 858 | Since an ordered dictionary remembers its insertion order, it can be used |
| 859 | in conjuction with sorting to make a sorted dictionary:: |
| 860 | |
| 861 | >>> # regular unsorted dictionary |
| 862 | >>> d = {'banana': 3, 'apple':4, 'pear': 1, 'orange': 2} |
| 863 | |
| 864 | >>> # dictionary sorted by key |
| 865 | >>> OrderedDict(sorted(d.items(), key=lambda t: t[0])) |
| 866 | OrderedDict([('apple', 4), ('banana', 3), ('orange', 2), ('pear', 1)]) |
| 867 | |
| 868 | >>> # dictionary sorted by value |
| 869 | >>> OrderedDict(sorted(d.items(), key=lambda t: t[1])) |
| 870 | OrderedDict([('pear', 1), ('orange', 2), ('banana', 3), ('apple', 4)]) |
| 871 | |
| 872 | >>> # dictionary sorted by length of the key string |
| 873 | >>> OrderedDict(sorted(d.items(), key=lambda t: len(t[0]))) |
| 874 | OrderedDict([('pear', 1), ('apple', 4), ('orange', 2), ('banana', 3)]) |
| 875 | |
| 876 | The new sorted dictionaries maintain their sort order when entries |
| 877 | are deleted. But when new keys are added, the keys are appended |
| 878 | to the end and the sort is not maintained. |
| 879 | |
Raymond Hettinger | 4821ef8 | 2010-07-31 10:14:41 +0000 | [diff] [blame] | 880 | It is also straight-forward to create an ordered dictionary variant |
| 881 | that the remembers the order the keys were *last* inserted. |
| 882 | If a new entry overwrites an existing entry, the |
| 883 | original insertion position is changed and moved to the end:: |
| 884 | |
| 885 | class LastUpdatedOrderedDict(OrderedDict): |
Georg Brandl | 77570e2 | 2010-12-18 16:21:58 +0000 | [diff] [blame] | 886 | 'Store items in the order the keys were last added' |
Raymond Hettinger | 7bba683 | 2011-04-15 17:43:19 -0700 | [diff] [blame] | 887 | |
Raymond Hettinger | 4821ef8 | 2010-07-31 10:14:41 +0000 | [diff] [blame] | 888 | def __setitem__(self, key, value): |
| 889 | if key in self: |
| 890 | del self[key] |
| 891 | OrderedDict.__setitem__(self, key, value) |
| 892 | |
Éric Araujo | 889a7dc | 2011-08-19 00:40:46 +0200 | [diff] [blame] | 893 | An ordered dictionary can be combined with the :class:`Counter` class |
Raymond Hettinger | 7bba683 | 2011-04-15 17:43:19 -0700 | [diff] [blame] | 894 | so that the counter remembers the order elements are first encountered:: |
| 895 | |
| 896 | class OrderedCounter(Counter, OrderedDict): |
| 897 | 'Counter that remembers the order elements are first encountered' |
| 898 | |
Raymond Hettinger | 7bba683 | 2011-04-15 17:43:19 -0700 | [diff] [blame] | 899 | def __repr__(self): |
| 900 | return '%s(%r)' % (self.__class__.__name__, OrderedDict(self)) |
| 901 | |
| 902 | def __reduce__(self): |
| 903 | return self.__class__, (OrderedDict(self),) |
| 904 | |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 905 | |
| 906 | :class:`UserDict` objects |
Mark Summerfield | 8f2d006 | 2008-02-06 13:30:44 +0000 | [diff] [blame] | 907 | ------------------------- |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 908 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 909 | The class, :class:`UserDict` acts as a wrapper around dictionary objects. |
| 910 | The need for this class has been partially supplanted by the ability to |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 911 | subclass directly from :class:`dict`; however, this class can be easier |
| 912 | to work with because the underlying dictionary is accessible as an |
| 913 | attribute. |
| 914 | |
| 915 | .. class:: UserDict([initialdata]) |
| 916 | |
| 917 | Class that simulates a dictionary. The instance's contents are kept in a |
| 918 | regular dictionary, which is accessible via the :attr:`data` attribute of |
| 919 | :class:`UserDict` instances. If *initialdata* is provided, :attr:`data` is |
| 920 | initialized with its contents; note that a reference to *initialdata* will not |
| 921 | be kept, allowing it be used for other purposes. |
| 922 | |
Benjamin Peterson | d319ad5 | 2010-07-18 14:27:02 +0000 | [diff] [blame] | 923 | In addition to supporting the methods and operations of mappings, |
| 924 | :class:`UserDict` instances provide the following attribute: |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 925 | |
Benjamin Peterson | d319ad5 | 2010-07-18 14:27:02 +0000 | [diff] [blame] | 926 | .. attribute:: data |
Raymond Hettinger | e4c96ad | 2008-02-06 01:23:58 +0000 | [diff] [blame] | 927 | |
Benjamin Peterson | d319ad5 | 2010-07-18 14:27:02 +0000 | [diff] [blame] | 928 | A real dictionary used to store the contents of the :class:`UserDict` |
| 929 | class. |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 930 | |
| 931 | |
| 932 | |
| 933 | :class:`UserList` objects |
| 934 | ------------------------- |
| 935 | |
| 936 | This class acts as a wrapper around list objects. It is a useful base class |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 937 | for your own list-like classes which can inherit from them and override |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 938 | existing methods or add new ones. In this way, one can add new behaviors to |
| 939 | lists. |
| 940 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 941 | The need for this class has been partially supplanted by the ability to |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 942 | subclass directly from :class:`list`; however, this class can be easier |
| 943 | to work with because the underlying list is accessible as an attribute. |
| 944 | |
| 945 | .. class:: UserList([list]) |
| 946 | |
| 947 | Class that simulates a list. The instance's contents are kept in a regular |
| 948 | list, which is accessible via the :attr:`data` attribute of :class:`UserList` |
| 949 | instances. The instance's contents are initially set to a copy of *list*, |
| 950 | defaulting to the empty list ``[]``. *list* can be any iterable, for |
| 951 | example a real Python list or a :class:`UserList` object. |
| 952 | |
Benjamin Peterson | d319ad5 | 2010-07-18 14:27:02 +0000 | [diff] [blame] | 953 | In addition to supporting the methods and operations of mutable sequences, |
| 954 | :class:`UserList` instances provide the following attribute: |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 955 | |
Benjamin Peterson | d319ad5 | 2010-07-18 14:27:02 +0000 | [diff] [blame] | 956 | .. attribute:: data |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 957 | |
Benjamin Peterson | d319ad5 | 2010-07-18 14:27:02 +0000 | [diff] [blame] | 958 | A real :class:`list` object used to store the contents of the |
| 959 | :class:`UserList` class. |
Raymond Hettinger | 53dbe39 | 2008-02-12 20:03:09 +0000 | [diff] [blame] | 960 | |
| 961 | **Subclassing requirements:** Subclasses of :class:`UserList` are expect to |
| 962 | offer a constructor which can be called with either no arguments or one |
| 963 | argument. List operations which return a new sequence attempt to create an |
| 964 | instance of the actual implementation class. To do so, it assumes that the |
| 965 | constructor can be called with a single parameter, which is a sequence object |
| 966 | used as a data source. |
| 967 | |
| 968 | If a derived class does not wish to comply with this requirement, all of the |
| 969 | special methods supported by this class will need to be overridden; please |
| 970 | consult the sources for information about the methods which need to be provided |
| 971 | in that case. |
Raymond Hettinger | b3a65f8 | 2008-02-21 22:11:37 +0000 | [diff] [blame] | 972 | |
| 973 | :class:`UserString` objects |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 974 | --------------------------- |
Raymond Hettinger | b3a65f8 | 2008-02-21 22:11:37 +0000 | [diff] [blame] | 975 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 976 | The class, :class:`UserString` acts as a wrapper around string objects. |
| 977 | The need for this class has been partially supplanted by the ability to |
Raymond Hettinger | b3a65f8 | 2008-02-21 22:11:37 +0000 | [diff] [blame] | 978 | subclass directly from :class:`str`; however, this class can be easier |
| 979 | to work with because the underlying string is accessible as an |
| 980 | attribute. |
| 981 | |
| 982 | .. class:: UserString([sequence]) |
| 983 | |
| 984 | Class that simulates a string or a Unicode string object. The instance's |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 985 | content is kept in a regular string object, which is accessible via the |
| 986 | :attr:`data` attribute of :class:`UserString` instances. The instance's |
Raymond Hettinger | b3a65f8 | 2008-02-21 22:11:37 +0000 | [diff] [blame] | 987 | contents are initially set to a copy of *sequence*. The *sequence* can |
| 988 | be an instance of :class:`bytes`, :class:`str`, :class:`UserString` (or a |
| 989 | subclass) or an arbitrary sequence which can be converted into a string using |
| 990 | the built-in :func:`str` function. |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 991 | |
Éric Araujo | 889a7dc | 2011-08-19 00:40:46 +0200 | [diff] [blame] | 992 | |
Éric Araujo | fa088db | 2011-06-04 18:42:38 +0200 | [diff] [blame] | 993 | .. _collections-abstract-base-classes: |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 994 | |
| 995 | ABCs - abstract base classes |
| 996 | ---------------------------- |
| 997 | |
Ezio Melotti | 9b2e67c | 2011-03-28 13:50:41 +0300 | [diff] [blame] | 998 | The collections module offers the following :term:`ABCs <abstract base class>`: |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 999 | |
| 1000 | ========================= ===================== ====================== ==================================================== |
Ezio Melotti | 9b2e67c | 2011-03-28 13:50:41 +0300 | [diff] [blame] | 1001 | ABC Inherits from Abstract Methods Mixin Methods |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1002 | ========================= ===================== ====================== ==================================================== |
| 1003 | :class:`Container` ``__contains__`` |
| 1004 | :class:`Hashable` ``__hash__`` |
| 1005 | :class:`Iterable` ``__iter__`` |
| 1006 | :class:`Iterator` :class:`Iterable` ``__next__`` ``__iter__`` |
| 1007 | :class:`Sized` ``__len__`` |
| 1008 | :class:`Callable` ``__call__`` |
| 1009 | |
Georg Brandl | e951e91 | 2011-02-03 07:08:25 +0000 | [diff] [blame] | 1010 | :class:`Sequence` :class:`Sized`, ``__getitem__`` ``__contains__``, ``__iter__``, ``__reversed__``, |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1011 | :class:`Iterable`, ``index``, and ``count`` |
| 1012 | :class:`Container` |
| 1013 | |
Ezio Melotti | 9b2e67c | 2011-03-28 13:50:41 +0300 | [diff] [blame] | 1014 | :class:`MutableSequence` :class:`Sequence` ``__setitem__``, Inherited :class:`Sequence` methods and |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1015 | ``__delitem__``, ``append``, ``reverse``, ``extend``, ``pop``, |
Ezio Melotti | 9b2e67c | 2011-03-28 13:50:41 +0300 | [diff] [blame] | 1016 | ``insert`` ``remove``, and ``__iadd__`` |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1017 | |
| 1018 | :class:`Set` :class:`Sized`, ``__le__``, ``__lt__``, ``__eq__``, ``__ne__``, |
Georg Brandl | e951e91 | 2011-02-03 07:08:25 +0000 | [diff] [blame] | 1019 | :class:`Iterable`, ``__gt__``, ``__ge__``, ``__and__``, ``__or__``, |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1020 | :class:`Container` ``__sub__``, ``__xor__``, and ``isdisjoint`` |
| 1021 | |
Ezio Melotti | 9b2e67c | 2011-03-28 13:50:41 +0300 | [diff] [blame] | 1022 | :class:`MutableSet` :class:`Set` ``add``, Inherited :class:`Set` methods and |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1023 | ``discard`` ``clear``, ``pop``, ``remove``, ``__ior__``, |
| 1024 | ``__iand__``, ``__ixor__``, and ``__isub__`` |
| 1025 | |
| 1026 | :class:`Mapping` :class:`Sized`, ``__getitem__`` ``__contains__``, ``keys``, ``items``, ``values``, |
| 1027 | :class:`Iterable`, ``get``, ``__eq__``, and ``__ne__`` |
| 1028 | :class:`Container` |
| 1029 | |
Ezio Melotti | 9b2e67c | 2011-03-28 13:50:41 +0300 | [diff] [blame] | 1030 | :class:`MutableMapping` :class:`Mapping` ``__setitem__``, Inherited :class:`Mapping` methods and |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1031 | ``__delitem__`` ``pop``, ``popitem``, ``clear``, ``update``, |
| 1032 | and ``setdefault`` |
| 1033 | |
| 1034 | |
| 1035 | :class:`MappingView` :class:`Sized` ``__len__`` |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1036 | :class:`ItemsView` :class:`MappingView`, ``__contains__``, |
| 1037 | :class:`Set` ``__iter__`` |
Ezio Melotti | 9b2e67c | 2011-03-28 13:50:41 +0300 | [diff] [blame] | 1038 | :class:`KeysView` :class:`MappingView`, ``__contains__``, |
| 1039 | :class:`Set` ``__iter__`` |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1040 | :class:`ValuesView` :class:`MappingView` ``__contains__``, ``__iter__`` |
| 1041 | ========================= ===================== ====================== ==================================================== |
| 1042 | |
Ezio Melotti | 9b2e67c | 2011-03-28 13:50:41 +0300 | [diff] [blame] | 1043 | |
| 1044 | .. class:: Container |
| 1045 | Hashable |
| 1046 | Sized |
| 1047 | Callable |
| 1048 | |
| 1049 | ABCs for classes that provide respectively the methods :meth:`__contains__`, |
| 1050 | :meth:`__hash__`, :meth:`__len__`, and :meth:`__call__`. |
| 1051 | |
| 1052 | .. class:: Iterable |
| 1053 | |
| 1054 | ABC for classes that provide the :meth:`__iter__` method. |
| 1055 | See also the definition of :term:`iterable`. |
| 1056 | |
| 1057 | .. class:: Iterator |
| 1058 | |
| 1059 | ABC for classes that provide the :meth:`__iter__` and :meth:`next` methods. |
| 1060 | See also the definition of :term:`iterator`. |
| 1061 | |
| 1062 | .. class:: Sequence |
| 1063 | MutableSequence |
| 1064 | |
| 1065 | ABCs for read-only and mutable :term:`sequences <sequence>`. |
| 1066 | |
| 1067 | .. class:: Set |
| 1068 | MutableSet |
| 1069 | |
| 1070 | ABCs for read-only and mutable sets. |
| 1071 | |
| 1072 | .. class:: Mapping |
| 1073 | MutableMapping |
| 1074 | |
| 1075 | ABCs for read-only and mutable :term:`mappings <mapping>`. |
| 1076 | |
| 1077 | .. class:: MappingView |
| 1078 | ItemsView |
| 1079 | KeysView |
| 1080 | ValuesView |
| 1081 | |
| 1082 | ABCs for mapping, items, keys, and values :term:`views <view>`. |
| 1083 | |
| 1084 | |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1085 | These ABCs allow us to ask classes or instances if they provide |
| 1086 | particular functionality, for example:: |
| 1087 | |
| 1088 | size = None |
| 1089 | if isinstance(myvar, collections.Sized): |
| 1090 | size = len(myvar) |
| 1091 | |
| 1092 | Several of the ABCs are also useful as mixins that make it easier to develop |
| 1093 | classes supporting container APIs. For example, to write a class supporting |
| 1094 | the full :class:`Set` API, it only necessary to supply the three underlying |
| 1095 | abstract methods: :meth:`__contains__`, :meth:`__iter__`, and :meth:`__len__`. |
| 1096 | The ABC supplies the remaining methods such as :meth:`__and__` and |
| 1097 | :meth:`isdisjoint` :: |
| 1098 | |
| 1099 | class ListBasedSet(collections.Set): |
| 1100 | ''' Alternate set implementation favoring space over speed |
| 1101 | and not requiring the set elements to be hashable. ''' |
| 1102 | def __init__(self, iterable): |
| 1103 | self.elements = lst = [] |
| 1104 | for value in iterable: |
| 1105 | if value not in lst: |
| 1106 | lst.append(value) |
| 1107 | def __iter__(self): |
| 1108 | return iter(self.elements) |
| 1109 | def __contains__(self, value): |
| 1110 | return value in self.elements |
| 1111 | def __len__(self): |
| 1112 | return len(self.elements) |
| 1113 | |
| 1114 | s1 = ListBasedSet('abcdef') |
| 1115 | s2 = ListBasedSet('defghi') |
| 1116 | overlap = s1 & s2 # The __and__() method is supported automatically |
| 1117 | |
| 1118 | Notes on using :class:`Set` and :class:`MutableSet` as a mixin: |
| 1119 | |
| 1120 | (1) |
| 1121 | Since some set operations create new sets, the default mixin methods need |
| 1122 | a way to create new instances from an iterable. The class constructor is |
| 1123 | assumed to have a signature in the form ``ClassName(iterable)``. |
| 1124 | That assumption is factored-out to an internal classmethod called |
| 1125 | :meth:`_from_iterable` which calls ``cls(iterable)`` to produce a new set. |
| 1126 | If the :class:`Set` mixin is being used in a class with a different |
Raymond Hettinger | e5820c6 | 2011-03-22 09:11:39 -0700 | [diff] [blame] | 1127 | constructor signature, you will need to override :meth:`_from_iterable` |
Raymond Hettinger | a6b76ba | 2010-08-08 00:29:08 +0000 | [diff] [blame] | 1128 | with a classmethod that can construct new instances from |
| 1129 | an iterable argument. |
| 1130 | |
| 1131 | (2) |
| 1132 | To override the comparisons (presumably for speed, as the |
| 1133 | semantics are fixed), redefine :meth:`__le__` and |
| 1134 | then the other operations will automatically follow suit. |
| 1135 | |
| 1136 | (3) |
| 1137 | The :class:`Set` mixin provides a :meth:`_hash` method to compute a hash value |
| 1138 | for the set; however, :meth:`__hash__` is not defined because not all sets |
| 1139 | are hashable or immutable. To add set hashabilty using mixins, |
| 1140 | inherit from both :meth:`Set` and :meth:`Hashable`, then define |
| 1141 | ``__hash__ = Set._hash``. |
| 1142 | |
| 1143 | .. seealso:: |
| 1144 | |
| 1145 | * `OrderedSet recipe <http://code.activestate.com/recipes/576694/>`_ for an |
| 1146 | example built on :class:`MutableSet`. |
| 1147 | |
| 1148 | * For more about ABCs, see the :mod:`abc` module and :pep:`3119`. |