<?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>pyxb.utils.unicode.CodePointSet</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="pyxb-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" >PyXB hosted on <a href="http://sourceforge.net/projects/pyxb"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=263147&type=9" width="80" height="15" alt="Get PyXB: Python XML Schema Bindings at SourceForge.net. Fast, secure and Free Open Source software downloads"/></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="pyxb-module.html">Package pyxb</a> :: <a href="pyxb.utils-module.html">Package utils</a> :: <a href="pyxb.utils.unicode-module.html">Module unicode</a> :: Class CodePointSet </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="pyxb.utils.unicode.CodePointSet-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class CodePointSet</h1><p class="nomargin-top"><span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet">source code</a></span></p> <pre class="base-tree"> object --+ | <strong class="uidshort">CodePointSet</strong> </pre> <hr /> <p>Represent a set of Unicode code points.</p> <p>Each code point is an integral value between 0 and 0x10FFFF. This class is used to represent a set of code points in a manner suitable for use as regular expression character sets.</p> <!-- ==================== 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 colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Instance Methods</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-InstanceMethods" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></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="__cmp__"></a><span class="summary-sig-name">__cmp__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">other</span>)</span><br /> Equality is delegated to the codepoints list.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.__cmp__">source code</a></span> </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="pyxb.utils.unicode.CodePointSet-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">*args</span>)</span><br /> x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.__init__">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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="__mutate"></a><span class="summary-sig-name">__mutate</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">value</span>, <span class="summary-sig-arg">do_add</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.__mutate">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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="__unichr"></a><span class="summary-sig-name">__unichr</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">code_point</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.__unichr">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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="_codepoints"></a><span class="summary-sig-name">_codepoints</span>(<span class="summary-sig-arg">self</span>)</span><br /> For testing purrposes only, access to the codepoints internal representation.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet._codepoints">source code</a></span> </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="pyxb.utils.unicode.CodePointSet-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">value</span>)</span><br /> Add the given value to the code point set.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.add">source code</a></span> </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="pyxb.utils.unicode.CodePointSet-class.html#asPattern" class="summary-sig-name">asPattern</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">with_brackets</span>=<span class="summary-sig-default">True</span>)</span><br /> Return the code point set as Unicode regular expression character group consisting of a sequence of characters or character ranges.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.asPattern">source code</a></span> </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="asSingleCharacter"></a><span class="summary-sig-name">asSingleCharacter</span>(<span class="summary-sig-arg">self</span>)</span><br /> If this set represents a single character, return it as its unicode string value.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.asSingleCharacter">source code</a></span> </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="pyxb.utils.unicode.CodePointSet-class.html#asTuples" class="summary-sig-name">asTuples</a>(<span class="summary-sig-arg">self</span>)</span><br /> Return the codepoints as tuples denoting the ranges that are in the set.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.asTuples">source code</a></span> </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="pyxb.utils.unicode.CodePointSet-class.html#extend" class="summary-sig-name">extend</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">values</span>)</span><br /> Add multiple values to a code point set.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.extend">source code</a></span> </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="negate"></a><span class="summary-sig-name">negate</span>(<span class="summary-sig-arg">self</span>)</span><br /> Return an instance that represents the inverse of this set.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.negate">source code</a></span> </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="pyxb.utils.unicode.CodePointSet-class.html#subtract" class="summary-sig-name">subtract</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">value</span>)</span><br /> Remove the given value from the code point set.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.subtract">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__delattr__</code>, <code>__format__</code>, <code>__getattribute__</code>, <code>__hash__</code>, <code>__new__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__repr__</code>, <code>__setattr__</code>, <code>__sizeof__</code>, <code>__str__</code>, <code>__subclasshook__</code> </p> </td> </tr> </table> <!-- ==================== CLASS VARIABLES ==================== --> <a name="section-ClassVariables"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Class Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-ClassVariables" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="MaxCodePoint"></a><span class="summary-name">MaxCodePoint</span> = <code title="65535">65535</code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="MaxShortCodePoint"></a><span class="summary-name">MaxShortCodePoint</span> = <code title="65535">65535</code> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="__NotXMLChar_set"></a><span class="summary-name">__NotXMLChar_set</span> = <code title="frozenset(['-', '[', ']'])"><code class="variable-group">frozenset([</code><code class="variable-quote">'</code><code class="variable-string">-</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">[</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">]</code><code class="variable-quote">'</code><code class="variable-group">])</code></code> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="__codepoints"></a><span class="summary-name">__codepoints</span> = <code title="None">None</code><br /> hash(x) </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 colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Properties</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Properties" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </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 colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Method Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-MethodDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="__init__"></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">__init__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">*args</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.__init__">source code</a></span> </td> </tr></table> <p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p> <dl class="fields"> <dt>Overrides: object.__init__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <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">value</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.add">source code</a></span> </td> </tr></table> <p>Add the given value to the code point set.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>value</code></strong> - An integral value denoting a code point, or a tuple <code>(s,e)</code> denoting the start and end (inclusive) code points in a range.</li> </ul></dd> <dt>Returns:</dt> <dd><code>self</code></dd> </dl> </td></tr></table> </div> <a name="asPattern"></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">asPattern</span>(<span class="sig-arg">self</span>, <span class="sig-arg">with_brackets</span>=<span class="sig-default">True</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.asPattern">source code</a></span> </td> </tr></table> <p>Return the code point set as Unicode regular expression character group consisting of a sequence of characters or character ranges.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>with_brackets</code></strong> - If <code>True</code> (default), square brackets are added to enclose the returned character group.</li> </ul></dd> </dl> </td></tr></table> </div> <a name="asTuples"></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">asTuples</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.asTuples">source code</a></span> </td> </tr></table> <p>Return the codepoints as tuples denoting the ranges that are in the set.</p> <p>Each tuple <code>(s, e)</code> indicates that the code points from <code>s</code> (inclusive) to <code>e</code>) (inclusive) are in the set.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="extend"></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">extend</span>(<span class="sig-arg">self</span>, <span class="sig-arg">values</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.extend">source code</a></span> </td> </tr></table> <p>Add multiple values to a code point set.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>values</code></strong> - Either a <a href="pyxb.utils.unicode.CodePointSet-class.html" class="link">CodePointSet</a> instance, or an iterable whose members are valid parameters to <a href="pyxb.utils.unicode.CodePointSet-class.html#add" class="link">add</a>.</li> </ul></dd> <dt>Returns:</dt> <dd><code>self</code></dd> </dl> </td></tr></table> </div> <a name="subtract"></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">subtract</span>(<span class="sig-arg">self</span>, <span class="sig-arg">value</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxb.utils.unicode-pysrc.html#CodePointSet.subtract">source code</a></span> </td> </tr></table> <p>Remove the given value from the code point set.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>value</code></strong> - An integral value denoting a code point, or a tuple <code>(s,e)</code> denoting the start and end (inclusive) code points in a range, or a <a href="pyxb.utils.unicode.CodePointSet-class.html" class="link">CodePointSet</a>.</li> </ul></dd> <dt>Returns:</dt> <dd><code>self</code></dd> </dl> </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="pyxb-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" >PyXB hosted on <a href="http://sourceforge.net/projects/pyxb"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=263147&type=9" width="80" height="15" alt="Get PyXB: Python XML Schema Bindings at SourceForge.net. Fast, secure and Free Open Source software downloads"/></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 May 30 12:40:31 2010 </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>