1
:mod:`symtable` --- Access to the compiler's symbol tables
2
==========================================================
5
:synopsis: Interface to the compiler's internal symbol tables.
7
.. moduleauthor:: Jeremy Hylton <jeremy@alum.mit.edu>
8
.. sectionauthor:: Benjamin Peterson
11
Symbol tables are generated by the compiler from AST just before bytecode is
12
generated. The symbol table is responsible for calculating the scope of every
13
identifier in the code. :mod:`symtable` provides an interface to examine these
17
Generating Symbol Tables
18
------------------------
20
.. function:: symtable(code, filename, compile_type)
22
Return the toplevel :class:`SymbolTable` for the Python source *code*.
23
*filename* is the name of the file containing the code. *compile_type* is
24
like the *mode* argument to :func:`compile`.
27
Examining Symbol Tables
28
-----------------------
30
.. class:: SymbolTable
32
A namespace table for a block. The constructor is not public.
34
.. method:: get_type()
36
Return the type of the symbol table. Possible values are ``'class'``,
37
``'module'``, and ``'function'``.
41
Return the table's identifier.
43
.. method:: get_name()
45
Return the table's name. This is the name of the class if the table is
46
for a class, the name of the function if the table is for a function, or
47
``'top'`` if the table is global (:meth:`get_type` returns ``'module'``).
49
.. method:: get_lineno()
51
Return the number of the first line in the block this table represents.
53
.. method:: is_optimized()
55
Return ``True`` if the locals in this table can be optimized.
57
.. method:: is_nested()
59
Return ``True`` if the block is a nested class or function.
61
.. method:: has_children()
63
Return ``True`` if the block has nested namespaces within it. These can
64
be obtained with :meth:`get_children`.
66
.. method:: has_exec()
68
Return ``True`` if the block uses ``exec``.
70
.. method:: has_import_start()
72
Return ``True`` if the block uses a starred from-import.
74
.. method:: get_identifiers()
76
Return a list of names of symbols in this table.
78
.. method:: lookup(name)
80
Lookup *name* in the table and return a :class:`Symbol` instance.
82
.. method:: get_symbols()
84
Return a list of :class:`Symbol` instances for names in the table.
86
.. method:: get_children()
88
Return a list of the nested symbol tables.
93
A namespace for a function or method. This class inherits
96
.. method:: get_parameters()
98
Return a tuple containing names of parameters to this function.
100
.. method:: get_locals()
102
Return a tuple containing names of locals in this function.
104
.. method:: get_globals()
106
Return a tuple containing names of globals in this function.
108
.. method:: get_frees()
110
Return a tuple containing names of free variables in this function.
115
A namespace of a class. This class inherits :class:`SymbolTable`.
117
.. method:: get_methods()
119
Return a tuple containing the names of methods declared in the class.
124
An entry in a :class:`SymbolTable` corresponding to an identifier in the
125
source. The constructor is not public.
127
.. method:: get_name()
129
Return the symbol's name.
131
.. method:: is_referenced()
133
Return ``True`` if the symbol is used in its block.
135
.. method:: is_imported()
137
Return ``True`` if the symbol is created from an import statement.
139
.. method:: is_parameter()
141
Return ``True`` if the symbol is a parameter.
143
.. method:: is_global()
145
Return ``True`` if the symbol is global.
147
.. method:: is_local()
149
Return ``True`` if the symbol is local to its block.
151
.. method:: is_free()
153
Return ``True`` if the symbol is referenced in its block, but not assigned
156
.. method:: is_assigned()
158
Return ``True`` if the symbol is assigned to in its block.
160
.. method:: is_namespace()
162
Return ``True`` if name binding introduces new namespace.
164
If the name is used as the target of a function or class statement, this
167
Note that a single name can be bound to multiple objects. If the result
168
is ``True``, the name may also be bound to other objects, like an int or
169
list, that does not introduce a new namespace.
171
.. method:: get_namespaces()
173
Return a list of namespaces bound to this name.
175
.. method:: get_namespace()
177
Return the namespace bound to this name. If more than one namespace is
178
bound, a :exc:`ValueError` is raised.
added
removed
Doc/library/symtable.rst
