← Back to branch summary

~ubuntu-branches/debian/lenny/epydoc/lenny

« back to all changes in this revision

Viewing changes to doc/api/epydoc.markup.pyval_repr-module.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2008-02-03 13:22:12 UTC
  • mfrom: (1.2.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080203132212-u2uohl6rswmlz2ra
Tags: 3.0.1-1
* New upstream release.
* Removed #! from top of epydoc/gui.py
* Got rid of version mangling in debian/watch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/epydoc.markup.pyval_repr-module.html
 
1
<?xml version="1.0" encoding="ascii"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>epydoc.markup.pyval_repr</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
 
8
  <script type="text/javascript" src="epydoc.js"></script>
 
9
</head>
 
10
 
 
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
12
      alink="#204080">
 
13
<!-- ==================== NAVIGATION BAR ==================== -->
 
14
<table class="navbar" border="0" width="100%" cellpadding="0"
 
15
       bgcolor="#a0c0ff" cellspacing="0">
 
16
  <tr valign="middle">
 
17
  <!-- Home link -->
 
18
      <th>&nbsp;&nbsp;&nbsp;<a
 
19
        href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
20
 
 
21
  <!-- Tree link -->
 
22
      <th>&nbsp;&nbsp;&nbsp;<a
 
23
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
24
 
 
25
  <!-- Index link -->
 
26
      <th>&nbsp;&nbsp;&nbsp;<a
 
27
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
28
 
 
29
  <!-- Help link -->
 
30
      <th>&nbsp;&nbsp;&nbsp;<a
 
31
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
32
 
 
33
  <!-- Project homepage -->
 
34
      <th class="navbar" align="right" width="100%">
 
35
        <table border="0" cellpadding="0" cellspacing="0">
 
36
          <tr><th class="navbar" align="center"
 
37
            ><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
 
38
          </tr></table></th>
 
39
  </tr>
 
40
</table>
 
41
<table width="100%" cellpadding="0" cellspacing="0">
 
42
  <tr valign="top">
 
43
    <td width="100%">
 
44
      <span class="breadcrumbs">
 
45
        <a href="epydoc-module.html">Package&nbsp;epydoc</a> ::
 
46
        <a href="epydoc.markup-module.html">Package&nbsp;markup</a> ::
 
47
        Module&nbsp;pyval_repr
 
48
      </span>
 
49
    </td>
 
50
    <td>
 
51
      <table cellpadding="0" cellspacing="0">
 
52
        <!-- hide/show private -->
 
53
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 
54
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 
55
        <tr><td align="right"><span class="options"
 
56
            >[<a href="frames.html" target="_top">frames</a
 
57
            >]&nbsp;|&nbsp;<a href="epydoc.markup.pyval_repr-module.html"
 
58
            target="_top">no&nbsp;frames</a>]</span></td></tr>
 
59
      </table>
 
60
    </td>
 
61
  </tr>
 
62
</table>
 
63
<!-- ==================== MODULE DESCRIPTION ==================== -->
 
64
<h1 class="epydoc">Module pyval_repr</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.pyval_repr-pysrc.html">source&nbsp;code</a></span></p>
 
65
<p>Syntax highlighter for Python values.  Currently provides special 
 
66
  colorization support for:</p>
 
67
  <ul>
 
68
    <li>
 
69
      lists, tuples, sets, frozensets, dicts
 
70
    </li>
 
71
    <li>
 
72
      numbers
 
73
    </li>
 
74
    <li>
 
75
      strings
 
76
    </li>
 
77
    <li>
 
78
      compiled regexps
 
79
    </li>
 
80
  </ul>
 
81
  <p>The highlighter also takes care of line-wrapping, and automatically 
 
82
  stops generating repr output as soon as it has exceeded the specified 
 
83
  number of lines (which should make it faster than pprint for large 
 
84
  values).  It does <i>not</i> bother to do automatic cycle detection, 
 
85
  because maxlines is typically around 5, so it's really not worth it.</p>
 
86
  <p>The syntax-highlighted output is encoded using a <a 
 
87
  href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html" 
 
88
  class="link">ParsedEpytextDocstring</a>, which can then be used to 
 
89
  generate output in a variety of formats.</p>
 
90
 
 
91
<!-- ==================== CLASSES ==================== -->
 
92
<a name="section-Classes"></a>
 
93
<table class="summary" border="1" cellpadding="3"
 
94
       cellspacing="0" width="100%" bgcolor="white">
 
95
<tr bgcolor="#70b0f0" class="table-header">
 
96
  <td colspan="2" class="table-header">
 
97
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
98
      <tr valign="top">
 
99
        <td align="left"><span class="table-header">Classes</span></td>
 
100
        <td align="right" valign="top"
 
101
         ><span class="options">[<a href="#section-Classes"
 
102
         class="privatelink" onclick="toggle_private();"
 
103
         >hide private</a>]</span></td>
 
104
      </tr>
 
105
    </table>
 
106
  </td>
 
107
</tr>
 
108
<tr class="private">
 
