<?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.markup.doctest</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> ::
<a href="epydoc.markup-module.html">Package markup</a> ::
Module doctest
</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.markup.doctest-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.markup.doctest-module.html">Module epydoc.markup.doctest</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment">#</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"># doctest.py: Syntax Highlighting for doctest blocks</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"># 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">#</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"># Created [06/28/03 02:52 AM]</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"># $Id: restructuredtext.py 1210 2006-04-10 13:25:50Z edloper $</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">#</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">Syntax highlighting for doctest blocks. This module defines two</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">functions, L{doctest_to_html()} and L{doctest_to_latex()}, which can</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring">be used to perform syntax highlighting on doctest blocks. It also</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring">defines the more general C{colorize_doctest()}, which could be used to</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring">do syntac highlighting on doctest blocks with other output formats.</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">(Both C{doctest_to_html()} and C{doctest_to_latex()} are defined using</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring">C{colorize_doctest()}.)</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-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext en'</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package epydoc=epydoc-module.html"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-0', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-1" 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-1', 'util', 'link-1');">util</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Function epydoc.util.plaintext_to_html()=epydoc.util-module.html#plaintext_to_html"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-2', 'plaintext_to_html', 'link-2');">plaintext_to_html</a></tt><tt class="py-op">,</tt> <tt id="link-3" class="py-name" targets="Function epydoc.util.plaintext_to_latex()=epydoc.util-module.html#plaintext_to_latex"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-3', 'plaintext_to_latex', 'link-3');">plaintext_to_latex</a></tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-name">__all__</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'doctest_to_html'</tt><tt class="py-op">,</tt> <tt class="py-string">'doctest_to_latex'</tt><tt class="py-op">,</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"> <tt class="py-string">'DoctestColorizer'</tt><tt class="py-op">,</tt> <tt class="py-string">'XMLDoctestColorizer'</tt><tt class="py-op">,</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"> <tt class="py-string">'HTMLDoctestColorizer'</tt><tt class="py-op">,</tt> <tt class="py-string">'LaTeXDoctestColorizer'</tt><tt class="py-op">]</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"> </tt>
<a name="doctest_to_html"></a><div id="doctest_to_html-def"><a name="L27"></a><tt class="py-lineno"> 27</tt> <a class="py-toggle" href="#" id="doctest_to_html-toggle" onclick="return toggle('doctest_to_html');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.doctest-module.html#doctest_to_html">doctest_to_html</a><tt class="py-op">(</tt><tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="doctest_to_html-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="doctest_to_html-expanded"><a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-docstring"> Perform syntax highlighting on the given doctest string, and</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-docstring"> return the resulting HTML code. This code consists of a C{<pre>}</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring"> block with class=py-doctest. Syntax highlighting is performed</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring"> using the following css classes:</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring"> - C{py-prompt} -- the Python PS1 prompt (>>>)</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"> - C{py-more} -- the Python PS2 prompt (...)</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"> - C{py-keyword} -- a Python keyword (for, if, etc.)</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring"> - C{py-builtin} -- a Python builtin name (abs, dir, etc.)</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"> - C{py-string} -- a string literal</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring"> - C{py-comment} -- a comment</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"> - C{py-except} -- an exception traceback (up to the next >>>)</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring"> - C{py-output} -- the output from a doctest block.</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> - C{py-defname} -- the name of a function or class defined by</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring"> a C{def} or C{class} statement.</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-4" class="py-name" targets="Class epydoc.markup.doctest.HTMLDoctestColorizer=epydoc.markup.doctest.HTMLDoctestColorizer-class.html"><a title="epydoc.markup.doctest.HTMLDoctestColorizer" class="py-name" href="#" onclick="return doclink('link-4', 'HTMLDoctestColorizer', 'link-4');">HTMLDoctestColorizer</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method epydoc.markup.doctest.DoctestColorizer.colorize_doctest()=epydoc.markup.doctest.DoctestColorizer-class.html#colorize_doctest"><a title="epydoc.markup.doctest.DoctestColorizer.colorize_doctest" class="py-name" href="#" onclick="return doclink('link-5', 'colorize_doctest', 'link-5');">colorize_doctest</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
</div><a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> </tt>
<a name="doctest_to_latex"></a><div id="doctest_to_latex-def"><a name="L47"></a><tt class="py-lineno"> 47</tt> <a class="py-toggle" href="#" id="doctest_to_latex-toggle" onclick="return toggle('doctest_to_latex');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.doctest-module.html#doctest_to_latex">doctest_to_latex</a><tt class="py-op">(</tt><tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="doctest_to_latex-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="doctest_to_latex-expanded"><a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"> Perform syntax highlighting on the given doctest string, and</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"> return the resulting LaTeX code. This code consists of an</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"> C{alltt} environment. Syntax highlighting is performed using </tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> the following new latex commands, which must be defined externally:</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> - C{\pysrcprompt} -- the Python PS1 prompt (>>>)</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"> - C{\pysrcmore} -- the Python PS2 prompt (...)</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> - C{\pysrckeyword} -- a Python keyword (for, if, etc.)</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"> - C{\pysrcbuiltin} -- a Python builtin name (abs, dir, etc.)</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"> - C{\pysrcstring} -- a string literal</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> - C{\pysrccomment} -- a comment</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> - C{\pysrcexcept} -- an exception traceback (up to the next >>>)</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> - C{\pysrcoutput} -- the output from a doctest block.</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> - C{\pysrcdefname} -- the name of a function or class defined by</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> a C{def} or C{class} statement.</tt> </tt>
<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-keyword">return</tt> <tt id="link-6" class="py-name" targets="Class epydoc.markup.doctest.LaTeXDoctestColorizer=epydoc.markup.doctest.LaTeXDoctestColorizer-class.html"><a title="epydoc.markup.doctest.LaTeXDoctestColorizer" class="py-name" href="#" onclick="return doclink('link-6', 'LaTeXDoctestColorizer', 'link-6');">LaTeXDoctestColorizer</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.colorize_doctest" class="py-name" href="#" onclick="return doclink('link-7', 'colorize_doctest', 'link-5');">colorize_doctest</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
</div><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> </tt>
<a name="DoctestColorizer"></a><div id="DoctestColorizer-def"><a name="L66"></a><tt class="py-lineno"> 66</tt> <a class="py-toggle" href="#" id="DoctestColorizer-toggle" onclick="return toggle('DoctestColorizer');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.doctest.DoctestColorizer-class.html">DoctestColorizer</a><tt class="py-op">:</tt> </tt>
</div><div id="DoctestColorizer-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="DoctestColorizer-expanded"><a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"> An abstract base class for performing syntax highlighting on</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> doctest blocks and other bits of Python code. Subclasses should</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"> provide definitions for:</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"> - The L{markup()} method, which takes a substring and a tag, and</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"> returns a colorized version of the substring.</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"> - The L{PREFIX} and L{SUFFIX} variables, which will be added</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> to the beginning and end of the strings returned by</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> L{colorize_codeblock} and L{colorize_doctest}. </tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-comment">#: A string that is added to the beginning of the strings</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: returned by L{colorize_codeblock} and L{colorize_doctest}.</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: Typically, this string begins a preformatted area.</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-8" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer.PREFIX=epydoc.markup.doctest.DoctestColorizer-class.html#PREFIX,Variable epydoc.markup.doctest.HTMLDoctestColorizer.PREFIX=epydoc.markup.doctest.HTMLDoctestColorizer-class.html#PREFIX,Variable epydoc.markup.doctest.LaTeXDoctestColorizer.PREFIX=epydoc.markup.doctest.LaTeXDoctestColorizer-class.html#PREFIX,Variable epydoc.markup.doctest.XMLDoctestColorizer.PREFIX=epydoc.markup.doctest.XMLDoctestColorizer-class.html#PREFIX"><a title="epydoc.markup.doctest.DoctestColorizer.PREFIX
epydoc.markup.doctest.HTMLDoctestColorizer.PREFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.PREFIX
epydoc.markup.doctest.XMLDoctestColorizer.PREFIX" class="py-name" href="#" onclick="return doclink('link-8', 'PREFIX', 'link-8');">PREFIX</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-comment">#: A string that is added to the end of the strings</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: returned by L{colorize_codeblock} and L{colorize_doctest}.</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: Typically, this string ends a preformatted area.</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-9" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer.SUFFIX=epydoc.markup.doctest.DoctestColorizer-class.html#SUFFIX,Variable epydoc.markup.doctest.HTMLDoctestColorizer.SUFFIX=epydoc.markup.doctest.HTMLDoctestColorizer-class.html#SUFFIX,Variable epydoc.markup.doctest.LaTeXDoctestColorizer.SUFFIX=epydoc.markup.doctest.LaTeXDoctestColorizer-class.html#SUFFIX,Variable epydoc.markup.doctest.XMLDoctestColorizer.SUFFIX=epydoc.markup.doctest.XMLDoctestColorizer-class.html#SUFFIX"><a title="epydoc.markup.doctest.DoctestColorizer.SUFFIX
epydoc.markup.doctest.HTMLDoctestColorizer.SUFFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.SUFFIX
epydoc.markup.doctest.XMLDoctestColorizer.SUFFIX" class="py-name" href="#" onclick="return doclink('link-9', 'SUFFIX', 'link-9');">SUFFIX</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-comment">#: A list of the names of all Python keywords. ('as' is included</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: even though it is technically not a keyword.)</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-10" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._KEYWORDS=epydoc.markup.doctest.DoctestColorizer-class.html#_KEYWORDS"><a title="epydoc.markup.doctest.DoctestColorizer._KEYWORDS" class="py-name" href="#" onclick="return doclink('link-10', '_KEYWORDS', 'link-10');">_KEYWORDS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">"and del for is raise"</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-string">"assert elif from lambda return"</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-string">"break else global not try"</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-string">"class except if or while"</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt class="py-string">"continue exec import pass yield"</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-string">"def finally in print as"</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-op">)</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-comment">#: A list of all Python builtins.</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-11" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._BUILTINS=epydoc.markup.doctest.DoctestColorizer-class.html#_BUILTINS"><a title="epydoc.markup.doctest.DoctestColorizer._BUILTINS" class="py-name" href="#" onclick="return doclink('link-11', '_BUILTINS', 'link-11');">_BUILTINS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-12" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._BI=epydoc.markup.doctest.DoctestColorizer-class.html#_BI"><a title="epydoc.markup.doctest.DoctestColorizer._BI" class="py-name" href="#" onclick="return doclink('link-12', '_BI', 'link-12');">_BI</a></tt> <tt class="py-keyword">for</tt> <tt id="link-13" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._BI" class="py-name" href="#" onclick="return doclink('link-13', '_BI', 'link-12');">_BI</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">dir</tt><tt class="py-op">(</tt><tt class="py-name">__builtins__</tt><tt class="py-op">)</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-14" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._BI" class="py-name" href="#" onclick="return doclink('link-14', '_BI', 'link-12');">_BI</a></tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'__'</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-comment">#: A regexp group that matches keywords.</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-15" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._KEYWORD_GRP=epydoc.markup.doctest.DoctestColorizer-class.html#_KEYWORD_GRP"><a title="epydoc.markup.doctest.DoctestColorizer._KEYWORD_GRP" class="py-name" href="#" onclick="return doclink('link-15', '_KEYWORD_GRP', 'link-15');">_KEYWORD_GRP</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 class="py-op">[</tt><tt class="py-string">r'\b%s\b'</tt> <tt class="py-op">%</tt> <tt id="link-16" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._KW=epydoc.markup.doctest.DoctestColorizer-class.html#_KW"><a title="epydoc.markup.doctest.DoctestColorizer._KW" class="py-name" href="#" onclick="return doclink('link-16', '_KW', 'link-16');">_KW</a></tt> <tt class="py-keyword">for</tt> <tt id="link-17" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._KW" class="py-name" href="#" onclick="return doclink('link-17', '_KW', 'link-16');">_KW</a></tt> <tt class="py-keyword">in</tt> <tt id="link-18" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._KEYWORDS" class="py-name" href="#" onclick="return doclink('link-18', '_KEYWORDS', 'link-10');">_KEYWORDS</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-comment">#: A regexp group that matches Python builtins.</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-19" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._BUILTIN_GRP=epydoc.markup.doctest.DoctestColorizer-class.html#_BUILTIN_GRP"><a title="epydoc.markup.doctest.DoctestColorizer._BUILTIN_GRP" class="py-name" href="#" onclick="return doclink('link-19', '_BUILTIN_GRP', 'link-19');">_BUILTIN_GRP</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">r'(?<!\.)(?:%s)'</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 class="py-op">[</tt><tt class="py-string">r'\b%s\b'</tt> <tt class="py-op">%</tt> <tt id="link-20" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._BI" class="py-name" href="#" onclick="return doclink('link-20', '_BI', 'link-12');">_BI</a></tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-21" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._BI" class="py-name" href="#" onclick="return doclink('link-21', '_BI', 'link-12');">_BI</a></tt> <tt class="py-keyword">in</tt> <tt id="link-22" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._BUILTINS" class="py-name" href="#" onclick="return doclink('link-22', '_BUILTINS', 'link-11');">_BUILTINS</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-comment">#: A regexp group that matches Python strings.</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-23" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._STRING_GRP=epydoc.markup.doctest.DoctestColorizer-class.html#_STRING_GRP"><a title="epydoc.markup.doctest.DoctestColorizer._STRING_GRP" class="py-name" href="#" onclick="return doclink('link-23', '_STRING_GRP', 'link-23');">_STRING_GRP</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>
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> <tt class="py-op">[</tt><tt class="py-string">r'("""("""|.*?((?!").)"""))'</tt><tt class="py-op">,</tt> <tt class="py-string">r'("("|.*?((?!").)"))'</tt><tt class="py-op">,</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> <tt class="py-string">r"('''('''|.*?[^\\']'''))"</tt><tt class="py-op">,</tt> <tt class="py-string">r"('('|.*?[^\\']'))"</tt><tt class="py-op">]</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-comment">#: A regexp group that matches Python comments.</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-24" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._COMMENT_GRP=epydoc.markup.doctest.DoctestColorizer-class.html#_COMMENT_GRP"><a title="epydoc.markup.doctest.DoctestColorizer._COMMENT_GRP" class="py-name" href="#" onclick="return doclink('link-24', '_COMMENT_GRP', 'link-24');">_COMMENT_GRP</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'(#.*?$)'</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-comment">#: A regexp group that matches Python ">>>" prompts.</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-25" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._PROMPT1_GRP=epydoc.markup.doctest.DoctestColorizer-class.html#_PROMPT1_GRP"><a title="epydoc.markup.doctest.DoctestColorizer._PROMPT1_GRP" class="py-name" href="#" onclick="return doclink('link-25', '_PROMPT1_GRP', 'link-25');">_PROMPT1_GRP</a></tt> <tt class="py-op">=</tt> <tt class="py-string">r'^[ \t]*>>>(?:[ \t]|$)'</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> <tt class="py-comment">#: A regexp group that matches Python "..." prompts.</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-26" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._PROMPT2_GRP=epydoc.markup.doctest.DoctestColorizer-class.html#_PROMPT2_GRP"><a title="epydoc.markup.doctest.DoctestColorizer._PROMPT2_GRP" class="py-name" href="#" onclick="return doclink('link-26', '_PROMPT2_GRP', 'link-26');">_PROMPT2_GRP</a></tt> <tt class="py-op">=</tt> <tt class="py-string">r'^[ \t]*\.\.\.(?:[ \t]|$)'</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-comment">#: A regexp group that matches function and class definitions.</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-27" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer._DEFINE_GRP=epydoc.markup.doctest.DoctestColorizer-class.html#_DEFINE_GRP"><a title="epydoc.markup.doctest.DoctestColorizer._DEFINE_GRP" class="py-name" href="#" onclick="return doclink('link-27', '_DEFINE_GRP', 'link-27');">_DEFINE_GRP</a></tt> <tt class="py-op">=</tt> <tt class="py-string">r'\b(?:def|class)[ \t]+\w+'</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> <tt class="py-comment">#: A regexp that matches Python prompts</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-28" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer.PROMPT_RE=epydoc.markup.doctest.DoctestColorizer-class.html#PROMPT_RE"><a title="epydoc.markup.doctest.DoctestColorizer.PROMPT_RE" class="py-name" href="#" onclick="return doclink('link-28', 'PROMPT_RE', 'link-28');">PROMPT_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'(%s|%s)'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-29" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._PROMPT1_GRP" class="py-name" href="#" onclick="return doclink('link-29', '_PROMPT1_GRP', 'link-25');">_PROMPT1_GRP</a></tt><tt class="py-op">,</tt> <tt id="link-30" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._PROMPT2_GRP" class="py-name" href="#" onclick="return doclink('link-30', '_PROMPT2_GRP', 'link-26');">_PROMPT2_GRP</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">MULTILINE</tt> <tt class="py-op">|</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">DOTALL</tt><tt class="py-op">)</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-comment">#: A regexp that matches Python "..." prompts.</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-31" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer.PROMPT2_RE=epydoc.markup.doctest.DoctestColorizer-class.html#PROMPT2_RE"><a title="epydoc.markup.doctest.DoctestColorizer.PROMPT2_RE" class="py-name" href="#" onclick="return doclink('link-31', 'PROMPT2_RE', 'link-31');">PROMPT2_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'(%s)'</tt> <tt class="py-op">%</tt> <tt id="link-32" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._PROMPT2_GRP" class="py-name" href="#" onclick="return doclink('link-32', '_PROMPT2_GRP', 'link-26');">_PROMPT2_GRP</a></tt><tt class="py-op">,</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">MULTILINE</tt> <tt class="py-op">|</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">DOTALL</tt><tt class="py-op">)</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> <tt class="py-comment">#: A regexp that matches doctest exception blocks.</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-33" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer.EXCEPT_RE=epydoc.markup.doctest.DoctestColorizer-class.html#EXCEPT_RE"><a title="epydoc.markup.doctest.DoctestColorizer.EXCEPT_RE" class="py-name" href="#" onclick="return doclink('link-33', 'EXCEPT_RE', 'link-33');">EXCEPT_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'^[ \t]*Traceback \(most recent call last\):.*'</tt><tt class="py-op">,</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">DOTALL</tt> <tt class="py-op">|</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">MULTILINE</tt><tt class="py-op">)</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt class="py-comment">#: A regexp that matches doctest directives.</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-34" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer.DOCTEST_DIRECTIVE_RE=epydoc.markup.doctest.DoctestColorizer-class.html#DOCTEST_DIRECTIVE_RE"><a title="epydoc.markup.doctest.DoctestColorizer.DOCTEST_DIRECTIVE_RE" class="py-name" href="#" onclick="return doclink('link-34', 'DOCTEST_DIRECTIVE_RE', 'link-34');">DOCTEST_DIRECTIVE_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'#[ \t]*doctest:.*'</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-comment">#: A regexp that matches all of the regions of a doctest block</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: that should be colored.</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-35" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer.DOCTEST_RE=epydoc.markup.doctest.DoctestColorizer-class.html#DOCTEST_RE"><a title="epydoc.markup.doctest.DoctestColorizer.DOCTEST_RE" class="py-name" href="#" onclick="return doclink('link-35', 'DOCTEST_RE', 'link-35');">DOCTEST_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"> <tt class="py-string">r'(.*?)((?P<STRING>%s)|(?P<COMMENT>%s)|(?P<DEFINE>%s)|'</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt class="py-string">r'(?P<KEYWORD>%s)|(?P<BUILTIN>%s)|'</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"> <tt class="py-string">r'(?P<PROMPT1>%s)|(?P<PROMPT2>%s)|(?P<EOS>\Z))'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"> <tt id="link-36" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._STRING_GRP" class="py-name" href="#" onclick="return doclink('link-36', '_STRING_GRP', 'link-23');">_STRING_GRP</a></tt><tt class="py-op">,</tt> <tt id="link-37" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._COMMENT_GRP" class="py-name" href="#" onclick="return doclink('link-37', '_COMMENT_GRP', 'link-24');">_COMMENT_GRP</a></tt><tt class="py-op">,</tt> <tt id="link-38" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._DEFINE_GRP" class="py-name" href="#" onclick="return doclink('link-38', '_DEFINE_GRP', 'link-27');">_DEFINE_GRP</a></tt><tt class="py-op">,</tt> <tt id="link-39" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._KEYWORD_GRP" class="py-name" href="#" onclick="return doclink('link-39', '_KEYWORD_GRP', 'link-15');">_KEYWORD_GRP</a></tt><tt class="py-op">,</tt> <tt id="link-40" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._BUILTIN_GRP" class="py-name" href="#" onclick="return doclink('link-40', '_BUILTIN_GRP', 'link-19');">_BUILTIN_GRP</a></tt><tt class="py-op">,</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"> <tt id="link-41" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._PROMPT1_GRP" class="py-name" href="#" onclick="return doclink('link-41', '_PROMPT1_GRP', 'link-25');">_PROMPT1_GRP</a></tt><tt class="py-op">,</tt> <tt id="link-42" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer._PROMPT2_GRP" class="py-name" href="#" onclick="return doclink('link-42', '_PROMPT2_GRP', 'link-26');">_PROMPT2_GRP</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">MULTILINE</tt> <tt class="py-op">|</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">DOTALL</tt><tt class="py-op">)</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"> <tt class="py-comment">#: This regular expression is used to find doctest examples in a</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: string. This is copied from the standard Python doctest.py</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: module (after the refactoring in Python 2.4+).</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-43" class="py-name" targets="Variable epydoc.markup.doctest.DoctestColorizer.DOCTEST_EXAMPLE_RE=epydoc.markup.doctest.DoctestColorizer-class.html#DOCTEST_EXAMPLE_RE"><a title="epydoc.markup.doctest.DoctestColorizer.DOCTEST_EXAMPLE_RE" class="py-name" href="#" onclick="return doclink('link-43', 'DOCTEST_EXAMPLE_RE', 'link-43');">DOCTEST_EXAMPLE_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'''</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"><tt class="py-string"> # Source consists of a PS1 line followed by zero or more PS2 lines.</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"><tt class="py-string"> (?P<source></tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"><tt class="py-string"> (?:^(?P<indent> [ ]*) >>> .*) # PS1 line</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-string"> (?:\n [ ]* \.\.\. .*)* # PS2 lines</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"><tt class="py-string"> \n?)</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"><tt class="py-string"> # Want consists of any non-blank lines that do not start with PS1.</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"><tt class="py-string"> (?P<want> (?:(?![ ]*$) # Not a blank line</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"><tt class="py-string"> (?![ ]*>>>) # Not a line starting with PS1</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"><tt class="py-string"> .*$\n? # But any other line</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"><tt class="py-string"> )*)</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">MULTILINE</tt> <tt class="py-op">|</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">VERBOSE</tt><tt class="py-op">)</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> </tt>
<a name="DoctestColorizer.colorize_inline"></a><div id="DoctestColorizer.colorize_inline-def"><a name="L166"></a><tt class="py-lineno">166</tt> <a class="py-toggle" href="#" id="DoctestColorizer.colorize_inline-toggle" onclick="return toggle('DoctestColorizer.colorize_inline');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.doctest.DoctestColorizer-class.html#colorize_inline">colorize_inline</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DoctestColorizer.colorize_inline-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DoctestColorizer.colorize_inline-expanded"><a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"> Colorize a string containing Python code. Do not add the</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"> L{PREFIX} and L{SUFFIX} strings to the returned value. This</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> method is intended for generating syntax-highlighted strings</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"> that are appropriate for inclusion as inline expressions.</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.DOCTEST_RE" class="py-name" href="#" onclick="return doclink('link-44', 'DOCTEST_RE', 'link-35');">DOCTEST_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name" targets="Method epydoc.markup.doctest.DoctestColorizer.subfunc()=epydoc.markup.doctest.DoctestColorizer-class.html#subfunc"><a title="epydoc.markup.doctest.DoctestColorizer.subfunc" class="py-name" href="#" onclick="return doclink('link-45', 'subfunc', 'link-45');">subfunc</a></tt><tt class="py-op">,</tt> <tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
</div><a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"> </tt>
<a name="DoctestColorizer.colorize_codeblock"></a><div id="DoctestColorizer.colorize_codeblock-def"><a name="L175"></a><tt class="py-lineno">175</tt> <a class="py-toggle" href="#" id="DoctestColorizer.colorize_codeblock-toggle" onclick="return toggle('DoctestColorizer.colorize_codeblock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.doctest.DoctestColorizer-class.html#colorize_codeblock">colorize_codeblock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DoctestColorizer.colorize_codeblock-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DoctestColorizer.colorize_codeblock-expanded"><a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"><tt class="py-docstring"> Colorize a string containing only Python code. This method</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"><tt class="py-docstring"> differs from L{colorize_doctest} in that it will not search</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"><tt class="py-docstring"> for doctest prompts when deciding how to colorize the string.</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt id="link-46" class="py-name" targets="Method epydoc.markup.Field.body()=epydoc.markup.Field-class.html#body"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-46', 'body', 'link-46');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.DOCTEST_RE" class="py-name" href="#" onclick="return doclink('link-47', 'DOCTEST_RE', 'link-35');">DOCTEST_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-48" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.subfunc" class="py-name" href="#" onclick="return doclink('link-48', 'subfunc', 'link-45');">subfunc</a></tt><tt class="py-op">,</tt> <tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.PREFIX
epydoc.markup.doctest.HTMLDoctestColorizer.PREFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.PREFIX
epydoc.markup.doctest.XMLDoctestColorizer.PREFIX" class="py-name" href="#" onclick="return doclink('link-49', 'PREFIX', 'link-8');">PREFIX</a></tt> <tt class="py-op">+</tt> <tt id="link-50" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-50', 'body', 'link-46');">body</a></tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.SUFFIX
epydoc.markup.doctest.HTMLDoctestColorizer.SUFFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.SUFFIX
epydoc.markup.doctest.XMLDoctestColorizer.SUFFIX" class="py-name" href="#" onclick="return doclink('link-51', 'SUFFIX', 'link-9');">SUFFIX</a></tt> </tt>
</div><a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> </tt>
<a name="DoctestColorizer.colorize_doctest"></a><div id="DoctestColorizer.colorize_doctest-def"><a name="L184"></a><tt class="py-lineno">184</tt> <a class="py-toggle" href="#" id="DoctestColorizer.colorize_doctest-toggle" onclick="return toggle('DoctestColorizer.colorize_doctest');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.doctest.DoctestColorizer-class.html#colorize_doctest">colorize_doctest</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">s</tt><tt class="py-op">,</tt> <tt class="py-param">strip_directives</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="DoctestColorizer.colorize_doctest-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DoctestColorizer.colorize_doctest-expanded"><a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"><tt class="py-docstring"> Colorize a string containing one or more doctest examples.</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> <tt class="py-name">charno</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">m</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.DOCTEST_EXAMPLE_RE" class="py-name" href="#" onclick="return doclink('link-52', 'DOCTEST_EXAMPLE_RE', 'link-43');">DOCTEST_EXAMPLE_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">finditer</tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"> <tt class="py-comment"># Parse the doctest example:</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">pysrc</tt><tt class="py-op">,</tt> <tt class="py-name">want</tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'source'</tt><tt class="py-op">,</tt> <tt class="py-string">'want'</tt><tt class="py-op">)</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"> <tt class="py-comment"># Pre-example text:</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">output</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">[</tt><tt class="py-name">charno</tt><tt class="py-op">:</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">start</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"> <tt class="py-comment"># Example source code:</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">output</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.DOCTEST_RE" class="py-name" href="#" onclick="return doclink('link-53', 'DOCTEST_RE', 'link-35');">DOCTEST_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.subfunc" class="py-name" href="#" onclick="return doclink('link-54', 'subfunc', 'link-45');">subfunc</a></tt><tt class="py-op">,</tt> <tt class="py-name">pysrc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"> <tt class="py-comment"># Example output:</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">want</tt><tt class="py-op">:</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-55" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.EXCEPT_RE" class="py-name" href="#" onclick="return doclink('link-55', 'EXCEPT_RE', 'link-33');">EXCEPT_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">want</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"> <tt class="py-name">output</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name" targets="Package epydoc.markup=epydoc.markup-module.html,Method epydoc.markup.doctest.DoctestColorizer.markup()=epydoc.markup.doctest.DoctestColorizer-class.html#markup,Method epydoc.markup.doctest.HTMLDoctestColorizer.markup()=epydoc.markup.doctest.HTMLDoctestColorizer-class.html#markup,Method epydoc.markup.doctest.LaTeXDoctestColorizer.markup()=epydoc.markup.doctest.LaTeXDoctestColorizer-class.html#markup,Method epydoc.markup.doctest.XMLDoctestColorizer.markup()=epydoc.markup.doctest.XMLDoctestColorizer-class.html#markup"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-56', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-string">'except'</tt><tt class="py-op">)</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">want</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt class="py-name">output</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-57', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-string">'output'</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">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">want</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"> <tt class="py-comment"># Update charno</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">charno</tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">end</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"> <tt class="py-comment"># Add any remaining post-example text.</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">output</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">[</tt><tt class="py-name">charno</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">)</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-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-58" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.PREFIX
epydoc.markup.doctest.HTMLDoctestColorizer.PREFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.PREFIX
epydoc.markup.doctest.XMLDoctestColorizer.PREFIX" class="py-name" href="#" onclick="return doclink('link-58', 'PREFIX', 'link-8');">PREFIX</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 class="py-name">output</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.SUFFIX
epydoc.markup.doctest.HTMLDoctestColorizer.SUFFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.SUFFIX
epydoc.markup.doctest.XMLDoctestColorizer.SUFFIX" class="py-name" href="#" onclick="return doclink('link-59', 'SUFFIX', 'link-9');">SUFFIX</a></tt> </tt>
</div><a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> </tt>
<a name="DoctestColorizer.subfunc"></a><div id="DoctestColorizer.subfunc-def"><a name="L212"></a><tt class="py-lineno">212</tt> <a class="py-toggle" href="#" id="DoctestColorizer.subfunc-toggle" onclick="return toggle('DoctestColorizer.subfunc');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.doctest.DoctestColorizer-class.html#subfunc">subfunc</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">match</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DoctestColorizer.subfunc-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DoctestColorizer.subfunc-expanded"><a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"> <tt class="py-name">other</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt> <tt class="py-op">=</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> <tt class="py-comment">#print 'M %20r %20r' % (other, text) # <- for debugging</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">other</tt><tt class="py-op">:</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> <tt class="py-name">other</tt> <tt class="py-op">=</tt> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-60', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-string">'other'</tt><tt class="py-op">)</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'PROMPT1'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">other</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-61', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">'prompt'</tt><tt class="py-op">)</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'PROMPT2'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">other</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-62', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">'more'</tt><tt class="py-op">)</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'KEYWORD'</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-keyword">return</tt> <tt class="py-name">other</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-63', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">'keyword'</tt><tt class="py-op">)</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'BUILTIN'</tt><tt class="py-op">)</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">return</tt> <tt class="py-name">other</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-64', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">'builtin'</tt><tt class="py-op">)</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'COMMENT'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">other</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-65', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">'comment'</tt><tt class="py-op">)</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'STRING'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-string">'\n'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">text</tt><tt class="py-op">:</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">other</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-66', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">'string'</tt><tt class="py-op">)</tt> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'STRING'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"> <tt class="py-comment"># It's a multiline string; colorize the string & prompt</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># portion of each line.</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">pieces</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">text</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</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 class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.PROMPT2_RE" class="py-name" href="#" onclick="return doclink('link-67', 'PROMPT2_RE', 'link-31');">PROMPT2_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</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">line</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">4</tt><tt class="py-op">:</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"> <tt class="py-name">pieces</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-68', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">4</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'more'</tt><tt class="py-op">)</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">self</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-69', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">4</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'string'</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 class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"> <tt class="py-name">pieces</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-70', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">4</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'more'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</tt><tt class="py-op">:</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"> <tt class="py-name">pieces</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-71" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-71', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-string">'string'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"> <tt class="py-name">pieces</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="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">other</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">pieces</tt><tt class="py-op">)</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'DEFINE'</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 class="py-name">m</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-string">'(?P<def>\w+)(?P<space>\s+)(?P<name>\w+)'</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt><tt class="py-op">)</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">other</tt> <tt class="py-op">+</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-72" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-72', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'def'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'keyword'</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-73', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'space'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'other'</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">self</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-74', 'markup', 'link-56');">markup</a></tt><tt class="py-op">(</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</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-string">'defname'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-string">'EOS'</tt><tt class="py-op">)</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="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">other</tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-string">'Unexpected match!'</tt> </tt>
</div><a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"> </tt>
<a name="DoctestColorizer.markup"></a><div id="DoctestColorizer.markup-def"><a name="L257"></a><tt class="py-lineno">257</tt> <a class="py-toggle" href="#" id="DoctestColorizer.markup-toggle" onclick="return toggle('DoctestColorizer.markup');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.doctest.DoctestColorizer-class.html#markup">markup</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">s</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DoctestColorizer.markup-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DoctestColorizer.markup-expanded"><a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"><tt class="py-docstring"> Apply syntax highlighting to a single substring from a doctest</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"><tt class="py-docstring"> block. C{s} is the substring, and C{tag} is the tag that</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"><tt class="py-docstring"> should be applied to the substring. C{tag} will be one of the</tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"><tt class="py-docstring"> following strings:</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"><tt class="py-docstring"> - C{prompt} -- the Python PS1 prompt (>>>)</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"><tt class="py-docstring"> - C{more} -- the Python PS2 prompt (...)</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"><tt class="py-docstring"> - C{keyword} -- a Python keyword (for, if, etc.)</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"><tt class="py-docstring"> - C{builtin} -- a Python builtin name (abs, dir, etc.)</tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"><tt class="py-docstring"> - C{string} -- a string literal</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"><tt class="py-docstring"> - C{comment} -- a comment</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"><tt class="py-docstring"> - C{except} -- an exception traceback (up to the next >>>)</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"><tt class="py-docstring"> - C{output} -- the output from a doctest block.</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"><tt class="py-docstring"> - C{defname} -- the name of a function or class defined by</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"><tt class="py-docstring"> a C{def} or C{class} statement.</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"><tt class="py-docstring"> - C{other} -- anything else (does *not* include output.)</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">AssertionError</tt><tt class="py-op">(</tt><tt class="py-string">"Abstract method"</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> </tt>
<a name="XMLDoctestColorizer"></a><div id="XMLDoctestColorizer-def"><a name="L278"></a><tt class="py-lineno">278</tt> <a class="py-toggle" href="#" id="XMLDoctestColorizer-toggle" onclick="return toggle('XMLDoctestColorizer');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.doctest.XMLDoctestColorizer-class.html">XMLDoctestColorizer</a><tt class="py-op">(</tt><tt class="py-base-class">DoctestColorizer</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="XMLDoctestColorizer-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="XMLDoctestColorizer-expanded"><a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"><tt class="py-docstring"> A subclass of DoctestColorizer that generates XML-like output.</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"><tt class="py-docstring"> This class is mainly intended to be used for testing purposes.</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> <tt id="link-75" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.PREFIX
epydoc.markup.doctest.HTMLDoctestColorizer.PREFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.PREFIX
epydoc.markup.doctest.XMLDoctestColorizer.PREFIX" class="py-name" href="#" onclick="return doclink('link-75', 'PREFIX', 'link-8');">PREFIX</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'<colorized>\n'</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"> <tt id="link-76" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.SUFFIX
epydoc.markup.doctest.HTMLDoctestColorizer.SUFFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.SUFFIX
epydoc.markup.doctest.XMLDoctestColorizer.SUFFIX" class="py-name" href="#" onclick="return doclink('link-76', 'SUFFIX', 'link-9');">SUFFIX</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'</colorized>\n'</tt> </tt>
<a name="XMLDoctestColorizer.markup"></a><div id="XMLDoctestColorizer.markup-def"><a name="L285"></a><tt class="py-lineno">285</tt> <a class="py-toggle" href="#" id="XMLDoctestColorizer.markup-toggle" onclick="return toggle('XMLDoctestColorizer.markup');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.doctest.XMLDoctestColorizer-class.html#markup">markup</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">s</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="XMLDoctestColorizer.markup-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="XMLDoctestColorizer.markup-expanded"><a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">s</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">'&amp;'</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">'&lt;'</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">'&gt;'</tt><tt class="py-op">)</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-77" class="py-name" targets="Method epydoc.markup.Field.tag()=epydoc.markup.Field-class.html#tag"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-77', 'tag', 'link-77');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'other'</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">'<%s>%s</%s>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-78" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-78', 'tag', 'link-77');">tag</a></tt><tt class="py-op">,</tt> <tt class="py-name">s</tt><tt class="py-op">,</tt> <tt id="link-79" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-79', 'tag', 'link-77');">tag</a></tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"> </tt>
<a name="HTMLDoctestColorizer"></a><div id="HTMLDoctestColorizer-def"><a name="L290"></a><tt class="py-lineno">290</tt> <a class="py-toggle" href="#" id="HTMLDoctestColorizer-toggle" onclick="return toggle('HTMLDoctestColorizer');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.doctest.HTMLDoctestColorizer-class.html">HTMLDoctestColorizer</a><tt class="py-op">(</tt><tt class="py-base-class">DoctestColorizer</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLDoctestColorizer-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="HTMLDoctestColorizer-expanded"><a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"> <tt class="py-docstring">"""A subclass of DoctestColorizer that generates HTML output."""</tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"> <tt id="link-80" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.PREFIX
epydoc.markup.doctest.HTMLDoctestColorizer.PREFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.PREFIX
epydoc.markup.doctest.XMLDoctestColorizer.PREFIX" class="py-name" href="#" onclick="return doclink('link-80', 'PREFIX', 'link-8');">PREFIX</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'<pre class="py-doctest">\n'</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"> <tt id="link-81" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.SUFFIX
epydoc.markup.doctest.HTMLDoctestColorizer.SUFFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.SUFFIX
epydoc.markup.doctest.XMLDoctestColorizer.SUFFIX" class="py-name" href="#" onclick="return doclink('link-81', 'SUFFIX', 'link-9');">SUFFIX</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'</pre>\n'</tt> </tt>
<a name="HTMLDoctestColorizer.markup"></a><div id="HTMLDoctestColorizer.markup-def"><a name="L294"></a><tt class="py-lineno">294</tt> <a class="py-toggle" href="#" id="HTMLDoctestColorizer.markup-toggle" onclick="return toggle('HTMLDoctestColorizer.markup');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.doctest.HTMLDoctestColorizer-class.html#markup">markup</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">s</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLDoctestColorizer.markup-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="HTMLDoctestColorizer.markup-expanded"><a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-82" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-82', 'tag', 'link-77');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'other'</tt><tt class="py-op">:</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-83" class="py-name"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-83', 'plaintext_to_html', 'link-2');">plaintext_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'<span class="py-%s">%s</span>'</tt> <tt class="py-op">%</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-84" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-84', 'tag', 'link-77');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-85" class="py-name"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-85', 'plaintext_to_html', 'link-2');">plaintext_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> </tt>
<a name="LaTeXDoctestColorizer"></a><div id="LaTeXDoctestColorizer-def"><a name="L301"></a><tt class="py-lineno">301</tt> <a class="py-toggle" href="#" id="LaTeXDoctestColorizer-toggle" onclick="return toggle('LaTeXDoctestColorizer');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.doctest.LaTeXDoctestColorizer-class.html">LaTeXDoctestColorizer</a><tt class="py-op">(</tt><tt class="py-base-class">DoctestColorizer</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LaTeXDoctestColorizer-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="LaTeXDoctestColorizer-expanded"><a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"> <tt class="py-docstring">"""A subclass of DoctestColorizer that generates LaTeX output."""</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"> <tt id="link-86" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.PREFIX
epydoc.markup.doctest.HTMLDoctestColorizer.PREFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.PREFIX
epydoc.markup.doctest.XMLDoctestColorizer.PREFIX" class="py-name" href="#" onclick="return doclink('link-86', 'PREFIX', 'link-8');">PREFIX</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'\\begin{alltt}\n'</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"> <tt id="link-87" class="py-name"><a title="epydoc.markup.doctest.DoctestColorizer.SUFFIX
epydoc.markup.doctest.HTMLDoctestColorizer.SUFFIX
epydoc.markup.doctest.LaTeXDoctestColorizer.SUFFIX
epydoc.markup.doctest.XMLDoctestColorizer.SUFFIX" class="py-name" href="#" onclick="return doclink('link-87', 'SUFFIX', 'link-9');">SUFFIX</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'\\end{alltt}\n'</tt> </tt>
<a name="LaTeXDoctestColorizer.markup"></a><div id="LaTeXDoctestColorizer.markup-def"><a name="L305"></a><tt class="py-lineno">305</tt> <a class="py-toggle" href="#" id="LaTeXDoctestColorizer.markup-toggle" onclick="return toggle('LaTeXDoctestColorizer.markup');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.doctest.LaTeXDoctestColorizer-class.html#markup">markup</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">s</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LaTeXDoctestColorizer.markup-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="LaTeXDoctestColorizer.markup-expanded"><a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-88" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-88', 'tag', 'link-77');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'other'</tt><tt class="py-op">:</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-89" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-89', 'plaintext_to_latex', 'link-3');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\pysrc%s{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-90" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-90', 'tag', 'link-77');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-91" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-91', 'plaintext_to_latex', 'link-3');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L310"></a><tt class="py-lineno">310</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:31 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>
