annotate Lib/compiler/__init__.py @ 79675:c0a2294de787 2.7

Issue #16199: Backport 2to3 typo fix from 3.2.
author Chris Jerdonek <chris.jerdonek@gmail.com>
date Thu, 11 Oct 2012 16:15:46 -0700
parents a0a67c2fb7ff
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11926
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
1 """Package for parsing and compiling Python source code
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
2
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
3 There are several functions defined at the top level that are imported
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
4 from modules contained in the package.
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
5
19946
41799b70a96c API change:
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 17344
diff changeset
6 parse(buf, mode="exec") -> AST
17344
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11928
diff changeset
7 Converts a string containing Python source code to an abstract
11926
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
8 syntax tree (AST). The AST is defined in compiler.ast.
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
9
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
10 parseFile(path) -> AST
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
11 The same as parse(open(path))
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
12
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
13 walk(ast, visitor, verbose=None)
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
14 Does a pre-order walk over the ast using the visitor instance.
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
15 See compiler.visitor for details.
11928
bdb5f6a524b5 import compile function form pycodegen
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11926
diff changeset
16
19946
41799b70a96c API change:
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 17344
diff changeset
17 compile(source, filename, mode, flags=None, dont_inherit=None)
20547
a12ccdbce8da Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 20128
diff changeset
18 Returns a code object. A replacement for the builtin compile() function.
19946
41799b70a96c API change:
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 17344
diff changeset
19
41799b70a96c API change:
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 17344
diff changeset
20 compileFile(filename)
20128
fdfcffc2152c Fix comment typo
Andrew M. Kuchling <amk@amk.ca>
parents: 19946
diff changeset
21 Generates a .pyc file by compiling filename.
11926
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
22 """
59710
a0a67c2fb7ff make compiler's py3k warning a full deprecation warning #6837
Benjamin Peterson <benjamin@python.org>
parents: 46818
diff changeset
23
a0a67c2fb7ff make compiler's py3k warning a full deprecation warning #6837
Benjamin Peterson <benjamin@python.org>
parents: 46818
diff changeset
24 import warnings
a0a67c2fb7ff make compiler's py3k warning a full deprecation warning #6837
Benjamin Peterson <benjamin@python.org>
parents: 46818
diff changeset
25
a0a67c2fb7ff make compiler's py3k warning a full deprecation warning #6837
Benjamin Peterson <benjamin@python.org>
parents: 46818
diff changeset
26 warnings.warn("The compiler package is deprecated and removed in Python 3.x.",
a0a67c2fb7ff make compiler's py3k warning a full deprecation warning #6837
Benjamin Peterson <benjamin@python.org>
parents: 46818
diff changeset
27 DeprecationWarning, stacklevel=2)
11926
a469aa8b332a add a doc string
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 11704
diff changeset
28
37408
a60a9443e8da Use absolute imports
Neal Norwitz <nnorwitz@gmail.com>
parents: 20547
diff changeset
29 from compiler.transformer import parse, parseFile
a60a9443e8da Use absolute imports
Neal Norwitz <nnorwitz@gmail.com>
parents: 20547
diff changeset
30 from compiler.visitor import walk
a60a9443e8da Use absolute imports
Neal Norwitz <nnorwitz@gmail.com>
parents: 20547
diff changeset
31 from compiler.pycodegen import compile, compileFile