Name	Size	Mode	Actions
2to3.rst.txt	14647	0644	editdlrm
abc.rst.txt	7219	0644	editdlrm
aepack.rst.txt	4257	0644	editdlrm
aetools.rst.txt	3532	0644	editdlrm
aetypes.rst.txt	4257	0644	editdlrm
aifc.rst.txt	7086	0644	editdlrm
al.rst.txt	5309	0644	editdlrm
allos.rst.txt	695	0644	editdlrm
anydbm.rst.txt	4111	0644	editdlrm
archiving.rst.txt	424	0644	editdlrm
argparse.rst.txt	74685	0644	editdlrm
array.rst.txt	10524	0644	editdlrm
ast.rst.txt	10111	0644	editdlrm
asynchat.rst.txt	9206	0644	editdlrm
asyncore.rst.txt	12937	0644	editdlrm
atexit.rst.txt	3910	0644	editdlrm
audioop.rst.txt	10395	0644	editdlrm
autogil.rst.txt	1015	0644	editdlrm
base64.rst.txt	6252	0644	editdlrm
basehttpserver.rst.txt	10404	0644	editdlrm
bastion.rst.txt	2611	0644	editdlrm
bdb.rst.txt	12456	0644	editdlrm
binascii.rst.txt	6508	0644	editdlrm
binhex.rst.txt	1910	0644	editdlrm
bisect.rst.txt	5415	0644	editdlrm
bsddb.rst.txt	7575	0644	editdlrm
bz2.rst.txt	8064	0644	editdlrm
calendar.rst.txt	11282	0644	editdlrm
carbon.rst.txt	15956	0644	editdlrm
cd.rst.txt	11974	0644	editdlrm
cgi.rst.txt	22853	0644	editdlrm
cgihttpserver.rst.txt	2788	0644	editdlrm
cgitb.rst.txt	2874	0644	editdlrm
chunk.rst.txt	4955	0644	editdlrm
cmath.rst.txt	7647	0644	editdlrm
cmd.rst.txt	8565	0644	editdlrm
code.rst.txt	7115	0644	editdlrm
codecs.rst.txt	66966	0644	editdlrm
codeop.rst.txt	3774	0644	editdlrm
collections.rst.txt	41448	0644	editdlrm
colorpicker.rst.txt	913	0644	editdlrm
colorsys.rst.txt	1819	0644	editdlrm
commands.rst.txt	2595	0644	editdlrm
compileall.rst.txt	4678	0644	editdlrm
compiler.rst.txt	37464	0644	editdlrm
configparser.rst.txt	19607	0644	editdlrm
constants.rst.txt	2328	0644	editdlrm
contextlib.rst.txt	6012	0644	editdlrm
cookie.rst.txt	9543	0644	editdlrm
cookielib.rst.txt	27875	0644	editdlrm
copy.rst.txt	3351	0644	editdlrm
copy_reg.rst.txt	2329	0644	editdlrm
crypt.rst.txt	2292	0644	editdlrm
crypto.rst.txt	355	0644	editdlrm
csv.rst.txt	22757	0644	editdlrm
ctypes.rst.txt	90513	0644	editdlrm
curses.ascii.rst.txt	9046	0644	editdlrm
curses.panel.rst.txt	2740	0644	editdlrm
curses.rst.txt	74877	0644	editdlrm
custominterp.rst.txt	570	0644	editdlrm
datatypes.rst.txt	864	0644	editdlrm
datetime.rst.txt	74679	0644	editdlrm
dbhash.rst.txt	3865	0644	editdlrm
dbm.rst.txt	3117	0644	editdlrm
debug.rst.txt	446	0644	editdlrm
decimal.rst.txt	70926	0644	editdlrm
development.rst.txt	640	0644	editdlrm
difflib.rst.txt	30716	0644	editdlrm
dircache.rst.txt	1813	0644	editdlrm
dis.rst.txt	23248	0644	editdlrm
distribution.rst.txt	426	0644	editdlrm
distutils.rst.txt	1958	0644	editdlrm
dl.rst.txt	3392	0644	editdlrm
doctest.rst.txt	73985	0644	editdlrm
docxmlrpcserver.rst.txt	3802	0644	editdlrm
dumbdbm.rst.txt	2841	0644	editdlrm
dummy_thread.rst.txt	1058	0644	editdlrm
dummy_threading.rst.txt	799	0644	editdlrm
easydialogs.rst.txt	10346	0644	editdlrm
email-examples.rst.txt	1271	0644	editdlrm
email.charset.rst.txt	9654	0644	editdlrm
email.encoders.rst.txt	2376	0644	editdlrm
email.errors.rst.txt	4006	0644	editdlrm
email.generator.rst.txt	6132	0644	editdlrm
email.header.rst.txt	7531	0644	editdlrm
email.iterators.rst.txt	2421	0644	editdlrm
email.message.rst.txt	25217	0644	editdlrm
email.mime.rst.txt	9917	0644	editdlrm
email.parser.rst.txt	10327	0644	editdlrm
email.rst.txt	16111	0644	editdlrm
email.utils.rst.txt	6475	0644	editdlrm
ensurepip.rst.txt	5022	0644	editdlrm
errno.rst.txt	6708	0644	editdlrm
exceptions.rst.txt	18343	0644	editdlrm
fcntl.rst.txt	7361	0644	editdlrm
filecmp.rst.txt	5348	0644	editdlrm
fileformats.rst.txt	302	0644	editdlrm
fileinput.rst.txt	7417	0644	editdlrm
filesys.rst.txt	806	0644	editdlrm
fl.rst.txt	17646	0644	editdlrm
fm.rst.txt	2699	0644	editdlrm
fnmatch.rst.txt	3104	0644	editdlrm
formatter.rst.txt	13245	0644	editdlrm
fpectl.rst.txt	4171	0644	editdlrm
fpformat.rst.txt	1747	0644	editdlrm
fractions.rst.txt	5297	0644	editdlrm
framework.rst.txt	11444	0644	editdlrm
frameworks.rst.txt	378	0644	editdlrm
ftplib.rst.txt	15720	0644	editdlrm
functions.rst.txt	75554	0644	editdlrm
functools.rst.txt	7448	0644	editdlrm
future_builtins.rst.txt	2010	0644	editdlrm
gc.rst.txt	9014	0644	editdlrm
gdbm.rst.txt	4882	0644	editdlrm
gensuitemodule.rst.txt	3113	0644	editdlrm
getopt.rst.txt	6670	0644	editdlrm
getpass.rst.txt	1876	0644	editdlrm
gettext.rst.txt	29040	0644	editdlrm
gl.rst.txt	6009	0644	editdlrm
glob.rst.txt	2414	0644	editdlrm
grp.rst.txt	2256	0644	editdlrm
gzip.rst.txt	4828	0644	editdlrm
hashlib.rst.txt	7379	0644	editdlrm
heapq.rst.txt	13185	0644	editdlrm
hmac.rst.txt	3073	0644	editdlrm
hotshot.rst.txt	4289	0644	editdlrm
htmllib.rst.txt	7379	0644	editdlrm
htmlparser.rst.txt	11640	0644	editdlrm
httplib.rst.txt	37454	0644	editdlrm
i18n.rst.txt	409	0644	editdlrm
ic.rst.txt	5005	0644	editdlrm
idle.rst.txt	22182	0644	editdlrm
imageop.rst.txt	4001	0644	editdlrm
imaplib.rst.txt	17221	0644	editdlrm
imgfile.rst.txt	2765	0644	editdlrm
imghdr.rst.txt	2635	0644	editdlrm
imp.rst.txt	12593	0644	editdlrm
importlib.rst.txt	1126	0644	editdlrm
imputil.rst.txt	7023	0644	editdlrm
index.rst.txt	2287	0644	editdlrm
inspect.rst.txt	28151	0644	editdlrm
internet.rst.txt	950	0644	editdlrm
intro.rst.txt	2803	0644	editdlrm
io.rst.txt	39015	0644	editdlrm
ipc.rst.txt	630	0644	editdlrm
itertools.rst.txt	36324	0644	editdlrm
jpeg.rst.txt	3858	0644	editdlrm
json.rst.txt	25545	0644	editdlrm
keyword.rst.txt	617	0644	editdlrm
language.rst.txt	523	0644	editdlrm
linecache.rst.txt	1887	0644	editdlrm
locale.rst.txt	24975	0644	editdlrm
logging.config.rst.txt	31560	0644	editdlrm
logging.handlers.rst.txt	28153	0644	editdlrm
logging.rst.txt	46882	0644	editdlrm
mac.rst.txt	791	0644	editdlrm
macos.rst.txt	3824	0644	editdlrm
macosa.rst.txt	3964	0644	editdlrm
macostools.rst.txt	4017	0644	editdlrm
macpath.rst.txt	650	0644	editdlrm
mailbox.rst.txt	68129	0644	editdlrm
mailcap.rst.txt	3675	0644	editdlrm
markup.rst.txt	1249	0644	editdlrm
marshal.rst.txt	5689	0644	editdlrm
math.rst.txt	10920	0644	editdlrm
md5.rst.txt	2815	0644	editdlrm
mhlib.rst.txt	3966	0644	editdlrm
mimetools.rst.txt	4504	0644	editdlrm
mimetypes.rst.txt	9839	0644	editdlrm
mimewriter.rst.txt	3360	0644	editdlrm
mimify.rst.txt	3519	0644	editdlrm
miniaeframe.rst.txt	2564	0644	editdlrm
misc.rst.txt	248	0644	editdlrm
mm.rst.txt	447	0644	editdlrm
mmap.rst.txt	10481	0644	editdlrm
modulefinder.rst.txt	3380	0644	editdlrm
modules.rst.txt	382	0644	editdlrm
msilib.rst.txt	19062	0644	editdlrm
msvcrt.rst.txt	4346	0644	editdlrm
multifile.rst.txt	6613	0644	editdlrm
multiprocessing.rst.txt	92621	0644	editdlrm
mutex.rst.txt	1939	0644	editdlrm
netdata.rst.txt	432	0644	editdlrm
netrc.rst.txt	3119	0644	editdlrm
new.rst.txt	2653	0644	editdlrm
nis.rst.txt	2108	0644	editdlrm
nntplib.rst.txt	14531	0644	editdlrm
numbers.rst.txt	8007	0644	editdlrm
numeric.rst.txt	751	0644	editdlrm
operator.rst.txt	22092	0644	editdlrm
optparse.rst.txt	77101	0644	editdlrm
os.path.rst.txt	13094	0644	editdlrm
os.rst.txt	82580	0644	editdlrm
ossaudiodev.rst.txt	17309	0644	editdlrm
othergui.rst.txt	2721	0644	editdlrm
parser.rst.txt	15385	0644	editdlrm
pdb.rst.txt	16043	0644	editdlrm
persistence.rst.txt	826	0644	editdlrm
pickle.rst.txt	37262	0644	editdlrm
pickletools.rst.txt	1997	0644	editdlrm
pipes.rst.txt	3786	0644	editdlrm
pkgutil.rst.txt	7714	0644	editdlrm
platform.rst.txt	9554	0644	editdlrm
plistlib.rst.txt	4134	0644	editdlrm
popen2.rst.txt	7022	0644	editdlrm
poplib.rst.txt	6220	0644	editdlrm
posix.rst.txt	3630	0644	editdlrm
posixfile.rst.txt	7200	0644	editdlrm
pprint.rst.txt	9071	0644	editdlrm
profile.rst.txt	28666	0644	editdlrm
pty.rst.txt	1762	0644	editdlrm
pwd.rst.txt	2725	0644	editdlrm
pyclbr.rst.txt	3296	0644	editdlrm
pydoc.rst.txt	4083	0644	editdlrm
pyexpat.rst.txt	28891	0644	editdlrm
python.rst.txt	514	0644	editdlrm
py_compile.rst.txt	2479	0644	editdlrm
queue.rst.txt	7034	0644	editdlrm
quopri.rst.txt	2670	0644	editdlrm
random.rst.txt	13319	0644	editdlrm
re.rst.txt	55102	0644	editdlrm
readline.rst.txt	10513	0644	editdlrm
repr.rst.txt	4718	0644	editdlrm
resource.rst.txt	9595	0644	editdlrm
restricted.rst.txt	3327	0644	editdlrm
rexec.rst.txt	11742	0644	editdlrm
rfc822.rst.txt	14037	0644	editdlrm
rlcompleter.rst.txt	2494	0644	editdlrm
robotparser.rst.txt	2190	0644	editdlrm
runpy.rst.txt	6938	0644	editdlrm
sched.rst.txt	4644	0644	editdlrm
scrolledtext.rst.txt	1379	0644	editdlrm
select.rst.txt	20705	0644	editdlrm
sets.rst.txt	14973	0644	editdlrm
sgi.rst.txt	322	0644	editdlrm
sgmllib.rst.txt	10664	0644	editdlrm
sha.rst.txt	2807	0644	editdlrm
shelve.rst.txt	8319	0644	editdlrm
shlex.rst.txt	11313	0644	editdlrm
shutil.rst.txt	13491	0644	editdlrm
signal.rst.txt	10719	0644	editdlrm
simplehttpserver.rst.txt	4559	0644	editdlrm
simplexmlrpcserver.rst.txt	10881	0644	editdlrm
site.rst.txt	7880	0644	editdlrm
smtpd.rst.txt	2464	0644	editdlrm
smtplib.rst.txt	14906	0644	editdlrm
sndhdr.rst.txt	1759	0644	editdlrm
socket.rst.txt	40765	0644	editdlrm
socketserver.rst.txt	22512	0644	editdlrm
someos.rst.txt	599	0644	editdlrm
spwd.rst.txt	2825	0644	editdlrm
sqlite3.rst.txt	35448	0644	editdlrm
ssl.rst.txt	76554	0644	editdlrm
stat.rst.txt	7778	0644	editdlrm
statvfs.rst.txt	1300	0644	editdlrm
stdtypes.rst.txt	122668	0644	editdlrm
string.rst.txt	44085	0644	editdlrm
stringio.rst.txt	4166	0644	editdlrm
stringprep.rst.txt	4238	0644	editdlrm
strings.rst.txt	746	0644	editdlrm
struct.rst.txt	17100	0644	editdlrm
subprocess.rst.txt	33648	0644	editdlrm
sun.rst.txt	249	0644	editdlrm
sunau.rst.txt	7124	0644	editdlrm
sunaudio.rst.txt	5849	0644	editdlrm
symbol.rst.txt	975	0644	editdlrm
symtable.rst.txt	5064	0644	editdlrm
sys.rst.txt	47520	0644	editdlrm
sysconfig.rst.txt	7639	0644	editdlrm
syslog.rst.txt	3931	0644	editdlrm
tabnanny.rst.txt	1999	0644	editdlrm
tarfile.rst.txt	28214	0644	editdlrm
telnetlib.rst.txt	7482	0644	editdlrm
tempfile.rst.txt	10504	0644	editdlrm
termios.rst.txt	3733	0644	editdlrm
test.rst.txt	17659	0644	editdlrm
textwrap.rst.txt	8552	0644	editdlrm
thread.rst.txt	6588	0644	editdlrm
threading.rst.txt	32468	0644	editdlrm
time.rst.txt	26020	0644	editdlrm
timeit.rst.txt	11598	0644	editdlrm
tix.rst.txt	22693	0644	editdlrm
tk.rst.txt	1612	0644	editdlrm
tkinter.rst.txt	33456	0644	editdlrm
token.rst.txt	2451	0644	editdlrm
tokenize.rst.txt	5570	0644	editdlrm
trace.rst.txt	6724	0644	editdlrm
traceback.rst.txt	10711	0644	editdlrm
ttk.rst.txt	57411	0644	editdlrm
tty.rst.txt	1011	0644	editdlrm
turtle.rst.txt	64097	0644	editdlrm
types.rst.txt	6200	0644	editdlrm
undoc.rst.txt	6550	0644	editdlrm
unicodedata.rst.txt	5736	0644	editdlrm
unittest.rst.txt	82952	0644	editdlrm
unix.rst.txt	490	0644	editdlrm
urllib.rst.txt	24960	0644	editdlrm
urllib2.rst.txt	35211	0644	editdlrm
urlparse.rst.txt	16071	0644	editdlrm
user.rst.txt	2748	0644	editdlrm
userdict.rst.txt	9290	0644	editdlrm
uu.rst.txt	2369	0644	editdlrm
uuid.rst.txt	8378	0644	editdlrm
warnings.rst.txt	19815	0644	editdlrm
wave.rst.txt	5047	0644	editdlrm
weakref.rst.txt	12926	0644	editdlrm
webbrowser.rst.txt	9863	0644	editdlrm
whichdb.rst.txt	931	0644	editdlrm
windows.rst.txt	273	0644	editdlrm
winsound.rst.txt	5066	0644	editdlrm
wsgiref.rst.txt	30567	0644	editdlrm
xdrlib.rst.txt	8077	0644	editdlrm
xml.dom.minidom.rst.txt	11208	0644	editdlrm
xml.dom.pulldom.rst.txt	1571	0644	editdlrm
xml.dom.rst.txt	40182	0644	editdlrm
xml.etree.elementtree.rst.txt	35707	0644	editdlrm
xml.rst.txt	6090	0644	editdlrm
xml.sax.handler.rst.txt	15371	0644	editdlrm
xml.sax.reader.rst.txt	12257	0644	editdlrm
xml.sax.rst.txt	6460	0644	editdlrm
xml.sax.utils.rst.txt	3560	0644	editdlrm
xmlrpclib.rst.txt	22559	0644	editdlrm
zipfile.rst.txt	18871	0644	editdlrm
zipimport.rst.txt	5957	0644	editdlrm
zlib.rst.txt	12766	0644	editdlrm
_winreg.rst.txt	23305	0644	editdlrm
__builtin__.rst.txt	1494	0644	editdlrm
__future__.rst.txt	4952	0644	editdlrm
__main__.rst.txt	535	0644	editdlrm

