pyparsing.Keyword Class Reference

Inheritance diagram for pyparsing.Keyword:

Collaboration diagram for pyparsing.Keyword:

Public Member Functions
def	__init__
def	parseImpl
def	copy
def	setDefaultKeywordChars
Public Member Functions inherited from pyparsing.Token
def	__init__
def	setName
Public Member Functions inherited from pyparsing.ParserElement
def	setDefaultWhitespaceChars
def	__init__
def	copy
def	setName
def	setResultsName
def	setBreak
def	setParseAction
def	addParseAction
def	setFailAction
def	preParse
def	parseImpl
def	postParse
def	tryParse
def	resetCache
def	enablePackrat
def	parseString
def	scanString
def	transformString
def	searchString
def	__add__
def	__radd__
def	__sub__
def	__rsub__
def	__mul__
def	__rmul__
def	__or__
def	__ror__
def	__xor__
def	__rxor__
def	__and__
def	__rand__
def	__invert__
def	__call__
def	suppress
def	leaveWhitespace
def	setWhitespaceChars
def	parseWithTabs
def	ignore
def	setDebugActions
def	setDebug
def	__str__
def	__repr__
def	streamline
def	checkRecursion
def	validate
def	parseFile
def	getException
def	__getattr__
def	__eq__
def	__ne__
def	__hash__
def	__req__
def	__rne__

Public Attributes
	match
	matchLen
	firstMatchChar
	name
	errmsg
	mayReturnEmpty
	mayIndexError
	caseless
	caselessmatch
	identChars
Public Attributes inherited from pyparsing.Token
	errmsg
Public Attributes inherited from pyparsing.ParserElement
	parseAction
	failAction
	strRepr
	resultsName
	saveAsList
	skipWhitespace
	whiteChars
	copyDefaultWhiteChars
	mayReturnEmpty
	keepTabs
	ignoreExprs
	debug
	streamlined
	mayIndexError
	errmsg
	modalResults
	debugActions
	re
	callPreparse
	callDuringTry
	name
	myException

Static Public Attributes
string	DEFAULT_KEYWORD_CHARS "_$"
tuple	setDefaultKeywordChars staticmethod(setDefaultKeywordChars)

Detailed Description

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.

Definition at line 1517 of file pyparsing.py.

Constructor & Destructor Documentation

def pyparsing.Keyword.__init__	(		self,
			matchString,
			identChars = DEFAULT_KEYWORD_CHARS,
			caseless = False
	)

Definition at line 1529 of file pyparsing.py.

    def __init__( self, matchString, identChars=DEFAULT_KEYWORD_CHARS, caseless=False ):
        super(Keyword,self).__init__()
        self.match = matchString
        self.matchLen = len(matchString)
        try:
            self.firstMatchChar = matchString[0]
        except IndexError:
            warnings.warn("null string passed to Keyword; use Empty() instead",
                            SyntaxWarning, stacklevel=2)
        self.name = '"%s"' % self.match
        self.errmsg = "Expected " + self.name
        self.mayReturnEmpty = False
        #self.myException.msg = self.errmsg
        self.mayIndexError = False
        self.caseless = caseless
        if caseless:
            self.caselessmatch = matchString.upper()
            identChars = identChars.upper()
        self.identChars = _str2dict(identChars)