"symtable" --- Access to the compiler's symbol tables
"symtable" --- Access to the compiler's symbol tables#
Código fuente: Lib/symtable.py
======================================================================
Symbol tables are generated by the compiler from AST just before bytecode is generated. The symbol table is responsible for calculating the scope of every identifier in the code. "symtable" provides an interface to examine these tables.
Generando tablas de símbolos#
symtable.symtable(code, filename, compile_type)
Retorna la "SymbolTable" del nivel más alto para el código Python code. filename es el nombre del archivo conteniendo el código. compile_type es como el argumento mode de la función "compile()".
Examinando la tabla de símbolos#
class symtable.SymbolTableType
An enumeration indicating the type of a "SymbolTable" object.
MODULE = "module"
Used for the symbol table of a module.
FUNCTION = "function"
Used for the symbol table of a function.
CLASS = "class"
Used for the symbol table of a class.
The following members refer to different flavors of annotation scopes.
ANNOTATION = "annotation"
Used for annotations if "from __future__ import annotations" is
active.
TYPE_ALIAS = "type alias"
Used for the symbol table of "type" constructions.
TYPE_PARAMETERS = "type parameters"
Used for the symbol table of generic functions or generic
classes.
TYPE_VARIABLE = "type variable"
Used for the symbol table of the bound, the constraint tuple or
the default value of a single type variable in the formal sense,
i.e., a TypeVar, a TypeVarTuple or a ParamSpec object (the
latter two do not support a bound or a constraint tuple).
Added in version 3.13.
class symtable.SymbolTable
Un espacio de nombres para el bloque. El constructor no es público.
get_type()
Return the type of the symbol table. Possible values are
members of the "SymbolTableType" enumeration.
Distinto en la versión 3.12: Se agregaron "'annotation'",
"'TypeVar bound'", "'type alias'" y "'type parameter'" como
posibles valores de retorno.
Distinto en la versión 3.13: Return values are members of the
"SymbolTableType" enumeration.The exact values of the returned
string may change in the future, and thus, it is recommended to
use "SymbolTableType" members instead of hard-coded strings.
get_id()
Retorna el identificador de la tabla.
get_name()
Retorna el nombre de la tabla. Es el nombre de la clase si la
tabla es para una clase, el nombre de la función si la tabla es
para una función o "'top" si la tabla es global ("get_type()"
retorna "'module"). Para ámbitos de parámetros de tipo (que se
utilizan para clases genéricas, funciones y alias de tipo), es
el nombre de la clase, función o alias de tipo subyacente. Para
ámbitos de alias de tipo, es el nombre del alias de tipo. Para
ámbitos enlazados "TypeVar", es el nombre del "TypeVar".
get_lineno()
Retorna el número de la primera línea en el bloque que esta
tabla representa.
is_optimized()
Retorna "True" si los locales en esta tabla pueden ser
optimizados.
is_nested()
Retorna "True" si el bloque es una clase o función anidadas.
has_children()
Retorna "True" si el bloque contiene espacios de nombres
anidados en él. Estos pueden ser obtenidos con "get_children()".
get_identifiers()
Retorna una vista de objeto que contiene los nombres de los
símbolos en la tabla. Lee la documentación de vistas de objetos.
lookup(name)
Busca *name* en la tabla y retorna una instancia de "Symbol".
get_symbols()
Retorna una lista de instancias de "Symbol" de los nombres en la
tabla.
get_children()
Retorna una lista de las tablas de símbolos anidadas.
class symtable.Function
A namespace for a function or method. This class inherits from "SymbolTable".
get_parameters()
Retorna una tupla conteniendo los nombres de los parámetros de
esta función.
get_locals()
Retorna una tupla conteniendo los nombres de los locales en esta
función.
get_globals()
Retorna una tupla conteniendo los nombres de los globales en
esta función.
get_nonlocals()
Return a tuple containing names of explicitly declared nonlocals
in this function.
get_frees()
Return a tuple containing names of *free (closure) variables* in
this function.
class symtable.Class
A namespace of a class. This class inherits from "SymbolTable".
get_methods()
Return a tuple containing the names of method-like functions
declared in the class.
Here, the term 'method' designates *any* function defined in the
class body via "def" or "async def".
Functions defined in a deeper scope (e.g., in an inner class)
are not picked up by "get_methods()".
For example:
>>> import symtable
>>> st = symtable.symtable('''
... def outer(): pass
...
... class A:
... def f():
... def w(): pass
...
... def g(self): pass
...
... @classmethod
... async def h(cls): pass
...
... global outer
... def outer(self): pass
... ''', 'test', 'exec')
>>> class_A = st.get_children()[2]
>>> class_A.get_methods()
('f', 'g', 'h')
Although "A().f()" raises "TypeError" at runtime, "A.f" is still
considered as a method-like function.
Deprecated since version 3.14, will be removed in version 3.16.
class symtable.Symbol
Una entrada en una "SymbolTable" correspondiente a un identificador en el código. El constructor no es público.
get_name()
Retorna el nombre del símbolo.
is_referenced()
Retorna "True" si el símbolo es usado en su bloque.
is_imported()
Retorna "True" si el símbolo es creado desde una instrucción
*import*.
is_parameter()
Retorna "True" si el símbolo es un parámetro.
is_type_parameter()
Return "True" if the symbol is a type parameter.
Added in version 3.14.
is_global()
Retorna "True" si el símbolo es global.
is_nonlocal()
Retorna "True" si el símbolo es no local.
is_declared_global()
Retorna "True" si el símbolo es declarado global con una
instrucción *global*.
is_local()
Retorna "True" si el símbolo es local a su bloque.
is_annotated()
Retorna "True" si el símbolo está anotado.
Added in version 3.6.
is_free()
Retorna "True" si el símbolo es referenciado en su bloque pero
no asignado.
is_free_class()
Return *True* if a class-scoped symbol is free from the
perspective of a method.
Consider the following example:
def f():
x = 1 # function-scoped
class C:
x = 2 # class-scoped
def method(self):
return x
In this example, the class-scoped symbol "x" is considered to be
free from the perspective of "C.method", thereby allowing the
latter to return *1* at runtime and not *2*.
Added in version 3.14.
is_assigned()
Retorna "True" si el símbolo es asignado en su bloque.
is_comp_iter()
Return "True" if the symbol is a comprehension iteration
variable.
Added in version 3.14.
is_comp_cell()
Return "True" if the symbol is a cell in an inlined
comprehension.
Added in version 3.14.
is_namespace()
Retorna "True" si la vinculación de nombres introduce un nuevo
espacio de nombres.
Si el nombre es usado como objetivo de una instrucción
*function* o *class* retornará verdadero.
Por ejemplo:
>>> table = symtable.symtable("def some_func(): pass", "string", "exec")
>>> table.lookup("some_func").is_namespace()
True
Note que un solo nombre puede estar vinculado a varios objetos.
Si el resultado es "True", el nombre puede estar vinculado
también a otros objetos, como un entero o una lista, esto no
introduce un nuevo espacio de nombres.
get_namespaces()
Retorna una lista de espacios de nombres vinculados a este
nombre.
get_namespace()
Retorna el espacio de nombre vinculado a este nombre. Si hay más
de un espacio de nombre vinculado o ninguno a ese nombre se
levanta un "ValueError".
Command-Line Usage#
Added in version 3.13.
The "symtable" module can be executed as a script from the command line.
python -m symtable [infile...]
Symbol tables are generated for the specified Python source files and dumped to stdout. If no input file is specified, the content is read from stdin.