OpenQuizz
Une application de gestion des contenus pédagogiques
Optional Class Reference
Inheritance diagram for Optional:
Collaboration diagram for Optional:

Public Member Functions

def __init__ (self, expr, default=__optionalNotMatched)
 
def parseImpl (self, instring, loc, doActions=True)
 
def __str__ (self)
 
- Public Member Functions inherited from ParseElementEnhance
def leaveWhitespace (self)
 
def ignore (self, other)
 
def streamline (self)
 
def checkRecursion (self, parseElementList)
 
def validate (self, validateTrace=None)
 
- Public Member Functions inherited from ParserElement
def __init__ (self, savelist=False)
 
def copy (self)
 
def setName (self, name)
 
def setResultsName (self, name, listAllMatches=False)
 
def setBreak (self, breakFlag=True)
 
def setParseAction (self, *fns, **kwargs)
 
def addParseAction (self, *fns, **kwargs)
 
def addCondition (self, *fns, **kwargs)
 
def setFailAction (self, fn)
 
def preParse (self, instring, loc)
 
def postParse (self, instring, loc, tokenlist)
 
def tryParse (self, instring, loc)
 
def canParseNext (self, instring, loc)
 
def parseString (self, instring, parseAll=False)
 
def scanString (self, instring, maxMatches=_MAX_INT, overlap=False)
 
def transformString (self, instring)
 
def searchString (self, instring, maxMatches=_MAX_INT)
 
def split (self, instring, maxsplit=_MAX_INT, includeSeparators=False)
 
def __add__ (self, other)
 
def __radd__ (self, other)
 
def __sub__ (self, other)
 
def __rsub__ (self, other)
 
def __mul__ (self, other)
 
def __rmul__ (self, other)
 
def __or__ (self, other)
 
def __ror__ (self, other)
 
def __xor__ (self, other)
 
def __rxor__ (self, other)
 
def __and__ (self, other)
 
def __rand__ (self, other)
 
def __invert__ (self)
 
def __iter__ (self)
 
def __getitem__ (self, key)
 
def __call__ (self, name=None)
 
def suppress (self)
 
def setWhitespaceChars (self, chars)
 
def parseWithTabs (self)
 
def setDebugActions (self, startAction, successAction, exceptionAction)
 
def setDebug (self, flag=True)
 
def __repr__ (self)
 
def parseFile (self, file_or_filename, parseAll=False)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __hash__ (self)
 
def __req__ (self, other)
 
def __rne__ (self, other)
 
def matches (self, testString, parseAll=True)
 
def runTests (self, tests, parseAll=True, comment='#', fullDump=True, printResults=True, failureTests=False, postParse=None, file=None)
 

Data Fields

 saveAsList
 
 defaultValue
 
 mayReturnEmpty
 
 strRepr
 
- Data Fields inherited from ParseElementEnhance
 expr
 
 strRepr
 
 mayIndexError
 
 mayReturnEmpty
 
 skipWhitespace
 
 saveAsList
 
 callPreparse
 
- Data Fields inherited from ParserElement
 parseAction
 
 failAction
 
 strRepr
 
 resultsName
 
 saveAsList
 
 skipWhitespace
 
 whiteChars
 
 copyDefaultWhiteChars
 
 mayReturnEmpty
 
 keepTabs
 
 ignoreExprs
 
 debug
 
 streamlined
 
 mayIndexError
 
 errmsg
 
 modalResults
 
 debugActions
 
 re
 
 callPreparse
 
 callDuringTry
 
 name
 

Additional Inherited Members

- Static Public Member Functions inherited from ParserElement
def setDefaultWhitespaceChars (chars)
 
def inlineLiteralsUsing (cls)
 
def resetCache ()
 
def enablePackrat (cache_size_limit=128)
 
- Static Public Attributes inherited from ParserElement
 DEFAULT_WHITE_CHARS
 
 verbose_stacktrace
 
 packrat_cache
 
 packrat_cache_lock
 
 packrat_cache_stats
 

Detailed Description

Optional matching of the given expression.

Parameters:
 - expr - expression that must match zero or more times
 - default (optional) - value to be returned if the optional expression is not found.

Example::

    # US postal code can be a 5-digit zip, plus optional 4-digit qualifier
    zip = Combine(Word(nums, exact=5) + Optional('-' + Word(nums, exact=4)))
    zip.runTests('''
        # traditional ZIP code
        12345

        # ZIP+4 form
        12101-0001

        # invalid ZIP
        98765-
        ''')

prints::

    # traditional ZIP code
    12345
    ['12345']

    # ZIP+4 form
    12101-0001
    ['12101-0001']

    # invalid ZIP
    98765-
         ^
    FAIL: Expected end of text (at char 5), (line:1, col:6)

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  expr,
  default = __optionalNotMatched 
)

Reimplemented from ParseElementEnhance.

Member Function Documentation

◆ __str__()

def __str__ (   self)

Reimplemented from ParseElementEnhance.

◆ parseImpl()

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

Reimplemented from ParseElementEnhance.

Field Documentation

◆ defaultValue

defaultValue

◆ mayReturnEmpty

mayReturnEmpty

◆ saveAsList

saveAsList

◆ strRepr

strRepr

The documentation for this class was generated from the following file: