<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.docbuilder</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
Module docbuilder
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.docbuilder-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.docbuilder-module.html">Module epydoc.docbuilder</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># epydoc -- Documentation Builder</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Copyright (C) 2005 Edward Loper</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Author: Edward Loper <edloper@loper.org></tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># URL: <http://epydoc.sf.net></tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># $Id: docbuilder.py 1683 2008-01-29 22:17:39Z edloper $</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-docstring">Construct data structures that encode the API documentation for Python</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">objects. These data structures are created using a series of steps:</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring"> 1. B{Building docs}: Extract basic information about the objects,</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring"> and objects that are related to them. This can be done by</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring"> introspecting the objects' values (with L{epydoc.docintrospecter}; or</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring"> by parsing their source code (with L{epydoc.docparser}.</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring"> 2. B{Merging}: Combine the information obtained from introspection &</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring"> parsing each object into a single structure.</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-docstring"> 3. B{Linking}: Replace any 'pointers' that were created for imported</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-docstring"> variables by their target (if it's available).</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring"> 4. B{Naming}: Chose a unique 'canonical name' for each</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring"> object.</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-docstring"> 5. B{Docstring Parsing}: Parse the docstring of each object, and</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-docstring"> extract any pertinant information.</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-docstring"> 6. B{Inheritance}: Add information about variables that classes</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring"> inherit from their base classes.</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring">The documentation information for each individual object is</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring">represented using an L{APIDoc}; and the documentation for a collection</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring">of objects is represented using a L{DocIndex}.</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring">The main interface to C{epydoc.docbuilder} consists of two functions:</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring"> - L{build_doc()} -- Builds documentation for a single item, and</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"> returns it as an L{APIDoc} object.</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring"> - L{build_doc_index()} -- Builds documentation for a collection of</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> items, and returns it as a L{DocIndex} object.</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring">The remaining functions are used by these two main functions to</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring">perform individual steps in the creation of the documentation.</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring">@group Documentation Construction: build_doc, build_doc_index,</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> _get_docs_from_*, _report_valdoc_progress</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring">@group Merging: *MERGE*, *merge*</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring">@group Linking: link_imports</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring">@group Naming: _name_scores, _unreachable_names, assign_canonical_names,</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> _var_shadows_self, _fix_self_shadowing_var, _unreachable_name_for</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring">@group Inheritance: inherit_docs, _inherit_info</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext en'</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Contents</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## 1. build_doc() & build_doc_index() -- the main interface.</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## 2. merge_docs() -- helper, used to merge parse & introspect info</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## 3. link_imports() -- helper, used to connect imported vars w/ values</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## 4. assign_canonical_names() -- helper, used to set canonical names</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## 5. inherit_docs() -- helper, used to inherit docs from base classes</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Imports</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.path=epydoc.apidoc.ModuleDoc-class.html#path"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-0', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-name">__builtin__</tt><tt class="py-op">,</tt> <tt class="py-name">imp</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">,</tt> <tt class="py-name">inspect</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Package epydoc=epydoc-module.html"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-1', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Module epydoc.apidoc=epydoc.apidoc-module.html"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-2', 'apidoc', 'link-2');">apidoc</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-3', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Module epydoc.docintrospecter=epydoc.docintrospecter-module.html"><a title="epydoc.docintrospecter" class="py-name" href="#" onclick="return doclink('link-4', 'docintrospecter', 'link-4');">docintrospecter</a></tt> <tt class="py-keyword">import</tt> <tt id="link-5" class="py-name" targets="Function epydoc.docintrospecter.introspect_docs()=epydoc.docintrospecter-module.html#introspect_docs"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-5', 'introspect_docs', 'link-5');">introspect_docs</a></tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-6" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-6', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Module epydoc.docparser=epydoc.docparser-module.html"><a title="epydoc.docparser" class="py-name" href="#" onclick="return doclink('link-7', 'docparser', 'link-7');">docparser</a></tt> <tt class="py-keyword">import</tt> <tt id="link-8" class="py-name" targets="Function epydoc.docparser.parse_docs()=epydoc.docparser-module.html#parse_docs"><a title="epydoc.docparser.parse_docs" class="py-name" href="#" onclick="return doclink('link-8', 'parse_docs', 'link-8');">parse_docs</a></tt><tt class="py-op">,</tt> <tt id="link-9" class="py-name" targets="Class epydoc.docparser.ParseError=epydoc.docparser.ParseError-class.html,Class epydoc.markup.ParseError=epydoc.markup.ParseError-class.html"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-9', 'ParseError', 'link-9');">ParseError</a></tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-10" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-10', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Module epydoc.docstringparser=epydoc.docstringparser-module.html"><a title="epydoc.docstringparser" class="py-name" href="#" onclick="return doclink('link-11', 'docstringparser', 'link-11');">docstringparser</a></tt> <tt class="py-keyword">import</tt> <tt id="link-12" class="py-name" targets="Function epydoc.docstringparser.parse_docstring()=epydoc.docstringparser-module.html#parse_docstring,Function epydoc.markup.epytext.parse_docstring()=epydoc.markup.epytext-module.html#parse_docstring,Function epydoc.markup.javadoc.parse_docstring()=epydoc.markup.javadoc-module.html#parse_docstring,Function epydoc.markup.plaintext.parse_docstring()=epydoc.markup.plaintext-module.html#parse_docstring,Function epydoc.markup.restructuredtext.parse_docstring()=epydoc.markup.restructuredtext-module.html#parse_docstring"><a title="epydoc.docstringparser.parse_docstring
epydoc.markup.epytext.parse_docstring
epydoc.markup.javadoc.parse_docstring
epydoc.markup.plaintext.parse_docstring
epydoc.markup.restructuredtext.parse_docstring" class="py-name" href="#" onclick="return doclink('link-12', 'parse_docstring', 'link-12');">parse_docstring</a></tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-13" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-13', 'epydoc', 'link-1');">epydoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-14" class="py-name" targets="Method epydoc.cli.ConsoleLogger.log()=epydoc.cli.ConsoleLogger-class.html#log,Method epydoc.cli.HTMLLogger.log()=epydoc.cli.HTMLLogger-class.html#log,Method epydoc.gui.GUILogger.log()=epydoc.gui.GUILogger-class.html#log,Module epydoc.log=epydoc.log-module.html,Method epydoc.log.Logger.log()=epydoc.log.Logger-class.html#log,Method epydoc.log.SimpleLogger.log()=epydoc.log.SimpleLogger-class.html#log"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-14', 'log', 'link-14');">log</a></tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-15" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-15', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Module epydoc.test.util=epydoc.test.util-module.html,Module epydoc.util=epydoc.util-module.html"><a title="epydoc.test.util
epydoc.util" class="py-name" href="#" onclick="return doclink('link-16', 'util', 'link-16');">util</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-17" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-17', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-18" class="py-name" targets="Module epydoc.compat=epydoc.compat-module.html"><a title="epydoc.compat" class="py-name" href="#" onclick="return doclink('link-18', 'compat', 'link-18');">compat</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> <tt class="py-comment"># Backwards compatibility</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## 1. build_doc()</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="BuildOptions"></a><div id="BuildOptions-def"><a name="L83"></a><tt class="py-lineno"> 83</tt> <a class="py-toggle" href="#" id="BuildOptions-toggle" onclick="return toggle('BuildOptions');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docbuilder.BuildOptions-class.html">BuildOptions</a><tt class="py-op">:</tt> </tt>
</div><div id="BuildOptions-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="BuildOptions-expanded"><a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> Holds the parameters for a documentation building process.</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="BuildOptions.__init__"></a><div id="BuildOptions.__init__-def"><a name="L87"></a><tt class="py-lineno"> 87</tt> <a class="py-toggle" href="#" id="BuildOptions.__init__-toggle" onclick="return toggle('BuildOptions.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder.BuildOptions-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">introspect</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-param">parse</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-param">exclude_introspect</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">exclude_parse</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-param">add_submodules</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="BuildOptions.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="BuildOptions.__init__-expanded"><a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">introspect</tt> <tt class="py-op">=</tt> <tt class="py-name">introspect</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name" targets="Function epydoc.markup.epytext.parse()=epydoc.markup.epytext-module.html#parse,Function epydoc.markup.parse()=epydoc.markup-module.html#parse"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-19', 'parse', 'link-19');">parse</a></tt> <tt class="py-op">=</tt> <tt id="link-20" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-20', 'parse', 'link-19');">parse</a></tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">exclude_introspect</tt> <tt class="py-op">=</tt> <tt class="py-name">exclude_introspect</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">exclude_parse</tt> <tt class="py-op">=</tt> <tt class="py-name">exclude_parse</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">add_submodules</tt> <tt class="py-op">=</tt> <tt class="py-name">add_submodules</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-comment"># Test for pattern syntax and compile them into pattern objects.</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_introspect_regexp</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">exclude_introspect</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-name">exclude_introspect</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parse_regexp</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">exclude_parse</tt> </tt>
<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-name">exclude_parse</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">exc</tt><tt class="py-op">:</tt> </tt>
<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"> <tt id="link-21" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-21', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-22" class="py-name" targets="Function epydoc.log.error()=epydoc.log-module.html#error"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-22', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'Error in regular expression pattern: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">exc</tt><tt class="py-op">)</tt> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt>
</div><a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"> </tt>
<a name="BuildOptions.must_introspect"></a><div id="BuildOptions.must_introspect-def"><a name="L106"></a><tt class="py-lineno"> 106</tt> <a class="py-toggle" href="#" id="BuildOptions.must_introspect-toggle" onclick="return toggle('BuildOptions.must_introspect');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder.BuildOptions-class.html#must_introspect">must_introspect</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="BuildOptions.must_introspect-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="BuildOptions.must_introspect-expanded"><a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"><tt class="py-docstring"> Return C{True} if a module is to be introsepcted with the current</tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"><tt class="py-docstring"> settings.</tt> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"><tt class="py-docstring"> @param name: The name of the module to test</tt> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"><tt class="py-docstring"> @type name: L{DottedName} or C{str}</tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">introspect</tt> \ </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name" targets="Method epydoc.docbuilder.BuildOptions._matches_filter()=epydoc.docbuilder.BuildOptions-class.html#_matches_filter"><a title="epydoc.docbuilder.BuildOptions._matches_filter" class="py-name" href="#" onclick="return doclink('link-23', '_matches_filter', 'link-23');">_matches_filter</a></tt><tt class="py-op">(</tt><tt id="link-24" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.name=epydoc.apidoc.VariableDoc-class.html#name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-24', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_introspect_regexp</tt><tt class="py-op">)</tt> </tt>
</div><a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"> </tt>
<a name="BuildOptions.must_parse"></a><div id="BuildOptions.must_parse-def"><a name="L117"></a><tt class="py-lineno"> 117</tt> <a class="py-toggle" href="#" id="BuildOptions.must_parse-toggle" onclick="return toggle('BuildOptions.must_parse');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder.BuildOptions-class.html#must_parse">must_parse</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="BuildOptions.must_parse-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="BuildOptions.must_parse-expanded"><a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"><tt class="py-docstring"> Return C{True} if a module is to be parsed with the current settings.</tt> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"><tt class="py-docstring"> @param name: The name of the module to test</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"><tt class="py-docstring"> @type name: L{DottedName} or C{str}</tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-25', 'parse', 'link-19');">parse</a></tt> \ </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="epydoc.docbuilder.BuildOptions._matches_filter" class="py-name" href="#" onclick="return doclink('link-26', '_matches_filter', 'link-23');">_matches_filter</a></tt><tt class="py-op">(</tt><tt id="link-27" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-27', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_parse_regexp</tt><tt class="py-op">)</tt> </tt>
</div><a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"> </tt>
<a name="BuildOptions._matches_filter"></a><div id="BuildOptions._matches_filter-def"><a name="L127"></a><tt class="py-lineno"> 127</tt> <a class="py-toggle" href="#" id="BuildOptions._matches_filter-toggle" onclick="return toggle('BuildOptions._matches_filter');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder.BuildOptions-class.html#_matches_filter">_matches_filter</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">regexp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="BuildOptions._matches_filter-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="BuildOptions._matches_filter-expanded"><a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-docstring"> Test if a module name matches a pattern.</tt> </tt>
<a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"><tt class="py-docstring"> @param name: The name of the module to test</tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"><tt class="py-docstring"> @type name: L{DottedName} or C{str}</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"><tt class="py-docstring"> @param regexp: The pattern object to match C{name} against.</tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"><tt class="py-docstring"> If C{None}, return C{False}</tt> </tt>
<a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"><tt class="py-docstring"> @type regexp: C{pattern}</tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{True} if C{name} in dotted format matches C{regexp},</tt> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"><tt class="py-docstring"> else C{False}</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{bool}</tt> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">regexp</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-28" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-28', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt id="link-29" class="py-name" targets="Class epydoc.apidoc.DottedName=epydoc.apidoc.DottedName-class.html"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-29', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"> <tt id="link-30" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-30', 'name', 'link-24');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-31" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-31', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">bool</tt><tt class="py-op">(</tt><tt class="py-name">regexp</tt><tt class="py-op">.</tt><tt class="py-name">search</tt><tt class="py-op">(</tt><tt id="link-32" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-32', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"> </tt>
<a name="build_doc"></a><div id="build_doc-def"><a name="L148"></a><tt class="py-lineno"> 148</tt> <a class="py-toggle" href="#" id="build_doc-toggle" onclick="return toggle('build_doc');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#build_doc">build_doc</a><tt class="py-op">(</tt><tt class="py-param">item</tt><tt class="py-op">,</tt> <tt class="py-param">introspect</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-param">parse</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-param">add_submodules</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"> <tt class="py-param">exclude_introspect</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">exclude_parse</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="build_doc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="build_doc-expanded"><a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"><tt class="py-docstring"> Build API documentation for a given item, and return it as</tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"><tt class="py-docstring"> an L{APIDoc} object.</tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{APIDoc}</tt> </tt>
<a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"><tt class="py-docstring"> @param item: The item to document, specified using any of the</tt> </tt>
<a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"><tt class="py-docstring"> following:</tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"><tt class="py-docstring"> - A string, naming a python package directory</tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"><tt class="py-docstring"> (e.g., C{'epydoc/markup'})</tt> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"><tt class="py-docstring"> - A string, naming a python file</tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"><tt class="py-docstring"> (e.g., C{'epydoc/docparser.py'})</tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"><tt class="py-docstring"> - A string, naming a python object</tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"><tt class="py-docstring"> (e.g., C{'epydoc.docparser.DocParser'})</tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"><tt class="py-docstring"> - Any (non-string) python object</tt> </tt>
<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"><tt class="py-docstring"> (e.g., C{list.append})</tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"><tt class="py-docstring"> @param introspect: If true, then use introspection to examine the</tt> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"><tt class="py-docstring"> specified items. Otherwise, just use parsing.</tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-docstring"> @param parse: If true, then use parsing to examine the specified</tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-docstring"> items. Otherwise, just use introspection.</tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"> <tt class="py-name">docindex</tt> <tt class="py-op">=</tt> <tt id="link-33" class="py-name" targets="Function epydoc.docbuilder.build_doc_index()=epydoc.docbuilder-module.html#build_doc_index"><a title="epydoc.docbuilder.build_doc_index" class="py-name" href="#" onclick="return doclink('link-33', 'build_doc_index', 'link-33');">build_doc_index</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">item</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">introspect</tt><tt class="py-op">,</tt> <tt id="link-34" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-34', 'parse', 'link-19');">parse</a></tt><tt class="py-op">,</tt> <tt class="py-name">add_submodules</tt><tt class="py-op">,</tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"> <tt class="py-name">exclude_introspect</tt><tt class="py-op">=</tt><tt class="py-name">exclude_introspect</tt><tt class="py-op">,</tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"> <tt class="py-name">exclude_parse</tt><tt class="py-op">=</tt><tt class="py-name">exclude_parse</tt><tt class="py-op">)</tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
</div><a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"> </tt>
<a name="build_doc_index"></a><div id="build_doc_index-def"><a name="L175"></a><tt class="py-lineno"> 175</tt> <a class="py-toggle" href="#" id="build_doc_index-toggle" onclick="return toggle('build_doc_index');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#build_doc_index">build_doc_index</a><tt class="py-op">(</tt><tt class="py-param">items</tt><tt class="py-op">,</tt> <tt class="py-param">introspect</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-param">parse</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-param">add_submodules</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"> <tt class="py-param">exclude_introspect</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">exclude_parse</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="build_doc_index-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="build_doc_index-expanded"><a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"><tt class="py-docstring"> Build API documentation for the given list of items, and</tt> </tt>
<a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"><tt class="py-docstring"> return it in the form of a L{DocIndex}.</tt> </tt>
<a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{DocIndex}</tt> </tt>
<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"><tt class="py-docstring"> @param items: The items to document, specified using any of the</tt> </tt>
<a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"><tt class="py-docstring"> following:</tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"><tt class="py-docstring"> - A string, naming a python package directory</tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-docstring"> (e.g., C{'epydoc/markup'})</tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-docstring"> - A string, naming a python file</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"><tt class="py-docstring"> (e.g., C{'epydoc/docparser.py'})</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"><tt class="py-docstring"> - A string, naming a python object</tt> </tt>
<a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"><tt class="py-docstring"> (e.g., C{'epydoc.docparser.DocParser'})</tt> </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"><tt class="py-docstring"> - Any (non-string) python object</tt> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"><tt class="py-docstring"> (e.g., C{list.append})</tt> </tt>
<a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"><tt class="py-docstring"> @param introspect: If true, then use introspection to examine the</tt> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"><tt class="py-docstring"> specified items. Otherwise, just use parsing.</tt> </tt>
<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"><tt class="py-docstring"> @param parse: If true, then use parsing to examine the specified</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"><tt class="py-docstring"> items. Otherwise, just use introspection.</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"> <tt class="py-name">options</tt> <tt class="py-op">=</tt> <tt id="link-35" class="py-name" targets="Class epydoc.docbuilder.BuildOptions=epydoc.docbuilder.BuildOptions-class.html"><a title="epydoc.docbuilder.BuildOptions" class="py-name" href="#" onclick="return doclink('link-35', 'BuildOptions', 'link-35');">BuildOptions</a></tt><tt class="py-op">(</tt><tt id="link-36" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-36', 'parse', 'link-19');">parse</a></tt><tt class="py-op">=</tt><tt id="link-37" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-37', 'parse', 'link-19');">parse</a></tt><tt class="py-op">,</tt> <tt class="py-name">introspect</tt><tt class="py-op">=</tt><tt class="py-name">introspect</tt><tt class="py-op">,</tt> </tt>
<a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"> <tt class="py-name">exclude_introspect</tt><tt class="py-op">=</tt><tt class="py-name">exclude_introspect</tt><tt class="py-op">,</tt> <tt class="py-name">exclude_parse</tt><tt class="py-op">=</tt><tt class="py-name">exclude_parse</tt><tt class="py-op">,</tt> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"> <tt class="py-name">add_submodules</tt><tt class="py-op">=</tt><tt class="py-name">add_submodules</tt><tt class="py-op">)</tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"> <tt class="py-comment"># log.error already reported by constructor.</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"> <tt class="py-comment"># Get the basic docs for each item.</tt> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">doc_pairs</tt> <tt class="py-op">=</tt> <tt id="link-38" class="py-name" targets="Function epydoc.docbuilder._get_docs_from_items()=epydoc.docbuilder-module.html#_get_docs_from_items"><a title="epydoc.docbuilder._get_docs_from_items" class="py-name" href="#" onclick="return doclink('link-38', '_get_docs_from_items', 'link-38');">_get_docs_from_items</a></tt><tt class="py-op">(</tt><tt class="py-name">items</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">)</tt> </tt>
<a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"> <tt class="py-comment"># Merge the introspection & parse docs.</tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-39', 'parse', 'link-19');">parse</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">introspect</tt><tt class="py-op">:</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> <tt id="link-40" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-40', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-41" class="py-name" targets="Method epydoc.cli.ConsoleLogger.start_progress()=epydoc.cli.ConsoleLogger-class.html#start_progress,Method epydoc.cli.UnifiedProgressConsoleLogger.start_progress()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#start_progress,Method epydoc.gui.GUILogger.start_progress()=epydoc.gui.GUILogger-class.html#start_progress,Method epydoc.log.Logger.start_progress()=epydoc.log.Logger-class.html#start_progress,Function epydoc.log.start_progress()=epydoc.log-module.html#start_progress"><a title="epydoc.cli.ConsoleLogger.start_progress
epydoc.cli.UnifiedProgressConsoleLogger.start_progress
epydoc.gui.GUILogger.start_progress
epydoc.log.Logger.start_progress
epydoc.log.start_progress" class="py-name" href="#" onclick="return doclink('link-41', 'start_progress', 'link-41');">start_progress</a></tt><tt class="py-op">(</tt><tt class="py-string">'Merging parsed & introspected information'</tt><tt class="py-op">)</tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">doc_pairs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">parse_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-42" class="py-name" targets="Variable epydoc.apidoc.GenericValueDoc.canonical_name=epydoc.apidoc.GenericValueDoc-class.html#canonical_name,Variable epydoc.apidoc.ValueDoc.canonical_name=epydoc.apidoc.ValueDoc-class.html#canonical_name,Variable epydoc.apidoc.VariableDoc.canonical_name=epydoc.apidoc.VariableDoc-class.html#canonical_name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-42', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-43" class="py-name" targets="Variable epydoc.apidoc.UNKNOWN=epydoc.apidoc-module.html#UNKNOWN"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-43', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"> <tt id="link-44" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-44', 'name', 'link-24');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-45', 'canonical_name', 'link-42');">canonical_name</a></tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"> <tt id="link-46" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-46', 'name', 'link-24');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-47', 'canonical_name', 'link-42');">canonical_name</a></tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"> <tt id="link-48" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-48', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-49" class="py-name" targets="Method epydoc.cli.ConsoleLogger.progress()=epydoc.cli.ConsoleLogger-class.html#progress,Method epydoc.cli.UnifiedProgressConsoleLogger.progress()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#progress,Method epydoc.docbuilder._ProgressEstimator.progress()=epydoc.docbuilder._ProgressEstimator-class.html#progress,Method epydoc.gui.GUILogger.progress()=epydoc.gui.GUILogger-class.html#progress,Method epydoc.log.Logger.progress()=epydoc.log.Logger-class.html#progress,Function epydoc.log.progress()=epydoc.log-module.html#progress"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-49', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">)</tt><tt class="py-op">/</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc_pairs</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-50" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-50', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-51" class="py-name" targets="Function epydoc.docbuilder.merge_docs()=epydoc.docbuilder-module.html#merge_docs"><a title="epydoc.docbuilder.merge_docs" class="py-name" href="#" onclick="return doclink('link-51', 'merge_docs', 'link-51');">merge_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">introspect_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">parse_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> <tt id="link-52" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-52', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-53" class="py-name" targets="Method epydoc.cli.ConsoleLogger.end_progress()=epydoc.cli.ConsoleLogger-class.html#end_progress,Method epydoc.cli.UnifiedProgressConsoleLogger.end_progress()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#end_progress,Method epydoc.gui.GUILogger.end_progress()=epydoc.gui.GUILogger-class.html#end_progress,Method epydoc.log.Logger.end_progress()=epydoc.log.Logger-class.html#end_progress,Function epydoc.log.end_progress()=epydoc.log-module.html#end_progress"><a title="epydoc.cli.ConsoleLogger.end_progress
epydoc.cli.UnifiedProgressConsoleLogger.end_progress
epydoc.gui.GUILogger.end_progress
epydoc.log.Logger.end_progress
epydoc.log.end_progress" class="py-name" href="#" onclick="return doclink('link-53', 'end_progress', 'link-53');">end_progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">introspect</tt><tt class="py-op">:</tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">doc_pair</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">for</tt> <tt class="py-name">doc_pair</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc_pairs</tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc_pair</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">doc_pair</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">for</tt> <tt class="py-name">doc_pair</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc_pairs</tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc_pair</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> </tt>
<a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">docs</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"> <tt id="link-54" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-54', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-55" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-55', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'Nothing left to document!'</tt><tt class="py-op">)</tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"> <tt class="py-comment"># Collect the docs into a single index.</tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">docindex</tt> <tt class="py-op">=</tt> <tt id="link-56" class="py-name" targets="Class epydoc.apidoc.DocIndex=epydoc.apidoc.DocIndex-class.html"><a title="epydoc.apidoc.DocIndex" class="py-name" href="#" onclick="return doclink('link-56', 'DocIndex', 'link-56');">DocIndex</a></tt><tt class="py-op">(</tt><tt class="py-name">docs</tt><tt class="py-op">)</tt> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"> <tt class="py-comment"># Replace any proxy valuedocs that we got from importing with</tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># their targets.</tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-57', 'parse', 'link-19');">parse</a></tt><tt class="py-op">:</tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"> <tt id="link-58" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-58', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="epydoc.cli.ConsoleLogger.start_progress
epydoc.cli.UnifiedProgressConsoleLogger.start_progress
epydoc.gui.GUILogger.start_progress
epydoc.log.Logger.start_progress
epydoc.log.start_progress" class="py-name" href="#" onclick="return doclink('link-59', 'start_progress', 'link-41');">start_progress</a></tt><tt class="py-op">(</tt><tt class="py-string">'Linking imported variables'</tt><tt class="py-op">)</tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"> <tt class="py-name">valdocs</tt> <tt class="py-op">=</tt> <tt id="link-60" class="py-name" targets="Function epydoc.compat.sorted()=epydoc.compat-module.html#sorted"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-60', 'sorted', 'link-60');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name" targets="Method epydoc.apidoc.DocIndex.reachable_valdocs()=epydoc.apidoc.DocIndex-class.html#reachable_valdocs,Function epydoc.apidoc.reachable_valdocs()=epydoc.apidoc-module.html#reachable_valdocs"><a title="epydoc.apidoc.DocIndex.reachable_valdocs
epydoc.apidoc.reachable_valdocs" class="py-name" href="#" onclick="return doclink('link-61', 'reachable_valdocs', 'link-61');">reachable_valdocs</a></tt><tt class="py-op">(</tt> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"> <tt id="link-62" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.imports=epydoc.apidoc.ModuleDoc-class.html#imports"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-62', 'imports', 'link-62');">imports</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-63" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.submodules=epydoc.apidoc.ModuleDoc-class.html#submodules"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-63', 'submodules', 'link-63');">submodules</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">packages</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-64" class="py-name" targets="Variable epydoc.apidoc.ClassDoc.subclasses=epydoc.apidoc.ClassDoc-class.html#subclasses"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-64', 'subclasses', 'link-64');">subclasses</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">valdocs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"> <tt id="link-65" class="py-name" targets="Function epydoc.docbuilder._report_valdoc_progress()=epydoc.docbuilder-module.html#_report_valdoc_progress"><a title="epydoc.docbuilder._report_valdoc_progress" class="py-name" href="#" onclick="return doclink('link-65', '_report_valdoc_progress', 'link-65');">_report_valdoc_progress</a></tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">valdocs</tt><tt class="py-op">)</tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"> <tt id="link-66" class="py-name" targets="Function epydoc.docbuilder.link_imports()=epydoc.docbuilder-module.html#link_imports"><a title="epydoc.docbuilder.link_imports" class="py-name" href="#" onclick="return doclink('link-66', 'link_imports', 'link-66');">link_imports</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">)</tt> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"> <tt id="link-67" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-67', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-68" class="py-name"><a title="epydoc.cli.ConsoleLogger.end_progress
epydoc.cli.UnifiedProgressConsoleLogger.end_progress
epydoc.gui.GUILogger.end_progress
epydoc.log.Logger.end_progress
epydoc.log.end_progress" class="py-name" href="#" onclick="return doclink('link-68', 'end_progress', 'link-53');">end_progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> </tt>
<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"> <tt class="py-comment"># Assign canonical names.</tt> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-69" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-69', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="epydoc.cli.ConsoleLogger.start_progress
epydoc.cli.UnifiedProgressConsoleLogger.start_progress
epydoc.gui.GUILogger.start_progress
epydoc.log.Logger.start_progress
epydoc.log.start_progress" class="py-name" href="#" onclick="return doclink('link-70', 'start_progress', 'link-41');">start_progress</a></tt><tt class="py-op">(</tt><tt class="py-string">'Indexing documentation'</tt><tt class="py-op">)</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"> <tt id="link-71" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-71', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-72" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-72', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">)</tt><tt class="py-op">/</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-73', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"> <tt id="link-74" class="py-name" targets="Function epydoc.docbuilder.assign_canonical_names()=epydoc.docbuilder-module.html#assign_canonical_names"><a title="epydoc.docbuilder.assign_canonical_names" class="py-name" href="#" onclick="return doclink('link-74', 'assign_canonical_names', 'link-74');">assign_canonical_names</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-75', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">)</tt> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"> <tt id="link-76" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-76', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-77" class="py-name"><a title="epydoc.cli.ConsoleLogger.end_progress
epydoc.cli.UnifiedProgressConsoleLogger.end_progress
epydoc.gui.GUILogger.end_progress
epydoc.log.Logger.end_progress
epydoc.log.end_progress" class="py-name" href="#" onclick="return doclink('link-77', 'end_progress', 'link-53');">end_progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"> <tt class="py-comment"># Set overrides pointers</tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-78" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-78', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-79" class="py-name"><a title="epydoc.cli.ConsoleLogger.start_progress
epydoc.cli.UnifiedProgressConsoleLogger.start_progress
epydoc.gui.GUILogger.start_progress
epydoc.log.Logger.start_progress
epydoc.log.start_progress" class="py-name" href="#" onclick="return doclink('link-79', 'start_progress', 'link-41');">start_progress</a></tt><tt class="py-op">(</tt><tt class="py-string">'Checking for overridden methods'</tt><tt class="py-op">)</tt> </tt>
<a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"> <tt class="py-name">valdocs</tt> <tt class="py-op">=</tt> <tt id="link-80" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-80', 'sorted', 'link-60');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-81" class="py-name"><a title="epydoc.apidoc.DocIndex.reachable_valdocs
epydoc.apidoc.reachable_valdocs" class="py-name" href="#" onclick="return doclink('link-81', 'reachable_valdocs', 'link-61');">reachable_valdocs</a></tt><tt class="py-op">(</tt> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> <tt id="link-82" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-82', 'imports', 'link-62');">imports</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-83" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-83', 'submodules', 'link-63');">submodules</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">packages</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-84" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-84', 'subclasses', 'link-64');">subclasses</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">valdocs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-85" class="py-name" targets="Class epydoc.apidoc.ClassDoc=epydoc.apidoc.ClassDoc-class.html"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-85', 'ClassDoc', 'link-85');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"> <tt class="py-name">percent</tt> <tt class="py-op">=</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">)</tt><tt class="py-op">/</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">valdocs</tt><tt class="py-op">)</tt> </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"> <tt id="link-86" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-86', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-87" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-87', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">percent</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-88" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-88', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> <tt id="link-89" class="py-name" targets="Function epydoc.docbuilder.find_overrides()=epydoc.docbuilder-module.html#find_overrides"><a title="epydoc.docbuilder.find_overrides" class="py-name" href="#" onclick="return doclink('link-89', 'find_overrides', 'link-89');">find_overrides</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"> <tt id="link-90" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-90', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-91" class="py-name"><a title="epydoc.cli.ConsoleLogger.end_progress
epydoc.cli.UnifiedProgressConsoleLogger.end_progress
epydoc.gui.GUILogger.end_progress
epydoc.log.Logger.end_progress
epydoc.log.end_progress" class="py-name" href="#" onclick="return doclink('link-91', 'end_progress', 'link-53');">end_progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"> <tt class="py-comment"># Parse the docstrings for each object.</tt> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-92" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-92', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-93" class="py-name"><a title="epydoc.cli.ConsoleLogger.start_progress
epydoc.cli.UnifiedProgressConsoleLogger.start_progress
epydoc.gui.GUILogger.start_progress
epydoc.log.Logger.start_progress
epydoc.log.start_progress" class="py-name" href="#" onclick="return doclink('link-93', 'start_progress', 'link-41');">start_progress</a></tt><tt class="py-op">(</tt><tt class="py-string">'Parsing docstrings'</tt><tt class="py-op">)</tt> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"> <tt class="py-name">suppress_warnings</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-name">valdocs</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">difference</tt><tt class="py-op">(</tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-94" class="py-name"><a title="epydoc.apidoc.DocIndex.reachable_valdocs
epydoc.apidoc.reachable_valdocs" class="py-name" href="#" onclick="return doclink('link-94', 'reachable_valdocs', 'link-61');">reachable_valdocs</a></tt><tt class="py-op">(</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"> <tt id="link-95" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-95', 'imports', 'link-62');">imports</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-96" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-96', 'submodules', 'link-63');">submodules</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">packages</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-97" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-97', 'subclasses', 'link-64');">subclasses</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"> <tt id="link-98" class="py-name" targets="Variable epydoc.apidoc.ClassDoc.bases=epydoc.apidoc.ClassDoc-class.html#bases"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-98', 'bases', 'link-98');">bases</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-99" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.overrides=epydoc.apidoc.VariableDoc-class.html#overrides"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-99', 'overrides', 'link-99');">overrides</a></tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">valdocs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"> <tt id="link-100" class="py-name"><a title="epydoc.docbuilder._report_valdoc_progress" class="py-name" href="#" onclick="return doclink('link-100', '_report_valdoc_progress', 'link-65');">_report_valdoc_progress</a></tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">valdocs</tt><tt class="py-op">)</tt> </tt>
<a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"> <tt class="py-comment"># the value's docstring</tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-101" class="py-name"><a title="epydoc.docstringparser.parse_docstring
epydoc.markup.epytext.parse_docstring
epydoc.markup.javadoc.parse_docstring
epydoc.markup.plaintext.parse_docstring
epydoc.markup.restructuredtext.parse_docstring" class="py-name" href="#" onclick="return doclink('link-101', 'parse_docstring', 'link-12');">parse_docstring</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">suppress_warnings</tt><tt class="py-op">)</tt> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"> <tt class="py-comment"># the value's variables' docstrings</tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-102" class="py-name" targets="Class epydoc.apidoc.NamespaceDoc=epydoc.apidoc.NamespaceDoc-class.html"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-102', 'NamespaceDoc', 'link-102');">NamespaceDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.variables=epydoc.apidoc.NamespaceDoc-class.html#variables"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-103', 'variables', 'link-103');">variables</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-104" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-104', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-105" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-105', 'variables', 'link-103');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"> <tt class="py-comment"># Now we have a chance to propagate the defining module</tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># to objects for which introspection is not possible,</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># such as properties.</tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-106" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.value=epydoc.apidoc.VariableDoc-class.html#value"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-106', 'value', 'link-106');">value</a></tt><tt class="py-op">,</tt> <tt id="link-107" class="py-name" targets="Class epydoc.apidoc.ValueDoc=epydoc.apidoc.ValueDoc-class.html"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-107', 'ValueDoc', 'link-107');">ValueDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-108" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-108', 'value', 'link-106');">value</a></tt><tt class="py-op">.</tt><tt id="link-109" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.defining_module=epydoc.apidoc.ValueDoc-class.html#defining_module,Variable epydoc.apidoc.VariableDoc.defining_module=epydoc.apidoc.VariableDoc-class.html#defining_module"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-109', 'defining_module', 'link-109');">defining_module</a></tt> <tt class="py-keyword">is</tt> <tt id="link-110" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-110', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-111" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-111', 'value', 'link-106');">value</a></tt><tt class="py-op">.</tt><tt id="link-112" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-112', 'defining_module', 'link-109');">defining_module</a></tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-113" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-113', 'defining_module', 'link-109');">defining_module</a></tt> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> <tt id="link-114" class="py-name"><a title="epydoc.docstringparser.parse_docstring
epydoc.markup.epytext.parse_docstring
epydoc.markup.javadoc.parse_docstring
epydoc.markup.plaintext.parse_docstring
epydoc.markup.restructuredtext.parse_docstring" class="py-name" href="#" onclick="return doclink('link-114', 'parse_docstring', 'link-12');">parse_docstring</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">suppress_warnings</tt><tt class="py-op">)</tt> </tt>
<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"> <tt id="link-115" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-115', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-116" class="py-name"><a title="epydoc.cli.ConsoleLogger.end_progress
epydoc.cli.UnifiedProgressConsoleLogger.end_progress
epydoc.gui.GUILogger.end_progress
epydoc.log.Logger.end_progress
epydoc.log.end_progress" class="py-name" href="#" onclick="return doclink('link-116', 'end_progress', 'link-53');">end_progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt class="py-comment"># Take care of inheritance.</tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-117" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-117', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-118" class="py-name"><a title="epydoc.cli.ConsoleLogger.start_progress
epydoc.cli.UnifiedProgressConsoleLogger.start_progress
epydoc.gui.GUILogger.start_progress
epydoc.log.Logger.start_progress
epydoc.log.start_progress" class="py-name" href="#" onclick="return doclink('link-118', 'start_progress', 'link-41');">start_progress</a></tt><tt class="py-op">(</tt><tt class="py-string">'Inheriting documentation'</tt><tt class="py-op">)</tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">valdocs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-119" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-119', 'ClassDoc', 'link-85');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"> <tt class="py-name">percent</tt> <tt class="py-op">=</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">)</tt><tt class="py-op">/</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">valdocs</tt><tt class="py-op">)</tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"> <tt id="link-120" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-120', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-121" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-121', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">percent</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-122" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-122', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"> <tt id="link-123" class="py-name" targets="Function epydoc.docbuilder.inherit_docs()=epydoc.docbuilder-module.html#inherit_docs"><a title="epydoc.docbuilder.inherit_docs" class="py-name" href="#" onclick="return doclink('link-123', 'inherit_docs', 'link-123');">inherit_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"> <tt id="link-124" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-124', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-125" class="py-name"><a title="epydoc.cli.ConsoleLogger.end_progress
epydoc.cli.UnifiedProgressConsoleLogger.end_progress
epydoc.gui.GUILogger.end_progress
epydoc.log.Logger.end_progress
epydoc.log.end_progress" class="py-name" href="#" onclick="return doclink('link-125', 'end_progress', 'link-53');">end_progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"> <tt class="py-comment"># Initialize the groups & sortedvars attributes.</tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-126" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-126', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-127" class="py-name"><a title="epydoc.cli.ConsoleLogger.start_progress
epydoc.cli.UnifiedProgressConsoleLogger.start_progress
epydoc.gui.GUILogger.start_progress
epydoc.log.Logger.start_progress
epydoc.log.start_progress" class="py-name" href="#" onclick="return doclink('link-127', 'start_progress', 'link-41');">start_progress</a></tt><tt class="py-op">(</tt><tt class="py-string">'Sorting & Grouping'</tt><tt class="py-op">)</tt> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">valdocs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-128" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-128', 'NamespaceDoc', 'link-102');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"> <tt class="py-name">percent</tt> <tt class="py-op">=</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">)</tt><tt class="py-op">/</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">valdocs</tt><tt class="py-op">)</tt> </tt>
<a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"> <tt id="link-129" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-129', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-130" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-130', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">percent</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-131" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-131', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-132" class="py-name" targets="Method epydoc.apidoc.NamespaceDoc.init_sorted_variables()=epydoc.apidoc.NamespaceDoc-class.html#init_sorted_variables"><a title="epydoc.apidoc.NamespaceDoc.init_sorted_variables" class="py-name" href="#" onclick="return doclink('link-132', 'init_sorted_variables', 'link-132');">init_sorted_variables</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-133" class="py-name" targets="Method epydoc.apidoc.NamespaceDoc.init_variable_groups()=epydoc.apidoc.NamespaceDoc-class.html#init_variable_groups"><a title="epydoc.apidoc.NamespaceDoc.init_variable_groups" class="py-name" href="#" onclick="return doclink('link-133', 'init_variable_groups', 'link-133');">init_variable_groups</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-134" class="py-name" targets="Class epydoc.apidoc.ModuleDoc=epydoc.apidoc.ModuleDoc-class.html"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-134', 'ModuleDoc', 'link-134');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-135" class="py-name" targets="Method epydoc.apidoc.ModuleDoc.init_submodule_groups()=epydoc.apidoc.ModuleDoc-class.html#init_submodule_groups"><a title="epydoc.apidoc.ModuleDoc.init_submodule_groups" class="py-name" href="#" onclick="return doclink('link-135', 'init_submodule_groups', 'link-135');">init_submodule_groups</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-136" class="py-name" targets="Method epydoc.apidoc.NamespaceDoc.report_unused_groups()=epydoc.apidoc.NamespaceDoc-class.html#report_unused_groups"><a title="epydoc.apidoc.NamespaceDoc.report_unused_groups" class="py-name" href="#" onclick="return doclink('link-136', 'report_unused_groups', 'link-136');">report_unused_groups</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"> <tt id="link-137" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-137', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-138" class="py-name"><a title="epydoc.cli.ConsoleLogger.end_progress
epydoc.cli.UnifiedProgressConsoleLogger.end_progress
epydoc.gui.GUILogger.end_progress
epydoc.log.Logger.end_progress
epydoc.log.end_progress" class="py-name" href="#" onclick="return doclink('link-138', 'end_progress', 'link-53');">end_progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">docindex</tt> </tt>
</div><a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"> </tt>
<a name="_report_valdoc_progress"></a><div id="_report_valdoc_progress-def"><a name="L313"></a><tt class="py-lineno"> 313</tt> <a class="py-toggle" href="#" id="_report_valdoc_progress-toggle" onclick="return toggle('_report_valdoc_progress');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_report_valdoc_progress">_report_valdoc_progress</a><tt class="py-op">(</tt><tt class="py-param">i</tt><tt class="py-op">,</tt> <tt class="py-param">val_doc</tt><tt class="py-op">,</tt> <tt class="py-param">val_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_report_valdoc_progress-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_report_valdoc_progress-expanded"><a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt id="link-139" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-139', 'ModuleDoc', 'link-134');">ModuleDoc</a></tt><tt class="py-op">,</tt> <tt id="link-140" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-140', 'ClassDoc', 'link-85');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-141" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-141', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-142" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-142', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-143" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-143', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'??'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"> <tt id="link-144" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-144', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-145" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-145', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">)</tt><tt class="py-op">/</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">val_docs</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-146" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-146', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"> </tt>
<a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Documentation Generation</tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="_get_docs_from_items"></a><div id="_get_docs_from_items-def"><a name="L323"></a><tt class="py-lineno"> 323</tt> <a class="py-toggle" href="#" id="_get_docs_from_items-toggle" onclick="return toggle('_get_docs_from_items');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_get_docs_from_items">_get_docs_from_items</a><tt class="py-op">(</tt><tt class="py-param">items</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_get_docs_from_items-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_get_docs_from_items-expanded"><a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"> <tt class="py-comment"># Start the progress bar.</tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-147" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-147', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-148" class="py-name"><a title="epydoc.cli.ConsoleLogger.start_progress
epydoc.cli.UnifiedProgressConsoleLogger.start_progress
epydoc.gui.GUILogger.start_progress
epydoc.log.Logger.start_progress
epydoc.log.start_progress" class="py-name" href="#" onclick="return doclink('link-148', 'start_progress', 'link-41');">start_progress</a></tt><tt class="py-op">(</tt><tt class="py-string">'Building documentation'</tt><tt class="py-op">)</tt> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"> <tt class="py-name">progress_estimator</tt> <tt class="py-op">=</tt> <tt id="link-149" class="py-name" targets="Class epydoc.docbuilder._ProgressEstimator=epydoc.docbuilder._ProgressEstimator-class.html"><a title="epydoc.docbuilder._ProgressEstimator" class="py-name" href="#" onclick="return doclink('link-149', '_ProgressEstimator', 'link-149');">_ProgressEstimator</a></tt><tt class="py-op">(</tt><tt class="py-name">items</tt><tt class="py-op">)</tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> <tt class="py-comment"># Check for duplicate item names.</tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">item_set</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">item_set</tt><tt class="py-op">:</tt> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> <tt id="link-150" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-150', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-151" class="py-name" targets="Method epydoc.checker.DocChecker.warning()=epydoc.checker.DocChecker-class.html#warning,Function epydoc.log.warning()=epydoc.log-module.html#warning"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-151', 'warning', 'link-151');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Name %r given multiple times"</tt> <tt class="py-op">%</tt> <tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"> <tt class="py-name">items</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"> <tt class="py-name">item_set</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> </tt>
<a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"> <tt class="py-comment"># Keep track of what top-level canonical names we've assigned, to</tt> </tt>
<a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># make sure there are no naming conflicts. This dict maps</tt> </tt>
<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># canonical names to the item names they came from (so we can print</tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># useful error messages).</tt> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">canonical_names</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> <tt class="py-comment"># Collect (introspectdoc, parsedoc) pairs for each item.</tt> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">doc_pairs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">:</tt> </tt>
<a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-152" class="py-name" targets="Function epydoc.util.is_module_file()=epydoc.util-module.html#is_module_file"><a title="epydoc.util.is_module_file" class="py-name" href="#" onclick="return doclink('link-152', 'is_module_file', 'link-152');">is_module_file</a></tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"> <tt class="py-name">doc_pairs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-153" class="py-name" targets="Function epydoc.docbuilder._get_docs_from_module_file()=epydoc.docbuilder-module.html#_get_docs_from_module_file"><a title="epydoc.docbuilder._get_docs_from_module_file" class="py-name" href="#" onclick="return doclink('link-153', '_get_docs_from_module_file', 'link-153');">_get_docs_from_module_file</a></tt><tt class="py-op">(</tt> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"> <tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-154" class="py-name" targets="Function epydoc.util.is_package_dir()=epydoc.util-module.html#is_package_dir"><a title="epydoc.util.is_package_dir" class="py-name" href="#" onclick="return doclink('link-154', 'is_package_dir', 'link-154');">is_package_dir</a></tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"> <tt class="py-name">pkgfile</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-155" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-155', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">abspath</tt><tt class="py-op">(</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-156" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-156', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-string">'__init__'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"> <tt class="py-name">doc_pairs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-157" class="py-name"><a title="epydoc.docbuilder._get_docs_from_module_file" class="py-name" href="#" onclick="return doclink('link-157', '_get_docs_from_module_file', 'link-153');">_get_docs_from_module_file</a></tt><tt class="py-op">(</tt> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt class="py-name">pkgfile</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-158', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">isfile</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> <tt class="py-name">doc_pairs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-159" class="py-name" targets="Function epydoc.docbuilder._get_docs_from_pyscript()=epydoc.docbuilder-module.html#_get_docs_from_pyscript"><a title="epydoc.docbuilder._get_docs_from_pyscript" class="py-name" href="#" onclick="return doclink('link-159', '_get_docs_from_pyscript', 'link-159');">_get_docs_from_pyscript</a></tt><tt class="py-op">(</tt> </tt>
<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"> <tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">__builtin__</tt><tt class="py-op">,</tt> <tt class="py-name">item</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"> <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">__builtin__</tt><tt class="py-op">,</tt> <tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"> <tt class="py-name">doc_pairs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-160" class="py-name" targets="Function epydoc.docbuilder._get_docs_from_pyobject()=epydoc.docbuilder-module.html#_get_docs_from_pyobject"><a title="epydoc.docbuilder._get_docs_from_pyobject" class="py-name" href="#" onclick="return doclink('link-160', '_get_docs_from_pyobject', 'link-160');">_get_docs_from_pyobject</a></tt><tt class="py-op">(</tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"> <tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-161" class="py-name" targets="Function epydoc.util.is_pyname()=epydoc.util-module.html#is_pyname"><a title="epydoc.util.is_pyname" class="py-name" href="#" onclick="return doclink('link-161', 'is_pyname', 'link-161');">is_pyname</a></tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"> <tt class="py-name">doc_pairs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-162" class="py-name" targets="Function epydoc.docbuilder._get_docs_from_pyname()=epydoc.docbuilder-module.html#_get_docs_from_pyname"><a title="epydoc.docbuilder._get_docs_from_pyname" class="py-name" href="#" onclick="return doclink('link-162', '_get_docs_from_pyname', 'link-162');">_get_docs_from_pyname</a></tt><tt class="py-op">(</tt> </tt>
<a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> <tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-163" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-163', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">isdir</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"> <tt id="link-164" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-164', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-165" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-165', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">"Directory %r is not a package"</tt> <tt class="py-op">%</tt> <tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-166" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-166', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">isfile</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"> <tt id="link-167" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-167', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-168" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-168', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">"File %s is not a Python module"</tt> <tt class="py-op">%</tt> <tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"> <tt id="link-169" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-169', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-170" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-170', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">"Could not find a file or object named %s"</tt> <tt class="py-op">%</tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"> <tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"> <tt class="py-name">doc_pairs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-171" class="py-name"><a title="epydoc.docbuilder._get_docs_from_pyobject" class="py-name" href="#" onclick="return doclink('link-171', '_get_docs_from_pyobject', 'link-160');">_get_docs_from_pyobject</a></tt><tt class="py-op">(</tt> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"> <tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"> <tt class="py-comment"># Make sure there are no naming conflicts.</tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-172" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-172', 'name', 'link-24');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">doc_pairs</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'canonical_name'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">doc_pairs</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'canonical_name'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-173" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-173', 'name', 'link-24');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">canonical_names</tt><tt class="py-op">:</tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"> <tt id="link-174" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-174', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-175" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-175', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"> <tt class="py-string">'Two of the specified items, %r and %r, have the same '</tt> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"> <tt class="py-string">'canonical name ("%s"). This may mean that you specified '</tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"> <tt class="py-string">'two different files that both use the same module name. '</tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"> <tt class="py-string">'Ignoring the second item (%r)'</tt> <tt class="py-op">%</tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">canonical_names</tt><tt class="py-op">[</tt><tt id="link-176" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-176', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">item</tt><tt class="py-op">,</tt> <tt id="link-177" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-177', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">canonical_names</tt><tt class="py-op">[</tt><tt id="link-178" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-178', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"> <tt class="py-name">doc_pairs</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"> <tt class="py-name">canonical_names</tt><tt class="py-op">[</tt><tt id="link-179" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-179', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"> </tt>
<a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"> <tt class="py-comment"># This will only have an effect if doc_pairs[-1] contains a</tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># package's docs. The 'not is_module_file(item)' prevents</tt> </tt>
<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># us from adding subdirectories if they explicitly specify</tt> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># a package's __init__.py file.</tt> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">add_submodules</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-180" class="py-name"><a title="epydoc.util.is_module_file" class="py-name" href="#" onclick="return doclink('link-180', 'is_module_file', 'link-152');">is_module_file</a></tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"> <tt class="py-name">doc_pairs</tt> <tt class="py-op">+=</tt> <tt id="link-181" class="py-name" targets="Function epydoc.docbuilder._get_docs_from_submodules()=epydoc.docbuilder-module.html#_get_docs_from_submodules"><a title="epydoc.docbuilder._get_docs_from_submodules" class="py-name" href="#" onclick="return doclink('link-181', '_get_docs_from_submodules', 'link-181');">_get_docs_from_submodules</a></tt><tt class="py-op">(</tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"> <tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-name">doc_pairs</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">)</tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"> </tt>
<a name="L400"></a><tt class="py-lineno"> 400</tt> <tt class="py-line"> <tt id="link-182" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-182', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-183" class="py-name"><a title="epydoc.cli.ConsoleLogger.end_progress
epydoc.cli.UnifiedProgressConsoleLogger.end_progress
epydoc.gui.GUILogger.end_progress
epydoc.log.Logger.end_progress
epydoc.log.end_progress" class="py-name" href="#" onclick="return doclink('link-183', 'end_progress', 'link-53');">end_progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">doc_pairs</tt> </tt>
</div><a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"> </tt>
<a name="_get_docs_from_pyobject"></a><div id="_get_docs_from_pyobject-def"><a name="L403"></a><tt class="py-lineno"> 403</tt> <a class="py-toggle" href="#" id="_get_docs_from_pyobject-toggle" onclick="return toggle('_get_docs_from_pyobject');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_get_docs_from_pyobject">_get_docs_from_pyobject</a><tt class="py-op">(</tt><tt class="py-param">obj</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">progress_estimator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_get_docs_from_pyobject-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_get_docs_from_pyobject-expanded"><a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"> <tt class="py-name">progress_estimator</tt><tt class="py-op">.</tt><tt class="py-name">complete</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"> <tt id="link-184" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-184', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-185" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-185', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">progress_estimator</tt><tt class="py-op">.</tt><tt id="link-186" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-186', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">repr</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">introspect</tt><tt class="py-op">:</tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"> <tt id="link-187" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-187', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-188" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-188', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">"Cannot get docs for Python objects without "</tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> <tt class="py-string">"introspecting them."</tt><tt class="py-op">)</tt> </tt>
<a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"> </tt>
<a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"> <tt class="py-name">introspect_error</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_error</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt> <tt class="py-op">=</tt> <tt id="link-189" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-189', 'introspect_docs', 'link-5');">introspect_docs</a></tt><tt class="py-op">(</tt><tt id="link-190" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-190', 'value', 'link-106');">value</a></tt><tt class="py-op">=</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt> </tt>
<a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"> <tt id="link-191" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-191', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-192" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-192', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-193" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-193', 'parse', 'link-19');">parse</a></tt><tt class="py-op">:</tt> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-194" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-194', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"> <tt class="py-name">prev_introspect</tt> <tt class="py-op">=</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">introspect</tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">introspect</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"> <tt class="py-name">_</tt><tt class="py-op">,</tt> <tt id="link-195" class="py-name"><a title="epydoc.docparser.parse_docs" class="py-name" href="#" onclick="return doclink('link-195', 'parse_docs', 'link-8');">parse_docs</a></tt> <tt class="py-op">=</tt> <tt id="link-196" class="py-name"><a title="epydoc.docbuilder._get_docs_from_pyname" class="py-name" href="#" onclick="return doclink('link-196', '_get_docs_from_pyname', 'link-162');">_get_docs_from_pyname</a></tt><tt class="py-op">(</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-197" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-197', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"> <tt class="py-name">progress_estimator</tt><tt class="py-op">,</tt> <tt class="py-name">suppress_warnings</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">introspect</tt> <tt class="py-op">=</tt> <tt class="py-name">prev_introspect</tt> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"> </tt>
<a name="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"> <tt class="py-comment"># We need a name:</tt> </tt>
<a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-198" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-198', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-199" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-199', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">,</tt> <tt class="py-string">'__name__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-200" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-200', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-201" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-201', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">(</tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"> <tt id="link-202" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-202', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-203" class="py-name" targets="Variable epydoc.apidoc.DottedName.UNREACHABLE=epydoc.apidoc.DottedName-class.html#UNREACHABLE"><a title="epydoc.apidoc.DottedName.UNREACHABLE" class="py-name" href="#" onclick="return doclink('link-203', 'UNREACHABLE', 'link-203');">UNREACHABLE</a></tt><tt class="py-op">,</tt> <tt class="py-name">obj</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-204" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-204', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-205" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-205', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">(</tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"> <tt id="link-206" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-206', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-207" class="py-name"><a title="epydoc.apidoc.DottedName.UNREACHABLE" class="py-name" href="#" onclick="return doclink('link-207', 'UNREACHABLE', 'link-203');">UNREACHABLE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"> </tt>
<a name="_get_docs_from_pyname"></a><div id="_get_docs_from_pyname-def"><a name="L439"></a><tt class="py-lineno"> 439</tt> <a class="py-toggle" href="#" id="_get_docs_from_pyname-toggle" onclick="return toggle('_get_docs_from_pyname');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_get_docs_from_pyname">_get_docs_from_pyname</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">progress_estimator</tt><tt class="py-op">,</tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"> <tt class="py-param">suppress_warnings</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_get_docs_from_pyname-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_get_docs_from_pyname-expanded"><a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"> <tt class="py-name">progress_estimator</tt><tt class="py-op">.</tt><tt class="py-name">complete</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-208" class="py-name" targets="Method epydoc.docbuilder.BuildOptions.must_introspect()=epydoc.docbuilder.BuildOptions-class.html#must_introspect"><a title="epydoc.docbuilder.BuildOptions.must_introspect" class="py-name" href="#" onclick="return doclink('link-208', 'must_introspect', 'link-208');">must_introspect</a></tt><tt class="py-op">(</tt><tt id="link-209" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-209', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-210" class="py-name" targets="Method epydoc.docbuilder.BuildOptions.must_parse()=epydoc.docbuilder.BuildOptions-class.html#must_parse"><a title="epydoc.docbuilder.BuildOptions.must_parse" class="py-name" href="#" onclick="return doclink('link-210', 'must_parse', 'link-210');">must_parse</a></tt><tt class="py-op">(</tt><tt id="link-211" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-211', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"> <tt id="link-212" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-212', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-213" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-213', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">progress_estimator</tt><tt class="py-op">.</tt><tt id="link-214" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-214', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-215" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-215', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"> <tt class="py-name">introspect_error</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_error</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-216" class="py-name"><a title="epydoc.docbuilder.BuildOptions.must_introspect" class="py-name" href="#" onclick="return doclink('link-216', 'must_introspect', 'link-208');">must_introspect</a></tt><tt class="py-op">(</tt><tt id="link-217" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-217', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt> <tt class="py-op">=</tt> <tt id="link-218" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-218', 'introspect_docs', 'link-5');">introspect_docs</a></tt><tt class="py-op">(</tt><tt id="link-219" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-219', 'name', 'link-24');">name</a></tt><tt class="py-op">=</tt><tt id="link-220" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-220', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"> <tt class="py-name">introspect_error</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-221" class="py-name"><a title="epydoc.docbuilder.BuildOptions.must_parse" class="py-name" href="#" onclick="return doclink('link-221', 'must_parse', 'link-210');">must_parse</a></tt><tt class="py-op">(</tt><tt id="link-222" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-222', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"> <tt class="py-name">parse_doc</tt> <tt class="py-op">=</tt> <tt id="link-223" class="py-name"><a title="epydoc.docparser.parse_docs" class="py-name" href="#" onclick="return doclink('link-223', 'parse_docs', 'link-8');">parse_docs</a></tt><tt class="py-op">(</tt><tt id="link-224" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-224', 'name', 'link-24');">name</a></tt><tt class="py-op">=</tt><tt id="link-225" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-225', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-226" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-226', 'ParseError', 'link-9');">ParseError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"> <tt class="py-name">parse_error</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"> <tt class="py-comment"># If we get here, then there' probably no python source</tt> </tt>
<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># available; don't bother to generate a warnining.</tt> </tt>
<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"> <tt class="py-comment"># Report any errors we encountered.</tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">suppress_warnings</tt><tt class="py-op">:</tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"> <tt id="link-227" class="py-name" targets="Function epydoc.docbuilder._report_errors()=epydoc.docbuilder-module.html#_report_errors"><a title="epydoc.docbuilder._report_errors" class="py-name" href="#" onclick="return doclink('link-227', '_report_errors', 'link-227');">_report_errors</a></tt><tt class="py-op">(</tt><tt id="link-228" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-228', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"> <tt class="py-name">introspect_error</tt><tt class="py-op">,</tt> <tt class="py-name">parse_error</tt><tt class="py-op">)</tt> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"> <tt class="py-comment"># Return the docs we found.</tt> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"> </tt>
<a name="_get_docs_from_pyscript"></a><div id="_get_docs_from_pyscript-def"><a name="L470"></a><tt class="py-lineno"> 470</tt> <a class="py-toggle" href="#" id="_get_docs_from_pyscript-toggle" onclick="return toggle('_get_docs_from_pyscript');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_get_docs_from_pyscript">_get_docs_from_pyscript</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">progress_estimator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_get_docs_from_pyscript-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_get_docs_from_pyscript-expanded"><a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"> <tt class="py-comment"># [xx] I should be careful about what names I allow as filenames,</tt> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># and maybe do some munging to prevent problems.</tt> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> <tt class="py-name">introspect_error</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_error</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">introspect</tt><tt class="py-op">:</tt> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt> <tt class="py-op">=</tt> <tt id="link-229" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-229', 'introspect_docs', 'link-5');">introspect_docs</a></tt><tt class="py-op">(</tt><tt id="link-230" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.filename=epydoc.apidoc.ModuleDoc-class.html#filename"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-230', 'filename', 'link-230');">filename</a></tt><tt class="py-op">=</tt><tt id="link-231" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-231', 'filename', 'link-230');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">is_script</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-232" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-232', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt id="link-233" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-233', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-234" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-234', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-235" class="py-name" targets="Function epydoc.util.munge_script_name()=epydoc.util-module.html#munge_script_name"><a title="epydoc.util.munge_script_name" class="py-name" href="#" onclick="return doclink('link-235', 'munge_script_name', 'link-235');">munge_script_name</a></tt><tt class="py-op">(</tt><tt id="link-236" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-236', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"> <tt class="py-name">introspect_error</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-237" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-237', 'parse', 'link-19');">parse</a></tt><tt class="py-op">:</tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"> <tt class="py-name">parse_doc</tt> <tt class="py-op">=</tt> <tt id="link-238" class="py-name"><a title="epydoc.docparser.parse_docs" class="py-name" href="#" onclick="return doclink('link-238', 'parse_docs', 'link-8');">parse_docs</a></tt><tt class="py-op">(</tt><tt id="link-239" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-239', 'filename', 'link-230');">filename</a></tt><tt class="py-op">=</tt><tt id="link-240" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-240', 'filename', 'link-230');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">is_script</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-241" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-241', 'ParseError', 'link-9');">ParseError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"> <tt class="py-name">parse_error</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"> <tt class="py-name">parse_error</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"> <tt class="py-comment"># Report any errors we encountered.</tt> </tt>
<a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-242" class="py-name"><a title="epydoc.docbuilder._report_errors" class="py-name" href="#" onclick="return doclink('link-242', '_report_errors', 'link-227');">_report_errors</a></tt><tt class="py-op">(</tt><tt id="link-243" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-243', 'filename', 'link-230');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"> <tt class="py-name">introspect_error</tt><tt class="py-op">,</tt> <tt class="py-name">parse_error</tt><tt class="py-op">)</tt> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"> </tt>
<a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"> <tt class="py-comment"># Return the docs we found.</tt> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"> </tt>
<a name="_get_docs_from_module_file"></a><div id="_get_docs_from_module_file-def"><a name="L498"></a><tt class="py-lineno"> 498</tt> <a class="py-toggle" href="#" id="_get_docs_from_module_file-toggle" onclick="return toggle('_get_docs_from_module_file');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_get_docs_from_module_file">_get_docs_from_module_file</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">progress_estimator</tt><tt class="py-op">,</tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"> <tt class="py-param">parent_docs</tt><tt class="py-op">=</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_get_docs_from_module_file-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_get_docs_from_module_file-expanded"><a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"><tt class="py-docstring"> Construct and return the API documentation for the python</tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"><tt class="py-docstring"> module with the given filename.</tt> </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"><tt class="py-docstring"> @param parent_docs: The C{ModuleDoc} of the containing package.</tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"><tt class="py-docstring"> If C{parent_docs} is not provided, then this method will</tt> </tt>
<a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"><tt class="py-docstring"> check if the given filename is contained in a package; and</tt> </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"><tt class="py-docstring"> if so, it will construct a stub C{ModuleDoc} for the</tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"><tt class="py-docstring"> containing package(s). C{parent_docs} is a tuple, where</tt> </tt>
<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"><tt class="py-docstring"> the first element is the parent from introspection, and</tt> </tt>
<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"><tt class="py-docstring"> the second element is the parent from parsing.</tt> </tt>
<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"> <tt class="py-comment"># Record our progress.</tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">modulename</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-244" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-244', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">splitext</tt><tt class="py-op">(</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-245" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-245', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt id="link-246" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-246', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">modulename</tt> <tt class="py-op">==</tt> <tt class="py-string">'__init__'</tt><tt class="py-op">:</tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"> <tt class="py-name">modulename</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-247" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-247', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-248" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-248', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt id="link-249" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-249', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"> <tt class="py-name">modulename</tt> <tt class="py-op">=</tt> <tt id="link-250" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-250', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_docs</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-251" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-251', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">modulename</tt><tt class="py-op">)</tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"> <tt class="py-name">modulename</tt> <tt class="py-op">=</tt> <tt id="link-252" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-252', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_docs</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-253" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-253', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">modulename</tt><tt class="py-op">)</tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-254" class="py-name"><a title="epydoc.docbuilder.BuildOptions.must_introspect" class="py-name" href="#" onclick="return doclink('link-254', 'must_introspect', 'link-208');">must_introspect</a></tt><tt class="py-op">(</tt><tt class="py-name">modulename</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-255" class="py-name"><a title="epydoc.docbuilder.BuildOptions.must_parse" class="py-name" href="#" onclick="return doclink('link-255', 'must_parse', 'link-210');">must_parse</a></tt><tt class="py-op">(</tt><tt class="py-name">modulename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"> <tt id="link-256" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-256', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-257" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-257', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">progress_estimator</tt><tt class="py-op">.</tt><tt id="link-258" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-258', 'progress', 'link-49');">progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"> <tt class="py-string">'%s (%s)'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">modulename</tt><tt class="py-op">,</tt> <tt id="link-259" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-259', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"> <tt class="py-name">progress_estimator</tt><tt class="py-op">.</tt><tt class="py-name">complete</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"> <tt class="py-comment"># Normalize the filename.</tt> </tt>
<a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-260" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-260', 'filename', 'link-230');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-261" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-261', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">normpath</tt><tt class="py-op">(</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-262" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-262', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">abspath</tt><tt class="py-op">(</tt><tt id="link-263" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-263', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"> <tt class="py-comment"># When possible, use the source version of the file.</tt> </tt>
<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"> <tt id="link-264" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-264', 'filename', 'link-230');">filename</a></tt> <tt class="py-op">=</tt> <tt id="link-265" class="py-name" targets="Function epydoc.util.py_src_filename()=epydoc.util-module.html#py_src_filename"><a title="epydoc.util.py_src_filename" class="py-name" href="#" onclick="return doclink('link-265', 'py_src_filename', 'link-265');">py_src_filename</a></tt><tt class="py-op">(</tt><tt id="link-266" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-266', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"> <tt class="py-name">src_file_available</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> </tt>
<a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"> <tt class="py-name">src_file_available</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"> <tt class="py-comment"># Get the introspected & parsed docs (as appropriate)</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">introspect_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"> <tt class="py-name">introspect_error</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_error</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-267" class="py-name"><a title="epydoc.docbuilder.BuildOptions.must_introspect" class="py-name" href="#" onclick="return doclink('link-267', 'must_introspect', 'link-208');">must_introspect</a></tt><tt class="py-op">(</tt><tt class="py-name">modulename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt> <tt class="py-op">=</tt> <tt id="link-268" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-268', 'introspect_docs', 'link-5');">introspect_docs</a></tt><tt class="py-op">(</tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"> <tt id="link-269" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-269', 'filename', 'link-230');">filename</a></tt><tt class="py-op">=</tt><tt id="link-270" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-270', 'filename', 'link-230');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">parent_docs</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-271" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-271', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt id="link-272" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-272', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-273" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-273', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">modulename</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"> <tt class="py-name">introspect_error</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">src_file_available</tt> <tt class="py-keyword">and</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt id="link-274" class="py-name"><a title="epydoc.docbuilder.BuildOptions.must_parse" class="py-name" href="#" onclick="return doclink('link-274', 'must_parse', 'link-210');">must_parse</a></tt><tt class="py-op">(</tt><tt class="py-name">modulename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"> <tt class="py-name">parse_doc</tt> <tt class="py-op">=</tt> <tt id="link-275" class="py-name"><a title="epydoc.docparser.parse_docs" class="py-name" href="#" onclick="return doclink('link-275', 'parse_docs', 'link-8');">parse_docs</a></tt><tt class="py-op">(</tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"> <tt id="link-276" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-276', 'filename', 'link-230');">filename</a></tt><tt class="py-op">=</tt><tt id="link-277" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-277', 'filename', 'link-230');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">parent_docs</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-278" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-278', 'ParseError', 'link-9');">ParseError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"> <tt class="py-name">parse_error</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"> <tt class="py-name">parse_error</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"> </tt>
<a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"> <tt class="py-comment"># Report any errors we encountered.</tt> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-279" class="py-name"><a title="epydoc.docbuilder._report_errors" class="py-name" href="#" onclick="return doclink('link-279', '_report_errors', 'link-227');">_report_errors</a></tt><tt class="py-op">(</tt><tt id="link-280" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-280', 'filename', 'link-230');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"> <tt class="py-name">introspect_error</tt><tt class="py-op">,</tt> <tt class="py-name">parse_error</tt><tt class="py-op">)</tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"> <tt class="py-comment"># Return the docs we found.</tt> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"> </tt>
<a name="_get_docs_from_submodules"></a><div id="_get_docs_from_submodules-def"><a name="L562"></a><tt class="py-lineno"> 562</tt> <a class="py-toggle" href="#" id="_get_docs_from_submodules-toggle" onclick="return toggle('_get_docs_from_submodules');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_get_docs_from_submodules">_get_docs_from_submodules</a><tt class="py-op">(</tt><tt class="py-param">item</tt><tt class="py-op">,</tt> <tt class="py-param">pkg_docs</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">progress_estimator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_get_docs_from_submodules-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_get_docs_from_submodules-expanded"><a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> <tt class="py-comment"># Extract the package's __path__.</tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">pkg_docs</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-281" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-281', 'ModuleDoc', 'link-134');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">pkg_docs</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-282" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.is_package=epydoc.apidoc.ModuleDoc-class.html#is_package"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-282', 'is_package', 'link-282');">is_package</a></tt><tt class="py-op">:</tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"> <tt class="py-name">pkg_path</tt> <tt class="py-op">=</tt> <tt class="py-name">pkg_docs</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-283" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-283', 'path', 'link-0');">path</a></tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"> <tt class="py-name">package_dir</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-284" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-284', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">pkg_docs</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-285" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-285', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">pkg_docs</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-286" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-286', 'ModuleDoc', 'link-134');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">pkg_docs</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-287" class="py-name"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-287', 'is_package', 'link-282');">is_package</a></tt><tt class="py-op">:</tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"> <tt class="py-name">pkg_path</tt> <tt class="py-op">=</tt> <tt class="py-name">pkg_docs</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-288" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-288', 'path', 'link-0');">path</a></tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"> <tt class="py-name">package_dir</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-289" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-289', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">pkg_docs</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-290" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-290', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"> <tt class="py-name">module_filenames</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"> <tt class="py-name">subpackage_dirs</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">subdir</tt> <tt class="py-keyword">in</tt> <tt class="py-name">pkg_path</tt><tt class="py-op">:</tt> </tt>
<a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-291" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-291', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">isdir</tt><tt class="py-op">(</tt><tt class="py-name">subdir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-292" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-292', 'name', 'link-24');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">listdir</tt><tt class="py-op">(</tt><tt class="py-name">subdir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"> <tt id="link-293" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-293', 'filename', 'link-230');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-294" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-294', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">subdir</tt><tt class="py-op">,</tt> <tt id="link-295" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-295', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"> <tt class="py-comment"># Is it a valid module filename?</tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-296" class="py-name"><a title="epydoc.util.is_module_file" class="py-name" href="#" onclick="return doclink('link-296', 'is_module_file', 'link-152');">is_module_file</a></tt><tt class="py-op">(</tt><tt id="link-297" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-297', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt class="py-name">basename</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-298" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-298', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">splitext</tt><tt class="py-op">(</tt><tt id="link-299" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-299', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-300" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-300', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">basename</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-string">'__init__'</tt><tt class="py-op">:</tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"> <tt class="py-name">module_filenames</tt><tt class="py-op">[</tt><tt class="py-name">basename</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-301" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-301', 'filename', 'link-230');">filename</a></tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"> <tt class="py-comment"># Is it a valid package filename?</tt> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-302" class="py-name"><a title="epydoc.util.is_package_dir" class="py-name" href="#" onclick="return doclink('link-302', 'is_package_dir', 'link-154');">is_package_dir</a></tt><tt class="py-op">(</tt><tt id="link-303" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-303', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"> <tt class="py-name">subpackage_dirs</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt id="link-304" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-304', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"> <tt class="py-comment"># Update our estimate of the number of modules in this package.</tt> </tt>
<a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">.</tt><tt id="link-305" class="py-name" targets="Method epydoc.docbuilder._ProgressEstimator.revise_estimate()=epydoc.docbuilder._ProgressEstimator-class.html#revise_estimate"><a title="epydoc.docbuilder._ProgressEstimator.revise_estimate" class="py-name" href="#" onclick="return doclink('link-305', 'revise_estimate', 'link-305');">revise_estimate</a></tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-name">module_filenames</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"> <tt class="py-name">subpackage_dirs</tt><tt class="py-op">)</tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">pkg_docs</tt><tt class="py-op">]</tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">module_filename</tt> <tt class="py-keyword">in</tt> <tt class="py-name">module_filenames</tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> <tt class="py-name">d</tt> <tt class="py-op">=</tt> <tt id="link-306" class="py-name"><a title="epydoc.docbuilder._get_docs_from_module_file" class="py-name" href="#" onclick="return doclink('link-306', '_get_docs_from_module_file', 'link-153');">_get_docs_from_module_file</a></tt><tt class="py-op">(</tt> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"> <tt class="py-name">module_filename</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">,</tt> <tt class="py-name">pkg_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">)</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">subpackage_dir</tt> <tt class="py-keyword">in</tt> <tt class="py-name">subpackage_dirs</tt><tt class="py-op">:</tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"> <tt class="py-name">subpackage_file</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-307" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-307', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">subpackage_dir</tt><tt class="py-op">,</tt> <tt class="py-string">'__init__'</tt><tt class="py-op">)</tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-308" class="py-name"><a title="epydoc.docbuilder._get_docs_from_module_file" class="py-name" href="#" onclick="return doclink('link-308', '_get_docs_from_module_file', 'link-153');">_get_docs_from_module_file</a></tt><tt class="py-op">(</tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"> <tt class="py-name">subpackage_file</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">,</tt> <tt class="py-name">pkg_docs</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">+=</tt> <tt id="link-309" class="py-name"><a title="epydoc.docbuilder._get_docs_from_submodules" class="py-name" href="#" onclick="return doclink('link-309', '_get_docs_from_submodules', 'link-181');">_get_docs_from_submodules</a></tt><tt class="py-op">(</tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"> <tt class="py-name">subpackage_dir</tt><tt class="py-op">,</tt> <tt class="py-name">docs</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">options</tt><tt class="py-op">,</tt> <tt class="py-name">progress_estimator</tt><tt class="py-op">)</tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">docs</tt> </tt>
</div><a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"> </tt>
<a name="_report_errors"></a><div id="_report_errors-def"><a name="L605"></a><tt class="py-lineno"> 605</tt> <a class="py-toggle" href="#" id="_report_errors-toggle" onclick="return toggle('_report_errors');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_report_errors">_report_errors</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-param">parse_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"> <tt class="py-param">introspect_error</tt><tt class="py-op">,</tt> <tt class="py-param">parse_error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_report_errors-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_report_errors-expanded"><a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"> <tt class="py-name">hdr</tt> <tt class="py-op">=</tt> <tt class="py-string">'In %s:\n'</tt> <tt class="py-op">%</tt> <tt id="link-310" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-310', 'name', 'link-24');">name</a></tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt> <tt class="py-op">==</tt> <tt class="py-name">parse_doc</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"> <tt id="link-311" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-311', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-312" class="py-name" targets="Method epydoc.cli.ConsoleLogger.start_block()=epydoc.cli.ConsoleLogger-class.html#start_block,Method epydoc.cli.HTMLLogger.start_block()=epydoc.cli.HTMLLogger-class.html#start_block,Method epydoc.gui.GUILogger.start_block()=epydoc.gui.GUILogger-class.html#start_block,Method epydoc.log.Logger.start_block()=epydoc.log.Logger-class.html#start_block,Function epydoc.log.start_block()=epydoc.log-module.html#start_block"><a title="epydoc.cli.ConsoleLogger.start_block
epydoc.cli.HTMLLogger.start_block
epydoc.gui.GUILogger.start_block
epydoc.log.Logger.start_block
epydoc.log.start_block" class="py-name" href="#" onclick="return doclink('link-312', 'start_block', 'link-312');">start_block</a></tt><tt class="py-op">(</tt><tt class="py-string">'%sNo documentation available!'</tt> <tt class="py-op">%</tt> <tt class="py-name">hdr</tt><tt class="py-op">)</tt> </tt>
<a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_error</tt><tt class="py-op">:</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> <tt id="link-313" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-313', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-314" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-314', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'Import failed:\n%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">introspect_error</tt><tt class="py-op">)</tt> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parse_error</tt><tt class="py-op">:</tt> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"> <tt id="link-315" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-315', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-316" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-316', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'Source code parsing failed:\n%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">parse_error</tt><tt class="py-op">)</tt> </tt>
<a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"> <tt id="link-317" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-317', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-318" class="py-name" targets="Method epydoc.cli.ConsoleLogger.end_block()=epydoc.cli.ConsoleLogger-class.html#end_block,Method epydoc.cli.HTMLLogger.end_block()=epydoc.cli.HTMLLogger-class.html#end_block,Method epydoc.gui.GUILogger.end_block()=epydoc.gui.GUILogger-class.html#end_block,Method epydoc.log.Logger.end_block()=epydoc.log.Logger-class.html#end_block,Function epydoc.log.end_block()=epydoc.log-module.html#end_block"><a title="epydoc.cli.ConsoleLogger.end_block
epydoc.cli.HTMLLogger.end_block
epydoc.gui.GUILogger.end_block
epydoc.log.Logger.end_block
epydoc.log.end_block" class="py-name" href="#" onclick="return doclink('link-318', 'end_block', 'link-318');">end_block</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">introspect_error</tt><tt class="py-op">:</tt> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> <tt id="link-319" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-319', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-320" class="py-name"><a title="epydoc.cli.ConsoleLogger.start_block
epydoc.cli.HTMLLogger.start_block
epydoc.gui.GUILogger.start_block
epydoc.log.Logger.start_block
epydoc.log.start_block" class="py-name" href="#" onclick="return doclink('link-320', 'start_block', 'link-312');">start_block</a></tt><tt class="py-op">(</tt><tt class="py-string">'%sImport failed (but source code parsing '</tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> <tt class="py-string">'was successful).'</tt> <tt class="py-op">%</tt> <tt class="py-name">hdr</tt><tt class="py-op">)</tt> </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"> <tt id="link-321" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-321', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-322" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-322', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-name">introspect_error</tt><tt class="py-op">)</tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"> <tt id="link-323" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-323', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-324" class="py-name"><a title="epydoc.cli.ConsoleLogger.end_block
epydoc.cli.HTMLLogger.end_block
epydoc.gui.GUILogger.end_block
epydoc.log.Logger.end_block
epydoc.log.end_block" class="py-name" href="#" onclick="return doclink('link-324', 'end_block', 'link-318');">end_block</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">parse_error</tt><tt class="py-op">:</tt> </tt>
<a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"> <tt id="link-325" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-325', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-326" class="py-name"><a title="epydoc.cli.ConsoleLogger.start_block
epydoc.cli.HTMLLogger.start_block
epydoc.gui.GUILogger.start_block
epydoc.log.Logger.start_block
epydoc.log.start_block" class="py-name" href="#" onclick="return doclink('link-326', 'start_block', 'link-312');">start_block</a></tt><tt class="py-op">(</tt><tt class="py-string">'%sSource code parsing failed (but '</tt> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"> <tt class="py-string">'introspection was successful).'</tt> <tt class="py-op">%</tt> <tt class="py-name">hdr</tt><tt class="py-op">)</tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"> <tt id="link-327" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-327', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-328" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-328', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-name">parse_error</tt><tt class="py-op">)</tt> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"> <tt id="link-329" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-329', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-330" class="py-name"><a title="epydoc.cli.ConsoleLogger.end_block
epydoc.cli.HTMLLogger.end_block
epydoc.gui.GUILogger.end_block
epydoc.log.Logger.end_block
epydoc.log.end_block" class="py-name" href="#" onclick="return doclink('link-330', 'end_block', 'link-318');">end_block</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> </tt>
<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"> </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Progress Estimation (for Documentation Generation)</tt> </tt>
<a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="_ProgressEstimator"></a><div id="_ProgressEstimator-def"><a name="L631"></a><tt class="py-lineno"> 631</tt> <a class="py-toggle" href="#" id="_ProgressEstimator-toggle" onclick="return toggle('_ProgressEstimator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docbuilder._ProgressEstimator-class.html">_ProgressEstimator</a><tt class="py-op">:</tt> </tt>
</div><div id="_ProgressEstimator-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_ProgressEstimator-expanded"><a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"><tt class="py-docstring"> Used to keep track of progress when generating the initial docs</tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"><tt class="py-docstring"> for the given items. (It is not known in advance how many items a</tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"><tt class="py-docstring"> package directory will contain, since it might depend on those</tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"><tt class="py-docstring"> packages' __path__ values.)</tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="_ProgressEstimator.__init__"></a><div id="_ProgressEstimator.__init__-def"><a name="L638"></a><tt class="py-lineno"> 638</tt> <a class="py-toggle" href="#" id="_ProgressEstimator.__init__-toggle" onclick="return toggle('_ProgressEstimator.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder._ProgressEstimator-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">items</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_ProgressEstimator.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_ProgressEstimator.__init__-expanded"><a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">est_totals</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">complete</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">:</tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-331" class="py-name"><a title="epydoc.util.is_package_dir" class="py-name" href="#" onclick="return doclink('link-331', 'is_package_dir', 'link-154');">is_package_dir</a></tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">est_totals</tt><tt class="py-op">[</tt><tt class="py-name">item</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-332" class="py-name" targets="Method epydoc.docbuilder._ProgressEstimator._est_pkg_modules()=epydoc.docbuilder._ProgressEstimator-class.html#_est_pkg_modules"><a title="epydoc.docbuilder._ProgressEstimator._est_pkg_modules" class="py-name" href="#" onclick="return doclink('link-332', '_est_pkg_modules', 'link-332');">_est_pkg_modules</a></tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
<a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">est_totals</tt><tt class="py-op">[</tt><tt class="py-name">item</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
</div><a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"> </tt>
<a name="_ProgressEstimator.progress"></a><div id="_ProgressEstimator.progress-def"><a name="L648"></a><tt class="py-lineno"> 648</tt> <a class="py-toggle" href="#" id="_ProgressEstimator.progress-toggle" onclick="return toggle('_ProgressEstimator.progress');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder._ProgressEstimator-class.html#progress">progress</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_ProgressEstimator.progress-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_ProgressEstimator.progress-expanded"><a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"> <tt class="py-name">total</tt> <tt class="py-op">=</tt> <tt class="py-name">sum</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">est_totals</tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">complete</tt><tt class="py-op">)</tt> <tt class="py-op">/</tt> <tt class="py-name">total</tt> </tt>
</div><a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"> </tt>
<a name="_ProgressEstimator.revise_estimate"></a><div id="_ProgressEstimator.revise_estimate-def"><a name="L652"></a><tt class="py-lineno"> 652</tt> <a class="py-toggle" href="#" id="_ProgressEstimator.revise_estimate-toggle" onclick="return toggle('_ProgressEstimator.revise_estimate');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder._ProgressEstimator-class.html#revise_estimate">revise_estimate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">pkg_item</tt><tt class="py-op">,</tt> <tt class="py-param">modules</tt><tt class="py-op">,</tt> <tt class="py-param">subpackages</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_ProgressEstimator.revise_estimate-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_ProgressEstimator.revise_estimate-expanded"><a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">est_totals</tt><tt class="py-op">[</tt><tt class="py-name">pkg_item</tt><tt class="py-op">]</tt> </tt>
<a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">modules</tt><tt class="py-op">:</tt> </tt>
<a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">est_totals</tt><tt class="py-op">[</tt><tt class="py-name">item</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">subpackages</tt><tt class="py-op">:</tt> </tt>
<a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">est_totals</tt><tt class="py-op">[</tt><tt class="py-name">item</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-333" class="py-name"><a title="epydoc.docbuilder._ProgressEstimator._est_pkg_modules" class="py-name" href="#" onclick="return doclink('link-333', '_est_pkg_modules', 'link-332');">_est_pkg_modules</a></tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
</div><a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"> </tt>
<a name="_ProgressEstimator._est_pkg_modules"></a><div id="_ProgressEstimator._est_pkg_modules-def"><a name="L659"></a><tt class="py-lineno"> 659</tt> <a class="py-toggle" href="#" id="_ProgressEstimator._est_pkg_modules-toggle" onclick="return toggle('_ProgressEstimator._est_pkg_modules');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder._ProgressEstimator-class.html#_est_pkg_modules">_est_pkg_modules</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">package_dir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_ProgressEstimator._est_pkg_modules-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_ProgressEstimator._est_pkg_modules-expanded"><a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"> <tt class="py-name">num_items</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-334" class="py-name"><a title="epydoc.util.is_package_dir" class="py-name" href="#" onclick="return doclink('link-334', 'is_package_dir', 'link-154');">is_package_dir</a></tt><tt class="py-op">(</tt><tt class="py-name">package_dir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-335" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-335', 'name', 'link-24');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">listdir</tt><tt class="py-op">(</tt><tt class="py-name">package_dir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"> <tt id="link-336" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-336', 'filename', 'link-230');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-337" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-337', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">package_dir</tt><tt class="py-op">,</tt> <tt id="link-338" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-338', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-339" class="py-name"><a title="epydoc.util.is_module_file" class="py-name" href="#" onclick="return doclink('link-339', 'is_module_file', 'link-152');">is_module_file</a></tt><tt class="py-op">(</tt><tt id="link-340" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-340', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"> <tt class="py-name">num_items</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-341" class="py-name"><a title="epydoc.util.is_package_dir" class="py-name" href="#" onclick="return doclink('link-341', 'is_package_dir', 'link-154');">is_package_dir</a></tt><tt class="py-op">(</tt><tt id="link-342" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-342', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> <tt class="py-name">num_items</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-343" class="py-name"><a title="epydoc.docbuilder._ProgressEstimator._est_pkg_modules" class="py-name" href="#" onclick="return doclink('link-343', '_est_pkg_modules', 'link-332');">_est_pkg_modules</a></tt><tt class="py-op">(</tt><tt id="link-344" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-344', 'filename', 'link-230');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">num_items</tt> </tt>
</div></div><a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> </tt>
<a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Doc Merger</tt> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"><tt id="link-345" class="py-name" targets="Variable epydoc.docbuilder.MERGE_PRECEDENCE=epydoc.docbuilder-module.html#MERGE_PRECEDENCE"><a title="epydoc.docbuilder.MERGE_PRECEDENCE" class="py-name" href="#" onclick="return doclink('link-345', 'MERGE_PRECEDENCE', 'link-345');">MERGE_PRECEDENCE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"> <tt class="py-string">'repr'</tt><tt class="py-op">:</tt> <tt class="py-string">'parse'</tt><tt class="py-op">,</tt> </tt>
<a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"> <tt class="py-comment"># The names we get from introspection match the names that users</tt> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"> <tt class="py-comment"># can actually use -- i.e., they take magic into account.</tt> </tt>
<a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"> <tt class="py-string">'canonical_name'</tt><tt class="py-op">:</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">,</tt> </tt>
<a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"> <tt class="py-comment"># Only fall-back on the parser for is_imported if the introspecter</tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"> <tt class="py-comment"># isn't sure. Otherwise, we can end up thinking that vars</tt> </tt>
<a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"> <tt class="py-comment"># containing modules are not imported, which can cause external</tt> </tt>
<a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"> <tt class="py-comment"># modules to show up in the docs (sf bug #1653486)</tt> </tt>
<a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"> <tt class="py-string">'is_imported'</tt><tt class="py-op">:</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">,</tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> <tt class="py-comment"># The parser can tell if an assignment creates an alias or not.</tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-string">'is_alias'</tt><tt class="py-op">:</tt> <tt class="py-string">'parse'</tt><tt class="py-op">,</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> <tt class="py-comment"># The parser is better able to determine what text file something</tt> </tt>
<a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"> <tt class="py-comment"># came from; e.g., it can't be fooled by 'covert' imports.</tt> </tt>
<a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"> <tt class="py-string">'docformat'</tt><tt class="py-op">:</tt> <tt class="py-string">'parse'</tt><tt class="py-op">,</tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"> <tt class="py-comment"># The parse should be able to tell definitively whether a module</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"> <tt class="py-comment"># is a package or not.</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> <tt class="py-string">'is_package'</tt><tt class="py-op">:</tt> <tt class="py-string">'parse'</tt><tt class="py-op">,</tt> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> <tt class="py-comment"># Extract the sort spec from the order in which values are defined</tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> <tt class="py-comment"># in the source file.</tt> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt class="py-string">'sort_spec'</tt><tt class="py-op">:</tt> <tt class="py-string">'parse'</tt><tt class="py-op">,</tt> </tt>
<a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"> <tt class="py-string">'submodules'</tt><tt class="py-op">:</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">,</tt> </tt>
<a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> </tt>
<a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"> <tt class="py-comment"># The filename used by 'parse' is the source file.</tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"> <tt class="py-string">'filename'</tt><tt class="py-op">:</tt> <tt class="py-string">'parse'</tt><tt class="py-op">,</tt> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt class="py-comment"># 'parse' is more likely to get the encoding right, but</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"> <tt class="py-comment"># 'introspect' will handle programatically generated docstrings.</tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"> <tt class="py-comment"># Which is better?</tt> </tt>
<a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> <tt class="py-string">'docstring'</tt><tt class="py-op">:</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">,</tt> </tt>
<a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"><tt class="py-string">"""Indicates whether information from introspection or parsing should be</tt> </tt>
<a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"><tt class="py-string">given precedence, for specific attributes. This dictionary maps from</tt> </tt>
<a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"><tt class="py-string">attribute names to either C{'introspect'} or C{'parse'}."""</tt> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"><tt id="link-346" class="py-name" targets="Variable epydoc.docbuilder.DEFAULT_MERGE_PRECEDENCE=epydoc.docbuilder-module.html#DEFAULT_MERGE_PRECEDENCE"><a title="epydoc.docbuilder.DEFAULT_MERGE_PRECEDENCE" class="py-name" href="#" onclick="return doclink('link-346', 'DEFAULT_MERGE_PRECEDENCE', 'link-346');">DEFAULT_MERGE_PRECEDENCE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'introspect'</tt> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"><tt class="py-string">"""Indicates whether information from introspection or parsing should be</tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"><tt class="py-string">given precedence. Should be either C{'introspect'} or C{'parse'}"""</tt> </tt>
<a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"> </tt>
<a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"><tt id="link-347" class="py-name" targets="Variable epydoc.docbuilder._attribute_mergefunc_registry=epydoc.docbuilder-module.html#_attribute_mergefunc_registry"><a title="epydoc.docbuilder._attribute_mergefunc_registry" class="py-name" href="#" onclick="return doclink('link-347', '_attribute_mergefunc_registry', 'link-347');">_attribute_mergefunc_registry</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="register_attribute_mergefunc"></a><div id="register_attribute_mergefunc-def"><a name="L723"></a><tt class="py-lineno"> 723</tt> <a class="py-toggle" href="#" id="register_attribute_mergefunc-toggle" onclick="return toggle('register_attribute_mergefunc');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#register_attribute_mergefunc">register_attribute_mergefunc</a><tt class="py-op">(</tt><tt class="py-param">attrib</tt><tt class="py-op">,</tt> <tt class="py-param">mergefunc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="register_attribute_mergefunc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="register_attribute_mergefunc-expanded"><a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"><tt class="py-docstring"> Register an attribute merge function. This function will be</tt> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"><tt class="py-docstring"> called by L{merge_docs()} when it needs to merge the attribute</tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"><tt class="py-docstring"> values of two C{APIDoc}s.</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"><tt class="py-docstring"> @param attrib: The name of the attribute whose values are merged</tt> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"><tt class="py-docstring"> by C{mergefunc}.</tt> </tt>
<a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"><tt class="py-docstring"> @param mergefunc: The merge function, whose sinature is:</tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"><tt class="py-docstring"> >>> def mergefunc(introspect_val, parse_val, precedence, cyclecheck, path):</tt> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"><tt class="py-docstring"> ... return calculate_merged_value(introspect_val, parse_val)</tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"><tt class="py-docstring"> Where C{introspect_val} and C{parse_val} are the two values to</tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"><tt class="py-docstring"> combine; C{precedence} is a string indicating which value takes</tt> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"><tt class="py-docstring"> precedence for this attribute (C{'introspect'} or C{'parse'});</tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"><tt class="py-docstring"> C{cyclecheck} is a value used by C{merge_docs()} to make sure that</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"><tt class="py-docstring"> it only visits each pair of docs once; and C{path} is a string</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"><tt class="py-docstring"> describing the path that was taken from the root to this</tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"><tt class="py-docstring"> attribute (used to generate log messages).</tt> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"><tt class="py-docstring"> If the merge function needs to call C{merge_docs}, then it should</tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"><tt class="py-docstring"> pass C{cyclecheck} and C{path} back in. (When appropriate, a</tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"><tt class="py-docstring"> suffix should be added to C{path} to describe the path taken to</tt> </tt>
<a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"><tt class="py-docstring"> the merged values.)</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"> <tt id="link-348" class="py-name"><a title="epydoc.docbuilder._attribute_mergefunc_registry" class="py-name" href="#" onclick="return doclink('link-348', '_attribute_mergefunc_registry', 'link-347');">_attribute_mergefunc_registry</a></tt><tt class="py-op">[</tt><tt class="py-name">attrib</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">mergefunc</tt> </tt>
</div><a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"> </tt>
<a name="merge_docs"></a><div id="merge_docs-def"><a name="L752"></a><tt class="py-lineno"> 752</tt> <a class="py-toggle" href="#" id="merge_docs-toggle" onclick="return toggle('merge_docs');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_docs">merge_docs</a><tt class="py-op">(</tt><tt class="py-param">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-param">parse_doc</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_docs-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_docs-expanded"><a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"><tt class="py-docstring"> Merge the API documentation information that was obtained from</tt> </tt>
<a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"><tt class="py-docstring"> introspection with information that was obtained from parsing.</tt> </tt>
<a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"><tt class="py-docstring"> C{introspect_doc} and C{parse_doc} should be two C{APIDoc} instances</tt> </tt>
<a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"><tt class="py-docstring"> that describe the same object. C{merge_docs} combines the</tt> </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"><tt class="py-docstring"> information from these two instances, and returns the merged</tt> </tt>
<a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"><tt class="py-docstring"> C{APIDoc}.</tt> </tt>
<a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"><tt class="py-docstring"> If C{introspect_doc} and C{parse_doc} are compatible, then they will</tt> </tt>
<a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"><tt class="py-docstring"> be I{merged} -- i.e., they will be coerced to a common class, and</tt> </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"><tt class="py-docstring"> their state will be stored in a shared dictionary. Once they have</tt> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"><tt class="py-docstring"> been merged, any change made to the attributes of one will affect</tt> </tt>
<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"><tt class="py-docstring"> the other. The value for the each of the merged C{APIDoc}'s</tt> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"><tt class="py-docstring"> attributes is formed by combining the values of the source</tt> </tt>
<a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"><tt class="py-docstring"> C{APIDoc}s' attributes, as follows:</tt> </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"><tt class="py-docstring"> - If either of the source attributes' value is C{UNKNOWN}, then</tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"><tt class="py-docstring"> use the other source attribute's value.</tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"><tt class="py-docstring"> - Otherwise, if an attribute merge function has been registered</tt> </tt>
<a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"><tt class="py-docstring"> for the attribute, then use that function to calculate the</tt> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"><tt class="py-docstring"> merged value from the two source attribute values.</tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"><tt class="py-docstring"> - Otherwise, if L{MERGE_PRECEDENCE} is defined for the</tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"><tt class="py-docstring"> attribute, then use the attribute value from the source that</tt> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"><tt class="py-docstring"> it indicates.</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"><tt class="py-docstring"> - Otherwise, use the attribute value from the source indicated</tt> </tt>
<a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"><tt class="py-docstring"> by L{DEFAULT_MERGE_PRECEDENCE}.</tt> </tt>
<a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"><tt class="py-docstring"> If C{introspect_doc} and C{parse_doc} are I{not} compatible (e.g., if</tt> </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"><tt class="py-docstring"> their values have incompatible types), then C{merge_docs()} will</tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"><tt class="py-docstring"> simply return either C{introspect_doc} or C{parse_doc}, depending on</tt> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"><tt class="py-docstring"> the value of L{DEFAULT_MERGE_PRECEDENCE}. The two input</tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"><tt class="py-docstring"> C{APIDoc}s will not be merged or modified in any way.</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"><tt class="py-docstring"> @param cyclecheck, path: These arguments should only be provided</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"><tt class="py-docstring"> when C{merge_docs()} is called by an attribute merge</tt> </tt>
<a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"><tt class="py-docstring"> function. See L{register_attribute_mergefunc()} for more</tt> </tt>
<a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"><tt class="py-docstring"> details.</tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt id="link-349" class="py-name" targets="Class epydoc.apidoc.APIDoc=epydoc.apidoc.APIDoc-class.html"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-349', 'APIDoc', 'link-349');">APIDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt id="link-350" class="py-name"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-350', 'APIDoc', 'link-349');">APIDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">cyclecheck</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"> <tt class="py-name">cyclecheck</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-351" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-351', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-352" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-352', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> <tt id="link-353" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-353', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-354" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-354', 'canonical_name', 'link-42');">canonical_name</a></tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-355" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-355', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-356" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-356', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"> <tt id="link-357" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-357', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-358" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-358', 'canonical_name', 'link-42');">canonical_name</a></tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> <tt id="link-359" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-359', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'??'</tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"> <tt class="py-comment"># If we've already examined this pair, then there's nothing</tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># more to do. The reason that we check id's here is that we</tt> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># want to avoid hashing the APIDoc objects for now, so we can</tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># use APIDoc.merge_and_overwrite() later.</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">id</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">id</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">cyclecheck</tt><tt class="py-op">:</tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">introspect_doc</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"> <tt class="py-name">cyclecheck</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">id</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">id</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> </tt>
<a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt class="py-comment"># If these two are already merged, then we're done. (Two</tt> </tt>
<a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># APIDoc's compare equal iff they are identical or have been</tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># merged.)</tt> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt> <tt class="py-op">==</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">:</tt> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">introspect_doc</tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"> <tt class="py-comment"># If both values are GenericValueDoc, then we don't want to merge</tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># them. E.g., we don't want to merge 2+2 with 4. So just copy</tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the parse_doc's parse_repr to introspect_doc, & return it.</tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (In particular, do *not* call merge_and_overwrite.)</tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt id="link-360" class="py-name" targets="Class epydoc.apidoc.GenericValueDoc=epydoc.apidoc.GenericValueDoc-class.html"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-360', 'GenericValueDoc', 'link-360');">GenericValueDoc</a></tt><tt class="py-op">:</tt> </tt>
<a name="L822"></a><tt class="py-lineno"> 822</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-361" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.parse_repr=epydoc.apidoc.ValueDoc-class.html#parse_repr"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-361', 'parse_repr', 'link-361');">parse_repr</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-362" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-362', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-363" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-363', 'parse_repr', 'link-361');">parse_repr</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-364" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-364', 'parse_repr', 'link-361');">parse_repr</a></tt> </tt>
<a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-365" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docs_extracted_by=epydoc.apidoc.APIDoc-class.html#docs_extracted_by"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-365', 'docs_extracted_by', 'link-365');">docs_extracted_by</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'both'</tt> </tt>
<a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">introspect_doc</tt> </tt>
<a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"> <tt class="py-comment"># Perform several sanity checks here -- if we accidentally</tt> </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># merge values that shouldn't get merged, then bad things can</tt> </tt>
<a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># happen.</tt> </tt>
<a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">mismatch</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt> <tt class="py-op">!=</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt class="py-name">issubclass</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"> <tt class="py-name">issubclass</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">,</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"> <tt class="py-name">mismatch</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">"value types don't match -- i=%r, p=%r."</tt> <tt class="py-op">%</tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt id="link-366" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-366', 'ValueDoc', 'link-107');">ValueDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt id="link-367" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-367', 'ValueDoc', 'link-107');">ValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-368" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.pyval=epydoc.apidoc.ValueDoc-class.html#pyval"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-368', 'pyval', 'link-368');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-369" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-369', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-370" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-370', 'pyval', 'link-368');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-371" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-371', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-372" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-372', 'pyval', 'link-368');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-373" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-373', 'pyval', 'link-368');">pyval</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> <tt class="py-name">mismatch</tt> <tt class="py-op">=</tt> <tt class="py-string">"values don't match."</tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-374" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-374', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-375" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-375', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-376" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-376', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-377" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-377', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-378" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-378', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-379" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-379', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"> <tt class="py-name">mismatch</tt> <tt class="py-op">=</tt> <tt class="py-string">"canonical names don't match."</tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">mismatch</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> <tt id="link-380" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-380', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-381" class="py-name" targets="Function epydoc.log.info()=epydoc.log-module.html#info"><a title="epydoc.log.info" class="py-name" href="#" onclick="return doclink('link-381', 'info', 'link-381');">info</a></tt><tt class="py-op">(</tt><tt class="py-string">"Not merging the parsed & introspected values of %s, "</tt> </tt>
<a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"> <tt class="py-string">"since their %s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-382" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-382', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-name">mismatch</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-383" class="py-name"><a title="epydoc.docbuilder.DEFAULT_MERGE_PRECEDENCE" class="py-name" href="#" onclick="return doclink('link-383', 'DEFAULT_MERGE_PRECEDENCE', 'link-346');">DEFAULT_MERGE_PRECEDENCE</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">:</tt> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">introspect_doc</tt> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parse_doc</tt> </tt>
<a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> <tt class="py-comment"># If one apidoc's class is a superclass of the other's, then</tt> </tt>
<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># specialize it to the more specific class.</tt> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">:</tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">issubclass</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-384" class="py-name" targets="Method epydoc.apidoc.APIDoc.specialize_to()=epydoc.apidoc.APIDoc-class.html#specialize_to"><a title="epydoc.apidoc.APIDoc.specialize_to" class="py-name" href="#" onclick="return doclink('link-384', 'specialize_to', 'link-384');">specialize_to</a></tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">issubclass</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">,</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-385" class="py-name"><a title="epydoc.apidoc.APIDoc.specialize_to" class="py-name" href="#" onclick="return doclink('link-385', 'specialize_to', 'link-384');">specialize_to</a></tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt> <tt class="py-keyword">is</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt> </tt>
<a name="L862"></a><tt class="py-lineno"> 862</tt> <tt class="py-line"> </tt>
<a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"> <tt class="py-comment"># The posargs and defaults are tied together -- if we merge</tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the posargs one way, then we need to merge the defaults the</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># same way. So check them first. (This is a minor hack)</tt> </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt id="link-386" class="py-name" targets="Class epydoc.apidoc.RoutineDoc=epydoc.apidoc.RoutineDoc-class.html"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-386', 'RoutineDoc', 'link-386');">RoutineDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt id="link-387" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-387', 'RoutineDoc', 'link-386');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> <tt id="link-388" class="py-name" targets="Function epydoc.docbuilder._merge_posargs_and_defaults()=epydoc.docbuilder-module.html#_merge_posargs_and_defaults"><a title="epydoc.docbuilder._merge_posargs_and_defaults" class="py-name" href="#" onclick="return doclink('link-388', '_merge_posargs_and_defaults', 'link-388');">_merge_posargs_and_defaults</a></tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt id="link-389" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-389', 'path', 'link-0');">path</a></tt><tt class="py-op">)</tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"> </tt>
<a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"> <tt class="py-comment"># Merge the two api_doc's attributes.</tt> </tt>
<a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">attrib</tt> <tt class="py-keyword">in</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> <tt class="py-comment"># Be sure not to merge any private attributes (especially</tt> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># __mergeset or __has_been_hashed!)</tt> </tt>
<a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">attrib</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'_'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> <tt id="link-390" class="py-name" targets="Function epydoc.docbuilder.merge_attribute()=epydoc.docbuilder-module.html#merge_attribute"><a title="epydoc.docbuilder.merge_attribute" class="py-name" href="#" onclick="return doclink('link-390', 'merge_attribute', 'link-390');">merge_attribute</a></tt><tt class="py-op">(</tt><tt class="py-name">attrib</tt><tt class="py-op">,</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"> <tt class="py-name">cyclecheck</tt><tt class="py-op">,</tt> <tt id="link-391" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-391', 'path', 'link-0');">path</a></tt><tt class="py-op">)</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"> <tt class="py-comment"># Set the dictionaries to be shared.</tt> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-392" class="py-name" targets="Method epydoc.apidoc.APIDoc.merge_and_overwrite()=epydoc.apidoc.APIDoc-class.html#merge_and_overwrite"><a title="epydoc.apidoc.APIDoc.merge_and_overwrite" class="py-name" href="#" onclick="return doclink('link-392', 'merge_and_overwrite', 'link-392');">merge_and_overwrite</a></tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"> </tt>
<a name="_merge_posargs_and_defaults"></a><div id="_merge_posargs_and_defaults-def"><a name="L882"></a><tt class="py-lineno"> 882</tt> <a class="py-toggle" href="#" id="_merge_posargs_and_defaults-toggle" onclick="return toggle('_merge_posargs_and_defaults');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_merge_posargs_and_defaults">_merge_posargs_and_defaults</a><tt class="py-op">(</tt><tt class="py-param">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-param">parse_doc</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_merge_posargs_and_defaults-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_merge_posargs_and_defaults-expanded"><a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"> <tt class="py-comment"># If either is unknown, then let merge_attrib handle it.</tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-393" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posargs=epydoc.apidoc.RoutineDoc-class.html#posargs"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-393', 'posargs', 'link-393');">posargs</a></tt> <tt class="py-keyword">is</tt> <tt id="link-394" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-394', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> <tt class="py-keyword">or</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-395" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-395', 'posargs', 'link-393');">posargs</a></tt> <tt class="py-keyword">is</tt> <tt id="link-396" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-396', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"> <tt class="py-comment"># If the introspected doc just has '...', then trust the parsed doc.</tt> </tt>
<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-397" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-397', 'posargs', 'link-393');">posargs</a></tt> <tt class="py-op">==</tt> <tt class="py-op">[</tt><tt class="py-string">'...'</tt><tt class="py-op">]</tt> <tt class="py-keyword">and</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-398" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-398', 'posargs', 'link-393');">posargs</a></tt> <tt class="py-op">!=</tt> <tt class="py-op">[</tt><tt class="py-string">'...'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-399" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-399', 'posargs', 'link-393');">posargs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-400" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-400', 'posargs', 'link-393');">posargs</a></tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-401" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posarg_defaults=epydoc.apidoc.RoutineDoc-class.html#posarg_defaults"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-401', 'posarg_defaults', 'link-401');">posarg_defaults</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-402" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-402', 'posarg_defaults', 'link-401');">posarg_defaults</a></tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"> <tt class="py-comment"># If they are incompatible, then check the precedence.</tt> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-403" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-403', 'posargs', 'link-393');">posargs</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-404" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-404', 'posargs', 'link-393');">posargs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"> <tt id="link-405" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-405', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-406" class="py-name"><a title="epydoc.log.info" class="py-name" href="#" onclick="return doclink('link-406', 'info', 'link-381');">info</a></tt><tt class="py-op">(</tt><tt class="py-string">"Not merging the parsed & introspected arg "</tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"> <tt class="py-string">"lists for %s, since they don't match (%s vs %s)"</tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-407" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-407', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-408" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-408', 'posargs', 'link-393');">posargs</a></tt><tt class="py-op">,</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-409" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-409', 'posargs', 'link-393');">posargs</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt id="link-410" class="py-name"><a title="epydoc.docbuilder.MERGE_PRECEDENCE" class="py-name" href="#" onclick="return doclink('link-410', 'MERGE_PRECEDENCE', 'link-345');">MERGE_PRECEDENCE</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'posargs'</tt><tt class="py-op">,</tt> <tt id="link-411" class="py-name"><a title="epydoc.docbuilder.DEFAULT_MERGE_PRECEDENCE" class="py-name" href="#" onclick="return doclink('link-411', 'DEFAULT_MERGE_PRECEDENCE', 'link-346');">DEFAULT_MERGE_PRECEDENCE</a></tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> </tt>
<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"> <tt class="py-string">'introspect'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-412" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-412', 'posargs', 'link-393');">posargs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-413" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-413', 'posargs', 'link-393');">posargs</a></tt> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-414" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-414', 'posarg_defaults', 'link-401');">posarg_defaults</a></tt> <tt class="py-op">=</tt> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-415" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-415', 'posarg_defaults', 'link-401');">posarg_defaults</a></tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-416" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-416', 'posargs', 'link-393');">posargs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-417" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-417', 'posargs', 'link-393');">posargs</a></tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"> <tt class="py-name">introspect_doc</tt><tt class="py-op">.</tt><tt id="link-418" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-418', 'posarg_defaults', 'link-401');">posarg_defaults</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parse_doc</tt><tt class="py-op">.</tt><tt id="link-419" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-419', 'posarg_defaults', 'link-401');">posarg_defaults</a></tt> </tt>
</div><a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"> </tt>
<a name="merge_attribute"></a><div id="merge_attribute-def"><a name="L905"></a><tt class="py-lineno"> 905</tt> <a class="py-toggle" href="#" id="merge_attribute-toggle" onclick="return toggle('merge_attribute');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_attribute">merge_attribute</a><tt class="py-op">(</tt><tt class="py-param">attrib</tt><tt class="py-op">,</tt> <tt class="py-param">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-param">parse_doc</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_attribute-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_attribute-expanded"><a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"> <tt class="py-name">precedence</tt> <tt class="py-op">=</tt> <tt id="link-420" class="py-name"><a title="epydoc.docbuilder.MERGE_PRECEDENCE" class="py-name" href="#" onclick="return doclink('link-420', 'MERGE_PRECEDENCE', 'link-345');">MERGE_PRECEDENCE</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">attrib</tt><tt class="py-op">,</tt> <tt id="link-421" class="py-name"><a title="epydoc.docbuilder.DEFAULT_MERGE_PRECEDENCE" class="py-name" href="#" onclick="return doclink('link-421', 'DEFAULT_MERGE_PRECEDENCE', 'link-346');">DEFAULT_MERGE_PRECEDENCE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">precedence</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'parse'</tt><tt class="py-op">,</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad precedence value %r'</tt> <tt class="py-op">%</tt> <tt class="py-name">precedence</tt><tt class="py-op">)</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt id="link-422" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-422', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-423" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-423', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">,</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-424" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-424', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt id="link-425" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-425', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">,</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt id="link-426" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-426', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt id="link-427" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-427', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"> <tt class="py-comment"># Both APIDoc objects have values; we need to merge them.</tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">introspect_val</tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"> <tt class="py-name">parse_val</tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">attrib</tt> <tt class="py-keyword">in</tt> <tt id="link-428" class="py-name"><a title="epydoc.docbuilder._attribute_mergefunc_registry" class="py-name" href="#" onclick="return doclink('link-428', '_attribute_mergefunc_registry', 'link-347');">_attribute_mergefunc_registry</a></tt><tt class="py-op">:</tt> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"> <tt class="py-name">handler</tt> <tt class="py-op">=</tt> <tt id="link-429" class="py-name"><a title="epydoc.docbuilder._attribute_mergefunc_registry" class="py-name" href="#" onclick="return doclink('link-429', '_attribute_mergefunc_registry', 'link-347');">_attribute_mergefunc_registry</a></tt><tt class="py-op">[</tt><tt class="py-name">attrib</tt><tt class="py-op">]</tt> </tt>
<a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"> <tt class="py-name">merged_val</tt> <tt class="py-op">=</tt> <tt class="py-name">handler</tt><tt class="py-op">(</tt><tt class="py-name">introspect_val</tt><tt class="py-op">,</tt> <tt class="py-name">parse_val</tt><tt class="py-op">,</tt> <tt class="py-name">precedence</tt><tt class="py-op">,</tt> </tt>
<a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"> <tt class="py-name">cyclecheck</tt><tt class="py-op">,</tt> <tt id="link-430" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-430', 'path', 'link-0');">path</a></tt><tt class="py-op">)</tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">precedence</tt> <tt class="py-op">==</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">:</tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"> <tt class="py-name">merged_val</tt> <tt class="py-op">=</tt> <tt class="py-name">introspect_val</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">precedence</tt> <tt class="py-op">==</tt> <tt class="py-string">'parse'</tt><tt class="py-op">:</tt> </tt>
<a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"> <tt class="py-name">merged_val</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_val</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"> </tt>
<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">introspect_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">,</tt> <tt class="py-name">merged_val</tt><tt class="py-op">)</tt> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">parse_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">,</tt> <tt class="py-name">merged_val</tt><tt class="py-op">)</tt> </tt>
</div><a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"> </tt>
<a name="merge_variables"></a><div id="merge_variables-def"><a name="L935"></a><tt class="py-lineno"> 935</tt> <a class="py-toggle" href="#" id="merge_variables-toggle" onclick="return toggle('merge_variables');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_variables">merge_variables</a><tt class="py-op">(</tt><tt class="py-param">varlist1</tt><tt class="py-op">,</tt> <tt class="py-param">varlist2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_variables-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_variables-expanded"><a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-comment"># Merge all variables that are in both sets.</tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">varname</tt><tt class="py-op">,</tt> <tt class="py-name">var1</tt> <tt class="py-keyword">in</tt> <tt class="py-name">varlist1</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> <tt class="py-name">var2</tt> <tt class="py-op">=</tt> <tt class="py-name">varlist2</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">varname</tt><tt class="py-op">)</tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var2</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"> <tt class="py-name">var</tt> <tt class="py-op">=</tt> <tt id="link-431" class="py-name"><a title="epydoc.docbuilder.merge_docs" class="py-name" href="#" onclick="return doclink('link-431', 'merge_docs', 'link-51');">merge_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">var1</tt><tt class="py-op">,</tt> <tt class="py-name">var2</tt><tt class="py-op">,</tt> <tt class="py-name">cyclecheck</tt><tt class="py-op">,</tt> <tt id="link-432" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-432', 'path', 'link-0');">path</a></tt><tt class="py-op">+</tt><tt class="py-string">'.'</tt><tt class="py-op">+</tt><tt class="py-name">varname</tt><tt class="py-op">)</tt> </tt>
<a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"> <tt class="py-name">varlist1</tt><tt class="py-op">[</tt><tt class="py-name">varname</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">var</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"> <tt class="py-name">varlist2</tt><tt class="py-op">[</tt><tt class="py-name">varname</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">var</tt> </tt>
<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"> <tt class="py-comment"># Copy any variables that are not in varlist1 over.</tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">varname</tt><tt class="py-op">,</tt> <tt class="py-name">var</tt> <tt class="py-keyword">in</tt> <tt class="py-name">varlist2</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"> <tt class="py-name">varlist1</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">varname</tt><tt class="py-op">,</tt> <tt class="py-name">var</tt><tt class="py-op">)</tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">varlist1</tt> </tt>
</div><a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"> </tt>
<a name="merge_value"></a><div id="merge_value-def"><a name="L950"></a><tt class="py-lineno"> 950</tt> <a class="py-toggle" href="#" id="merge_value-toggle" onclick="return toggle('merge_value');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_value">merge_value</a><tt class="py-op">(</tt><tt class="py-param">value1</tt><tt class="py-op">,</tt> <tt class="py-param">value2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_value-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_value-expanded"><a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">value1</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">value2</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-433" class="py-name"><a title="epydoc.docbuilder.merge_docs" class="py-name" href="#" onclick="return doclink('link-433', 'merge_docs', 'link-51');">merge_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">value1</tt><tt class="py-op">,</tt> <tt class="py-name">value2</tt><tt class="py-op">,</tt> <tt class="py-name">cyclecheck</tt><tt class="py-op">,</tt> <tt id="link-434" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-434', 'path', 'link-0');">path</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"> </tt>
<a name="merge_overrides"></a><div id="merge_overrides-def"><a name="L954"></a><tt class="py-lineno"> 954</tt> <a class="py-toggle" href="#" id="merge_overrides-toggle" onclick="return toggle('merge_overrides');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_overrides">merge_overrides</a><tt class="py-op">(</tt><tt class="py-param">v1</tt><tt class="py-op">,</tt> <tt class="py-param">v2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_overrides-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_overrides-expanded"><a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-435" class="py-name" targets="Function epydoc.docbuilder.merge_value()=epydoc.docbuilder-module.html#merge_value"><a title="epydoc.docbuilder.merge_value" class="py-name" href="#" onclick="return doclink('link-435', 'merge_value', 'link-435');">merge_value</a></tt><tt class="py-op">(</tt><tt class="py-name">v1</tt><tt class="py-op">,</tt> <tt class="py-name">v2</tt><tt class="py-op">,</tt> <tt class="py-name">precedence</tt><tt class="py-op">,</tt> <tt class="py-name">cyclecheck</tt><tt class="py-op">,</tt> <tt id="link-436" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-436', 'path', 'link-0');">path</a></tt><tt class="py-op">+</tt><tt class="py-string">'.<overrides>'</tt><tt class="py-op">)</tt> </tt>
</div><a name="merge_fget"></a><div id="merge_fget-def"><a name="L956"></a><tt class="py-lineno"> 956</tt> <a class="py-toggle" href="#" id="merge_fget-toggle" onclick="return toggle('merge_fget');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_fget">merge_fget</a><tt class="py-op">(</tt><tt class="py-param">v1</tt><tt class="py-op">,</tt> <tt class="py-param">v2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_fget-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_fget-expanded"><a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-437" class="py-name"><a title="epydoc.docbuilder.merge_value" class="py-name" href="#" onclick="return doclink('link-437', 'merge_value', 'link-435');">merge_value</a></tt><tt class="py-op">(</tt><tt class="py-name">v1</tt><tt class="py-op">,</tt> <tt class="py-name">v2</tt><tt class="py-op">,</tt> <tt class="py-name">precedence</tt><tt class="py-op">,</tt> <tt class="py-name">cyclecheck</tt><tt class="py-op">,</tt> <tt id="link-438" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-438', 'path', 'link-0');">path</a></tt><tt class="py-op">+</tt><tt class="py-string">'.fget'</tt><tt class="py-op">)</tt> </tt>
</div><a name="merge_fset"></a><div id="merge_fset-def"><a name="L958"></a><tt class="py-lineno"> 958</tt> <a class="py-toggle" href="#" id="merge_fset-toggle" onclick="return toggle('merge_fset');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_fset">merge_fset</a><tt class="py-op">(</tt><tt class="py-param">v1</tt><tt class="py-op">,</tt> <tt class="py-param">v2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_fset-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_fset-expanded"><a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-439" class="py-name"><a title="epydoc.docbuilder.merge_value" class="py-name" href="#" onclick="return doclink('link-439', 'merge_value', 'link-435');">merge_value</a></tt><tt class="py-op">(</tt><tt class="py-name">v1</tt><tt class="py-op">,</tt> <tt class="py-name">v2</tt><tt class="py-op">,</tt> <tt class="py-name">precedence</tt><tt class="py-op">,</tt> <tt class="py-name">cyclecheck</tt><tt class="py-op">,</tt> <tt id="link-440" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-440', 'path', 'link-0');">path</a></tt><tt class="py-op">+</tt><tt class="py-string">'.fset'</tt><tt class="py-op">)</tt> </tt>
</div><a name="merge_fdel"></a><div id="merge_fdel-def"><a name="L960"></a><tt class="py-lineno"> 960</tt> <a class="py-toggle" href="#" id="merge_fdel-toggle" onclick="return toggle('merge_fdel');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_fdel">merge_fdel</a><tt class="py-op">(</tt><tt class="py-param">v1</tt><tt class="py-op">,</tt> <tt class="py-param">v2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_fdel-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_fdel-expanded"><a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-441" class="py-name"><a title="epydoc.docbuilder.merge_value" class="py-name" href="#" onclick="return doclink('link-441', 'merge_value', 'link-435');">merge_value</a></tt><tt class="py-op">(</tt><tt class="py-name">v1</tt><tt class="py-op">,</tt> <tt class="py-name">v2</tt><tt class="py-op">,</tt> <tt class="py-name">precedence</tt><tt class="py-op">,</tt> <tt class="py-name">cyclecheck</tt><tt class="py-op">,</tt> <tt id="link-442" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-442', 'path', 'link-0');">path</a></tt><tt class="py-op">+</tt><tt class="py-string">'.fdel'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"> </tt>
<a name="merge_proxy_for"></a><div id="merge_proxy_for-def"><a name="L963"></a><tt class="py-lineno"> 963</tt> <a class="py-toggle" href="#" id="merge_proxy_for-toggle" onclick="return toggle('merge_proxy_for');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_proxy_for">merge_proxy_for</a><tt class="py-op">(</tt><tt class="py-param">v1</tt><tt class="py-op">,</tt> <tt class="py-param">v2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_proxy_for-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_proxy_for-expanded"><a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"> <tt class="py-comment"># Anything we got from introspection shouldn't have a proxy_for</tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># attribute -- it should be the actual object's documentation.</tt> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">v1</tt> </tt>
</div><a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"> </tt>
<a name="merge_bases"></a><div id="merge_bases-def"><a name="L968"></a><tt class="py-lineno"> 968</tt> <a class="py-toggle" href="#" id="merge_bases-toggle" onclick="return toggle('merge_bases');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_bases">merge_bases</a><tt class="py-op">(</tt><tt class="py-param">baselist1</tt><tt class="py-op">,</tt> <tt class="py-param">baselist2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_bases-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_bases-expanded"><a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"> <tt class="py-comment"># Be careful here -- if we get it wrong, then we could end up</tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># merging two unrelated classes, which could lead to bad</tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># things (e.g., a class that's its own subclass). So only</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># merge two bases if we're quite sure they're the same class.</tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (In particular, if they have the same canonical name.)</tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"> <tt class="py-comment"># If the lengths don't match up, then give up. This is most</tt> </tt>
<a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># often caused by __metaclass__.</tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">baselist1</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">baselist2</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> <tt id="link-443" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-443', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-444" class="py-name"><a title="epydoc.log.info" class="py-name" href="#" onclick="return doclink('link-444', 'info', 'link-381');">info</a></tt><tt class="py-op">(</tt><tt class="py-string">"Not merging the introspected & parsed base lists "</tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"> <tt class="py-string">"for %s, since their lengths don't match (%s vs %s)"</tt> <tt class="py-op">%</tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-445" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-445', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">baselist1</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">baselist2</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">precedence</tt> <tt class="py-op">==</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">baselist1</tt> </tt>
<a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">baselist2</tt> </tt>
<a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> </tt>
<a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt class="py-comment"># If any names disagree, then give up.</tt> </tt>
<a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">base1</tt><tt class="py-op">,</tt> <tt class="py-name">base2</tt> <tt class="py-keyword">in</tt> <tt class="py-name">zip</tt><tt class="py-op">(</tt><tt class="py-name">baselist1</tt><tt class="py-op">,</tt> <tt class="py-name">baselist2</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">base1</tt><tt class="py-op">.</tt><tt id="link-446" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-446', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-447" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-447', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"> <tt class="py-name">base2</tt><tt class="py-op">.</tt><tt id="link-448" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-448', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-449" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-449', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"> <tt class="py-name">base1</tt><tt class="py-op">.</tt><tt id="link-450" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-450', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">base2</tt><tt class="py-op">.</tt><tt id="link-451" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-451', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"> <tt id="link-452" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-452', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-453" class="py-name"><a title="epydoc.log.info" class="py-name" href="#" onclick="return doclink('link-453', 'info', 'link-381');">info</a></tt><tt class="py-op">(</tt><tt class="py-string">"Not merging the parsed & introspected base "</tt> </tt>
<a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"> <tt class="py-string">"lists for %s, since the bases' names don't match "</tt> </tt>
<a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"> <tt class="py-string">"(%s vs %s)"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-454" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-454', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-name">base1</tt><tt class="py-op">.</tt><tt id="link-455" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-455', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">,</tt> </tt>
<a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"> <tt class="py-name">base2</tt><tt class="py-op">.</tt><tt id="link-456" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-456', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">precedence</tt> <tt class="py-op">==</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">baselist1</tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">baselist2</tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"> </tt>
<a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">base1</tt><tt class="py-op">,</tt> <tt class="py-name">base2</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">zip</tt><tt class="py-op">(</tt><tt class="py-name">baselist1</tt><tt class="py-op">,</tt> <tt class="py-name">baselist2</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"> <tt class="py-name">base</tt> <tt class="py-op">=</tt> <tt id="link-457" class="py-name"><a title="epydoc.docbuilder.merge_docs" class="py-name" href="#" onclick="return doclink('link-457', 'merge_docs', 'link-51');">merge_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">base1</tt><tt class="py-op">,</tt> <tt class="py-name">base2</tt><tt class="py-op">,</tt> <tt class="py-name">cyclecheck</tt><tt class="py-op">,</tt> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"> <tt class="py-string">'%s.__bases__[%d]'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-458" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-458', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-name">i</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"> <tt class="py-name">baselist1</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">baselist2</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">base</tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">baselist1</tt> </tt>
</div><a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"> </tt>
<a name="merge_posarg_defaults"></a><div id="merge_posarg_defaults-def"><a name="L1003"></a><tt class="py-lineno">1003</tt> <a class="py-toggle" href="#" id="merge_posarg_defaults-toggle" onclick="return toggle('merge_posarg_defaults');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_posarg_defaults">merge_posarg_defaults</a><tt class="py-op">(</tt><tt class="py-param">defaults1</tt><tt class="py-op">,</tt> <tt class="py-param">defaults2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_posarg_defaults-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_posarg_defaults-expanded"><a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">defaults1</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">defaults2</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">precedence</tt> <tt class="py-op">==</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">defaults1</tt> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">defaults2</tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"> <tt class="py-name">defaults</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">d1</tt><tt class="py-op">,</tt> <tt class="py-name">d2</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">zip</tt><tt class="py-op">(</tt><tt class="py-name">defaults1</tt><tt class="py-op">,</tt> <tt class="py-name">defaults2</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">d1</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">d2</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"> <tt class="py-name">d_path</tt> <tt class="py-op">=</tt> <tt class="py-string">'%s.<default-arg-val>[%d]'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-459" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-459', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-name">i</tt><tt class="py-op">)</tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"> <tt class="py-name">defaults</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-460" class="py-name"><a title="epydoc.docbuilder.merge_docs" class="py-name" href="#" onclick="return doclink('link-460', 'merge_docs', 'link-51');">merge_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">d1</tt><tt class="py-op">,</tt> <tt class="py-name">d2</tt><tt class="py-op">,</tt> <tt class="py-name">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-name">d_path</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">precedence</tt> <tt class="py-op">==</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">:</tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"> <tt class="py-name">defaults</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">d1</tt><tt class="py-op">)</tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"> <tt class="py-name">defaults</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">d2</tt><tt class="py-op">)</tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">defaults</tt> </tt>
</div><a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> </tt>
<a name="merge_docstring"></a><div id="merge_docstring-def"><a name="L1018"></a><tt class="py-lineno">1018</tt> <a class="py-toggle" href="#" id="merge_docstring-toggle" onclick="return toggle('merge_docstring');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_docstring">merge_docstring</a><tt class="py-op">(</tt><tt class="py-param">docstring1</tt><tt class="py-op">,</tt> <tt class="py-param">docstring2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_docstring-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_docstring-expanded"><a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">docstring1</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-name">docstring1</tt> <tt class="py-keyword">is</tt> <tt id="link-461" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-461', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> <tt class="py-keyword">or</tt> <tt class="py-name">precedence</tt><tt class="py-op">==</tt><tt class="py-string">'parse'</tt><tt class="py-op">:</tt> </tt>
<a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">docstring2</tt> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">docstring1</tt> </tt>
</div><a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"> </tt>
<a name="merge_docs_extracted_by"></a><div id="merge_docs_extracted_by-def"><a name="L1024"></a><tt class="py-lineno">1024</tt> <a class="py-toggle" href="#" id="merge_docs_extracted_by-toggle" onclick="return toggle('merge_docs_extracted_by');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_docs_extracted_by">merge_docs_extracted_by</a><tt class="py-op">(</tt><tt class="py-param">v1</tt><tt class="py-op">,</tt> <tt class="py-param">v2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_docs_extracted_by-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_docs_extracted_by-expanded"><a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'both'</tt> </tt>
</div><a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"> </tt>
<a name="merge_submodules"></a><div id="merge_submodules-def"><a name="L1027"></a><tt class="py-lineno">1027</tt> <a class="py-toggle" href="#" id="merge_submodules-toggle" onclick="return toggle('merge_submodules');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#merge_submodules">merge_submodules</a><tt class="py-op">(</tt><tt class="py-param">v1</tt><tt class="py-op">,</tt> <tt class="py-param">v2</tt><tt class="py-op">,</tt> <tt class="py-param">precedence</tt><tt class="py-op">,</tt> <tt class="py-param">cyclecheck</tt><tt class="py-op">,</tt> <tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="merge_submodules-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="merge_submodules-expanded"><a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"> <tt class="py-name">n1</tt> <tt class="py-op">=</tt> <tt id="link-462" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-462', 'sorted', 'link-60');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt id="link-463" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-463', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">for</tt> <tt class="py-name">m</tt> <tt class="py-keyword">in</tt> <tt class="py-name">v1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"> <tt class="py-name">n2</tt> <tt class="py-op">=</tt> <tt id="link-464" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-464', 'sorted', 'link-60');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt id="link-465" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-465', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">for</tt> <tt class="py-name">m</tt> <tt class="py-keyword">in</tt> <tt class="py-name">v2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">n1</tt> <tt class="py-op">!=</tt> <tt class="py-name">n2</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-op">(</tt><tt class="py-name">n2</tt> <tt class="py-op">!=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"> <tt id="link-466" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-466', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-467" class="py-name"><a title="epydoc.log.info" class="py-name" href="#" onclick="return doclink('link-467', 'info', 'link-381');">info</a></tt><tt class="py-op">(</tt><tt class="py-string">'Introspector & parser disagree about submodules '</tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"> <tt class="py-string">'for %s: (%s) vs (%s)'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-468" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-468', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"> <tt class="py-string">', '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">n</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">n</tt> <tt class="py-keyword">in</tt> <tt class="py-name">n1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"> <tt class="py-string">', '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">n</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">n</tt> <tt class="py-keyword">in</tt> <tt class="py-name">n2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">v1</tt> <tt class="py-op">+</tt> <tt class="py-op">[</tt><tt class="py-name">m</tt> <tt class="py-keyword">for</tt> <tt class="py-name">m</tt> <tt class="py-keyword">in</tt> <tt class="py-name">v2</tt> <tt class="py-keyword">if</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt id="link-469" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-469', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">n1</tt><tt class="py-op">]</tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">v1</tt> </tt>
</div><a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"><tt id="link-470" class="py-name" targets="Function epydoc.docbuilder.register_attribute_mergefunc()=epydoc.docbuilder-module.html#register_attribute_mergefunc"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-470', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'variables'</tt><tt class="py-op">,</tt> <tt id="link-471" class="py-name" targets="Function epydoc.docbuilder.merge_variables()=epydoc.docbuilder-module.html#merge_variables"><a title="epydoc.docbuilder.merge_variables" class="py-name" href="#" onclick="return doclink('link-471', 'merge_variables', 'link-471');">merge_variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt id="link-472" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-472', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'value'</tt><tt class="py-op">,</tt> <tt id="link-473" class="py-name"><a title="epydoc.docbuilder.merge_value" class="py-name" href="#" onclick="return doclink('link-473', 'merge_value', 'link-435');">merge_value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"><tt id="link-474" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-474', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'overrides'</tt><tt class="py-op">,</tt> <tt id="link-475" class="py-name" targets="Function epydoc.docbuilder.merge_overrides()=epydoc.docbuilder-module.html#merge_overrides"><a title="epydoc.docbuilder.merge_overrides" class="py-name" href="#" onclick="return doclink('link-475', 'merge_overrides', 'link-475');">merge_overrides</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"><tt id="link-476" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-476', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'fget'</tt><tt class="py-op">,</tt> <tt id="link-477" class="py-name" targets="Function epydoc.docbuilder.merge_fget()=epydoc.docbuilder-module.html#merge_fget"><a title="epydoc.docbuilder.merge_fget" class="py-name" href="#" onclick="return doclink('link-477', 'merge_fget', 'link-477');">merge_fget</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"><tt id="link-478" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-478', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'fset'</tt><tt class="py-op">,</tt> <tt id="link-479" class="py-name" targets="Function epydoc.docbuilder.merge_fset()=epydoc.docbuilder-module.html#merge_fset"><a title="epydoc.docbuilder.merge_fset" class="py-name" href="#" onclick="return doclink('link-479', 'merge_fset', 'link-479');">merge_fset</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"><tt id="link-480" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-480', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'fdel'</tt><tt class="py-op">,</tt> <tt id="link-481" class="py-name" targets="Function epydoc.docbuilder.merge_fdel()=epydoc.docbuilder-module.html#merge_fdel"><a title="epydoc.docbuilder.merge_fdel" class="py-name" href="#" onclick="return doclink('link-481', 'merge_fdel', 'link-481');">merge_fdel</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"><tt id="link-482" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-482', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'proxy_for'</tt><tt class="py-op">,</tt> <tt id="link-483" class="py-name" targets="Function epydoc.docbuilder.merge_proxy_for()=epydoc.docbuilder-module.html#merge_proxy_for"><a title="epydoc.docbuilder.merge_proxy_for" class="py-name" href="#" onclick="return doclink('link-483', 'merge_proxy_for', 'link-483');">merge_proxy_for</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"><tt id="link-484" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-484', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'bases'</tt><tt class="py-op">,</tt> <tt id="link-485" class="py-name" targets="Function epydoc.docbuilder.merge_bases()=epydoc.docbuilder-module.html#merge_bases"><a title="epydoc.docbuilder.merge_bases" class="py-name" href="#" onclick="return doclink('link-485', 'merge_bases', 'link-485');">merge_bases</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"><tt id="link-486" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-486', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'posarg_defaults'</tt><tt class="py-op">,</tt> <tt id="link-487" class="py-name" targets="Function epydoc.docbuilder.merge_posarg_defaults()=epydoc.docbuilder-module.html#merge_posarg_defaults"><a title="epydoc.docbuilder.merge_posarg_defaults" class="py-name" href="#" onclick="return doclink('link-487', 'merge_posarg_defaults', 'link-487');">merge_posarg_defaults</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"><tt id="link-488" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-488', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'docstring'</tt><tt class="py-op">,</tt> <tt id="link-489" class="py-name" targets="Function epydoc.docbuilder.merge_docstring()=epydoc.docbuilder-module.html#merge_docstring"><a title="epydoc.docbuilder.merge_docstring" class="py-name" href="#" onclick="return doclink('link-489', 'merge_docstring', 'link-489');">merge_docstring</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"><tt id="link-490" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-490', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'docs_extracted_by'</tt><tt class="py-op">,</tt> <tt id="link-491" class="py-name" targets="Function epydoc.docbuilder.merge_docs_extracted_by()=epydoc.docbuilder-module.html#merge_docs_extracted_by"><a title="epydoc.docbuilder.merge_docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-491', 'merge_docs_extracted_by', 'link-491');">merge_docs_extracted_by</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"><tt id="link-492" class="py-name"><a title="epydoc.docbuilder.register_attribute_mergefunc" class="py-name" href="#" onclick="return doclink('link-492', 'register_attribute_mergefunc', 'link-470');">register_attribute_mergefunc</a></tt><tt class="py-op">(</tt><tt class="py-string">'submodules'</tt><tt class="py-op">,</tt> <tt id="link-493" class="py-name" targets="Function epydoc.docbuilder.merge_submodules()=epydoc.docbuilder-module.html#merge_submodules"><a title="epydoc.docbuilder.merge_submodules" class="py-name" href="#" onclick="return doclink('link-493', 'merge_submodules', 'link-493');">merge_submodules</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"> </tt>
<a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Import Linking</tt> </tt>
<a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="link_imports"></a><div id="link_imports-def"><a name="L1056"></a><tt class="py-lineno">1056</tt> <a class="py-toggle" href="#" id="link_imports-toggle" onclick="return toggle('link_imports');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#link_imports">link_imports</a><tt class="py-op">(</tt><tt class="py-param">val_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="link_imports-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="link_imports-expanded"><a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"> <tt class="py-comment"># Check if the ValueDoc has an unresolved proxy_for link.</tt> </tt>
<a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># If so, then resolve it.</tt> </tt>
<a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">while</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-494" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.proxy_for=epydoc.apidoc.ValueDoc-class.html#proxy_for"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-494', 'proxy_for', 'link-494');">proxy_for</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-495" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-495', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"> <tt class="py-comment"># Find the valuedoc that the proxy_for name points to.</tt> </tt>
<a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">src_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-496" class="py-name" targets="Method epydoc.apidoc.DocIndex.get_valdoc()=epydoc.apidoc.DocIndex-class.html#get_valdoc"><a title="epydoc.apidoc.DocIndex.get_valdoc" class="py-name" href="#" onclick="return doclink('link-496', 'get_valdoc', 'link-496');">get_valdoc</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-497" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-497', 'proxy_for', 'link-494');">proxy_for</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"> </tt>
<a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> <tt class="py-comment"># If we don't have any valuedoc at that address, then</tt> </tt>
<a name="L1064"></a><tt class="py-lineno">1064</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># set that address as its canonical name.</tt> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># [XXX] Do I really want to do this?</tt> </tt>
<a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">src_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-498" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-498', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-499" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-499', 'proxy_for', 'link-494');">proxy_for</a></tt> </tt>
<a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"> <tt class="py-comment"># If we *do* have something at that address, then</tt> </tt>
<a name="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># merge the proxy `val_doc` with it.</tt> </tt>
<a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">src_doc</tt> <tt class="py-op">!=</tt> <tt class="py-name">val_doc</tt><tt class="py-op">:</tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"> <tt class="py-comment"># Copy any subclass information from val_doc->src_doc.</tt> </tt>
<a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-500" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-500', 'ClassDoc', 'link-85');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">src_doc</tt><tt class="py-op">,</tt> <tt id="link-501" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-501', 'ClassDoc', 'link-85');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">subclass</tt> <tt class="py-keyword">in</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-502" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-502', 'subclasses', 'link-64');">subclasses</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">subclass</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">src_doc</tt><tt class="py-op">.</tt><tt id="link-503" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-503', 'subclasses', 'link-64');">subclasses</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"> <tt class="py-name">src_doc</tt><tt class="py-op">.</tt><tt id="link-504" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-504', 'subclasses', 'link-64');">subclasses</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">subclass</tt><tt class="py-op">)</tt> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"> <tt class="py-comment"># Then overwrite val_doc with the contents of src_doc.</tt> </tt>
<a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">src_doc</tt><tt class="py-op">.</tt><tt id="link-505" class="py-name"><a title="epydoc.apidoc.APIDoc.merge_and_overwrite" class="py-name" href="#" onclick="return doclink('link-505', 'merge_and_overwrite', 'link-392');">merge_and_overwrite</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">ignore_hash_conflict</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"> </tt>
<a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"> <tt class="py-comment"># If the proxy_for link points back at src_doc</tt> </tt>
<a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># itself, then we most likely have a variable that's</tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># shadowing a submodule that it should be equal to.</tt> </tt>
<a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># So just get rid of the variable.</tt> </tt>
<a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">src_doc</tt> <tt class="py-op">==</tt> <tt class="py-name">val_doc</tt><tt class="py-op">:</tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"> <tt class="py-name">parent_name</tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-506" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-506', 'proxy_for', 'link-494');">proxy_for</a></tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"> <tt class="py-name">var_name</tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-507" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-507', 'proxy_for', 'link-494');">proxy_for</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> <tt class="py-name">parent</tt> <tt class="py-op">=</tt> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-508" class="py-name"><a title="epydoc.apidoc.DocIndex.get_valdoc" class="py-name" href="#" onclick="return doclink('link-508', 'get_valdoc', 'link-496');">get_valdoc</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_name</tt><tt class="py-op">)</tt> </tt>
<a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parent</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">var_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parent</tt><tt class="py-op">.</tt><tt id="link-509" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-509', 'variables', 'link-103');">variables</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">parent</tt><tt class="py-op">.</tt><tt id="link-510" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-510', 'variables', 'link-103');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">var_name</tt><tt class="py-op">]</tt> </tt>
<a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-name">src_doc</tt><tt class="py-op">.</tt><tt id="link-511" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-511', 'proxy_for', 'link-494');">proxy_for</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"> </tt>
<a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Canonical Name Assignment</tt> </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"><tt id="link-512" class="py-name" targets="Variable epydoc.docbuilder._name_scores=epydoc.docbuilder-module.html#_name_scores"><a title="epydoc.docbuilder._name_scores" class="py-name" href="#" onclick="return doclink('link-512', '_name_scores', 'link-512');">_name_scores</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1099"></a><tt class="py-lineno">1099</tt> <tt class="py-line"><tt class="py-string">"""A dictionary mapping from each C{ValueDoc} to the score that has</tt> </tt>
<a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"><tt class="py-string">been assigned to its current cannonical name. If</tt> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"><tt class="py-string">L{assign_canonical_names()} finds a canonical name with a better</tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"><tt class="py-string">score, then it will replace the old name."""</tt> </tt>
<a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"> </tt>
<a name="L1104"></a><tt class="py-lineno">1104</tt> <tt class="py-line"><tt id="link-513" class="py-name" targets="Variable epydoc.docbuilder._unreachable_names=epydoc.docbuilder-module.html#_unreachable_names"><a title="epydoc.docbuilder._unreachable_names" class="py-name" href="#" onclick="return doclink('link-513', '_unreachable_names', 'link-513');">_unreachable_names</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt id="link-514" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-514', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-515" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-515', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-516" class="py-name"><a title="epydoc.apidoc.DottedName.UNREACHABLE" class="py-name" href="#" onclick="return doclink('link-516', 'UNREACHABLE', 'link-203');">UNREACHABLE</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt><tt class="py-number">1</tt><tt class="py-op">}</tt> </tt>
<a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"><tt class="py-string">"""The set of names that have been used for unreachable objects. This</tt> </tt>
<a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"><tt class="py-string">is used to ensure there are no duplicate cannonical names assigned.</tt> </tt>
<a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"><tt class="py-string">C{_unreachable_names} is a dictionary mapping from dotted names to</tt> </tt>
<a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"><tt class="py-string">integer ids, where the next unused unreachable name derived from</tt> </tt>
<a name="L1109"></a><tt class="py-lineno">1109</tt> <tt class="py-line"><tt class="py-string">dotted name C{n} is</tt> </tt>
<a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"><tt class="py-string">C{DottedName('%s-%s' % (n, str(_unreachable_names[n]+1))}"""</tt> </tt>
<a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"> </tt>
<a name="assign_canonical_names"></a><div id="assign_canonical_names-def"><a name="L1112"></a><tt class="py-lineno">1112</tt> <a class="py-toggle" href="#" id="assign_canonical_names-toggle" onclick="return toggle('assign_canonical_names');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#assign_canonical_names">assign_canonical_names</a><tt class="py-op">(</tt><tt class="py-param">val_doc</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">score</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="assign_canonical_names-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="assign_canonical_names-expanded"><a name="L1113"></a><tt class="py-lineno">1113</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1114"></a><tt class="py-lineno">1114</tt> <tt class="py-line"><tt class="py-docstring"> Assign a canonical name to C{val_doc} (if it doesn't have one</tt> </tt>
<a name="L1115"></a><tt class="py-lineno">1115</tt> <tt class="py-line"><tt class="py-docstring"> already), and (recursively) to each variable in C{val_doc}.</tt> </tt>
<a name="L1116"></a><tt class="py-lineno">1116</tt> <tt class="py-line"><tt class="py-docstring"> In particular, C{val_doc} will be assigned the canonical name</tt> </tt>
<a name="L1117"></a><tt class="py-lineno">1117</tt> <tt class="py-line"><tt class="py-docstring"> C{name} iff either:</tt> </tt>
<a name="L1118"></a><tt class="py-lineno">1118</tt> <tt class="py-line"><tt class="py-docstring"> - C{val_doc}'s canonical name is C{UNKNOWN}; or</tt> </tt>
<a name="L1119"></a><tt class="py-lineno">1119</tt> <tt class="py-line"><tt class="py-docstring"> - C{val_doc}'s current canonical name was assigned by this</tt> </tt>
<a name="L1120"></a><tt class="py-lineno">1120</tt> <tt class="py-line"><tt class="py-docstring"> method; but the score of the new name (C{score}) is higher</tt> </tt>
<a name="L1121"></a><tt class="py-lineno">1121</tt> <tt class="py-line"><tt class="py-docstring"> than the score of the current name (C{score_dict[val_doc]}).</tt> </tt>
<a name="L1122"></a><tt class="py-lineno">1122</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"><tt class="py-docstring"> Note that canonical names will even be assigned to values</tt> </tt>
<a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"><tt class="py-docstring"> like integers and C{None}; but these should be harmless.</tt> </tt>
<a name="L1125"></a><tt class="py-lineno">1125</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"> <tt class="py-comment"># If we've already visited this node, and our new score</tt> </tt>
<a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># doesn't beat our old score, then there's nothing more to do.</tt> </tt>
<a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Note that since score increases strictly monotonically, this</tt> </tt>
<a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># also prevents us from going in cycles.</tt> </tt>
<a name="L1130"></a><tt class="py-lineno">1130</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt id="link-517" class="py-name"><a title="epydoc.docbuilder._name_scores" class="py-name" href="#" onclick="return doclink('link-517', '_name_scores', 'link-512');">_name_scores</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">score</tt> <tt class="py-op"><=</tt> <tt id="link-518" class="py-name"><a title="epydoc.docbuilder._name_scores" class="py-name" href="#" onclick="return doclink('link-518', '_name_scores', 'link-512');">_name_scores</a></tt><tt class="py-op">[</tt><tt class="py-name">val_doc</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1132"></a><tt class="py-lineno">1132</tt> <tt class="py-line"> </tt>
<a name="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"> <tt class="py-comment"># Update val_doc's canonical name, if appropriate.</tt> </tt>
<a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">val_doc</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-519" class="py-name"><a title="epydoc.docbuilder._name_scores" class="py-name" href="#" onclick="return doclink('link-519', '_name_scores', 'link-512');">_name_scores</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-520" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-520', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-521" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-521', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"> <tt class="py-comment"># If this is the first time we've seen val_doc, and it</tt> </tt>
<a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># already has a name, then don't change that name.</tt> </tt>
<a name="L1138"></a><tt class="py-lineno">1138</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-522" class="py-name"><a title="epydoc.docbuilder._name_scores" class="py-name" href="#" onclick="return doclink('link-522', '_name_scores', 'link-512');">_name_scores</a></tt><tt class="py-op">[</tt><tt class="py-name">val_doc</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">maxint</tt> </tt>
<a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"> <tt id="link-523" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-523', 'name', 'link-24');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-524" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-524', 'canonical_name', 'link-42');">canonical_name</a></tt> </tt>
<a name="L1140"></a><tt class="py-lineno">1140</tt> <tt class="py-line"> <tt class="py-name">score</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, update the name iff the new score is better</tt> </tt>
<a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># than the old one.</tt> </tt>
<a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">val_doc</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-525" class="py-name"><a title="epydoc.docbuilder._name_scores" class="py-name" href="#" onclick="return doclink('link-525', '_name_scores', 'link-512');">_name_scores</a></tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"> <tt class="py-name">score</tt> <tt class="py-op">></tt> <tt id="link-526" class="py-name"><a title="epydoc.docbuilder._name_scores" class="py-name" href="#" onclick="return doclink('link-526', '_name_scores', 'link-512');">_name_scores</a></tt><tt class="py-op">[</tt><tt class="py-name">val_doc</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1146"></a><tt class="py-lineno">1146</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-527" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-527', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-528" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-528', 'name', 'link-24');">name</a></tt> </tt>
<a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"> <tt id="link-529" class="py-name"><a title="epydoc.docbuilder._name_scores" class="py-name" href="#" onclick="return doclink('link-529', '_name_scores', 'link-512');">_name_scores</a></tt><tt class="py-op">[</tt><tt class="py-name">val_doc</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">score</tt> </tt>
<a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"> </tt>
<a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"> <tt class="py-comment"># Recurse to any contained values.</tt> </tt>
<a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-530" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-530', 'NamespaceDoc', 'link-102');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-531" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-531', 'variables', 'link-103');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"> <tt class="py-comment"># Set the variable's canonical name.</tt> </tt>
<a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">varname</tt> <tt class="py-op">=</tt> <tt id="link-532" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-532', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-533" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-533', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-534" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-534', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-535" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-535', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">varname</tt> </tt>
<a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"> </tt>
<a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"> <tt class="py-comment"># If the value is unknown, or is a generic value doc, then</tt> </tt>
<a name="L1157"></a><tt class="py-lineno">1157</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the valuedoc doesn't get assigned a name; move on.</tt> </tt>
<a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-536" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-536', 'value', 'link-106');">value</a></tt> <tt class="py-keyword">is</tt> <tt id="link-537" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-537', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> </tt>
<a name="L1159"></a><tt class="py-lineno">1159</tt> <tt class="py-line"> <tt class="py-keyword">or</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-538" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-538', 'value', 'link-106');">value</a></tt><tt class="py-op">,</tt> <tt id="link-539" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-539', 'GenericValueDoc', 'link-360');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L1161"></a><tt class="py-lineno">1161</tt> <tt class="py-line"> </tt>
<a name="L1162"></a><tt class="py-lineno">1162</tt> <tt class="py-line"> <tt class="py-comment"># [XX] After svn commit 1644-1647, I'm not sure if this</tt> </tt>
<a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># ever gets used: This check is for cases like</tt> </tt>
<a name="L1164"></a><tt class="py-lineno">1164</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># curses.wrapper, where an imported variable shadows its</tt> </tt>
<a name="L1165"></a><tt class="py-lineno">1165</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># value's "real" location.</tt> </tt>
<a name="L1166"></a><tt class="py-lineno">1166</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-540" class="py-name" targets="Function epydoc.docbuilder._var_shadows_self()=epydoc.docbuilder-module.html#_var_shadows_self"><a title="epydoc.docbuilder._var_shadows_self" class="py-name" href="#" onclick="return doclink('link-540', '_var_shadows_self', 'link-540');">_var_shadows_self</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">varname</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> <tt id="link-541" class="py-name" targets="Function epydoc.docbuilder._fix_self_shadowing_var()=epydoc.docbuilder-module.html#_fix_self_shadowing_var"><a title="epydoc.docbuilder._fix_self_shadowing_var" class="py-name" href="#" onclick="return doclink('link-541', '_fix_self_shadowing_var', 'link-541');">_fix_self_shadowing_var</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">varname</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">)</tt> </tt>
<a name="L1168"></a><tt class="py-lineno">1168</tt> <tt class="py-line"> </tt>
<a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"> <tt class="py-comment"># Find the score for this new name. </tt> </tt>
<a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">vardoc_score</tt> <tt class="py-op">=</tt> <tt class="py-name">score</tt><tt class="py-op">-</tt><tt class="py-number">1</tt> </tt>
<a name="L1171"></a><tt class="py-lineno">1171</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-542" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_imported=epydoc.apidoc.VariableDoc-class.html#is_imported"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-542', 'is_imported', 'link-542');">is_imported</a></tt> <tt class="py-keyword">is</tt> <tt id="link-543" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-543', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-name">vardoc_score</tt> <tt class="py-op">-=</tt> <tt class="py-number">10</tt> </tt>
<a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-544" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-544', 'is_imported', 'link-542');">is_imported</a></tt><tt class="py-op">:</tt> <tt class="py-name">vardoc_score</tt> <tt class="py-op">-=</tt> <tt class="py-number">100</tt> </tt>
<a name="L1173"></a><tt class="py-lineno">1173</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-545" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_alias=epydoc.apidoc.VariableDoc-class.html#is_alias"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-545', 'is_alias', 'link-545');">is_alias</a></tt> <tt class="py-keyword">is</tt> <tt id="link-546" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-546', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-name">vardoc_score</tt> <tt class="py-op">-=</tt> <tt class="py-number">10</tt> </tt>
<a name="L1174"></a><tt class="py-lineno">1174</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-547" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-547', 'is_alias', 'link-545');">is_alias</a></tt><tt class="py-op">:</tt> <tt class="py-name">vardoc_score</tt> <tt class="py-op">-=</tt> <tt class="py-number">1000</tt> </tt>
<a name="L1175"></a><tt class="py-lineno">1175</tt> <tt class="py-line"> </tt>
<a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"> <tt id="link-548" class="py-name"><a title="epydoc.docbuilder.assign_canonical_names" class="py-name" href="#" onclick="return doclink('link-548', 'assign_canonical_names', 'link-74');">assign_canonical_names</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-549" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-549', 'value', 'link-106');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">varname</tt><tt class="py-op">,</tt> </tt>
<a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">vardoc_score</tt><tt class="py-op">)</tt> </tt>
<a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"> </tt>
<a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"> <tt class="py-comment"># Recurse to any directly reachable values.</tt> </tt>
<a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">val_doc_2</tt> <tt class="py-keyword">in</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-550" class="py-name" targets="Method epydoc.apidoc.APIDoc.apidoc_links()=epydoc.apidoc.APIDoc-class.html#apidoc_links,Method epydoc.apidoc.ClassDoc.apidoc_links()=epydoc.apidoc.ClassDoc-class.html#apidoc_links,Method epydoc.apidoc.ModuleDoc.apidoc_links()=epydoc.apidoc.ModuleDoc-class.html#apidoc_links,Method epydoc.apidoc.NamespaceDoc.apidoc_links()=epydoc.apidoc.NamespaceDoc-class.html#apidoc_links,Method epydoc.apidoc.PropertyDoc.apidoc_links()=epydoc.apidoc.PropertyDoc-class.html#apidoc_links,Method epydoc.apidoc.ValueDoc.apidoc_links()=epydoc.apidoc.ValueDoc-class.html#apidoc_links,Method epydoc.apidoc.VariableDoc.apidoc_links()=epydoc.apidoc.VariableDoc-class.html#apidoc_links"><a title="epydoc.apidoc.APIDoc.apidoc_links
epydoc.apidoc.ClassDoc.apidoc_links
epydoc.apidoc.ModuleDoc.apidoc_links
epydoc.apidoc.NamespaceDoc.apidoc_links
epydoc.apidoc.PropertyDoc.apidoc_links
epydoc.apidoc.ValueDoc.apidoc_links
epydoc.apidoc.VariableDoc.apidoc_links" class="py-name" href="#" onclick="return doclink('link-550', 'apidoc_links', 'link-550');">apidoc_links</a></tt><tt class="py-op">(</tt><tt id="link-551" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-551', 'variables', 'link-103');">variables</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1181"></a><tt class="py-lineno">1181</tt> <tt class="py-line"> <tt class="py-name">val_name</tt><tt class="py-op">,</tt> <tt class="py-name">val_score</tt> <tt class="py-op">=</tt> <tt id="link-552" class="py-name" targets="Function epydoc.docbuilder._unreachable_name_for()=epydoc.docbuilder-module.html#_unreachable_name_for"><a title="epydoc.docbuilder._unreachable_name_for" class="py-name" href="#" onclick="return doclink('link-552', '_unreachable_name_for', 'link-552');">_unreachable_name_for</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc_2</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">)</tt> </tt>
<a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"> <tt id="link-553" class="py-name"><a title="epydoc.docbuilder.assign_canonical_names" class="py-name" href="#" onclick="return doclink('link-553', 'assign_canonical_names', 'link-74');">assign_canonical_names</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc_2</tt><tt class="py-op">,</tt> <tt class="py-name">val_name</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">val_score</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"> </tt>
<a name="_var_shadows_self"></a><div id="_var_shadows_self-def"><a name="L1184"></a><tt class="py-lineno">1184</tt> <a class="py-toggle" href="#" id="_var_shadows_self-toggle" onclick="return toggle('_var_shadows_self');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_var_shadows_self">_var_shadows_self</a><tt class="py-op">(</tt><tt class="py-param">var_doc</tt><tt class="py-op">,</tt> <tt class="py-param">varname</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_var_shadows_self-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_var_shadows_self-expanded"><a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-554" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-554', 'value', 'link-106');">value</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-555" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-555', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-556" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-556', 'value', 'link-106');">value</a></tt><tt class="py-op">.</tt><tt id="link-557" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-557', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-558" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-558', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1187"></a><tt class="py-lineno">1187</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-559" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-559', 'value', 'link-106');">value</a></tt><tt class="py-op">.</tt><tt id="link-560" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-560', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">varname</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1188"></a><tt class="py-lineno">1188</tt> <tt class="py-line"> <tt class="py-name">varname</tt><tt class="py-op">.</tt><tt id="link-561" class="py-name" targets="Method epydoc.apidoc.DottedName.dominates()=epydoc.apidoc.DottedName-class.html#dominates"><a title="epydoc.apidoc.DottedName.dominates" class="py-name" href="#" onclick="return doclink('link-561', 'dominates', 'link-561');">dominates</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-562" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-562', 'value', 'link-106');">value</a></tt><tt class="py-op">.</tt><tt id="link-563" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-563', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1189"></a><tt class="py-lineno">1189</tt> <tt class="py-line"> </tt>
<a name="_fix_self_shadowing_var"></a><div id="_fix_self_shadowing_var-def"><a name="L1190"></a><tt class="py-lineno">1190</tt> <a class="py-toggle" href="#" id="_fix_self_shadowing_var-toggle" onclick="return toggle('_fix_self_shadowing_var');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_fix_self_shadowing_var">_fix_self_shadowing_var</a><tt class="py-op">(</tt><tt class="py-param">var_doc</tt><tt class="py-op">,</tt> <tt class="py-param">varname</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_fix_self_shadowing_var-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_fix_self_shadowing_var-expanded"><a name="L1191"></a><tt class="py-lineno">1191</tt> <tt class="py-line"> <tt class="py-comment"># If possible, find another name for the shadowed value.</tt> </tt>
<a name="L1192"></a><tt class="py-lineno">1192</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">cname</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-564" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-564', 'value', 'link-106');">value</a></tt><tt class="py-op">.</tt><tt id="link-565" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-565', 'canonical_name', 'link-42');">canonical_name</a></tt> </tt>
<a name="L1193"></a><tt class="py-lineno">1193</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">cname</tt><tt class="py-op">)</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1194"></a><tt class="py-lineno">1194</tt> <tt class="py-line"> <tt class="py-name">new_name</tt> <tt class="py-op">=</tt> <tt class="py-name">cname</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-op">(</tt><tt class="py-name">cname</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt class="py-string">"'"</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">cname</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1195"></a><tt class="py-lineno">1195</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-566" class="py-name"><a title="epydoc.apidoc.DocIndex.get_valdoc" class="py-name" href="#" onclick="return doclink('link-566', 'get_valdoc', 'link-496');">get_valdoc</a></tt><tt class="py-op">(</tt><tt class="py-name">new_name</tt><tt class="py-op">)</tt> </tt>
<a name="L1196"></a><tt class="py-lineno">1196</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1197"></a><tt class="py-lineno">1197</tt> <tt class="py-line"> <tt id="link-567" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-567', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-568" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-568', 'warning', 'link-151');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s shadows its own value -- using %s instead"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1198"></a><tt class="py-lineno">1198</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">varname</tt><tt class="py-op">,</tt> <tt class="py-name">new_name</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1199"></a><tt class="py-lineno">1199</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-569" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-569', 'value', 'link-106');">value</a></tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt> </tt>
<a name="L1200"></a><tt class="py-lineno">1200</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1201"></a><tt class="py-lineno">1201</tt> <tt class="py-line"> </tt>
<a name="L1202"></a><tt class="py-lineno">1202</tt> <tt class="py-line"> <tt class="py-comment"># If we couldn't find the actual value, use an unreachable name.</tt> </tt>
<a name="L1203"></a><tt class="py-lineno">1203</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-570" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-570', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">score</tt> <tt class="py-op">=</tt> <tt id="link-571" class="py-name"><a title="epydoc.docbuilder._unreachable_name_for" class="py-name" href="#" onclick="return doclink('link-571', '_unreachable_name_for', 'link-552');">_unreachable_name_for</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-572" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-572', 'value', 'link-106');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">)</tt> </tt>
<a name="L1204"></a><tt class="py-lineno">1204</tt> <tt class="py-line"> <tt id="link-573" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-573', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-574" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-574', 'warning', 'link-151');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s shadows itself -- using %s instead'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">varname</tt><tt class="py-op">,</tt> <tt id="link-575" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-575', 'name', 'link-24');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1205"></a><tt class="py-lineno">1205</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-576" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-576', 'value', 'link-106');">value</a></tt><tt class="py-op">.</tt><tt id="link-577" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-577', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-578" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-578', 'name', 'link-24');">name</a></tt> </tt>
</div><a name="L1206"></a><tt class="py-lineno">1206</tt> <tt class="py-line"> </tt>
<a name="_unreachable_name_for"></a><div id="_unreachable_name_for-def"><a name="L1207"></a><tt class="py-lineno">1207</tt> <a class="py-toggle" href="#" id="_unreachable_name_for-toggle" onclick="return toggle('_unreachable_name_for');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_unreachable_name_for">_unreachable_name_for</a><tt class="py-op">(</tt><tt class="py-param">val_doc</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_unreachable_name_for-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_unreachable_name_for-expanded"><a name="L1208"></a><tt class="py-lineno">1208</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-579" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-579', 'ValueDoc', 'link-107');">ValueDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1209"></a><tt class="py-lineno">1209</tt> <tt class="py-line"> </tt>
<a name="L1210"></a><tt class="py-lineno">1210</tt> <tt class="py-line"> <tt class="py-comment"># [xx] (when) does this help?</tt> </tt>
<a name="L1211"></a><tt class="py-lineno">1211</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-580" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-580', 'ModuleDoc', 'link-134');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1212"></a><tt class="py-lineno">1212</tt> <tt class="py-line"> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-581" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-581', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-number">1</tt> <tt class="py-keyword">and</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-582" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.package=epydoc.apidoc.ModuleDoc-class.html#package"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-582', 'package', 'link-582');">package</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1213"></a><tt class="py-lineno">1213</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">root_val</tt> <tt class="py-keyword">in</tt> <tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">:</tt> </tt>
<a name="L1214"></a><tt class="py-lineno">1214</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">root_val</tt><tt class="py-op">.</tt><tt id="link-583" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-583', 'canonical_name', 'link-42');">canonical_name</a></tt> <tt class="py-op">==</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-584" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-584', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1215"></a><tt class="py-lineno">1215</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">root_val</tt> <tt class="py-op">!=</tt> <tt class="py-name">val_doc</tt><tt class="py-op">:</tt> </tt>
<a name="L1216"></a><tt class="py-lineno">1216</tt> <tt class="py-line"> <tt id="link-585" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-585', 'log', 'link-14');">log</a></tt><tt class="py-op">.</tt><tt id="link-586" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-586', 'error', 'link-22');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">"Name conflict: %r vs %r"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1217"></a><tt class="py-lineno">1217</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">root_val</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1218"></a><tt class="py-lineno">1218</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L1219"></a><tt class="py-lineno">1219</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1220"></a><tt class="py-lineno">1220</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-587" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-587', 'canonical_name', 'link-42');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-op">-</tt><tt class="py-number">1000</tt> </tt>
<a name="L1221"></a><tt class="py-lineno">1221</tt> <tt class="py-line"> </tt>
<a name="L1222"></a><tt class="py-lineno">1222</tt> <tt class="py-line"> <tt class="py-comment"># Assign it an 'unreachable' name:</tt> </tt>
<a name="L1223"></a><tt class="py-lineno">1223</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-588" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-588', 'pyval', 'link-368');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-589" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-589', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1224"></a><tt class="py-lineno">1224</tt> <tt class="py-line"> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-590" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-590', 'pyval', 'link-368');">pyval</a></tt><tt class="py-op">,</tt> <tt class="py-string">'__name__'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1225"></a><tt class="py-lineno">1225</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1226"></a><tt class="py-lineno">1226</tt> <tt class="py-line"> <tt id="link-591" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-591', 'name', 'link-24');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-592" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-592', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-593" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-593', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-594" class="py-name"><a title="epydoc.apidoc.DottedName.UNREACHABLE" class="py-name" href="#" onclick="return doclink('link-594', 'UNREACHABLE', 'link-203');">UNREACHABLE</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1227"></a><tt class="py-lineno">1227</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-595" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-595', 'pyval', 'link-368');">pyval</a></tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> <tt class="py-name">strict</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1228"></a><tt class="py-lineno">1228</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-596" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-596', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-597" class="py-name" targets="Class epydoc.apidoc.DottedName.InvalidDottedName=epydoc.apidoc.DottedName.InvalidDottedName-class.html"><a title="epydoc.apidoc.DottedName.InvalidDottedName" class="py-name" href="#" onclick="return doclink('link-597', 'InvalidDottedName', 'link-597');">InvalidDottedName</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1229"></a><tt class="py-lineno">1229</tt> <tt class="py-line"> <tt id="link-598" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-598', 'name', 'link-24');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-599" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-599', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-600" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-600', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-601" class="py-name"><a title="epydoc.apidoc.DottedName.UNREACHABLE" class="py-name" href="#" onclick="return doclink('link-601', 'UNREACHABLE', 'link-203');">UNREACHABLE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1230"></a><tt class="py-lineno">1230</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1231"></a><tt class="py-lineno">1231</tt> <tt class="py-line"> <tt id="link-602" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-602', 'name', 'link-24');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-603" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-603', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-604" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-604', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-605" class="py-name"><a title="epydoc.apidoc.DottedName.UNREACHABLE" class="py-name" href="#" onclick="return doclink('link-605', 'UNREACHABLE', 'link-203');">UNREACHABLE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1232"></a><tt class="py-lineno">1232</tt> <tt class="py-line"> </tt>
<a name="L1233"></a><tt class="py-lineno">1233</tt> <tt class="py-line"> <tt class="py-comment"># Uniquify the name.</tt> </tt>
<a name="L1234"></a><tt class="py-lineno">1234</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-606" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-606', 'name', 'link-24');">name</a></tt> <tt class="py-keyword">in</tt> <tt id="link-607" class="py-name"><a title="epydoc.docbuilder._unreachable_names" class="py-name" href="#" onclick="return doclink('link-607', '_unreachable_names', 'link-513');">_unreachable_names</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1235"></a><tt class="py-lineno">1235</tt> <tt class="py-line"> <tt id="link-608" class="py-name"><a title="epydoc.docbuilder._unreachable_names" class="py-name" href="#" onclick="return doclink('link-608', '_unreachable_names', 'link-513');">_unreachable_names</a></tt><tt class="py-op">[</tt><tt id="link-609" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-609', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1236"></a><tt class="py-lineno">1236</tt> <tt class="py-line"> <tt id="link-610" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-610', 'name', 'link-24');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-611" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-611', 'DottedName', 'link-29');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s-%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-612" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-612', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt id="link-613" class="py-name"><a title="epydoc.docbuilder._unreachable_names" class="py-name" href="#" onclick="return doclink('link-613', '_unreachable_names', 'link-513');">_unreachable_names</a></tt><tt class="py-op">[</tt><tt id="link-614" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-614', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1237"></a><tt class="py-lineno">1237</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1238"></a><tt class="py-lineno">1238</tt> <tt class="py-line"> <tt id="link-615" class="py-name"><a title="epydoc.docbuilder._unreachable_names" class="py-name" href="#" onclick="return doclink('link-615', '_unreachable_names', 'link-513');">_unreachable_names</a></tt><tt class="py-op">[</tt><tt id="link-616" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-616', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1239"></a><tt class="py-lineno">1239</tt> <tt class="py-line"> </tt>
<a name="L1240"></a><tt class="py-lineno">1240</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-617" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-617', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt class="py-op">-</tt><tt class="py-number">10000</tt> </tt>
</div><a name="L1241"></a><tt class="py-lineno">1241</tt> <tt class="py-line"> </tt>
<a name="L1242"></a><tt class="py-lineno">1242</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1243"></a><tt class="py-lineno">1243</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Documentation Inheritance</tt> </tt>
<a name="L1244"></a><tt class="py-lineno">1244</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1245"></a><tt class="py-lineno">1245</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="find_overrides"></a><div id="find_overrides-def"><a name="L1246"></a><tt class="py-lineno">1246</tt> <a class="py-toggle" href="#" id="find_overrides-toggle" onclick="return toggle('find_overrides');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#find_overrides">find_overrides</a><tt class="py-op">(</tt><tt class="py-param">class_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="find_overrides-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="find_overrides-expanded"><a name="L1247"></a><tt class="py-lineno">1247</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1248"></a><tt class="py-lineno">1248</tt> <tt class="py-line"><tt class="py-docstring"> Set the C{overrides} attribute for all variables in C{class_doc}.</tt> </tt>
<a name="L1249"></a><tt class="py-lineno">1249</tt> <tt class="py-line"><tt class="py-docstring"> This needs to be done early (before docstring parsing), so we can</tt> </tt>
<a name="L1250"></a><tt class="py-lineno">1250</tt> <tt class="py-line"><tt class="py-docstring"> know which docstrings to suppress warnings for.</tt> </tt>
<a name="L1251"></a><tt class="py-lineno">1251</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1252"></a><tt class="py-lineno">1252</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base_class</tt> <tt class="py-keyword">in</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-618" class="py-name" targets="Method epydoc.apidoc.ClassDoc.mro()=epydoc.apidoc.ClassDoc-class.html#mro"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-618', 'mro', 'link-618');">mro</a></tt><tt class="py-op">(</tt><tt class="py-name">warn_about_bad_bases</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1253"></a><tt class="py-lineno">1253</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base_class</tt> <tt class="py-op">==</tt> <tt class="py-name">class_doc</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L1254"></a><tt class="py-lineno">1254</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base_class</tt><tt class="py-op">.</tt><tt id="link-619" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-619', 'variables', 'link-103');">variables</a></tt> <tt class="py-keyword">is</tt> <tt id="link-620" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-620', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L1255"></a><tt class="py-lineno">1255</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-621" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-621', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">base_class</tt><tt class="py-op">.</tt><tt id="link-622" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-622', 'variables', 'link-103');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1256"></a><tt class="py-lineno">1256</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt id="link-623" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-623', 'name', 'link-24');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'__'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-624" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-624', 'name', 'link-24');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'__'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1257"></a><tt class="py-lineno">1257</tt> <tt class="py-line"> <tt class="py-name">base_class</tt> <tt class="py-op">==</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-625" class="py-name" targets="Method epydoc.apidoc.DocIndex.container()=epydoc.apidoc.DocIndex-class.html#container,Method epydoc.apidoc.DottedName.container()=epydoc.apidoc.DottedName-class.html#container,Variable epydoc.apidoc.VariableDoc.container=epydoc.apidoc.VariableDoc-class.html#container"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-625', 'container', 'link-625');">container</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1258"></a><tt class="py-lineno">1258</tt> <tt class="py-line"> <tt id="link-626" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-626', 'name', 'link-24');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-627" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-627', 'variables', 'link-103');">variables</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1259"></a><tt class="py-lineno">1259</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-628" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-628', 'variables', 'link-103');">variables</a></tt><tt class="py-op">[</tt><tt id="link-629" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-629', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-630" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-630', 'container', 'link-625');">container</a></tt><tt class="py-op">==</tt><tt class="py-name">class_doc</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1260"></a><tt class="py-lineno">1260</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-631" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-631', 'variables', 'link-103');">variables</a></tt><tt class="py-op">[</tt><tt id="link-632" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-632', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-633" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-633', 'overrides', 'link-99');">overrides</a></tt> <tt class="py-keyword">is</tt> <tt id="link-634" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-634', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt> <tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1261"></a><tt class="py-lineno">1261</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-635" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-635', 'variables', 'link-103');">variables</a></tt><tt class="py-op">[</tt><tt id="link-636" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-636', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-637" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-637', 'overrides', 'link-99');">overrides</a></tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt> </tt>
</div><a name="L1262"></a><tt class="py-lineno">1262</tt> <tt class="py-line"> </tt>
<a name="L1263"></a><tt class="py-lineno">1263</tt> <tt class="py-line"> </tt>
<a name="inherit_docs"></a><div id="inherit_docs-def"><a name="L1264"></a><tt class="py-lineno">1264</tt> <a class="py-toggle" href="#" id="inherit_docs-toggle" onclick="return toggle('inherit_docs');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#inherit_docs">inherit_docs</a><tt class="py-op">(</tt><tt class="py-param">class_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="inherit_docs-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="inherit_docs-expanded"><a name="L1265"></a><tt class="py-lineno">1265</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base_class</tt> <tt class="py-keyword">in</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-638" class="py-name"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-638', 'mro', 'link-618');">mro</a></tt><tt class="py-op">(</tt><tt class="py-name">warn_about_bad_bases</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1266"></a><tt class="py-lineno">1266</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base_class</tt> <tt class="py-op">==</tt> <tt class="py-name">class_doc</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L1267"></a><tt class="py-lineno">1267</tt> <tt class="py-line"> </tt>
<a name="L1268"></a><tt class="py-lineno">1268</tt> <tt class="py-line"> <tt class="py-comment"># Inherit any groups. Place them *after* this class's groups,</tt> </tt>
<a name="L1269"></a><tt class="py-lineno">1269</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># so that any groups that are important to this class come</tt> </tt>
<a name="L1270"></a><tt class="py-lineno">1270</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># first.</tt> </tt>
<a name="L1271"></a><tt class="py-lineno">1271</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">base_class</tt><tt class="py-op">.</tt><tt id="link-639" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.group_specs=epydoc.apidoc.NamespaceDoc-class.html#group_specs"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-639', 'group_specs', 'link-639');">group_specs</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-640" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-640', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1272"></a><tt class="py-lineno">1272</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-641" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-641', 'group_specs', 'link-639');">group_specs</a></tt> <tt class="py-op">+=</tt> <tt class="py-op">[</tt><tt class="py-name">gs</tt> <tt class="py-keyword">for</tt> <tt class="py-name">gs</tt> <tt class="py-keyword">in</tt> <tt class="py-name">base_class</tt><tt class="py-op">.</tt><tt id="link-642" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-642', 'group_specs', 'link-639');">group_specs</a></tt> </tt>
<a name="L1273"></a><tt class="py-lineno">1273</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">gs</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-643" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-643', 'group_specs', 'link-639');">group_specs</a></tt><tt class="py-op">]</tt> </tt>
<a name="L1274"></a><tt class="py-lineno">1274</tt> <tt class="py-line"> </tt>
<a name="L1275"></a><tt class="py-lineno">1275</tt> <tt class="py-line"> <tt class="py-comment"># Inherit any variables.</tt> </tt>
<a name="L1276"></a><tt class="py-lineno">1276</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">base_class</tt><tt class="py-op">.</tt><tt id="link-644" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-644', 'variables', 'link-103');">variables</a></tt> <tt class="py-keyword">is</tt> <tt id="link-645" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-645', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L1277"></a><tt class="py-lineno">1277</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-646" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-646', 'name', 'link-24');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">base_class</tt><tt class="py-op">.</tt><tt id="link-647" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-647', 'variables', 'link-103');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1278"></a><tt class="py-lineno">1278</tt> <tt class="py-line"> <tt class="py-comment"># If it's a __private variable, then don't inherit it.</tt> </tt>
<a name="L1279"></a><tt class="py-lineno">1279</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-648" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-648', 'name', 'link-24');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'__'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-649" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-649', 'name', 'link-24');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1280"></a><tt class="py-lineno">1280</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L1281"></a><tt class="py-lineno">1281</tt> <tt class="py-line"> </tt>
<a name="L1282"></a><tt class="py-lineno">1282</tt> <tt class="py-line"> <tt class="py-comment"># Inhetit only from the defining class. Or else, in case of</tt> </tt>
<a name="L1283"></a><tt class="py-lineno">1283</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># multiple inheritance, we may import from a grand-ancestor</tt> </tt>
<a name="L1284"></a><tt class="py-lineno">1284</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># variables overridden by a class that follows in mro.</tt> </tt>
<a name="L1285"></a><tt class="py-lineno">1285</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">base_class</tt> <tt class="py-op">!=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-650" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-650', 'container', 'link-625');">container</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1286"></a><tt class="py-lineno">1286</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L1287"></a><tt class="py-lineno">1287</tt> <tt class="py-line"> </tt>
<a name="L1288"></a><tt class="py-lineno">1288</tt> <tt class="py-line"> <tt class="py-comment"># If class_doc doesn't have a variable with this name,</tt> </tt>
<a name="L1289"></a><tt class="py-lineno">1289</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># then inherit it.</tt> </tt>
<a name="L1290"></a><tt class="py-lineno">1290</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-651" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-651', 'name', 'link-24');">name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-652" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-652', 'variables', 'link-103');">variables</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1291"></a><tt class="py-lineno">1291</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-653" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-653', 'variables', 'link-103');">variables</a></tt><tt class="py-op">[</tt><tt id="link-654" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-654', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt> </tt>
<a name="L1292"></a><tt class="py-lineno">1292</tt> <tt class="py-line"> </tt>
<a name="L1293"></a><tt class="py-lineno">1293</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, class_doc already contains a variable</tt> </tt>
<a name="L1294"></a><tt class="py-lineno">1294</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># that shadows var_doc. But if class_doc's var is</tt> </tt>
<a name="L1295"></a><tt class="py-lineno">1295</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># local, then record the fact that it overrides</tt> </tt>
<a name="L1296"></a><tt class="py-lineno">1296</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># var_doc.</tt> </tt>
<a name="L1297"></a><tt class="py-lineno">1297</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-655" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-655', 'variables', 'link-103');">variables</a></tt><tt class="py-op">[</tt><tt id="link-656" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-656', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-657" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-657', 'container', 'link-625');">container</a></tt><tt class="py-op">==</tt><tt class="py-name">class_doc</tt><tt class="py-op">:</tt> </tt>
<a name="L1298"></a><tt class="py-lineno">1298</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-658" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-658', 'variables', 'link-103');">variables</a></tt><tt class="py-op">[</tt><tt id="link-659" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-659', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-660" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-660', 'overrides', 'link-99');">overrides</a></tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt> </tt>
<a name="L1299"></a><tt class="py-lineno">1299</tt> <tt class="py-line"> <tt id="link-661" class="py-name" targets="Function epydoc.docbuilder._inherit_info()=epydoc.docbuilder-module.html#_inherit_info"><a title="epydoc.docbuilder._inherit_info" class="py-name" href="#" onclick="return doclink('link-661', '_inherit_info', 'link-661');">_inherit_info</a></tt><tt class="py-op">(</tt><tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-662" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-662', 'variables', 'link-103');">variables</a></tt><tt class="py-op">[</tt><tt id="link-663" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-663', 'name', 'link-24');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1300"></a><tt class="py-lineno">1300</tt> <tt class="py-line"> </tt>
<a name="L1301"></a><tt class="py-lineno">1301</tt> <tt class="py-line"><tt id="link-664" class="py-name" targets="Variable epydoc.docbuilder._INHERITED_ATTRIBS=epydoc.docbuilder-module.html#_INHERITED_ATTRIBS"><a title="epydoc.docbuilder._INHERITED_ATTRIBS" class="py-name" href="#" onclick="return doclink('link-664', '_INHERITED_ATTRIBS', 'link-664');">_INHERITED_ATTRIBS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> </tt>
<a name="L1302"></a><tt class="py-lineno">1302</tt> <tt class="py-line"> <tt class="py-string">'descr'</tt><tt class="py-op">,</tt> <tt class="py-string">'summary'</tt><tt class="py-op">,</tt> <tt class="py-string">'metadata'</tt><tt class="py-op">,</tt> <tt class="py-string">'extra_docstring_fields'</tt><tt class="py-op">,</tt> </tt>
<a name="L1303"></a><tt class="py-lineno">1303</tt> <tt class="py-line"> <tt class="py-string">'type_descr'</tt><tt class="py-op">,</tt> <tt class="py-string">'arg_descrs'</tt><tt class="py-op">,</tt> <tt class="py-string">'arg_types'</tt><tt class="py-op">,</tt> <tt class="py-string">'return_descr'</tt><tt class="py-op">,</tt> </tt>
<a name="L1304"></a><tt class="py-lineno">1304</tt> <tt class="py-line"> <tt class="py-string">'return_type'</tt><tt class="py-op">,</tt> <tt class="py-string">'exception_descrs'</tt><tt class="py-op">]</tt> </tt>
<a name="L1305"></a><tt class="py-lineno">1305</tt> <tt class="py-line"> </tt>
<a name="L1306"></a><tt class="py-lineno">1306</tt> <tt class="py-line"><tt class="py-name">_method_descriptor</tt> <tt class="py-op">=</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">list</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">)</tt> </tt>
<a name="L1307"></a><tt class="py-lineno">1307</tt> <tt class="py-line"> </tt>
<a name="_inherit_info"></a><div id="_inherit_info-def"><a name="L1308"></a><tt class="py-lineno">1308</tt> <a class="py-toggle" href="#" id="_inherit_info-toggle" onclick="return toggle('_inherit_info');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docbuilder-module.html#_inherit_info">_inherit_info</a><tt class="py-op">(</tt><tt class="py-param">var_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_inherit_info-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_inherit_info-expanded"><a name="L1309"></a><tt class="py-lineno">1309</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1310"></a><tt class="py-lineno">1310</tt> <tt class="py-line"><tt class="py-docstring"> Copy any relevant documentation information from the variable that</tt> </tt>
<a name="L1311"></a><tt class="py-lineno">1311</tt> <tt class="py-line"><tt class="py-docstring"> C{var_doc} overrides into C{var_doc} itself.</tt> </tt>
<a name="L1312"></a><tt class="py-lineno">1312</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1313"></a><tt class="py-lineno">1313</tt> <tt class="py-line"> <tt class="py-name">src_var</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-665" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-665', 'overrides', 'link-99');">overrides</a></tt> </tt>
<a name="L1314"></a><tt class="py-lineno">1314</tt> <tt class="py-line"> <tt class="py-name">src_val</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-666" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-666', 'overrides', 'link-99');">overrides</a></tt><tt class="py-op">.</tt><tt id="link-667" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-667', 'value', 'link-106');">value</a></tt> </tt>
<a name="L1315"></a><tt class="py-lineno">1315</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-668" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-668', 'value', 'link-106');">value</a></tt> </tt>
<a name="L1316"></a><tt class="py-lineno">1316</tt> <tt class="py-line"> </tt>
<a name="L1317"></a><tt class="py-lineno">1317</tt> <tt class="py-line"> <tt class="py-comment"># Special case: if the source value and target values are both c</tt> </tt>
<a name="L1318"></a><tt class="py-lineno">1318</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># extension methods, and the target value's signature is not</tt> </tt>
<a name="L1319"></a><tt class="py-lineno">1319</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># specified, then inherit the source value's signature.</tt> </tt>
<a name="L1320"></a><tt class="py-lineno">1320</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-669" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-669', 'RoutineDoc', 'link-386');">RoutineDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1321"></a><tt class="py-lineno">1321</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">src_val</tt><tt class="py-op">,</tt> <tt id="link-670" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-670', 'RoutineDoc', 'link-386');">RoutineDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1322"></a><tt class="py-lineno">1322</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">isbuiltin</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-671" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-671', 'pyval', 'link-368');">pyval</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1323"></a><tt class="py-lineno">1323</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-672" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-672', 'pyval', 'link-368');">pyval</a></tt><tt class="py-op">,</tt> <tt class="py-name">_method_descriptor</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1324"></a><tt class="py-lineno">1324</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">isbuiltin</tt><tt class="py-op">(</tt><tt class="py-name">src_val</tt><tt class="py-op">.</tt><tt id="link-673" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-673', 'pyval', 'link-368');">pyval</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1325"></a><tt class="py-lineno">1325</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">src_val</tt><tt class="py-op">.</tt><tt id="link-674" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-674', 'pyval', 'link-368');">pyval</a></tt><tt class="py-op">,</tt> <tt class="py-name">_method_descriptor</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1326"></a><tt class="py-lineno">1326</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-675" class="py-name" targets="Method epydoc.apidoc.RoutineDoc.all_args()=epydoc.apidoc.RoutineDoc-class.html#all_args"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-675', 'all_args', 'link-675');">all_args</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'...'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-676" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-676', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1327"></a><tt class="py-lineno">1327</tt> <tt class="py-line"> <tt class="py-name">src_val</tt><tt class="py-op">.</tt><tt id="link-677" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-677', 'all_args', 'link-675');">all_args</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'...'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-678" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-678', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1328"></a><tt class="py-lineno">1328</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">attrib</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-string">'posargs'</tt><tt class="py-op">,</tt> <tt class="py-string">'posarg_defaults'</tt><tt class="py-op">,</tt> <tt class="py-string">'vararg'</tt><tt class="py-op">,</tt> </tt>
<a name="L1329"></a><tt class="py-lineno">1329</tt> <tt class="py-line"> <tt class="py-string">'kwarg'</tt><tt class="py-op">,</tt> <tt class="py-string">'return_type'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1330"></a><tt class="py-lineno">1330</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">,</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">src_val</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1331"></a><tt class="py-lineno">1331</tt> <tt class="py-line"> </tt>
<a name="L1332"></a><tt class="py-lineno">1332</tt> <tt class="py-line"> <tt class="py-comment"># If the new variable has a docstring, then don't inherit</tt> </tt>
<a name="L1333"></a><tt class="py-lineno">1333</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># anything, even if the docstring is blank.</tt> </tt>
<a name="L1334"></a><tt class="py-lineno">1334</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-679" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docstring=epydoc.apidoc.APIDoc-class.html#docstring"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-679', 'docstring', 'link-679');">docstring</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-680" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-680', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1335"></a><tt class="py-lineno">1335</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1336"></a><tt class="py-lineno">1336</tt> <tt class="py-line"> <tt class="py-comment"># [xx] Do I want a check like this:?</tt> </tt>
<a name="L1337"></a><tt class="py-lineno">1337</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># # If it's a method and the signature doesn't match well enough,</tt> </tt>
<a name="L1338"></a><tt class="py-lineno">1338</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># # then give up.</tt> </tt>
<a name="L1339"></a><tt class="py-lineno">1339</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># if (isinstance(src_val, RoutineDoc) and</tt> </tt>
<a name="L1340"></a><tt class="py-lineno">1340</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># isinstance(val_doc, RoutineDoc)):</tt> </tt>
<a name="L1341"></a><tt class="py-lineno">1341</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># if (src_val.posargs != val_doc.posargs[:len(src_val.posargs)] or</tt> </tt>
<a name="L1342"></a><tt class="py-lineno">1342</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># src_val.vararg != None and src_val.vararg != val_doc.vararg):</tt> </tt>
<a name="L1343"></a><tt class="py-lineno">1343</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># log.docstring_warning(</tt> </tt>
<a name="L1344"></a><tt class="py-lineno">1344</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># "The signature of %s does not match the signature of the "</tt> </tt>
<a name="L1345"></a><tt class="py-lineno">1345</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># "method it overrides (%s); not inheriting documentation." %</tt> </tt>
<a name="L1346"></a><tt class="py-lineno">1346</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># (var_doc.canonical_name, src_var.canonical_name))</tt> </tt>
<a name="L1347"></a><tt class="py-lineno">1347</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># return</tt> </tt>
<a name="L1348"></a><tt class="py-lineno">1348</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1349"></a><tt class="py-lineno">1349</tt> <tt class="py-line"> <tt class="py-comment"># Inherit attributes!</tt> </tt>
<a name="L1350"></a><tt class="py-lineno">1350</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">attrib</tt> <tt class="py-keyword">in</tt> <tt id="link-681" class="py-name"><a title="epydoc.docbuilder._INHERITED_ATTRIBS" class="py-name" href="#" onclick="return doclink('link-681', '_INHERITED_ATTRIBS', 'link-664');">_INHERITED_ATTRIBS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1351"></a><tt class="py-lineno">1351</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">src_var</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1352"></a><tt class="py-lineno">1352</tt> <tt class="py-line"> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">src_var</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-682" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-682', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1353"></a><tt class="py-lineno">1353</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">,</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">src_var</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1354"></a><tt class="py-lineno">1354</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">src_val</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1355"></a><tt class="py-lineno">1355</tt> <tt class="py-line"> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">src_val</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1356"></a><tt class="py-lineno">1356</tt> <tt class="py-line"> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">src_val</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-683" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-683', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1357"></a><tt class="py-lineno">1357</tt> <tt class="py-line"> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-684" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-684', 'UNKNOWN', 'link-43');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1358"></a><tt class="py-lineno">1358</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">,</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">src_val</tt><tt class="py-op">,</tt> <tt class="py-name">attrib</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1359"></a><tt class="py-lineno">1359</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:09:19 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
