Package pyparsing :: Module pyparsing :: Class Keyword
[frames] | no frames]

Class Keyword

source code

   object --+        
            |        
ParserElement --+    
                |    
            Token --+
                    |
                   Keyword
Known Subclasses:

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:

 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)'

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.

Instance Methods
 
__init__(self, matchString, identChars='abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ012345678..., caseless=False)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
parseImpl(self, instring, loc, doActions=True) source code
 
copy(self)
Make a copy of this ParserElement.
source code

Inherited from Token: setName

Inherited from ParserElement: __add__, __and__, __call__, __eq__, __getattr__, __hash__, __invert__, __mul__, __ne__, __or__, __radd__, __rand__, __repr__, __req__, __rmul__, __rne__, __ror__, __rsub__, __rxor__, __str__, __sub__, __xor__, addParseAction, checkRecursion, getException, ignore, leaveWhitespace, parseFile, parseString, parseWithTabs, postParse, preParse, scanString, searchString, setBreak, setDebug, setDebugActions, setFailAction, setParseAction, setResultsName, setWhitespaceChars, streamline, suppress, transformString, tryParse, validate

Inherited from object: __delattr__, __getattribute__, __new__, __reduce__, __reduce_ex__, __setattr__

Static Methods
 
setDefaultKeywordChars(chars)
Overrides the default Keyword chars
source code

Inherited from ParserElement: enablePackrat, resetCache, setDefaultWhitespaceChars

Class Variables
  DEFAULT_KEYWORD_CHARS = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJK...

Inherited from ParserElement: DEFAULT_WHITE_CHARS, verbose_stacktrace

Properties

Inherited from object: __class__

Method Details

__init__(self, matchString, identChars='abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ012345678..., caseless=False)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

parseImpl(self, instring, loc, doActions=True)

source code 
Overrides: ParserElement.parseImpl

copy(self)

source code 

Make a copy of this ParserElement. Useful for defining different parse actions for the same parsing pattern, using copies of the original parse element.

Overrides: ParserElement.copy
(inherited documentation)

Class Variable Details

DEFAULT_KEYWORD_CHARS

Value:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_$'