summaryrefslogtreecommitdiffstats
path: root/Lib/collections/__init__.py
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2015-11-24 04:43:28 (GMT)
committerRaymond Hettinger <python@rcn.com>2015-11-24 04:43:28 (GMT)
commitc9c3dd87c1235dfaae49602ec7ba279b6d6be9a3 (patch)
treead2aa7097fc0ad6a5af43e0b8514fc8d8b4d3136 /Lib/collections/__init__.py
parent11bb1ad15502849f126af3f35de7eaeebd617fc5 (diff)
downloadcpython-c9c3dd87c1235dfaae49602ec7ba279b6d6be9a3.zip
cpython-c9c3dd87c1235dfaae49602ec7ba279b6d6be9a3.tar.gz
cpython-c9c3dd87c1235dfaae49602ec7ba279b6d6be9a3.tar.bz2
Add a missing docstring
Diffstat (limited to 'Lib/collections/__init__.py')
-rw-r--r--Lib/collections/__init__.py16
1 files changed, 16 insertions, 0 deletions
diff --git a/Lib/collections/__init__.py b/Lib/collections/__init__.py
index e8312a9..5b47e60 100644
--- a/Lib/collections/__init__.py
+++ b/Lib/collections/__init__.py
@@ -1,3 +1,19 @@
+'''This module implements specialized container datatypes providing
+alternatives to Python’s general purpose built-in containers, dict,
+list, set, and tuple.
+
+* namedtuple factory function for creating tuple subclasses with named fields
+* deque list-like container with fast appends and pops on either end
+* ChainMap dict-like class for creating a single view of multiple mappings
+* Counter dict subclass for counting hashable objects
+* OrderedDict dict subclass that remembers the order entries were added
+* defaultdict dict subclass that calls a factory function to supply missing values
+* UserDict wrapper around dictionary objects for easier dict subclassing
+* UserList wrapper around list objects for easier list subclassing
+* UserString wrapper around string objects for easier string subclassing
+
+'''
+
__all__ = ['deque', 'defaultdict', 'namedtuple', 'UserDict', 'UserList',
'UserString', 'Counter', 'OrderedDict', 'ChainMap']