396 lines
21 KiB
HTML
396 lines
21 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="zh_CN">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
<title>pyclbr --- Python 模块浏览器支持 — Python 3.8.20 文档</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
|
|
<script id="documentation_options" data-url_root="../" 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/language_data.js"></script>
|
|
<script src="../_static/translations.js"></script>
|
|
|
|
<script src="../_static/sidebar.js"></script>
|
|
|
|
<link rel="search" type="application/opensearchdescription+xml"
|
|
title="在 Python 3.8.20 文档 中搜索"
|
|
href="../_static/opensearch.xml"/>
|
|
<link rel="author" title="关于这些文档" href="../about.html" />
|
|
<link rel="index" title="索引" href="../genindex.html" />
|
|
<link rel="search" title="搜索" href="../search.html" />
|
|
<link rel="copyright" title="版权所有" href="../copyright.html" />
|
|
<link rel="next" title="py_compile --- 编译 Python 源文件" href="py_compile.html" />
|
|
<link rel="prev" title="tabnanny --- 模糊缩进检测" href="tabnanny.html" />
|
|
<link rel="canonical" href="https://docs.python.org/3/library/pyclbr.html" />
|
|
|
|
|
|
|
|
|
|
|
|
<style>
|
|
@media only screen {
|
|
table.full-width-table {
|
|
width: 100%;
|
|
}
|
|
}
|
|
</style>
|
|
<link rel="shortcut icon" type="image/png" href="../_static/py.svg" />
|
|
<script type="text/javascript" src="../_static/copybutton.js"></script>
|
|
<script type="text/javascript" src="../_static/menu.js"></script>
|
|
|
|
</head>
|
|
<body>
|
|
<div class="mobile-nav">
|
|
<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
|
|
aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
|
|
<label for="menuToggler" class="toggler__label">
|
|
<span></span>
|
|
</label>
|
|
<nav class="nav-content" role="navigation">
|
|
<a href="https://www.python.org/" class="nav-logo">
|
|
<img src="../_static/py.svg" alt="Logo"/>
|
|
</a>
|
|
<div class="version_switcher_placeholder"></div>
|
|
<form role="search" class="search" action="../search.html" method="get">
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
|
|
<path fill-rule="nonzero"
|
|
d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
|
|
</svg>
|
|
<input type="text" name="q" aria-label="快速搜索"/>
|
|
<input type="submit" value="转向"/>
|
|
</form>
|
|
</nav>
|
|
<div class="menu-wrapper">
|
|
<nav class="menu" role="navigation" aria-label="main navigation">
|
|
<div class="language_switcher_placeholder"></div>
|
|
<h3><a href="../contents.html">目录</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pyclbr</span></code> --- Python 模块浏览器支持</a><ul>
|
|
<li><a class="reference internal" href="#function-objects">函数对象</a></li>
|
|
<li><a class="reference internal" href="#class-objects">类对象</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>上一个主题</h4>
|
|
<p class="topless"><a href="tabnanny.html"
|
|
title="上一章"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tabnanny</span></code> --- 模糊缩进检测</a></p>
|
|
<h4>下一个主题</h4>
|
|
<p class="topless"><a href="py_compile.html"
|
|
title="下一章"><code class="xref py py-mod docutils literal notranslate"><span class="pre">py_compile</span></code> --- 编译 Python 源文件</a></p>
|
|
<div role="note" aria-label="source link">
|
|
<h3>本页</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../bugs.html">报告 Bug</a></li>
|
|
<li>
|
|
<a href="https://github.com/python/cpython/blob/3.8/Doc/library/pyclbr.rst"
|
|
rel="nofollow">显示源代码
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
|
|
这个文档所针对的是一个已不再受支持的 Python 旧版本。
|
|
你应当升级版本，并阅读
|
|
<a href="/3/library/pyclbr.html"> Python 当前稳定版本的文档</a>.
|
|
</div>
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>导航</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../genindex.html" title="总目录"
|
|
accesskey="I">索引</a></li>
|
|
<li class="right" >
|
|
<a href="../py-modindex.html" title="Python 模块索引"
|
|
>模块</a> |</li>
|
|
<li class="right" >
|
|
<a href="py_compile.html" title="py_compile --- 编译 Python 源文件"
|
|
accesskey="N">下一页</a> |</li>
|
|
<li class="right" >
|
|
<a href="tabnanny.html" title="tabnanny --- 模糊缩进检测"
|
|
accesskey="P">上一页</a> |</li>
|
|
|
|
<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
|
|
<li><a href="https://www.python.org/">Python</a> »</li>
|
|
<li class="switchers">
|
|
<div class="language_switcher_placeholder"></div>
|
|
<div class="version_switcher_placeholder"></div>
|
|
</li>
|
|
<li>
|
|
|
|
</li>
|
|
<li id="cpython-language-and-version">
|
|
<a href="../index.html">3.8.20 Documentation</a> »
|
|
</li>
|
|
|
|
<li class="nav-item nav-item-1"><a href="index.html" >Python 标准库</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="language.html" accesskey="U">Python 语言服务</a> »</li>
|
|
<li class="right">
|
|
|
|
|
|
<div class="inline-search" role="search">
|
|
<form class="inline-search" action="../search.html" method="get">
|
|
<input placeholder="快速搜索" aria-label="快速搜索" type="text" name="q" />
|
|
<input type="submit" value="转向" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<section id="module-pyclbr">
|
|
<span id="pyclbr-python-module-browser-support"></span><h1><a class="reference internal" href="#module-pyclbr" title="pyclbr: Supports information extraction for a Python module browser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">pyclbr</span></code></a> --- Python 模块浏览器支持<a class="headerlink" href="#module-pyclbr" title="永久链接至标题">¶</a></h1>
|
|
<p><strong>源代码:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.8/Lib/pyclbr.py">Lib/pyclbr.py</a></p>
|
|
<hr class="docutils" />
|
|
<p><a class="reference internal" href="#module-pyclbr" title="pyclbr: Supports information extraction for a Python module browser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">pyclbr</span></code></a> 模块提供了对于以 Python 编写的模块中定义的函数、类和方法的受限信息。 这种信息足够用来实现一个模块浏览器。 这种信息是从 Python 源代码中直接提取而非通过导入模块，因此该模块可以安全地用于不受信任的代码。 此限制使得非 Python 实现的模块无法使用此模块，包括所有标准和可选的扩展模块。</p>
|
|
<dl class="function">
|
|
<dt id="pyclbr.readmodule">
|
|
<code class="sig-prename descclassname">pyclbr.</code><code class="sig-name descname">readmodule</code><span class="sig-paren">(</span><em class="sig-param">module</em>, <em class="sig-param">path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyclbr.readmodule" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>返回一个将模块层级的类名映射到类描述器的字典。 如果可能，将会包括已导入基类的描述器。 形参 <em>module</em> 为要读取模块名称的字符串；它可能是某个包内部的模块名称。 <em>path</em> 如果给出则为添加到 <code class="docutils literal notranslate"><span class="pre">sys.path</span></code> 开头的目录路径序列，它会被用于定位模块的源代码。</p>
|
|
<p>此函数为原始接口，仅保留用于向下兼容。 它会返回以下内容的过滤版本。</p>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="pyclbr.readmodule_ex">
|
|
<code class="sig-prename descclassname">pyclbr.</code><code class="sig-name descname">readmodule_ex</code><span class="sig-paren">(</span><em class="sig-param">module</em>, <em class="sig-param">path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyclbr.readmodule_ex" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>返回一个基于字典的树，其中包含与模块中每个用 <code class="docutils literal notranslate"><span class="pre">def</span></code> 或 <code class="docutils literal notranslate"><span class="pre">class</span></code> 语句定义的函数和类相对应的函数和类描述器。 被返回的字典会将模块层级的函数和类名映射到它们的描述器。 嵌套的对象会被输入到它们的上级子目录中。 与 readmodule 一样，<em>module</em> 指明要读取的模块而 <em>path</em> 会被添加到 sys.path。 如果被读取的模块是一个包，则返回的字典将具有 <code class="docutils literal notranslate"><span class="pre">'__path__'</span></code> 键，其值是一个包含包搜索路径的列表。</p>
|
|
</dd></dl>
|
|
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">3.7 新版功能: </span>嵌套定义的描述器。 它们通过新的子属性来访问。 每个定义都会有一个新的上级属性。</p>
|
|
</div>
|
|
<p>这些函数所返回的描述器是 Function 和 Class 类的实例。 用户不应自行创建这些类的实例。</p>
|
|
<section id="function-objects">
|
|
<span id="pyclbr-function-objects"></span><h2>函数对象<a class="headerlink" href="#function-objects" title="永久链接至标题">¶</a></h2>
|
|
<p><code class="xref py py-class docutils literal notranslate"><span class="pre">Function</span></code> 类的实例描述了由 def 语句所定义的函数。 它们具有下列属性:</p>
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Function.file">
|
|
<code class="sig-prename descclassname">Function.</code><code class="sig-name descname">file</code><a class="headerlink" href="#pyclbr.Function.file" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>函数定义所在的文件名。</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Function.module">
|
|
<code class="sig-prename descclassname">Function.</code><code class="sig-name descname">module</code><a class="headerlink" href="#pyclbr.Function.module" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>定义了所描述函数的模块名。</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Function.name">
|
|
<code class="sig-prename descclassname">Function.</code><code class="sig-name descname">name</code><a class="headerlink" href="#pyclbr.Function.name" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>函数名称。</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Function.lineno">
|
|
<code class="sig-prename descclassname">Function.</code><code class="sig-name descname">lineno</code><a class="headerlink" href="#pyclbr.Function.lineno" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>定义在文件中起始位置的行号。</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Function.parent">
|
|
<code class="sig-prename descclassname">Function.</code><code class="sig-name descname">parent</code><a class="headerlink" href="#pyclbr.Function.parent" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>对于最高层级函数为 None。 对于嵌套函数则为上级函数。</p>
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">3.7 新版功能.</span></p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Function.children">
|
|
<code class="sig-prename descclassname">Function.</code><code class="sig-name descname">children</code><a class="headerlink" href="#pyclbr.Function.children" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>将名称映射到嵌套函数和类描述器的字典。</p>
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">3.7 新版功能.</span></p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="class-objects">
|
|
<span id="pyclbr-class-objects"></span><h2>类对象<a class="headerlink" href="#class-objects" title="永久链接至标题">¶</a></h2>
|
|
<p><code class="xref py py-class docutils literal notranslate"><span class="pre">Class</span></code> 类的实例描述了由 class 语句所定义的类。 它们具有与 Function 对象相同的属性以及两个额外属性。</p>
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Class.file">
|
|
<code class="sig-prename descclassname">Class.</code><code class="sig-name descname">file</code><a class="headerlink" href="#pyclbr.Class.file" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>类定义所在的文件名称。</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Class.module">
|
|
<code class="sig-prename descclassname">Class.</code><code class="sig-name descname">module</code><a class="headerlink" href="#pyclbr.Class.module" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>定义了所描述类的模块名称。</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Class.name">
|
|
<code class="sig-prename descclassname">Class.</code><code class="sig-name descname">name</code><a class="headerlink" href="#pyclbr.Class.name" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>类名称。</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Class.lineno">
|
|
<code class="sig-prename descclassname">Class.</code><code class="sig-name descname">lineno</code><a class="headerlink" href="#pyclbr.Class.lineno" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>定义在文件中起始位置的行号。</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Class.parent">
|
|
<code class="sig-prename descclassname">Class.</code><code class="sig-name descname">parent</code><a class="headerlink" href="#pyclbr.Class.parent" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>对于最高层级类为 None。 对于嵌套类则为上级类。</p>
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">3.7 新版功能.</span></p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Class.children">
|
|
<code class="sig-prename descclassname">Class.</code><code class="sig-name descname">children</code><a class="headerlink" href="#pyclbr.Class.children" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>将名称映射到嵌套函数和类描述器的字典。</p>
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">3.7 新版功能.</span></p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Class.super">
|
|
<code class="sig-prename descclassname">Class.</code><code class="sig-name descname">super</code><a class="headerlink" href="#pyclbr.Class.super" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>一个 <code class="xref py py-class docutils literal notranslate"><span class="pre">Class</span></code> 对象的列表，它们描述了所描述类的直接基类。 被命名为超类但无法被 <a class="reference internal" href="#pyclbr.readmodule_ex" title="pyclbr.readmodule_ex"><code class="xref py py-func docutils literal notranslate"><span class="pre">readmodule_ex()</span></code></a> 发现的类会作为类名字符串而非 <code class="xref py py-class docutils literal notranslate"><span class="pre">Class</span></code> 对象列出。</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyclbr.Class.methods">
|
|
<code class="sig-prename descclassname">Class.</code><code class="sig-name descname">methods</code><a class="headerlink" href="#pyclbr.Class.methods" title="永久链接至目标">¶</a></dt>
|
|
<dd><p>一个将方法名映射到行号的字典。 此属性可从更新的子目录中获取，仅保留用于向下兼容。</p>
|
|
</dd></dl>
|
|
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="../contents.html">目录</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pyclbr</span></code> --- Python 模块浏览器支持</a><ul>
|
|
<li><a class="reference internal" href="#function-objects">函数对象</a></li>
|
|
<li><a class="reference internal" href="#class-objects">类对象</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>上一个主题</h4>
|
|
<p class="topless"><a href="tabnanny.html"
|
|
title="上一章"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tabnanny</span></code> --- 模糊缩进检测</a></p>
|
|
<h4>下一个主题</h4>
|
|
<p class="topless"><a href="py_compile.html"
|
|
title="下一章"><code class="xref py py-mod docutils literal notranslate"><span class="pre">py_compile</span></code> --- 编译 Python 源文件</a></p>
|
|
<div role="note" aria-label="source link">
|
|
<h3>本页</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../bugs.html">报告 Bug</a></li>
|
|
<li>
|
|
<a href="https://github.com/python/cpython/blob/3.8/Doc/library/pyclbr.rst"
|
|
rel="nofollow">显示源代码
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>导航</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../genindex.html" title="总目录"
|
|
>索引</a></li>
|
|
<li class="right" >
|
|
<a href="../py-modindex.html" title="Python 模块索引"
|
|
>模块</a> |</li>
|
|
<li class="right" >
|
|
<a href="py_compile.html" title="py_compile --- 编译 Python 源文件"
|
|
>下一页</a> |</li>
|
|
<li class="right" >
|
|
<a href="tabnanny.html" title="tabnanny --- 模糊缩进检测"
|
|
>上一页</a> |</li>
|
|
|
|
<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
|
|
<li><a href="https://www.python.org/">Python</a> »</li>
|
|
<li class="switchers">
|
|
<div class="language_switcher_placeholder"></div>
|
|
<div class="version_switcher_placeholder"></div>
|
|
</li>
|
|
<li>
|
|
|
|
</li>
|
|
<li id="cpython-language-and-version">
|
|
<a href="../index.html">3.8.20 Documentation</a> »
|
|
</li>
|
|
|
|
<li class="nav-item nav-item-1"><a href="index.html" >Python 标准库</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="language.html" >Python 语言服务</a> »</li>
|
|
<li class="right">
|
|
|
|
|
|
<div class="inline-search" role="search">
|
|
<form class="inline-search" action="../search.html" method="get">
|
|
<input placeholder="快速搜索" aria-label="快速搜索" type="text" name="q" />
|
|
<input type="submit" value="转向" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© <a href="../copyright.html">版权所有</a> 2001-2024, Python Software Foundation.
|
|
<br />
|
|
This page is licensed under the Python Software Foundation License Version 2.
|
|
<br />
|
|
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
|
|
<br />
|
|
|
|
<br />
|
|
|
|
The Python Software Foundation is a non-profit corporation.
|
|
<a href="https://www.python.org/psf/donations/">Please donate.</a>
|
|
<br />
|
|
<br />
|
|
|
|
最后更新于 12月 09, 2024.
|
|
<a href="https://docs.python.org/3/bugs.html">Found a bug</a>?
|
|
<br />
|
|
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 2.4.4.
|
|
</div>
|
|
|
|
</body>
|
|
</html> |