<?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.docintrospecter</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 docintrospecter
</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.docintrospecter-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.docintrospecter-module.html">Module epydoc.docintrospecter</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 -- Introspection</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: docintrospecter.py 1678 2008-01-29 17:21:29Z 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">Extract API documentation about python objects by directly introspecting</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">their values.</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">The function L{introspect_docs()}, which provides the main interface</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring">of this module, examines a Python objects via introspection, and uses</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">the information it finds to create an L{APIDoc} objects containing the</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring">API documentation for that objects.</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">The L{register_introspecter()} method can be used to extend the</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">functionality of C{docintrospector}, by providing methods that handle</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring">special value types.</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</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="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Imports</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">inspect</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">,</tt> <tt class="py-name">sys</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">imp</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-comment"># API documentation encoding:</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-comment"></tt><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="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-comment"># Type comparisons:</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">from</tt> <tt class="py-name">types</tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-comment"># Error reporting:</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-comment"></tt><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-keyword">import</tt> <tt id="link-4" 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-4', 'log', 'link-4');">log</a></tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-comment"># Helper functions:</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">from</tt> <tt id="link-5" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-5', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-6" 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-6', 'util', 'link-6');">util</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-comment"># For extracting encoding for docstrings:</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt id="link-7" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-7', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Module epydoc.docparser=epydoc.docparser-module.html"><a title="epydoc.docparser" class="py-name" href="#" onclick="return doclink('link-8', 'docparser', 'link-8');">docparser</a></tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-comment"># Builtin values</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt class="py-name">__builtin__</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-comment"># Backwards compatibility</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">from</tt> <tt id="link-9" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-9', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Module epydoc.compat=epydoc.compat-module.html"><a title="epydoc.compat" class="py-name" href="#" onclick="return doclink('link-10', 'compat', 'link-10');">compat</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Caches</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt id="link-11" class="py-name" targets="Variable epydoc.docintrospecter._valuedoc_cache=epydoc.docintrospecter-module.html#_valuedoc_cache"><a title="epydoc.docintrospecter._valuedoc_cache" class="py-name" href="#" onclick="return doclink('link-11', '_valuedoc_cache', 'link-11');">_valuedoc_cache</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-string">"""A cache containing the API documentation for values that we've</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-string">already seen. This cache is implemented as a dictionary that maps a</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-string">value's pyid to its L{ValueDoc}.</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-string">Note that if we encounter a value but decide not to introspect it</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-string">(because it's imported from another module), then C{_valuedoc_cache}</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-string">will contain an entry for the value, but the value will not be listed</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-string">in L{_introspected_values}."""</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt id="link-12" class="py-name" targets="Variable epydoc.docintrospecter._introspected_values=epydoc.docintrospecter-module.html#_introspected_values"><a title="epydoc.docintrospecter._introspected_values" class="py-name" href="#" onclick="return doclink('link-12', '_introspected_values', 'link-12');">_introspected_values</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-string">"""A record which values we've introspected, encoded as a dictionary from</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-string">pyid to C{bool}."""</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> </tt>
<a name="clear_cache"></a><div id="clear_cache-def"><a name="L62"></a><tt class="py-lineno"> 62</tt> <a class="py-toggle" href="#" id="clear_cache-toggle" onclick="return toggle('clear_cache');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#clear_cache">clear_cache</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="clear_cache-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="clear_cache-expanded"><a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> Discard any cached C{APIDoc} values that have been computed for</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> introspected values.</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt id="link-13" class="py-name"><a title="epydoc.docintrospecter._valuedoc_cache" class="py-name" href="#" onclick="return doclink('link-13', '_valuedoc_cache', 'link-11');">_valuedoc_cache</a></tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Method epydoc.docwriter.xlink.DocUrlGenerator.clear()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#clear,Method epydoc.gui.GUILogger.clear()=epydoc.gui.GUILogger-class.html#clear"><a title="epydoc.docwriter.xlink.DocUrlGenerator.clear
epydoc.gui.GUILogger.clear" class="py-name" href="#" onclick="return doclink('link-14', 'clear', 'link-14');">clear</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt id="link-15" class="py-name"><a title="epydoc.docintrospecter._introspected_values" class="py-name" href="#" onclick="return doclink('link-15', '_introspected_values', 'link-12');">_introspected_values</a></tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="epydoc.docwriter.xlink.DocUrlGenerator.clear
epydoc.gui.GUILogger.clear" class="py-name" href="#" onclick="return doclink('link-16', 'clear', 'link-14');">clear</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Introspection</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="introspect_docs"></a><div id="introspect_docs-def"><a name="L74"></a><tt class="py-lineno"> 74</tt> <a class="py-toggle" href="#" id="introspect_docs-toggle" onclick="return toggle('introspect_docs');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#introspect_docs">introspect_docs</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-param">is_script</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">module_name</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="introspect_docs-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="introspect_docs-expanded"><a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> Generate the API documentation for a specified object by</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> introspecting Python values, and return it as a L{ValueDoc}. The</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> object to generate documentation for may be specified using</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> the C{value} parameter, the C{filename} parameter, I{or} the</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> C{name} parameter. (It is an error to specify more than one</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> of these three parameters, or to not specify any of them.)</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> @param value: The python object that should be documented.</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> @param filename: The name of the file that contains the python</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"> source code for a package, module, or script. If</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> C{filename} is specified, then C{introspect} will return a</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> C{ModuleDoc} describing its contents.</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> @param name: The fully-qualified python dotted name of any</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> value (including packages, modules, classes, and</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> functions). C{DocParser} will automatically figure out</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-docstring"> which module(s) it needs to import in order to find the</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring"> documentation for the specified object.</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> @param context: The API documentation for the class of module</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> that contains C{value} (if available).</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"> @param module_name: The name of the module where the value is defined.</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> Useful to retrieve the docstring encoding if there is no way to</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> detect the module by introspection (such as in properties)</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-17" 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-17', 'value', 'link-17');">value</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt id="link-18" 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-18', 'name', 'link-18');">name</a></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 id="link-19" 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-19', 'filename', 'link-19');">filename</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"> <tt id="link-20" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-20', 'value', 'link-17');">value</a></tt> <tt class="py-op">=</tt> <tt id="link-21" class="py-name" targets="Function epydoc.docintrospecter.get_value_from_name()=epydoc.docintrospecter-module.html#get_value_from_name"><a title="epydoc.docintrospecter.get_value_from_name" class="py-name" href="#" onclick="return doclink('link-21', 'get_value_from_name', 'link-21');">get_value_from_name</a></tt><tt class="py-op">(</tt><tt id="link-22" 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-22', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-23" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-23', 'name', 'link-18');">name</a></tt><tt class="py-op">)</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">elif</tt> <tt id="link-24" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-24', 'value', 'link-17');">value</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt id="link-25" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-25', 'name', 'link-18');">name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt id="link-26" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-26', 'filename', 'link-19');">filename</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="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">is_script</tt><tt class="py-op">:</tt> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"> <tt id="link-27" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-27', 'value', 'link-17');">value</a></tt> <tt class="py-op">=</tt> <tt id="link-28" class="py-name" targets="Function epydoc.docintrospecter.get_value_from_scriptname()=epydoc.docintrospecter-module.html#get_value_from_scriptname"><a title="epydoc.docintrospecter.get_value_from_scriptname" class="py-name" href="#" onclick="return doclink('link-28', 'get_value_from_scriptname', 'link-28');">get_value_from_scriptname</a></tt><tt class="py-op">(</tt><tt id="link-29" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-29', 'filename', 'link-19');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"> <tt id="link-30" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-30', 'value', 'link-17');">value</a></tt> <tt class="py-op">=</tt> <tt id="link-31" class="py-name" targets="Function epydoc.docintrospecter.get_value_from_filename()=epydoc.docintrospecter-module.html#get_value_from_filename"><a title="epydoc.docintrospecter.get_value_from_filename" class="py-name" href="#" onclick="return doclink('link-31', 'get_value_from_filename', 'link-31');">get_value_from_filename</a></tt><tt class="py-op">(</tt><tt id="link-32" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-32', 'filename', 'link-19');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-33" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-33', 'name', 'link-18');">name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt id="link-34" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-34', 'filename', 'link-19');">filename</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"> <tt class="py-comment"># it's ok if value is None -- that's a value, after all.</tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</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">"Expected exactly one of the following "</tt> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"> <tt class="py-string">"arguments: value, name, filename"</tt><tt class="py-op">)</tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"> <tt class="py-name">pyid</tt> <tt class="py-op">=</tt> <tt class="py-name">id</tt><tt class="py-op">(</tt><tt id="link-35" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-35', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"> </tt>
<a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"> <tt class="py-comment"># If we've already introspected this value, then simply return</tt> </tt>
<a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># its ValueDoc from our cache.</tt> </tt>
<a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">pyid</tt> <tt class="py-keyword">in</tt> <tt id="link-36" class="py-name"><a title="epydoc.docintrospecter._introspected_values" class="py-name" href="#" onclick="return doclink('link-36', '_introspected_values', 'link-12');">_introspected_values</a></tt><tt class="py-op">:</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"> <tt class="py-comment"># If the file is a script, then adjust its name.</tt> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">is_script</tt> <tt class="py-keyword">and</tt> <tt id="link-37" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-37', 'filename', 'link-19');">filename</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="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"> <tt id="link-38" class="py-name"><a title="epydoc.docintrospecter._valuedoc_cache" class="py-name" href="#" onclick="return doclink('link-38', '_valuedoc_cache', 'link-11');">_valuedoc_cache</a></tt><tt class="py-op">[</tt><tt class="py-name">pyid</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-39" 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-39', 'canonical_name', 'link-39');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-40" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-40', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"> <tt id="link-41" 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-41', 'munge_script_name', 'link-41');">munge_script_name</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-42" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-42', 'filename', 'link-19');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-43" class="py-name"><a title="epydoc.docintrospecter._valuedoc_cache" class="py-name" href="#" onclick="return doclink('link-43', '_valuedoc_cache', 'link-11');">_valuedoc_cache</a></tt><tt class="py-op">[</tt><tt class="py-name">pyid</tt><tt class="py-op">]</tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"> <tt class="py-comment"># Create an initial value doc for this value & add it to the cache.</tt> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt id="link-44" class="py-name" targets="Function epydoc.docintrospecter._get_valuedoc()=epydoc.docintrospecter-module.html#_get_valuedoc"><a title="epydoc.docintrospecter._get_valuedoc" class="py-name" href="#" onclick="return doclink('link-44', '_get_valuedoc', 'link-44');">_get_valuedoc</a></tt><tt class="py-op">(</tt><tt id="link-45" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-45', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"> </tt>
<a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"> <tt class="py-comment"># Introspect the value.</tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-46" class="py-name"><a title="epydoc.docintrospecter._introspected_values" class="py-name" href="#" onclick="return doclink('link-46', '_introspected_values', 'link-12');">_introspected_values</a></tt><tt class="py-op">[</tt><tt class="py-name">pyid</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"> <tt class="py-name">introspect_func</tt> <tt class="py-op">=</tt> <tt id="link-47" class="py-name" targets="Function epydoc.docintrospecter._get_introspecter()=epydoc.docintrospecter-module.html#_get_introspecter"><a title="epydoc.docintrospecter._get_introspecter" class="py-name" href="#" onclick="return doclink('link-47', '_get_introspecter', 'link-47');">_get_introspecter</a></tt><tt class="py-op">(</tt><tt id="link-48" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-48', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"> <tt class="py-name">introspect_func</tt><tt class="py-op">(</tt><tt id="link-49" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-49', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">module_name</tt><tt class="py-op">=</tt><tt class="py-name">module_name</tt><tt class="py-op">)</tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"> <tt class="py-comment"># Set canonical name, if it was given</tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</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-op">.</tt><tt id="link-50" 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-50', 'canonical_name', 'link-39');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt id="link-51" 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-51', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt id="link-52" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-52', 'name', 'link-18');">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="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-53" 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-53', 'canonical_name', 'link-39');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-54" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-54', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-55" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-55', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"> <tt class="py-comment"># If the file is a script, then adjust its name.</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">is_script</tt> <tt class="py-keyword">and</tt> <tt id="link-56" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-56', 'filename', 'link-19');">filename</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="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-57" 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-57', 'canonical_name', 'link-39');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-58" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-58', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-59" class="py-name"><a title="epydoc.util.munge_script_name" class="py-name" href="#" onclick="return doclink('link-59', 'munge_script_name', 'link-41');">munge_script_name</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-60" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-60', 'filename', 'link-19');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-61" 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-61', 'canonical_name', 'link-39');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt id="link-62" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-62', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt id="link-63" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-63', 'filename', 'link-19');">filename</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="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"> <tt class="py-name">shadowed_name</tt> <tt class="py-op">=</tt> <tt id="link-64" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-64', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-65" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-65', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"> <tt id="link-66" 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-66', 'log', 'link-4');">log</a></tt><tt class="py-op">.</tt><tt id="link-67" 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-67', 'warning', 'link-67');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Module %s is shadowed by a variable with "</tt> </tt>
<a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"> <tt class="py-string">"the same name."</tt> <tt class="py-op">%</tt> <tt class="py-name">shadowed_name</tt><tt class="py-op">)</tt> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-68" 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-68', 'canonical_name', 'link-39');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-69" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-69', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">shadowed_name</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">"'"</tt><tt class="py-op">)</tt> </tt>
<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 class="py-keyword">return</tt> <tt class="py-name">val_doc</tt> </tt>
</div><a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"> </tt>
<a name="_get_valuedoc"></a><div id="_get_valuedoc-def"><a name="L149"></a><tt class="py-lineno"> 149</tt> <a class="py-toggle" href="#" id="_get_valuedoc-toggle" onclick="return toggle('_get_valuedoc');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#_get_valuedoc">_get_valuedoc</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_get_valuedoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_get_valuedoc-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"> If a C{ValueDoc} for the given value exists in the valuedoc</tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"><tt class="py-docstring"> cache, then return it; otherwise, create a new C{ValueDoc},</tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"><tt class="py-docstring"> add it to the cache, and return it. When possible, the new</tt> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"><tt class="py-docstring"> C{ValueDoc}'s C{pyval}, C{repr}, and C{canonical_name}</tt> </tt>
<a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"><tt class="py-docstring"> attributes will be set appropriately.</tt> </tt>
<a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"> <tt class="py-name">pyid</tt> <tt class="py-op">=</tt> <tt class="py-name">id</tt><tt class="py-op">(</tt><tt id="link-70" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-70', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt id="link-71" class="py-name"><a title="epydoc.docintrospecter._valuedoc_cache" class="py-name" href="#" onclick="return doclink('link-71', '_valuedoc_cache', 'link-11');">_valuedoc_cache</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">pyid</tt><tt class="py-op">)</tt> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</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-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt id="link-72" 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-72', 'canonical_name', 'link-39');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-73" class="py-name" targets="Function epydoc.docintrospecter.get_canonical_name()=epydoc.docintrospecter-module.html#get_canonical_name,Method epydoc.docwriter.xlink.UrlGenerator.get_canonical_name()=epydoc.docwriter.xlink.UrlGenerator-class.html#get_canonical_name"><a title="epydoc.docintrospecter.get_canonical_name
epydoc.docwriter.xlink.UrlGenerator.get_canonical_name" class="py-name" href="#" onclick="return doclink('link-73', 'get_canonical_name', 'link-73');">get_canonical_name</a></tt><tt class="py-op">(</tt><tt id="link-74" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-74', 'value', 'link-17');">value</a></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="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-75" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-75', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-76" 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-76', 'InvalidDottedName', 'link-76');">InvalidDottedName</a></tt><tt class="py-op">:</tt> <tt id="link-77" 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-77', 'canonical_name', 'link-39');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-78" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-78', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt id="link-79" 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-79', 'ValueDoc', 'link-79');">ValueDoc</a></tt><tt class="py-op">(</tt><tt id="link-80" 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-80', 'pyval', 'link-80');">pyval</a></tt><tt class="py-op">=</tt><tt id="link-81" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-81', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt id="link-82" 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-82', 'canonical_name', 'link-39');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-83" 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-83', 'canonical_name', 'link-39');">canonical_name</a></tt><tt class="py-op">,</tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"> <tt id="link-84" 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-84', 'docs_extracted_by', 'link-84');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'introspecter'</tt><tt class="py-op">)</tt> </tt>
<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"> <tt id="link-85" class="py-name"><a title="epydoc.docintrospecter._valuedoc_cache" class="py-name" href="#" onclick="return doclink('link-85', '_valuedoc_cache', 'link-11');">_valuedoc_cache</a></tt><tt class="py-op">[</tt><tt class="py-name">pyid</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"> <tt class="py-comment"># If it's a module, then do some preliminary introspection.</tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Otherwise, check what the containing module is (used e.g.</tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># to decide what markup language should be used for docstrings)</tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">ismodule</tt><tt class="py-op">(</tt><tt id="link-86" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-86', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"> <tt id="link-87" class="py-name" targets="Function epydoc.docintrospecter.introspect_module()=epydoc.docintrospecter-module.html#introspect_module"><a title="epydoc.docintrospecter.introspect_module" class="py-name" href="#" onclick="return doclink('link-87', 'introspect_module', 'link-87');">introspect_module</a></tt><tt class="py-op">(</tt><tt id="link-88" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-88', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">preliminary</tt><tt class="py-op">=</tt><tt class="py-name">True</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">val_doc</tt><tt class="py-op">.</tt><tt id="link-89" 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-89', 'defining_module', 'link-89');">defining_module</a></tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"> <tt class="py-name">module_name</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-90" class="py-name" targets="Function epydoc.docintrospecter.get_containing_module()=epydoc.docintrospecter-module.html#get_containing_module"><a title="epydoc.docintrospecter.get_containing_module" class="py-name" href="#" onclick="return doclink('link-90', 'get_containing_module', 'link-90');">get_containing_module</a></tt><tt class="py-op">(</tt><tt id="link-91" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-91', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">modules</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">module_name</tt><tt class="py-op">)</tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module</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">inspect</tt><tt class="py-op">.</tt><tt class="py-name">ismodule</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-92" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-92', 'defining_module', 'link-89');">defining_module</a></tt> <tt class="py-op">=</tt> <tt id="link-93" class="py-name"><a title="epydoc.docintrospecter._get_valuedoc" class="py-name" href="#" onclick="return doclink('link-93', '_get_valuedoc', 'link-44');">_get_valuedoc</a></tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">)</tt> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"> </tt>
<a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val_doc</tt> </tt>
</div><a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"> </tt>
<a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Module Introspection</tt> </tt>
<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"><tt class="py-comment">#: A list of module variables that should not be included in a</tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#: module's API documentation.</tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-94" class="py-name" targets="Variable epydoc.docintrospecter.UNDOCUMENTED_MODULE_VARS=epydoc.docintrospecter-module.html#UNDOCUMENTED_MODULE_VARS"><a title="epydoc.docintrospecter.UNDOCUMENTED_MODULE_VARS" class="py-name" href="#" onclick="return doclink('link-94', 'UNDOCUMENTED_MODULE_VARS', 'link-94');">UNDOCUMENTED_MODULE_VARS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"> <tt class="py-string">'__builtins__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__doc__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__all__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__file__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__path__'</tt><tt class="py-op">,</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"> <tt class="py-string">'__name__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__extra_epydoc_fields__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__docformat__'</tt><tt class="py-op">)</tt> </tt>
<a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"> </tt>
<a name="introspect_module"></a><div id="introspect_module-def"><a name="L190"></a><tt class="py-lineno"> 190</tt> <a class="py-toggle" href="#" id="introspect_module-toggle" onclick="return toggle('introspect_module');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#introspect_module">introspect_module</a><tt class="py-op">(</tt><tt class="py-param">module</tt><tt class="py-op">,</tt> <tt class="py-param">module_doc</tt><tt class="py-op">,</tt> <tt class="py-param">module_name</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">preliminary</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="introspect_module-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="introspect_module-expanded"><a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"><tt class="py-docstring"> Add API documentation information about the module C{module}</tt> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"><tt class="py-docstring"> to C{module_doc}.</tt> </tt>
<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-95" 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-95', 'specialize_to', 'link-95');">specialize_to</a></tt><tt class="py-op">(</tt><tt id="link-96" 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-96', 'ModuleDoc', 'link-96');">ModuleDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"> <tt class="py-comment"># Record the module's docformat</tt> </tt>
<a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">,</tt> <tt class="py-string">'__docformat__'</tt><tt class="py-op">)</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">module_doc</tt><tt class="py-op">.</tt><tt id="link-97" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.docformat=epydoc.apidoc.ModuleDoc-class.html#docformat"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-97', 'docformat', 'link-97');">docformat</a></tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">__docformat__</tt><tt class="py-op">)</tt> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"> <tt class="py-comment"># Record the module's filename</tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">,</tt> <tt class="py-string">'__file__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-98" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-98', 'filename', 'link-19');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">__file__</tt><tt class="py-op">)</tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-99" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-99', 'filename', 'link-19');">filename</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-100" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-100', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-101" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-101', 'filename', 'link-19');">filename</a></tt> <tt class="py-op">=</tt> <tt id="link-102" 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-102', 'py_src_filename', 'link-102');">py_src_filename</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-103', 'filename', 'link-19');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> <tt class="py-comment"># If this is just a preliminary introspection, then don't do</tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># anything else. (Typically this is true if this module was</tt> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># imported, but is not included in the set of modules we're</tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># documenting.)</tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-104" 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-104', 'variables', 'link-104');">variables</a></tt> <tt class="py-op">=</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 class="py-keyword">if</tt> <tt class="py-name">preliminary</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"> <tt class="py-comment"># Record the module's docstring</tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">,</tt> <tt class="py-string">'__doc__'</tt><tt class="py-op">)</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">module_doc</tt><tt class="py-op">.</tt><tt id="link-105" 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-105', 'docstring', 'link-105');">docstring</a></tt> <tt class="py-op">=</tt> <tt id="link-106" class="py-name" targets="Function epydoc.docintrospecter.get_docstring()=epydoc.docintrospecter-module.html#get_docstring"><a title="epydoc.docintrospecter.get_docstring" class="py-name" href="#" onclick="return doclink('link-106', 'get_docstring', 'link-106');">get_docstring</a></tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">)</tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"> <tt class="py-comment"># If the module has a __path__, then it's (probably) a</tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># package; so set is_package=True and record its __path__.</tt> </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">,</tt> <tt class="py-string">'__path__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-107" 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-107', 'is_package', 'link-107');">is_package</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-108" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-108', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">p</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">p</tt> <tt class="py-keyword">in</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">__path__</tt><tt class="py-op">]</tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-109" class="py-name"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-109', 'is_package', 'link-107');">is_package</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"> <tt class="py-comment"># Make sure we have a name for the package.</tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-110" 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-110', 'canonical_name', 'link-39');">canonical_name</a></tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">dotted_name</tt> <tt class="py-keyword">is</tt> <tt id="link-111" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-111', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-112" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-112', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"> <tt class="py-name">name_without_primes</tt> <tt class="py-op">=</tt> <tt id="link-113" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-113', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">"'"</tt><tt class="py-op">,</tt> <tt class="py-string">""</tt><tt class="py-op">)</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"># Record the module's parent package, if it has one.</tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</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">dotted_name</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="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"> <tt class="py-name">package_name</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</tt><tt class="py-op">.</tt><tt id="link-114" 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-114', 'container', 'link-114');">container</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"> <tt id="link-115" 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-115', 'package', 'link-115');">package</a></tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">modules</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">package_name</tt><tt class="py-op">)</tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-116" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-116', 'package', 'link-115');">package</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="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-117" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-117', 'package', 'link-115');">package</a></tt> <tt class="py-op">=</tt> <tt id="link-118" 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-118', 'introspect_docs', 'link-118');">introspect_docs</a></tt><tt class="py-op">(</tt><tt id="link-119" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-119', 'package', 'link-115');">package</a></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">else</tt><tt class="py-op">:</tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-120', 'package', 'link-115');">package</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"> <tt class="py-comment"># Initialize the submodules property</tt> </tt>
<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-121" 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-121', 'submodules', 'link-121');">submodules</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> <tt class="py-comment"># Add the module to its parent package's submodules list.</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-122" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-122', 'package', 'link-115');">package</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-123" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-123', 'UNKNOWN', 'link-51');">UNKNOWN</a></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 class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-124" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-124', 'package', 'link-115');">package</a></tt><tt class="py-op">.</tt><tt id="link-125" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-125', 'submodules', 'link-121');">submodules</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"> <tt class="py-comment"># Look up the module's __all__ attribute (public names).</tt> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">public_names</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</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">module</tt><tt class="py-op">,</tt> <tt class="py-string">'__all__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"> <tt class="py-keyword">try</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">public_names</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-126" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-126', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt id="link-127" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-127', 'name', 'link-18');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">__all__</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"> <tt class="py-comment"># Record the module's variables.</tt> </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-128" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-128', 'variables', 'link-104');">variables</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">child_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">dir</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">child_name</tt> <tt class="py-keyword">in</tt> <tt id="link-129" class="py-name"><a title="epydoc.docintrospecter.UNDOCUMENTED_MODULE_VARS" class="py-name" href="#" onclick="return doclink('link-129', 'UNDOCUMENTED_MODULE_VARS', 'link-94');">UNDOCUMENTED_MODULE_VARS</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> <tt class="py-name">child</tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">,</tt> <tt class="py-name">child_name</tt><tt class="py-op">)</tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"> <tt class="py-comment"># Create a VariableDoc for the child, and introspect its</tt> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># value if it's defined in this module.</tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-130" 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-130', 'container', 'link-114');">container</a></tt> <tt class="py-op">=</tt> <tt id="link-131" class="py-name"><a title="epydoc.docintrospecter.get_containing_module" class="py-name" href="#" onclick="return doclink('link-131', 'get_containing_module', 'link-90');">get_containing_module</a></tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">)</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt id="link-132" 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-132', 'container', 'link-114');">container</a></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="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"> <tt id="link-133" 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-133', 'container', 'link-114');">container</a></tt> <tt class="py-op">==</tt> <tt class="py-name">name_without_primes</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">public_names</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="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"> <tt class="py-name">child_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">public_names</tt><tt class="py-op">)</tt><tt class="py-op">)</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"># Local variable.</tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">child_val_doc</tt> <tt class="py-op">=</tt> <tt id="link-134" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-134', 'introspect_docs', 'link-118');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">module_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"> <tt class="py-name">module_name</tt><tt class="py-op">=</tt><tt class="py-name">dotted_name</tt><tt class="py-op">)</tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"> <tt class="py-name">child_var_doc</tt> <tt class="py-op">=</tt> <tt id="link-135" class="py-name" targets="Class epydoc.apidoc.VariableDoc=epydoc.apidoc.VariableDoc-class.html"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-135', 'VariableDoc', 'link-135');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-136" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-136', 'name', 'link-18');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">child_name</tt><tt class="py-op">,</tt> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt id="link-137" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-137', 'value', 'link-17');">value</a></tt><tt class="py-op">=</tt><tt class="py-name">child_val_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> <tt id="link-138" 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-138', 'is_imported', 'link-138');">is_imported</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"> <tt id="link-139" 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-139', 'container', 'link-114');">container</a></tt><tt class="py-op">=</tt><tt class="py-name">module_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"> <tt id="link-140" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-140', 'docs_extracted_by', 'link-84');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'introspecter'</tt><tt class="py-op">)</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-141" 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-141', 'container', 'link-114');">container</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-142" 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-142', 'canonical_name', 'link-39');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt id="link-143" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-143', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"> <tt class="py-comment"># Don't introspect stuff "from __future__"</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-144" class="py-name" targets="Function epydoc.docintrospecter.is_future_feature()=epydoc.docintrospecter-module.html#is_future_feature"><a title="epydoc.docintrospecter.is_future_feature" class="py-name" href="#" onclick="return doclink('link-144', 'is_future_feature', 'link-144');">is_future_feature</a></tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> </tt>
<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"> <tt class="py-comment"># Possibly imported variable.</tt> </tt>
<a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">child_val_doc</tt> <tt class="py-op">=</tt> <tt id="link-145" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-145', 'introspect_docs', 'link-118');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">module_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt class="py-name">child_var_doc</tt> <tt class="py-op">=</tt> <tt id="link-146" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-146', 'VariableDoc', 'link-135');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-147" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-147', 'name', 'link-18');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">child_name</tt><tt class="py-op">,</tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"> <tt id="link-148" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-148', 'value', 'link-17');">value</a></tt><tt class="py-op">=</tt><tt class="py-name">child_val_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"> <tt id="link-149" 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-149', 'container', 'link-114');">container</a></tt><tt class="py-op">=</tt><tt class="py-name">module_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"> <tt id="link-150" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-150', 'docs_extracted_by', 'link-84');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'introspecter'</tt><tt class="py-op">)</tt> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"> <tt class="py-comment"># Imported variable.</tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">child_val_doc</tt> <tt class="py-op">=</tt> <tt id="link-151" class="py-name"><a title="epydoc.docintrospecter._get_valuedoc" class="py-name" href="#" onclick="return doclink('link-151', '_get_valuedoc', 'link-44');">_get_valuedoc</a></tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">)</tt> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"> <tt class="py-name">child_var_doc</tt> <tt class="py-op">=</tt> <tt id="link-152" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-152', 'VariableDoc', 'link-135');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-153" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-153', 'name', 'link-18');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">child_name</tt><tt class="py-op">,</tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"> <tt id="link-154" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-154', 'value', 'link-17');">value</a></tt><tt class="py-op">=</tt><tt class="py-name">child_val_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"> <tt id="link-155" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-155', 'is_imported', 'link-138');">is_imported</a></tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"> <tt id="link-156" 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-156', 'container', 'link-114');">container</a></tt><tt class="py-op">=</tt><tt class="py-name">module_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"> <tt id="link-157" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-157', 'docs_extracted_by', 'link-84');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'introspecter'</tt><tt class="py-op">)</tt> </tt>
<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"> </tt>
<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"> <tt class="py-comment"># If the module's __all__ attribute is set, use it to set the</tt> </tt>
<a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># variables public/private status and imported status.</tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">public_names</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="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">child_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">public_names</tt><tt class="py-op">:</tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"> <tt class="py-name">child_var_doc</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_public=epydoc.apidoc.VariableDoc-class.html#is_public"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-158', 'is_public', 'link-158');">is_public</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">child_var_doc</tt><tt class="py-op">,</tt> <tt id="link-159" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-159', 'ModuleDoc', 'link-96');">ModuleDoc</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">child_var_doc</tt><tt class="py-op">.</tt><tt id="link-160" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-160', 'is_imported', 'link-138');">is_imported</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"> <tt class="py-name">child_var_doc</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-161', 'is_public', 'link-158');">is_public</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"> </tt>
<a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-162" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-162', 'variables', 'link-104');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">child_name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">child_var_doc</tt> </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">module_doc</tt> </tt>
</div><a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Class Introspection</tt> </tt>
<a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </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">#: A list of class variables that should not be included in a</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">#: class's API documentation.</tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-163" class="py-name" targets="Variable epydoc.docintrospecter.UNDOCUMENTED_CLASS_VARS=epydoc.docintrospecter-module.html#UNDOCUMENTED_CLASS_VARS"><a title="epydoc.docintrospecter.UNDOCUMENTED_CLASS_VARS" class="py-name" href="#" onclick="return doclink('link-163', 'UNDOCUMENTED_CLASS_VARS', 'link-163');">UNDOCUMENTED_CLASS_VARS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt> </tt>
<a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"> <tt class="py-string">'__doc__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__module__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__dict__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__weakref__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__slots__'</tt><tt class="py-op">,</tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"> <tt class="py-string">'__pyx_vtable__'</tt><tt class="py-op">)</tt> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"> </tt>
<a name="introspect_class"></a><div id="introspect_class-def"><a name="L326"></a><tt class="py-lineno"> 326</tt> <a class="py-toggle" href="#" id="introspect_class-toggle" onclick="return toggle('introspect_class');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#introspect_class">introspect_class</a><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">,</tt> <tt class="py-param">class_doc</tt><tt class="py-op">,</tt> <tt class="py-param">module_name</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="introspect_class-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="introspect_class-expanded"><a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"><tt class="py-docstring"> Add API documentation information about the class C{cls}</tt> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"><tt class="py-docstring"> to C{class_doc}.</tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name"><a title="epydoc.apidoc.APIDoc.specialize_to" class="py-name" href="#" onclick="return doclink('link-164', 'specialize_to', 'link-95');">specialize_to</a></tt><tt class="py-op">(</tt><tt id="link-165" 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-165', 'ClassDoc', 'link-165');">ClassDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> <tt class="py-comment"># Record the class's docstring.</tt> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-166" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-166', 'docstring', 'link-105');">docstring</a></tt> <tt class="py-op">=</tt> <tt id="link-167" class="py-name"><a title="epydoc.docintrospecter.get_docstring" class="py-name" href="#" onclick="return doclink('link-167', 'get_docstring', 'link-106');">get_docstring</a></tt><tt class="py-op">(</tt><tt class="py-name">cls</tt><tt class="py-op">)</tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> <tt class="py-comment"># Record the class's __all__ attribute (public names).</tt> </tt>
<a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">public_names</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L338"></a><tt class="py-lineno"> 338</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">cls</tt><tt class="py-op">,</tt> <tt class="py-string">'__all__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"> <tt class="py-name">public_names</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-168" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-168', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt id="link-169" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-169', 'name', 'link-18');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt class="py-name">__all__</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"> <tt class="py-comment"># Start a list of subclasses.</tt> </tt>
<a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-170" 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-170', 'subclasses', 'link-170');">subclasses</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"> </tt>
<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-comment"># Sometimes users will define a __metaclass__ that copies all</tt> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># class attributes from bases directly into the derived class's</tt> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># __dict__ when the class is created. (This saves the lookup time</tt> </tt>
<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># needed to search the base tree for an attribute.) But for the</tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># docs, we only want to list these copied attributes in the</tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># parent. So only add an attribute if it is not identical to an</tt> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># attribute of a base class. (Unfortunately, this can sometimes</tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># cause an attribute to look like it was inherited, even though it</tt> </tt>
<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># wasn't, if it happens to have the exact same value as the</tt> </tt>
<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># corresponding base's attribute.) An example of a case where</tt> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># this helps is PyQt -- subclasses of QWidget get about 300</tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># methods injected into them.</tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">base_children</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"> <tt class="py-comment"># Record the class's base classes; and add the class to its</tt> </tt>
<a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># base class's subclass lists.</tt> </tt>
<a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">cls</tt><tt class="py-op">,</tt> <tt class="py-string">'__bases__'</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">try</tt><tt class="py-op">:</tt> <tt id="link-171" 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-171', 'bases', 'link-171');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">cls</tt><tt class="py-op">.</tt><tt class="py-name">__bases__</tt><tt class="py-op">)</tt> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"> <tt id="link-172" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-172', 'bases', 'link-171');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"> <tt id="link-173" 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-173', 'log', 'link-4');">log</a></tt><tt class="py-op">.</tt><tt id="link-174" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-174', 'warning', 'link-67');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Class '%s' defines __bases__, but it does not "</tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"> <tt class="py-string">"contain an iterable; ignoring base list."</tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">cls</tt><tt class="py-op">,</tt> <tt class="py-string">'__name__'</tt><tt class="py-op">,</tt> <tt class="py-string">'??'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-175" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-175', 'bases', 'link-171');">bases</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="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-176" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-176', 'bases', 'link-171');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt id="link-177" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-177', 'bases', 'link-171');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"> <tt class="py-name">basedoc</tt> <tt class="py-op">=</tt> <tt id="link-178" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-178', 'introspect_docs', 'link-118');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">)</tt> </tt>
<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-179" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-179', 'bases', 'link-171');">bases</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">basedoc</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">basedoc</tt><tt class="py-op">.</tt><tt id="link-180" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-180', 'subclasses', 'link-170');">subclasses</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">class_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"> <tt id="link-181" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-181', 'bases', 'link-171');">bases</a></tt><tt class="py-op">.</tt><tt class="py-name">reverse</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt id="link-182" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-182', 'bases', 'link-171');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</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">base</tt><tt class="py-op">,</tt> <tt class="py-string">'__dict__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"> <tt class="py-name">base_children</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"> <tt class="py-comment"># The module name is not defined if the class is being introspected</tt> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># as another class base.</tt> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">module_name</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-183" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-183', 'defining_module', 'link-89');">defining_module</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-184" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-184', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"> <tt class="py-name">module_name</tt> <tt class="py-op">=</tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-185" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-185', 'defining_module', 'link-89');">defining_module</a></tt><tt class="py-op">.</tt><tt id="link-186" 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-186', 'canonical_name', 'link-39');">canonical_name</a></tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"> <tt class="py-comment"># Record the class's local variables.</tt> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-187" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-187', 'variables', 'link-104');">variables</a></tt> <tt class="py-op">=</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">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">cls</tt><tt class="py-op">,</tt> <tt class="py-string">'__dict__'</tt><tt class="py-op">)</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">private_prefix</tt> <tt class="py-op">=</tt> <tt class="py-string">'_%s__'</tt> <tt class="py-op">%</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">cls</tt><tt class="py-op">,</tt> <tt class="py-string">'__name__'</tt><tt class="py-op">,</tt> <tt class="py-string">'<none>'</tt><tt class="py-op">)</tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">child_name</tt><tt class="py-op">,</tt> <tt class="py-name">child</tt> <tt class="py-keyword">in</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</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="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">child_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">base_children</tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">base_children</tt><tt class="py-op">[</tt><tt class="py-name">child_name</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">child</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">child_name</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-name">private_prefix</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">child_name</tt> <tt class="py-op">=</tt> <tt class="py-name">child_name</tt><tt class="py-op">[</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">private_prefix</tt><tt class="py-op">)</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">child_name</tt> <tt class="py-keyword">in</tt> <tt id="link-188" class="py-name"><a title="epydoc.docintrospecter.UNDOCUMENTED_CLASS_VARS" class="py-name" href="#" onclick="return doclink('link-188', 'UNDOCUMENTED_CLASS_VARS', 'link-163');">UNDOCUMENTED_CLASS_VARS</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"> <tt class="py-name">val_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-118');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">class_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L400"></a><tt class="py-lineno"> 400</tt> <tt class="py-line"> <tt class="py-name">module_name</tt><tt class="py-op">=</tt><tt class="py-name">module_name</tt><tt class="py-op">)</tt> </tt>
<a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-190" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-190', 'VariableDoc', 'link-135');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-191" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-191', 'name', 'link-18');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">child_name</tt><tt class="py-op">,</tt> <tt id="link-192" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-192', 'value', 'link-17');">value</a></tt><tt class="py-op">=</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"> <tt id="link-193" 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-193', 'container', 'link-114');">container</a></tt><tt class="py-op">=</tt><tt class="py-name">class_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"> <tt id="link-194" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-194', 'docs_extracted_by', 'link-84');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'introspecter'</tt><tt class="py-op">)</tt> </tt>
<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">public_names</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="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-195" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-195', 'is_public', 'link-158');">is_public</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">child_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">public_names</tt><tt class="py-op">)</tt> </tt>
<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-196" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-196', 'variables', 'link-104');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">child_name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">class_doc</tt> </tt>
</div><a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> </tt>
<a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Routine Introspection</tt> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="introspect_routine"></a><div id="introspect_routine-def"><a name="L414"></a><tt class="py-lineno"> 414</tt> <a class="py-toggle" href="#" id="introspect_routine-toggle" onclick="return toggle('introspect_routine');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#introspect_routine">introspect_routine</a><tt class="py-op">(</tt><tt class="py-param">routine</tt><tt class="py-op">,</tt> <tt class="py-param">routine_doc</tt><tt class="py-op">,</tt> <tt class="py-param">module_name</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="introspect_routine-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="introspect_routine-expanded"><a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"> <tt class="py-docstring">"""Add API documentation information about the function</tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"><tt class="py-docstring"> C{routine} to C{routine_doc} (specializing it to C{Routine_doc})."""</tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-197" class="py-name"><a title="epydoc.apidoc.APIDoc.specialize_to" class="py-name" href="#" onclick="return doclink('link-197', 'specialize_to', 'link-95');">specialize_to</a></tt><tt class="py-op">(</tt><tt id="link-198" 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-198', 'RoutineDoc', 'link-198');">RoutineDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"> <tt class="py-comment"># Extract the underying function</tt> </tt>
<a name="L420"></a><tt class="py-lineno"> 420</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">routine</tt><tt class="py-op">,</tt> <tt class="py-name">MethodType</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"> <tt class="py-name">func</tt> <tt class="py-op">=</tt> <tt class="py-name">routine</tt><tt class="py-op">.</tt><tt class="py-name">im_func</tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</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">routine</tt><tt class="py-op">,</tt> <tt class="py-name">staticmethod</tt><tt class="py-op">)</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">func</tt> <tt class="py-op">=</tt> <tt class="py-name">routine</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</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">routine</tt><tt class="py-op">,</tt> <tt class="py-name">classmethod</tt><tt class="py-op">)</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">func</tt> <tt class="py-op">=</tt> <tt class="py-name">routine</tt><tt class="py-op">.</tt><tt class="py-name">__get__</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">im_func</tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"> <tt class="py-keyword">else</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">func</tt> <tt class="py-op">=</tt> <tt class="py-name">routine</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"># Record the function's docstring.</tt> </tt>
<a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-199" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-199', 'docstring', 'link-105');">docstring</a></tt> <tt class="py-op">=</tt> <tt id="link-200" class="py-name"><a title="epydoc.docintrospecter.get_docstring" class="py-name" href="#" onclick="return doclink('link-200', 'get_docstring', 'link-106');">get_docstring</a></tt><tt class="py-op">(</tt><tt class="py-name">func</tt><tt class="py-op">)</tt> </tt>
<a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"> </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"> <tt class="py-comment"># Record the function's signature.</tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</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">func</tt><tt class="py-op">,</tt> <tt class="py-name">FunctionType</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt id="link-201" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.vararg=epydoc.apidoc.RoutineDoc-class.html#vararg"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-201', 'vararg', 'link-201');">vararg</a></tt><tt class="py-op">,</tt> <tt id="link-202" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.kwarg=epydoc.apidoc.RoutineDoc-class.html#kwarg"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-202', 'kwarg', 'link-202');">kwarg</a></tt><tt class="py-op">,</tt> <tt class="py-name">defaults</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">getargspec</tt><tt class="py-op">(</tt><tt class="py-name">func</tt><tt class="py-op">)</tt> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"> <tt class="py-comment"># Add the arguments.</tt> </tt>
<a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-203" 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-203', 'posargs', 'link-203');">posargs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">args</tt> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-204" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-204', 'vararg', 'link-201');">vararg</a></tt> <tt class="py-op">=</tt> <tt id="link-205" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-205', 'vararg', 'link-201');">vararg</a></tt> </tt>
<a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-206" class="py-name"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-206', 'kwarg', 'link-202');">kwarg</a></tt> <tt class="py-op">=</tt> <tt id="link-207" class="py-name"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-207', 'kwarg', 'link-202');">kwarg</a></tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"> <tt class="py-comment"># Set default values for positional arguments.</tt> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-208" 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-208', 'posarg_defaults', 'link-208');">posarg_defaults</a></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-op">*</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">defaults</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="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"> <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">args</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">defaults</tt><tt class="py-op">)</tt> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</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-name">len</tt><tt class="py-op">(</tt><tt class="py-name">defaults</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"> <tt class="py-name">default_val</tt> <tt class="py-op">=</tt> <tt id="link-209" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-209', 'introspect_docs', 'link-118');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">defaults</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="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-210" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-210', 'posarg_defaults', 'link-208');">posarg_defaults</a></tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">+</tt><tt class="py-name">offset</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">default_val</tt> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"> <tt class="py-comment"># If it's a bound method, then strip off the first argument.</tt> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</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">routine</tt><tt class="py-op">,</tt> <tt class="py-name">MethodType</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">routine</tt><tt class="py-op">.</tt><tt class="py-name">im_self</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="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-211" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-211', 'posargs', 'link-203');">posargs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-212" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-212', 'posargs', 'link-203');">posargs</a></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="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-213" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-213', 'posarg_defaults', 'link-208');">posarg_defaults</a></tt> <tt class="py-op">=</tt> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-214" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-214', 'posarg_defaults', 'link-208');">posarg_defaults</a></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="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"> </tt>
<a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"> <tt class="py-comment"># Set the routine's line number.</tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">func</tt><tt class="py-op">,</tt> <tt class="py-string">'func_code'</tt><tt class="py-op">)</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">routine_doc</tt><tt class="py-op">.</tt><tt id="link-215" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.lineno=epydoc.apidoc.RoutineDoc-class.html#lineno"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-215', 'lineno', 'link-215');">lineno</a></tt> <tt class="py-op">=</tt> <tt class="py-name">func</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_firstlineno</tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"> </tt>
<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"> <tt class="py-comment"># [XX] I should probably use UNKNOWN here??</tt> </tt>
<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># dvarrazzo: if '...' is to be changed, also check that</tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># `docstringparser.process_arg_field()` works correctly.</tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># See SF bug #1556024.</tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-216" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-216', 'posargs', 'link-203');">posargs</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'...'</tt><tt class="py-op">]</tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-217" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-217', 'posarg_defaults', 'link-208');">posarg_defaults</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">None</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">routine_doc</tt><tt class="py-op">.</tt><tt id="link-218" class="py-name"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-218', 'kwarg', 'link-202');">kwarg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-219" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-219', 'vararg', 'link-201');">vararg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"> <tt class="py-comment"># Change type, if appropriate.</tt> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</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">routine</tt><tt class="py-op">,</tt> <tt class="py-name">staticmethod</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-220" class="py-name"><a title="epydoc.apidoc.APIDoc.specialize_to" class="py-name" href="#" onclick="return doclink('link-220', 'specialize_to', 'link-95');">specialize_to</a></tt><tt class="py-op">(</tt><tt id="link-221" class="py-name" targets="Class epydoc.apidoc.StaticMethodDoc=epydoc.apidoc.StaticMethodDoc-class.html"><a title="epydoc.apidoc.StaticMethodDoc" class="py-name" href="#" onclick="return doclink('link-221', 'StaticMethodDoc', 'link-221');">StaticMethodDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L471"></a><tt class="py-lineno"> 471</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">routine</tt><tt class="py-op">,</tt> <tt class="py-name">classmethod</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"> <tt class="py-name">routine_doc</tt><tt class="py-op">.</tt><tt id="link-222" class="py-name"><a title="epydoc.apidoc.APIDoc.specialize_to" class="py-name" href="#" onclick="return doclink('link-222', 'specialize_to', 'link-95');">specialize_to</a></tt><tt class="py-op">(</tt><tt id="link-223" class="py-name" targets="Class epydoc.apidoc.ClassMethodDoc=epydoc.apidoc.ClassMethodDoc-class.html"><a title="epydoc.apidoc.ClassMethodDoc" class="py-name" href="#" onclick="return doclink('link-223', 'ClassMethodDoc', 'link-223');">ClassMethodDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">routine_doc</tt> </tt>
</div><a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Property Introspection</tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="introspect_property"></a><div id="introspect_property-def"><a name="L480"></a><tt class="py-lineno"> 480</tt> <a class="py-toggle" href="#" id="introspect_property-toggle" onclick="return toggle('introspect_property');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#introspect_property">introspect_property</a><tt class="py-op">(</tt><tt class="py-param">prop</tt><tt class="py-op">,</tt> <tt class="py-param">prop_doc</tt><tt class="py-op">,</tt> <tt class="py-param">module_name</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="introspect_property-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="introspect_property-expanded"><a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"> <tt class="py-docstring">"""Add API documentation information about the property</tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"><tt class="py-docstring"> C{prop} to C{prop_doc} (specializing it to C{PropertyDoc})."""</tt> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"> <tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-224" class="py-name"><a title="epydoc.apidoc.APIDoc.specialize_to" class="py-name" href="#" onclick="return doclink('link-224', 'specialize_to', 'link-95');">specialize_to</a></tt><tt class="py-op">(</tt><tt id="link-225" class="py-name" targets="Class epydoc.apidoc.PropertyDoc=epydoc.apidoc.PropertyDoc-class.html"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-225', 'PropertyDoc', 'link-225');">PropertyDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"> <tt class="py-comment"># Record the property's docstring.</tt> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-226" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-226', 'docstring', 'link-105');">docstring</a></tt> <tt class="py-op">=</tt> <tt id="link-227" class="py-name"><a title="epydoc.docintrospecter.get_docstring" class="py-name" href="#" onclick="return doclink('link-227', 'get_docstring', 'link-106');">get_docstring</a></tt><tt class="py-op">(</tt><tt class="py-name">prop</tt><tt class="py-op">,</tt> <tt class="py-name">module_name</tt><tt class="py-op">=</tt><tt class="py-name">module_name</tt><tt class="py-op">)</tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"> <tt class="py-comment"># Record the property's access functions.</tt> </tt>
<a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">prop</tt><tt class="py-op">,</tt> <tt class="py-string">'fget'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"> <tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-228" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.fget=epydoc.apidoc.PropertyDoc-class.html#fget"><a title="epydoc.apidoc.PropertyDoc.fget" class="py-name" href="#" onclick="return doclink('link-228', 'fget', 'link-228');">fget</a></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-118');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">prop</tt><tt class="py-op">.</tt><tt id="link-230" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fget" class="py-name" href="#" onclick="return doclink('link-230', 'fget', 'link-228');">fget</a></tt><tt class="py-op">)</tt> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"> <tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-231" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.fset=epydoc.apidoc.PropertyDoc-class.html#fset"><a title="epydoc.apidoc.PropertyDoc.fset" class="py-name" href="#" onclick="return doclink('link-231', 'fset', 'link-231');">fset</a></tt> <tt class="py-op">=</tt> <tt id="link-232" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-232', 'introspect_docs', 'link-118');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">prop</tt><tt class="py-op">.</tt><tt id="link-233" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fset" class="py-name" href="#" onclick="return doclink('link-233', 'fset', 'link-231');">fset</a></tt><tt class="py-op">)</tt> </tt>
<a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"> <tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-234" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.fdel=epydoc.apidoc.PropertyDoc-class.html#fdel"><a title="epydoc.apidoc.PropertyDoc.fdel" class="py-name" href="#" onclick="return doclink('link-234', 'fdel', 'link-234');">fdel</a></tt> <tt class="py-op">=</tt> <tt id="link-235" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-235', 'introspect_docs', 'link-118');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">prop</tt><tt class="py-op">.</tt><tt id="link-236" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fdel" class="py-name" href="#" onclick="return doclink('link-236', 'fdel', 'link-234');">fdel</a></tt><tt class="py-op">)</tt> </tt>
<a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">prop_doc</tt> </tt>
</div><a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Generic Value Introspection</tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="introspect_other"></a><div id="introspect_other-def"><a name="L500"></a><tt class="py-lineno"> 500</tt> <a class="py-toggle" href="#" id="introspect_other-toggle" onclick="return toggle('introspect_other');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#introspect_other">introspect_other</a><tt class="py-op">(</tt><tt class="py-param">val</tt><tt class="py-op">,</tt> <tt class="py-param">val_doc</tt><tt class="py-op">,</tt> <tt class="py-param">module_name</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="introspect_other-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="introspect_other-expanded"><a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"> <tt class="py-docstring">"""Specialize val_doc to a C{GenericValueDoc} and return it."""</tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-237" class="py-name"><a title="epydoc.apidoc.APIDoc.specialize_to" class="py-name" href="#" onclick="return doclink('link-237', 'specialize_to', 'link-95');">specialize_to</a></tt><tt class="py-op">(</tt><tt id="link-238" 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-238', 'GenericValueDoc', 'link-238');">GenericValueDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val_doc</tt> </tt>
</div><a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Helper functions</tt> </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="isclass"></a><div id="isclass-def"><a name="L509"></a><tt class="py-lineno"> 509</tt> <a class="py-toggle" href="#" id="isclass-toggle" onclick="return toggle('isclass');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#isclass">isclass</a><tt class="py-op">(</tt><tt class="py-param">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="isclass-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="isclass-expanded"><a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"><tt class="py-docstring"> Return true if the given object is a class. In particular, return</tt> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"><tt class="py-docstring"> true if object is an instance of C{types.TypeType} or of</tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"><tt class="py-docstring"> C{types.ClassType}. This is used instead of C{inspect.isclass()},</tt> </tt>
<a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"><tt class="py-docstring"> because the latter returns true for objects that are not classes</tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"><tt class="py-docstring"> (in particular, it returns true for any object that has a</tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"><tt class="py-docstring"> C{__bases__} attribute, including objects that define</tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"><tt class="py-docstring"> C{__getattr__} to always return a value).</tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">object</tt><tt class="py-op">,</tt> <tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt id="link-239" class="py-name" targets="Variable epydoc.docintrospecter._CLASS_TYPES=epydoc.docintrospecter-module.html#_CLASS_TYPES"><a title="epydoc.docintrospecter._CLASS_TYPES" class="py-name" href="#" onclick="return doclink('link-239', '_CLASS_TYPES', 'link-239');">_CLASS_TYPES</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"><tt id="link-240" class="py-name"><a title="epydoc.docintrospecter._CLASS_TYPES" class="py-name" href="#" onclick="return doclink('link-240', '_CLASS_TYPES', 'link-239');">_CLASS_TYPES</a></tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">TypeType</tt><tt class="py-op">,</tt> <tt class="py-name">ClassType</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">"""A list of types that should be treated as classes."""</tt> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"> </tt>
<a name="register_class_type"></a><div id="register_class_type-def"><a name="L524"></a><tt class="py-lineno"> 524</tt> <a class="py-toggle" href="#" id="register_class_type-toggle" onclick="return toggle('register_class_type');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#register_class_type">register_class_type</a><tt class="py-op">(</tt><tt class="py-param">typ</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="register_class_type-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="register_class_type-expanded"><a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"> <tt class="py-docstring">"""Add a type to the lists of types that should be treated as</tt> </tt>
<a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"><tt class="py-docstring"> classes. By default, this list contains C{TypeType} and</tt> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"><tt class="py-docstring"> C{ClassType}."""</tt> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"> <tt id="link-241" class="py-name"><a title="epydoc.docintrospecter._CLASS_TYPES" class="py-name" href="#" onclick="return doclink('link-241', '_CLASS_TYPES', 'link-239');">_CLASS_TYPES</a></tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt class="py-name">typ</tt><tt class="py-op">)</tt> </tt>
</div><a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"><tt id="link-242" class="py-name" targets="Variable epydoc.docintrospecter.__future_check_works=epydoc.docintrospecter-module.html#__future_check_works"><a title="epydoc.docintrospecter.__future_check_works" class="py-name" href="#" onclick="return doclink('link-242', '__future_check_works', 'link-242');">__future_check_works</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"> </tt>
<a name="is_future_feature"></a><div id="is_future_feature-def"><a name="L532"></a><tt class="py-lineno"> 532</tt> <a class="py-toggle" href="#" id="is_future_feature-toggle" onclick="return toggle('is_future_feature');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#is_future_feature">is_future_feature</a><tt class="py-op">(</tt><tt class="py-param">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="is_future_feature-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="is_future_feature-expanded"><a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"><tt class="py-docstring"> Return True if C{object} results from a C{from __future__ import feature}</tt> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"><tt class="py-docstring"> statement.</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"> <tt class="py-comment"># Guard from unexpected implementation changes of the __future__ module.</tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">global</tt> <tt id="link-243" class="py-name"><a title="epydoc.docintrospecter.__future_check_works" class="py-name" href="#" onclick="return doclink('link-243', '__future_check_works', 'link-242');">__future_check_works</a></tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-244" class="py-name"><a title="epydoc.docintrospecter.__future_check_works" class="py-name" href="#" onclick="return doclink('link-244', '__future_check_works', 'link-242');">__future_check_works</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="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-245" class="py-name"><a title="epydoc.docintrospecter.__future_check_works" class="py-name" href="#" onclick="return doclink('link-245', '__future_check_works', 'link-242');">__future_check_works</a></tt><tt class="py-op">:</tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">__future__</tt> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">object</tt><tt class="py-op">,</tt> <tt class="py-name">__future__</tt><tt class="py-op">.</tt><tt class="py-name">_Feature</tt><tt class="py-op">)</tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"> <tt id="link-246" class="py-name"><a title="epydoc.docintrospecter.__future_check_works" class="py-name" href="#" onclick="return doclink('link-246', '__future_check_works', 'link-242');">__future_check_works</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</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-keyword">return</tt> <tt id="link-247" class="py-name"><a title="epydoc.docintrospecter.is_future_feature" class="py-name" href="#" onclick="return doclink('link-247', 'is_future_feature', 'link-144');">is_future_feature</a></tt><tt class="py-op">(</tt><tt class="py-name">object</tt><tt class="py-op">)</tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"> <tt id="link-248" class="py-name"><a title="epydoc.docintrospecter.__future_check_works" class="py-name" href="#" onclick="return doclink('link-248', '__future_check_works', 'link-242');">__future_check_works</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"> <tt id="link-249" 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-249', 'log', 'link-4');">log</a></tt><tt class="py-op">.</tt><tt id="link-250" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-250', 'warning', 'link-67');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Troubles inspecting __future__. Python implementation"</tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"> <tt class="py-string">" may have been changed."</tt><tt class="py-op">)</tt> </tt>
<a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"> </tt>
<a name="get_docstring"></a><div id="get_docstring-def"><a name="L555"></a><tt class="py-lineno"> 555</tt> <a class="py-toggle" href="#" id="get_docstring-toggle" onclick="return toggle('get_docstring');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#get_docstring">get_docstring</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">,</tt> <tt class="py-param">module_name</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="get_docstring-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_docstring-expanded"><a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"><tt class="py-docstring"> Return the docstring for the given value; or C{None} if it</tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"><tt class="py-docstring"> does not have a docstring.</tt> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{unicode}</tt> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"> <tt id="link-251" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-251', 'docstring', 'link-105');">docstring</a></tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt id="link-252" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-252', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt class="py-string">'__doc__'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-253" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-253', 'docstring', 'link-105');">docstring</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-254" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-254', 'docstring', 'link-105');">docstring</a></tt><tt class="py-op">,</tt> <tt class="py-name">unicode</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-255" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-255', 'docstring', 'link-105');">docstring</a></tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-256" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-256', 'docstring', 'link-105');">docstring</a></tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</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">try</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt id="link-257" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-257', 'docstring', 'link-105');">docstring</a></tt><tt class="py-op">,</tt> <tt class="py-string">'ascii'</tt><tt class="py-op">)</tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">UnicodeDecodeError</tt><tt class="py-op">:</tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module_name</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"> <tt class="py-name">module_name</tt> <tt class="py-op">=</tt> <tt id="link-258" class="py-name"><a title="epydoc.docintrospecter.get_containing_module" class="py-name" href="#" onclick="return doclink('link-258', 'get_containing_module', 'link-90');">get_containing_module</a></tt><tt class="py-op">(</tt><tt id="link-259" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-259', 'value', 'link-17');">value</a></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">if</tt> <tt class="py-name">module_name</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="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt id="link-260" class="py-name"><a title="epydoc.docintrospecter.get_value_from_name" class="py-name" href="#" onclick="return doclink('link-260', 'get_value_from_name', 'link-21');">get_value_from_name</a></tt><tt class="py-op">(</tt><tt class="py-name">module_name</tt><tt class="py-op">)</tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"> <tt id="link-261" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-261', 'filename', 'link-19');">filename</a></tt> <tt class="py-op">=</tt> <tt id="link-262" class="py-name"><a title="epydoc.util.py_src_filename" class="py-name" href="#" onclick="return doclink('link-262', 'py_src_filename', 'link-102');">py_src_filename</a></tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">__file__</tt><tt class="py-op">)</tt> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"> <tt class="py-name">encoding</tt> <tt class="py-op">=</tt> <tt id="link-263" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-263', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-264" class="py-name"><a title="epydoc.docparser" class="py-name" href="#" onclick="return doclink('link-264', 'docparser', 'link-8');">docparser</a></tt><tt class="py-op">.</tt><tt id="link-265" class="py-name" targets="Function epydoc.docparser.get_module_encoding()=epydoc.docparser-module.html#get_module_encoding"><a title="epydoc.docparser.get_module_encoding" class="py-name" href="#" onclick="return doclink('link-265', 'get_module_encoding', 'link-265');">get_module_encoding</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-19');">filename</a></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">return</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt id="link-267" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-267', 'docstring', 'link-105');">docstring</a></tt><tt class="py-op">,</tt> <tt class="py-name">encoding</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">except</tt> <tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</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-keyword">pass</tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-268" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-268', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt class="py-string">'__name__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt id="link-269" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-269', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-270" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-270', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt id="link-271" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-271', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">repr</tt><tt class="py-op">(</tt><tt id="link-272" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-272', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt id="link-273" 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-273', 'log', 'link-4');">log</a></tt><tt class="py-op">.</tt><tt id="link-274" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-274', 'warning', 'link-67');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s's docstring is not a unicode string, but it "</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"> <tt class="py-string">"contains non-ascii data -- treating it as "</tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"> <tt class="py-string">"latin-1."</tt> <tt class="py-op">%</tt> <tt id="link-275" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-275', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt id="link-276" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-276', 'docstring', 'link-105');">docstring</a></tt><tt class="py-op">,</tt> <tt class="py-string">'latin-1'</tt><tt class="py-op">)</tt> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-277" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-277', 'value', 'link-17');">value</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">BuiltinMethodType</tt><tt class="py-op">:</tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"> <tt class="py-comment"># Don't issue a warning for this special case.</tt> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</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="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-278" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-278', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt class="py-string">'__name__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt id="link-279" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-279', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-280" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-280', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt id="link-281" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-281', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">repr</tt><tt class="py-op">(</tt><tt id="link-282" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-282', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"> <tt id="link-283" 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-283', 'log', 'link-4');">log</a></tt><tt class="py-op">.</tt><tt id="link-284" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-284', 'warning', 'link-67');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s's docstring is not a string -- ignoring it."</tt> <tt class="py-op">%</tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> <tt id="link-285" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-285', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"> </tt>
<a name="get_canonical_name"></a><div id="get_canonical_name-def"><a name="L596"></a><tt class="py-lineno"> 596</tt> <a class="py-toggle" href="#" id="get_canonical_name-toggle" onclick="return toggle('get_canonical_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#get_canonical_name">get_canonical_name</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">,</tt> <tt class="py-param">strict</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_canonical_name-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_canonical_name-expanded"><a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"><tt class="py-docstring"> @return: the canonical name for C{value}, or C{UNKNOWN} if no</tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"><tt class="py-docstring"> canonical name can be found. Currently, C{get_canonical_name}</tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"><tt class="py-docstring"> can find canonical names for: modules; functions; non-nested</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"><tt class="py-docstring"> classes; methods of non-nested classes; and some class methods</tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"><tt class="py-docstring"> of non-nested classes.</tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{DottedName} or C{UNKNOWN}</tt> </tt>
<a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-286" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-286', 'value', 'link-17');">value</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-keyword">return</tt> <tt id="link-287" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-287', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"> <tt class="py-comment"># Get the name via introspection.</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</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 id="link-288" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-288', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">ModuleType</tt><tt class="py-op">)</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">try</tt><tt class="py-op">:</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-289" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-289', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-290" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-290', 'value', 'link-17');">value</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">strict</tt><tt class="py-op">)</tt> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"> <tt class="py-comment"># If the module is shadowed by a variable in its parent</tt> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># package(s), then add a prime mark to the end, to</tt> </tt>
<a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># differentiate it from the variable that shadows it.</tt> </tt>
<a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-291" class="py-name" targets="Function epydoc.docintrospecter.verify_name()=epydoc.docintrospecter-module.html#verify_name"><a title="epydoc.docintrospecter.verify_name" class="py-name" href="#" onclick="return doclink('link-291', 'verify_name', 'link-291');">verify_name</a></tt><tt class="py-op">(</tt><tt id="link-292" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-292', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">dotted_name</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt id="link-293" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-293', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> <tt id="link-294" 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-294', 'log', 'link-4');">log</a></tt><tt class="py-op">.</tt><tt id="link-295" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-295', 'warning', 'link-67');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Module %s is shadowed by a variable with "</tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> <tt class="py-string">"the same name."</tt> <tt class="py-op">%</tt> <tt class="py-name">dotted_name</tt><tt class="py-op">)</tt> </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"> <tt class="py-comment"># Note -- this return bypasses verify_name check:</tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt id="link-296" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-296', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-297" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-297', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">+</tt><tt class="py-string">"'"</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">except</tt> <tt id="link-298" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-298', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-299" class="py-name"><a title="epydoc.apidoc.DottedName.InvalidDottedName" class="py-name" href="#" onclick="return doclink('link-299', 'InvalidDottedName', 'link-76');">InvalidDottedName</a></tt><tt class="py-op">:</tt> </tt>
<a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"> <tt class="py-comment"># Name is not a valid Python identifier -- treat as script.</tt> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-300" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-300', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt class="py-string">'__file__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"> <tt id="link-301" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-301', 'filename', 'link-19');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt id="link-302" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-302', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt id="link-303" class="py-name" targets="Method epydoc.apidoc.DottedName.__str__()=epydoc.apidoc.DottedName-class.html#__str__,Method epydoc.markup.ParseError.__str__()=epydoc.markup.ParseError-class.html#__str__,Method epydoc.markup.epytext.Element.__str__()=epydoc.markup.epytext.Element-class.html#__str__,Method epydoc.markup.epytext.ParsedEpytextDocstring.__str__()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#__str__"><a title="epydoc.apidoc.DottedName.__str__
epydoc.markup.ParseError.__str__
epydoc.markup.epytext.Element.__str__
epydoc.markup.epytext.ParsedEpytextDocstring.__str__" class="py-name" href="#" onclick="return doclink('link-303', '__str__', 'link-303');">__str__</a></tt> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-304" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-304', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-305" class="py-name"><a title="epydoc.util.munge_script_name" class="py-name" href="#" onclick="return doclink('link-305', 'munge_script_name', 'link-41');">munge_script_name</a></tt><tt class="py-op">(</tt><tt id="link-306" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-306', 'filename', 'link-19');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<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 class="py-keyword">elif</tt> <tt id="link-307" class="py-name" targets="Function epydoc.docintrospecter.isclass()=epydoc.docintrospecter-module.html#isclass"><a title="epydoc.docintrospecter.isclass" class="py-name" href="#" onclick="return doclink('link-307', 'isclass', 'link-307');">isclass</a></tt><tt class="py-op">(</tt><tt id="link-308" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-308', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-309" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-309', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__module__</tt> <tt class="py-op">==</tt> <tt class="py-string">'__builtin__'</tt><tt class="py-op">:</tt> </tt>
<a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-310" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-310', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-311" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-311', 'value', 'link-17');">value</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">strict</tt><tt class="py-op">)</tt> </tt>
<a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-312" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-312', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-313" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-313', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__module__</tt><tt class="py-op">,</tt> <tt id="link-314" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-314', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"> <tt class="py-name">strict</tt><tt class="py-op">=</tt><tt class="py-name">strict</tt><tt class="py-op">)</tt> </tt>
<a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">ismethod</tt><tt class="py-op">(</tt><tt id="link-315" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-315', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt id="link-316" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-316', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">im_self</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="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"> <tt id="link-317" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-317', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">im_class</tt> <tt class="py-keyword">is</tt> <tt class="py-name">ClassType</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt id="link-318" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-318', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__name__</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 class="py-comment"># class method.</tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"> <tt class="py-name">class_name</tt> <tt class="py-op">=</tt> <tt id="link-319" class="py-name"><a title="epydoc.docintrospecter.get_canonical_name
epydoc.docwriter.xlink.UrlGenerator.get_canonical_name" class="py-name" href="#" onclick="return doclink('link-319', 'get_canonical_name', 'link-73');">get_canonical_name</a></tt><tt class="py-op">(</tt><tt id="link-320" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-320', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">im_self</tt><tt class="py-op">)</tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">class_name</tt> <tt class="py-keyword">is</tt> <tt id="link-321" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-321', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-322" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-322', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-323" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-323', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">class_name</tt><tt class="py-op">,</tt> <tt id="link-324" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-324', 'value', 'link-17');">value</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">strict</tt><tt class="py-op">)</tt> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">ismethod</tt><tt class="py-op">(</tt><tt id="link-325" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-325', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt id="link-326" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-326', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__name__</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="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"> <tt class="py-name">class_name</tt> <tt class="py-op">=</tt> <tt id="link-327" class="py-name"><a title="epydoc.docintrospecter.get_canonical_name
epydoc.docwriter.xlink.UrlGenerator.get_canonical_name" class="py-name" href="#" onclick="return doclink('link-327', 'get_canonical_name', 'link-73');">get_canonical_name</a></tt><tt class="py-op">(</tt><tt id="link-328" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-328', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">im_class</tt><tt class="py-op">)</tt> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">class_name</tt> <tt class="py-keyword">is</tt> <tt id="link-329" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-329', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-330" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-330', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-331" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-331', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">class_name</tt><tt class="py-op">,</tt> <tt id="link-332" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-332', 'value', 'link-17');">value</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">strict</tt><tt class="py-op">)</tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-333" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-333', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">FunctionType</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt id="link-334" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-334', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__name__</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="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"> <tt class="py-name">module_name</tt> <tt class="py-op">=</tt> <tt id="link-335" class="py-name" targets="Function epydoc.docintrospecter._find_function_module()=epydoc.docintrospecter-module.html#_find_function_module"><a title="epydoc.docintrospecter._find_function_module" class="py-name" href="#" onclick="return doclink('link-335', '_find_function_module', 'link-335');">_find_function_module</a></tt><tt class="py-op">(</tt><tt id="link-336" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-336', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module_name</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 id="link-337" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-337', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-338" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-338', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">module_name</tt><tt class="py-op">,</tt> <tt id="link-339" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-339', 'value', 'link-17');">value</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">strict</tt><tt class="py-op">)</tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"> <tt class="py-keyword">else</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 id="link-340" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-340', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
<a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"> </tt>
<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-341" class="py-name"><a title="epydoc.docintrospecter.verify_name" class="py-name" href="#" onclick="return doclink('link-341', 'verify_name', 'link-291');">verify_name</a></tt><tt class="py-op">(</tt><tt id="link-342" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-342', 'value', 'link-17');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">dotted_name</tt><tt class="py-op">)</tt> </tt>
</div><a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> </tt>
<a name="verify_name"></a><div id="verify_name-def"><a name="L654"></a><tt class="py-lineno"> 654</tt> <a class="py-toggle" href="#" id="verify_name-toggle" onclick="return toggle('verify_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#verify_name">verify_name</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">,</tt> <tt class="py-param">dotted_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="verify_name-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="verify_name-expanded"><a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"><tt class="py-docstring"> Verify the name. E.g., if it's a nested class, then we won't be</tt> </tt>
<a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"><tt class="py-docstring"> able to find it with the name we constructed.</tt> </tt>
<a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">dotted_name</tt> <tt class="py-keyword">is</tt> <tt id="link-343" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-343', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-344" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-344', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
<a name="L660"></a><tt class="py-lineno"> 660</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">dotted_name</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">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">__builtin__</tt><tt class="py-op">,</tt> <tt class="py-name">dotted_name</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>
<a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">dotted_name</tt> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> <tt class="py-name">named_value</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">modules</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</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="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">named_value</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 id="link-345" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-345', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
<a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">identifier</tt> <tt class="py-keyword">in</tt> <tt class="py-name">dotted_name</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>
<a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">named_value</tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">named_value</tt><tt class="py-op">,</tt> <tt class="py-name">identifier</tt><tt class="py-op">)</tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-346" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-346', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-347" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-347', 'value', 'link-17');">value</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">named_value</tt><tt class="py-op">:</tt> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">dotted_name</tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-348" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-348', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
</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"># [xx] not used:</tt> </tt>
<a name="value_repr"></a><div id="value_repr-def"><a name="L673"></a><tt class="py-lineno"> 673</tt> <a class="py-toggle" href="#" id="value_repr-toggle" onclick="return toggle('value_repr');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#value_repr">value_repr</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="value_repr-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="value_repr-expanded"><a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">'%r'</tt> <tt class="py-op">%</tt> <tt id="link-349" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-349', 'value', 'link-17');">value</a></tt> </tt>
<a name="L676"></a><tt class="py-lineno"> 676</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">s</tt><tt class="py-op">,</tt> <tt class="py-name">str</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-name">s</tt> <tt class="py-op">=</tt> <tt id="link-350" class="py-name" targets="Function epydoc.util.decode_with_backslashreplace()=epydoc.util-module.html#decode_with_backslashreplace"><a title="epydoc.util.decode_with_backslashreplace" class="py-name" href="#" onclick="return doclink('link-350', 'decode_with_backslashreplace', 'link-350');">decode_with_backslashreplace</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
<a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-351" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-351', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt> </tt>
</div><a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"> </tt>
<a name="get_containing_module"></a><div id="get_containing_module-def"><a name="L682"></a><tt class="py-lineno"> 682</tt> <a class="py-toggle" href="#" id="get_containing_module-toggle" onclick="return toggle('get_containing_module');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#get_containing_module">get_containing_module</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_containing_module-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_containing_module-expanded"><a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"><tt class="py-docstring"> Return the name of the module containing the given value, or</tt> </tt>
<a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"><tt class="py-docstring"> C{None} if the module name can't be determined.</tt> </tt>
<a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{DottedName}</tt> </tt>
<a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">ismodule</tt><tt class="py-op">(</tt><tt id="link-352" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-352', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-353" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-353', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-354" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-354', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-355" class="py-name"><a title="epydoc.docintrospecter.isclass" class="py-name" href="#" onclick="return doclink('link-355', 'isclass', 'link-307');">isclass</a></tt><tt class="py-op">(</tt><tt id="link-356" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-356', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-357" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-357', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-358" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-358', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">__module__</tt><tt class="py-op">)</tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">ismethod</tt><tt class="py-op">(</tt><tt id="link-359" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-359', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt id="link-360" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-360', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">im_self</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="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"> <tt id="link-361" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-361', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">im_class</tt> <tt class="py-keyword">is</tt> <tt class="py-name">ClassType</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-comment"># class method.</tt> </tt>
<a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-362" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-362', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-363" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-363', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">im_self</tt><tt class="py-op">.</tt><tt class="py-name">__module__</tt><tt class="py-op">)</tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">ismethod</tt><tt class="py-op">(</tt><tt id="link-364" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-364', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-365" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-365', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-366" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-366', 'value', 'link-17');">value</a></tt><tt class="py-op">.</tt><tt class="py-name">im_class</tt><tt class="py-op">.</tt><tt class="py-name">__module__</tt><tt class="py-op">)</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">isroutine</tt><tt class="py-op">(</tt><tt id="link-367" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-367', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt id="link-368" class="py-name"><a title="epydoc.docintrospecter._find_function_module" class="py-name" href="#" onclick="return doclink('link-368', '_find_function_module', 'link-335');">_find_function_module</a></tt><tt class="py-op">(</tt><tt id="link-369" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-369', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module</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">None</tt> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-370" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-370', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">)</tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> </tt>
<a name="_find_function_module"></a><div id="_find_function_module-def"><a name="L704"></a><tt class="py-lineno"> 704</tt> <a class="py-toggle" href="#" id="_find_function_module-toggle" onclick="return toggle('_find_function_module');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#_find_function_module">_find_function_module</a><tt class="py-op">(</tt><tt class="py-param">func</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_find_function_module-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_find_function_module-expanded"><a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"><tt class="py-docstring"> @return: The module that defines the given function.</tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{module}</tt> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"><tt class="py-docstring"> @param func: The function whose module should be found.</tt> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"><tt class="py-docstring"> @type func: C{function}</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</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">func</tt><tt class="py-op">,</tt> <tt class="py-string">'__module__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">func</tt><tt class="py-op">.</tt><tt class="py-name">__module__</tt> </tt>
<a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">getmodule</tt><tt class="py-op">(</tt><tt class="py-name">func</tt><tt class="py-op">)</tt> </tt>
<a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
<a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-comment"># This fallback shouldn't usually be needed. But it is needed in</tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># a couple special cases (including using epydoc to document</tt> </tt>
<a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># itself). In particular, if a module gets loaded twice, using</tt> </tt>
<a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># two different names for the same file, then this helps.</tt> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">module</tt> <tt class="py-keyword">in</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">modules</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="L724"></a><tt class="py-lineno"> 724</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">module</tt><tt class="py-op">,</tt> <tt class="py-string">'__dict__'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">func</tt><tt class="py-op">,</tt> <tt class="py-string">'func_globals'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"> <tt class="py-name">func</tt><tt class="py-op">.</tt><tt class="py-name">func_globals</tt> <tt class="py-keyword">is</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Introspection Dispatch Table</tt> </tt>
<a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"><tt id="link-371" class="py-name" targets="Variable epydoc.docintrospecter._introspecter_registry=epydoc.docintrospecter-module.html#_introspecter_registry"><a title="epydoc.docintrospecter._introspecter_registry" class="py-name" href="#" onclick="return doclink('link-371', '_introspecter_registry', 'link-371');">_introspecter_registry</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="register_introspecter"></a><div id="register_introspecter-def"><a name="L735"></a><tt class="py-lineno"> 735</tt> <a class="py-toggle" href="#" id="register_introspecter-toggle" onclick="return toggle('register_introspecter');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#register_introspecter">register_introspecter</a><tt class="py-op">(</tt><tt class="py-param">applicability_test</tt><tt class="py-op">,</tt> <tt class="py-param">introspecter</tt><tt class="py-op">,</tt> <tt class="py-param">priority</tt><tt class="py-op">=</tt><tt class="py-number">10</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="register_introspecter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="register_introspecter-expanded"><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"> Register an introspecter function. Introspecter functions take</tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"><tt class="py-docstring"> two arguments, a python value and a C{ValueDoc} object, and should</tt> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"><tt class="py-docstring"> add information about the given value to the the C{ValueDoc}.</tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"><tt class="py-docstring"> Usually, the first line of an inspecter function will specialize</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"><tt class="py-docstring"> it to a sublass of C{ValueDoc}, using L{ValueDoc.specialize_to()}:</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"><tt class="py-docstring"> >>> def typical_introspecter(value, value_doc):</tt> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"><tt class="py-docstring"> ... value_doc.specialize_to(SomeSubclassOfValueDoc)</tt> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"><tt class="py-docstring"> ... <add info to value_doc></tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"><tt class="py-docstring"> @param priority: The priority of this introspecter, which determines</tt> </tt>
<a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"><tt class="py-docstring"> the order in which introspecters are tried -- introspecters with lower</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"><tt class="py-docstring"> numbers are tried first. The standard introspecters have priorities</tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"><tt class="py-docstring"> ranging from 20 to 30. The default priority (10) will place new</tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"><tt class="py-docstring"> introspecters before standard introspecters.</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"> <tt id="link-372" class="py-name"><a title="epydoc.docintrospecter._introspecter_registry" class="py-name" href="#" onclick="return doclink('link-372', '_introspecter_registry', 'link-371');">_introspecter_registry</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">priority</tt><tt class="py-op">,</tt> <tt class="py-name">applicability_test</tt><tt class="py-op">,</tt> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"> <tt class="py-name">introspecter</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"> <tt id="link-373" class="py-name"><a title="epydoc.docintrospecter._introspecter_registry" class="py-name" href="#" onclick="return doclink('link-373', '_introspecter_registry', 'link-371');">_introspecter_registry</a></tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"> </tt>
<a name="_get_introspecter"></a><div id="_get_introspecter-def"><a name="L757"></a><tt class="py-lineno"> 757</tt> <a class="py-toggle" href="#" id="_get_introspecter-toggle" onclick="return toggle('_get_introspecter');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#_get_introspecter">_get_introspecter</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_get_introspecter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_get_introspecter-expanded"><a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">priority</tt><tt class="py-op">,</tt> <tt class="py-name">applicability_test</tt><tt class="py-op">,</tt> <tt class="py-name">introspecter</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt id="link-374" class="py-name"><a title="epydoc.docintrospecter._introspecter_registry" class="py-name" href="#" onclick="return doclink('link-374', '_introspecter_registry', 'link-371');">_introspecter_registry</a></tt><tt class="py-op">:</tt> </tt>
<a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">applicability_test</tt><tt class="py-op">(</tt><tt id="link-375" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-375', 'value', 'link-17');">value</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">introspecter</tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-376" class="py-name" targets="Function epydoc.docintrospecter.introspect_other()=epydoc.docintrospecter-module.html#introspect_other"><a title="epydoc.docintrospecter.introspect_other" class="py-name" href="#" onclick="return doclink('link-376', 'introspect_other', 'link-376');">introspect_other</a></tt> </tt>
</div><a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"><tt class="py-comment"># Register the standard introspecter functions.</tt> </tt>
<a name="is_classmethod"></a><div id="is_classmethod-def"><a name="L765"></a><tt class="py-lineno"> 765</tt> <a class="py-toggle" href="#" id="is_classmethod-toggle" onclick="return toggle('is_classmethod');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#is_classmethod">is_classmethod</a><tt class="py-op">(</tt><tt class="py-param">v</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-377" class="py-name" targets="Variable epydoc.markup.restructuredtext._EpydocReader.v=epydoc.markup.restructuredtext._EpydocReader-class.html#v"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-377', 'v', 'link-377');">v</a></tt><tt class="py-op">,</tt> <tt class="py-name">classmethod</tt><tt class="py-op">)</tt> </tt>
</div><a name="is_staticmethod"></a><div id="is_staticmethod-def"><a name="L766"></a><tt class="py-lineno"> 766</tt> <a class="py-toggle" href="#" id="is_staticmethod-toggle" onclick="return toggle('is_staticmethod');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#is_staticmethod">is_staticmethod</a><tt class="py-op">(</tt><tt class="py-param">v</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-378" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-378', 'v', 'link-377');">v</a></tt><tt class="py-op">,</tt> <tt class="py-name">staticmethod</tt><tt class="py-op">)</tt> </tt>
</div><a name="is_property"></a><div id="is_property-def"><a name="L767"></a><tt class="py-lineno"> 767</tt> <a class="py-toggle" href="#" id="is_property-toggle" onclick="return toggle('is_property');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#is_property">is_property</a><tt class="py-op">(</tt><tt class="py-param">v</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-379" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-379', 'v', 'link-377');">v</a></tt><tt class="py-op">,</tt> <tt class="py-name">property</tt><tt class="py-op">)</tt> </tt>
</div><a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"><tt id="link-380" class="py-name" targets="Function epydoc.docintrospecter.register_introspecter()=epydoc.docintrospecter-module.html#register_introspecter"><a title="epydoc.docintrospecter.register_introspecter" class="py-name" href="#" onclick="return doclink('link-380', 'register_introspecter', 'link-380');">register_introspecter</a></tt><tt class="py-op">(</tt><tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">ismodule</tt><tt class="py-op">,</tt> <tt id="link-381" class="py-name"><a title="epydoc.docintrospecter.introspect_module" class="py-name" href="#" onclick="return doclink('link-381', 'introspect_module', 'link-87');">introspect_module</a></tt><tt class="py-op">,</tt> <tt class="py-name">priority</tt><tt class="py-op">=</tt><tt class="py-number">20</tt><tt class="py-op">)</tt> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"><tt id="link-382" class="py-name"><a title="epydoc.docintrospecter.register_introspecter" class="py-name" href="#" onclick="return doclink('link-382', 'register_introspecter', 'link-380');">register_introspecter</a></tt><tt class="py-op">(</tt><tt id="link-383" class="py-name"><a title="epydoc.docintrospecter.isclass" class="py-name" href="#" onclick="return doclink('link-383', 'isclass', 'link-307');">isclass</a></tt><tt class="py-op">,</tt> <tt id="link-384" class="py-name" targets="Function epydoc.docintrospecter.introspect_class()=epydoc.docintrospecter-module.html#introspect_class"><a title="epydoc.docintrospecter.introspect_class" class="py-name" href="#" onclick="return doclink('link-384', 'introspect_class', 'link-384');">introspect_class</a></tt><tt class="py-op">,</tt> <tt class="py-name">priority</tt><tt class="py-op">=</tt><tt class="py-number">24</tt><tt class="py-op">)</tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"><tt id="link-385" class="py-name"><a title="epydoc.docintrospecter.register_introspecter" class="py-name" href="#" onclick="return doclink('link-385', 'register_introspecter', 'link-380');">register_introspecter</a></tt><tt class="py-op">(</tt><tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">isroutine</tt><tt class="py-op">,</tt> <tt id="link-386" class="py-name" targets="Function epydoc.docintrospecter.introspect_routine()=epydoc.docintrospecter-module.html#introspect_routine"><a title="epydoc.docintrospecter.introspect_routine" class="py-name" href="#" onclick="return doclink('link-386', 'introspect_routine', 'link-386');">introspect_routine</a></tt><tt class="py-op">,</tt> <tt class="py-name">priority</tt><tt class="py-op">=</tt><tt class="py-number">28</tt><tt class="py-op">)</tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"><tt id="link-387" class="py-name"><a title="epydoc.docintrospecter.register_introspecter" class="py-name" href="#" onclick="return doclink('link-387', 'register_introspecter', 'link-380');">register_introspecter</a></tt><tt class="py-op">(</tt><tt id="link-388" class="py-name" targets="Function epydoc.docintrospecter.is_property()=epydoc.docintrospecter-module.html#is_property"><a title="epydoc.docintrospecter.is_property" class="py-name" href="#" onclick="return doclink('link-388', 'is_property', 'link-388');">is_property</a></tt><tt class="py-op">,</tt> <tt id="link-389" class="py-name" targets="Function epydoc.docintrospecter.introspect_property()=epydoc.docintrospecter-module.html#introspect_property"><a title="epydoc.docintrospecter.introspect_property" class="py-name" href="#" onclick="return doclink('link-389', 'introspect_property', 'link-389');">introspect_property</a></tt><tt class="py-op">,</tt> <tt class="py-name">priority</tt><tt class="py-op">=</tt><tt class="py-number">30</tt><tt class="py-op">)</tt> </tt>
<a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"><tt class="py-comment"># Register getset_descriptor as a property</tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">array</tt> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"> <tt class="py-name">getset_type</tt> <tt class="py-op">=</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">array</tt><tt class="py-op">.</tt><tt class="py-name">array</tt><tt class="py-op">.</tt><tt class="py-name">typecode</tt><tt class="py-op">)</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">array</tt> </tt>
<a name="is_getset"></a><div id="is_getset-def"><a name="L778"></a><tt class="py-lineno"> 778</tt> <a class="py-toggle" href="#" id="is_getset-toggle" onclick="return toggle('is_getset');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#is_getset">is_getset</a><tt class="py-op">(</tt><tt class="py-param">v</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-390" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-390', 'v', 'link-377');">v</a></tt><tt class="py-op">,</tt> <tt class="py-name">getset_type</tt><tt class="py-op">)</tt> </tt>
</div><a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"> <tt id="link-391" class="py-name"><a title="epydoc.docintrospecter.register_introspecter" class="py-name" href="#" onclick="return doclink('link-391', 'register_introspecter', 'link-380');">register_introspecter</a></tt><tt class="py-op">(</tt><tt id="link-392" class="py-name" targets="Function epydoc.docintrospecter.is_getset()=epydoc.docintrospecter-module.html#is_getset"><a title="epydoc.docintrospecter.is_getset" class="py-name" href="#" onclick="return doclink('link-392', 'is_getset', 'link-392');">is_getset</a></tt><tt class="py-op">,</tt> <tt id="link-393" class="py-name"><a title="epydoc.docintrospecter.introspect_property" class="py-name" href="#" onclick="return doclink('link-393', 'introspect_property', 'link-389');">introspect_property</a></tt><tt class="py-op">,</tt> <tt class="py-name">priority</tt><tt class="py-op">=</tt><tt class="py-number">32</tt><tt class="py-op">)</tt> </tt>
<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"><tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"><tt class="py-comment"># Register member_descriptor as a property</tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">datetime</tt> </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> <tt class="py-name">member_type</tt> <tt class="py-op">=</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">timedelta</tt><tt class="py-op">.</tt><tt class="py-name">days</tt><tt class="py-op">)</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">datetime</tt> </tt>
<a name="is_member"></a><div id="is_member-def"><a name="L788"></a><tt class="py-lineno"> 788</tt> <a class="py-toggle" href="#" id="is_member-toggle" onclick="return toggle('is_member');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#is_member">is_member</a><tt class="py-op">(</tt><tt class="py-param">v</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-394" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-394', 'v', 'link-377');">v</a></tt><tt class="py-op">,</tt> <tt class="py-name">member_type</tt><tt class="py-op">)</tt> </tt>
</div><a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"> <tt id="link-395" class="py-name"><a title="epydoc.docintrospecter.register_introspecter" class="py-name" href="#" onclick="return doclink('link-395', 'register_introspecter', 'link-380');">register_introspecter</a></tt><tt class="py-op">(</tt><tt id="link-396" class="py-name" targets="Function epydoc.docintrospecter.is_member()=epydoc.docintrospecter-module.html#is_member"><a title="epydoc.docintrospecter.is_member" class="py-name" href="#" onclick="return doclink('link-396', 'is_member', 'link-396');">is_member</a></tt><tt class="py-op">,</tt> <tt id="link-397" class="py-name"><a title="epydoc.docintrospecter.introspect_property" class="py-name" href="#" onclick="return doclink('link-397', 'introspect_property', 'link-389');">introspect_property</a></tt><tt class="py-op">,</tt> <tt class="py-name">priority</tt><tt class="py-op">=</tt><tt class="py-number">34</tt><tt class="py-op">)</tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"><tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Import support</tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="get_value_from_filename"></a><div id="get_value_from_filename-def"><a name="L797"></a><tt class="py-lineno"> 797</tt> <a class="py-toggle" href="#" id="get_value_from_filename-toggle" onclick="return toggle('get_value_from_filename');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#get_value_from_filename">get_value_from_filename</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">context</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="get_value_from_filename-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_value_from_filename-expanded"><a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"> <tt class="py-comment"># Normalize the filename.</tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-398" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-398', 'filename', 'link-19');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-399" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-399', '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-400" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-400', '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-401" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-401', 'filename', 'link-19');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> <tt class="py-comment"># Divide the filename into a base directory and a name. (For</tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># packages, use the package's parent directory as the base, and</tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the directory name as its name).</tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">basedir</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-402" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-402', '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-403" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-403', 'filename', 'link-19');">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="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"> <tt id="link-404" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-404', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-405" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-405', '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-406" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-406', '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-407" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-407', 'filename', 'link-19');">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="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-408" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-408', 'name', 'link-18');">name</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'__init__'</tt><tt class="py-op">:</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"> <tt class="py-name">basedir</tt><tt class="py-op">,</tt> <tt id="link-409" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-409', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-410" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-410', '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">basedir</tt><tt class="py-op">)</tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> <tt id="link-411" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-411', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-412" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-412', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-413" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-413', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"> </tt>
<a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> <tt class="py-comment"># If the context wasn't provided, then check if the file is in a</tt> </tt>
<a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># package directory. If so, then update basedir & name to contain</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"># the topmost package's directory and the fully qualified name for</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"># this file. (This update assume the default value of __path__</tt> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># for the parent packages; if the parent packages override their</tt> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># __path__s, then this can cause us not to find the value.)</tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">context</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt id="link-414" 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-414', 'is_package_dir', 'link-414');">is_package_dir</a></tt><tt class="py-op">(</tt><tt class="py-name">basedir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"> <tt class="py-name">basedir</tt><tt class="py-op">,</tt> <tt class="py-name">pkg_name</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-415" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-415', '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">basedir</tt><tt class="py-op">)</tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"> <tt id="link-416" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-416', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-417" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-417', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">pkg_name</tt><tt class="py-op">,</tt> <tt id="link-418" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-418', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"> <tt class="py-comment"># If a parent package was specified, then find the directory of</tt> </tt>
<a name="L822"></a><tt class="py-lineno"> 822</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the topmost package, and the fully qualified name for this file.</tt> </tt>
<a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">context</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="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"> <tt class="py-comment"># Combine the name.</tt> </tt>
<a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-419" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-419', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-420" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-420', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">context</tt><tt class="py-op">.</tt><tt id="link-421" 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-421', 'canonical_name', 'link-39');">canonical_name</a></tt><tt class="py-op">,</tt> <tt id="link-422" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-422', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"> <tt class="py-comment"># Find the directory of the base package.</tt> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">while</tt> <tt class="py-name">context</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-423" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-423', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"> <tt class="py-name">pkg_dir</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-424" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-424', '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">context</tt><tt class="py-op">.</tt><tt id="link-425" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-425', 'filename', 'link-19');">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="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"> <tt class="py-name">basedir</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-426" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-426', '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_dir</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="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"> <tt class="py-name">context</tt> <tt class="py-op">=</tt> <tt class="py-name">context</tt><tt class="py-op">.</tt><tt id="link-427" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-427', 'package', 'link-115');">package</a></tt> </tt>
<a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> </tt>
<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"> <tt class="py-comment"># Import the module. (basedir is the directory of the module's</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># topmost package, or its own directory if it's not in a package;</tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># and name is the fully qualified dotted name for the module.)</tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">old_sys_path</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt id="link-428" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-428', 'path', 'link-0');">path</a></tt><tt class="py-op">[</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">try</tt><tt class="py-op">:</tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt id="link-429" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-429', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">insert</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">basedir</tt><tt class="py-op">)</tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"> <tt class="py-comment"># This will make sure that we get the module itself, even</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># if it is shadowed by a variable. (E.g., curses.wrapper):</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-430" class="py-name" targets="Function epydoc.docintrospecter._import()=epydoc.docintrospecter-module.html#_import,Method epydoc.docwriter.html.HTMLWriter._import()=epydoc.docwriter.html.HTMLWriter-class.html#_import"><a title="epydoc.docintrospecter._import
epydoc.docwriter.html.HTMLWriter._import" class="py-name" href="#" onclick="return doclink('link-430', '_import', 'link-430');">_import</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-431" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-431', 'name', 'link-18');">name</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-keyword">if</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-432" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-432', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">modules</tt><tt class="py-op">:</tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">modules</tt><tt class="py-op">[</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-433" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-433', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"> <tt class="py-comment"># Use this as a fallback -- it *shouldn't* ever be needed.</tt> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt id="link-434" class="py-name"><a title="epydoc.docintrospecter.get_value_from_name" class="py-name" href="#" onclick="return doclink('link-434', 'get_value_from_name', 'link-21');">get_value_from_name</a></tt><tt class="py-op">(</tt><tt id="link-435" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-435', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> <tt class="py-name">sys</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-name">old_sys_path</tt> </tt>
</div><a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"> </tt>
<a name="get_value_from_scriptname"></a><div id="get_value_from_scriptname-def"><a name="L849"></a><tt class="py-lineno"> 849</tt> <a class="py-toggle" href="#" id="get_value_from_scriptname-toggle" onclick="return toggle('get_value_from_scriptname');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#get_value_from_scriptname">get_value_from_scriptname</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_value_from_scriptname-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_value_from_scriptname-expanded"><a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"> <tt id="link-437" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-437', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-438" class="py-name"><a title="epydoc.util.munge_script_name" class="py-name" href="#" onclick="return doclink('link-438', 'munge_script_name', 'link-41');">munge_script_name</a></tt><tt class="py-op">(</tt><tt id="link-439" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-439', 'filename', 'link-19');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-440" class="py-name"><a title="epydoc.docintrospecter._import
epydoc.docwriter.html.HTMLWriter._import" class="py-name" href="#" onclick="return doclink('link-440', '_import', 'link-430');">_import</a></tt><tt class="py-op">(</tt><tt id="link-441" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-441', 'name', 'link-18');">name</a></tt><tt class="py-op">,</tt> <tt id="link-442" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-442', 'filename', 'link-19');">filename</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"> </tt>
<a name="get_value_from_name"></a><div id="get_value_from_name-def"><a name="L853"></a><tt class="py-lineno"> 853</tt> <a class="py-toggle" href="#" id="get_value_from_name-toggle" onclick="return toggle('get_value_from_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#get_value_from_name">get_value_from_name</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">globs</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="get_value_from_name-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_value_from_name-expanded"><a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"><tt class="py-docstring"> Given a name, return the corresponding value.</tt> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"><tt class="py-docstring"> @param globs: A namespace to check for the value, if there is no</tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"><tt class="py-docstring"> module containing the named value. Defaults to __builtin__.</tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"> <tt id="link-443" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-443', 'name', 'link-18');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-444" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-444', 'DottedName', 'link-22');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-445" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-445', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> </tt>
<a name="L862"></a><tt class="py-lineno"> 862</tt> <tt class="py-line"> <tt class="py-comment"># Import the topmost module/package. If we fail, then check if</tt> </tt>
<a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the requested name refers to a builtin.</tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt id="link-446" class="py-name"><a title="epydoc.docintrospecter._import
epydoc.docwriter.html.HTMLWriter._import" class="py-name" href="#" onclick="return doclink('link-446', '_import', 'link-430');">_import</a></tt><tt class="py-op">(</tt><tt id="link-447" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-447', 'name', 'link-18');">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>
<a name="L866"></a><tt class="py-lineno"> 866</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="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">globs</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">globs</tt> <tt class="py-op">=</tt> <tt class="py-name">__builtin__</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-448" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-448', 'name', 'link-18');">name</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt class="py-name">globs</tt><tt class="py-op">:</tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-449" class="py-name" targets="Function epydoc.docintrospecter._lookup()=epydoc.docintrospecter-module.html#_lookup"><a title="epydoc.docintrospecter._lookup" class="py-name" href="#" onclick="return doclink('link-449', '_lookup', 'link-449');">_lookup</a></tt><tt class="py-op">(</tt><tt class="py-name">globs</tt><tt class="py-op">[</tt><tt id="link-450" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-450', 'name', 'link-18');">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-op">,</tt> <tt id="link-451" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-451', 'name', 'link-18');">name</a></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>
<a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt class="py-name">e</tt> </tt>
<a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"> <tt class="py-comment"># Find the requested value in the module/package or its submodules.</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">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 id="link-452" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-452', 'name', 'link-18');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-453" class="py-name"><a title="epydoc.docintrospecter._lookup" class="py-name" href="#" onclick="return doclink('link-453', '_lookup', 'link-449');">_lookup</a></tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">,</tt> <tt id="link-454" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-454', 'name', 'link-18');">name</a></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>
<a name="L877"></a><tt class="py-lineno"> 877</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-keyword">pass</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt id="link-455" class="py-name"><a title="epydoc.docintrospecter._import
epydoc.docwriter.html.HTMLWriter._import" class="py-name" href="#" onclick="return doclink('link-455', '_import', 'link-430');">_import</a></tt><tt class="py-op">(</tt><tt class="py-string">'.'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-456" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-456', 'name', 'link-18');">name</a></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-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt id="link-457" class="py-name"><a title="epydoc.docintrospecter._lookup" class="py-name" href="#" onclick="return doclink('link-457', '_lookup', 'link-449');">_lookup</a></tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">,</tt> <tt id="link-458" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-458', 'name', 'link-18');">name</a></tt><tt class="py-op">[</tt><tt class="py-number">1</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="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">module</tt> </tt>
</div><a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"> </tt>
<a name="_lookup"></a><div id="_lookup-def"><a name="L882"></a><tt class="py-lineno"> 882</tt> <a class="py-toggle" href="#" id="_lookup-toggle" onclick="return toggle('_lookup');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#_lookup">_lookup</a><tt class="py-op">(</tt><tt class="py-param">module</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="_lookup-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_lookup-expanded"><a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"> <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">module</tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</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">identifier</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt id="link-459" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-459', 'name', 'link-18');">name</a></tt><tt class="py-op">)</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">try</tt><tt class="py-op">:</tt> <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">val</tt><tt class="py-op">,</tt> <tt class="py-name">identifier</tt><tt class="py-op">)</tt> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"> <tt class="py-name">exc_msg</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'no variable named %s in %s'</tt> <tt class="py-op">%</tt> </tt>
<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">,</tt> <tt class="py-string">'.'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-460" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-460', 'name', 'link-18');">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-name">i</tt><tt class="py-op">]</tt><tt class="py-op">)</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-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">(</tt><tt class="py-name">exc_msg</tt><tt class="py-op">)</tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val</tt> </tt>
</div><a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"> </tt>
<a name="_import"></a><div id="_import-def"><a name="L892"></a><tt class="py-lineno"> 892</tt> <a class="py-toggle" href="#" id="_import-toggle" onclick="return toggle('_import');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#_import">_import</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">filename</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="_import-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_import-expanded"><a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"><tt class="py-docstring"> Run the given callable in a 'sandboxed' environment.</tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"><tt class="py-docstring"> Currently, this includes saving and restoring the contents of</tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"><tt class="py-docstring"> sys and __builtins__; and suppressing stdin, stdout, and stderr.</tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"> <tt class="py-comment"># Note that we just do a shallow copy of sys. In particular,</tt> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># any changes made to sys.modules will be kept. But we do</tt> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># explicitly store sys.path.</tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">old_sys</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</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">old_sys_path</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt id="link-461" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-461', 'path', 'link-0');">path</a></tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"> <tt class="py-name">old_builtins</tt> <tt class="py-op">=</tt> <tt class="py-name">__builtin__</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"> <tt class="py-comment"># Add the current directory to sys.path, in case they're trying to</tt> </tt>
<a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># import a module by name that resides in the current directory.</tt> </tt>
<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># But add it to the end -- otherwise, the explicit directory added</tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># in get_value_from_filename might get overwritten</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt id="link-462" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-462', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">''</tt><tt class="py-op">)</tt> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"> <tt class="py-comment"># Suppress input and output. (These get restored when we restore</tt> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># sys to old_sys). </tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stdin</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stderr</tt> <tt class="py-op">=</tt> <tt id="link-463" class="py-name" targets="Variable epydoc.docintrospecter._dev_null=epydoc.docintrospecter-module.html#_dev_null"><a title="epydoc.docintrospecter._dev_null" class="py-name" href="#" onclick="return doclink('link-463', '_dev_null', 'link-463');">_dev_null</a></tt> </tt>
<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">__stdin__</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">__stdout__</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">__stderr__</tt> <tt class="py-op">=</tt> <tt id="link-464" class="py-name"><a title="epydoc.docintrospecter._dev_null" class="py-name" href="#" onclick="return doclink('link-464', '_dev_null', 'link-463');">_dev_null</a></tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"> <tt class="py-comment"># Remove any command-line arguments</tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">argv</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'(imported)'</tt><tt class="py-op">]</tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-465" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-465', 'filename', 'link-19');">filename</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">__import__</tt><tt class="py-op">(</tt><tt id="link-466" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-466', 'name', 'link-18');">name</a></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">else</tt><tt class="py-op">:</tt> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"> <tt class="py-comment"># For importing scripts:</tt> </tt>
<a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">imp</tt><tt class="py-op">.</tt><tt class="py-name">load_source</tt><tt class="py-op">(</tt><tt id="link-467" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-467', 'name', 'link-18');">name</a></tt><tt class="py-op">,</tt> <tt id="link-468" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-468', 'filename', 'link-19');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"> <tt class="py-keyword">except</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">exc_typ</tt><tt class="py-op">,</tt> <tt class="py-name">exc_val</tt><tt class="py-op">,</tt> <tt class="py-name">exc_tb</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">exc_info</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">exc_val</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</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">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">exc_typ</tt><tt class="py-op">,</tt><tt class="py-op">)</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">'%s: %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">exc_typ</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> <tt class="py-name">exc_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-keyword">if</tt> <tt class="py-name">exc_tb</tt><tt class="py-op">.</tt><tt class="py-name">tb_next</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="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">+=</tt> <tt class="py-string">' (line %d)'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">exc_tb</tt><tt class="py-op">.</tt><tt class="py-name">tb_next</tt><tt class="py-op">.</tt><tt class="py-name">tb_lineno</tt><tt class="py-op">,</tt><tt class="py-op">)</tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">)</tt> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"> <tt class="py-comment"># Restore the important values that we saved.</tt> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">__builtin__</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt id="link-469" class="py-name"><a title="epydoc.docwriter.xlink.DocUrlGenerator.clear
epydoc.gui.GUILogger.clear" class="py-name" href="#" onclick="return doclink('link-469', 'clear', 'link-14');">clear</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"> <tt class="py-name">__builtin__</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">old_builtins</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">sys</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt id="link-470" class="py-name"><a title="epydoc.docwriter.xlink.DocUrlGenerator.clear
epydoc.gui.GUILogger.clear" class="py-name" href="#" onclick="return doclink('link-470', 'clear', 'link-14');">clear</a></tt><tt class="py-op">(</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">sys</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">old_sys</tt><tt class="py-op">)</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt id="link-471" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-471', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-name">old_sys_path</tt> </tt>
</div><a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"> </tt>
<a name="introspect_docstring_lineno"></a><div id="introspect_docstring_lineno-def"><a name="L944"></a><tt class="py-lineno"> 944</tt> <a class="py-toggle" href="#" id="introspect_docstring_lineno-toggle" onclick="return toggle('introspect_docstring_lineno');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#introspect_docstring_lineno">introspect_docstring_lineno</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="introspect_docstring_lineno-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="introspect_docstring_lineno-expanded"><a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"><tt class="py-docstring"> Try to determine the line number on which the given item's</tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"><tt class="py-docstring"> docstring begins. Return the line number, or C{None} if the line</tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"><tt class="py-docstring"> number can't be determined. The line number of the first line in</tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"><tt class="py-docstring"> the file is 1.</tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-472" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docstring_lineno=epydoc.apidoc.APIDoc-class.html#docstring_lineno"><a title="epydoc.apidoc.APIDoc.docstring_lineno" class="py-name" href="#" onclick="return doclink('link-472', 'docstring_lineno', 'link-472');">docstring_lineno</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-473" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-473', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-474" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring_lineno" class="py-name" href="#" onclick="return doclink('link-474', 'docstring_lineno', 'link-472');">docstring_lineno</a></tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</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">api_doc</tt><tt class="py-op">,</tt> <tt id="link-475" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-475', 'ValueDoc', 'link-79');">ValueDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-476" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-476', 'pyval', 'link-80');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-477" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-477', 'UNKNOWN', 'link-51');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> <tt class="py-name">lines</tt><tt class="py-op">,</tt> <tt id="link-478" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-478', 'lineno', 'link-215');">lineno</a></tt> <tt class="py-op">=</tt> <tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">findsource</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-479" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-479', 'pyval', 'link-80');">pyval</a></tt><tt class="py-op">)</tt> </tt>
<a name="L956"></a><tt class="py-lineno"> 956</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-480" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-480', 'ModuleDoc', 'link-96');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt id="link-481" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-481', 'lineno', 'link-215');">lineno</a></tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-482" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-482', 'lineno', 'link-215');">lineno</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt id="link-483" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-483', 'lineno', 'link-215');">lineno</a></tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt id="link-484" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-484', 'lineno', 'link-215');">lineno</a></tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'#'</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-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-485" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring_lineno" class="py-name" href="#" onclick="return doclink('link-485', 'docstring_lineno', 'link-472');">docstring_lineno</a></tt> <tt class="py-op">=</tt> <tt id="link-486" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-486', 'lineno', 'link-215');">lineno</a></tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> </tt>
<a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-487" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-487', 'lineno', 'link-215');">lineno</a></tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> </tt>
<a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IOError</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">TypeError</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IndexError</tt><tt class="py-op">:</tt> </tt>
<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"> <tt id="link-488" 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-488', 'log', 'link-4');">log</a></tt><tt class="py-op">.</tt><tt id="link-489" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-489', 'warning', 'link-67');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'inspect.findsource(%s) raised IndexError'</tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-490" 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-490', 'canonical_name', 'link-39');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"> </tt>
<a name="_DevNull"></a><div id="_DevNull-def"><a name="L968"></a><tt class="py-lineno"> 968</tt> <a class="py-toggle" href="#" id="_DevNull-toggle" onclick="return toggle('_DevNull');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html">_DevNull</a><tt class="py-op">:</tt> </tt>
</div><div id="_DevNull-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_DevNull-expanded"><a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"><tt class="py-docstring"> A "file-like" object that discards anything that is written and</tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"><tt class="py-docstring"> always reports end-of-file when read. C{_DevNull} is used by</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"><tt class="py-docstring"> L{_import()} to discard output when importing modules; and to</tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"><tt class="py-docstring"> ensure that stdin appears closed.</tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="_DevNull.__init__"></a><div id="_DevNull.__init__-def"><a name="L975"></a><tt class="py-lineno"> 975</tt> <a class="py-toggle" href="#" id="_DevNull.__init__-toggle" onclick="return toggle('_DevNull.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#__init__">__init__</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="_DevNull.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_DevNull.__init__-expanded"><a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">closed</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mode</tt> <tt class="py-op">=</tt> <tt class="py-string">'r+'</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">softspace</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-491" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-491', 'name', 'link-18');">name</a></tt><tt class="py-op">=</tt><tt class="py-string">'</dev/null>'</tt> </tt>
</div><a name="_DevNull.close"></a><div id="_DevNull.close-def"><a name="L980"></a><tt class="py-lineno"> 980</tt> <a class="py-toggle" href="#" id="_DevNull.close-toggle" onclick="return toggle('_DevNull.close');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#close">close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="_DevNull.flush"></a><div id="_DevNull.flush-def"><a name="L981"></a><tt class="py-lineno"> 981</tt> <a class="py-toggle" href="#" id="_DevNull.flush-toggle" onclick="return toggle('_DevNull.flush');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#flush">flush</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="_DevNull.read"></a><div id="_DevNull.read-def"><a name="L982"></a><tt class="py-lineno"> 982</tt> <a class="py-toggle" href="#" id="_DevNull.read-toggle" onclick="return toggle('_DevNull.read');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#read">read</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">size</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-keyword">return</tt> <tt class="py-string">''</tt> </tt>
</div><a name="_DevNull.readline"></a><div id="_DevNull.readline-def"><a name="L983"></a><tt class="py-lineno"> 983</tt> <a class="py-toggle" href="#" id="_DevNull.readline-toggle" onclick="return toggle('_DevNull.readline');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#readline">readline</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">size</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-keyword">return</tt> <tt class="py-string">''</tt> </tt>
</div><a name="_DevNull.readlines"></a><div id="_DevNull.readlines-def"><a name="L984"></a><tt class="py-lineno"> 984</tt> <a class="py-toggle" href="#" id="_DevNull.readlines-toggle" onclick="return toggle('_DevNull.readlines');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#readlines">readlines</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">sizehint</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-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="_DevNull.seek"></a><div id="_DevNull.seek-def"><a name="L985"></a><tt class="py-lineno"> 985</tt> <a class="py-toggle" href="#" id="_DevNull.seek-toggle" onclick="return toggle('_DevNull.seek');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#seek">seek</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">offset</tt><tt class="py-op">,</tt> <tt class="py-param">whence</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-keyword">pass</tt> </tt>
</div><a name="_DevNull.tell"></a><div id="_DevNull.tell-def"><a name="L986"></a><tt class="py-lineno"> 986</tt> <a class="py-toggle" href="#" id="_DevNull.tell-toggle" onclick="return toggle('_DevNull.tell');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#tell">tell</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">0L</tt> </tt>
</div><a name="_DevNull.truncate"></a><div id="_DevNull.truncate-def"><a name="L987"></a><tt class="py-lineno"> 987</tt> <a class="py-toggle" href="#" id="_DevNull.truncate-toggle" onclick="return toggle('_DevNull.truncate');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#truncate">truncate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">size</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-keyword">pass</tt> </tt>
</div><a name="_DevNull.write"></a><div id="_DevNull.write-def"><a name="L988"></a><tt class="py-lineno"> 988</tt> <a class="py-toggle" href="#" id="_DevNull.write-toggle" onclick="return toggle('_DevNull.write');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#write">write</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">str</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="_DevNull.writelines"></a><div id="_DevNull.writelines-def"><a name="L989"></a><tt class="py-lineno"> 989</tt> <a class="py-toggle" href="#" id="_DevNull.writelines-toggle" onclick="return toggle('_DevNull.writelines');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter._DevNull-class.html#writelines">writelines</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">sequence</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"> <tt class="py-name">xreadlines</tt> <tt class="py-op">=</tt> <tt id="link-492" class="py-name" targets="Method epydoc.docintrospecter._DevNull.readlines()=epydoc.docintrospecter._DevNull-class.html#readlines"><a title="epydoc.docintrospecter._DevNull.readlines" class="py-name" href="#" onclick="return doclink('link-492', 'readlines', 'link-492');">readlines</a></tt> </tt>
</div><a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"><tt id="link-493" class="py-name"><a title="epydoc.docintrospecter._dev_null" class="py-name" href="#" onclick="return doclink('link-493', '_dev_null', 'link-463');">_dev_null</a></tt> <tt class="py-op">=</tt> <tt id="link-494" class="py-name" targets="Class epydoc.docintrospecter._DevNull=epydoc.docintrospecter._DevNull-class.html"><a title="epydoc.docintrospecter._DevNull" class="py-name" href="#" onclick="return doclink('link-494', '_DevNull', 'link-494');">_DevNull</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Zope InterfaceClass</tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">zope</tt><tt class="py-op">.</tt><tt class="py-name">interface</tt><tt class="py-op">.</tt><tt class="py-name">interface</tt> <tt class="py-keyword">import</tt> <tt class="py-name">InterfaceClass</tt> <tt class="py-name">as</tt> <tt class="py-name">_ZopeInterfaceClass</tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"> <tt id="link-495" class="py-name" targets="Function epydoc.docintrospecter.register_class_type()=epydoc.docintrospecter-module.html#register_class_type"><a title="epydoc.docintrospecter.register_class_type" class="py-name" href="#" onclick="return doclink('link-495', 'register_class_type', 'link-495');">register_class_type</a></tt><tt class="py-op">(</tt><tt class="py-name">_ZopeInterfaceClass</tt><tt class="py-op">)</tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"><tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"> </tt>
<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Zope Extension classes</tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> <tt class="py-comment"># Register type(ExtensionClass.ExtensionClass)</tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">from</tt> <tt class="py-name">ExtensionClass</tt> <tt class="py-keyword">import</tt> <tt class="py-name">ExtensionClass</tt> <tt class="py-name">as</tt> <tt class="py-name">_ExtensionClass</tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"> <tt id="link-496" class="py-name" targets="Variable epydoc.docintrospecter._ZopeType=epydoc.docintrospecter-module.html#_ZopeType"><a title="epydoc.docintrospecter._ZopeType" class="py-name" href="#" onclick="return doclink('link-496', '_ZopeType', 'link-496');">_ZopeType</a></tt> <tt class="py-op">=</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">_ExtensionClass</tt><tt class="py-op">)</tt> </tt>
<a name="_is_zope_type"></a><div id="_is_zope_type-def"><a name="L1011"></a><tt class="py-lineno">1011</tt> <a class="py-toggle" href="#" id="_is_zope_type-toggle" onclick="return toggle('_is_zope_type');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#_is_zope_type">_is_zope_type</a><tt class="py-op">(</tt><tt class="py-param">val</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_is_zope_type-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_is_zope_type-expanded"><a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt id="link-497" class="py-name"><a title="epydoc.docintrospecter._ZopeType" class="py-name" href="#" onclick="return doclink('link-497', '_ZopeType', 'link-496');">_ZopeType</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"> <tt id="link-498" class="py-name"><a title="epydoc.docintrospecter.register_introspecter" class="py-name" href="#" onclick="return doclink('link-498', 'register_introspecter', 'link-380');">register_introspecter</a></tt><tt class="py-op">(</tt><tt id="link-499" class="py-name" targets="Function epydoc.docintrospecter._is_zope_type()=epydoc.docintrospecter-module.html#_is_zope_type"><a title="epydoc.docintrospecter._is_zope_type" class="py-name" href="#" onclick="return doclink('link-499', '_is_zope_type', 'link-499');">_is_zope_type</a></tt><tt class="py-op">,</tt> <tt id="link-500" class="py-name"><a title="epydoc.docintrospecter.introspect_class" class="py-name" href="#" onclick="return doclink('link-500', 'introspect_class', 'link-384');">introspect_class</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"> <tt class="py-comment"># Register ExtensionClass.*MethodType</tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">from</tt> <tt class="py-name">ExtensionClass</tt> <tt class="py-keyword">import</tt> <tt class="py-name">PythonMethodType</tt> <tt class="py-name">as</tt> <tt class="py-name">_ZopeMethodType</tt> </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">ExtensionClass</tt> <tt class="py-keyword">import</tt> <tt class="py-name">ExtensionMethodType</tt> <tt class="py-name">as</tt> <tt class="py-name">_ZopeCMethodType</tt> </tt>
<a name="_is_zope_method"></a><div id="_is_zope_method-def"><a name="L1018"></a><tt class="py-lineno">1018</tt> <a class="py-toggle" href="#" id="_is_zope_method-toggle" onclick="return toggle('_is_zope_method');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docintrospecter-module.html#_is_zope_method">_is_zope_method</a><tt class="py-op">(</tt><tt class="py-param">val</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_is_zope_method-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_is_zope_method-expanded"><a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">_ZopeMethodType</tt><tt class="py-op">,</tt> <tt class="py-name">_ZopeCMethodType</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"> <tt id="link-501" class="py-name"><a title="epydoc.docintrospecter.register_introspecter" class="py-name" href="#" onclick="return doclink('link-501', 'register_introspecter', 'link-380');">register_introspecter</a></tt><tt class="py-op">(</tt><tt id="link-502" class="py-name" targets="Function epydoc.docintrospecter._is_zope_method()=epydoc.docintrospecter-module.html#_is_zope_method"><a title="epydoc.docintrospecter._is_zope_method" class="py-name" href="#" onclick="return doclink('link-502', '_is_zope_method', 'link-502');">_is_zope_method</a></tt><tt class="py-op">,</tt> <tt id="link-503" class="py-name"><a title="epydoc.docintrospecter.introspect_routine" class="py-name" href="#" onclick="return doclink('link-503', 'introspect_routine', 'link-386');">introspect_routine</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"><tt class="py-keyword">except</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">pass</tt> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"> </tt>
<a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"> </tt>
<a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"> </tt>
<a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"><tt class="py-comment"># [xx]</tt> </tt>
<a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-number">0</tt> <tt class="py-comment"># hm.. otherwise the following gets treated as a docstring! ouch!</tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"><tt class="py-string">######################################################################</tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"><tt class="py-string">## Zope Extension...</tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"><tt class="py-string">######################################################################</tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"><tt class="py-string">class ZopeIntrospecter(Introspecter):</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"><tt class="py-string"> VALUEDOC_CLASSES = Introspecter.VALUEDOC_CLASSES.copy()</tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"><tt class="py-string"> VALUEDOC_CLASSES.update({</tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"><tt class="py-string"> 'module': ZopeModuleDoc,</tt> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"><tt class="py-string"> 'class': ZopeClassDoc,</tt> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"><tt class="py-string"> 'interface': ZopeInterfaceDoc,</tt> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"><tt class="py-string"> 'attribute': ZopeAttributeDoc,</tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt class="py-string"> })</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"><tt class="py-string"> def add_module_child(self, child, child_name, module_doc):</tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"><tt class="py-string"> if isinstance(child, zope.interfaces.Interface):</tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"><tt class="py-string"> module_doc.add_zope_interface(child_name)</tt> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"><tt class="py-string"> else:</tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"><tt class="py-string"> Introspecter.add_module_child(self, child, child_name, module_doc)</tt> </tt>
<a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"><tt class="py-string"> def add_class_child(self, child, child_name, class_doc):</tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"><tt class="py-string"> if isinstance(child, zope.interfaces.Interface):</tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"><tt class="py-string"> class_doc.add_zope_interface(child_name)</tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"><tt class="py-string"> else:</tt> </tt>
<a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"><tt class="py-string"> Introspecter.add_class_child(self, child, child_name, class_doc)</tt> </tt>
<a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"><tt class="py-string"> def introspect_zope_interface(self, interface, interfacename):</tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"><tt class="py-string"> pass # etc...</tt> </tt>
<a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L1057"></a><tt class="py-lineno">1057</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:25 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>
