<?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>genshi.core.Markup</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="genshi-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="../index.html">Documentation Index</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="genshi-module.html">Package genshi</a> :: <a href="genshi.core-module.html">Module core</a> :: Class Markup </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class Markup</h1><p class="nomargin-top"></p> <pre class="base-tree"> object --+ | basestring --+ | unicode --+ | <strong class="uidshort">Markup</strong> </pre> <hr /> Marks a string as being safe for inclusion in HTML/XML output without needing to be escaped. <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Instance Methods</span></td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.core.Markup-class.html#__add__" class="summary-sig-name">__add__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">other</span>)</span><br /> x+y</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.core.Markup-class.html#__mod__" class="summary-sig-name">__mod__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">args</span>)</span><br /> x%y</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.core.Markup-class.html#__mul__" class="summary-sig-name">__mul__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">num</span>)</span><br /> n*x</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="__radd__"></a><span class="summary-sig-name">__radd__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">other</span>)</span></td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.core.Markup-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br /> repr(x)</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.core.Markup-class.html#__rmul__" class="summary-sig-name">__rmul__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">num</span>)</span><br /> n*x</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><a href="genshi.core.Markup-class.html" class="link">Markup</a></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.core.Markup-class.html#join" class="summary-sig-name">join</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">seq</span>, <span class="summary-sig-arg">escape_quotes</span>=<span class="summary-sig-default">True</span>)</span><br /> Return a <a href="genshi.core.Markup-class.html" class="link">Markup</a> object which is the concatenation of the strings in the given sequence, where this <a href="genshi.core.Markup-class.html" class="link">Markup</a> object is the separator between the joined elements.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><a href="genshi.core.Markup-class.html" class="link">Markup</a></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.core.Markup-class.html#stripentities" class="summary-sig-name">stripentities</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">keepxmlentities</span>=<span class="summary-sig-default">False</span>)</span><br /> Return a copy of the text with any character or numeric entities replaced by the equivalent UTF-8 characters.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><a href="genshi.core.Markup-class.html" class="link">Markup</a></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.core.Markup-class.html#striptags" class="summary-sig-name">striptags</a>(<span class="summary-sig-arg">self</span>)</span><br /> Return a copy of the text with all XML/HTML tags removed.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code class="link">unicode</code></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.core.Markup-class.html#unescape" class="summary-sig-name">unescape</a>(<span class="summary-sig-arg">self</span>)</span><br /> Reverse-escapes &, <, >, and " and returns a <code class="link">unicode</code> object.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>unicode</code></b>: <code>__contains__</code>, <code>__eq__</code>, <code>__format__</code>, <code>__ge__</code>, <code>__getattribute__</code>, <code>__getitem__</code>, <code>__getnewargs__</code>, <code>__getslice__</code>, <code>__gt__</code>, <code>__hash__</code>, <code>__le__</code>, <code>__len__</code>, <code>__lt__</code>, <code>__ne__</code>, <code>__new__</code>, <code>__rmod__</code>, <code>__sizeof__</code>, <code>__str__</code>, <code>capitalize</code>, <code>center</code>, <code>count</code>, <code>decode</code>, <code>encode</code>, <code>endswith</code>, <code>expandtabs</code>, <code>find</code>, <code>format</code>, <code>index</code>, <code>isalnum</code>, <code>isalpha</code>, <code>isdecimal</code>, <code>isdigit</code>, <code>islower</code>, <code>isnumeric</code>, <code>isspace</code>, <code>istitle</code>, <code>isupper</code>, <code>ljust</code>, <code>lower</code>, <code>lstrip</code>, <code>partition</code>, <code>replace</code>, <code>rfind</code>, <code>rindex</code>, <code>rjust</code>, <code>rpartition</code>, <code>rsplit</code>, <code>rstrip</code>, <code>split</code>, <code>splitlines</code>, <code>startswith</code>, <code>strip</code>, <code>swapcase</code>, <code>title</code>, <code>translate</code>, <code>upper</code>, <code>zfill</code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__delattr__</code>, <code>__init__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__setattr__</code>, <code>__subclasshook__</code> </p> </td> </tr> </table> <!-- ==================== CLASS METHODS ==================== --> <a name="section-ClassMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Class Methods</span></td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><a href="genshi.core.Markup-class.html" class="link">Markup</a></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.core.Markup-class.html#escape" class="summary-sig-name">escape</a>(<span class="summary-sig-arg">cls</span>, <span class="summary-sig-arg">text</span>, <span class="summary-sig-arg">quotes</span>=<span class="summary-sig-default">True</span>)</span><br /> Create a Markup instance from a string and escape special characters it may contain (<, >, & and ").</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> </table> <!-- ==================== PROPERTIES ==================== --> <a name="section-Properties"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Properties</span></td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__class__</code> </p> </td> </tr> </table> <!-- ==================== METHOD DETAILS ==================== --> <a name="section-MethodDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Method Details</span></td> </tr> </table> <a name="__add__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__add__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">other</span>)</span> <br /><em class="fname">(Addition operator)</em> </h3> </td><td align="right" valign="top" > </td> </tr></table> x+y <dl class="fields"> <dt>Overrides: unicode.__add__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="__mod__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__mod__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">args</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> x%y <dl class="fields"> <dt>Overrides: unicode.__mod__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="__mul__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__mul__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">num</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> n*x <dl class="fields"> <dt>Overrides: unicode.__mul__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="__repr__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span> <br /><em class="fname">(Representation operator)</em> </h3> </td><td align="right" valign="top" > </td> </tr></table> repr(x) <dl class="fields"> <dt>Overrides: object.__repr__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="__rmul__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__rmul__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">num</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> n*x <dl class="fields"> <dt>Overrides: unicode.__rmul__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="escape"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">escape</span>(<span class="sig-arg">cls</span>, <span class="sig-arg">text</span>, <span class="sig-arg">quotes</span>=<span class="sig-default">True</span>)</span> <br /><em class="fname">Class Method</em> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Create a Markup instance from a string and escape special characters it may contain (<, >, & and ").</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span>escape(<span class="py-string">'"1 < 2"'</span>) <span class="py-output"><Markup u'&#34;1 &lt; 2&#34;'></span></pre> <p>If the <code class="link">quotes</code> parameter is set to <code class="link">False</code>, the " character is left as is. Escaping quotes is generally only required for strings that are to be used in attribute values.</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span>escape(<span class="py-string">'"1 < 2"'</span>, quotes=False) <span class="py-output"><Markup u'"1 &lt; 2"'></span></pre> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>text</code></strong> - the text to escape</li> <li><strong class="pname"><code>quotes</code></strong> - if <tt class="rst-docutils literal">True</tt>, double quote characters are escaped in addition to the other special characters</li> </ul></dd> <dt>Returns: <a href="genshi.core.Markup-class.html" class="link">Markup</a></dt> <dd>the escaped <a href="genshi.core.Markup-class.html" class="link">Markup</a> string</dd> </dl> </td></tr></table> </div> <a name="join"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">join</span>(<span class="sig-arg">self</span>, <span class="sig-arg">seq</span>, <span class="sig-arg">escape_quotes</span>=<span class="sig-default">True</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return a <a href="genshi.core.Markup-class.html" class="link">Markup</a> object which is the concatenation of the strings in the given sequence, where this <a href="genshi.core.Markup-class.html" class="link">Markup</a> object is the separator between the joined elements.</p> <p>Any element in the sequence that is not a <a href="genshi.core.Markup-class.html" class="link">Markup</a> instance is automatically escaped.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>seq</code></strong> - the sequence of strings to join</li> <li><strong class="pname"><code>escape_quotes</code></strong> - whether double quote characters in the elements should be escaped</li> </ul></dd> <dt>Returns: <a href="genshi.core.Markup-class.html" class="link">Markup</a></dt> <dd>the joined <a href="genshi.core.Markup-class.html" class="link">Markup</a> object</dd> <dt>Overrides: unicode.join </dt> </dl> <div class="fields"> <p><strong>See Also:</strong> <a href="genshi.core.Markup-class.html#escape" class="link">escape</a> </p> </div></td></tr></table> </div> <a name="stripentities"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">stripentities</span>(<span class="sig-arg">self</span>, <span class="sig-arg">keepxmlentities</span>=<span class="sig-default">False</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return a copy of the text with any character or numeric entities replaced by the equivalent UTF-8 characters.</p> <p>If the <code class="link">keepxmlentities</code> parameter is provided and evaluates to <code class="link">True</code>, the core XML entities (<tt class="rst-docutils literal">&amp;</tt>, <tt class="rst-docutils literal">&apos;</tt>, <tt class="rst-docutils literal">&gt;</tt>, <tt class="rst-docutils literal">&lt;</tt> and <tt class="rst-docutils literal">&quot;</tt>) are not stripped.</p> <dl class="fields"> <dt>Returns: <a href="genshi.core.Markup-class.html" class="link">Markup</a></dt> <dd>a <a href="genshi.core.Markup-class.html" class="link">Markup</a> instance with entities removed</dd> </dl> <div class="fields"> <p><strong>See Also:</strong> <a href="genshi.util-module.html#stripentities" class="link">genshi.util.stripentities</a> </p> </div></td></tr></table> </div> <a name="striptags"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">striptags</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> Return a copy of the text with all XML/HTML tags removed. <dl class="fields"> <dt>Returns: <a href="genshi.core.Markup-class.html" class="link">Markup</a></dt> <dd>a <a href="genshi.core.Markup-class.html" class="link">Markup</a> instance with all tags removed</dd> </dl> <div class="fields"> <p><strong>See Also:</strong> <a href="genshi.util-module.html#striptags" class="link">genshi.util.striptags</a> </p> </div></td></tr></table> </div> <a name="unescape"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">unescape</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Reverse-escapes &, <, >, and " and returns a <code class="link">unicode</code> object.</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span>Markup(<span class="py-string">'1 &lt; 2'</span>).unescape() <span class="py-output">u'1 < 2'</span></pre> <dl class="fields"> <dt>Returns: <code class="link">unicode</code></dt> <dd>the unescaped string</dd> </dl> <div class="fields"> <p><strong>See Also:</strong> <a href="genshi.core-module.html#unescape" class="link">genshi.core.unescape</a> </p> </div></td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="genshi-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="../index.html">Documentation Index</a></th> </tr></table></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Sun Jan 27 18:17:20 2013 </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>