Linux cpanel.rrshost.in 5.15.0-25-generic #25-Ubuntu SMP Wed Mar 30 15:54:22 UTC 2022 x86_64
Apache
: 109.123.238.221 | : 172.69.17.152
128 Domain
8.2.28
aev999
Terminal
AUTO ROOT
Adminer
Backdoor Destroyer
Linux Exploit
Lock Shell
Lock File
Create User
CREATE RDP
PHP Mailer
BACKCONNECT
HASH IDENTIFIER
README
+ Create Folder
+ Create File
/
usr /
share /
doc /
python2.7 /
html /
_sources /
library /
[ HOME SHELL ]
Name
Size
Permission
Action
2to3.rst.txt
14.3
KB
-rw-r--r--
__builtin__.rst.txt
1.46
KB
-rw-r--r--
__future__.rst.txt
4.84
KB
-rw-r--r--
__main__.rst.txt
535
B
-rw-r--r--
_winreg.rst.txt
22.77
KB
-rw-r--r--
abc.rst.txt
7.05
KB
-rw-r--r--
aepack.rst.txt
4.16
KB
-rw-r--r--
aetools.rst.txt
3.45
KB
-rw-r--r--
aetypes.rst.txt
4.16
KB
-rw-r--r--
aifc.rst.txt
6.92
KB
-rw-r--r--
al.rst.txt
5.18
KB
-rw-r--r--
allos.rst.txt
695
B
-rw-r--r--
anydbm.rst.txt
4.01
KB
-rw-r--r--
archiving.rst.txt
424
B
-rw-r--r--
argparse.rst.txt
72.93
KB
-rw-r--r--
array.rst.txt
10.28
KB
-rw-r--r--
ast.rst.txt
10.23
KB
-rw-r--r--
asynchat.rst.txt
8.99
KB
-rw-r--r--
asyncore.rst.txt
12.63
KB
-rw-r--r--
atexit.rst.txt
3.82
KB
-rw-r--r--
audioop.rst.txt
10.15
KB
-rw-r--r--
autogil.rst.txt
1015
B
-rw-r--r--
base64.rst.txt
6.11
KB
-rw-r--r--
basehttpserver.rst.txt
10.16
KB
-rw-r--r--
bastion.rst.txt
2.55
KB
-rw-r--r--
bdb.rst.txt
12.16
KB
-rw-r--r--
binascii.rst.txt
6.36
KB
-rw-r--r--
binhex.rst.txt
1.87
KB
-rw-r--r--
bisect.rst.txt
5.29
KB
-rw-r--r--
bsddb.rst.txt
7.4
KB
-rw-r--r--
bz2.rst.txt
7.88
KB
-rw-r--r--
calendar.rst.txt
11.02
KB
-rw-r--r--
carbon.rst.txt
15.58
KB
-rw-r--r--
cd.rst.txt
11.69
KB
-rw-r--r--
cgi.rst.txt
22.32
KB
-rw-r--r--
cgihttpserver.rst.txt
2.72
KB
-rw-r--r--
cgitb.rst.txt
2.81
KB
-rw-r--r--
chunk.rst.txt
4.84
KB
-rw-r--r--
cmath.rst.txt
7.47
KB
-rw-r--r--
cmd.rst.txt
8.36
KB
-rw-r--r--
code.rst.txt
6.95
KB
-rw-r--r--
codecs.rst.txt
65.4
KB
-rw-r--r--
codeop.rst.txt
3.69
KB
-rw-r--r--
collections.rst.txt
40.48
KB
-rw-r--r--
colorpicker.rst.txt
913
B
-rw-r--r--
colorsys.rst.txt
1.78
KB
-rw-r--r--
commands.rst.txt
2.53
KB
-rw-r--r--
compileall.rst.txt
4.57
KB
-rw-r--r--
compiler.rst.txt
36.59
KB
-rw-r--r--
configparser.rst.txt
19.15
KB
-rw-r--r--
constants.rst.txt
2.27
KB
-rw-r--r--
contextlib.rst.txt
5.87
KB
-rw-r--r--
cookie.rst.txt
9.32
KB
-rw-r--r--
cookielib.rst.txt
27.22
KB
-rw-r--r--
copy.rst.txt
3.27
KB
-rw-r--r--
copy_reg.rst.txt
2.27
KB
-rw-r--r--
crypt.rst.txt
2.24
KB
-rw-r--r--
crypto.rst.txt
355
B
-rw-r--r--
csv.rst.txt
22.22
KB
-rw-r--r--
ctypes.rst.txt
88.39
KB
-rw-r--r--
curses.ascii.rst.txt
8.83
KB
-rw-r--r--
curses.panel.rst.txt
2.68
KB
-rw-r--r--
curses.rst.txt
73.12
KB
-rw-r--r--
custominterp.rst.txt
570
B
-rw-r--r--
datatypes.rst.txt
864
B
-rw-r--r--
datetime.rst.txt
72.93
KB
-rw-r--r--
dbhash.rst.txt
3.77
KB
-rw-r--r--
dbm.rst.txt
3.04
KB
-rw-r--r--
debug.rst.txt
446
B
-rw-r--r--
decimal.rst.txt
69.26
KB
-rw-r--r--
development.rst.txt
640
B
-rw-r--r--
difflib.rst.txt
30
KB
-rw-r--r--
dircache.rst.txt
1.77
KB
-rw-r--r--
dis.rst.txt
22.7
KB
-rw-r--r--
distribution.rst.txt
426
B
-rw-r--r--
distutils.rst.txt
1.91
KB
-rw-r--r--
dl.rst.txt
3.31
KB
-rw-r--r--
doctest.rst.txt
72.25
KB
-rw-r--r--
docxmlrpcserver.rst.txt
3.71
KB
-rw-r--r--
dumbdbm.rst.txt
2.77
KB
-rw-r--r--
dummy_thread.rst.txt
1.03
KB
-rw-r--r--
dummy_threading.rst.txt
799
B
-rw-r--r--
easydialogs.rst.txt
10.1
KB
-rw-r--r--
email-examples.rst.txt
1.24
KB
-rw-r--r--
email.charset.rst.txt
9.43
KB
-rw-r--r--
email.encoders.rst.txt
2.32
KB
-rw-r--r--
email.errors.rst.txt
3.91
KB
-rw-r--r--
email.generator.rst.txt
5.99
KB
-rw-r--r--
email.header.rst.txt
7.35
KB
-rw-r--r--
email.iterators.rst.txt
2.36
KB
-rw-r--r--
email.message.rst.txt
24.63
KB
-rw-r--r--
email.mime.rst.txt
9.68
KB
-rw-r--r--
email.parser.rst.txt
10.08
KB
-rw-r--r--
email.rst.txt
15.73
KB
-rw-r--r--
email.utils.rst.txt
6.32
KB
-rw-r--r--
ensurepip.rst.txt
4.9
KB
-rw-r--r--
errno.rst.txt
6.55
KB
-rw-r--r--
exceptions.rst.txt
18.03
KB
-rw-r--r--
fcntl.rst.txt
7.19
KB
-rw-r--r--
filecmp.rst.txt
5.22
KB
-rw-r--r--
fileformats.rst.txt
302
B
-rw-r--r--
fileinput.rst.txt
7.24
KB
-rw-r--r--
filesys.rst.txt
806
B
-rw-r--r--
fl.rst.txt
17.23
KB
-rw-r--r--
fm.rst.txt
2.64
KB
-rw-r--r--
fnmatch.rst.txt
3.03
KB
-rw-r--r--
formatter.rst.txt
12.93
KB
-rw-r--r--
fpectl.rst.txt
4.07
KB
-rw-r--r--
fpformat.rst.txt
1.71
KB
-rw-r--r--
fractions.rst.txt
5.17
KB
-rw-r--r--
framework.rst.txt
11.18
KB
-rw-r--r--
frameworks.rst.txt
378
B
-rw-r--r--
ftplib.rst.txt
15.35
KB
-rw-r--r--
functions.rst.txt
73.75
KB
-rw-r--r--
functools.rst.txt
7.27
KB
-rw-r--r--
future_builtins.rst.txt
1.96
KB
-rw-r--r--
gc.rst.txt
8.8
KB
-rw-r--r--
gdbm.rst.txt
4.77
KB
-rw-r--r--
gensuitemodule.rst.txt
3.04
KB
-rw-r--r--
getopt.rst.txt
6.51
KB
-rw-r--r--
getpass.rst.txt
1.83
KB
-rw-r--r--
gettext.rst.txt
28.36
KB
-rw-r--r--
gl.rst.txt
5.87
KB
-rw-r--r--
glob.rst.txt
2.36
KB
-rw-r--r--
grp.rst.txt
2.2
KB
-rw-r--r--
gzip.rst.txt
4.71
KB
-rw-r--r--
hashlib.rst.txt
7.21
KB
-rw-r--r--
heapq.rst.txt
12.88
KB
-rw-r--r--
hmac.rst.txt
3
KB
-rw-r--r--
hotshot.rst.txt
4.19
KB
-rw-r--r--
htmllib.rst.txt
7.21
KB
-rw-r--r--
htmlparser.rst.txt
11.37
KB
-rw-r--r--
httplib.rst.txt
36.58
KB
-rw-r--r--
i18n.rst.txt
409
B
-rw-r--r--
ic.rst.txt
4.89
KB
-rw-r--r--
idle.rst.txt
21.66
KB
-rw-r--r--
imageop.rst.txt
3.91
KB
-rw-r--r--
imaplib.rst.txt
16.82
KB
-rw-r--r--
imgfile.rst.txt
2.7
KB
-rw-r--r--
imghdr.rst.txt
2.57
KB
-rw-r--r--
imp.rst.txt
12.3
KB
-rw-r--r--
importlib.rst.txt
1.1
KB
-rw-r--r--
imputil.rst.txt
6.86
KB
-rw-r--r--
index.rst.txt
2.23
KB
-rw-r--r--
inspect.rst.txt
27.49
KB
-rw-r--r--
internet.rst.txt
950
B
-rw-r--r--
intro.rst.txt
2.74
KB
-rw-r--r--
io.rst.txt
38.11
KB
-rw-r--r--
ipc.rst.txt
630
B
-rw-r--r--
itertools.rst.txt
35.67
KB
-rw-r--r--
jpeg.rst.txt
3.77
KB
-rw-r--r--
json.rst.txt
24.95
KB
-rw-r--r--
keyword.rst.txt
617
B
-rw-r--r--
language.rst.txt
523
B
-rw-r--r--
linecache.rst.txt
1.84
KB
-rw-r--r--
locale.rst.txt
24.39
KB
-rw-r--r--
logging.config.rst.txt
30.82
KB
-rw-r--r--
logging.handlers.rst.txt
27.49
KB
-rw-r--r--
logging.rst.txt
45.78
KB
-rw-r--r--
mac.rst.txt
791
B
-rw-r--r--
macos.rst.txt
3.73
KB
-rw-r--r--
macosa.rst.txt
3.87
KB
-rw-r--r--
macostools.rst.txt
3.92
KB
-rw-r--r--
macpath.rst.txt
650
B
-rw-r--r--
mailbox.rst.txt
66.53
KB
-rw-r--r--
mailcap.rst.txt
3.59
KB
-rw-r--r--
markup.rst.txt
1.22
KB
-rw-r--r--
marshal.rst.txt
5.56
KB
-rw-r--r--
math.rst.txt
10.66
KB
-rw-r--r--
md5.rst.txt
2.75
KB
-rw-r--r--
mhlib.rst.txt
3.87
KB
-rw-r--r--
mimetools.rst.txt
4.4
KB
-rw-r--r--
mimetypes.rst.txt
9.61
KB
-rw-r--r--
mimewriter.rst.txt
3.28
KB
-rw-r--r--
mimify.rst.txt
3.44
KB
-rw-r--r--
miniaeframe.rst.txt
2.5
KB
-rw-r--r--
misc.rst.txt
248
B
-rw-r--r--
mm.rst.txt
447
B
-rw-r--r--
mmap.rst.txt
10.24
KB
-rw-r--r--
modulefinder.rst.txt
3.3
KB
-rw-r--r--
modules.rst.txt
382
B
-rw-r--r--
msilib.rst.txt
18.62
KB
-rw-r--r--
msvcrt.rst.txt
4.24
KB
-rw-r--r--
multifile.rst.txt
6.46
KB
-rw-r--r--
multiprocessing.rst.txt
90.45
KB
-rw-r--r--
mutex.rst.txt
1.89
KB
-rw-r--r--
netdata.rst.txt
432
B
-rw-r--r--
netrc.rst.txt
3.05
KB
-rw-r--r--
new.rst.txt
2.59
KB
-rw-r--r--
nis.rst.txt
2.06
KB
-rw-r--r--
nntplib.rst.txt
14.19
KB
-rw-r--r--
numbers.rst.txt
7.82
KB
-rw-r--r--
numeric.rst.txt
751
B
-rw-r--r--
operator.rst.txt
21.57
KB
-rw-r--r--
optparse.rst.txt
75.29
KB
-rw-r--r--
os.path.rst.txt
12.79
KB
-rw-r--r--
os.rst.txt
80.64
KB
-rw-r--r--
ossaudiodev.rst.txt
16.9
KB
-rw-r--r--
othergui.rst.txt
2.66
KB
-rw-r--r--
parser.rst.txt
15.02
KB
-rw-r--r--
pdb.rst.txt
15.67
KB
-rw-r--r--
persistence.rst.txt
826
B
-rw-r--r--
pickle.rst.txt
36.39
KB
-rw-r--r--
pickletools.rst.txt
1.95
KB
-rw-r--r--
pipes.rst.txt
3.7
KB
-rw-r--r--
pkgutil.rst.txt
7.53
KB
-rw-r--r--
platform.rst.txt
9.33
KB
-rw-r--r--
plistlib.rst.txt
4.04
KB
-rw-r--r--
popen2.rst.txt
6.86
KB
-rw-r--r--
poplib.rst.txt
6.07
KB
-rw-r--r--
posix.rst.txt
3.54
KB
-rw-r--r--
posixfile.rst.txt
7.03
KB
-rw-r--r--
pprint.rst.txt
8.86
KB
-rw-r--r--
profile.rst.txt
27.99
KB
-rw-r--r--
pty.rst.txt
1.72
KB
-rw-r--r--
pwd.rst.txt
2.66
KB
-rw-r--r--
py_compile.rst.txt
2.42
KB
-rw-r--r--
pyclbr.rst.txt
3.22
KB
-rw-r--r--
pydoc.rst.txt
3.99
KB
-rw-r--r--
pyexpat.rst.txt
28.21
KB
-rw-r--r--
python.rst.txt
514
B
-rw-r--r--
queue.rst.txt
6.87
KB
-rw-r--r--
quopri.rst.txt
2.61
KB
-rw-r--r--
random.rst.txt
13.01
KB
-rw-r--r--
re.rst.txt
53.81
KB
-rw-r--r--
readline.rst.txt
10.27
KB
-rw-r--r--
repr.rst.txt
4.61
KB
-rw-r--r--
resource.rst.txt
9.37
KB
-rw-r--r--
restricted.rst.txt
3.25
KB
-rw-r--r--
rexec.rst.txt
11.47
KB
-rw-r--r--
rfc822.rst.txt
13.71
KB
-rw-r--r--
rlcompleter.rst.txt
2.44
KB
-rw-r--r--
robotparser.rst.txt
2.14
KB
-rw-r--r--
runpy.rst.txt
6.78
KB
-rw-r--r--
sched.rst.txt
4.54
KB
-rw-r--r--
scrolledtext.rst.txt
1.35
KB
-rw-r--r--
select.rst.txt
20.26
KB
-rw-r--r--
sets.rst.txt
14.62
KB
-rw-r--r--
sgi.rst.txt
322
B
-rw-r--r--
sgmllib.rst.txt
10.41
KB
-rw-r--r--
sha.rst.txt
2.74
KB
-rw-r--r--
shelve.rst.txt
8.12
KB
-rw-r--r--
shlex.rst.txt
11.05
KB
-rw-r--r--
shutil.rst.txt
13.17
KB
-rw-r--r--
signal.rst.txt
10.47
KB
-rw-r--r--
simplehttpserver.rst.txt
4.45
KB
-rw-r--r--
simplexmlrpcserver.rst.txt
10.63
KB
-rw-r--r--
site.rst.txt
7.7
KB
-rw-r--r--
smtpd.rst.txt
2.41
KB
-rw-r--r--
smtplib.rst.txt
14.56
KB
-rw-r--r--
sndhdr.rst.txt
1.72
KB
-rw-r--r--
socket.rst.txt
39.81
KB
-rw-r--r--
socketserver.rst.txt
21.98
KB
-rw-r--r--
someos.rst.txt
599
B
-rw-r--r--
spwd.rst.txt
2.76
KB
-rw-r--r--
sqlite3.rst.txt
34.62
KB
-rw-r--r--
ssl.rst.txt
74.91
KB
-rw-r--r--
stat.rst.txt
7.6
KB
-rw-r--r--
statvfs.rst.txt
1.27
KB
-rw-r--r--
stdtypes.rst.txt
119.78
KB
-rw-r--r--
string.rst.txt
43.05
KB
-rw-r--r--
stringio.rst.txt
4.07
KB
-rw-r--r--
stringprep.rst.txt
4.14
KB
-rw-r--r--
strings.rst.txt
746
B
-rw-r--r--
struct.rst.txt
16.7
KB
-rw-r--r--
subprocess.rst.txt
32.86
KB
-rw-r--r--
sun.rst.txt
249
B
-rw-r--r--
sunau.rst.txt
6.96
KB
-rw-r--r--
sunaudio.rst.txt
5.71
KB
-rw-r--r--
symbol.rst.txt
975
B
-rw-r--r--
symtable.rst.txt
4.95
KB
-rw-r--r--
sys.rst.txt
46.4
KB
-rw-r--r--
sysconfig.rst.txt
7.46
KB
-rw-r--r--
syslog.rst.txt
3.84
KB
-rw-r--r--
tabnanny.rst.txt
1.95
KB
-rw-r--r--
tarfile.rst.txt
27.55
KB
-rw-r--r--
telnetlib.rst.txt
7.31
KB
-rw-r--r--
tempfile.rst.txt
10.26
KB
-rw-r--r--
termios.rst.txt
3.65
KB
-rw-r--r--
test.rst.txt
17.34
KB
-rw-r--r--
textwrap.rst.txt
8.47
KB
-rw-r--r--
thread.rst.txt
6.43
KB
-rw-r--r--
threading.rst.txt
31.77
KB
-rw-r--r--
time.rst.txt
25.41
KB
-rw-r--r--
timeit.rst.txt
11.33
KB
-rw-r--r--
tix.rst.txt
22.16
KB
-rw-r--r--
tk.rst.txt
1.57
KB
-rw-r--r--
tkinter.rst.txt
32.72
KB
-rw-r--r--
token.rst.txt
2.39
KB
-rw-r--r--
tokenize.rst.txt
5.44
KB
-rw-r--r--
trace.rst.txt
6.57
KB
-rw-r--r--
traceback.rst.txt
10.46
KB
-rw-r--r--
ttk.rst.txt
56.07
KB
-rw-r--r--
tty.rst.txt
1011
B
-rw-r--r--
turtle.rst.txt
62.59
KB
-rw-r--r--
types.rst.txt
6.05
KB
-rw-r--r--
undoc.rst.txt
6.4
KB
-rw-r--r--
unicodedata.rst.txt
5.59
KB
-rw-r--r--
unittest.rst.txt
81.01
KB
-rw-r--r--
unix.rst.txt
490
B
-rw-r--r--
urllib.rst.txt
24.38
KB
-rw-r--r--
urllib2.rst.txt
34.39
KB
-rw-r--r--
urlparse.rst.txt
16.56
KB
-rw-r--r--
user.rst.txt
2.68
KB
-rw-r--r--
userdict.rst.txt
9.07
KB
-rw-r--r--
uu.rst.txt
2.31
KB
-rw-r--r--
uuid.rst.txt
8.18
KB
-rw-r--r--
warnings.rst.txt
19.6
KB
-rw-r--r--
wave.rst.txt
4.93
KB
-rw-r--r--
weakref.rst.txt
12.62
KB
-rw-r--r--
webbrowser.rst.txt
9.63
KB
-rw-r--r--
whichdb.rst.txt
931
B
-rw-r--r--
windows.rst.txt
273
B
-rw-r--r--
winsound.rst.txt
4.95
KB
-rw-r--r--
wsgiref.rst.txt
29.85
KB
-rw-r--r--
xdrlib.rst.txt
7.89
KB
-rw-r--r--
xml.dom.minidom.rst.txt
10.95
KB
-rw-r--r--
xml.dom.pulldom.rst.txt
1.53
KB
-rw-r--r--
xml.dom.rst.txt
39.24
KB
-rw-r--r--
xml.etree.elementtree.rst.txt
34.87
KB
-rw-r--r--
xml.rst.txt
5.95
KB
-rw-r--r--
xml.sax.handler.rst.txt
15.01
KB
-rw-r--r--
xml.sax.reader.rst.txt
11.97
KB
-rw-r--r--
xml.sax.rst.txt
6.31
KB
-rw-r--r--
xml.sax.utils.rst.txt
3.48
KB
-rw-r--r--
xmlrpclib.rst.txt
22.03
KB
-rw-r--r--
zipfile.rst.txt
18.43
KB
-rw-r--r--
zipimport.rst.txt
5.82
KB
-rw-r--r--
zlib.rst.txt
12.47
KB
-rw-r--r--
Delete
Unzip
Zip
${this.title}
Close
Code Editor : collections.rst.txt
:mod:`collections` --- High-performance container datatypes =========================================================== .. module:: collections :synopsis: High-performance datatypes .. moduleauthor:: Raymond Hettinger <python@rcn.com> .. sectionauthor:: Raymond Hettinger <python@rcn.com> .. versionadded:: 2.4 .. testsetup:: * from collections import * import itertools __name__ = '<doctest>' **Source code:** :source:`Lib/collections.py` and :source:`Lib/_abcoll.py` -------------- This module implements specialized container datatypes providing alternatives to Python's general purpose built-in containers, :class:`dict`, :class:`list`, :class:`set`, and :class:`tuple`. ===================== ==================================================================== =========================== :func:`namedtuple` factory function for creating tuple subclasses with named fields .. versionadded:: 2.6 :class:`deque` list-like container with fast appends and pops on either end .. versionadded:: 2.4 :class:`Counter` dict subclass for counting hashable objects .. versionadded:: 2.7 :class:`OrderedDict` dict subclass that remembers the order entries were added .. versionadded:: 2.7 :class:`defaultdict` dict subclass that calls a factory function to supply missing values .. versionadded:: 2.5 ===================== ==================================================================== =========================== In addition to the concrete container classes, the collections module provides :ref:`abstract base classes <collections-abstract-base-classes>` that can be used to test whether a class provides a particular interface, for example, whether it is hashable or a mapping. :class:`Counter` objects ------------------------ A counter tool is provided to support convenient and rapid tallies. For example:: >>> # Tally occurrences of words in a list >>> cnt = Counter() >>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']: ... cnt[word] += 1 >>> cnt Counter({'blue': 3, 'red': 2, 'green': 1}) >>> # Find the ten most common words in Hamlet >>> import re >>> words = re.findall(r'\w+', open('hamlet.txt').read().lower()) >>> Counter(words).most_common(10) [('the', 1143), ('and', 966), ('to', 762), ('of', 669), ('i', 631), ('you', 554), ('a', 546), ('my', 514), ('hamlet', 471), ('in', 451)] .. class:: Counter([iterable-or-mapping]) A :class:`Counter` is a :class:`dict` subclass for counting hashable objects. It is an unordered collection where elements are stored as dictionary keys and their counts are stored as dictionary values. Counts are allowed to be any integer value including zero or negative counts. The :class:`Counter` class is similar to bags or multisets in other languages. Elements are counted from an *iterable* or initialized from another *mapping* (or counter): >>> c = Counter() # a new, empty counter >>> c = Counter('gallahad') # a new counter from an iterable >>> c = Counter({'red': 4, 'blue': 2}) # a new counter from a mapping >>> c = Counter(cats=4, dogs=8) # a new counter from keyword args Counter objects have a dictionary interface except that they return a zero count for missing items instead of raising a :exc:`KeyError`: >>> c = Counter(['eggs', 'ham']) >>> c['bacon'] # count of a missing element is zero 0 Setting a count to zero does not remove an element from a counter. Use ``del`` to remove it entirely: >>> c['sausage'] = 0 # counter entry with a zero count >>> del c['sausage'] # del actually removes the entry .. versionadded:: 2.7 Counter objects support three methods beyond those available for all dictionaries: .. method:: elements() Return an iterator over elements repeating each as many times as its count. Elements are returned in arbitrary order. If an element's count is less than one, :meth:`elements` will ignore it. >>> c = Counter(a=4, b=2, c=0, d=-2) >>> list(c.elements()) ['a', 'a', 'a', 'a', 'b', 'b'] .. method:: most_common([n]) Return a list of the *n* most common elements and their counts from the most common to the least. If *n* is omitted or ``None``, :func:`most_common` returns *all* elements in the counter. Elements with equal counts are ordered arbitrarily: >>> Counter('abracadabra').most_common(3) [('a', 5), ('r', 2), ('b', 2)] .. method:: subtract([iterable-or-mapping]) Elements are subtracted from an *iterable* or from another *mapping* (or counter). Like :meth:`dict.update` but subtracts counts instead of replacing them. Both inputs and outputs may be zero or negative. >>> c = Counter(a=4, b=2, c=0, d=-2) >>> d = Counter(a=1, b=2, c=3, d=4) >>> c.subtract(d) >>> c Counter({'a': 3, 'b': 0, 'c': -3, 'd': -6}) The usual dictionary methods are available for :class:`Counter` objects except for two which work differently for counters. .. method:: fromkeys(iterable) This class method is not implemented for :class:`Counter` objects. .. method:: update([iterable-or-mapping]) Elements are counted from an *iterable* or added-in from another *mapping* (or counter). Like :meth:`dict.update` but adds counts instead of replacing them. Also, the *iterable* is expected to be a sequence of elements, not a sequence of ``(key, value)`` pairs. Common patterns for working with :class:`Counter` objects:: sum(c.values()) # total of all counts c.clear() # reset all counts list(c) # list unique elements set(c) # convert to a set dict(c) # convert to a regular dictionary c.items() # convert to a list of (elem, cnt) pairs Counter(dict(list_of_pairs)) # convert from a list of (elem, cnt) pairs c.most_common()[:-n-1:-1] # n least common elements c += Counter() # remove zero and negative counts Several mathematical operations are provided for combining :class:`Counter` objects to produce multisets (counters that have counts greater than zero). Addition and subtraction combine counters by adding or subtracting the counts of corresponding elements. Intersection and union return the minimum and maximum of corresponding counts. Each operation can accept inputs with signed counts, but the output will exclude results with counts of zero or less. >>> c = Counter(a=3, b=1) >>> d = Counter(a=1, b=2) >>> c + d # add two counters together: c[x] + d[x] Counter({'a': 4, 'b': 3}) >>> c - d # subtract (keeping only positive counts) Counter({'a': 2}) >>> c & d # intersection: min(c[x], d[x]) Counter({'a': 1, 'b': 1}) >>> c | d # union: max(c[x], d[x]) Counter({'a': 3, 'b': 2}) .. note:: Counters were primarily designed to work with positive integers to represent running counts; however, care was taken to not unnecessarily preclude use cases needing other types or negative values. To help with those use cases, this section documents the minimum range and type restrictions. * The :class:`Counter` class itself is a dictionary subclass with no restrictions on its keys and values. The values are intended to be numbers representing counts, but you *could* store anything in the value field. * The :meth:`most_common` method requires only that the values be orderable. * For in-place operations such as ``c[key] += 1``, the value type need only support addition and subtraction. So fractions, floats, and decimals would work and negative values are supported. The same is also true for :meth:`update` and :meth:`subtract` which allow negative and zero values for both inputs and outputs. * The multiset methods are designed only for use cases with positive values. The inputs may be negative or zero, but only outputs with positive values are created. There are no type restrictions, but the value type needs to support addition, subtraction, and comparison. * The :meth:`elements` method requires integer counts. It ignores zero and negative counts. .. seealso:: * `Counter class <https://code.activestate.com/recipes/576611/>`_ adapted for Python 2.5 and an early `Bag recipe <https://code.activestate.com/recipes/259174/>`_ for Python 2.4. * `Bag class <https://www.gnu.org/software/smalltalk/manual-base/html_node/Bag.html>`_ in Smalltalk. * Wikipedia entry for `Multisets <https://en.wikipedia.org/wiki/Multiset>`_. * `C++ multisets <http://www.java2s.com/Tutorial/Cpp/0380__set-multiset/Catalog0380__set-multiset.htm>`_ tutorial with examples. * For mathematical operations on multisets and their use cases, see *Knuth, Donald. The Art of Computer Programming Volume II, Section 4.6.3, Exercise 19*. * To enumerate all distinct multisets of a given size over a given set of elements, see :func:`itertools.combinations_with_replacement`. map(Counter, combinations_with_replacement('ABC', 2)) --> AA AB AC BB BC CC :class:`deque` objects ---------------------- .. class:: deque([iterable[, maxlen]]) Returns a new deque object initialized left-to-right (using :meth:`append`) with data from *iterable*. If *iterable* is not specified, the new deque is empty. Deques are a generalization of stacks and queues (the name is pronounced "deck" and is short for "double-ended queue"). Deques support thread-safe, memory efficient appends and pops from either side of the deque with approximately the same O(1) performance in either direction. Though :class:`list` objects support similar operations, they are optimized for fast fixed-length operations and incur O(n) memory movement costs for ``pop(0)`` and ``insert(0, v)`` operations which change both the size and position of the underlying data representation. .. versionadded:: 2.4 If *maxlen* is not specified or is ``None``, deques may grow to an arbitrary length. Otherwise, the deque is bounded to the specified maximum length. Once a bounded length deque is full, when new items are added, a corresponding number of items are discarded from the opposite end. Bounded length deques provide functionality similar to the ``tail`` filter in Unix. They are also useful for tracking transactions and other pools of data where only the most recent activity is of interest. .. versionchanged:: 2.6 Added *maxlen* parameter. Deque objects support the following methods: .. method:: append(x) Add *x* to the right side of the deque. .. method:: appendleft(x) Add *x* to the left side of the deque. .. method:: clear() Remove all elements from the deque leaving it with length 0. .. method:: count(x) Count the number of deque elements equal to *x*. .. versionadded:: 2.7 .. method:: extend(iterable) Extend the right side of the deque by appending elements from the iterable argument. .. method:: extendleft(iterable) Extend the left side of the deque by appending elements from *iterable*. Note, the series of left appends results in reversing the order of elements in the iterable argument. .. method:: pop() Remove and return an element from the right side of the deque. If no elements are present, raises an :exc:`IndexError`. .. method:: popleft() Remove and return an element from the left side of the deque. If no elements are present, raises an :exc:`IndexError`. .. method:: remove(value) Remove the first occurrence of *value*. If not found, raises a :exc:`ValueError`. .. versionadded:: 2.5 .. method:: reverse() Reverse the elements of the deque in-place and then return ``None``. .. versionadded:: 2.7 .. method:: rotate(n=1) Rotate the deque *n* steps to the right. If *n* is negative, rotate to the left. When the deque is not empty, rotating one step to the right is equivalent to ``d.appendleft(d.pop())``, and rotating one step to the left is equivalent to ``d.append(d.popleft())``. Deque objects also provide one read-only attribute: .. attribute:: maxlen Maximum size of a deque or ``None`` if unbounded. .. versionadded:: 2.7 In addition to the above, deques support iteration, pickling, ``len(d)``, ``reversed(d)``, ``copy.copy(d)``, ``copy.deepcopy(d)``, membership testing with the :keyword:`in` operator, and subscript references such as ``d[-1]``. Indexed access is O(1) at both ends but slows to O(n) in the middle. For fast random access, use lists instead. Example: .. doctest:: >>> from collections import deque >>> d = deque('ghi') # make a new deque with three items >>> for elem in d: # iterate over the deque's elements ... print elem.upper() G H I >>> d.append('j') # add a new entry to the right side >>> d.appendleft('f') # add a new entry to the left side >>> d # show the representation of the deque deque(['f', 'g', 'h', 'i', 'j']) >>> d.pop() # return and remove the rightmost item 'j' >>> d.popleft() # return and remove the leftmost item 'f' >>> list(d) # list the contents of the deque ['g', 'h', 'i'] >>> d[0] # peek at leftmost item 'g' >>> d[-1] # peek at rightmost item 'i' >>> list(reversed(d)) # list the contents of a deque in reverse ['i', 'h', 'g'] >>> 'h' in d # search the deque True >>> d.extend('jkl') # add multiple elements at once >>> d deque(['g', 'h', 'i', 'j', 'k', 'l']) >>> d.rotate(1) # right rotation >>> d deque(['l', 'g', 'h', 'i', 'j', 'k']) >>> d.rotate(-1) # left rotation >>> d deque(['g', 'h', 'i', 'j', 'k', 'l']) >>> deque(reversed(d)) # make a new deque in reverse order deque(['l', 'k', 'j', 'i', 'h', 'g']) >>> d.clear() # empty the deque >>> d.pop() # cannot pop from an empty deque Traceback (most recent call last): File "<pyshell#6>", line 1, in -toplevel- d.pop() IndexError: pop from an empty deque >>> d.extendleft('abc') # extendleft() reverses the input order >>> d deque(['c', 'b', 'a']) :class:`deque` Recipes ^^^^^^^^^^^^^^^^^^^^^^ This section shows various approaches to working with deques. Bounded length deques provide functionality similar to the ``tail`` filter in Unix:: def tail(filename, n=10): 'Return the last n lines of a file' return deque(open(filename), n) Another approach to using deques is to maintain a sequence of recently added elements by appending to the right and popping to the left:: def moving_average(iterable, n=3): # moving_average([40, 30, 50, 46, 39, 44]) --> 40.0 42.0 45.0 43.0 # http://en.wikipedia.org/wiki/Moving_average it = iter(iterable) d = deque(itertools.islice(it, n-1)) d.appendleft(0) s = sum(d) for elem in it: s += elem - d.popleft() d.append(elem) yield s / float(n) The :meth:`rotate` method provides a way to implement :class:`deque` slicing and deletion. For example, a pure Python implementation of ``del d[n]`` relies on the :meth:`rotate` method to position elements to be popped:: def delete_nth(d, n): d.rotate(-n) d.popleft() d.rotate(n) To implement :class:`deque` slicing, use a similar approach applying :meth:`rotate` to bring a target element to the left side of the deque. Remove old entries with :meth:`popleft`, add new entries with :meth:`extend`, and then reverse the rotation. With minor variations on that approach, it is easy to implement Forth style stack manipulations such as ``dup``, ``drop``, ``swap``, ``over``, ``pick``, ``rot``, and ``roll``. :class:`defaultdict` objects ---------------------------- .. class:: defaultdict([default_factory[, ...]]) Returns a new dictionary-like object. :class:`defaultdict` is a subclass of the built-in :class:`dict` class. It overrides one method and adds one writable instance variable. The remaining functionality is the same as for the :class:`dict` class and is not documented here. The first argument provides the initial value for the :attr:`default_factory` attribute; it defaults to ``None``. All remaining arguments are treated the same as if they were passed to the :class:`dict` constructor, including keyword arguments. .. versionadded:: 2.5 :class:`defaultdict` objects support the following method in addition to the standard :class:`dict` operations: .. method:: __missing__(key) If the :attr:`default_factory` attribute is ``None``, this raises a :exc:`KeyError` exception with the *key* as argument. If :attr:`default_factory` is not ``None``, it is called without arguments to provide a default value for the given *key*, this value is inserted in the dictionary for the *key*, and returned. If calling :attr:`default_factory` raises an exception this exception is propagated unchanged. This method is called by the :meth:`__getitem__` method of the :class:`dict` class when the requested key is not found; whatever it returns or raises is then returned or raised by :meth:`__getitem__`. Note that :meth:`__missing__` is *not* called for any operations besides :meth:`__getitem__`. This means that :meth:`get` will, like normal dictionaries, return ``None`` as a default rather than using :attr:`default_factory`. :class:`defaultdict` objects support the following instance variable: .. attribute:: default_factory This attribute is used by the :meth:`__missing__` method; it is initialized from the first argument to the constructor, if present, or to ``None``, if absent. :class:`defaultdict` Examples ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Using :class:`list` as the :attr:`default_factory`, it is easy to group a sequence of key-value pairs into a dictionary of lists: >>> s = [('yellow', 1), ('blue', 2), ('yellow', 3), ('blue', 4), ('red', 1)] >>> d = defaultdict(list) >>> for k, v in s: ... d[k].append(v) ... >>> d.items() [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])] When each key is encountered for the first time, it is not already in the mapping; so an entry is automatically created using the :attr:`default_factory` function which returns an empty :class:`list`. The :meth:`list.append` operation then attaches the value to the new list. When keys are encountered again, the look-up proceeds normally (returning the list for that key) and the :meth:`list.append` operation adds another value to the list. This technique is simpler and faster than an equivalent technique using :meth:`dict.setdefault`: >>> d = {} >>> for k, v in s: ... d.setdefault(k, []).append(v) ... >>> d.items() [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])] Setting the :attr:`default_factory` to :class:`int` makes the :class:`defaultdict` useful for counting (like a bag or multiset in other languages): >>> s = 'mississippi' >>> d = defaultdict(int) >>> for k in s: ... d[k] += 1 ... >>> d.items() [('i', 4), ('p', 2), ('s', 4), ('m', 1)] When a letter is first encountered, it is missing from the mapping, so the :attr:`default_factory` function calls :func:`int` to supply a default count of zero. The increment operation then builds up the count for each letter. The function :func:`int` which always returns zero is just a special case of constant functions. A faster and more flexible way to create constant functions is to use :func:`itertools.repeat` which can supply any constant value (not just zero): >>> def constant_factory(value): ... return itertools.repeat(value).next >>> d = defaultdict(constant_factory('<missing>')) >>> d.update(name='John', action='ran') >>> '%(name)s %(action)s to %(object)s' % d 'John ran to <missing>' Setting the :attr:`default_factory` to :class:`set` makes the :class:`defaultdict` useful for building a dictionary of sets: >>> s = [('red', 1), ('blue', 2), ('red', 3), ('blue', 4), ('red', 1), ('blue', 4)] >>> d = defaultdict(set) >>> for k, v in s: ... d[k].add(v) ... >>> d.items() [('blue', set([2, 4])), ('red', set([1, 3]))] :func:`namedtuple` Factory Function for Tuples with Named Fields ---------------------------------------------------------------- Named tuples assign meaning to each position in a tuple and allow for more readable, self-documenting code. They can be used wherever regular tuples are used, and they add the ability to access fields by name instead of position index. .. function:: namedtuple(typename, field_names, [verbose=False], [rename=False]) Returns a new tuple subclass named *typename*. The new subclass is used to create tuple-like objects that have fields accessible by attribute lookup as well as being indexable and iterable. Instances of the subclass also have a helpful docstring (with typename and field_names) and a helpful :meth:`__repr__` method which lists the tuple contents in a ``name=value`` format. The *field_names* are a sequence of strings such as ``['x', 'y']``. Alternatively, *field_names* can be a single string with each fieldname separated by whitespace and/or commas, for example ``'x y'`` or ``'x, y'``. Any valid Python identifier may be used for a fieldname except for names starting with an underscore. Valid identifiers consist of letters, digits, and underscores but do not start with a digit or underscore and cannot be a :mod:`keyword` such as *class*, *for*, *return*, *global*, *pass*, *print*, or *raise*. If *rename* is true, invalid fieldnames are automatically replaced with positional names. For example, ``['abc', 'def', 'ghi', 'abc']`` is converted to ``['abc', '_1', 'ghi', '_3']``, eliminating the keyword ``def`` and the duplicate fieldname ``abc``. If *verbose* is true, the class definition is printed just before being built. Named tuple instances do not have per-instance dictionaries, so they are lightweight and require no more memory than regular tuples. .. versionadded:: 2.6 .. versionchanged:: 2.7 added support for *rename*. Example: .. doctest:: :options: +NORMALIZE_WHITESPACE >>> Point = namedtuple('Point', ['x', 'y'], verbose=True) class Point(tuple): 'Point(x, y)' <BLANKLINE> __slots__ = () <BLANKLINE> _fields = ('x', 'y') <BLANKLINE> def __new__(_cls, x, y): 'Create new instance of Point(x, y)' return _tuple.__new__(_cls, (x, y)) <BLANKLINE> @classmethod def _make(cls, iterable, new=tuple.__new__, len=len): 'Make a new Point object from a sequence or iterable' result = new(cls, iterable) if len(result) != 2: raise TypeError('Expected 2 arguments, got %d' % len(result)) return result <BLANKLINE> def __repr__(self): 'Return a nicely formatted representation string' return 'Point(x=%r, y=%r)' % self <BLANKLINE> def _asdict(self): 'Return a new OrderedDict which maps field names to their values' return OrderedDict(zip(self._fields, self)) <BLANKLINE> def _replace(_self, **kwds): 'Return a new Point object replacing specified fields with new values' result = _self._make(map(kwds.pop, ('x', 'y'), _self)) if kwds: raise ValueError('Got unexpected field names: %r' % kwds.keys()) return result <BLANKLINE> def __getnewargs__(self): 'Return self as a plain tuple. Used by copy and pickle.' return tuple(self) <BLANKLINE> __dict__ = _property(_asdict) <BLANKLINE> def __getstate__(self): 'Exclude the OrderedDict from pickling' pass <BLANKLINE> x = _property(_itemgetter(0), doc='Alias for field number 0') <BLANKLINE> y = _property(_itemgetter(1), doc='Alias for field number 1') <BLANKLINE> <BLANKLINE> >>> p = Point(11, y=22) # instantiate with positional or keyword arguments >>> p[0] + p[1] # indexable like the plain tuple (11, 22) 33 >>> x, y = p # unpack like a regular tuple >>> x, y (11, 22) >>> p.x + p.y # fields also accessible by name 33 >>> p # readable __repr__ with a name=value style Point(x=11, y=22) Named tuples are especially useful for assigning field names to result tuples returned by the :mod:`csv` or :mod:`sqlite3` modules:: EmployeeRecord = namedtuple('EmployeeRecord', 'name, age, title, department, paygrade') import csv for emp in map(EmployeeRecord._make, csv.reader(open("employees.csv", "rb"))): print emp.name, emp.title import sqlite3 conn = sqlite3.connect('/companydata') cursor = conn.cursor() cursor.execute('SELECT name, age, title, department, paygrade FROM employees') for emp in map(EmployeeRecord._make, cursor.fetchall()): print emp.name, emp.title In addition to the methods inherited from tuples, named tuples support three additional methods and one attribute. To prevent conflicts with field names, the method and attribute names start with an underscore. .. classmethod:: somenamedtuple._make(iterable) Class method that makes a new instance from an existing sequence or iterable. .. doctest:: >>> t = [11, 22] >>> Point._make(t) Point(x=11, y=22) .. method:: somenamedtuple._asdict() Return a new :class:`OrderedDict` which maps field names to their corresponding values:: >>> p = Point(x=11, y=22) >>> p._asdict() OrderedDict([('x', 11), ('y', 22)]) .. versionchanged:: 2.7 Returns an :class:`OrderedDict` instead of a regular :class:`dict`. .. method:: somenamedtuple._replace(**kwargs) Return a new instance of the named tuple replacing specified fields with new values:: >>> p = Point(x=11, y=22) >>> p._replace(x=33) Point(x=33, y=22) >>> for partnum, record in inventory.items(): ... inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now()) .. attribute:: somenamedtuple._fields Tuple of strings listing the field names. Useful for introspection and for creating new named tuple types from existing named tuples. .. doctest:: >>> p._fields # view the field names ('x', 'y') >>> Color = namedtuple('Color', 'red green blue') >>> Pixel = namedtuple('Pixel', Point._fields + Color._fields) >>> Pixel(11, 22, 128, 255, 0) Pixel(x=11, y=22, red=128, green=255, blue=0) To retrieve a field whose name is stored in a string, use the :func:`getattr` function: >>> getattr(p, 'x') 11 To convert a dictionary to a named tuple, use the double-star-operator (as described in :ref:`tut-unpacking-arguments`): >>> d = {'x': 11, 'y': 22} >>> Point(**d) Point(x=11, y=22) Since a named tuple is a regular Python class, it is easy to add or change functionality with a subclass. Here is how to add a calculated field and a fixed-width print format: >>> class Point(namedtuple('Point', 'x y')): ... __slots__ = () ... @property ... def hypot(self): ... return (self.x ** 2 + self.y ** 2) ** 0.5 ... def __str__(self): ... return 'Point: x=%6.3f y=%6.3f hypot=%6.3f' % (self.x, self.y, self.hypot) ... >>> for p in Point(3, 4), Point(14, 5/7.): ... print p Point: x= 3.000 y= 4.000 hypot= 5.000 Point: x=14.000 y= 0.714 hypot=14.018 The subclass shown above sets ``__slots__`` to an empty tuple. This helps keep memory requirements low by preventing the creation of instance dictionaries. Subclassing is not useful for adding new, stored fields. Instead, simply create a new named tuple type from the :attr:`_fields` attribute: >>> Point3D = namedtuple('Point3D', Point._fields + ('z',)) Default values can be implemented by using :meth:`_replace` to customize a prototype instance: >>> Account = namedtuple('Account', 'owner balance transaction_count') >>> default_account = Account('<owner name>', 0.0, 0) >>> johns_account = default_account._replace(owner='John') Enumerated constants can be implemented with named tuples, but it is simpler and more efficient to use a simple class declaration: >>> Status = namedtuple('Status', 'open pending closed')._make(range(3)) >>> Status.open, Status.pending, Status.closed (0, 1, 2) >>> class Status: ... open, pending, closed = range(3) .. seealso:: `Named tuple recipe <https://code.activestate.com/recipes/500261/>`_ adapted for Python 2.4. :class:`OrderedDict` objects ---------------------------- Ordered dictionaries are just like regular dictionaries but they remember the order that items were inserted. When iterating over an ordered dictionary, the items are returned in the order their keys were first added. .. class:: OrderedDict([items]) Return an instance of a dict subclass, supporting the usual :class:`dict` methods. An *OrderedDict* is a dict that remembers the order that keys were first inserted. If a new entry overwrites an existing entry, the original insertion position is left unchanged. Deleting an entry and reinserting it will move it to the end. .. versionadded:: 2.7 .. method:: OrderedDict.popitem(last=True) The :meth:`popitem` method for ordered dictionaries returns and removes a (key, value) pair. The pairs are returned in LIFO order if *last* is true or FIFO order if false. In addition to the usual mapping methods, ordered dictionaries also support reverse iteration using :func:`reversed`. Equality tests between :class:`OrderedDict` objects are order-sensitive and are implemented as ``list(od1.items())==list(od2.items())``. Equality tests between :class:`OrderedDict` objects and other :class:`Mapping` objects are order-insensitive like regular dictionaries. This allows :class:`OrderedDict` objects to be substituted anywhere a regular dictionary is used. The :class:`OrderedDict` constructor and :meth:`update` method both accept keyword arguments, but their order is lost because Python's function call semantics pass-in keyword arguments using a regular unordered dictionary. .. seealso:: `Equivalent OrderedDict recipe <https://code.activestate.com/recipes/576693/>`_ that runs on Python 2.4 or later. :class:`OrderedDict` Examples and Recipes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Since an ordered dictionary remembers its insertion order, it can be used in conjunction with sorting to make a sorted dictionary:: >>> # regular unsorted dictionary >>> d = {'banana': 3, 'apple': 4, 'pear': 1, 'orange': 2} >>> # dictionary sorted by key >>> OrderedDict(sorted(d.items(), key=lambda t: t[0])) OrderedDict([('apple', 4), ('banana', 3), ('orange', 2), ('pear', 1)]) >>> # dictionary sorted by value >>> OrderedDict(sorted(d.items(), key=lambda t: t[1])) OrderedDict([('pear', 1), ('orange', 2), ('banana', 3), ('apple', 4)]) >>> # dictionary sorted by length of the key string >>> OrderedDict(sorted(d.items(), key=lambda t: len(t[0]))) OrderedDict([('pear', 1), ('apple', 4), ('orange', 2), ('banana', 3)]) The new sorted dictionaries maintain their sort order when entries are deleted. But when new keys are added, the keys are appended to the end and the sort is not maintained. It is also straight-forward to create an ordered dictionary variant that remembers the order the keys were *last* inserted. If a new entry overwrites an existing entry, the original insertion position is changed and moved to the end:: class LastUpdatedOrderedDict(OrderedDict): 'Store items in the order the keys were last added' def __setitem__(self, key, value): if key in self: del self[key] OrderedDict.__setitem__(self, key, value) An ordered dictionary can be combined with the :class:`Counter` class so that the counter remembers the order elements are first encountered:: class OrderedCounter(Counter, OrderedDict): 'Counter that remembers the order elements are first encountered' def __repr__(self): return '%s(%r)' % (self.__class__.__name__, OrderedDict(self)) def __reduce__(self): return self.__class__, (OrderedDict(self),) .. _collections-abstract-base-classes: Collections Abstract Base Classes --------------------------------- The collections module offers the following :term:`ABCs <abstract base class>`: ========================= ===================== ====================== ==================================================== ABC Inherits from Abstract Methods Mixin Methods ========================= ===================== ====================== ==================================================== :class:`Container` ``__contains__`` :class:`Hashable` ``__hash__`` :class:`Iterable` ``__iter__`` :class:`Iterator` :class:`Iterable` ``next`` ``__iter__`` :class:`Sized` ``__len__`` :class:`Callable` ``__call__`` :class:`Sequence` :class:`Sized`, ``__getitem__``, ``__contains__``, ``__iter__``, ``__reversed__``, :class:`Iterable`, ``__len__`` ``index``, and ``count`` :class:`Container` :class:`MutableSequence` :class:`Sequence` ``__getitem__``, Inherited :class:`Sequence` methods and ``__setitem__``, ``append``, ``reverse``, ``extend``, ``pop``, ``__delitem__``, ``remove``, and ``__iadd__`` ``__len__``, ``insert`` :class:`Set` :class:`Sized`, ``__contains__``, ``__le__``, ``__lt__``, ``__eq__``, ``__ne__``, :class:`Iterable`, ``__iter__``, ``__gt__``, ``__ge__``, ``__and__``, ``__or__``, :class:`Container` ``__len__`` ``__sub__``, ``__xor__``, and ``isdisjoint`` :class:`MutableSet` :class:`Set` ``__contains__``, Inherited :class:`Set` methods and ``__iter__``, ``clear``, ``pop``, ``remove``, ``__ior__``, ``__len__``, ``__iand__``, ``__ixor__``, and ``__isub__`` ``add``, ``discard`` :class:`Mapping` :class:`Sized`, ``__getitem__``, ``__contains__``, ``keys``, ``items``, ``values``, :class:`Iterable`, ``__iter__``, ``get``, ``__eq__``, and ``__ne__`` :class:`Container` ``__len__`` :class:`MutableMapping` :class:`Mapping` ``__getitem__``, Inherited :class:`Mapping` methods and ``__setitem__``, ``pop``, ``popitem``, ``clear``, ``update``, ``__delitem__``, and ``setdefault`` ``__iter__``, ``__len__`` :class:`MappingView` :class:`Sized` ``__len__`` :class:`ItemsView` :class:`MappingView`, ``__contains__``, :class:`Set` ``__iter__`` :class:`KeysView` :class:`MappingView`, ``__contains__``, :class:`Set` ``__iter__`` :class:`ValuesView` :class:`MappingView` ``__contains__``, ``__iter__`` ========================= ===================== ====================== ==================================================== .. class:: Container Hashable Sized Callable ABCs for classes that provide respectively the methods :meth:`__contains__`, :meth:`__hash__`, :meth:`__len__`, and :meth:`__call__`. .. class:: Iterable ABC for classes that provide the :meth:`__iter__` method. See also the definition of :term:`iterable`. .. class:: Iterator ABC for classes that provide the :meth:`~iterator.__iter__` and :meth:`~iterator.next` methods. See also the definition of :term:`iterator`. .. class:: Sequence MutableSequence ABCs for read-only and mutable :term:`sequences <sequence>`. .. class:: Set MutableSet ABCs for read-only and mutable sets. .. class:: Mapping MutableMapping ABCs for read-only and mutable :term:`mappings <mapping>`. .. class:: MappingView ItemsView KeysView ValuesView ABCs for mapping, items, keys, and values :term:`views <dictionary view>`. These ABCs allow us to ask classes or instances if they provide particular functionality, for example:: size = None if isinstance(myvar, collections.Sized): size = len(myvar) Several of the ABCs are also useful as mixins that make it easier to develop classes supporting container APIs. For example, to write a class supporting the full :class:`Set` API, it only necessary to supply the three underlying abstract methods: :meth:`__contains__`, :meth:`__iter__`, and :meth:`__len__`. The ABC supplies the remaining methods such as :meth:`__and__` and :meth:`isdisjoint` :: class ListBasedSet(collections.Set): ''' Alternate set implementation favoring space over speed and not requiring the set elements to be hashable. ''' def __init__(self, iterable): self.elements = lst = [] for value in iterable: if value not in lst: lst.append(value) def __iter__(self): return iter(self.elements) def __contains__(self, value): return value in self.elements def __len__(self): return len(self.elements) s1 = ListBasedSet('abcdef') s2 = ListBasedSet('defghi') overlap = s1 & s2 # The __and__() method is supported automatically Notes on using :class:`Set` and :class:`MutableSet` as a mixin: (1) Since some set operations create new sets, the default mixin methods need a way to create new instances from an iterable. The class constructor is assumed to have a signature in the form ``ClassName(iterable)``. That assumption is factored-out to an internal classmethod called :meth:`_from_iterable` which calls ``cls(iterable)`` to produce a new set. If the :class:`Set` mixin is being used in a class with a different constructor signature, you will need to override :meth:`_from_iterable` with a classmethod that can construct new instances from an iterable argument. (2) To override the comparisons (presumably for speed, as the semantics are fixed), redefine :meth:`__le__` and :meth:`__ge__`, then the other operations will automatically follow suit. (3) The :class:`Set` mixin provides a :meth:`_hash` method to compute a hash value for the set; however, :meth:`__hash__` is not defined because not all sets are hashable or immutable. To add set hashability using mixins, inherit from both :meth:`Set` and :meth:`Hashable`, then define ``__hash__ = Set._hash``. .. seealso:: * `OrderedSet recipe <https://code.activestate.com/recipes/576694/>`_ for an example built on :class:`MutableSet`. * For more about ABCs, see the :mod:`abc` module and :pep:`3119`.
Close