.. _compiler: *********************** Python compiler package *********************** .. deprecated:: 2.6 The :mod:`compiler` package has been removed in Python 3. .. sectionauthor:: Jeremy Hylton The Python compiler package is a tool for analyzing Python source code and generating Python bytecode. The compiler contains libraries to generate an abstract syntax tree from Python source code and to generate Python :term:`bytecode` from the tree. The :mod:`compiler` package is a Python source to bytecode translator written in Python. It uses the built-in parser and standard :mod:`parser` module to generate a concrete syntax tree. This tree is used to generate an abstract syntax tree (AST) and then Python bytecode. The full functionality of the package duplicates the built-in compiler provided with the Python interpreter. It is intended to match its behavior almost exactly. Why implement another compiler that does the same thing? The package is useful for a variety of purposes. It can be modified more easily than the built-in compiler. The AST it generates is useful for analyzing Python source code. This chapter explains how the various components of the :mod:`compiler` package work. It blends reference material with a tutorial. The basic interface =================== .. module:: compiler :synopsis: Python code compiler written in Python. :deprecated: The top-level of the package defines four functions. If you import :mod:`compiler`, you will get these functions and a collection of modules contained in the package. .. function:: parse(buf) Returns an abstract syntax tree for the Python source code in *buf*. The function raises :exc:`SyntaxError` if there is an error in the source code. The return value is a :class:`compiler.ast.Module` instance that contains the tree. .. function:: parseFile(path) Return an abstract syntax tree for the Python source code in the file specified by *path*. It is equivalent to ``parse(open(path).read())``. .. function:: walk(ast, visitor[, verbose]) Do a pre-order walk over the abstract syntax tree *ast*. Call the appropriate method on the *visitor* instance for each node encountered. .. function:: compile(source, filename, mode, flags=None, dont_inherit=None) Compile the string *source*, a Python module, statement or expression, into a code object that can be executed by the exec statement or :func:`eval`. This function is a replacement for the built-in :func:`compile` function. The *filename* will be used for run-time error messages. The *mode* must be 'exec' to compile a module, 'single' to compile a single (interactive) statement, or 'eval' to compile an expression. The *flags* and *dont_inherit* arguments affect future-related statements, but are not supported yet. .. function:: compileFile(source) Compiles the file *source* and generates a .pyc file. The :mod:`compiler` package contains the following modules: :mod:`ast`, :mod:`consts`, :mod:`future`, :mod:`misc`, :mod:`pyassem`, :mod:`pycodegen`, :mod:`symbols`, :mod:`transformer`, and :mod:`visitor`. Limitations =========== There are some problems with the error checking of the compiler package. The interpreter detects syntax errors in two distinct phases. One set of errors is detected by the interpreter's parser, the other set by the compiler. The compiler package relies on the interpreter's parser, so it get the first phases of error checking for free. It implements the second phase itself, and that implementation is incomplete. For example, the compiler package does not raise an error if a name appears more than once in an argument list: ``def f(x, x): ...`` A future version of the compiler should fix these problems. Python Abstract Syntax ====================== The :mod:`compiler.ast` module defines an abstract syntax for Python. In the abstract syntax tree, each node represents a syntactic construct. The root of the tree is :class:`Module` object. The abstract syntax offers a higher level interface to parsed Python source code. The :mod:`parser` module and the compiler written in C for the Python interpreter use a concrete syntax tree. The concrete syntax is tied closely to the grammar description used for the Python parser. Instead of a single node for a construct, there are often several levels of nested nodes that are introduced by Python's precedence rules. The abstract syntax tree is created by the :mod:`compiler.transformer` module. The transformer relies on the built-in Python parser to generate a concrete syntax tree. It generates an abstract syntax tree from the concrete tree. .. index:: single: Stein, Greg single: Tutt, Bill The :mod:`transformer` module was created by Greg Stein and Bill Tutt for an experimental Python-to-C compiler. The current version contains a number of modifications and improvements, but the basic form of the abstract syntax and of the transformer are due to Stein and Tutt. AST Nodes --------- .. module:: compiler.ast The :mod:`compiler.ast` module is generated from a text file that describes each node type and its elements. Each node type is represented as a class that inherits from the abstract base class :class:`compiler.ast.Node` and defines a set of named attributes for child nodes. .. class:: Node() The :class:`Node` instances are created automatically by the parser generator. The recommended interface for specific :class:`Node` instances is to use the public attributes to access child nodes. A public attribute may be bound to a single node or to a sequence of nodes, depending on the :class:`Node` type. For example, the :attr:`bases` attribute of the :class:`Class` node, is bound to a list of base class nodes, and the :attr:`doc` attribute is bound to a single node. Each :class:`Node` instance has a :attr:`lineno` attribute which may be ``None``. XXX Not sure what the rules are for which nodes will have a useful lineno. All :class:`Node` objects offer the following methods: .. method:: getChildren() Returns a flattened list of the child nodes and objects in the order they occur. Specifically, the order of the nodes is the order in which they appear in the Python grammar. Not all of the children are :class:`Node` instances. The names of functions and classes, for example, are plain strings. .. method:: getChildNodes() Returns a flattened list of the child nodes in the order they occur. This method is like :meth:`getChildren`, except that it only returns those children that are :class:`Node` instances. Two examples illustrate the general structure of :class:`Node` classes. The :keyword:`while` statement is defined by the following grammar production:: while_stmt: "while" expression ":" suite ["else" ":" suite] The :class:`While` node has three attributes: :attr:`test`, :attr:`body`, and :attr:`else_`. (If the natural name for an attribute is also a Python reserved word, it can't be used as an attribute name. An underscore is appended to the word to make it a legal identifier, hence :attr:`else_` instead of :keyword:`else`.) The :keyword:`if` statement is more complicated because it can include several tests. :: if_stmt: 'if' test ':' suite ('elif' test ':' suite)* ['else' ':' suite] The :class:`If` node only defines two attributes: :attr:`tests` and :attr:`else_`. The :attr:`tests` attribute is a sequence of test expression, consequent body pairs. There is one pair for each :keyword:`if`/:keyword:`elif` clause. The first element of the pair is the test expression. The second elements is a :class:`Stmt` node that contains the code to execute if the test is true. The :meth:`getChildren` method of :class:`If` returns a flat list of child nodes. If there are three :keyword:`if`/:keyword:`elif` clauses and no :keyword:`else` clause, then :meth:`getChildren` will return a list of six elements: the first test expression, the first :class:`Stmt`, the second text expression, etc. The following table lists each of the :class:`Node` subclasses defined in :mod:`compiler.ast` and each of the public attributes available on their instances. The values of most of the attributes are themselves :class:`Node` instances or sequences of instances. When the value is something other than an instance, the type is noted in the comment. The attributes are listed in the order in which they are returned by :meth:`getChildren` and :meth:`getChildNodes`. +-----------------------+--------------------+---------------------------------+ | Node type | Attribute | Value | +=======================+====================+=================================+ | :class:`Add` | :attr:`left` | left operand | +-----------------------+--------------------+---------------------------------+ | | :attr:`right` | right operand | +-----------------------+--------------------+---------------------------------+ | :class:`And` | :attr:`nodes` | list of operands | +-----------------------+--------------------+---------------------------------+ | :class:`AssAttr` | | *attribute as target of | | | | assignment* | +-----------------------+--------------------+---------------------------------+ | | :attr:`expr` | expression on the left-hand | | | | side of the dot | +-----------------------+--------------------+---------------------------------+ | | :attr:`attrname` | the attribute name, a string | +-----------------------+--------------------+---------------------------------+ | | :attr:`flags` | XXX | +-----------------------+--------------------+---------------------------------+ | :class:`AssList` | :attr:`nodes` | list of list elements being | | | | assigned to | +-----------------------+--------------------+---------------------------------+ | :class:`AssName` | :attr:`name` | name being assigned to | +-----------------------+--------------------+---------------------------------+ | | :attr:`flags` | XXX | +-----------------------+--------------------+---------------------------------+ | :class:`AssTuple` | :attr:`nodes` | list of tuple elements being | | | | assigned to | +-----------------------+--------------------+---------------------------------+ | :class:`Assert` | :attr:`test` | the expression to be tested | +-----------------------+--------------------+---------------------------------+ | | :attr:`fail` | the value of the | | | | :exc:`AssertionError` | +-----------------------+--------------------+---------------------------------+ | :class:`Assign` | :attr:`nodes` | a list of assignment targets, | | | | one per equal sign | +-----------------------+--------------------+---------------------------------+ | | :attr:`expr` | the value being assigned | +-----------------------+--------------------+---------------------------------+ | :class:`AugAssign` | :attr:`node` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`op` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | :class:`Backquote` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | :class:`Bitand` | :attr:`nodes` | | +-----------------------+--------------------+---------------------------------+ | :class:`Bitor` | :attr:`nodes` | | +-----------------------+--------------------+---------------------------------+ | :class:`Bitxor` | :attr:`nodes` | | +-----------------------+--------------------+---------------------------------+ | :class:`Break` | | | +-----------------------+--------------------+---------------------------------+ | :class:`CallFunc` | :attr:`node` | expression for the callee | +-----------------------+--------------------+---------------------------------+ | | :attr:`args` | a list of arguments | +-----------------------+--------------------+---------------------------------+ | | :attr:`star_args` | the extended \*-arg value | +-----------------------+--------------------+---------------------------------+ | | :attr:`dstar_args` | the extended \*\*-arg value | +-----------------------+--------------------+---------------------------------+ | :class:`Class` | :attr:`name` | the name of the class, a string | +-----------------------+--------------------+---------------------------------+ | | :attr:`bases` | a list of base classes | +-----------------------+--------------------+---------------------------------+ | | :attr:`doc` | doc string, a string or | | | | ``None`` | +-----------------------+--------------------+---------------------------------+ | | :attr:`code` | the body of the class statement | +-----------------------+--------------------+---------------------------------+ | :class:`Compare` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`ops` | | +-----------------------+--------------------+---------------------------------+ | :class:`Const` | :attr:`value` | | +-----------------------+--------------------+---------------------------------+ | :class:`Continue` | | | +-----------------------+--------------------+---------------------------------+ | :class:`Decorators` | :attr:`nodes` | List of function decorator | | | | expressions | +-----------------------+--------------------+---------------------------------+ | :class:`Dict` | :attr:`items` | | +-----------------------+--------------------+---------------------------------+ | :class:`Discard` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | :class:`Div` | :attr:`left` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`right` | | +-----------------------+--------------------+---------------------------------+ | :class:`Ellipsis` | | | +-----------------------+--------------------+---------------------------------+ | :class:`Expression` | :attr:`node` | | +-----------------------+--------------------+---------------------------------+ | :class:`Exec` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`locals` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`globals` | | +-----------------------+--------------------+---------------------------------+ | :class:`FloorDiv` | :attr:`left` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`right` | | +-----------------------+--------------------+---------------------------------+ | :class:`For` | :attr:`assign` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`list` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`body` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`else_` | | +-----------------------+--------------------+---------------------------------+ | :class:`From` | :attr:`modname` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`names` | | +-----------------------+--------------------+---------------------------------+ | :class:`Function` | :attr:`decorators` | :class:`Decorators` or ``None`` | +-----------------------+--------------------+---------------------------------+ | | :attr:`name` | name used in def, a string | +-----------------------+--------------------+---------------------------------+ | | :attr:`argnames` | list of argument names, as | | | | strings | +-----------------------+--------------------+---------------------------------+ | | :attr:`defaults` | list of default values | +-----------------------+--------------------+---------------------------------+ | | :attr:`flags` | xxx | +-----------------------+--------------------+---------------------------------+ | | :attr:`doc` | doc string, a string or | | | | ``None`` | +-----------------------+--------------------+---------------------------------+ | | :attr:`code` | the body of the function | +-----------------------+--------------------+---------------------------------+ | :class:`GenExpr` | :attr:`code` | | +-----------------------+--------------------+---------------------------------+ | :class:`GenExprFor` | :attr:`assign` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`iter` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`ifs` | | +-----------------------+--------------------+---------------------------------+ | :class:`GenExprIf` | :attr:`test` | | +-----------------------+--------------------+---------------------------------+ | :class:`GenExprInner` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`quals` | | +-----------------------+--------------------+---------------------------------+ | :class:`Getattr` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`attrname` | | +-----------------------+--------------------+---------------------------------+ | :class:`Global` | :attr:`names` | | +-----------------------+--------------------+---------------------------------+ | :class:`If` | :attr:`tests` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`else_` | | +-----------------------+--------------------+---------------------------------+ | :class:`Import` | :attr:`names` | | +-----------------------+--------------------+---------------------------------+ | :class:`Invert` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | :class:`Keyword` | :attr:`name` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | :class:`Lambda` | :attr:`argnames` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`defaults` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`flags` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`code` | | +-----------------------+--------------------+---------------------------------+ | :class:`LeftShift` | :attr:`left` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`right` | | +-----------------------+--------------------+---------------------------------+ | :class:`List` | :attr:`nodes` | | +-----------------------+--------------------+---------------------------------+ | :class:`ListComp` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`quals` | | +-----------------------+--------------------+---------------------------------+ | :class:`ListCompFor` | :attr:`assign` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`list` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`ifs` | | +-----------------------+--------------------+---------------------------------+ | :class:`ListCompIf` | :attr:`test` | | +-----------------------+--------------------+---------------------------------+ | :class:`Mod` | :attr:`left` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`right` | | +-----------------------+--------------------+---------------------------------+ | :class:`Module` | :attr:`doc` | doc string, a string or | | | | ``None`` | +-----------------------+--------------------+---------------------------------+ | | :attr:`node` | body of the module, a | | | | :class:`Stmt` | +-----------------------+--------------------+---------------------------------+ | :class:`Mul` | :attr:`left` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`right` | | +-----------------------+--------------------+---------------------------------+ | :class:`Name` | :attr:`name` | | +-----------------------+--------------------+---------------------------------+ | :class:`Not` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | :class:`Or` | :attr:`nodes` | | +-----------------------+--------------------+---------------------------------+ | :class:`Pass` | | | +-----------------------+--------------------+---------------------------------+ | :class:`Power` | :attr:`left` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`right` | | +-----------------------+--------------------+---------------------------------+ | :class:`Print` | :attr:`nodes` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`dest` | | +-----------------------+--------------------+---------------------------------+ | :class:`Printnl` | :attr:`nodes` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`dest` | | +-----------------------+--------------------+---------------------------------+ | :class:`Raise` | :attr:`expr1` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`expr2` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`expr3` | | +-----------------------+--------------------+---------------------------------+ | :class:`Return` | :attr:`value` | | +-----------------------+--------------------+---------------------------------+ | :class:`RightShift` | :attr:`left` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`right` | | +-----------------------+--------------------+---------------------------------+ | :class:`Slice` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`flags` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`lower` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`upper` | | +-----------------------+--------------------+---------------------------------+ | :class:`Sliceobj` | :attr:`nodes` | list of statements | +-----------------------+--------------------+---------------------------------+ | :class:`Stmt` | :attr:`nodes` | | +-----------------------+--------------------+---------------------------------+ | :class:`Sub` | :attr:`left` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`right` | | +-----------------------+--------------------+---------------------------------+ | :class:`Subscript` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`flags` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`subs` | | +-----------------------+--------------------+---------------------------------+ | :class:`TryExcept` | :attr:`body` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`handlers` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`else_` | | +-----------------------+--------------------+---------------------------------+ | :class:`TryFinally` | :attr:`body` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`final` | | +-----------------------+--------------------+---------------------------------+ | :class:`Tuple` | :attr:`nodes` | | +-----------------------+--------------------+---------------------------------+ | :class:`UnaryAdd` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | :class:`UnarySub` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | :class:`While` | :attr:`test` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`body` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`else_` | | +-----------------------+--------------------+---------------------------------+ | :class:`With` | :attr:`expr` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`vars` | | +-----------------------+--------------------+---------------------------------+ | | :attr:`body` | | +-----------------------+--------------------+---------------------------------+ | :class:`Yield` | :attr:`value` | | +-----------------------+--------------------+---------------------------------+ Assignment nodes ---------------- There is a collection of nodes used to represent assignments. Each assignment statement in the source code becomes a single :class:`Assign` node in the AST. The :attr:`nodes` attribute is a list that contains a node for each assignment target. This is necessary because assignment can be chained, e.g. ``a = b = 2``. Each :class:`Node` in the list will be one of the following classes: :class:`AssAttr`, :class:`AssList`, :class:`AssName`, or :class:`AssTuple`. Each target assignment node will describe the kind of object being assigned to: :class:`AssName` for a simple name, e.g. ``a = 1``. :class:`AssAttr` for an attribute assigned, e.g. ``a.x = 1``. :class:`AssList` and :class:`AssTuple` for list and tuple expansion respectively, e.g. ``a, b, c = a_tuple``. The target assignment nodes also have a :attr:`flags` attribute that indicates whether the node is being used for assignment or in a delete statement. The :class:`AssName` is also used to represent a delete statement, e.g. :class:`del x`. When an expression contains several attribute references, an assignment or delete statement will contain only one :class:`AssAttr` node -- for the final attribute reference. The other attribute references will be represented as :class:`Getattr` nodes in the :attr:`expr` attribute of the :class:`AssAttr` instance. Examples -------- This section shows several simple examples of ASTs for Python source code. The examples demonstrate how to use the :func:`parse` function, what the repr of an AST looks like, and how to access attributes of an AST node. The first module defines a single function. Assume it is stored in :file:`doublelib.py`. :: """This is an example module. This is the docstring. """ def double(x): "Return twice the argument" return x * 2 In the interactive interpreter session below, I have reformatted the long AST reprs for readability. The AST reprs use unqualified class names. If you want to create an instance from a repr, you must import the class names from the :mod:`compiler.ast` module. :: >>> import compiler >>> mod = compiler.parseFile("doublelib.py") >>> mod Module('This is an example module.\n\nThis is the docstring.\n', Stmt([Function(None, 'double', ['x'], [], 0, 'Return twice the argument', Stmt([Return(Mul((Name('x'), Const(2))))]))])) >>> from compiler.ast import * >>> Module('This is an example module.\n\nThis is the docstring.\n', ... Stmt([Function(None, 'double', ['x'], [], 0, ... 'Return twice the argument', ... Stmt([Return(Mul((Name('x'), Const(2))))]))])) Module('This is an example module.\n\nThis is the docstring.\n', Stmt([Function(None, 'double', ['x'], [], 0, 'Return twice the argument', Stmt([Return(Mul((Name('x'), Const(2))))]))])) >>> mod.doc 'This is an example module.\n\nThis is the docstring.\n' >>> for node in mod.node.nodes: ... print node ... Function(None, 'double', ['x'], [], 0, 'Return twice the argument', Stmt([Return(Mul((Name('x'), Const(2))))])) >>> func = mod.node.nodes[0] >>> func.code Stmt([Return(Mul((Name('x'), Const(2))))]) Using Visitors to Walk ASTs =========================== .. module:: compiler.visitor The visitor pattern is ... The :mod:`compiler` package uses a variant on the visitor pattern that takes advantage of Python's introspection features to eliminate the need for much of the visitor's infrastructure. The classes being visited do not need to be programmed to accept visitors. The visitor need only define visit methods for classes it is specifically interested in; a default visit method can handle the rest. XXX The magic :meth:`visit` method for visitors. .. function:: walk(tree, visitor[, verbose]) .. class:: ASTVisitor() The :class:`ASTVisitor` is responsible for walking over the tree in the correct order. A walk begins with a call to :meth:`preorder`. For each node, it checks the *visitor* argument to :meth:`preorder` for a method named 'visitNodeType,' where NodeType is the name of the node's class, e.g. for a :class:`While` node a :meth:`visitWhile` would be called. If the method exists, it is called with the node as its first argument. The visitor method for a particular node type can control how child nodes are visited during the walk. The :class:`ASTVisitor` modifies the visitor argument by adding a visit method to the visitor; this method can be used to visit a particular child node. If no visitor is found for a particular node type, the :meth:`default` method is called. :class:`ASTVisitor` objects have the following methods: XXX describe extra arguments .. method:: default(node[, ...]) .. method:: dispatch(node[, ...]) .. method:: preorder(tree, visitor) Bytecode Generation =================== The code generator is a visitor that emits bytecodes. Each visit method can call the :meth:`emit` method to emit a new bytecode. The basic code generator is specialized for modules, classes, and functions. An assembler converts that emitted instructions to the low-level bytecode format. It handles things like generation of constant lists of code objects and calculation of jump offsets.