Your IP : 216.73.216.213
<?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>pyparsing.Word</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="pyparsing-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"
>pyparsing</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="pyparsing-module.html">Module pyparsing</a> ::
Class Word
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="pyparsing.Word-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Word</h1><p class="nomargin-top"><span class="codelink"><a href="pyparsing-pysrc.html#Word">source code</a></span></p>
<pre class="base-tree">
object --+
|
<a href="pyparsing.ParserElement-class.html">ParserElement</a> --+
|
<a href="pyparsing.Token-class.html">Token</a> --+
|
<strong class="uidshort">Word</strong>
</pre>
<hr />
<p>Token for matching words composed of allowed character sets. Defined
with string containing all allowed initial characters, an optional string
containing allowed body characters (if omitted, defaults to the initial
character set), and an optional minimum, maximum, and/or exact length.
The default value for <code>min</code> is 1 (a minimum value < 1 is
not valid); the default values for <code>max</code> and
<code>exact</code> are 0, meaning no maximum or exact length restriction.
An optional <code>excludeChars</code> parameter can list characters that
might be found in the input <code>bodyChars</code> string; useful to
define a word of all printables except for one or two characters, for
instance.</p>
<p><a href="pyparsing-module.html#srange" class="link">srange</a> is
useful for defining custom character set strings for defining
<code>Word</code> expressions, using range notation from regular
expression character sets.</p>
<p>A common mistake is to use <code>Word</code> to match a specific
literal string, as in <code>Word("Address")</code>. Remember
that <code>Word</code> uses the string argument to define <i>sets</i> of
matchable characters. This expression would match "Add",
"AAA", "dAred", or any other word made up of the
characters 'A', 'd', 'r', 'e', and 's'. To match an exact literal string,
use <a href="pyparsing.Literal-class.html" class="link"
onclick="show_private();">Literal</a> or <a
href="pyparsing.Keyword-class.html" class="link">Keyword</a>.</p>
<p>pyparsing includes helper strings for building Words:</p>
<ul>
<li>
<a href="pyparsing-module.html#alphas" class="link">alphas</a>
</li>
<li>
<a href="pyparsing-module.html#nums" class="link">nums</a>
</li>
<li>
<a href="pyparsing-module.html#alphanums" class="link">alphanums</a>
</li>
<li>
<a href="pyparsing-module.html#hexnums" class="link">hexnums</a>
</li>
<li>
<a href="pyparsing-module.html#alphas8bit"
class="link">alphas8bit</a> (alphabetic characters in ASCII range
128-255 - accented, tilded, umlauted, etc.)
</li>
<li>
<a href="pyparsing-module.html#punc8bit" class="link">punc8bit</a>
(non-alphabetic characters in ASCII range 128-255 - currency,
symbols, superscripts, diacriticals, etc.)
</li>
<li>
<a href="pyparsing-module.html#printables"
class="link">printables</a> (any non-whitespace character)
</li>
</ul>
<p>Example:</p>
<pre class="literalblock">
# a word composed of digits
integer = Word(nums) # equivalent to Word("0123456789") or Word(srange("0-9"))
# a word with a leading capital, and zero or more lowercase
capital_word = Word(alphas.upper(), alphas.lower())
# hostnames are alphanumeric, with leading alpha, and '-'
hostname = Word(alphas, alphanums+'-')
# roman numeral (not a strict parser, accepts invalid mix of characters)
roman = Word("IVXLCDM")
# any string of non-whitespace characters, except for ','
csv_value = Word(printables, excludeChars=",")
</pre>
<!-- ==================== 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="pyparsing.Word-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">initChars</span>,
<span class="summary-sig-arg">bodyChars</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">min</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">max</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">exact</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">asKeyword</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">excludeChars</span>=<span class="summary-sig-default">None</span>)</span><br />
x.__init__(...) initializes x; see help(type(x)) for signature</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing-pysrc.html#Word.__init__">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="pyparsing.Word-class.html#parseImpl" class="summary-sig-name">parseImpl</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">instring</span>,
<span class="summary-sig-arg">loc</span>,
<span class="summary-sig-arg">doActions</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing-pysrc.html#Word.parseImpl">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="pyparsing.Word-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
str(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing-pysrc.html#Word.__str__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyparsing.ParserElement-class.html">ParserElement</a></code></b>:
<code><a href="pyparsing.ParserElement-class.html#__add__">__add__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__and__">__and__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__call__">__call__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__eq__">__eq__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__hash__">__hash__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__invert__">__invert__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__mul__">__mul__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__ne__">__ne__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__or__">__or__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__radd__">__radd__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__rand__">__rand__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__repr__">__repr__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__req__">__req__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__rmul__">__rmul__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__rne__">__rne__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__ror__">__ror__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__rsub__">__rsub__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__rxor__">__rxor__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__sub__">__sub__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#__xor__">__xor__</a></code>,
<code><a href="pyparsing.ParserElement-class.html#addCondition">addCondition</a></code>,
<code><a href="pyparsing.ParserElement-class.html#addParseAction">addParseAction</a></code>,
<code><a href="pyparsing.ParserElement-class.html#canParseNext">canParseNext</a></code>,
<code><a href="pyparsing.ParserElement-class.html#checkRecursion">checkRecursion</a></code>,
<code><a href="pyparsing.ParserElement-class.html#copy">copy</a></code>,
<code><a href="pyparsing.ParserElement-class.html#ignore">ignore</a></code>,
<code><a href="pyparsing.ParserElement-class.html#leaveWhitespace">leaveWhitespace</a></code>,
<code><a href="pyparsing.ParserElement-class.html#matches">matches</a></code>,
<code><a href="pyparsing.ParserElement-class.html#parseFile">parseFile</a></code>,
<code><a href="pyparsing.ParserElement-class.html#parseString">parseString</a></code>,
<code><a href="pyparsing.ParserElement-class.html#parseWithTabs">parseWithTabs</a></code>,
<code><a href="pyparsing.ParserElement-class.html#postParse">postParse</a></code>,
<code><a href="pyparsing.ParserElement-class.html#preParse">preParse</a></code>,
<code><a href="pyparsing.ParserElement-class.html#runTests">runTests</a></code>,
<code><a href="pyparsing.ParserElement-class.html#scanString">scanString</a></code>,
<code><a href="pyparsing.ParserElement-class.html#searchString">searchString</a></code>,
<code><a href="pyparsing.ParserElement-class.html#setBreak">setBreak</a></code>,
<code><a href="pyparsing.ParserElement-class.html#setDebug">setDebug</a></code>,
<code><a href="pyparsing.ParserElement-class.html#setDebugActions">setDebugActions</a></code>,
<code><a href="pyparsing.ParserElement-class.html#setFailAction">setFailAction</a></code>,
<code><a href="pyparsing.ParserElement-class.html#setName">setName</a></code>,
<code><a href="pyparsing.ParserElement-class.html#setParseAction">setParseAction</a></code>,
<code><a href="pyparsing.ParserElement-class.html#setResultsName">setResultsName</a></code>,
<code><a href="pyparsing.ParserElement-class.html#setWhitespaceChars">setWhitespaceChars</a></code>,
<code><a href="pyparsing.ParserElement-class.html#split">split</a></code>,
<code><a href="pyparsing.ParserElement-class.html#streamline">streamline</a></code>,
<code><a href="pyparsing.ParserElement-class.html#suppress">suppress</a></code>,
<code><a href="pyparsing.ParserElement-class.html#transformString">transformString</a></code>,
<code><a href="pyparsing.ParserElement-class.html#tryParse">tryParse</a></code>,
<code><a href="pyparsing.ParserElement-class.html#validate">validate</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></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">Static Methods</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyparsing.ParserElement-class.html">ParserElement</a></code></b>:
<code><a href="pyparsing.ParserElement-class.html#enablePackrat">enablePackrat</a></code>,
<code><a href="pyparsing.ParserElement-class.html#inlineLiteralsUsing">inlineLiteralsUsing</a></code>,
<code><a href="pyparsing.ParserElement-class.html#resetCache">resetCache</a></code>,
<code><a href="pyparsing.ParserElement-class.html#setDefaultWhitespaceChars">setDefaultWhitespaceChars</a></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 align="left" colspan="2" class="table-header">
<span class="table-header">Class Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__slotnames__"></a><span class="summary-name">__slotnames__</span> = <code title="[]"><code class="variable-group">[</code><code class="variable-group">]</code></code>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyparsing.ParserElement-class.html">ParserElement</a></code></b>:
<code><a href="pyparsing.ParserElement-class.html#DEFAULT_WHITE_CHARS">DEFAULT_WHITE_CHARS</a></code>,
<code><a href="pyparsing.ParserElement-class.html#packrat_cache">packrat_cache</a></code>,
<code><a href="pyparsing.ParserElement-class.html#packrat_cache_lock">packrat_cache_lock</a></code>,
<code><a href="pyparsing.ParserElement-class.html#packrat_cache_stats">packrat_cache_stats</a></code>,
<code><a href="pyparsing.ParserElement-class.html#verbose_stacktrace">verbose_stacktrace</a></code>
</p>
</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="__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">initChars</span>,
<span class="sig-arg">bodyChars</span>=<span class="sig-default">None</span>,
<span class="sig-arg">min</span>=<span class="sig-default">1</span>,
<span class="sig-arg">max</span>=<span class="sig-default">0</span>,
<span class="sig-arg">exact</span>=<span class="sig-default">0</span>,
<span class="sig-arg">asKeyword</span>=<span class="sig-default">False</span>,
<span class="sig-arg">excludeChars</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing-pysrc.html#Word.__init__">source code</a></span>
</td>
</tr></table>
<p>x.__init__(...) initializes x; see help(type(x)) 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="parseImpl"></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">parseImpl</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">instring</span>,
<span class="sig-arg">loc</span>,
<span class="sig-arg">doActions</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing-pysrc.html#Word.parseImpl">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="pyparsing.ParserElement-class.html#parseImpl">ParserElement.parseImpl</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__str__"></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">__str__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing-pysrc.html#Word.__str__">source code</a></span>
</td>
</tr></table>
<p>str(x)</p>
<dl class="fields">
<dt>Overrides:
object.__str__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</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="pyparsing-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"
>pyparsing</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 Thu Oct 06 20:32:30 2016
</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>