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

Class Optional

source code

     object --+        
              |        
  ParserElement --+    
                  |    
ParseElementEnhance --+
                      |
                     Optional

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

Instance Methods
 
__init__(self, exprs, default=_NullToken())
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
parseImpl(self, instring, loc, doActions=True) source code
 
__str__(self)
str(x)
source code

Inherited from ParseElementEnhance: checkRecursion, ignore, leaveWhitespace, streamline, validate

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

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

Static Methods

Inherited from ParserElement: enablePackrat, resetCache, setDefaultWhitespaceChars

Class Variables
  __slotnames__ = []

Inherited from ParserElement: DEFAULT_WHITE_CHARS, verbose_stacktrace

Properties

Inherited from object: __class__

Method Details

__init__(self, exprs, default=_NullToken())
(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

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)