0x1949 Team - FAZEMRX - MANAGER

Edit File: symtable.html

<!DOCTYPE html>

<title>32.3. symtable — Access to the compiler’s symbol tables &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 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="32.4. symbol — Constants used with Python parse trees" href="symbol.html" />
 <link rel="prev" title="32.2. ast — Abstract Syntax Trees" href="ast.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/symtable.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/symtable.html"> Python documentation for the Python3 version packaged in this release</a>.
</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"
 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="symbol.html" title="32.4. symbol — Constants used with Python parse trees"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="ast.html" title="32.2. ast — Abstract Syntax Trees"
 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> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="language.html" accesskey="U">32. Python Language Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">32.3. <code class="xref py py-mod docutils literal notranslate">symtable</code> — Access to the compiler’s symbol tables</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-symtable">
<h1>32.3. <a class="reference internal" href="#module-symtable" title="symtable: Interface to the compiler's internal symbol tables."><code class="xref py py-mod docutils literal notranslate">symtable</code></a> — Access to the compiler’s symbol tables<a class="headerlink" href="#module-symtable" title="Permalink to this headline">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/2.7/Lib/symtable.py">Lib/symtable.py</a>
<hr class="docutils" />
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. <a class="reference internal" href="#module-symtable" title="symtable: Interface to the compiler's internal symbol tables."><code class="xref py py-mod docutils literal notranslate">symtable</code></a> provides an interface to examine these
tables.
<section id="generating-symbol-tables">
<h2>32.3.1. Generating Symbol Tables<a class="headerlink" href="#generating-symbol-tables" title="Permalink to this headline">¶</a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="symtable.symtable">
symtable.symtable(code, filename, compile_type)<a class="headerlink" href="#symtable.symtable" title="Permalink to this definition">¶</a></dt>
<dd>Return the toplevel <a class="reference internal" href="#symtable.SymbolTable" title="symtable.SymbolTable"><code class="xref py py-class docutils literal notranslate">SymbolTable</code></a> for the Python source code.
filename is the name of the file containing the code. compile_type is
like the mode argument to <a class="reference internal" href="functions.html#compile" title="compile"><code class="xref py py-func docutils literal notranslate">compile()</code></a>.
</dd></dl>

