pyparsing.Optional Class Reference

Inheritance diagram for pyparsing.Optional:

Collaboration diagram for pyparsing.Optional:

Public Member Functions
def	__init__
def	parseImpl
def	__str__
Public Member Functions inherited from pyparsing.ParseElementEnhance
def	__init__
def	parseImpl
def	leaveWhitespace
def	ignore
def	streamline
def	checkRecursion
def	validate
def	__str__
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
	defaultValue
	mayReturnEmpty
	strRepr
Public Attributes inherited from pyparsing.ParseElementEnhance
	expr
	strRepr
	mayIndexError
	mayReturnEmpty
	skipWhitespace
	saveAsList
	callPreparse
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

Optional matching of the given expression.
   A default return string can also be specified, if the optional expression
   is not found.

Definition at line 2789 of file pyparsing.py.

Constructor & Destructor Documentation

def pyparsing.Optional.__init__	(		self,
			exprs,
			default = _optionalNotMatched
	)

Definition at line 2794 of file pyparsing.py.

    def __init__( self, exprs, default=_optionalNotMatched ):
        super(Optional,self).__init__( exprs, savelist=False )
        self.defaultValue = default
        self.mayReturnEmpty = True