pyparsing.Word Class Reference

Inheritance diagram for pyparsing.Word:

Collaboration diagram for pyparsing.Word:

Public Member Functions
def	__init__
def	parseImpl
def	__str__
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
	initCharsOrig
	initChars
	bodyCharsOrig
	bodyChars
	maxSpecified
	minLen
	maxLen
	name
	errmsg
	mayIndexError
	asKeyword
	reString
	re
	strRepr
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

Additional Inherited Members
Static Public Attributes inherited from pyparsing.ParserElement
string	DEFAULT_WHITE_CHARS " \n\t\r"
tuple	setDefaultWhitespaceChars staticmethod(setDefaultWhitespaceChars)
tuple	resetCache staticmethod(resetCache)
tuple	enablePackrat staticmethod(enablePackrat)

Detailed Description

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 min is 1 (a
   minimum value < 1 is not valid); the default values for max and exact
   are 0, meaning no maximum or exact length restriction.

Definition at line 1614 of file pyparsing.py.

Constructor & Destructor Documentation

def pyparsing.Word.__init__	(		self,
			initChars,
			bodyChars = None,
			min = 1,
			max = 0,
			exact = 0,
			asKeyword = False
	)

Definition at line 1623 of file pyparsing.py.

    def __init__( self, initChars, bodyChars=None, min=1, max=0, exact=0, asKeyword=False ):
        super(Word,self).__init__()
        self.initCharsOrig = initChars
        self.initChars = _str2dict(initChars)
        if bodyChars :
            self.bodyCharsOrig = bodyChars
            self.bodyChars = _str2dict(bodyChars)
        else:
            self.bodyCharsOrig = initChars
            self.bodyChars = _str2dict(initChars)

        self.maxSpecified = max > 0

        if min < 1:
            raise ValueError("cannot specify a minimum length < 1; use Optional(Word()) if zero-length word is permitted")

        self.minLen = min

        if max > 0:
            self.maxLen = max
        else:
            self.maxLen = _MAX_INT

        if exact > 0:
            self.maxLen = exact
            self.minLen = exact

        self.name = _ustr(self)
        self.errmsg = "Expected " + self.name
        #self.myException.msg = self.errmsg
        self.mayIndexError = False
        self.asKeyword = asKeyword

        if ' ' not in self.initCharsOrig+self.bodyCharsOrig and (min==1 and max==0 and exact==0):
            if self.bodyCharsOrig == self.initCharsOrig:
                self.reString = "[%s]+" % _escapeRegexRangeChars(self.initCharsOrig)
            elif len(self.bodyCharsOrig) == 1:
                self.reString = "%s[%s]*" % \
                                      (re.escape(self.initCharsOrig),
                                      _escapeRegexRangeChars(self.bodyCharsOrig),)
            else:
                self.reString = "[%s][%s]*" % \
                                      (_escapeRegexRangeChars(self.initCharsOrig),
                                      _escapeRegexRangeChars(self.bodyCharsOrig),)
            if self.asKeyword:
                self.reString = r"\b"+self.reString+r"\b"
            try:
                self.re = re.compile( self.reString )
            except:
                self.re = None