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">
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>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="epydoc-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
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>
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
45
<a href="epydoc-module.html">Package epydoc</a> ::
46
<a href="epydoc.markup-module.html">Package markup</a> ::
47
Module pyval_repr
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 private</a>]</span></td></tr>
55
<tr><td align="right"><span class="options"
56
>[<a href="frames.html" target="_top">frames</a
57
>] | <a href="epydoc.markup.pyval_repr-module.html"
58
target="_top">no frames</a>]</span></td></tr>
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 code</a></span></p>
65
<p>Syntax highlighter for Python values. Currently provides special
66
colorization support for:</p>
69
lists, tuples, sets, frozensets, dicts
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>
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%">
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>
109
<td width="15%" align="right" valign="top" class="summary">
110
<span class="summary-type"> </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
118
<td width="15%" align="right" valign="top" class="summary">
119
<span class="summary-type"> </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.
127
<td width="15%" align="right" valign="top" class="summary">
128
<span class="summary-type"> </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.
137
<td width="15%" align="right" valign="top" class="summary">
138
<span class="summary-type"> </span>
139
</td><td class="summary">
140
<a href="epydoc.markup.pyval_repr.ColorizedPyvalRepr-class.html" class="summary-name">ColorizedPyvalRepr</a>
144
<td width="15%" align="right" valign="top" class="summary">
145
<span class="summary-type"> </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.
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%">
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>
170
<td width="15%" align="right" valign="top" class="summary">
171
<span class="summary-type"> </span>
172
</td><td class="summary">
173
<table width="100%" cellpadding="0" cellspacing="0" border="0">
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 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 graph</a></span>
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-class.html#_colorize" title="PyvalColorizer._colorize()" alt="" coords="7,6,225,38" />
186
<area shape="rect" href="epydoc.markup.pyval_repr-module.html#is_re_pattern" title="is_re_pattern()" alt="" coords="276,6,407,38" />
188
<img src="call_graph_for_is_re_pattern.gif" alt='' usemap="#call_graph_for_is_re_pattern" ismap="ismap" class="graph-without-title" />
190
<tr><th>Call Graph</th></tr>
197
<td width="15%" align="right" valign="top" class="summary">
198
<span class="summary-type"> </span>
199
</td><td class="summary">
200
<table width="100%" cellpadding="0" cellspacing="0" border="0">
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 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 graph</a></span>
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-class.html#pyval_repr" title="apidoc.ValueDoc.pyval_repr()" alt="" coords="46,6,294,38" />
219
<area shape="rect" href="epydoc.markup.pyval_repr-module.html#colorize_pyval" title="colorize_pyval()" alt="" coords="383,34,527,66" />
220
<area shape="rect" href="epydoc.apidoc.ValueDoc-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-class.html#__init__" title="PyvalColorizer.__init__()" alt="" coords="576,6,790,38" />
222
<area shape="rect" href="epydoc.markup.pyval_repr.PyvalColorizer-class.html#colorize" title="PyvalColorizer.colorize()" alt="" coords="578,62,788,94" />
224
<img src="call_graph_for_colorize_pyval.gif" alt='' usemap="#call_graph_for_colorize_pyval" ismap="ismap" class="graph-without-title" />
226
<tr><th>Call Graph</th></tr>
233
<!-- ==================== NAVIGATION BAR ==================== -->
234
<table class="navbar" border="0" width="100%" cellpadding="0"
235
bgcolor="#a0c0ff" cellspacing="0">
238
<th> <a
239
href="epydoc-module.html">Home</a> </th>
242
<th> <a
243
href="module-tree.html">Trees</a> </th>
246
<th> <a
247
href="identifier-index.html">Indices</a> </th>
250
<th> <a
251
href="help.html">Help</a> </th>
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>
261
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
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>
267
<td align="right" class="footer">
268
<a target="mainFrame" href="http://epydoc.sourceforge.net"
269
>http://epydoc.sourceforge.net</a>
274
<script type="text/javascript">
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.