annotate Misc/cheatsheet @ 79675:c0a2294de787 2.7

Issue #16199: Backport 2to3 typo fix from 3.2.
author Chris Jerdonek <chris.jerdonek@gmail.com>
date Thu, 11 Oct 2012 16:15:46 -0700
parents f6785bce54b5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
1 Python 2.3 Quick Reference
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
3
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
4 25 Jan 2003 upgraded by Raymond Hettinger for Python 2.3
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
5 16 May 2001 upgraded by Richard Gruet and Simon Brunning for Python 2.0
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
6 2000/07/18 upgraded by Richard Gruet, rgruet@intraware.com for Python 1.5.2
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
7 from V1.3 ref
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
8 1995/10/30, by Chris Hoffmann, choffman@vicorp.com
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
9
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
10 Based on:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
11 Python Bestiary, Author: Ken Manheimer, ken.manheimer@nist.gov
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
12 Python manuals, Authors: Guido van Rossum and Fred Drake
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
13 What's new in Python 2.0, Authors: A.M. Kuchling and Moshe Zadka
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
14 python-mode.el, Author: Tim Peters, tim_one@email.msn.com
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
15
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
16 and the readers of comp.lang.python
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
17
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
18 Python's nest: http://www.python.org Developement: http://
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
19 python.sourceforge.net/ ActivePython : http://www.ActiveState.com/ASPN/
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
20 Python/
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
21 newsgroup: comp.lang.python Help desk: help@python.org
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
22 Resources: http://starship.python.net/
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
23 http://www.vex.net/parnassus/
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
24 http://aspn.activestate.com/ASPN/Cookbook/Python
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
25 FAQ: http://www.python.org/cgi-bin/faqw.py
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
26 Full documentation: http://www.python.org/doc/
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
27 Excellent reference books:
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
28 Python Essential Reference by David Beazley (New Riders)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
29 Python Pocket Reference by Mark Lutz (O'Reilly)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
30
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
31
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
32 Invocation Options
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
33
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
34 python [-diOStuUvxX?] [-c command | script | - ] [args]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
35
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
36 Invocation Options
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
37 Option Effect
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
38 -c cmd program passed in as string (terminates option list)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
39 -d Outputs parser debugging information (also PYTHONDEBUG=x)
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
40 -E ignore environment variables (such as PYTHONPATH)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
41 -h print this help message and exit
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
42 -i Inspect interactively after running script (also PYTHONINSPECT=x) and
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
43 force prompts, even if stdin appears not to be a terminal
41832
a0ee3b2ba361 Add -3 option to the interpreter to warn about features that are
Neal Norwitz <nnorwitz@gmail.com>
parents: 41712
diff changeset
44 -m mod run library module as a script (terminates option list
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
45 -O optimize generated bytecode (a tad; also PYTHONOPTIMIZE=x)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
46 -OO remove doc-strings in addition to the -O optimizations
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
47 -Q arg division options: -Qold (default), -Qwarn, -Qwarnall, -Qnew
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
48 -S Don't perform 'import site' on initialization
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
49 -t Issue warnings about inconsistent tab usage (-tt: issue errors)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
50 -u Unbuffered binary stdout and stderr (also PYTHONUNBUFFERED=x).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
51 -v Verbose (trace import statements) (also PYTHONVERBOSE=x)
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
52 -W arg : warning control (arg is action:message:category:module:lineno)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
53 -x Skip first line of source, allowing use of non-unix Forms of #!cmd
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
54 -? Help!
41832
a0ee3b2ba361 Add -3 option to the interpreter to warn about features that are
Neal Norwitz <nnorwitz@gmail.com>
parents: 41712
diff changeset
55 -3 warn about Python 3.x incompatibilities
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
56 -c Specify the command to execute (see next section). This terminates the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
57 command option list (following options are passed as arguments to the command).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
58 the name of a python file (.py) to execute read from stdin.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
59 script Anything afterward is passed as options to python script or command,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
60 not interpreted as an option to interpreter itself.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
61 args passed to script or command (in sys.argv[1:])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
62 If no script or command, Python enters interactive mode.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
63
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
64 * Available IDEs in std distrib: IDLE (tkinter based, portable), Pythonwin
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
65 (Windows).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
66
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
67
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
68
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
69 Environment variables
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
70
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
71 Environment variables
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
72 Variable Effect
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
73 PYTHONHOME Alternate prefix directory (or prefix;exec_prefix). The
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
74 default module search path uses prefix/lib
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
75 Augments the default search path for module files. The format
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
76 is the same as the shell's $PATH: one or more directory
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
77 pathnames separated by ':' or ';' without spaces around
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
78 (semi-)colons!
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
79 PYTHONPATH On Windows first search for Registry key HKEY_LOCAL_MACHINE\
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
80 Software\Python\PythonCore\x.y\PythonPath (default value). You
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
81 may also define a key named after your application with a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
82 default string value giving the root directory path of your
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
83 app.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
84 If this is the name of a readable file, the Python commands in
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
85 PYTHONSTARTUP that file are executed before the first prompt is displayed in
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
86 interactive mode (no default).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
87 PYTHONDEBUG If non-empty, same as -d option
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
88 PYTHONINSPECT If non-empty, same as -i option
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
89 PYTHONSUPPRESS If non-empty, same as -s option
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
90 PYTHONUNBUFFERED If non-empty, same as -u option
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
91 PYTHONVERBOSE If non-empty, same as -v option
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
92 PYTHONCASEOK If non-empty, ignore case in file/module names (imports)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
93
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
94
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
95
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
96
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
97 Notable lexical entities
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
98
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
99 Keywords
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
100
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
101 and del for is raise
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
102 assert elif from lambda return
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
103 break else global not try
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
104 class except if or while
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
105 continue exec import pass yield
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
106 def finally in print
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
107
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
108 * (list of keywords in std module: keyword)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
109 * Illegitimate Tokens (only valid in strings): @ $ ?
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
110 * A statement must all be on a single line. To break a statement over
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
111 multiple lines use "\", as with the C preprocessor.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
112 Exception: can always break when inside any (), [], or {} pair, or in
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
113 triple-quoted strings.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
114 * More than one statement can appear on a line if they are separated with
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
115 semicolons (";").
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
116 * Comments start with "#" and continue to end of line.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
117
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
118 Identifiers
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
119
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
120 (letter | "_") (letter | digit | "_")*
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
121
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
122 * Python identifiers keywords, attributes, etc. are case-sensitive.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
123 * Special forms: _ident (not imported by 'from module import *'); __ident__
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
124 (system defined name);
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
125 __ident (class-private name mangling)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
126
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
127 Strings
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
128
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
129 "a string enclosed by double quotes"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
130 'another string delimited by single quotes and with a " inside'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
131 '''a string containing embedded newlines and quote (') marks, can be
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
132 delimited with triple quotes.'''
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
133 """ may also use 3- double quotes as delimiters """
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
134 u'a unicode string' U"Another unicode string"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
135 r'a raw string where \ are kept (literalized): handy for regular
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
136 expressions and windows paths!'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
137 R"another raw string" -- raw strings cannot end with a \
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
138 ur'a unicode raw string' UR"another raw unicode"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
139
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
140 Use \ at end of line to continue a string on next line.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
141 adjacent strings are concatened, e.g. 'Monty' ' Python' is the same as
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
142 'Monty Python'.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
143 u'hello' + ' world' --> u'hello world' (coerced to unicode)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
144
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
145 String Literal Escapes
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
146
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
147 \newline Ignored (escape newline)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
148 \\ Backslash (\) \e Escape (ESC) \v Vertical Tab (VT)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
149 \' Single quote (') \f Formfeed (FF) \OOO char with octal value OOO
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
150 \" Double quote (") \n Linefeed (LF)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
151 \a Bell (BEL) \r Carriage Return (CR) \xHH char with hex value HH
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
152 \b Backspace (BS) \t Horizontal Tab (TAB)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
153 \uHHHH unicode char with hex value HHHH, can only be used in unicode string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
154 \UHHHHHHHH unicode char with hex value HHHHHHHH, can only be used in unicode string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
155 \AnyOtherChar is left as-is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
156
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
157 * NUL byte (\000) is NOT an end-of-string marker; NULs may be embedded in
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
158 strings.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
159 * Strings (and tuples) are immutable: they cannot be modified.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
160
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
161 Numbers
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
162
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
163 Decimal integer: 1234, 1234567890546378940L (or l)
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
164 Octal integer: 0177, 0177777777777777777 (begin with a 0)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
165 Hex integer: 0xFF, 0XFFFFffffFFFFFFFFFF (begin with 0x or 0X)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
166 Long integer (unlimited precision): 1234567890123456
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
167 Float (double precision): 3.14e-10, .001, 10., 1E3
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
168 Complex: 1J, 2+3J, 4+5j (ends with J or j, + separates (float) real and
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
169 imaginary parts)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
170
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
171 Sequences
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
172
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
173 * String of length 0, 1, 2 (see above)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
174 '', '1', "12", 'hello\n'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
175 * Tuple of length 0, 1, 2, etc:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
176 () (1,) (1,2) # parentheses are optional if len > 0
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
177 * List of length 0, 1, 2, etc:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
178 [] [1] [1,2]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
179
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
180 Indexing is 0-based. Negative indices (usually) mean count backwards from end
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
181 of sequence.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
182
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
183 Sequence slicing [starting-at-index : but-less-than-index]. Start defaults to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
184 '0'; End defaults to 'sequence-length'.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
185
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
186 a = (0,1,2,3,4,5,6,7)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
187 a[3] ==> 3
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
188 a[-1] ==> 7
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
189 a[2:4] ==> (2, 3)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
190 a[1:] ==> (1, 2, 3, 4, 5, 6, 7)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
191 a[:3] ==> (0, 1, 2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
192 a[:] ==> (0,1,2,3,4,5,6,7) # makes a copy of the sequence.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
193
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
194 Dictionaries (Mappings)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
195
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
196 {} # Zero length empty dictionary
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
197 {1 : 'first'} # Dictionary with one (key, value) pair
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
198 {1 : 'first', 'next': 'second'}
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
199 dict([('one',1),('two',2)]) # Construct a dict from an item list
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
200 dict('one'=1, 'two'=2) # Construct a dict using keyword args
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
201 dict.fromkeys(['one', 'keys']) # Construct a dict from a sequence
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
202
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
203 Operators and their evaluation order
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
204
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
205 Operators and their evaluation order
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
206 Highest Operator Comment
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
207 (...) [...] {...} `...` Tuple, list & dict. creation; string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
208 conv.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
209 s[i] s[i:j] s.attr f(...) indexing & slicing; attributes, fct
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
210 calls
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
211 +x, -x, ~x Unary operators
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
212 x**y Power
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
213 x*y x/y x%y x//y mult, division, modulo, floor division
35380
d682790d5db0 backport bug [ 1266296 ] Mistakes in decimal.Context.subtract documentation
Georg Brandl <georg@python.org>
parents: 33448
diff changeset
214 x+y x-y addition, subtraction
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
215 x<<y x>>y Bit shifting
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
216 x&y Bitwise and
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
217 x^y Bitwise exclusive or
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
218 x|y Bitwise or
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
219 x<y x<=y x>y x>=y x==y x!=y Comparison,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
220 x<>y identity,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
221 x is y x is not y membership
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
222 x in s x not in s
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
223 not x boolean negation
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
224 x and y boolean and
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
225 x or y boolean or
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
226 Lowest lambda args: expr anonymous function
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
227
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
228 Alternate names are defined in module operator (e.g. __add__ and add for +)
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
229 Most operators are overridable.
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
230
27383
5174b4a71e6e Part II of Python2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27377
diff changeset
231 Many binary operators also support augmented assignment:
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
232 x += 1 # Same as x = x + 1
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
233
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
234
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
235 Basic Types and Their Operations
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
236
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
237 Comparisons (defined between *any* types)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
238
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
239 Comparisons
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
240 Comparison Meaning Notes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
241 < strictly less than (1)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
242 <= less than or equal to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
243 > strictly greater than
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
244 >= greater than or equal to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
245 == equal to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
246 != or <> not equal to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
247 is object identity (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
248 is not negated object identity (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
249
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
250 Notes :
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
251 Comparison behavior can be overridden for a given class by defining special
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
252 method __cmp__.
33448
5570fae1f01c Typo fix: 'comparisions' is not a word
Andrew M. Kuchling <amk@amk.ca>
parents: 33373
diff changeset
253 The above comparisons return True or False which are of type bool
27383
5174b4a71e6e Part II of Python2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27377
diff changeset
254 (a subclass of int) and behave exactly as 1 or 0 except for their type and
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
255 that they print as True or False instead of 1 or 0.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
256 (1) X < Y < Z < W has expected meaning, unlike C
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
257 (2) Compare object identities (i.e. id(object)), not object values.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
258
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
259 Boolean values and operators
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
260
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
261 Boolean values and operators
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
262 Value or Operator Returns Notes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
263 None, numeric zeros, empty sequences and False
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
264 mappings
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
265 all other values True
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
266 not x True if x is False, else
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
267 True
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
268 x or y if x is False then y, else (1)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
269 x
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
270 x and y if x is False then x, else (1)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
271 y
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
272
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
273 Notes :
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
274 Truth testing behavior can be overridden for a given class by defining
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
275 special method __nonzero__.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
276 (1) Evaluate second arg only if necessary to determine outcome.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
277
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
278 None
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
279
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
280 None is used as default return value on functions. Built-in single object
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
281 with type NoneType.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
282 Input that evaluates to None does not print when running Python
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
283 interactively.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
284
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
285 Numeric types
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
286
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
287 Floats, integers and long integers.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
288
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
289 Floats are implemented with C doubles.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
290 Integers are implemented with C longs.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
291 Long integers have unlimited size (only limit is system resources)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
292
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
293 Operators on all numeric types
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
294
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
295 Operators on all numeric types
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
296 Operation Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
297 abs(x) the absolute value of x
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
298 int(x) x converted to integer
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
299 long(x) x converted to long integer
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
300 float(x) x converted to floating point
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
301 -x x negated
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
302 +x x unchanged
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
303 x + y the sum of x and y
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
304 x - y difference of x and y
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
305 x * y product of x and y
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
306 x / y quotient of x and y
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
307 x % y remainder of x / y
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
308 divmod(x, y) the tuple (x/y, x%y)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
309 x ** y x to the power y (the same as pow(x, y))
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
310
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
311 Bit operators on integers and long integers
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
312
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
313 Bit operators
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
314 Operation >Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
315 ~x the bits of x inverted
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
316 x ^ y bitwise exclusive or of x and y
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
317 x & y bitwise and of x and y
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
318 x | y bitwise or of x and y
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
319 x << n x shifted left by n bits
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
320 x >> n x shifted right by n bits
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
321
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
322 Complex Numbers
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
323
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
324 * represented as a pair of machine-level double precision floating point
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
325 numbers.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
326 * The real and imaginary value of a complex number z can be retrieved through
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
327 the attributes z.real and z.imag.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
328
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
329 Numeric exceptions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
330
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
331 TypeError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
332 raised on application of arithmetic operation to non-number
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
333 OverflowError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
334 numeric bounds exceeded
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
335 ZeroDivisionError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
336 raised when zero second argument of div or modulo op
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
337 FloatingPointError
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
338 raised when a floating point operation fails
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
339
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
340 Operations on all sequence types (lists, tuples, strings)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
341
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
342 Operations on all sequence types
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
343 Operation Result Notes
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
344 x in s True if an item of s is equal to x, else False
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
345 x not in s False if an item of s is equal to x, else True
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
346 for x in s: loops over the sequence
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
347 s + t the concatenation of s and t
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
348 s * n, n*s n copies of s concatenated
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
349 s[i] i'th item of s, origin 0 (1)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
350 s[i:j] slice of s from i (included) to j (excluded) (1), (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
351 len(s) length of s
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
352 min(s) smallest item of s
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
353 max(s) largest item of (s)
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
354 iter(s) returns an iterator over s. iterators define __iter__ and next()
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
355
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
356 Notes :
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
357 (1) if i or j is negative, the index is relative to the end of the string,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
358 ie len(s)+ i or len(s)+j is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
359 substituted. But note that -0 is still 0.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
360 (2) The slice of s from i to j is defined as the sequence of items with
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
361 index k such that i <= k < j.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
362 If i or j is greater than len(s), use len(s). If i is omitted, use
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
363 len(s). If i is greater than or
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
364 equal to j, the slice is empty.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
365
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
366 Operations on mutable (=modifiable) sequences (lists)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
367
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
368 Operations on mutable sequences
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
369 Operation Result Notes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
370 s[i] =x item i of s is replaced by x
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
371 s[i:j] = t slice of s from i to j is replaced by t
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
372 del s[i:j] same as s[i:j] = []
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
373 s.append(x) same as s[len(s) : len(s)] = [x]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
374 s.count(x) return number of i's for which s[i] == x
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
375 s.extend(x) same as s[len(s):len(s)]= x
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
376 s.index(x) return smallest i such that s[i] == x (1)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
377 s.insert(i, x) same as s[i:i] = [x] if i >= 0
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
378 s.pop([i]) same as x = s[i]; del s[i]; return x (4)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
379 s.remove(x) same as del s[s.index(x)] (1)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
380 s.reverse() reverse the items of s in place (3)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
381 s.sort([cmpFct]) sort the items of s in place (2), (3)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
382
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
383 Notes :
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
384 (1) raise a ValueError exception when x is not found in s (i.e. out of
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
385 range).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
386 (2) The sort() method takes an optional argument specifying a comparison
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
387 fct of 2 arguments (list items) which should
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
388 return -1, 0, or 1 depending on whether the 1st argument is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
389 considered smaller than, equal to, or larger than the 2nd
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
390 argument. Note that this slows the sorting process down considerably.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
391 (3) The sort() and reverse() methods modify the list in place for economy
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
392 of space when sorting or reversing a large list.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
393 They don't return the sorted or reversed list to remind you of this
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
394 side effect.
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
395 (4) [New 1.5.2] The optional argument i defaults to -1, so that by default the last
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
396 item is removed and returned.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
397
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
398
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
399
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
400 Operations on mappings (dictionaries)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
401
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
402 Operations on mappings
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
403 Operation Result Notes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
404 len(d) the number of items in d
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
405 d[k] the item of d with key k (1)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
406 d[k] = x set d[k] to x
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
407 del d[k] remove d[k] from d (1)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
408 d.clear() remove all items from d
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
409 d.copy() a shallow copy of d
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
410 d.get(k,defaultval) the item of d with key k (4)
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
411 d.has_key(k) True if d has key k, else False
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
412 d.items() a copy of d's list of (key, item) pairs (2)
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
413 d.iteritems() an iterator over (key, value) pairs (7)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
414 d.iterkeys() an iterator over the keys of d (7)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
415 d.itervalues() an iterator over the values of d (7)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
416 d.keys() a copy of d's list of keys (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
417 d1.update(d2) for k, v in d2.items(): d1[k] = v (3)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
418 d.values() a copy of d's list of values (2)
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
419 d.pop(k) remove d[k] and return its value
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
420 d.popitem() remove and return an arbitrary (6)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
421 (key, item) pair
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
422 d.setdefault(k,defaultval) the item of d with key k (5)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
423
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
424 Notes :
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
425 TypeError is raised if key is not acceptable
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
426 (1) KeyError is raised if key k is not in the map
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
427 (2) Keys and values are listed in random order
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
428 (3) d2 must be of the same type as d1
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
429 (4) Never raises an exception if k is not in the map, instead it returns
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
430 defaultVal.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
431 defaultVal is optional, when not provided and k is not in the map,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
432 None is returned.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
433 (5) Never raises an exception if k is not in the map, instead it returns
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
434 defaultVal, and adds k to map with value defaultVal. defaultVal is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
435 optional. When not provided and k is not in the map, None is returned and
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
436 added to map.
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
437 (6) Raises a KeyError if the dictionary is emtpy.
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
438 (7) While iterating over a dictionary, the values may be updated but
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
439 the keys cannot be changed.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
440
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
441 Operations on strings
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
442
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
443 Note that these string methods largely (but not completely) supersede the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
444 functions available in the string module.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
445
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
446
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
447 Operations on strings
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
448 Operation Result Notes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
449 s.capitalize() return a copy of s with only its first character
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
450 capitalized.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
451 s.center(width) return a copy of s centered in a string of length width (1)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
452 .
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
453 s.count(sub[ return the number of occurrences of substring sub in (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
454 ,start[,end]]) string s.
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
455 s.decode(([ return a decoded version of s. (3)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
456 encoding
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
457 [,errors]])
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
458 s.encode([ return an encoded version of s. Default encoding is the
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
459 encoding current default string encoding. (3)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
460 [,errors]])
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
461 s.endswith(suffix return true if s ends with the specified suffix, (2)
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
462 [,start[,end]]) otherwise return False.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
463 s.expandtabs([ return a copy of s where all tab characters are (4)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
464 tabsize]) expanded using spaces.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
465 s.find(sub[,start return the lowest index in s where substring sub is (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
466 [,end]]) found. Return -1 if sub is not found.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
467 s.index(sub[ like find(), but raise ValueError when the substring is (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
468 ,start[,end]]) not found.
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
469 s.isalnum() return True if all characters in s are alphanumeric, (5)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
470 False otherwise.
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
471 s.isalpha() return True if all characters in s are alphabetic, (5)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
472 False otherwise.
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
473 s.isdigit() return True if all characters in s are digit (5)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
474 characters, False otherwise.
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
475 s.islower() return True if all characters in s are lowercase, False (6)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
476 otherwise.
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
477 s.isspace() return True if all characters in s are whitespace (5)
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
478 characters, False otherwise.
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
479 s.istitle() return True if string s is a titlecased string, False (7)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
480 otherwise.
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
481 s.isupper() return True if all characters in s are uppercase, False (6)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
482 otherwise.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
483 s.join(seq) return a concatenation of the strings in the sequence
55049
74c0a78114ae Merged revisions 69846 via svnmerge from
Jesus Cea <jcea@jcea.es>
parents: 47252
diff changeset
484 seq, separated by 's's.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
485 s.ljust(width) return s left justified in a string of length width. (1),
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
486 (8)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
487 s.lower() return a copy of s converted to lowercase.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
488 s.lstrip() return a copy of s with leading whitespace removed.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
489 s.replace(old, return a copy of s with all occurrences of substring (9)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
490 new[, maxsplit]) old replaced by new.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
491 s.rfind(sub[ return the highest index in s where substring sub is (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
492 ,start[,end]]) found. Return -1 if sub is not found.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
493 s.rindex(sub[ like rfind(), but raise ValueError when the substring (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
494 ,start[,end]]) is not found.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
495 s.rjust(width) return s right justified in a string of length width. (1),
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
496 (8)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
497 s.rstrip() return a copy of s with trailing whitespace removed.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
498 s.split([sep[ return a list of the words in s, using sep as the (10)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
499 ,maxsplit]]) delimiter string.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
500 s.splitlines([ return a list of the lines in s, breaking at line (11)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
501 keepends]) boundaries.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
502 s.startswith return true if s starts with the specified prefix,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
503 (prefix[,start[ otherwise return false. (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
504 ,end]])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
505 s.strip() return a copy of s with leading and trailing whitespace
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
506 removed.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
507 s.swapcase() return a copy of s with uppercase characters converted
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
508 to lowercase and vice versa.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
509 return a titlecased copy of s, i.e. words start with
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
510 s.title() uppercase characters, all remaining cased characters
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
511 are lowercase.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
512 s.translate(table return a copy of s mapped through translation table (12)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
513 [,deletechars]) table.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
514 s.upper() return a copy of s converted to uppercase.
27383
5174b4a71e6e Part II of Python2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27377
diff changeset
515 s.zfill(width) return a string padded with zeroes on the left side and
27377
f3babaede189 Part I of an update for Python 2.3.
Raymond Hettinger <python@rcn.com>
parents: 19013
diff changeset
516 sliding a minus sign left if necessary. never truncates.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
517
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
518 Notes :
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
519 (1) Padding is done using spaces.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
520 (2) If optional argument start is supplied, substring s[start:] is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
521 processed. If optional arguments start and end are supplied, substring s[start:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
522 end] is processed.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
523 (3) Optional argument errors may be given to set a different error handling
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
524 scheme. The default for errors is 'strict', meaning that encoding errors raise
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
525 a ValueError. Other possible values are 'ignore' and 'replace'.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
526 (4) If optional argument tabsize is not given, a tab size of 8 characters
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
527 is assumed.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
528 (5) Returns false if string s does not contain at least one character.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
529 (6) Returns false if string s does not contain at least one cased
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
530 character.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
531 (7) A titlecased string is a string in which uppercase characters may only
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
532 follow uncased characters and lowercase characters only cased ones.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
533 (8) s is returned if width is less than len(s).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
534 (9) If the optional argument maxsplit is given, only the first maxsplit
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
535 occurrences are replaced.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
536 (10) If sep is not specified or None, any whitespace string is a separator.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
537 If maxsplit is given, at most maxsplit splits are done.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
538 (11) Line breaks are not included in the resulting list unless keepends is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
539 given and true.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
540 (12) table must be a string of length 256. All characters occurring in the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
541 optional argument deletechars are removed prior to translation.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
542
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
543 String formatting with the % operator
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
544
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
545 formatString % args--> evaluates to a string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
546
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
547 * formatString uses C printf format codes : %, c, s, i, d, u, o, x, X, e, E,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
548 f, g, G, r (details below).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
549 * Width and precision may be a * to specify that an integer argument gives
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
550 the actual width or precision.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
551 * The flag characters -, +, blank, # and 0 are understood. (details below)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
552 * %s will convert any type argument to string (uses str() function)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
553 * args may be a single arg or a tuple of args
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
554
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
555 '%s has %03d quote types.' % ('Python', 2) # => 'Python has 002 quote types.'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
556
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
557 * Right-hand-side can also be a mapping:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
558
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
559 a = '%(lang)s has %(c)03d quote types.' % {'c':2, 'lang':'Python}
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
560 (vars() function very handy to use on right-hand-side.)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
561
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
562 Format codes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
563 Conversion Meaning
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
564 d Signed integer decimal.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
565 i Signed integer decimal.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
566 o Unsigned octal.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
567 u Unsigned decimal.
45502
ade7ac88d2d0 Fix typo of hexidecimal
Neal Norwitz <nnorwitz@gmail.com>
parents: 41903
diff changeset
568 x Unsigned hexadecimal (lowercase).
ade7ac88d2d0 Fix typo of hexidecimal
Neal Norwitz <nnorwitz@gmail.com>
parents: 41903
diff changeset
569 X Unsigned hexadecimal (uppercase).
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
570 e Floating point exponential format (lowercase).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
571 E Floating point exponential format (uppercase).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
572 f Floating point decimal format.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
573 F Floating point decimal format.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
574 g Same as "e" if exponent is greater than -4 or less than precision,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
575 "f" otherwise.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
576 G Same as "E" if exponent is greater than -4 or less than precision,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
577 "F" otherwise.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
578 c Single character (accepts integer or single character string).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
579 r String (converts any python object using repr()).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
580 s String (converts any python object using str()).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
581 % No argument is converted, results in a "%" character in the result.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
582 (The complete specification is %%.)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
583
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
584 Conversion flag characters
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
585 Flag Meaning
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
586 # The value conversion will use the ``alternate form''.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
587 0 The conversion will be zero padded.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
588 - The converted value is left adjusted (overrides "-").
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
589 (a space) A blank should be left before a positive number (or empty
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
590 string) produced by a signed conversion.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
591 + A sign character ("+" or "-") will precede the conversion (overrides a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
592 "space" flag).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
593
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
594 File Objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
595
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
596 Created with built-in function open; may be created by other modules' functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
597 as well.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
598
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
599 Operators on file objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
600
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
601 File operations
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
602 Operation Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
603 f.close() Close file f.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
604 f.fileno() Get fileno (fd) for file f.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
605 f.flush() Flush file f's internal buffer.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
606 f.isatty() True if file f is connected to a tty-like dev, else False.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
607 f.read([size]) Read at most size bytes from file f and return as a string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
608 object. If size omitted, read to EOF.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
609 f.readline() Read one entire line from file f.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
610 f.readlines() Read until EOF with readline() and return list of lines read.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
611 Set file f's position, like "stdio's fseek()".
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
612 f.seek(offset[, whence == 0 then use absolute indexing.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
613 whence=0]) whence == 1 then offset relative to current pos.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
614 whence == 2 then offset relative to file end.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
615 f.tell() Return file f's current position (byte offset).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
616 f.write(str) Write string to file f.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
617 f.writelines(list Write list of strings to file f.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
618 )
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
619
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
620 File Exceptions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
621
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
622 EOFError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
623 End-of-file hit when reading (may be raised many times, e.g. if f is a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
624 tty).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
625 IOError
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
626 Other I/O-related I/O operation failure.
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
627 OSError
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
628 OS system call failed.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
629
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
630
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
631 Advanced Types
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
632
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
633 -See manuals for more details -
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
634 + Module objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
635 + Class objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
636 + Class instance objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
637 + Type objects (see module: types)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
638 + File objects (see above)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
639 + Slice objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
640 + XRange objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
641 + Callable types:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
642 o User-defined (written in Python):
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
643 # User-defined Function objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
644 # User-defined Method objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
645 o Built-in (written in C):
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
646 # Built-in Function objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
647 # Built-in Method objects
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
648 + Internal Types:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
649 o Code objects (byte-compile executable Python code: bytecode)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
650 o Frame objects (execution frames)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
651 o Traceback objects (stack trace of an exception)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
652
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
653
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
654 Statements
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
655
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
656 pass -- Null statement
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
657 del name[,name]* -- Unbind name(s) from object. Object will be indirectly
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
658 (and automatically) deleted only if no longer referenced.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
659 print [>> fileobject,] [s1 [, s2 ]* [,]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
660 -- Writes to sys.stdout, or to fileobject if supplied.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
661 Puts spaces between arguments. Puts newline at end
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
662 unless statement ends with comma.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
663 Print is not required when running interactively,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
664 simply typing an expression will print its value,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
665 unless the value is None.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
666 exec x [in globals [,locals]]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
667 -- Executes x in namespaces provided. Defaults
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
668 to current namespaces. x can be a string, file
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
669 object or a function object.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
670 callable(value,... [id=value], [*args], [**kw])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
671 -- Call function callable with parameters. Parameters can
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
672 be passed by name or be omitted if function
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
673 defines default values. E.g. if callable is defined as
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
674 "def callable(p1=1, p2=2)"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
675 "callable()" <=> "callable(1, 2)"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
676 "callable(10)" <=> "callable(10, 2)"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
677 "callable(p2=99)" <=> "callable(1, 99)"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
678 *args is a tuple of positional arguments.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
679 **kw is a dictionary of keyword arguments.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
680
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
681 Assignment operators
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
682
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
683 Caption
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
684 Operator Result Notes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
685 a = b Basic assignment - assign object b to label a (1)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
686 a += b Roughly equivalent to a = a + b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
687 a -= b Roughly equivalent to a = a - b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
688 a *= b Roughly equivalent to a = a * b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
689 a /= b Roughly equivalent to a = a / b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
690 a %= b Roughly equivalent to a = a % b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
691 a **= b Roughly equivalent to a = a ** b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
692 a &= b Roughly equivalent to a = a & b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
693 a |= b Roughly equivalent to a = a | b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
694 a ^= b Roughly equivalent to a = a ^ b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
695 a >>= b Roughly equivalent to a = a >> b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
696 a <<= b Roughly equivalent to a = a << b (2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
697
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
698 Notes :
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
699 (1) Can unpack tuples, lists, and strings.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
700 first, second = a[0:2]; [f, s] = range(2); c1,c2,c3='abc'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
701 Tip: x,y = y,x swaps x and y.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
702 (2) Not exactly equivalent - a is evaluated only once. Also, where
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
703 possible, operation performed in-place - a is modified rather than
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
704 replaced.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
705
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
706 Control Flow
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
707
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
708 if condition: suite
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
709 [elif condition: suite]*
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
710 [else: suite] -- usual if/else_if/else statement
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
711 while condition: suite
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
712 [else: suite]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
713 -- usual while statement. "else" suite is executed
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
714 after loop exits, unless the loop is exited with
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
715 "break"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
716 for element in sequence: suite
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
717 [else: suite]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
718 -- iterates over sequence, assigning each element to element.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
719 Use built-in range function to iterate a number of times.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
720 "else" suite executed at end unless loop exited
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
721 with "break"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
722 break -- immediately exits "for" or "while" loop
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
723 continue -- immediately does next iteration of "for" or "while" loop
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
724 return [result] -- Exits from function (or method) and returns result (use a tuple to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
725 return more than one value). If no result given, then returns None.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
726 yield result -- Freezes the execution frame of a generator and returns the result
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
727 to the iterator's .next() method. Upon the next call to next(),
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
728 resumes execution at the frozen point with all of the local variables
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
729 still intact.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
730
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
731 Exception Statements
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
732
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
733 assert expr[, message]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
734 -- expr is evaluated. if false, raises exception AssertionError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
735 with message. Inhibited if __debug__ is 0.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
736 try: suite1
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
737 [except [exception [, value]: suite2]+
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
738 [else: suite3]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
739 -- statements in suite1 are executed. If an exception occurs, look
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
740 in "except" clauses for matching <exception>. If matches or bare
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
741 "except" execute suite of that clause. If no exception happens
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
742 suite in "else" clause is executed after suite1.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
743 If exception has a value, it is put in value.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
744 exception can also be tuple of exceptions, e.g.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
745 "except (KeyError, NameError), val: print val"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
746 try: suite1
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
747 finally: suite2
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
748 -- statements in suite1 are executed. If no
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
749 exception, execute suite2 (even if suite1 is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
750 exited with a "return", "break" or "continue"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
751 statement). If exception did occur, executes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
752 suite2 and then immediately reraises exception.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
753 raise exception [,value [, traceback]]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
754 -- raises exception with optional value
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
755 value. Arg traceback specifies a traceback object to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
756 use when printing the exception's backtrace.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
757 raise -- a raise statement without arguments re-raises
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
758 the last exception raised in the current function
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
759 An exception is either a string (object) or a class instance.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
760 Can create a new one simply by creating a new string:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
761
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
762 my_exception = 'You did something wrong'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
763 try:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
764 if bad:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
765 raise my_exception, bad
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
766 except my_exception, value:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
767 print 'Oops', value
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
768
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
769 Exception classes must be derived from the predefined class: Exception, e.g.:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
770 class text_exception(Exception): pass
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
771 try:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
772 if bad:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
773 raise text_exception()
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
774 # This is a shorthand for the form
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
775 # "raise <class>, <instance>"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
776 except Exception:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
777 print 'Oops'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
778 # This will be printed because
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
779 # text_exception is a subclass of Exception
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
780 When an error message is printed for an unhandled exception which is a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
781 class, the class name is printed, then a colon and a space, and
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
782 finally the instance converted to a string using the built-in function
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
783 str().
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
784 All built-in exception classes derives from StandardError, itself
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
785 derived from Exception.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
786
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
787 Name Space Statements
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
788
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
789 [1.51: On Mac & Windows, the case of module file names must now match the case
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
790 as used
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
791 in the import statement]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
792 Packages (>1.5): a package is a name space which maps to a directory including
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
793 module(s) and the special initialization module '__init__.py'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
794 (possibly empty). Packages/dirs can be nested. You address a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
795 module's symbol via '[package.[package...]module.symbol's.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
796 import module1 [as name1] [, module2]*
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
797 -- imports modules. Members of module must be
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
798 referred to by qualifying with [package.]module name:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
799 "import sys; print sys.argv:"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
800 "import package1.subpackage.module; package1.subpackage.module.foo()"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
801 module1 renamed as name1, if supplied.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
802 from module import name1 [as othername1] [, name2]*
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
803 -- imports names from module module in current namespace.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
804 "from sys import argv; print argv"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
805 "from package1 import module; module.foo()"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
806 "from package1.module import foo; foo()"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
807 name1 renamed as othername1, if supplied.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
808 from module import *
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
809 -- imports all names in module, except those starting with "_";
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
810 *to be used sparsely, beware of name clashes* :
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
811 "from sys import *; print argv"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
812 "from package.module import *; print x'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
813 NB: "from package import *" only imports the symbols defined
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
814 in the package's __init__.py file, not those in the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
815 template modules!
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
816 global name1 [, name2]*
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
817 -- names are from global scope (usually meaning from module)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
818 rather than local (usually meaning only in function).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
819 -- E.g. in fct without "global" statements, assuming
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
820 "a" is name that hasn't been used in fct or module
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
821 so far:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
822 -Try to read from "a" -> NameError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
823 -Try to write to "a" -> creates "a" local to fcn
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
824 -If "a" not defined in fct, but is in module, then
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
825 -Try to read from "a", gets value from module
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
826 -Try to write to "a", creates "a" local to fct
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
827 But note "a[0]=3" starts with search for "a",
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
828 will use to global "a" if no local "a".
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
829
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
830 Function Definition
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
831
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
832 def func_id ([param_list]): suite
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
833 -- Creates a function object & binds it to name func_id.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
834
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
835 param_list ::= [id [, id]*]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
836 id ::= value | id = value | *id | **id
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
837 [Args are passed by value.Thus only args representing a mutable object
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
838 can be modified (are inout parameters). Use a tuple to return more than
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
839 one value]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
840
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
841 Example:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
842 def test (p1, p2 = 1+1, *rest, **keywords):
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
843 -- Parameters with "=" have default value (v is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
844 evaluated when function defined).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
845 If list has "*id" then id is assigned a tuple of
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
846 all remaining args passed to function (like C vararg)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
847 If list has "**id" then id is assigned a dictionary of
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
848 all extra arguments passed as keywords.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
849
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
850 Class Definition
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
851
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
852 class <class_id> [(<super_class1> [,<super_class2>]*)]: <suite>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
853 -- Creates a class object and assigns it name <class_id>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
854 <suite> may contain local "defs" of class methods and
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
855 assignments to class attributes.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
856 Example:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
857 class my_class (class1, class_list[3]): ...
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
858 Creates a class object inheriting from both "class1" and whatever
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
859 class object "class_list[3]" evaluates to. Assigns new
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
860 class object to name "my_class".
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
861 - First arg to class methods is always instance object, called 'self'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
862 by convention.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
863 - Special method __init__() is called when instance is created.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
864 - Special method __del__() called when no more reference to object.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
865 - Create instance by "calling" class object, possibly with arg
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
866 (thus instance=apply(aClassObject, args...) creates an instance!)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
867 - In current implementation, can't subclass off built-in
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
868 classes. But can "wrap" them, see UserDict & UserList modules,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
869 and see __getattr__() below.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
870 Example:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
871 class c (c_parent):
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
872 def __init__(self, name): self.name = name
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
873 def print_name(self): print "I'm", self.name
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
874 def call_parent(self): c_parent.print_name(self)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
875 instance = c('tom')
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
876 print instance.name
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
877 'tom'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
878 instance.print_name()
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
879 "I'm tom"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
880 Call parent's super class by accessing parent's method
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
881 directly and passing "self" explicitly (see "call_parent"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
882 in example above).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
883 Many other special methods available for implementing
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
884 arithmetic operators, sequence, mapping indexing, etc.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
885
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
886 Documentation Strings
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
887
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
888 Modules, classes and functions may be documented by placing a string literal by
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
889 itself as the first statement in the suite. The documentation can be retrieved
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
890 by getting the '__doc__' attribute from the module, class or function.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
891 Example:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
892 class C:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
893 "A description of C"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
894 def __init__(self):
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
895 "A description of the constructor"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
896 # etc.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
897 Then c.__doc__ == "A description of C".
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
898 Then c.__init__.__doc__ == "A description of the constructor".
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
899
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
900 Others
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
901
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
902 lambda [param_list]: returnedExpr
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
903 -- Creates an anonymous function. returnedExpr must be
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
904 an expression, not a statement (e.g., not "if xx:...",
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
905 "print xxx", etc.) and thus can't contain newlines.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
906 Used mostly for filter(), map(), reduce() functions, and GUI callbacks..
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
907 List comprehensions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
908 result = [expression for item1 in sequence1 [if condition1]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
909 [for item2 in sequence2 ... for itemN in sequenceN]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
910 ]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
911 is equivalent to:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
912 result = []
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
913 for item1 in sequence1:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
914 for item2 in sequence2:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
915 ...
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
916 for itemN in sequenceN:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
917 if (condition1) and furthur conditions:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
918 result.append(expression)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
919
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
920
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
921
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
922 Built-In Functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
923
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
924 Built-In Functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
925 Function Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
926 __import__(name[, Imports module within the given context (see lib ref for
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
927 globals[, locals[, more details)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
928 fromlist]]])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
929 abs(x) Return the absolute value of number x.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
930 apply(f, args[, Calls func/method f with arguments args and optional
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
931 keywords]) keywords.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
932 bool(x) Returns True when the argument x is true and False otherwise.
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
933 buffer(obj) Creates a buffer reference to an object.
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
934 callable(x) Returns True if x callable, else False.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
935 chr(i) Returns one-character string whose ASCII code isinteger i
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
936 classmethod(f) Converts a function f, into a method with the class as the
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
937 first argument. Useful for creating alternative constructors.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
938 cmp(x,y) Returns negative, 0, positive if x <, ==, > to y
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
939 coerce(x,y) Returns a tuple of the two numeric arguments converted to a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
940 common type.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
941 Compiles string into a code object.filename is used in
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
942 error message, can be any string. It isusually the file
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
943 compile(string, from which the code was read, or eg. '<string>'if not read
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
944 filename, kind) from file.kind can be 'eval' if string is a single stmt, or
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
945 'single' which prints the output of expression statements
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
946 thatevaluate to something else than None, or be 'exec'.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
947 complex(real[, Builds a complex object (can also be done using J or j
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
948 image]) suffix,e.g. 1+3J)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
949 delattr(obj, name) deletes attribute named name of object obj <=> del obj.name
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
950 If no args, returns the list of names in current
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
951 dict([items]) Create a new dictionary from the specified item list.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
952 dir([object]) localsymbol table. With a module, class or class
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
953 instanceobject as arg, returns list of names in its attr.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
954 dict.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
955 divmod(a,b) Returns tuple of (a/b, a%b)
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
956 enumerate(seq) Return a iterator giving: (0, seq[0]), (1, seq[1]), ...
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
957 eval(s[, globals[, Eval string s in (optional) globals, locals contexts.s must
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
958 locals]]) have no NUL's or newlines. s can also be acode object.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
959 Example: x = 1; incr_x = eval('x + 1')
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
960 execfile(file[, Executes a file without creating a new module, unlike
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
961 globals[, locals]]) import.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
962 file() Synonym for open().
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
963 filter(function, Constructs a list from those elements of sequence for which
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
964 sequence) function returns true. function takes one parameter.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
965 float(x) Converts a number or a string to floating point.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
966 getattr(object, [<default> arg added in 1.5.2]Gets attribute called name
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
967 name[, default])) from object,e.g. getattr(x, 'f') <=> x.f). If not found,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
968 raisesAttributeError or returns default if specified.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
969 globals() Returns a dictionary containing current global variables.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
970 hasattr(object, Returns true if object has attr called name.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
971 name)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
972 hash(object) Returns the hash value of the object (if it has one)
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
973 help(f) Display documentation on object f.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
974 hex(x) Converts a number x to a hexadecimal string.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
975 id(object) Returns a unique 'identity' integer for an object.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
976 input([prompt]) Prints prompt if given. Reads input and evaluates it.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
977 Converts a number or a string to a plain integer. Optional
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
978 int(x[, base]) base paramenter specifies base from which to convert string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
979 values.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
980 intern(aString) Enters aString in the table of "interned strings"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
981 andreturns the string. Interned strings are 'immortals'.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
982 isinstance(obj, returns true if obj is an instance of class. Ifissubclass
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
983 class) (A,B) then isinstance(x,A) => isinstance(x,B)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
984 issubclass(class1, returns true if class1 is derived from class2
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
985 class2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
986 Returns the length (the number of items) of an object
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
987 iter(collection) Returns an iterator over the collection.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
988 len(obj) (sequence, dictionary, or instance of class implementing
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
989 __len__).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
990 list(sequence) Converts sequence into a list. If already a list,returns a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
991 copy of it.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
992 locals() Returns a dictionary containing current local variables.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
993 Converts a number or a string to a long integer. Optional
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
994 long(x[, base]) base paramenter specifies base from which to convert string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
995 values.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
996 Applies function to every item of list and returns a listof
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
997 map(function, list, the results. If additional arguments are passed,function
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
998 ...) must take that many arguments and it is givento function on
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
999 each call.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1000 max(seq) Returns the largest item of the non-empty sequence seq.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1001 min(seq) Returns the smallest item of a non-empty sequence seq.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1002 oct(x) Converts a number to an octal string.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1003 open(filename [, Returns a new file object. First two args are same asthose
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1004 mode='r', [bufsize= for C's "stdio open" function. bufsize is 0for unbuffered,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1005 implementation 1 for line-buffered, negative forsys-default, all else, of
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1006 dependent]]) (about) given size.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1007 ord(c) Returns integer ASCII value of c (a string of len 1). Works
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1008 with Unicode char.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1009 object() Create a base type. Used as a superclass for new-style objects.
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1010 open(name Open a file.
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1011 [, mode
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1012 [, buffering]])
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1013 pow(x, y [, z]) Returns x to power y [modulo z]. See also ** operator.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1014 property() Created a property with access controlled by functions.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1015 range(start [,end Returns list of ints from >= start and < end.With 1 arg,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1016 [, step]]) list from 0..arg-1With 2 args, list from start..end-1With 3
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1017 args, list from start up to end by step
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1018 raw_input([prompt]) Prints prompt if given, then reads string from stdinput (no
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1019 trailing \n). See also input().
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1020 reduce(f, list [, Applies the binary function f to the items oflist so as to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1021 init]) reduce the list to a single value.If init given, it is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1022 "prepended" to list.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1023 Re-parses and re-initializes an already imported module.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1024 Useful in interactive mode, if you want to reload amodule
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1025 reload(module) after fixing it. If module was syntacticallycorrect but had
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1026 an error in initialization, mustimport it one more time
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1027 before calling reload().
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1028 Returns a string containing a printable and if possible
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1029 repr(object) evaluable representation of an object. <=> `object`
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1030 (usingbackquotes). Class redefinissable (__repr__). See
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1031 also str()
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1032 round(x, n=0) Returns the floating point value x rounded to n digitsafter
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1033 the decimal point.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1034 setattr(object, This is the counterpart of getattr().setattr(o, 'foobar',
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1035 name, value) 3) <=> o.foobar = 3Creates attribute if it doesn't exist!
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1036 slice([start,] stop Returns a slice object representing a range, with R/
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1037 [, step]) Oattributes: start, stop, step.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1038 Returns a string containing a nicely
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1039 staticmethod() Convert a function to method with no self or class
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1040 argument. Useful for methods associated with a class that
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1041 do not need access to an object's internal state.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1042 str(object) printablerepresentation of an object. Class overridable
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1043 (__str__).See also repr().
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1044 super(type) Create an unbound super object. Used to call cooperative
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1045 superclass methods.
29829
09da9e56555d Update for new module and new builtin.
Raymond Hettinger <python@rcn.com>
parents: 29750
diff changeset
1046 sum(sequence, Add the values in the sequence and return the sum.
47248
9acb314b9072 Queue renaming reversal part 3: move module into place and
Georg Brandl <georg@python.org>
parents: 47241
diff changeset
1047 [start])
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1048 tuple(sequence) Creates a tuple with same elements as sequence. If already
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1049 a tuple, return itself (not a copy).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1050 Returns a type object [see module types] representing
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1051 thetype of obj. Example: import typesif type(x) ==
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1052 type(obj) types.StringType: print 'It is a string'NB: it is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1053 recommanded to use the following form:if isinstance(x,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1054 types.StringType): etc...
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1055 unichr(code) code.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1056 unicode(string[, Creates a Unicode string from a 8-bit string, using
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1057 encoding[, error thegiven encoding name and error treatment ('strict',
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1058 ]]]) 'ignore',or 'replace'}.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1059 Without arguments, returns a dictionary correspondingto the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1060 current local symbol table. With a module,class or class
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1061 vars([object]) instance object as argumentreturns a dictionary
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1062 corresponding to the object'ssymbol table. Useful with "%"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1063 formatting operator.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1064 xrange(start [, end Like range(), but doesn't actually store entire listall at
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1065 [, step]]) once. Good to use in "for" loops when there is abig range
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1066 and little memory.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1067 zip(seq1[, seq2, Returns a list of tuples where each tuple contains the nth
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1068 ...]) element of each of the argument sequences.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1069
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1070
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1071
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1072
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1073 Built-In Exceptions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1074
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1075 Exception>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1076 Root class for all exceptions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1077 SystemExit
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1078 On 'sys.exit()'
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1079 StopIteration
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1080 Signal the end from iterator.next()
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1081 StandardError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1082 Base class for all built-in exceptions; derived from Exception
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1083 root class.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1084 ArithmeticError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1085 Base class for OverflowError, ZeroDivisionError,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1086 FloatingPointError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1087 FloatingPointError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1088 When a floating point operation fails.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1089 OverflowError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1090 On excessively large arithmetic operation
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1091 ZeroDivisionError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1092 On division or modulo operation with 0 as 2nd arg
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1093 AssertionError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1094 When an assert statement fails.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1095 AttributeError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1096 On attribute reference or assignment failure
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1097 EnvironmentError [new in 1.5.2]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1098 On error outside Python; error arg tuple is (errno, errMsg...)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1099 IOError [changed in 1.5.2]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1100 I/O-related operation failure
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1101 OSError [new in 1.5.2]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1102 used by the os module's os.error exception.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1103 EOFError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1104 Immediate end-of-file hit by input() or raw_input()
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1105 ImportError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1106 On failure of `import' to find module or name
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1107 KeyboardInterrupt
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1108 On user entry of the interrupt key (often `Control-C')
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1109 LookupError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1110 base class for IndexError, KeyError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1111 IndexError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1112 On out-of-range sequence subscript
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1113 KeyError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1114 On reference to a non-existent mapping (dict) key
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1115 MemoryError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1116 On recoverable memory exhaustion
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1117 NameError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1118 On failure to find a local or global (unqualified) name
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1119 RuntimeError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1120 Obsolete catch-all; define a suitable error instead
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1121 NotImplementedError [new in 1.5.2]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1122 On method not implemented
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1123 SyntaxError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1124 On parser encountering a syntax error
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1125 IndentationError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1126 On parser encountering an indentation syntax error
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1127 TabError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1128 On parser encountering an indentation syntax error
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1129 SystemError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1130 On non-fatal interpreter error - bug - report it
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1131 TypeError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1132 On passing inappropriate type to built-in op or func
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1133 ValueError
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1134 On arg error not covered by TypeError or more precise
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1135 Warning
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1136 UserWarning
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1137 DeprecationWarning
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1138 PendingDeprecationWarning
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1139 SyntaxWarning
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1140 RuntimeWarning
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1141 FutureWarning
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1142
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1143
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1144
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1145 Standard methods & operators redefinition in classes
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1146
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1147 Standard methods & operators map to special '__methods__' and thus may be
56814
127d623396ab Merged revisions 73286,73294,73296,73459,73462-73463,73544,73576-73577,73595-73596,73693-73694,73704-73705,73707,73713,73937-73940,73945,73951,73979 via svnmerge from
Georg Brandl <georg@python.org>
parents: 55049
diff changeset
1148 redefined (mostly in user-defined classes), e.g.:
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1149 class x:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1150 def __init__(self, v): self.value = v
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1151 def __add__(self, r): return self.value + r
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1152 a = x(3) # sort of like calling x.__init__(a, 3)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1153 a + 4 # is equivalent to a.__add__(4)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1154
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1155 Special methods for any class
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1156
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1157 (s: self, o: other)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1158 __init__(s, args) instance initialization (on construction)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1159 __del__(s) called on object demise (refcount becomes 0)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1160 __repr__(s) repr() and `...` conversions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1161 __str__(s) str() and 'print' statement
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1162 __cmp__(s, o) Compares s to o and returns <0, 0, or >0.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1163 Implements >, <, == etc...
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1164 __hash__(s) Compute a 32 bit hash code; hash() and dictionary ops
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1165 __nonzero__(s) Returns False or True for truth value testing
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1166 __getattr__(s, name) called when attr lookup doesn't find <name>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1167 __setattr__(s, name, val) called when setting an attr
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1168 (inside, don't use "self.name = value"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1169 use "self.__dict__[name] = val")
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1170 __delattr__(s, name) called to delete attr <name>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1171 __call__(self, *args) called when an instance is called as function.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1172
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1173 Operators
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1174
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1175 See list in the operator module. Operator function names are provided with
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1176 2 variants, with or without
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1177 ading & trailing '__' (eg. __add__ or add).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1178
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1179 Numeric operations special methods
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1180 (s: self, o: other)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1181
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1182 s+o = __add__(s,o) s-o = __sub__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1183 s*o = __mul__(s,o) s/o = __div__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1184 s%o = __mod__(s,o) divmod(s,o) = __divmod__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1185 s**o = __pow__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1186 s&o = __and__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1187 s^o = __xor__(s,o) s|o = __or__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1188 s<<o = __lshift__(s,o) s>>o = __rshift__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1189 nonzero(s) = __nonzero__(s) (used in boolean testing)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1190 -s = __neg__(s) +s = __pos__(s)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1191 abs(s) = __abs__(s) ~s = __invert__(s) (bitwise)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1192 s+=o = __iadd__(s,o) s-=o = __isub__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1193 s*=o = __imul__(s,o) s/=o = __idiv__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1194 s%=o = __imod__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1195 s**=o = __ipow__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1196 s&=o = __iand__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1197 s^=o = __ixor__(s,o) s|=o = __ior__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1198 s<<=o = __ilshift__(s,o) s>>=o = __irshift__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1199 Conversions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1200 int(s) = __int__(s) long(s) = __long__(s)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1201 float(s) = __float__(s) complex(s) = __complex__(s)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1202 oct(s) = __oct__(s) hex(s) = __hex__(s)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1203 coerce(s,o) = __coerce__(s,o)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1204 Right-hand-side equivalents for all binary operators exist;
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1205 are called when class instance is on r-h-s of operator:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1206 a + 3 calls __add__(a, 3)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1207 3 + a calls __radd__(a, 3)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1208
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1209 All seqs and maps, general operations plus:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1210 (s: self, i: index or key)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1211
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1212 len(s) = __len__(s) length of object, >= 0. Length 0 == false
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1213 s[i] = __getitem__(s,i) Element at index/key i, origin 0
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1214
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1215 Sequences, general methods, plus:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1216 s[i]=v = __setitem__(s,i,v)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1217 del s[i] = __delitem__(s,i)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1218 s[i:j] = __getslice__(s,i,j)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1219 s[i:j]=seq = __setslice__(s,i,j,seq)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1220 del s[i:j] = __delslice__(s,i,j) == s[i:j] = []
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1221 seq * n = __repeat__(seq, n)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1222 s1 + s2 = __concat__(s1, s2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1223 i in s = __contains__(s, i)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1224 Mappings, general methods, plus
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1225 hash(s) = __hash__(s) - hash value for dictionary references
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1226 s[k]=v = __setitem__(s,k,v)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1227 del s[k] = __delitem__(s,k)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1228
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1229 Special informative state attributes for some types:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1230
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1231 Modules:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1232 __doc__ (string/None, R/O): doc string (<=> __dict__['__doc__'])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1233 __name__(string, R/O): module name (also in __dict__['__name__'])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1234 __dict__ (dict, R/O): module's name space
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1235 __file__(string/undefined, R/O): pathname of .pyc, .pyo or .pyd (undef for
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1236 modules statically linked to the interpreter)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1237
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1238 Classes: [in bold: writable since 1.5.2]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1239 __doc__ (string/None, R/W): doc string (<=> __dict__['__doc__'])
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1240 __module__ is the module name in which the class was defined
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1241 __name__(string, R/W): class name (also in __dict__['__name__'])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1242 __bases__ (tuple, R/W): parent classes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1243 __dict__ (dict, R/W): attributes (class name space)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1244
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1245 Instances:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1246 __class__ (class, R/W): instance's class
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1247 __dict__ (dict, R/W): attributes
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1248
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1249 User-defined functions: [bold: writable since 1.5.2]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1250 __doc__ (string/None, R/W): doc string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1251 __name__(string, R/O): function name
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1252 func_doc (R/W): same as __doc__
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1253 func_name (R/O): same as __name__
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1254 func_defaults (tuple/None, R/W): default args values if any
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1255 func_code (code, R/W): code object representing the compiled function body
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1256 func_globals (dict, R/O): ref to dictionary of func global variables
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1257 func_dict (dict, R/W): same as __dict__ contains the namespace supporting
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1258 arbitrary function attributes
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1259 func_closure (R/O): None or a tuple of cells that contain bindings
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1260 for the function's free variables.
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1261
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1262
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1263 User-defined Methods:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1264 __doc__ (string/None, R/O): doc string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1265 __name__(string, R/O): method name (same as im_func.__name__)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1266 im_class (class, R/O): class defining the method (may be a base class)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1267 im_self (instance/None, R/O): target instance object (None if unbound)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1268 im_func (function, R/O): function object
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1269
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1270 Built-in Functions & methods:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1271 __doc__ (string/None, R/O): doc string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1272 __name__ (string, R/O): function name
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1273 __self__ : [methods only] target object
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1274
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1275 Codes:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1276 co_name (string, R/O): function name
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1277 co_argcount (int, R/0): number of positional args
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1278 co_nlocals (int, R/O): number of local vars (including args)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1279 co_varnames (tuple, R/O): names of local vars (starting with args)
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1280 co_cellvars (tuple, R/O)) the names of local variables referenced by
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1281 nested functions
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1282 co_freevars (tuple, R/O)) names of free variables
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1283 co_code (string, R/O): sequence of bytecode instructions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1284 co_consts (tuple, R/O): litterals used by the bytecode, 1st one is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1285 fct doc (or None)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1286 co_names (tuple, R/O): names used by the bytecode
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1287 co_filename (string, R/O): filename from which the code was compiled
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1288 co_firstlineno (int, R/O): first line number of the function
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1289 co_lnotab (string, R/O): string encoding bytecode offsets to line numbers.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1290 co_stacksize (int, R/O): required stack size (including local vars)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1291 co_flags (int, R/O): flags for the interpreter
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1292 bit 2 set if fct uses "*arg" syntax
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1293 bit 3 set if fct uses '**keywords' syntax
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1294 Frames:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1295 f_back (frame/None, R/O): previous stack frame (toward the caller)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1296 f_code (code, R/O): code object being executed in this frame
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1297 f_locals (dict, R/O): local vars
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1298 f_globals (dict, R/O): global vars
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1299 f_builtins (dict, R/O): built-in (intrinsic) names
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1300 f_restricted (int, R/O): flag indicating whether fct is executed in
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1301 restricted mode
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1302 f_lineno (int, R/O): current line number
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1303 f_lasti (int, R/O): precise instruction (index into bytecode)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1304 f_trace (function/None, R/W): debug hook called at start of each source line
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1305 f_exc_type (Type/None, R/W): Most recent exception type
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1306 f_exc_value (any, R/W): Most recent exception value
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1307 f_exc_traceback (traceback/None, R/W): Most recent exception traceback
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1308 Tracebacks:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1309 tb_next (frame/None, R/O): next level in stack trace (toward the frame where
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1310 the exception occurred)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1311 tb_frame (frame, R/O): execution frame of the current level
35806
44fe157255bc fix typos, mostly in comments
Fred Drake <fdrake@acm.org>
parents: 35380
diff changeset
1312 tb_lineno (int, R/O): line number where the exception occurred
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1313 tb_lasti (int, R/O): precise instruction (index into bytecode)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1314
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1315 Slices:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1316 start (any/None, R/O): lowerbound
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1317 stop (any/None, R/O): upperbound
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1318 step (any/None, R/O): step value
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1319
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1320 Complex numbers:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1321 real (float, R/O): real part
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1322 imag (float, R/O): imaginary part
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1323
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1324
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1325 Important Modules
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1326
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1327 sys
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1328
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1329 Some sys variables
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1330 Variable Content
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1331 argv The list of command line arguments passed to aPython
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1332 script. sys.argv[0] is the script name.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1333 builtin_module_names A list of strings giving the names of all moduleswritten
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1334 in C that are linked into this interpreter.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1335 check_interval How often to check for thread switches or signals(measured
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1336 in number of virtual machine instructions)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1337 exc_type, exc_value, Deprecated since release 1.5. Use exc_info() instead.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1338 exc_traceback
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1339 exitfunc User can set to a parameterless fcn. It will getcalled
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1340 before interpreter exits.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1341 last_type, Set only when an exception not handled andinterpreter
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1342 last_value, prints an error. Used by debuggers.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1343 last_traceback
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1344 maxint maximum positive value for integers
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1345 modules Dictionary of modules that have already been loaded.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1346 path Search path for external modules. Can be modifiedby
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1347 program. sys.path[0] == dir of script executing
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1348 platform The current platform, e.g. "sunos5", "win32"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1349 ps1, ps2 prompts to use in interactive mode.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1350 File objects used for I/O. One can redirect byassigning a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1351 stdin, stdout, new file object to them (or any object:.with a method
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1352 stderr write(string) for stdout/stderr,.with a method readline()
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1353 for stdin)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1354 version string containing version info about Python interpreter.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1355 (and also: copyright, dllhandle, exec_prefix, prefix)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1356 version_info tuple containing Python version info - (major, minor,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1357 micro, level, serial).
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1358
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1359 Some sys functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1360 Function Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1361 exit(n) Exits with status n. Raises SystemExit exception.(Hence can
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1362 be caught and ignored by program)
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1363 getrefcount(object Returns the reference count of the object. Generally one
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1364 ) higher than you might expect, because of object arg temp
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1365 reference.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1366 setcheckinterval( Sets the interpreter's thread switching interval (in number
29750
b86446f0350f Correct documentation of check interval - it's 100 by default, not 10 any
Skip Montanaro <skip@pobox.com>
parents: 27389
diff changeset
1367 interval) of virtual code instructions, default:100).
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1368 settrace(func) Sets a trace function: called before each line ofcode is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1369 exited.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1370 setprofile(func) Sets a profile function for performance profiling.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1371 Info on exception currently being handled; this is atuple
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1372 (exc_type, exc_value, exc_traceback).Warning: assigning the
41903
06e6d6215c5b Fix typo in doc
Neal Norwitz <nnorwitz@gmail.com>
parents: 41832
diff changeset
1373 exc_info() traceback return value to a local variable in a
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1374 function handling an exception will cause a circular
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1375 reference.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1376 setdefaultencoding Change default Unicode encoding - defaults to 7-bit ASCII.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1377 (encoding)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1378 getrecursionlimit Retrieve maximum recursion depth.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1379 ()
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1380 setrecursionlimit Set maximum recursion depth. (Defaults to 1000.)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1381 ()
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1382
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1383
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1384
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1385 os
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1386 "synonym" for whatever O/S-specific module is proper for current environment.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1387 this module uses posix whenever possible.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1388 (see also M.A. Lemburg's utility http://www.lemburg.com/files/python/
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1389 platform.py)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1390
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1391 Some os variables
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1392 Variable Meaning
61258
f6785bce54b5 In a number of places code still revers
Ronald Oussoren <ronaldoussoren@mac.com>
parents: 56814
diff changeset
1393 name name of O/S-specific module (e.g. "posix", "nt")
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1394 path O/S-specific module for path manipulations.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1395 On Unix, os.path.split() <=> posixpath.split()
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1396 curdir string used to represent current directory ('.')
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1397 pardir string used to represent parent directory ('..')
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1398 sep string used to separate directories ('/' or '\'). Tip: use
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1399 os.path.join() to build portable paths.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1400 altsep Alternate sep
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1401 if applicable (None
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1402 otherwise)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1403 pathsep character used to separate search path components (as in
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1404 $PATH), eg. ';' for windows.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1405 linesep line separator as used in binary files, ie '\n' on Unix, '\
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1406 r\n' on Dos/Win, '\r'
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1407
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1408 Some os functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1409 Function Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1410 makedirs(path[, Recursive directory creation (create required intermediary
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1411 mode=0777]) dirs); os.error if fails.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1412 removedirs(path) Recursive directory delete (delete intermediary empty
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1413 dirs); if fails.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1414 renames(old, new) Recursive directory or file renaming; os.error if fails.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1415
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1416
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1417
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1418 posix
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1419 don't import this module directly, import os instead !
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1420 (see also module: shutil for file copy & remove fcts)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1421
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1422 posix Variables
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1423 Variable Meaning
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1424 environ dictionary of environment variables, e.g.posix.environ['HOME'].
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1425 error exception raised on POSIX-related error.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1426 Corresponding value is tuple of errno code and perror() string.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1427
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1428 Some posix functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1429 Function Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1430 chdir(path) Changes current directory to path.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1431 chmod(path, Changes the mode of path to the numeric mode
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1432 mode)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1433 close(fd) Closes file descriptor fd opened with posix.open.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1434 _exit(n) Immediate exit, with no cleanups, no SystemExit,etc. Should use
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1435 this to exit a child process.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1436 execv(p, args) "Become" executable p with args args
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1437 getcwd() Returns a string representing the current working directory
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1438 getpid() Returns the current process id
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1439 fork() Like C's fork(). Returns 0 to child, child pid to parent.[Not
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1440 on Windows]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1441 kill(pid, Like C's kill [Not on Windows]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1442 signal)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1443 listdir(path) Lists (base)names of entries in directory path, excluding '.'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1444 and '..'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1445 lseek(fd, pos, Sets current position in file fd to position pos, expressedas
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1446 how) an offset relative to beginning of file (how=0), tocurrent
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1447 position (how=1), or to end of file (how=2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1448 mkdir(path[, Creates a directory named path with numeric mode (default 0777)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1449 mode])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1450 open(file, Like C's open(). Returns file descriptor. Use file object
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1451 flags, mode) fctsrather than this low level ones.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1452 pipe() Creates a pipe. Returns pair of file descriptors (r, w) [Not on
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1453 Windows].
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1454 popen(command, Opens a pipe to or from command. Result is a file object to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1455 mode='r', read to orwrite from, as indicated by mode being 'r' or 'w'.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1456 bufSize=0) Use it to catch acommand output ('r' mode) or to feed it ('w'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1457 mode).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1458 remove(path) See unlink.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1459 rename(src, dst Renames/moves the file or directory src to dst. [error iftarget
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1460 ) name already exists]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1461 rmdir(path) Removes the empty directory path
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1462 read(fd, n) Reads n bytes from file descriptor fd and return as string.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1463 Returns st_mode, st_ino, st_dev, st_nlink, st_uid,st_gid,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1464 stat(path) st_size, st_atime, st_mtime, st_ctime.[st_ino, st_uid, st_gid
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1465 are dummy on Windows]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1466 system(command) Executes string command in a subshell. Returns exitstatus of
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1467 subshell (usually 0 means OK).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1468 Returns accumulated CPU times in sec (user, system, children's
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1469 times() user,children's sys, elapsed real time). [3 last not on
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1470 Windows]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1471 unlink(path) Unlinks ("deletes") the file (not dir!) path. same as: remove
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1472 utime(path, ( Sets the access & modified time of the file to the given tuple
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1473 aTime, mTime)) of values.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1474 wait() Waits for child process completion. Returns tuple ofpid,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1475 exit_status [Not on Windows]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1476 waitpid(pid, Waits for process pid to complete. Returns tuple ofpid,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1477 options) exit_status [Not on Windows]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1478 write(fd, str) Writes str to file fd. Returns nb of bytes written.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1479
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1480
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1481
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1482 posixpath
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1483 Do not import this module directly, import os instead and refer to this module
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1484 as os.path. (e.g. os.path.exists(p)) !
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1485
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1486 Some posixpath functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1487 Function Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1488 abspath(p) Returns absolute path for path p, taking current working dir in
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1489 account.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1490 dirname/
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1491 basename(p directory and name parts of the path p. See also split.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1492 )
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1493 exists(p) True if string p is an existing path (file or directory)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1494 expanduser Returns string that is (a copy of) p with "~" expansion done.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1495 (p)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1496 expandvars Returns string that is (a copy of) p with environment vars expanded.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1497 (p) [Windows: case significant; must use Unix: $var notation, not %var%]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1498 getsize( return the size in bytes of filename. raise os.error.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1499 filename)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1500 getmtime( return last modification time of filename (integer nb of seconds
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1501 filename) since epoch).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1502 getatime( return last access time of filename (integer nb of seconds since
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1503 filename) epoch).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1504 isabs(p) True if string p is an absolute path.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1505 isdir(p) True if string p is a directory.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1506 islink(p) True if string p is a symbolic link.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1507 ismount(p) True if string p is a mount point [true for all dirs on Windows].
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1508 join(p[,q Joins one or more path components intelligently.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1509 [,...]])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1510 Splits p into (head, tail) where tail is lastpathname component and
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1511 split(p) <head> is everything leadingup to that. <=> (dirname(p), basename
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1512 (p))
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1513 splitdrive Splits path p in a pair ('drive:', tail) [Windows]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1514 (p)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1515 splitext(p Splits into (root, ext) where last comp of root contains no periods
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1516 ) and ext is empty or startswith a period.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1517 Calls the function visit with arguments(arg, dirname, names) for
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1518 each directory recursively inthe directory tree rooted at p
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1519 walk(p, (including p itself if it's a dir)The argument dirname specifies the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1520 visit, arg visited directory, the argumentnames lists the files in the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1521 ) directory. The visit function maymodify names to influence the set
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1522 of directories visited belowdirname, e.g., to avoid visiting certain
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1523 parts of the tree.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1524
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1525
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1526
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1527 shutil
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1528 high-level file operations (copying, deleting).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1529
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1530 Main shutil functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1531 Function Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1532 copy(src, dst) Copies the contents of file src to file dst, retaining file
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1533 permissions.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1534 copytree(src, dst Recursively copies an entire directory tree rooted at src
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1535 [, symlinks]) into dst (which should not already exist). If symlinks is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1536 true, links insrc are kept as such in dst.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1537 rmtree(path[, Deletes an entire directory tree, ignoring errors if
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1538 ignore_errors[, ignore_errors true,or calling onerror(func, path,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1539 onerror]]) sys.exc_info()) if supplied with
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1540
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1541 (and also: copyfile, copymode, copystat, copy2)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1542
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1543 time
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1544
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1545 Variables
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1546 Variable Meaning
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1547 altzone signed offset of local DST timezone in sec west of the 0th meridian.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1548 daylight nonzero if a DST timezone is specified
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1549
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1550 Functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1551 Function Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1552 time() return a float representing UTC time in seconds since the epoch.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1553 gmtime(secs), return a tuple representing time : (year aaaa, month(1-12),day
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1554 localtime( (1-31), hour(0-23), minute(0-59), second(0-59), weekday(0-6, 0 is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1555 secs) monday), Julian day(1-366), daylight flag(-1,0 or 1))
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1556 asctime(
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1557 timeTuple),
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1558 strftime(
55049
74c0a78114ae Merged revisions 69846 via svnmerge from
Jesus Cea <jcea@jcea.es>
parents: 47252
diff changeset
1559 format, return a formatted string representing time.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1560 timeTuple)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1561 mktime(tuple) inverse of localtime(). Return a float.
55049
74c0a78114ae Merged revisions 69846 via svnmerge from
Jesus Cea <jcea@jcea.es>
parents: 47252
diff changeset
1562 strptime( parse a formatted string representing time, return tuple as in
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1563 string[, gmtime().
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1564 format])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1565 sleep(secs) Suspend execution for <secs> seconds. <secs> can be a float.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1566
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1567 and also: clock, ctime.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1568
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1569 string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1570
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1571 As of Python 2.0, much (though not all) of the functionality provided by the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1572 string module have been superseded by built-in string methods - see Operations
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1573 on strings for details.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1574
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1575 Some string variables
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1576 Variable Meaning
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1577 digits The string '0123456789'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1578 hexdigits, octdigits legal hexadecimal & octal digits
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1579 letters, uppercase, lowercase, Strings containing the appropriate
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1580 whitespace characters
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1581 index_error Exception raised by index() if substr not
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1582 found.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1583
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1584 Some string functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1585 Function Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1586 expandtabs(s, returns a copy of string <s> with tabs expanded.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1587 tabSize)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1588 find/rfind(s, sub Return the lowest/highest index in <s> where the substring
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1589 [, start=0[, end= <sub> is found such that <sub> is wholly contained ins
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1590 0]) [start:end]. Return -1 if <sub> not found.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1591 ljust/rjust/center Return a copy of string <s> left/right justified/centerd in
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1592 (s, width) afield of given width, padded with spaces. <s> is
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1593 nevertruncated.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1594 lower/upper(s) Return a string that is (a copy of) <s> in lowercase/
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1595 uppercase
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1596 split(s[, sep= Return a list containing the words of the string <s>,using
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1597 whitespace[, the string <sep> as a separator.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1598 maxsplit=0]])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1599 join(words[, sep=' Concatenate a list or tuple of words with
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1600 ']) interveningseparators; inverse of split.
35806
44fe157255bc fix typos, mostly in comments
Fred Drake <fdrake@acm.org>
parents: 35380
diff changeset
1601 replace(s, old, Returns a copy of string <s> with all occurrences of
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1602 new[, maxsplit=0] substring<old> replaced by <new>. Limits to <maxsplit>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1603 firstsubstitutions if specified.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1604 strip(s) Return a string that is (a copy of) <s> without leadingand
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1605 trailing whitespace. see also lstrip, rstrip.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1606
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1607
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1608
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1609 re (sre)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1610
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1611 Handles Unicode strings. Implemented in new module sre, re now a mere front-end
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1612 for compatibility.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1613 Patterns are specified as strings. Tip: Use raw strings (e.g. r'\w*') to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1614 litteralize backslashes.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1615
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1616
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1617 Regular expression syntax
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1618 Form Description
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1619 . matches any character (including newline if DOTALL flag specified)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1620 ^ matches start of the string (of every line in MULTILINE mode)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1621 $ matches end of the string (of every line in MULTILINE mode)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1622 * 0 or more of preceding regular expression (as many as possible)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1623 + 1 or more of preceding regular expression (as many as possible)
35806
44fe157255bc fix typos, mostly in comments
Fred Drake <fdrake@acm.org>
parents: 35380
diff changeset
1624 ? 0 or 1 occurrence of preceding regular expression
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1625 *?, +?, ?? Same as *, + and ? but matches as few characters as possible
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1626 {m,n} matches from m to n repetitions of preceding RE
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1627 {m,n}? idem, attempting to match as few repetitions as possible
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1628 [ ] defines character set: e.g. '[a-zA-Z]' to match all letters(see also
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1629 \w \S)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1630 [^ ] defines complemented character set: matches if char is NOT in set
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1631 escapes special chars '*?+&$|()' and introduces special sequences
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1632 \ (see below). Due to Python string rules, write as '\\' orr'\' in the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1633 pattern string.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1634 \\ matches a litteral '\'; due to Python string rules, write as '\\\\
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1635 'in pattern string, or better using raw string: r'\\'.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1636 | specifies alternative: 'foo|bar' matches 'foo' or 'bar'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1637 (...) matches any RE inside (), and delimits a group.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1638 (?:...) idem but doesn't delimit a group.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1639 matches if ... matches next, but doesn't consume any of the string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1640 (?=...) e.g. 'Isaac (?=Asimov)' matches 'Isaac' only if followed by
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1641 'Asimov'.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1642 (?!...) matches if ... doesn't match next. Negative of (?=...)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1643 (?P<name matches any RE inside (), and delimits a named group. (e.g. r'(?P
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1644 >...) <id>[a-zA-Z_]\w*)' defines a group named id)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1645 (?P=name) matches whatever text was matched by the earlier group named name.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1646 (?#...) A comment; ignored.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1647 (?letter) letter is one of 'i','L', 'm', 's', 'x'. Set the corresponding flags
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1648 (re.I, re.L, re.M, re.S, re.X) for the entire RE.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1649
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1650 Special sequences
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1651 Sequence Description
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1652 number matches content of the group of the same number; groups are numbered
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1653 starting from 1
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1654 \A matches only at the start of the string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1655 \b empty str at beg or end of word: '\bis\b' matches 'is', but not 'his'
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1656 \B empty str NOT at beginning or end of word
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1657 \d any decimal digit (<=> [0-9])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1658 \D any non-decimal digit char (<=> [^O-9])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1659 \s any whitespace char (<=> [ \t\n\r\f\v])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1660 \S any non-whitespace char (<=> [^ \t\n\r\f\v])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1661 \w any alphaNumeric char (depends on LOCALE flag)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1662 \W any non-alphaNumeric char (depends on LOCALE flag)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1663 \Z matches only at the end of the string
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1664
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1665 Variables
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1666 Variable Meaning
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1667 error Exception when pattern string isn't a valid regexp.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1668
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1669 Functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1670 Function Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1671 Compile a RE pattern string into a regular expression object.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1672 Flags (combinable by |):
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1673
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1674 I or IGNORECASE or (?i)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1675 case insensitive matching
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1676 compile( L or LOCALE or (?L)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1677 pattern[, make \w, \W, \b, \B dependent on thecurrent locale
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1678 flags=0]) M or MULTILINE or (?m)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1679 matches every new line and not onlystart/end of the whole
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1680 string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1681 S or DOTALL or (?s)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1682 '.' matches ALL chars, including newline
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1683 X or VERBOSE or (?x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1684 Ignores whitespace outside character sets
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1685 escape(string) return (a copy of) string with all non-alphanumerics
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1686 backslashed.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1687 match(pattern, if 0 or more chars at beginning of <string> match the RE pattern
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1688 string[, flags string,return a corresponding MatchObject instance, or None if
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1689 ]) no match.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1690 search(pattern scan thru <string> for a location matching <pattern>, return
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1691 , string[, acorresponding MatchObject instance, or None if no match.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1692 flags])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1693 split(pattern, split <string> by occurrences of <pattern>. If capturing () are
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1694 string[, used inpattern, then occurrences of patterns or subpatterns are
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1695 maxsplit=0]) also returned.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1696 findall( return a list of non-overlapping matches in <pattern>, either a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1697 pattern, list ofgroups or a list of tuples if the pattern has more than 1
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1698 string) group.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1699 return string obtained by replacing the (<count> first) lefmost
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1700 sub(pattern, non-overlapping occurrences of <pattern> (a string or a RE
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1701 repl, string[, object) in <string>by <repl>; <repl> can be a string or a fct
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1702 count=0]) called with a single MatchObj arg, which must return the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1703 replacement string.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1704 subn(pattern,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1705 repl, string[, same as sub(), but returns a tuple (newString, numberOfSubsMade)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1706 count=0])
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1707
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1708 Regular Expression Objects
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1709
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1710
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1711 (RE objects are returned by the compile fct)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1712
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1713 re object attributes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1714 Attribute Descrition
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1715 flags flags arg used when RE obj was compiled, or 0 if none provided
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1716 groupindex dictionary of {group name: group number} in pattern
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1717 pattern pattern string from which RE obj was compiled
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1718
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1719 re object methods
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1720 Method Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1721 If zero or more characters at the beginning of string match this
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1722 regular expression, return a corresponding MatchObject instance.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1723 Return None if the string does not match the pattern; note that
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1724 this is different from a zero-length match.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1725 The optional second parameter pos gives an index in the string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1726 match( where the search is to start; it defaults to 0. This is not
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1727 string[, completely equivalent to slicing the string; the '' pattern
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1728 pos][, character matches at the real beginning of the string and at
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1729 endpos]) positions just after a newline, but not necessarily at the index
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1730 where the search is to start.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1731 The optional parameter endpos limits how far the string will be
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1732 searched; it will be as if the string is endpos characters long, so
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1733 only the characters from pos to endpos will be searched for a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1734 match.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1735 Scan through string looking for a location where this regular
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1736 search( expression produces a match, and return a corresponding MatchObject
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1737 string[, instance. Return None if no position in the string matches the
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1738 pos][, pattern; note that this is different from finding a zero-length
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1739 endpos]) match at some point in the string.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1740 The optional pos and endpos parameters have the same meaning as for
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1741 the match() method.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1742 split(
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1743 string[, Identical to the split() function, using the compiled pattern.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1744 maxsplit=
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1745 0])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1746 findall( Identical to the findall() function, using the compiled pattern.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1747 string)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1748 sub(repl,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1749 string[, Identical to the sub() function, using the compiled pattern.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1750 count=0])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1751 subn(repl,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1752 string[, Identical to the subn() function, using the compiled pattern.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1753 count=0])
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1754
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1755 Match Objects
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1756
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1757
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1758 (Match objects are returned by the match & search functions)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1759
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1760 Match object attributes
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1761 Attribute Description
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1762 pos value of pos passed to search or match functions; index intostring at
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1763 which RE engine started search.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1764 endpos value of endpos passed to search or match functions; index intostring
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1765 beyond which RE engine won't go.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1766 re RE object whose match or search fct produced this MatchObj instance
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1767 string string passed to match() or search()
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1768
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1769 Match object functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1770 Function Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1771 returns one or more groups of the match. If one arg, result is a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1772 group([g1 string;if multiple args, result is a tuple with one item per arg. If
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1773 , g2, gi is 0,return value is entire matching string; if 1 <= gi <= 99,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1774 ...]) returnstring matching group #gi (or None if no such group); gi may
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1775 also bea group name.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1776 returns a tuple of all groups of the match; groups not
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1777 groups() participatingto the match have a value of None. Returns a string
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1778 instead of tupleif len(tuple)=1
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1779 start(
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1780 group), returns indices of start & end of substring matched by group (or
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1781 end(group Noneif group exists but doesn't contribute to the match)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1782 )
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1783 span( returns the 2-tuple (start(group), end(group)); can be (None, None)if
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1784 group) group didn't contibute to the match.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1785
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1786
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1787
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1788 math
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1789
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1790 Variables:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1791 pi
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1792 e
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1793 Functions (see ordinary C man pages for info):
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1794 acos(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1795 asin(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1796 atan(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1797 atan2(x, y)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1798 ceil(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1799 cos(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1800 cosh(x)
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1801 degrees(x)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1802 exp(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1803 fabs(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1804 floor(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1805 fmod(x, y)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1806 frexp(x) -- Unlike C: (float, int) = frexp(float)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1807 ldexp(x, y)
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1808 log(x [,base])
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1809 log10(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1810 modf(x) -- Unlike C: (float, float) = modf(float)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1811 pow(x, y)
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1812 radians(x)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1813 sin(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1814 sinh(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1815 sqrt(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1816 tan(x)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1817 tanh(x)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1818
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1819 getopt
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1820
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1821 Functions:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1822 getopt(list, optstr) -- Similar to C. <optstr> is option
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1823 letters to look for. Put ':' after letter
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1824 if option takes arg. E.g.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1825 # invocation was "python test.py -c hi -a arg1 arg2"
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1826 opts, args = getopt.getopt(sys.argv[1:], 'ab:c:')
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1827 # opts would be
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1828 [('-c', 'hi'), ('-a', '')]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1829 # args would be
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1830 ['arg1', 'arg2']
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1831
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1832
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1833 List of modules and packages in base distribution
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1834
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1835 (built-ins and content of python Lib directory)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1836 (Python NT distribution, may be slightly different in other distributions)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
1837
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1838 Standard library modules
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1839 Operation Result
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1840 aifc Stuff to parse AIFF-C and AIFF files.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1841 anydbm Generic interface to all dbm clones. (dbhash, gdbm,
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1842 dbm,dumbdbm)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1843 asynchat Support for 'chat' style protocols
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1844 asyncore Asynchronous File I/O (in select style)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1845 atexit Register functions to be called at exit of Python interpreter.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1846 audiodev Audio support for a few platforms.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1847 base64 Conversions to/from base64 RFC-MIME transport encoding .
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1848 BaseHTTPServer Base class forhttp services.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1849 Bastion "Bastionification" utility (control access to instance vars)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1850 bdb A generic Python debugger base class.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1851 binhex Macintosh binhex compression/decompression.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1852 bisect List bisection algorithms.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1853 bz2 Support for bz2 compression/decompression.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1854 calendar Calendar printing functions.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1855 cgi Wraps the WWW Forms Common Gateway Interface (CGI).
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1856 cgitb Utility for handling CGI tracebacks.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1857 CGIHTTPServer CGI http services.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1858 cmd A generic class to build line-oriented command interpreters.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1859 datetime Basic date and time types.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1860 code Utilities needed to emulate Python's interactive interpreter
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1861 codecs Lookup existing Unicode encodings and register new ones.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1862 colorsys Conversion functions between RGB and other color systems.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1863 commands Tools for executing UNIX commands .
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1864 compileall Force "compilation" of all .py files in a directory.
47252
e534ee0a4cd0 ConfigParser renaming reversal part 3: move module into place and adapt imports.
Georg Brandl <georg@python.org>
parents: 47248
diff changeset
1865 ConfigParser Configuration file parser (much like windows .ini files)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1866 copy Generic shallow and deep copying operations.
47189
f419b2e96a98 Revert copy_reg -> copyreg rename.
Georg Brandl <georg@python.org>
parents: 47108
diff changeset
1867 copy_reg Helper to provide extensibility for pickle/cPickle.
29829
09da9e56555d Update for new module and new builtin.
Raymond Hettinger <python@rcn.com>
parents: 29750
diff changeset
1868 csv Read and write files with comma separated values.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1869 dbhash (g)dbm-compatible interface to bsdhash.hashopen.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1870 dircache Sorted list of files in a dir, using a cache.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1871 [DEL:dircmp:DEL] [DEL:Defines a class to build directory diff tools on.:DEL]
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1872 difflib Tool for creating delta between sequences.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1873 dis Bytecode disassembler.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1874 distutils Package installation system.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1875 doctest Tool for running and verifying tests inside doc strings.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1876 dospath Common operations on DOS pathnames.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1877 dumbdbm A dumb and slow but simple dbm clone.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1878 [DEL:dump:DEL] [DEL:Print python code that reconstructs a variable.:DEL]
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1879 email Comprehensive support for internet email.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1880 exceptions Class based built-in exception hierarchy.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1881 filecmp File comparison.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1882 fileinput Helper class to quickly write a loop over all standard input
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1883 files.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1884 [DEL:find:DEL] [DEL:Find files directory hierarchy matching a pattern.:DEL]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1885 fnmatch Filename matching with shell patterns.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1886 formatter A test formatter.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1887 fpformat General floating point formatting functions.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1888 ftplib An FTP client class. Based on RFC 959.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1889 gc Perform garbacge collection, obtain GC debug stats, and tune
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1890 GC parameters.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1891 getopt Standard command line processing. See also ftp://
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1892 www.pauahtun.org/pub/getargspy.zip
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1893 getpass Utilities to get a password and/or the current user name.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1894 glob filename globbing.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1895 gopherlib Gopher protocol client interface.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1896 [DEL:grep:DEL] [DEL:'grep' utilities.:DEL]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1897 gzip Read & write gzipped files.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1898 heapq Priority queue implemented using lists organized as heaps.
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1899 HMAC Keyed-Hashing for Message Authentication -- RFC 2104.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1900 htmlentitydefs Proposed entity definitions for HTML.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1901 htmllib HTML parsing utilities.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1902 HTMLParser A parser for HTML and XHTML.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1903 httplib HTTP client class.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1904 ihooks Hooks into the "import" mechanism.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1905 imaplib IMAP4 client.Based on RFC 2060.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1906 imghdr Recognizing image files based on their first few bytes.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1907 imputil Privides a way of writing customised import hooks.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1908 inspect Tool for probing live Python objects.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1909 keyword List of Python keywords.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1910 knee A Python re-implementation of hierarchical module import.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1911 linecache Cache lines from files.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1912 linuxaudiodev Lunix /dev/audio support.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1913 locale Support for number formatting using the current locale
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1914 settings.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1915 logging Python logging facility.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1916 macpath Pathname (or related) operations for the Macintosh.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1917 macurl2path Mac specific module for conversion between pathnames and URLs.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1918 mailbox A class to handle a unix-style or mmdf-style mailbox.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1919 mailcap Mailcap file handling (RFC 1524).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1920 mhlib MH (mailbox) interface.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1921 mimetools Various tools used by MIME-reading or MIME-writing programs.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1922 mimetypes Guess the MIME type of a file.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1923 MimeWriter Generic MIME writer.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1924 mimify Mimification and unmimification of mail messages.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1925 mmap Interface to memory-mapped files - they behave like mutable
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1926 strings./font>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1927 multifile Class to make multi-file messages easier to handle.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1928 mutex Mutual exclusion -- for use with module sched.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1929 netrc
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1930 nntplib An NNTP client class. Based on RFC 977.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1931 ntpath Common operations on DOS pathnames.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1932 nturl2path Mac specific module for conversion between pathnames and URLs.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1933 optparse A comprehensive tool for processing command line options.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1934 os Either mac, dos or posix depending system.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1935 [DEL:packmail: [DEL:Create a self-unpacking shell archive.:DEL]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1936 DEL]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1937 pdb A Python debugger.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1938 pickle Pickling (save and restore) of Python objects (a faster
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1939 Cimplementation exists in built-in module: cPickle).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1940 pipes Conversion pipeline templates.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1941 pkgunil Utilities for working with Python packages.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1942 popen2 variations on pipe open.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1943 poplib A POP3 client class. Based on the J. Myers POP3 draft.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1944 posixfile Extended (posix) file operations.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1945 posixpath Common operations on POSIX pathnames.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1946 pprint Support to pretty-print lists, tuples, & dictionaries
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1947 recursively.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1948 profile Class for profiling python code.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1949 pstats Class for printing reports on profiled python code.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1950 pydoc Utility for generating documentation from source files.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1951 pty Pseudo terminal utilities.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1952 pyexpat Interface to the Expay XML parser.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1953 py_compile Routine to "compile" a .py file to a .pyc file.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1954 pyclbr Parse a Python file and retrieve classes and methods.
47248
9acb314b9072 Queue renaming reversal part 3: move module into place and
Georg Brandl <georg@python.org>
parents: 47241
diff changeset
1955 Queue A multi-producer, multi-consumer queue.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1956 quopri Conversions to/from quoted-printable transport encoding.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1957 rand Don't use unless you want compatibility with C's rand().
27383
5174b4a71e6e Part II of Python2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27377
diff changeset
1958 random Random variable generators
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1959 re Regular Expressions.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1960 repr Redo repr() but with limits on most sizes.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1961 rexec Restricted execution facilities ("safe" exec, eval, etc).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1962 rfc822 RFC-822 message manipulation class.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1963 rlcompleter Word completion for GNU readline 2.0.
31652
ef06c2124cb0 SF patch #911431: robot.txt must be robots.txt
Raymond Hettinger <python@rcn.com>
parents: 29829
diff changeset
1964 robotparser Parse robots.txt files, useful for web spiders.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1965 sched A generally useful event scheduler class.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1966 sets Module for a set datatype.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1967 sgmllib A parser for SGML.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1968 shelve Manage shelves of pickled objects.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1969 shlex Lexical analyzer class for simple shell-like syntaxes.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1970 shutil Utility functions usable in a shell-like program.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1971 SimpleHTTPServer Simple extension to base http class
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1972 site Append module search paths for third-party packages to
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1973 sys.path.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1974 smtplib SMTP Client class (RFC 821)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1975 sndhdr Several routines that help recognizing sound.
47241
ba1fa511b72d socketserver renaming reversal part 3: move the module into the right
Georg Brandl <georg@python.org>
parents: 47189
diff changeset
1976 SocketServer Generic socket server classes.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1977 stat Constants and functions for interpreting stat/lstat struct.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1978 statcache Maintain a cache of file stats.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1979 statvfs Constants for interpreting statvfs struct as returned by
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1980 os.statvfs()and os.fstatvfs() (if they exist).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1981 string A collection of string operations.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1982 StringIO File-like objects that read/write a string buffer (a fasterC
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1983 implementation exists in built-in module: cStringIO).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1984 sunau Stuff to parse Sun and NeXT audio files.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1985 sunaudio Interpret sun audio headers.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1986 symbol Non-terminal symbols of Python grammar (from "graminit.h").
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1987 tabnanny,/font> Check Python source for ambiguous indentation.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1988 tarfile Facility for reading and writing to the *nix tarfile format.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1989 telnetlib TELNET client class. Based on RFC 854.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1990 tempfile Temporary file name allocation.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
1991 textwrap Object for wrapping and filling text.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1992 threading Proposed new higher-level threading interfaces
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1993 threading_api (doc of the threading module)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1994 toaiff Convert "arbitrary" sound files to AIFF files .
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1995 token Tokens (from "token.h").
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1996 tokenize Compiles a regular expression that recognizes Python tokens.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1997 traceback Format and print Python stack traces.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1998 tty Terminal utilities.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
1999 turtle LogoMation-like turtle graphics
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2000 types Define names for all type symbols in the std interpreter.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2001 tzparse Parse a timezone specification.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2002 unicodedata Interface to unicode properties.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2003 urllib Open an arbitrary URL.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2004 urlparse Parse URLs according to latest draft of standard.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2005 user Hook to allow user-specified customization code to run.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2006 UserDict A wrapper to allow subclassing of built-in dict class.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2007 UserList A wrapper to allow subclassing of built-in list class.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2008 UserString A wrapper to allow subclassing of built-in string class.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2009 [DEL:util:DEL] [DEL:some useful functions that don't fit elsewhere !!:DEL]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2010 uu UUencode/UUdecode.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
2011 unittest Utilities for implementing unit testing.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2012 wave Stuff to parse WAVE files.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
2013 weakref Tools for creating and managing weakly referenced objects.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2014 webbrowser Platform independent URL launcher.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2015 [DEL:whatsound: [DEL:Several routines that help recognizing sound files.:DEL]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2016 DEL]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2017 whichdb Guess which db package to use to open a db file.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2018 xdrlib Implements (a subset of) Sun XDR (eXternal Data
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2019 Representation)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2020 xmllib A parser for XML, using the derived class as static DTD.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2021 xml.dom Classes for processing XML using the Document Object Model.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2022 xml.sax Classes for processing XML using the SAX API.
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
2023 xmlrpclib Support for remote procedure calls using XML.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2024 zipfile Read & write PK zipped files.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2025 [DEL:zmod:DEL] [DEL:Demonstration of abstruse mathematical concepts.:DEL]
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2026
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2027
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2028
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2029 * Built-ins *
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2030
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2031 sys Interpreter state vars and functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2032 __built-in__ Access to all built-in python identifiers
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2033 __main__ Scope of the interpreters main program, script or stdin
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2034 array Obj efficiently representing arrays of basic values
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2035 math Math functions of C standard
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
2036 time Time-related functions (also the newer datetime module)
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2037 marshal Read and write some python values in binary format
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2038 struct Convert between python values and C structs
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2039
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2040 * Standard *
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2041
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2042 getopt Parse cmd line args in sys.argv. A la UNIX 'getopt'.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2043 os A more portable interface to OS dependent functionality
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2044 re Functions useful for working with regular expressions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2045 string Useful string and characters functions and exceptions
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
2046 random Mersenne Twister pseudo-random number generator
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2047 thread Low-level primitives for working with process threads
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2048 threading idem, new recommanded interface.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2049
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2050 * Unix/Posix *
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2051
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2052 dbm Interface to Unix ndbm database library
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2053 grp Interface to Unix group database
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2054 posix OS functionality standardized by C and POSIX standards
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2055 posixpath POSIX pathname functions
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2056 pwd Access to the Unix password database
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2057 select Access to Unix select multiplex file synchronization
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2058 socket Access to BSD socket interface
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2059
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2060 * Tk User-interface Toolkit *
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2061
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2062 tkinter Main interface to Tk
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2063
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2064 * Multimedia *
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2065
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2066 audioop Useful operations on sound fragments
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2067 imageop Useful operations on images
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2068 jpeg Access to jpeg image compressor and decompressor
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2069 rgbimg Access SGI imglib image files
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2070
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2071 * Cryptographic Extensions *
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2072
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2073 md5 Interface to RSA's MD5 message digest algorithm
33373
76a9bda3028e Remove mpz, rotor
Andrew M. Kuchling <amk@amk.ca>
parents: 31652
diff changeset
2074 sha Interface to the SHA message digest algorithm
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
2075 HMAC Keyed-Hashing for Message Authentication -- RFC 2104.
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2076
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2077 * SGI IRIX * (4 & 5)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2078
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2079 al SGI audio facilities
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2080 AL al constants
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2081 fl Interface to FORMS library
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2082 FL fl constants
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2083 flp Functions for form designer
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2084 fm Access to font manager library
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2085 gl Access to graphics library
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2086 GL Constants for gl
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2087 DEVICE More constants for gl
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2088 imgfile Imglib image file interface
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2089
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2090 * Suns *
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2091
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2092 sunaudiodev Access to sun audio interface
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2093
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2094
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2095 Workspace exploration and idiom hints
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2096
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2097 dir(<module>) list functions, variables in <module>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2098 dir() get object keys, defaults to local name space
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2099 if __name__ == '__main__': main() invoke main if running as script
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2100 map(None, lst1, lst2, ...) merge lists
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2101 b = a[:] create copy of seq structure
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2102 _ in interactive mode, is last value printed
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2103
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2104
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2105
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2106
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2107
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2108
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2109
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2110 Python Mode for Emacs
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2111
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2112 (Not revised, possibly not up to date)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2113 Type C-c ? when in python-mode for extensive help.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2114 INDENTATION
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2115 Primarily for entering new code:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2116 TAB indent line appropriately
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2117 LFD insert newline, then indent
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2118 DEL reduce indentation, or delete single character
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2119 Primarily for reindenting existing code:
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2120 C-c : guess py-indent-offset from file content; change locally
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2121 C-u C-c : ditto, but change globally
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2122 C-c TAB reindent region to match its context
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2123 C-c < shift region left by py-indent-offset
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2124 C-c > shift region right by py-indent-offset
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2125 MARKING & MANIPULATING REGIONS OF CODE
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2126 C-c C-b mark block of lines
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2127 M-C-h mark smallest enclosing def
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2128 C-u M-C-h mark smallest enclosing class
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2129 C-c # comment out region of code
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2130 C-u C-c # uncomment region of code
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2131 MOVING POINT
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2132 C-c C-p move to statement preceding point
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2133 C-c C-n move to statement following point
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2134 C-c C-u move up to start of current block
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2135 M-C-a move to start of def
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2136 C-u M-C-a move to start of class
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2137 M-C-e move to end of def
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2138 C-u M-C-e move to end of class
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2139 EXECUTING PYTHON CODE
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2140 C-c C-c sends the entire buffer to the Python interpreter
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2141 C-c | sends the current region
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2142 C-c ! starts a Python interpreter window; this will be used by
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2143 subsequent C-c C-c or C-c | commands
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
2144 C-c C-w runs PyChecker
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
2145
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2146 VARIABLES
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2147 py-indent-offset indentation increment
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2148 py-block-comment-prefix comment string used by py-comment-region
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2149 py-python-command shell command to invoke Python interpreter
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2150 py-scroll-process-buffer t means always scroll Python process buffer
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2151 py-temp-directory directory used for temp files (if needed)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2152 py-beep-if-tab-change ring the bell if tab-width is changed
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2153
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2154
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2155 The Python Debugger
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2156
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2157 (Not revised, possibly not up to date, see 1.5.2 Library Ref section 9.1; in 1.5.2, you may also use debugger integrated in IDLE)
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2158
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2159 Accessing
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2160
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2161 import pdb (it's a module written in Python)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2162 -- defines functions :
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2163 run(statement[,globals[, locals]])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2164 -- execute statement string under debugger control, with optional
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2165 global & local environment.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2166 runeval(expression[,globals[, locals]])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2167 -- same as run, but evaluate expression and return value.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2168 runcall(function[, argument, ...])
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2169 -- run function object with given arg(s)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2170 pm() -- run postmortem on last exception (like debugging a core file)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2171 post_mortem(t)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2172 -- run postmortem on traceback object <t>
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2173
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2174 -- defines class Pdb :
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2175 use Pdb to create reusable debugger objects. Object
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2176 preserves state (i.e. break points) between calls.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2177
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2178 runs until a breakpoint hit, exception, or end of program
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2179 If exception, variable '__exception__' holds (exception,value).
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2180
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2181 Commands
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2182
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2183 h, help
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2184 brief reminder of commands
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2185 b, break [<arg>]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2186 if <arg> numeric, break at line <arg> in current file
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2187 if <arg> is function object, break on entry to fcn <arg>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2188 if no arg, list breakpoints
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2189 cl, clear [<arg>]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2190 if <arg> numeric, clear breakpoint at <arg> in current file
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2191 if no arg, clear all breakpoints after confirmation
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2192 w, where
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2193 print current call stack
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2194 u, up
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2195 move up one stack frame (to top-level caller)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2196 d, down
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2197 move down one stack frame
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2198 s, step
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2199 advance one line in the program, stepping into calls
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2200 n, next
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2201 advance one line, stepping over calls
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2202 r, return
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2203 continue execution until current function returns
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2204 (return value is saved in variable "__return__", which
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2205 can be printed or manipulated from debugger)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2206 c, continue
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2207 continue until next breakpoint
27389
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
2208 j, jump lineno
aa94c820b3ed Part 3 of Py2.3 update
Raymond Hettinger <python@rcn.com>
parents: 27383
diff changeset
2209 Set the next line that will be executed
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2210 a, args
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2211 print args to current function
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2212 rv, retval
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2213 prints return value from last function that returned
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2214 p, print <arg>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2215 prints value of <arg> in current stack frame
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2216 l, list [<first> [, <last>]]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2217 List source code for the current file.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2218 Without arguments, list 11 lines around the current line
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2219 or continue the previous listing.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2220 With one argument, list 11 lines starting at that line.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2221 With two arguments, list the given range;
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2222 if the second argument is less than the first, it is a count.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2223 whatis <arg>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2224 prints type of <arg>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2225 !
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2226 executes rest of line as a Python statement in the current stack frame
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2227 q quit
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2228 immediately stop execution and leave debugger
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2229 <return>
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2230 executes last command again
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2231 Any input debugger doesn't recognize as a command is assumed to be a
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2232 Python statement to execute in the current stack frame, the same way
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2233 the exclamation mark ("!") command does.
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2234
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2235 Example
1763
d3535d0626b4 Very useful file!
Guido van Rossum <guido@python.org>
parents:
diff changeset
2236
19013
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2237 (1394) python
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2238 Python 1.0.3 (Sep 26 1994)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2239 Copyright 1991-1994 Stichting Mathematisch Centrum, Amsterdam
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2240 >>> import rm
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2241 >>> rm.run()
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2242 Traceback (innermost last):
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2243 File "<stdin>", line 1
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2244 File "./rm.py", line 7
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2245 x = div(3)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2246 File "./rm.py", line 2
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2247 return a / r
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2248 ZeroDivisionError: integer division or modulo
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2249 >>> import pdb
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2250 >>> pdb.pm()
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2251 > ./rm.py(2)div: return a / r
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2252 (Pdb) list
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2253 1 def div(a):
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2254 2 -> return a / r
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2255 3
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2256 4 def run():
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2257 5 global r
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2258 6 r = 0
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2259 7 x = div(3)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2260 8 print x
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2261 [EOF]
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2262 (Pdb) print r
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2263 0
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2264 (Pdb) q
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2265 >>> pdb.runcall(rm.run)
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2266 etc.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2267
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2268 Quirks
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2269
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2270 Breakpoints are stored as filename, line number tuples. If a module is reloaded
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2271 after editing, any remembered breakpoints are likely to be wrong.
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2272
7d27e388ec6c Update cheatsheet to 2.0 from Brunning/Gruet's quick reference
Andrew M. Kuchling <amk@amk.ca>
parents: 1763
diff changeset
2273 Always single-steps through top-most stack frame. That is, "c" acts like "n".