109
    <td width="15%" align="right" valign="top" class="summary">
 
110
      <span class="summary-type">&nbsp;</span>
 
111
    </td><td class="summary">
 
112
        <a href="epydoc.markup.pyval_repr._ColorizerState-class.html" class="summary-name" onclick="show_private();">_ColorizerState</a><br />
 
113
      An object uesd to keep track of the current state of the pyval 
 
114
        colorizer.
 
115
    </td>
 
116
  </tr>
 
117
<tr class="private">
 
118
    <td width="15%" align="right" valign="top" class="summary">
 
119
      <span class="summary-type">&nbsp;</span>
 
120
    </td><td class="summary">
 
121
        <a href="epydoc.markup.pyval_repr._Maxlines-class.html" class="summary-name" onclick="show_private();">_Maxlines</a><br />
 
122
      A control-flow exception that is raised when PyvalColorizer exeeds 
 
123
        the maximum number of allowed lines.
 
124
    </td>
 
125
  </tr>
 
126
<tr class="private">
 
127
    <td width="15%" align="right" valign="top" class="summary">
 
128
      <span class="summary-type">&nbsp;</span>
 
129
    </td><td class="summary">
 
130
        <a href="epydoc.markup.pyval_repr._Linebreak-class.html" class="summary-name" onclick="show_private();">_Linebreak</a><br />
 
131
      A control-flow exception that is raised when PyvalColorizer 
 
132
        generates a string containing a newline, but the state object's 
 
133
        linebreakok variable is False.
 
134
    </td>
 
135
  </tr>
 
136
<tr>
 
137
    <td width="15%" align="right" valign="top" class="summary">
 
138
      <span class="summary-type">&nbsp;</span>
 
139
    </td><td class="summary">
 
140
        <a href="epydoc.markup.pyval_repr.ColorizedPyvalRepr-class.html" class="summary-name">ColorizedPyvalRepr</a>
 
141
    </td>
 
142
  </tr>
 
143
<tr>
 
144
    <td width="15%" align="right" valign="top" class="summary">
 
145
      <span class="summary-type">&nbsp;</span>
 
146
    </td><td class="summary">
 
147
        <a href="epydoc.markup.pyval_repr.PyvalColorizer-class.html" class="summary-name">PyvalColorizer</a><br />
 
148
      Syntax highlighter for Python values.
 
149
    </td>
 
150
  </tr>
 
151
</table>
 
152
<!-- ==================== FUNCTIONS ==================== -->
 
153
<a name="section-Functions"></a>
 
154
<table class="summary" border="1" cellpadding="3"
 
155
       cellspacing="0" width="100%" bgcolor="white">
 
156
<tr bgcolor="#70b0f0" class="table-header">
 
157
  <td colspan="2" class="table-header">
 
158
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
159
      <tr valign="top">
 
160
        <td align="left"><span class="table-header">Functions</span></td>
 
161
        <td align="right" valign="top"
 
162
         ><span class="options">[<a href="#section-Functions"
 
163
         class="privatelink" onclick="toggle_private();"
 
164
         >hide private</a>]</span></td>
 
165
      </tr>
 
166
    </table>
 
167
  </td>
 
168
</tr>
 
169
<tr>
 
170
    <td width="15%" align="right" valign="top" class="summary">
 
171
      <span class="summary-type">&nbsp;</span>
 
172
    </td><td class="summary">
 
173
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
174
        <tr>
 
175
          <td><span class="summary-sig"><a name="is_re_pattern"></a><span class="summary-sig-name">is_re_pattern</span>(<span class="summary-sig-arg">pyval</span>)</span></td>
 
176
          <td align="right" valign="top">
 
177
            <span class="codelink"><a href="epydoc.markup.pyval_repr-pysrc.html#is_re_pattern">source&nbsp;code</a></span>
 
178
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_re_pattern-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
 
179
          </td>
 
180
        </tr>
 
181
      </table>
 
182
      <div style="display:none" id="call_graph_for_is_re_pattern-summary-div"><center>
 
183
<table border="0" cellpadding="0" cellspacing="0">
 
184
  <tr><td><center>  <map id="call_graph_for_is_re_pattern" name="call_graph_for_is_re_pattern">
 
185
<area shape="rect" href="epydoc.markup.pyval_repr.PyvalColorizer&#45;class.html#_colorize" title="PyvalColorizer._colorize()" alt="" coords="7,6,225,38" />
 
186
<area shape="rect" href="epydoc.markup.pyval_repr&#45;module.html#is_re_pattern" title="is_re_pattern()" alt="" coords="276,6,407,38" />
 
187
</map>
 
188
  <img src="call_graph_for_is_re_pattern.gif" alt='' usemap="#call_graph_for_is_re_pattern" ismap="ismap" class="graph-without-title" />
 
189
</center></td></tr>
 
190
  <tr><th>Call Graph</th></tr>
 
191
</table><br />
 
192
</center></div>
 
193
 
 
194
    </td>
 
195
  </tr>
 
196
<tr>
 
197
    <td width="15%" align="right" valign="top" class="summary">
 
