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