<?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.pyparsing.Keyword</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.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"> Package pyparsing :: <a href="pyparsing.pyparsing-module.html">Module pyparsing</a> :: Class Keyword </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.pyparsing.Keyword-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class Keyword</h1><p class="nomargin-top"><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#Keyword">source code</a></span></p> <pre class="base-tree"> object --+ | <a href="pyparsing.pyparsing.ParserElement-class.html">ParserElement</a> --+ | <a href="pyparsing.pyparsing.Token-class.html">Token</a> --+ | <strong class="uidshort">Keyword</strong> </pre> <dl><dt>Known Subclasses:</dt> <dd> <ul class="subclass-list"> <li><a href="pyparsing.pyparsing.CaselessKeyword-class.html">CaselessKeyword</a></li> </ul> </dd></dl> <hr /> <p>Token to exactly match a specified string as a keyword, that is, it must be immediately followed by a non-keyword character. Compare with Literal:</p> <pre class="literalblock"> Literal("if") will match the leading 'if' in 'ifAndOnlyIf'. Keyword("if") will not; it will only match the leading 'if in 'if x=1', or 'if(y==2)' </pre> <p>Accepts two optional constructor arguments in addition to the keyword string: identChars is a string of characters that would be valid identifier characters, defaulting to all alphanumerics + "_" and "$"; caseless allows case-insensitive matching, default is False.</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 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.pyparsing.Keyword-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">matchString</span>, <span class="summary-sig-arg">identChars</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ012345678</code><code class="variable-ellipsis">...</code></span>, <span class="summary-sig-arg">caseless</span>=<span class="summary-sig-default">False</span>)</span><br /> x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#Keyword.__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.pyparsing.Keyword-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.pyparsing-pysrc.html#Keyword.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.pyparsing.Keyword-class.html#copy" class="summary-sig-name">copy</a>(<span class="summary-sig-arg">self</span>)</span><br /> Make a copy of this ParserElement.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#Keyword.copy">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.pyparsing.Token-class.html">Token</a></code></b>: <code><a href="pyparsing.pyparsing.Token-class.html#setName">setName</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyparsing.pyparsing.ParserElement-class.html">ParserElement</a></code></b>: <code><a href="pyparsing.pyparsing.ParserElement-class.html#__add__">__add__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__and__">__and__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__call__">__call__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__eq__">__eq__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__getattr__">__getattr__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__hash__">__hash__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__invert__">__invert__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__mul__">__mul__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__ne__">__ne__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__or__">__or__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__radd__">__radd__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__rand__">__rand__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__repr__">__repr__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__req__">__req__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__rmul__">__rmul__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__rne__">__rne__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__ror__">__ror__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__rsub__">__rsub__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__rxor__">__rxor__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__str__">__str__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__sub__">__sub__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#__xor__">__xor__</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#addParseAction">addParseAction</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#checkRecursion">checkRecursion</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#getException">getException</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#ignore">ignore</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#leaveWhitespace">leaveWhitespace</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#parseFile">parseFile</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#parseString">parseString</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#parseWithTabs">parseWithTabs</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#postParse">postParse</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#preParse">preParse</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#scanString">scanString</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#searchString">searchString</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#setBreak">setBreak</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#setDebug">setDebug</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#setDebugActions">setDebugActions</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#setFailAction">setFailAction</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#setParseAction">setParseAction</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#setResultsName">setResultsName</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#setWhitespaceChars">setWhitespaceChars</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#streamline">streamline</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#suppress">suppress</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#transformString">transformString</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#tryParse">tryParse</a></code>, <code><a href="pyparsing.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>__getattribute__</code>, <code>__new__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__setattr__</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 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="setDefaultKeywordChars"></a><span class="summary-sig-name">setDefaultKeywordChars</span>(<span class="summary-sig-arg">chars</span>)</span><br /> Overrides the default Keyword chars</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#Keyword.setDefaultKeywordChars">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.pyparsing.ParserElement-class.html">ParserElement</a></code></b>: <code><a href="pyparsing.pyparsing.ParserElement-class.html#enablePackrat">enablePackrat</a></code>, <code><a href="pyparsing.pyparsing.ParserElement-class.html#resetCache">resetCache</a></code>, <code><a href="pyparsing.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 href="pyparsing.pyparsing.Keyword-class.html#DEFAULT_KEYWORD_CHARS" class="summary-name">DEFAULT_KEYWORD_CHARS</a> = <code title="'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_$'"><code class="variable-quote">'</code><code class="variable-string">abcdefghijklmnopqrstuvwxyzABCDEFGHIJK</code><code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyparsing.pyparsing.ParserElement-class.html">ParserElement</a></code></b>: <code><a href="pyparsing.pyparsing.ParserElement-class.html#DEFAULT_WHITE_CHARS">DEFAULT_WHITE_CHARS</a></code>, <code><a href="pyparsing.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">matchString</span>, <span class="sig-arg">identChars</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ012345678</code><code class="variable-ellipsis">...</code></span>, <span class="sig-arg">caseless</span>=<span class="sig-default">False</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#Keyword.__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="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.pyparsing-pysrc.html#Keyword.parseImpl">source code</a></span> </td> </tr></table> <dl class="fields"> <dt>Overrides: <a href="pyparsing.pyparsing.ParserElement-class.html#parseImpl">ParserElement.parseImpl</a> </dt> </dl> </td></tr></table> </div> <a name="copy"></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">copy</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#Keyword.copy">source code</a></span> </td> </tr></table> <p>Make a copy of this ParserElement. Useful for defining different parse actions for the same parsing pattern, using copies of the original parse element.</p> <dl class="fields"> <dt>Overrides: <a href="pyparsing.pyparsing.ParserElement-class.html#copy">ParserElement.copy</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <br /> <!-- ==================== CLASS VARIABLE DETAILS ==================== --> <a name="section-ClassVariableDetails"></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">Class Variable Details</span></td> </tr> </table> <a name="DEFAULT_KEYWORD_CHARS"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">DEFAULT_KEYWORD_CHARS</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-quote">'</code><code class="variable-string">abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_$</code><code class="variable-quote">'</code> </pre></td></tr></table> </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="pyparsing.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 Sun May 16 19:17:14 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>