</section>
<section id="examining-symbol-tables">
<h2>32.3.2. Examining Symbol Tables<a class="headerlink" href="#examining-symbol-tables" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="symtable.SymbolTable">
class symtable.SymbolTable<a class="headerlink" href="#symtable.SymbolTable" title="Permalink to this definition">¶</a></dt>
<dd>A namespace table for a block. The constructor is not public.
<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.get_type">
get_type()<a class="headerlink" href="#symtable.SymbolTable.get_type" title="Permalink to this definition">¶</a></dt>
<dd>Return the type of the symbol table. Possible values are <code class="docutils literal notranslate">'class'</code>,
<code class="docutils literal notranslate">'module'</code>, and <code class="docutils literal notranslate">'function'</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.get_id">
get_id()<a class="headerlink" href="#symtable.SymbolTable.get_id" title="Permalink to this definition">¶</a></dt>
<dd>Return the table’s identifier.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.get_name">
get_name()<a class="headerlink" href="#symtable.SymbolTable.get_name" title="Permalink to this definition">¶</a></dt>
<dd>Return the table’s name. This is the name of the class if the table is
for a class, the name of the function if the table is for a function, or
<code class="docutils literal notranslate">'top'</code> if the table is global (<a class="reference internal" href="#symtable.SymbolTable.get_type" title="symtable.SymbolTable.get_type"><code class="xref py py-meth docutils literal notranslate">get_type()</code></a> returns <code class="docutils literal notranslate">'module'</code>).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.get_lineno">
get_lineno()<a class="headerlink" href="#symtable.SymbolTable.get_lineno" title="Permalink to this definition">¶</a></dt>
<dd>Return the number of the first line in the block this table represents.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.is_optimized">
is_optimized()<a class="headerlink" href="#symtable.SymbolTable.is_optimized" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the locals in this table can be optimized.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.is_nested">
is_nested()<a class="headerlink" href="#symtable.SymbolTable.is_nested" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the block is a nested class or function.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.has_children">
has_children()<a class="headerlink" href="#symtable.SymbolTable.has_children" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the block has nested namespaces within it. These can
be obtained with <a class="reference internal" href="#symtable.SymbolTable.get_children" title="symtable.SymbolTable.get_children"><code class="xref py py-meth docutils literal notranslate">get_children()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.has_exec">
has_exec()<a class="headerlink" href="#symtable.SymbolTable.has_exec" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the block uses <code class="docutils literal notranslate">exec</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.has_import_star">
has_import_star()<a class="headerlink" href="#symtable.SymbolTable.has_import_star" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the block uses a starred from-import.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.get_identifiers">
get_identifiers()<a class="headerlink" href="#symtable.SymbolTable.get_identifiers" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of names of symbols in this table.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.lookup">
lookup(name)<a class="headerlink" href="#symtable.SymbolTable.lookup" title="Permalink to this definition">¶</a></dt>
<dd>Lookup name in the table and return a <a class="reference internal" href="#symtable.Symbol" title="symtable.Symbol"><code class="xref py py-class docutils literal notranslate">Symbol</code></a> instance.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.get_symbols">
get_symbols()<a class="headerlink" href="#symtable.SymbolTable.get_symbols" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of <a class="reference internal" href="#symtable.Symbol" title="symtable.Symbol"><code class="xref py py-class docutils literal notranslate">Symbol</code></a> instances for names in the table.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.SymbolTable.get_children">
get_children()<a class="headerlink" href="#symtable.SymbolTable.get_children" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of the nested symbol tables.
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="symtable.Function">
class symtable.Function<a class="headerlink" href="#symtable.Function" title="Permalink to this definition">¶</a></dt>
<dd>A namespace for a function or method. This class inherits
<a class="reference internal" href="#symtable.SymbolTable" title="symtable.SymbolTable"><code class="xref py py-class docutils literal notranslate">SymbolTable</code></a>.
<dl class="py method">
<dt class="sig sig-object py" id="symtable.Function.get_parameters">
get_parameters()<a class="headerlink" href="#symtable.Function.get_parameters" title="Permalink to this definition">¶</a></dt>
<dd>Return a tuple containing names of parameters to this function.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Function.get_locals">
get_locals()<a class="headerlink" href="#symtable.Function.get_locals" title="Permalink to this definition">¶</a></dt>
<dd>Return a tuple containing names of locals in this function.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Function.get_globals">
get_globals()<a class="headerlink" href="#symtable.Function.get_globals" title="Permalink to this definition">¶</a></dt>
<dd>Return a tuple containing names of globals in this function.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Function.get_frees">
get_frees()<a class="headerlink" href="#symtable.Function.get_frees" title="Permalink to this definition">¶</a></dt>
<dd>Return a tuple containing names of free variables in this function.
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="symtable.Class">
class symtable.Class<a class="headerlink" href="#symtable.Class" title="Permalink to this definition">¶</a></dt>
<dd>A namespace of a class. This class inherits <a class="reference internal" href="#symtable.SymbolTable" title="symtable.SymbolTable"><code class="xref py py-class docutils literal notranslate">SymbolTable</code></a>.
<dl class="py method">
<dt class="sig sig-object py" id="symtable.Class.get_methods">
get_methods()<a class="headerlink" href="#symtable.Class.get_methods" title="Permalink to this definition">¶</a></dt>
<dd>Return a tuple containing the names of methods declared in the class.
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="symtable.Symbol">
class symtable.Symbol<a class="headerlink" href="#symtable.Symbol" title="Permalink to this definition">¶</a></dt>
<dd>An entry in a <a class="reference internal" href="#symtable.SymbolTable" title="symtable.SymbolTable"><code class="xref py py-class docutils literal notranslate">SymbolTable</code></a> corresponding to an identifier in the
source. The constructor is not public.
<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.get_name">
get_name()<a class="headerlink" href="#symtable.Symbol.get_name" title="Permalink to this definition">¶</a></dt>
<dd>Return the symbol’s name.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.is_referenced">
is_referenced()<a class="headerlink" href="#symtable.Symbol.is_referenced" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the symbol is used in its block.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.is_imported">
is_imported()<a class="headerlink" href="#symtable.Symbol.is_imported" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the symbol is created from an import statement.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.is_parameter">
is_parameter()<a class="headerlink" href="#symtable.Symbol.is_parameter" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the symbol is a parameter.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.is_global">
is_global()<a class="headerlink" href="#symtable.Symbol.is_global" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the symbol is global.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.is_declared_global">
is_declared_global()<a class="headerlink" href="#symtable.Symbol.is_declared_global" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the symbol is declared global with a global statement.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.is_local">
is_local()<a class="headerlink" href="#symtable.Symbol.is_local" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the symbol is local to its block.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.is_free">
is_free()<a class="headerlink" href="#symtable.Symbol.is_free" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the symbol is referenced in its block, but not assigned
to.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.is_assigned">
is_assigned()<a class="headerlink" href="#symtable.Symbol.is_assigned" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the symbol is assigned to in its block.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.is_namespace">
is_namespace()<a class="headerlink" href="#symtable.Symbol.is_namespace" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if name binding introduces new namespace.
If the name is used as the target of a function or class statement, this
will be true.
For example:
<div class="highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; table = symtable.symtable(&quot;def some_func(): pass&quot;, &quot;string&quot;, &quot;exec&quot;)
&gt;&gt;&gt; table.lookup(&quot;some_func&quot;).is_namespace()
True
</pre></div>
</div>
Note that a single name can be bound to multiple objects. If the result
is <code class="docutils literal notranslate">True</code>, the name may also be bound to other objects, like an int or
list, that does not introduce a new namespace.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.get_namespaces">
get_namespaces()<a class="headerlink" href="#symtable.Symbol.get_namespaces" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of namespaces bound to this name.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="symtable.Symbol.get_namespace">
get_namespace()<a class="headerlink" href="#symtable.Symbol.get_namespace" title="Permalink to this definition">¶</a></dt>
<dd>Return the namespace bound to this name. If more than one namespace is
bound, a <code class="xref py py-exc docutils literal notranslate">ValueError</code> is raised.
</dd></dl>

</dd></dl>

</section>
</section>

<div class="clearer"></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="#">32.3. <code class="xref py py-mod docutils literal notranslate">symtable</code> — Access to the compiler’s symbol tables</a><ul>
<li><a class="reference internal" href="#generating-symbol-tables">32.3.1. Generating Symbol Tables</a></li>
<li><a class="reference internal" href="#examining-symbol-tables">32.3.2. Examining Symbol Tables</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="ast.html"
 title="previous chapter">32.2. <code class="xref py py-mod docutils literal notranslate">ast</code> — Abstract Syntax Trees</a>
 <h4>Next topic</h4>
 <a href="symbol.html"
 title="next chapter">32.4. <code class="xref py py-mod docutils literal notranslate">symbol</code> — Constants used with Python parse trees</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/symtable.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#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="symbol.html" title="32.4. symbol — Constants used with Python parse trees"
 >next</a> |</li>
 <li class="right" >
 <a href="ast.html" title="32.2. ast — Abstract Syntax Trees"
 >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> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="language.html" >32. Python Language Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">32.3. <code class="xref py py-mod docutils literal notranslate">symtable</code> — Access to the compiler’s symbol tables</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on November 21, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>