/
usr
/
share
/
doc
/
python2-docs
/
html
/
library
/
/usr/share/doc/python2-docs/html/library
mkdir
upload
Name
Size
Mode
Actions
2to3.html
59507
0644
edit
dl
rm
abc.html
25826
0644
edit
dl
rm
aepack.html
14164
0644
edit
dl
rm
aetools.html
16389
0644
edit
dl
rm
aetypes.html
21021
0644
edit
dl
rm
aifc.html
25064
0644
edit
dl
rm
al.html
18672
0644
edit
dl
rm
allos.html
35297
0644
edit
dl
rm
anydbm.html
18124
0644
edit
dl
rm
archiving.html
10078
0644
edit
dl
rm
argparse.html
263616
0644
edit
dl
rm
array.html
31855
0644
edit
dl
rm
ast.html
38167
0644
edit
dl
rm
asynchat.html
33930
0644
edit
dl
rm
asyncore.html
40631
0644
edit
dl
rm
atexit.html
18455
0644
edit
dl
rm
audioop.html
34252
0644
edit
dl
rm
autogil.html
8733
0644
edit
dl
rm
base64.html
21862
0644
edit
dl
rm
basehttpserver.html
37441
0644
edit
dl
rm
bastion.html
11798
0644
edit
dl
rm
bdb.html
41395
0644
edit
dl
rm
binascii.html
22997
0644
edit
dl
rm
binhex.html
11309
0644
edit
dl
rm
bisect.html
24666
0644
edit
dl
rm
bsddb.html
28589
0644
edit
dl
rm
bz2.html
29048
0644
edit
dl
rm
calendar.html
41762
0644
edit
dl
rm
carbon.html
51998
0644
edit
dl
rm
cd.html
30033
0644
edit
dl
rm
cgi.html
55922
0644
edit
dl
rm
cgihttpserver.html
14026
0644
edit
dl
rm
cgitb.html
12263
0644
edit
dl
rm
chunk.html
15899
0644
edit
dl
rm
cmath.html
28365
0644
edit
dl
rm
cmd.html
29042
0644
edit
dl
rm
code.html
26959
0644
edit
dl
rm
codecs.html
118258
0644
edit
dl
rm
codeop.html
15898
0644
edit
dl
rm
collections.html
147647
0644
edit
dl
rm
colorpicker.html
8035
0644
edit
dl
rm
colorsys.html
11919
0644
edit
dl
rm
commands.html
15516
0644
edit
dl
rm
compileall.html
18621
0644
edit
dl
rm
compiler.html
75897
0644
edit
dl
rm
configparser.html
67751
0644
edit
dl
rm
constants.html
13979
0644
edit
dl
rm
contextlib.html
22777
0644
edit
dl
rm
cookie.html
41854
0644
edit
dl
rm
cookielib.html
91032
0644
edit
dl
rm
copy.html
13004
0644
edit
dl
rm
copy_reg.html
14691
0644
edit
dl
rm
crypt.html
10647
0644
edit
dl
rm
crypto.html
7761
0644
edit
dl
rm
csv.html
76456
0644
edit
dl
rm
ctypes.html
264575
0644
edit
dl
rm
curses.ascii.html
24873
0644
edit
dl
rm
curses.html
167501
0644
edit
dl
rm
curses.panel.html
15824
0644
edit
dl
rm
custominterp.html
8026
0644
edit
dl
rm
datatypes.html
18015
0644
edit
dl
rm
datetime.html
253438
0644
edit
dl
rm
dbhash.html
16825
0644
edit
dl
rm
dbm.html
13507
0644
edit
dl
rm
debug.html
10703
0644
edit
dl
rm
decimal.html
222315
0644
edit
dl
rm
development.html
14828
0644
edit
dl
rm
difflib.html
91975
0644
edit
dl
rm
dircache.html
12299
0644
edit
dl
rm
dis.html
84156
0644
edit
dl
rm
distribution.html
7679
0644
edit
dl
rm
distutils.html
10152
0644
edit
dl
rm
dl.html
17668
0644
edit
dl
rm
doctest.html
185883
0644
edit
dl
rm
docxmlrpcserver.html
17573
0644
edit
dl
rm
dumbdbm.html
15549
0644
edit
dl
rm
dummy_thread.html
10065
0644
edit
dl
rm
dummy_threading.html
8934
0644
edit
dl
rm
easydialogs.html
33124
0644
edit
dl
rm
email-examples.html
47424
0644
edit
dl
rm
email.charset.html
29424
0644
edit
dl
rm
email.encoders.html
12847
0644
edit
dl
rm
email.errors.html
17952
0644
edit
dl
rm
email.generator.html
23141
0644
edit
dl
rm
email.header.html
29108
0644
edit
dl
rm
email.html
55722
0644
edit
dl
rm
email.iterators.html
12623
0644
edit
dl
rm
email.message.html
70189
0644
edit
dl
rm
email.mime.html
31655
0644
edit
dl
rm
email.parser.html
35142
0644
edit
dl
rm
email.utils.html
27076
0644
edit
dl
rm
ensurepip.html
18327
0644
edit
dl
rm
errno.html
40246
0644
edit
dl
rm
exceptions.html
63693
0644
edit
dl
rm
fcntl.html
26245
0644
edit
dl
rm
filecmp.html
23997
0644
edit
dl
rm
fileformats.html
9653
0644
edit
dl
rm
fileinput.html
27071
0644
edit
dl
rm
filesys.html
10866
0644
edit
dl
rm
fl.html
56525
0644
edit
dl
rm
fm.html
13009
0644
edit
dl
rm
fnmatch.html
16258
0644
edit
dl
rm
formatter.html
37371
0644
edit
dl
rm
fpectl.html
16879
0644
edit
dl
rm
fpformat.html
11455
0644
edit
dl
rm
fractions.html
24888
0644
edit
dl
rm
framework.html
36934
0644
edit
dl
rm
frameworks.html
7551
0644
edit
dl
rm
ftplib.html
49577
0644
edit
dl
rm
functions.html
205640
0644
edit
dl
rm
functools.html
29645
0644
edit
dl
rm
future_builtins.html
14477
0644
edit
dl
rm
gc.html
28423
0644
edit
dl
rm
gdbm.html
17805
0644
edit
dl
rm
gensuitemodule.html
12574
0644
edit
dl
rm
getopt.html
25280
0644
edit
dl
rm
getpass.html
11426
0644
edit
dl
rm
gettext.html
84971
0644
edit
dl
rm
gl.html
24342
0644
edit
dl
rm
glob.html
14430
0644
edit
dl
rm
grp.html
11316
0644
edit
dl
rm
gzip.html
20576
0644
edit
dl
rm
hashlib.html
25467
0644
edit
dl
rm
heapq.html
34890
0644
edit
dl
rm
hmac.html
14374
0644
edit
dl
rm
hotshot.html
20147
0644
edit
dl
rm
htmllib.html
27682
0644
edit
dl
rm
htmlparser.html
42433
0644
edit
dl
rm
httplib.html
70932
0644
edit
dl
rm
i18n.html
10047
0644
edit
dl
rm
ic.html
18654
0644
edit
dl
rm
idle.html
42148
0644
edit
dl
rm
imageop.html
16099
0644
edit
dl
rm
imaplib.html
58515
0644
edit
dl
rm
imgfile.html
12732
0644
edit
dl
rm
imghdr.html
12238
0644
edit
dl
rm
imp.html
37603
0644
edit
dl
rm
importlib.html
8926
0644
edit
dl
rm
imputil.html
33563
0644
edit
dl
rm
index.html
79088
0644
edit
dl
rm
inspect.html
56823
0644
edit
dl
rm
internet.html
26138
0644
edit
dl
rm
intro.html
9353
0644
edit
dl
rm
io.html
113701
0644
edit
dl
rm
ipc.html
16598
0644
edit
dl
rm
itertools.html
125397
0644
edit
dl
rm
jpeg.html
13757
0644
edit
dl
rm
json.html
73678
0644
edit
dl
rm
keyword.html
8210
0644
edit
dl
rm
language.html
11687
0644
edit
dl
rm
linecache.html
11416
0644
edit
dl
rm
locale.html
61576
0644
edit
dl
rm
logging.config.html
80045
0644
edit
dl
rm
logging.handlers.html
80194
0644
edit
dl
rm
logging.html
110254
0644
edit
dl
rm
mac.html
23376
0644
edit
dl
rm
macos.html
16129
0644
edit
dl
rm
macosa.html
14080
0644
edit
dl
rm
macostools.html
16898
0644
edit
dl
rm
macpath.html
8386
0644
edit
dl
rm
mailbox.html
171121
0644
edit
dl
rm
mailcap.html
14132
0644
edit
dl
rm
markup.html
19862
0644
edit
dl
rm
marshal.html
19456
0644
edit
dl
rm
math.html
44015
0644
edit
dl
rm
md5.html
15123
0644
edit
dl
rm
mhlib.html
24123
0644
edit
dl
rm
mimetools.html
21206
0644
edit
dl
rm
mimetypes.html
30634
0644
edit
dl
rm
mimewriter.html
16078
0644
edit
dl
rm
mimify.html
15279
0644
edit
dl
rm
miniaeframe.html
13109
0644
edit
dl
rm
misc.html
7236
0644
edit
dl
rm
mm.html
9570
0644
edit
dl
rm
mmap.html
30832
0644
edit
dl
rm
modulefinder.html
18096
0644
edit
dl
rm
modules.html
9017
0644
edit
dl
rm
msilib.html
57853
0644
edit
dl
rm
msvcrt.html
21232
0644
edit
dl
rm
multifile.html
26256
0644
edit
dl
rm
multiprocessing.html
414535
0644
edit
dl
rm
mutex.html
12147
0644
edit
dl
rm
netdata.html
18379
0644
edit
dl
rm
netrc.html
14021
0644
edit
dl
rm
new.html
13177
0644
edit
dl
rm
nis.html
11502
0644
edit
dl
rm
nntplib.html
45689
0644
edit
dl
rm
numbers.html
40636
0644
edit
dl
rm
numeric.html
14292
0644
edit
dl
rm
operator.html
93622
0644
edit
dl
rm
optparse.html
250109
0644
edit
dl
rm
os.html
240195
0644
edit
dl
rm
os.path.html
43402
0644
edit
dl
rm
ossaudiodev.html
45594
0644
edit
dl
rm
othergui.html
9403
0644
edit
dl
rm
parser.html
42558
0644
edit
dl
rm
pdb.html
38603
0644
edit
dl
rm
persistence.html
15676
0644
edit
dl
rm
pickle.html
109684
0644
edit
dl
rm
pickletools.html
11475
0644
edit
dl
rm
pipes.html
19685
0644
edit
dl
rm
pkgutil.html
27367
0644
edit
dl
rm
platform.html
31599
0644
edit
dl
rm
plistlib.html
18344
0644
edit
dl
rm
popen2.html
27601
0644
edit
dl
rm
poplib.html
24320
0644
edit
dl
rm
posix.html
16626
0644
edit
dl
rm
posixfile.html
21387
0644
edit
dl
rm
pprint.html
32207
0644
edit
dl
rm
profile.html
72788
0644
edit
dl
rm
pty.html
10195
0644
edit
dl
rm
pwd.html
12388
0644
edit
dl
rm
pyclbr.html
15812
0644
edit
dl
rm
pydoc.html
13650
0644
edit
dl
rm
pyexpat.html
80886
0644
edit
dl
rm
python.html
12854
0644
edit
dl
rm
py_compile.html
11932
0644
edit
dl
rm
queue.html
26856
0644
edit
dl
rm
quopri.html
12739
0644
edit
dl
rm
random.html
42722
0644
edit
dl
rm
re.html
155985
0644
edit
dl
rm
readline.html
37383
0644
edit
dl
rm
repr.html
21778
0644
edit
dl
rm
resource.html
28286
0644
edit
dl
rm
restricted.html
12366
0644
edit
dl
rm
rexec.html
40566
0644
edit
dl
rm
rfc822.html
46408
0644
edit
dl
rm
rlcompleter.html
14460
0644
edit
dl
rm
robotparser.html
13403
0644
edit
dl
rm
runpy.html
21925
0644
edit
dl
rm
sched.html
19878
0644
edit
dl
rm
scrolledtext.html
9728
0644
edit
dl
rm
select.html
44090
0644
edit
dl
rm
sets.html
40151
0644
edit
dl
rm
sgi.html
10371
0644
edit
dl
rm
sgmllib.html
34464
0644
edit
dl
rm
sha.html
13062
0644
edit
dl
rm
shelve.html
29955
0644
edit
dl
rm
shlex.html
35033
0644
edit
dl
rm
shutil.html
45454
0644
edit
dl
rm
signal.html
34023
0644
edit
dl
rm
simplehttpserver.html
20351
0644
edit
dl
rm
simplexmlrpcserver.html
37794
0644
edit
dl
rm
site.html
26887
0644
edit
dl
rm
smtpd.html
13587
0644
edit
dl
rm
smtplib.html
47054
0644
edit
dl
rm
sndhdr.html
10993
0644
edit
dl
rm
socket.html
116414
0644
edit
dl
rm
socketserver.html
76430
0644
edit
dl
rm
someos.html
16472
0644
edit
dl
rm
spwd.html
11163
0644
edit
dl
rm
sqlite3.html
150014
0644
edit
dl
rm
ssl.html
202453
0644
edit
dl
rm
stat.html
34597
0644
edit
dl
rm
statvfs.html
11326
0644
edit
dl
rm
stdtypes.html
298144
0644
edit
dl
rm
string.html
120219
0644
edit
dl
rm
stringio.html
20061
0644
edit
dl
rm
stringprep.html
17729
0644
edit
dl
rm
strings.html
15905
0644
edit
dl
rm
struct.html
44896
0644
edit
dl
rm
subprocess.html
110447
0644
edit
dl
rm
sun.html
7253
0644
edit
dl
rm
sunau.html
30011
0644
edit
dl
rm
sunaudio.html
19236
0644
edit
dl
rm
symbol.html
8140
0644
edit
dl
rm
symtable.html
25871
0644
edit
dl
rm
sys.html
110996
0644
edit
dl
rm
sysconfig.html
26299
0644
edit
dl
rm
syslog.html
19737
0644
edit
dl
rm
tabnanny.html
11393
0644
edit
dl
rm
tarfile.html
88728
0644
edit
dl
rm
telnetlib.html
27782
0644
edit
dl
rm
tempfile.html
31903
0644
edit
dl
rm
termios.html
17309
0644
edit
dl
rm
test.html
57030
0644
edit
dl
rm
textwrap.html
30135
0644
edit
dl
rm
thread.html
21486
0644
edit
dl
rm
threading.html
86655
0644
edit
dl
rm
time.html
63798
0644
edit
dl
rm
timeit.html
40529
0644
edit
dl
rm
tix.html
50582
0644
edit
dl
rm
tk.html
26568
0644
edit
dl
rm
tkinter.html
84316
0644
edit
dl
rm
token.html
20999
0644
edit
dl
rm
tokenize.html
20607
0644
edit
dl
rm
trace.html
28668
0644
edit
dl
rm
traceback.html
40900
0644
edit
dl
rm
ttk.html
108515
0644
edit
dl
rm
tty.html
9753
0644
edit
dl
rm
turtle.html
230483
0644
edit
dl
rm
types.html
29833
0644
edit
dl
rm
undoc.html
24680
0644
edit
dl
rm
unicodedata.html
20186
0644
edit
dl
rm
unittest.html
225021
0644
edit
dl
rm
unix.html
11223
0644
edit
dl
rm
urllib.html
68266
0644
edit
dl
rm
urllib2.html
113380
0644
edit
dl
rm
urlparse.html
43474
0644
edit
dl
rm
user.html
12707
0644
edit
dl
rm
userdict.html
32069
0644
edit
dl
rm
uu.html
11810
0644
edit
dl
rm
uuid.html
30137
0644
edit
dl
rm
warnings.html
50950
0644
edit
dl
rm
wave.html
24894
0644
edit
dl
rm
weakref.html
38808
0644
edit
dl
rm
webbrowser.html
26565
0644
edit
dl
rm
whichdb.html
9499
0644
edit
dl
rm
windows.html
9817
0644
edit
dl
rm
winsound.html
20466
0644
edit
dl
rm
wsgiref.html
88384
0644
edit
dl
rm
xdrlib.html
33018
0644
edit
dl
rm
xml.dom.html
97877
0644
edit
dl
rm
xml.dom.minidom.html
43230
0644
edit
dl
rm
xml.dom.pulldom.html
13835
0644
edit
dl
rm
xml.etree.elementtree.html
111804
0644
edit
dl
rm
xml.html
18007
0644
edit
dl
rm
xml.sax.handler.html
41877
0644
edit
dl
rm
xml.sax.html
23458
0644
edit
dl
rm
xml.sax.reader.html
44802
0644
edit
dl
rm
xml.sax.utils.html
16087
0644
edit
dl
rm
xmlrpclib.html
69191
0644
edit
dl
rm
zipfile.html
62227
0644
edit
dl
rm
zipimport.html
22769
0644
edit
dl
rm
zlib.html
31230
0644
edit
dl
rm
_winreg.html
64631
0644
edit
dl
rm
__builtin__.html
11069
0644
edit
dl
rm
__future__.html
14688
0644
edit
dl
rm
__main__.html
7512
0644
edit
dl
rm
Edit:
/usr/share/doc/python2-docs/html/library/compiler.html
(75897B)
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>33. Python compiler package — Python 2.7.16 documentation</title> <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.16 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="next" title="34. Miscellaneous Services" href="misc.html" /> <link rel="prev" title="32.13. pickletools — Tools for pickle developers" href="pickletools.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <link rel="canonical" href="https://docs.python.org/2/library/compiler.html" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="misc.html" title="34. Miscellaneous Services" accesskey="N">next</a> |</li> <li class="right" > <a href="pickletools.html" title="32.13. pickletools — Tools for pickle developers" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.16 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">The Python Standard Library</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="python-compiler-package"> <span id="compiler"></span><h1>33. Python compiler package<a class="headerlink" href="#python-compiler-package" title="Permalink to this headline">¶</a></h1> <div class="deprecated"> <p><span class="versionmodified">Deprecated since version 2.6: </span>The <a class="reference internal" href="#module-compiler" title="compiler: Python code compiler written in Python. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler</span></code></a> package has been removed in Python 3.</p> </div> <p>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 <a class="reference internal" href="../glossary.html#term-bytecode"><span class="xref std std-term">bytecode</span></a> from the tree.</p> <p>The <a class="reference internal" href="#module-compiler" title="compiler: Python code compiler written in Python. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler</span></code></a> package is a Python source to bytecode translator written in Python. It uses the built-in parser and standard <a class="reference internal" href="parser.html#module-parser" title="parser: Access parse trees for Python source code."><code class="xref py py-mod docutils literal notranslate"><span class="pre">parser</span></code></a> module to generate a concrete syntax tree. This tree is used to generate an abstract syntax tree (AST) and then Python bytecode.</p> <p>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.</p> <p>This chapter explains how the various components of the <a class="reference internal" href="#module-compiler" title="compiler: Python code compiler written in Python. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler</span></code></a> package work. It blends reference material with a tutorial.</p> <div class="section" id="module-compiler"> <span id="the-basic-interface"></span><h2>33.1. The basic interface<a class="headerlink" href="#module-compiler" title="Permalink to this headline">¶</a></h2> <p>The top-level of the package defines four functions. If you import <a class="reference internal" href="#module-compiler" title="compiler: Python code compiler written in Python. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler</span></code></a>, you will get these functions and a collection of modules contained in the package.</p> <dl class="function"> <dt id="compiler.parse"> <code class="descclassname">compiler.</code><code class="descname">parse</code><span class="sig-paren">(</span><em>buf</em><span class="sig-paren">)</span><a class="headerlink" href="#compiler.parse" title="Permalink to this definition">¶</a></dt> <dd><p>Returns an abstract syntax tree for the Python source code in <em>buf</em>. The function raises <a class="reference internal" href="exceptions.html#exceptions.SyntaxError" title="exceptions.SyntaxError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">SyntaxError</span></code></a> if there is an error in the source code. The return value is a <code class="xref py py-class docutils literal notranslate"><span class="pre">compiler.ast.Module</span></code> instance that contains the tree.</p> </dd></dl> <dl class="function"> <dt id="compiler.parseFile"> <code class="descclassname">compiler.</code><code class="descname">parseFile</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#compiler.parseFile" title="Permalink to this definition">¶</a></dt> <dd><p>Return an abstract syntax tree for the Python source code in the file specified by <em>path</em>. It is equivalent to <code class="docutils literal notranslate"><span class="pre">parse(open(path).read())</span></code>.</p> </dd></dl> <dl class="function"> <dt id="compiler.walk"> <code class="descclassname">compiler.</code><code class="descname">walk</code><span class="sig-paren">(</span><em>ast</em>, <em>visitor</em><span class="optional">[</span>, <em>verbose</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#compiler.walk" title="Permalink to this definition">¶</a></dt> <dd><p>Do a pre-order walk over the abstract syntax tree <em>ast</em>. Call the appropriate method on the <em>visitor</em> instance for each node encountered.</p> </dd></dl> <dl class="function"> <dt id="compiler.compile"> <code class="descclassname">compiler.</code><code class="descname">compile</code><span class="sig-paren">(</span><em>source</em>, <em>filename</em>, <em>mode</em>, <em>flags=None</em>, <em>dont_inherit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#compiler.compile" title="Permalink to this definition">¶</a></dt> <dd><p>Compile the string <em>source</em>, a Python module, statement or expression, into a code object that can be executed by the exec statement or <a class="reference internal" href="functions.html#eval" title="eval"><code class="xref py py-func docutils literal notranslate"><span class="pre">eval()</span></code></a>. This function is a replacement for the built-in <a class="reference internal" href="functions.html#compile" title="compile"><code class="xref py py-func docutils literal notranslate"><span class="pre">compile()</span></code></a> function.</p> <p>The <em>filename</em> will be used for run-time error messages.</p> <p>The <em>mode</em> must be ‘exec’ to compile a module, ‘single’ to compile a single (interactive) statement, or ‘eval’ to compile an expression.</p> <p>The <em>flags</em> and <em>dont_inherit</em> arguments affect future-related statements, but are not supported yet.</p> </dd></dl> <dl class="function"> <dt id="compiler.compileFile"> <code class="descclassname">compiler.</code><code class="descname">compileFile</code><span class="sig-paren">(</span><em>source</em><span class="sig-paren">)</span><a class="headerlink" href="#compiler.compileFile" title="Permalink to this definition">¶</a></dt> <dd><p>Compiles the file <em>source</em> and generates a .pyc file.</p> </dd></dl> <p>The <a class="reference internal" href="#module-compiler" title="compiler: Python code compiler written in Python. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler</span></code></a> package contains the following modules: <a class="reference internal" href="ast.html#module-ast" title="ast: Abstract Syntax Tree classes and manipulation."><code class="xref py py-mod docutils literal notranslate"><span class="pre">ast</span></code></a>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">consts</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">future</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">misc</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">pyassem</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">pycodegen</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">symbols</span></code>, <code class="xref py py-mod docutils literal notranslate"><span class="pre">transformer</span></code>, and <code class="xref py py-mod docutils literal notranslate"><span class="pre">visitor</span></code>.</p> </div> <div class="section" id="limitations"> <h2>33.2. Limitations<a class="headerlink" href="#limitations" title="Permalink to this headline">¶</a></h2> <p>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: <code class="docutils literal notranslate"><span class="pre">def</span> <span class="pre">f(x,</span> <span class="pre">x):</span> <span class="pre">...</span></code></p> <p>A future version of the compiler should fix these problems.</p> </div> <div class="section" id="python-abstract-syntax"> <h2>33.3. Python Abstract Syntax<a class="headerlink" href="#python-abstract-syntax" title="Permalink to this headline">¶</a></h2> <p>The <a class="reference internal" href="#module-compiler.ast" title="compiler.ast"><code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler.ast</span></code></a> module defines an abstract syntax for Python. In the abstract syntax tree, each node represents a syntactic construct. The root of the tree is <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> object.</p> <p>The abstract syntax offers a higher level interface to parsed Python source code. The <a class="reference internal" href="parser.html#module-parser" title="parser: Access parse trees for Python source code."><code class="xref py py-mod docutils literal notranslate"><span class="pre">parser</span></code></a> 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.</p> <p>The abstract syntax tree is created by the <code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler.transformer</span></code> 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.</p> <p id="index-0">The <code class="xref py py-mod docutils literal notranslate"><span class="pre">transformer</span></code> 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.</p> <div class="section" id="module-compiler.ast"> <span id="ast-nodes"></span><h3>33.3.1. AST Nodes<a class="headerlink" href="#module-compiler.ast" title="Permalink to this headline">¶</a></h3> <p>The <a class="reference internal" href="#module-compiler.ast" title="compiler.ast"><code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler.ast</span></code></a> 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 <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">compiler.ast.Node</span></code></a> and defines a set of named attributes for child nodes.</p> <dl class="class"> <dt id="compiler.ast.Node"> <em class="property">class </em><code class="descclassname">compiler.ast.</code><code class="descname">Node</code><a class="headerlink" href="#compiler.ast.Node" title="Permalink to this definition">¶</a></dt> <dd><p>The <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> instances are created automatically by the parser generator. The recommended interface for specific <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> 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 <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> type. For example, the <code class="xref py py-attr docutils literal notranslate"><span class="pre">bases</span></code> attribute of the <code class="xref py py-class docutils literal notranslate"><span class="pre">Class</span></code> node, is bound to a list of base class nodes, and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">doc</span></code> attribute is bound to a single node.</p> <p>Each <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> instance has a <code class="xref py py-attr docutils literal notranslate"><span class="pre">lineno</span></code> attribute which may be <code class="docutils literal notranslate"><span class="pre">None</span></code>. XXX Not sure what the rules are for which nodes will have a useful lineno.</p> <p>All <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> objects offer the following methods:</p> <dl class="method"> <dt id="compiler.ast.Node.getChildren"> <code class="descname">getChildren</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compiler.ast.Node.getChildren" title="Permalink to this definition">¶</a></dt> <dd><p>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 <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> instances. The names of functions and classes, for example, are plain strings.</p> </dd></dl> <dl class="method"> <dt id="compiler.ast.Node.getChildNodes"> <code class="descname">getChildNodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#compiler.ast.Node.getChildNodes" title="Permalink to this definition">¶</a></dt> <dd><p>Returns a flattened list of the child nodes in the order they occur. This method is like <a class="reference internal" href="#compiler.ast.Node.getChildren" title="compiler.ast.Node.getChildren"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getChildren()</span></code></a>, except that it only returns those children that are <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> instances.</p> </dd></dl> </dd></dl> <p>Two examples illustrate the general structure of <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> classes. The <a class="reference internal" href="../reference/compound_stmts.html#while"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">while</span></code></a> statement is defined by the following grammar production:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">while_stmt</span><span class="p">:</span> <span class="s2">"while"</span> <span class="n">expression</span> <span class="s2">":"</span> <span class="n">suite</span> <span class="p">[</span><span class="s2">"else"</span> <span class="s2">":"</span> <span class="n">suite</span><span class="p">]</span> </pre></div> </div> <p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">While</span></code> node has three attributes: <a class="reference internal" href="test.html#module-test" title="test: Regression tests package containing the testing suite for Python."><code class="xref py py-attr docutils literal notranslate"><span class="pre">test</span></code></a>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">body</span></code>, and <code class="xref py py-attr docutils literal notranslate"><span class="pre">else_</span></code>. (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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">else_</span></code> instead of <a class="reference internal" href="../reference/compound_stmts.html#else"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">else</span></code></a>.)</p> <p>The <a class="reference internal" href="../reference/compound_stmts.html#if"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">if</span></code></a> statement is more complicated because it can include several tests.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">if_stmt</span><span class="p">:</span> <span class="s1">'if'</span> <span class="n">test</span> <span class="s1">':'</span> <span class="n">suite</span> <span class="p">(</span><span class="s1">'elif'</span> <span class="n">test</span> <span class="s1">':'</span> <span class="n">suite</span><span class="p">)</span><span class="o">*</span> <span class="p">[</span><span class="s1">'else'</span> <span class="s1">':'</span> <span class="n">suite</span><span class="p">]</span> </pre></div> </div> <p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">If</span></code> node only defines two attributes: <code class="xref py py-attr docutils literal notranslate"><span class="pre">tests</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">else_</span></code>. The <code class="xref py py-attr docutils literal notranslate"><span class="pre">tests</span></code> attribute is a sequence of test expression, consequent body pairs. There is one pair for each <a class="reference internal" href="../reference/compound_stmts.html#if"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">if</span></code></a>/<a class="reference internal" href="../reference/compound_stmts.html#elif"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">elif</span></code></a> clause. The first element of the pair is the test expression. The second elements is a <code class="xref py py-class docutils literal notranslate"><span class="pre">Stmt</span></code> node that contains the code to execute if the test is true.</p> <p>The <code class="xref py py-meth docutils literal notranslate"><span class="pre">getChildren()</span></code> method of <code class="xref py py-class docutils literal notranslate"><span class="pre">If</span></code> returns a flat list of child nodes. If there are three <a class="reference internal" href="../reference/compound_stmts.html#if"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">if</span></code></a>/<a class="reference internal" href="../reference/compound_stmts.html#elif"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">elif</span></code></a> clauses and no <a class="reference internal" href="../reference/compound_stmts.html#else"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">else</span></code></a> clause, then <code class="xref py py-meth docutils literal notranslate"><span class="pre">getChildren()</span></code> will return a list of six elements: the first test expression, the first <code class="xref py py-class docutils literal notranslate"><span class="pre">Stmt</span></code>, the second text expression, etc.</p> <p>The following table lists each of the <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> subclasses defined in <a class="reference internal" href="#module-compiler.ast" title="compiler.ast"><code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler.ast</span></code></a> and each of the public attributes available on their instances. The values of most of the attributes are themselves <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> 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 <code class="xref py py-meth docutils literal notranslate"><span class="pre">getChildren()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">getChildNodes()</span></code>.</p> <table border="1" class="docutils"> <colgroup> <col width="30%" /> <col width="26%" /> <col width="43%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Node type</th> <th class="head">Attribute</th> <th class="head">Value</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Add</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">left</span></code></td> <td>left operand</td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">right</span></code></td> <td>right operand</td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">And</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td>list of operands</td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">AssAttr</span></code></td> <td> </td> <td><em>attribute as target of assignment</em></td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td>expression on the left-hand side of the dot</td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">attrname</span></code></td> <td>the attribute name, a string</td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">flags</span></code></td> <td>XXX</td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">AssList</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td>list of list elements being assigned to</td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">AssName</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code></td> <td>name being assigned to</td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">flags</span></code></td> <td>XXX</td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">AssTuple</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td>list of tuple elements being assigned to</td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Assert</span></code></td> <td><a class="reference internal" href="test.html#module-test" title="test: Regression tests package containing the testing suite for Python."><code class="xref py py-attr docutils literal notranslate"><span class="pre">test</span></code></a></td> <td>the expression to be tested</td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">fail</span></code></td> <td>the value of the <a class="reference internal" href="exceptions.html#exceptions.AssertionError" title="exceptions.AssertionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AssertionError</span></code></a></td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Assign</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td>a list of assignment targets, one per equal sign</td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td>the value being assigned</td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">AugAssign</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">node</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">op</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Backquote</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Bitand</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Bitor</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Bitxor</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Break</span></code></td> <td> </td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">CallFunc</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">node</span></code></td> <td>expression for the callee</td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">args</span></code></td> <td>a list of arguments</td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">star_args</span></code></td> <td>the extended *-arg value</td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">dstar_args</span></code></td> <td>the extended **-arg value</td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Class</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code></td> <td>the name of the class, a string</td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">bases</span></code></td> <td>a list of base classes</td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">doc</span></code></td> <td>doc string, a string or <code class="docutils literal notranslate"><span class="pre">None</span></code></td> </tr> <tr class="row-even"><td> </td> <td><a class="reference internal" href="code.html#module-code" title="code: Facilities to implement read-eval-print loops."><code class="xref py py-attr docutils literal notranslate"><span class="pre">code</span></code></a></td> <td>the body of the class statement</td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Compare</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">ops</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Const</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">value</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Continue</span></code></td> <td> </td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Decorators</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td>List of function decorator expressions</td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">items</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Discard</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Div</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">left</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">right</span></code></td> <td> </td> </tr> <tr class="row-even"><td><a class="reference internal" href="constants.html#Ellipsis" title="Ellipsis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ellipsis</span></code></a></td> <td> </td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Expression</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">node</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Exec</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><a class="reference internal" href="functions.html#locals" title="locals"><code class="xref py py-attr docutils literal notranslate"><span class="pre">locals</span></code></a></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><a class="reference internal" href="functions.html#globals" title="globals"><code class="xref py py-attr docutils literal notranslate"><span class="pre">globals</span></code></a></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">FloorDiv</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">left</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">right</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">For</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">assign</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">list</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">body</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">else_</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">From</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">modname</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">names</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Function</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">decorators</span></code></td> <td><code class="xref py py-class docutils literal notranslate"><span class="pre">Decorators</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code></td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code></td> <td>name used in def, a string</td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">argnames</span></code></td> <td>list of argument names, as strings</td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">defaults</span></code></td> <td>list of default values</td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">flags</span></code></td> <td>xxx</td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">doc</span></code></td> <td>doc string, a string or <code class="docutils literal notranslate"><span class="pre">None</span></code></td> </tr> <tr class="row-odd"><td> </td> <td><a class="reference internal" href="code.html#module-code" title="code: Facilities to implement read-eval-print loops."><code class="xref py py-attr docutils literal notranslate"><span class="pre">code</span></code></a></td> <td>the body of the function</td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">GenExpr</span></code></td> <td><a class="reference internal" href="code.html#module-code" title="code: Facilities to implement read-eval-print loops."><code class="xref py py-attr docutils literal notranslate"><span class="pre">code</span></code></a></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">GenExprFor</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">assign</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><a class="reference internal" href="functions.html#iter" title="iter"><code class="xref py py-attr docutils literal notranslate"><span class="pre">iter</span></code></a></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">ifs</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">GenExprIf</span></code></td> <td><a class="reference internal" href="test.html#module-test" title="test: Regression tests package containing the testing suite for Python."><code class="xref py py-attr docutils literal notranslate"><span class="pre">test</span></code></a></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">GenExprInner</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">quals</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Getattr</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">attrname</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Global</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">names</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">If</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">tests</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">else_</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Import</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">names</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Invert</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Keyword</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Lambda</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">argnames</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">defaults</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">flags</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><a class="reference internal" href="code.html#module-code" title="code: Facilities to implement read-eval-print loops."><code class="xref py py-attr docutils literal notranslate"><span class="pre">code</span></code></a></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">LeftShift</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">left</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">right</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">ListComp</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">quals</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">ListCompFor</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">assign</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">list</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">ifs</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">ListCompIf</span></code></td> <td><a class="reference internal" href="test.html#module-test" title="test: Regression tests package containing the testing suite for Python."><code class="xref py py-attr docutils literal notranslate"><span class="pre">test</span></code></a></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Mod</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">left</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">right</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">doc</span></code></td> <td>doc string, a string or <code class="docutils literal notranslate"><span class="pre">None</span></code></td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">node</span></code></td> <td>body of the module, a <code class="xref py py-class docutils literal notranslate"><span class="pre">Stmt</span></code></td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Mul</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">left</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">right</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Name</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Not</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Or</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Pass</span></code></td> <td> </td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Power</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">left</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">right</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Print</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">dest</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Printnl</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">dest</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Raise</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr1</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr2</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr3</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Return</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">value</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">RightShift</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">left</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">right</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Slice</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">flags</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">lower</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">upper</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Sliceobj</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td>list of statements</td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Stmt</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Sub</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">left</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">right</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Subscript</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">flags</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">subs</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">TryExcept</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">body</span></code></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">handlers</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">else_</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">TryFinally</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">body</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">final</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Tuple</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">UnaryAdd</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">UnarySub</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">While</span></code></td> <td><a class="reference internal" href="test.html#module-test" title="test: Regression tests package containing the testing suite for Python."><code class="xref py py-attr docutils literal notranslate"><span class="pre">test</span></code></a></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">body</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">else_</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">With</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code></td> <td> </td> </tr> <tr class="row-even"><td> </td> <td><a class="reference internal" href="functions.html#vars" title="vars"><code class="xref py py-attr docutils literal notranslate"><span class="pre">vars</span></code></a></td> <td> </td> </tr> <tr class="row-odd"><td> </td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">body</span></code></td> <td> </td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Yield</span></code></td> <td><code class="xref py py-attr docutils literal notranslate"><span class="pre">value</span></code></td> <td> </td> </tr> </tbody> </table> </div> <div class="section" id="assignment-nodes"> <h3>33.3.2. Assignment nodes<a class="headerlink" href="#assignment-nodes" title="Permalink to this headline">¶</a></h3> <p>There is a collection of nodes used to represent assignments. Each assignment statement in the source code becomes a single <code class="xref py py-class docutils literal notranslate"><span class="pre">Assign</span></code> node in the AST. The <code class="xref py py-attr docutils literal notranslate"><span class="pre">nodes</span></code> attribute is a list that contains a node for each assignment target. This is necessary because assignment can be chained, e.g. <code class="docutils literal notranslate"><span class="pre">a</span> <span class="pre">=</span> <span class="pre">b</span> <span class="pre">=</span> <span class="pre">2</span></code>. Each <a class="reference internal" href="#compiler.ast.Node" title="compiler.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a> in the list will be one of the following classes: <code class="xref py py-class docutils literal notranslate"><span class="pre">AssAttr</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">AssList</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">AssName</span></code>, or <code class="xref py py-class docutils literal notranslate"><span class="pre">AssTuple</span></code>.</p> <p>Each target assignment node will describe the kind of object being assigned to: <code class="xref py py-class docutils literal notranslate"><span class="pre">AssName</span></code> for a simple name, e.g. <code class="docutils literal notranslate"><span class="pre">a</span> <span class="pre">=</span> <span class="pre">1</span></code>. <code class="xref py py-class docutils literal notranslate"><span class="pre">AssAttr</span></code> for an attribute assigned, e.g. <code class="docutils literal notranslate"><span class="pre">a.x</span> <span class="pre">=</span> <span class="pre">1</span></code>. <code class="xref py py-class docutils literal notranslate"><span class="pre">AssList</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">AssTuple</span></code> for list and tuple expansion respectively, e.g. <code class="docutils literal notranslate"><span class="pre">a,</span> <span class="pre">b,</span> <span class="pre">c</span> <span class="pre">=</span> <span class="pre">a_tuple</span></code>.</p> <p>The target assignment nodes also have a <code class="xref py py-attr docutils literal notranslate"><span class="pre">flags</span></code> attribute that indicates whether the node is being used for assignment or in a delete statement. The <code class="xref py py-class docutils literal notranslate"><span class="pre">AssName</span></code> is also used to represent a delete statement, e.g. <code class="xref py py-class docutils literal notranslate"><span class="pre">del</span> <span class="pre">x</span></code>.</p> <p>When an expression contains several attribute references, an assignment or delete statement will contain only one <code class="xref py py-class docutils literal notranslate"><span class="pre">AssAttr</span></code> node – for the final attribute reference. The other attribute references will be represented as <code class="xref py py-class docutils literal notranslate"><span class="pre">Getattr</span></code> nodes in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">expr</span></code> attribute of the <code class="xref py py-class docutils literal notranslate"><span class="pre">AssAttr</span></code> instance.</p> </div> <div class="section" id="examples"> <h3>33.3.3. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3> <p>This section shows several simple examples of ASTs for Python source code. The examples demonstrate how to use the <code class="xref py py-func docutils literal notranslate"><span class="pre">parse()</span></code> function, what the repr of an AST looks like, and how to access attributes of an AST node.</p> <p>The first module defines a single function. Assume it is stored in <code class="file docutils literal notranslate"><span class="pre">doublelib.py</span></code>.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="sd">"""This is an example module.</span> <span class="sd">This is the docstring.</span> <span class="sd">"""</span> <span class="k">def</span> <span class="nf">double</span><span class="p">(</span><span class="n">x</span><span class="p">):</span> <span class="s2">"Return twice the argument"</span> <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="mi">2</span> </pre></div> </div> <p>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 <a class="reference internal" href="#module-compiler.ast" title="compiler.ast"><code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler.ast</span></code></a> module.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">compiler</span> <span class="gp">>>> </span><span class="n">mod</span> <span class="o">=</span> <span class="n">compiler</span><span class="o">.</span><span class="n">parseFile</span><span class="p">(</span><span class="s2">"doublelib.py"</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">mod</span> <span class="go">Module('This is an example module.\n\nThis is the docstring.\n',</span> <span class="go"> Stmt([Function(None, 'double', ['x'], [], 0,</span> <span class="go"> 'Return twice the argument',</span> <span class="go"> Stmt([Return(Mul((Name('x'), Const(2))))]))]))</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">compiler.ast</span> <span class="k">import</span> <span class="o">*</span> <span class="gp">>>> </span><span class="n">Module</span><span class="p">(</span><span class="s1">'This is an example module.</span><span class="se">\n\n</span><span class="s1">This is the docstring.</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="gp">... </span> <span class="n">Stmt</span><span class="p">([</span><span class="n">Function</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="s1">'double'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'x'</span><span class="p">],</span> <span class="p">[],</span> <span class="mi">0</span><span class="p">,</span> <span class="gp">... </span> <span class="s1">'Return twice the argument'</span><span class="p">,</span> <span class="gp">... </span> <span class="n">Stmt</span><span class="p">([</span><span class="n">Return</span><span class="p">(</span><span class="n">Mul</span><span class="p">((</span><span class="n">Name</span><span class="p">(</span><span class="s1">'x'</span><span class="p">),</span> <span class="n">Const</span><span class="p">(</span><span class="mi">2</span><span class="p">))))]))]))</span> <span class="go">Module('This is an example module.\n\nThis is the docstring.\n',</span> <span class="go"> Stmt([Function(None, 'double', ['x'], [], 0,</span> <span class="go"> 'Return twice the argument',</span> <span class="go"> Stmt([Return(Mul((Name('x'), Const(2))))]))]))</span> <span class="gp">>>> </span><span class="n">mod</span><span class="o">.</span><span class="n">doc</span> <span class="go">'This is an example module.\n\nThis is the docstring.\n'</span> <span class="gp">>>> </span><span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="n">mod</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">nodes</span><span class="p">:</span> <span class="gp">... </span> <span class="nb">print</span> <span class="n">node</span> <span class="gp">...</span> <span class="go">Function(None, 'double', ['x'], [], 0, 'Return twice the argument',</span> <span class="go"> Stmt([Return(Mul((Name('x'), Const(2))))]))</span> <span class="gp">>>> </span><span class="n">func</span> <span class="o">=</span> <span class="n">mod</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="gp">>>> </span><span class="n">func</span><span class="o">.</span><span class="n">code</span> <span class="go">Stmt([Return(Mul((Name('x'), Const(2))))])</span> </pre></div> </div> </div> </div> <div class="section" id="module-compiler.visitor"> <span id="using-visitors-to-walk-asts"></span><h2>33.4. Using Visitors to Walk ASTs<a class="headerlink" href="#module-compiler.visitor" title="Permalink to this headline">¶</a></h2> <p>The visitor pattern is … The <a class="reference internal" href="#module-compiler" title="compiler: Python code compiler written in Python. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">compiler</span></code></a> 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.</p> <p>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.</p> <p>XXX The magic <code class="xref py py-meth docutils literal notranslate"><span class="pre">visit()</span></code> method for visitors.</p> <dl class="function"> <dt id="compiler.visitor.walk"> <code class="descclassname">compiler.visitor.</code><code class="descname">walk</code><span class="sig-paren">(</span><em>tree</em>, <em>visitor</em><span class="optional">[</span>, <em>verbose</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#compiler.visitor.walk" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="class"> <dt id="compiler.visitor.ASTVisitor"> <em class="property">class </em><code class="descclassname">compiler.visitor.</code><code class="descname">ASTVisitor</code><a class="headerlink" href="#compiler.visitor.ASTVisitor" title="Permalink to this definition">¶</a></dt> <dd><p>The <a class="reference internal" href="#compiler.visitor.ASTVisitor" title="compiler.visitor.ASTVisitor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ASTVisitor</span></code></a> is responsible for walking over the tree in the correct order. A walk begins with a call to <a class="reference internal" href="#compiler.visitor.ASTVisitor.preorder" title="compiler.visitor.ASTVisitor.preorder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">preorder()</span></code></a>. For each node, it checks the <em>visitor</em> argument to <a class="reference internal" href="#compiler.visitor.ASTVisitor.preorder" title="compiler.visitor.ASTVisitor.preorder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">preorder()</span></code></a> for a method named ‘visitNodeType,’ where NodeType is the name of the node’s class, e.g. for a <code class="xref py py-class docutils literal notranslate"><span class="pre">While</span></code> node a <code class="xref py py-meth docutils literal notranslate"><span class="pre">visitWhile()</span></code> would be called. If the method exists, it is called with the node as its first argument.</p> <p>The visitor method for a particular node type can control how child nodes are visited during the walk. The <a class="reference internal" href="#compiler.visitor.ASTVisitor" title="compiler.visitor.ASTVisitor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ASTVisitor</span></code></a> 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 <a class="reference internal" href="#compiler.visitor.ASTVisitor.default" title="compiler.visitor.ASTVisitor.default"><code class="xref py py-meth docutils literal notranslate"><span class="pre">default()</span></code></a> method is called.</p> <p><a class="reference internal" href="#compiler.visitor.ASTVisitor" title="compiler.visitor.ASTVisitor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ASTVisitor</span></code></a> objects have the following methods:</p> <p>XXX describe extra arguments</p> <dl class="method"> <dt id="compiler.visitor.ASTVisitor.default"> <code class="descname">default</code><span class="sig-paren">(</span><em>node</em><span class="optional">[</span>, <em>...</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#compiler.visitor.ASTVisitor.default" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="compiler.visitor.ASTVisitor.dispatch"> <code class="descname">dispatch</code><span class="sig-paren">(</span><em>node</em><span class="optional">[</span>, <em>...</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#compiler.visitor.ASTVisitor.dispatch" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="compiler.visitor.ASTVisitor.preorder"> <code class="descname">preorder</code><span class="sig-paren">(</span><em>tree</em>, <em>visitor</em><span class="sig-paren">)</span><a class="headerlink" href="#compiler.visitor.ASTVisitor.preorder" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> </div> <div class="section" id="bytecode-generation"> <h2>33.5. Bytecode Generation<a class="headerlink" href="#bytecode-generation" title="Permalink to this headline">¶</a></h2> <p>The code generator is a visitor that emits bytecodes. Each visit method can call the <code class="xref py py-meth docutils literal notranslate"><span class="pre">emit()</span></code> 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.</p> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">33. Python compiler package</a><ul> <li><a class="reference internal" href="#module-compiler">33.1. The basic interface</a></li> <li><a class="reference internal" href="#limitations">33.2. Limitations</a></li> <li><a class="reference internal" href="#python-abstract-syntax">33.3. Python Abstract Syntax</a><ul> <li><a class="reference internal" href="#module-compiler.ast">33.3.1. AST Nodes</a></li> <li><a class="reference internal" href="#assignment-nodes">33.3.2. Assignment nodes</a></li> <li><a class="reference internal" href="#examples">33.3.3. Examples</a></li> </ul> </li> <li><a class="reference internal" href="#module-compiler.visitor">33.4. Using Visitors to Walk ASTs</a></li> <li><a class="reference internal" href="#bytecode-generation">33.5. Bytecode Generation</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="pickletools.html" title="previous chapter">32.13. <code class="docutils literal notranslate"><span class="pre">pickletools</span></code> — Tools for pickle developers</a></p> <h4>Next topic</h4> <p class="topless"><a href="misc.html" title="next chapter">34. Miscellaneous Services</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/library/compiler.rst.txt" rel="nofollow">Show Source</a></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="misc.html" title="34. Miscellaneous Services" >next</a> |</li> <li class="right" > <a href="pickletools.html" title="32.13. pickletools — Tools for pickle developers" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.16 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2019, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Mar 27, 2019. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.6. </div> </body> </html>
Save
cmd:
run