198
      <span class="summary-type">&nbsp;</span>
 
199
    </td><td class="summary">
 
200
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
201
        <tr>
 
202
          <td><span class="summary-sig"><a name="colorize_pyval"></a><span class="summary-sig-name">colorize_pyval</span>(<span class="summary-sig-arg">pyval</span>,
 
203
        <span class="summary-sig-arg">parse_repr</span>=<span class="summary-sig-default">None</span>,
 
204
        <span class="summary-sig-arg">min_score</span>=<span class="summary-sig-default">None</span>,
 
205
        <span class="summary-sig-arg">linelen</span>=<span class="summary-sig-default">75</span>,
 
206
        <span class="summary-sig-arg">maxlines</span>=<span class="summary-sig-default">5</span>,
 
207
        <span class="summary-sig-arg">linebreakok</span>=<span class="summary-sig-default">True</span>,
 
208
        <span class="summary-sig-arg">sort</span>=<span class="summary-sig-default">True</span>)</span></td>
 
209
          <td align="right" valign="top">
 
210
            <span class="codelink"><a href="epydoc.markup.pyval_repr-pysrc.html#colorize_pyval">source&nbsp;code</a></span>
 
211
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_colorize_pyval-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
 
212
          </td>
 
213
        </tr>
 
214
      </table>
 
215
      <div style="display:none" id="call_graph_for_colorize_pyval-summary-div"><center>
 
216
<table border="0" cellpadding="0" cellspacing="0">
 
217
  <tr><td><center>  <map id="call_graph_for_colorize_pyval" name="call_graph_for_colorize_pyval">
 
218
<area shape="rect" href="epydoc.apidoc.ValueDoc&#45;class.html#pyval_repr" title="apidoc.ValueDoc.pyval_repr()" alt="" coords="46,6,294,38" />
 
219
<area shape="rect" href="epydoc.markup.pyval_repr&#45;module.html#colorize_pyval" title="colorize_pyval()" alt="" coords="383,34,527,66" />
 
220
<area shape="rect" href="epydoc.apidoc.ValueDoc&#45;class.html#summary_pyval_repr" title="apidoc.ValueDoc.summary_pyval_repr()" alt="" coords="6,62,334,94" />
 
221
<area shape="rect" href="epydoc.markup.pyval_repr.PyvalColorizer&#45;class.html#__init__" title="PyvalColorizer.__init__()" alt="" coords="576,6,790,38" />
 
222
<area shape="rect" href="epydoc.markup.pyval_repr.PyvalColorizer&#45;class.html#colorize" title="PyvalColorizer.colorize()" alt="" coords="578,62,788,94" />
 
223
</map>
 
224
  <img src="call_graph_for_colorize_pyval.gif" alt='' usemap="#call_graph_for_colorize_pyval" ismap="ismap" class="graph-without-title" />
 
225
</center></td></tr>
 
226
  <tr><th>Call Graph</th></tr>
 
227
</table><br />
 
228
</center></div>
 
229
 
 
230
    </td>
 
231
  </tr>
 
232
</table>
 
233
<!-- ==================== NAVIGATION BAR ==================== -->
 
234
<table class="navbar" border="0" width="100%" cellpadding="0"
 
235
       bgcolor="#a0c0ff" cellspacing="0">
 
236
  <tr valign="middle">
 
237
  <!-- Home link -->
 
238
      <th>&nbsp;&nbsp;&nbsp;<a
 
239
        href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
240
 
 
241
  <!-- Tree link -->
 
242
      <th>&nbsp;&nbsp;&nbsp;<a
 
243
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
244
 
 
245
  <!-- Index link -->
 
246
      <th>&nbsp;&nbsp;&nbsp;<a
 
247
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
248
 
 
249
  <!-- Help link -->
 
250
      <th>&nbsp;&nbsp;&nbsp;<a
 
251
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
252
 
 
253
  <!-- Project homepage -->
 
254
      <th class="navbar" align="right" width="100%">
 
255
        <table border="0" cellpadding="0" cellspacing="0">
 
256
          <tr><th class="navbar" align="center"
 
257
            ><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
 
258
          </tr></table></th>
 
259
  </tr>
 
260
</table>
 
261
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
262
  <tr>
 
263
    <td align="left" class="footer">
 
264
    <a href="epydoc-log.html">Generated by Epydoc
 
265
    3.0.1 on Wed Jan 30 14:06:46 2008</a>
 
266
    </td>
 
267
    <td align="right" class="footer">
 
268
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
 
269
        >http://epydoc.sourceforge.net</a>
 
270
    </td>
 
271
  </tr>
 
272
</table>
 
273
 
 
274
<script type="text/javascript">
 
275
  <!--
 
276
  // Private objects are initially displayed (because if
 
277
  // javascript is turned off then we want them to be
 
278
  // visible); but by default, we want to hide them.  So hide
 
279
  // them unless we have a cookie that says to show them.
 
280
  checkCookie();
 
281
  // -->
 
282
</script>
 
283
</body>
 
284
</html>