diff options
| author | home_pc <[email protected]> | 2020-01-20 13:48:51 -0800 |
|---|---|---|
| committer | home_pc <[email protected]> | 2020-01-20 13:48:51 -0800 |
| commit | 75fa1d1810e98453960a81115d88302e276d817f (patch) | |
| tree | 92f37accb3cb041d056d00525b5830a69862631a /docs/build/_modules/sphinx/ext | |
| parent | fixed install.mel issue (diff) | |
| download | artv2-75fa1d1810e98453960a81115d88302e276d817f.tar.xz artv2-75fa1d1810e98453960a81115d88302e276d817f.zip | |
Uploading work on refactor
At this point, all components can build their skeletons. Next steps are to get components building their rigs.
Diffstat (limited to 'docs/build/_modules/sphinx/ext')
| -rw-r--r-- | docs/build/_modules/sphinx/ext/autodoc/importer.html | 471 |
1 files changed, 471 insertions, 0 deletions
diff --git a/docs/build/_modules/sphinx/ext/autodoc/importer.html b/docs/build/_modules/sphinx/ext/autodoc/importer.html new file mode 100644 index 0000000..4cb0f02 --- /dev/null +++ b/docs/build/_modules/sphinx/ext/autodoc/importer.html @@ -0,0 +1,471 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>sphinx.ext.autodoc.importer — ARTv2 2.0.1 documentation</title> + + + + + + + + + <script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script> + <script type="text/javascript" src="../../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../../_static/doctools.js"></script> + <script type="text/javascript" src="../../../../_static/language_data.js"></script> + + <script type="text/javascript" src="../../../../_static/js/theme.js"></script> + + + + + <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../../../../index.html" class="icon icon-home"> ARTv2 + + + + </a> + + + + + <div class="version"> + 2.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../../../installing.html">Installing ARTv2</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../../using_rigging_tools.html">Using the Rigging Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../../using_anim_tools.html">Using the Animation Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../../technical_documentation.html">Technical Documentation</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../../index.html">ARTv2</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../../index.html">Docs</a> »</li> + + <li><a href="../../../index.html">Module code</a> »</li> + + <li>sphinx.ext.autodoc.importer</li> + + + <li class="wy-breadcrumbs-aside"> + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <h1>Source code for sphinx.ext.autodoc.importer</h1><div class="highlight"><pre> +<span></span><span class="c1"># -*- coding: utf-8 -*-</span> +<span class="sd">"""</span> +<span class="sd"> sphinx.ext.autodoc.importer</span> +<span class="sd"> ~~~~~~~~~~~~~~~~~~~~~~~~~~~</span> + +<span class="sd"> Importer utilities for autodoc</span> + +<span class="sd"> :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.</span> +<span class="sd"> :license: BSD, see LICENSE for details.</span> +<span class="sd">"""</span> + +<span class="kn">import</span> <span class="nn">contextlib</span> +<span class="kn">import</span> <span class="nn">sys</span> +<span class="kn">import</span> <span class="nn">traceback</span> +<span class="kn">import</span> <span class="nn">warnings</span> +<span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">namedtuple</span> +<span class="kn">from</span> <span class="nn">types</span> <span class="k">import</span> <span class="n">FunctionType</span><span class="p">,</span> <span class="n">MethodType</span><span class="p">,</span> <span class="n">ModuleType</span> + +<span class="kn">from</span> <span class="nn">six</span> <span class="k">import</span> <span class="n">PY2</span><span class="p">,</span> <span class="n">iteritems</span> + +<span class="kn">from</span> <span class="nn">sphinx.util</span> <span class="k">import</span> <span class="n">logging</span> +<span class="kn">from</span> <span class="nn">sphinx.util.inspect</span> <span class="k">import</span> <span class="n">isenumclass</span><span class="p">,</span> <span class="n">safe_getattr</span> + +<span class="k">if</span> <span class="kc">False</span><span class="p">:</span> + <span class="c1"># For type annotation</span> + <span class="kn">from</span> <span class="nn">typing</span> <span class="k">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Generator</span><span class="p">,</span> <span class="n">Iterator</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Tuple</span> <span class="c1"># NOQA</span> + +<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span> + + +<span class="k">class</span> <span class="nc">_MockObject</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> + <span class="sd">"""Used by autodoc_mock_imports."""</span> + + <span class="k">def</span> <span class="nf">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> + <span class="c1"># type: (Any, Any) -> Any</span> + <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">3</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="nb">tuple</span><span class="p">)</span> <span class="ow">and</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="vm">__class__</span> <span class="ow">is</span> <span class="bp">cls</span><span class="p">:</span> + <span class="c1"># subclassing MockObject</span> + <span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">(</span><span class="n">_MockObject</span><span class="p">,),</span> <span class="n">args</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="c1"># type: ignore</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">_MockObject</span><span class="p">,</span> <span class="bp">cls</span><span class="p">)</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> + <span class="c1"># type: (Any, Any) -> None</span> + <span class="bp">self</span><span class="o">.</span><span class="vm">__qualname__</span> <span class="o">=</span> <span class="s1">''</span> + + <span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="c1"># type: () -> int</span> + <span class="k">return</span> <span class="mi">0</span> + + <span class="k">def</span> <span class="nf">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span> + <span class="c1"># type: (str) -> bool</span> + <span class="k">return</span> <span class="kc">False</span> + + <span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="c1"># type: () -> Iterator</span> + <span class="k">return</span> <span class="nb">iter</span><span class="p">([])</span> + + <span class="k">def</span> <span class="nf">__mro_entries__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bases</span><span class="p">):</span> + <span class="c1"># type: (Tuple) -> Tuple</span> + <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">,)</span> + + <span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span> + <span class="c1"># type: (str) -> _MockObject</span> + <span class="k">return</span> <span class="bp">self</span> + + <span class="k">def</span> <span class="nf">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span> + <span class="c1"># type: (str) -> _MockObject</span> + <span class="k">return</span> <span class="bp">self</span> + + <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span> + <span class="c1"># type: (Any, Any) -> Any</span> + <span class="k">if</span> <span class="n">args</span> <span class="ow">and</span> <span class="nb">type</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="ow">in</span> <span class="p">[</span><span class="n">FunctionType</span><span class="p">,</span> <span class="n">MethodType</span><span class="p">]:</span> + <span class="c1"># Appears to be a decorator, pass through unchanged</span> + <span class="k">return</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> + <span class="k">return</span> <span class="bp">self</span> + + +<span class="k">class</span> <span class="nc">_MockModule</span><span class="p">(</span><span class="n">ModuleType</span><span class="p">):</span> + <span class="sd">"""Used by autodoc_mock_imports."""</span> + <span class="vm">__file__</span> <span class="o">=</span> <span class="s1">'/dev/null'</span> + + <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">loader</span><span class="p">):</span> + <span class="c1"># type: (str, _MockImporter) -> None</span> + <span class="bp">self</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__package__</span> <span class="o">=</span> <span class="n">name</span> + <span class="bp">self</span><span class="o">.</span><span class="n">__loader__</span> <span class="o">=</span> <span class="n">loader</span> + <span class="bp">self</span><span class="o">.</span><span class="n">__all__</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># type: List[str]</span> + <span class="bp">self</span><span class="o">.</span><span class="n">__path__</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># type: List[str]</span> + + <span class="k">def</span> <span class="nf">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> + <span class="c1"># type: (str) -> _MockObject</span> + <span class="n">o</span> <span class="o">=</span> <span class="n">_MockObject</span><span class="p">()</span> + <span class="n">o</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__name__</span> + <span class="k">return</span> <span class="n">o</span> + + +<span class="k">class</span> <span class="nc">_MockImporter</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> + <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">names</span><span class="p">):</span> + <span class="c1"># type: (List[str]) -> None</span> + <span class="bp">self</span><span class="o">.</span><span class="n">names</span> <span class="o">=</span> <span class="n">names</span> + <span class="bp">self</span><span class="o">.</span><span class="n">mocked_modules</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># type: List[str]</span> + <span class="c1"># enable hook by adding itself to meta_path</span> + <span class="n">sys</span><span class="o">.</span><span class="n">meta_path</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">disable</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="c1"># type: () -> None</span> + <span class="c1"># remove `self` from `sys.meta_path` to disable import hook</span> + <span class="n">sys</span><span class="o">.</span><span class="n">meta_path</span> <span class="o">=</span> <span class="p">[</span><span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">meta_path</span> <span class="k">if</span> <span class="n">i</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">self</span><span class="p">]</span> + <span class="c1"># remove mocked modules from sys.modules to avoid side effects after</span> + <span class="c1"># running auto-documenter</span> + <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">mocked_modules</span><span class="p">:</span> + <span class="k">if</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span> + <span class="k">del</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">m</span><span class="p">]</span> + + <span class="k">def</span> <span class="nf">find_module</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> + <span class="c1"># type: (str, str) -> Any</span> + <span class="c1"># check if name is (or is a descendant of) one of our base_packages</span> + <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">names</span><span class="p">:</span> + <span class="k">if</span> <span class="n">n</span> <span class="o">==</span> <span class="n">name</span> <span class="ow">or</span> <span class="n">name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">n</span> <span class="o">+</span> <span class="s1">'.'</span><span class="p">):</span> + <span class="k">return</span> <span class="bp">self</span> + <span class="k">return</span> <span class="kc">None</span> + + <span class="k">def</span> <span class="nf">load_module</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> + <span class="c1"># type: (str) -> ModuleType</span> + <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span> + <span class="c1"># module has already been imported, return it</span> + <span class="k">return</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> + <span class="k">else</span><span class="p">:</span> + <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'[autodoc] adding a mock module </span><span class="si">%s</span><span class="s1">!'</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> + <span class="n">module</span> <span class="o">=</span> <span class="n">_MockModule</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span> + <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">module</span> + <span class="bp">self</span><span class="o">.</span><span class="n">mocked_modules</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> + <span class="k">return</span> <span class="n">module</span> + + +<span class="nd">@contextlib</span><span class="o">.</span><span class="n">contextmanager</span> +<span class="k">def</span> <span class="nf">mock</span><span class="p">(</span><span class="n">names</span><span class="p">):</span> + <span class="c1"># type: (List[str]) -> Generator</span> + <span class="k">try</span><span class="p">:</span> + <span class="n">importer</span> <span class="o">=</span> <span class="n">_MockImporter</span><span class="p">(</span><span class="n">names</span><span class="p">)</span> + <span class="k">yield</span> + <span class="k">finally</span><span class="p">:</span> + <span class="n">importer</span><span class="o">.</span><span class="n">disable</span><span class="p">()</span> + + +<span class="k">def</span> <span class="nf">import_module</span><span class="p">(</span><span class="n">modname</span><span class="p">,</span> <span class="n">warningiserror</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> + <span class="c1"># type: (str, bool) -> Any</span> + <span class="sd">"""</span> +<span class="sd"> Call __import__(modname), convert exceptions to ImportError</span> +<span class="sd"> """</span> + <span class="k">try</span><span class="p">:</span> + <span class="k">with</span> <span class="n">warnings</span><span class="o">.</span><span class="n">catch_warnings</span><span class="p">():</span> + <span class="n">warnings</span><span class="o">.</span><span class="n">filterwarnings</span><span class="p">(</span><span class="s2">"ignore"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="ne">ImportWarning</span><span class="p">)</span> + <span class="k">with</span> <span class="n">logging</span><span class="o">.</span><span class="n">skip_warningiserror</span><span class="p">(</span><span class="ow">not</span> <span class="n">warningiserror</span><span class="p">):</span> + <span class="nb">__import__</span><span class="p">(</span><span class="n">modname</span><span class="p">)</span> + <span class="k">return</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">modname</span><span class="p">]</span> + <span class="k">except</span> <span class="ne">BaseException</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span> + <span class="c1"># Importing modules may cause any side effects, including</span> + <span class="c1"># SystemExit, so we need to catch all errors.</span> + <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_exc</span><span class="p">())</span> + + +<span class="k">def</span> <span class="nf">import_object</span><span class="p">(</span><span class="n">modname</span><span class="p">,</span> <span class="n">objpath</span><span class="p">,</span> <span class="n">objtype</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="n">attrgetter</span><span class="o">=</span><span class="n">safe_getattr</span><span class="p">,</span> <span class="n">warningiserror</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> + <span class="c1"># type: (str, List[unicode], str, Callable[[Any, unicode], Any], bool) -> Any</span> + <span class="k">if</span> <span class="n">objpath</span><span class="p">:</span> + <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'[autodoc] from </span><span class="si">%s</span><span class="s1"> import </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">modname</span><span class="p">,</span> <span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">objpath</span><span class="p">))</span> + <span class="k">else</span><span class="p">:</span> + <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'[autodoc] import </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">modname</span><span class="p">)</span> + + <span class="k">try</span><span class="p">:</span> + <span class="n">module</span> <span class="o">=</span> <span class="kc">None</span> + <span class="n">exc_on_importing</span> <span class="o">=</span> <span class="kc">None</span> + <span class="n">objpath</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">objpath</span><span class="p">)</span> + <span class="k">while</span> <span class="n">module</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> + <span class="k">try</span><span class="p">:</span> + <span class="n">module</span> <span class="o">=</span> <span class="n">import_module</span><span class="p">(</span><span class="n">modname</span><span class="p">,</span> <span class="n">warningiserror</span><span class="o">=</span><span class="n">warningiserror</span><span class="p">)</span> + <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'[autodoc] import </span><span class="si">%s</span><span class="s1"> => </span><span class="si">%r</span><span class="s1">'</span><span class="p">,</span> <span class="n">modname</span><span class="p">,</span> <span class="n">module</span><span class="p">)</span> + <span class="k">except</span> <span class="ne">ImportError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span> + <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'[autodoc] import </span><span class="si">%s</span><span class="s1"> => failed'</span><span class="p">,</span> <span class="n">modname</span><span class="p">)</span> + <span class="n">exc_on_importing</span> <span class="o">=</span> <span class="n">exc</span> + <span class="k">if</span> <span class="s1">'.'</span> <span class="ow">in</span> <span class="n">modname</span><span class="p">:</span> + <span class="c1"># retry with parent module</span> + <span class="n">modname</span><span class="p">,</span> <span class="n">name</span> <span class="o">=</span> <span class="n">modname</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> + <span class="n">objpath</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">raise</span> + + <span class="n">obj</span> <span class="o">=</span> <span class="n">module</span> + <span class="n">parent</span> <span class="o">=</span> <span class="kc">None</span> + <span class="n">object_name</span> <span class="o">=</span> <span class="kc">None</span> + <span class="k">for</span> <span class="n">attrname</span> <span class="ow">in</span> <span class="n">objpath</span><span class="p">:</span> + <span class="n">parent</span> <span class="o">=</span> <span class="n">obj</span> + <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'[autodoc] getattr(_, </span><span class="si">%r</span><span class="s1">)'</span><span class="p">,</span> <span class="n">attrname</span><span class="p">)</span> + <span class="n">obj</span> <span class="o">=</span> <span class="n">attrgetter</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">attrname</span><span class="p">)</span> + <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'[autodoc] => </span><span class="si">%r</span><span class="s1">'</span><span class="p">,</span> <span class="n">obj</span><span class="p">)</span> + <span class="n">object_name</span> <span class="o">=</span> <span class="n">attrname</span> + <span class="k">return</span> <span class="p">[</span><span class="n">module</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">object_name</span><span class="p">,</span> <span class="n">obj</span><span class="p">]</span> + <span class="k">except</span> <span class="p">(</span><span class="ne">AttributeError</span><span class="p">,</span> <span class="ne">ImportError</span><span class="p">)</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span> + <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="ne">AttributeError</span><span class="p">)</span> <span class="ow">and</span> <span class="n">exc_on_importing</span><span class="p">:</span> + <span class="c1"># restore ImportError</span> + <span class="n">exc</span> <span class="o">=</span> <span class="n">exc_on_importing</span> + + <span class="k">if</span> <span class="n">objpath</span><span class="p">:</span> + <span class="n">errmsg</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'autodoc: failed to import </span><span class="si">%s</span><span class="s1"> </span><span class="si">%r</span><span class="s1"> from module </span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> + <span class="p">(</span><span class="n">objtype</span><span class="p">,</span> <span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">objpath</span><span class="p">),</span> <span class="n">modname</span><span class="p">))</span> + <span class="k">else</span><span class="p">:</span> + <span class="n">errmsg</span> <span class="o">=</span> <span class="s1">'autodoc: failed to import </span><span class="si">%s</span><span class="s1"> </span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">objtype</span><span class="p">,</span> <span class="n">modname</span><span class="p">)</span> + + <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="ne">ImportError</span><span class="p">):</span> + <span class="c1"># import_module() raises ImportError having real exception obj and</span> + <span class="c1"># traceback</span> + <span class="n">real_exc</span><span class="p">,</span> <span class="n">traceback_msg</span> <span class="o">=</span> <span class="n">exc</span><span class="o">.</span><span class="n">args</span> + <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">real_exc</span><span class="p">,</span> <span class="ne">SystemExit</span><span class="p">):</span> + <span class="n">errmsg</span> <span class="o">+=</span> <span class="p">(</span><span class="s1">'; the module executes module level statement '</span> + <span class="s1">'and it might call sys.exit().'</span><span class="p">)</span> + <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">real_exc</span><span class="p">,</span> <span class="ne">ImportError</span><span class="p">)</span> <span class="ow">and</span> <span class="n">real_exc</span><span class="o">.</span><span class="n">args</span><span class="p">:</span> + <span class="n">errmsg</span> <span class="o">+=</span> <span class="s1">'; the following exception was raised:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">real_exc</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> + <span class="k">else</span><span class="p">:</span> + <span class="n">errmsg</span> <span class="o">+=</span> <span class="s1">'; the following exception was raised:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">traceback_msg</span> + <span class="k">else</span><span class="p">:</span> + <span class="n">errmsg</span> <span class="o">+=</span> <span class="s1">'; the following exception was raised:</span><span class="se">\n</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_exc</span><span class="p">()</span> + + <span class="k">if</span> <span class="n">PY2</span><span class="p">:</span> + <span class="n">errmsg</span> <span class="o">=</span> <span class="n">errmsg</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span> <span class="c1"># type: ignore</span> + <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">errmsg</span><span class="p">)</span> + <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="n">errmsg</span><span class="p">)</span> + + +<span class="n">Attribute</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span><span class="s1">'Attribute'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'name'</span><span class="p">,</span> <span class="s1">'directly_defined'</span><span class="p">,</span> <span class="s1">'value'</span><span class="p">])</span> + + +<span class="k">def</span> <span class="nf">get_object_members</span><span class="p">(</span><span class="n">subject</span><span class="p">,</span> <span class="n">objpath</span><span class="p">,</span> <span class="n">attrgetter</span><span class="p">,</span> <span class="n">analyzer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> + <span class="c1"># type: (Any, List[unicode], Callable, Any) -> Dict[str, Attribute] # NOQA</span> + <span class="sd">"""Get members and attributes of target object."""</span> + <span class="c1"># the members directly defined in the class</span> + <span class="n">obj_dict</span> <span class="o">=</span> <span class="n">attrgetter</span><span class="p">(</span><span class="n">subject</span><span class="p">,</span> <span class="s1">'__dict__'</span><span class="p">,</span> <span class="p">{})</span> + + <span class="c1"># Py34 doesn't have enum members in __dict__.</span> + <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[:</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span> <span class="ow">and</span> <span class="n">isenumclass</span><span class="p">(</span><span class="n">subject</span><span class="p">):</span> + <span class="n">obj_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">obj_dict</span><span class="p">)</span> + <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">subject</span><span class="o">.</span><span class="n">__members__</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> + <span class="n">obj_dict</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span> + + <span class="n">members</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># type: Dict[str, Attribute]</span> + + <span class="c1"># enum members</span> + <span class="k">if</span> <span class="n">isenumclass</span><span class="p">(</span><span class="n">subject</span><span class="p">):</span> + <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">subject</span><span class="o">.</span><span class="n">__members__</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> + <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">members</span><span class="p">:</span> + <span class="n">members</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> + + <span class="n">superclass</span> <span class="o">=</span> <span class="n">subject</span><span class="o">.</span><span class="vm">__mro__</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> + <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">iteritems</span><span class="p">(</span><span class="n">obj_dict</span><span class="p">):</span> + <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">superclass</span><span class="o">.</span><span class="vm">__dict__</span><span class="p">:</span> + <span class="n">members</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> + + <span class="c1"># other members</span> + <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">subject</span><span class="p">):</span> + <span class="k">try</span><span class="p">:</span> + <span class="n">value</span> <span class="o">=</span> <span class="n">attrgetter</span><span class="p">(</span><span class="n">subject</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> + <span class="n">directly_defined</span> <span class="o">=</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">obj_dict</span> + <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">members</span><span class="p">:</span> + <span class="n">members</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">directly_defined</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> + <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> + <span class="k">continue</span> + + <span class="k">if</span> <span class="n">analyzer</span><span class="p">:</span> + <span class="c1"># append instance attributes (cf. self.attr1) if analyzer knows</span> + <span class="kn">from</span> <span class="nn">sphinx.ext.autodoc</span> <span class="k">import</span> <span class="n">INSTANCEATTR</span> + + <span class="n">namespace</span> <span class="o">=</span> <span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">objpath</span><span class="p">)</span> + <span class="k">for</span> <span class="p">(</span><span class="n">ns</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> <span class="ow">in</span> <span class="n">analyzer</span><span class="o">.</span><span class="n">find_attr_docs</span><span class="p">():</span> + <span class="k">if</span> <span class="n">namespace</span> <span class="o">==</span> <span class="n">ns</span> <span class="ow">and</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">members</span><span class="p">:</span> + <span class="n">members</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">INSTANCEATTR</span><span class="p">)</span> + + <span class="k">return</span> <span class="n">members</span> +</pre></div> + + </div> + + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2018, Jeremy Ernst + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html>
\ No newline at end of file |