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

Public Member Functions

def __init__ (self, initChars, bodyChars=None, min=1, max=0, exact=0, asKeyword=False, excludeChars=None)
 
def parseImpl (self, instring, loc, doActions=True)
 
def __str__ (self)
 
- Public Member Functions inherited from Token
def __init__ (self)
 
- 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 __call__ (self, name=None)
 
def suppress (self)
 
def leaveWhitespace (self)
 
def setWhitespaceChars (self, chars)
 
def parseWithTabs (self)
 
def ignore (self, other)
 
def setDebugActions (self, startAction, successAction, exceptionAction)
 
def setDebug (self, flag=True)
 
def __repr__ (self)
 
def streamline (self)
 
def checkRecursion (self, parseElementList)
 
def validate (self, validateTrace=[])
 
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)
 

Data Fields

 initCharsOrig
 
 initChars
 
 bodyCharsOrig
 
 bodyChars
 
 maxSpecified
 
 minLen
 
 maxLen
 
 name
 
 errmsg
 
 mayIndexError
 
 asKeyword
 
 reString
 
 re
 
 strRepr
 
- 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

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 C{min} is 1 (a
minimum value < 1 is not valid); the default values for C{max} and C{exact}
are 0, meaning no maximum or exact length restriction. An optional
C{excludeChars} parameter can list characters that might be found in 
the input C{bodyChars} string; useful to define a word of all printables
except for one or two characters, for instance.

L{srange} is useful for defining custom character set strings for defining 
C{Word} expressions, using range notation from regular expression character sets.

A common mistake is to use C{Word} to match a specific literal string, as in 
C{Word("Address")}. Remember that C{Word} uses the string argument to define
I{sets} of matchable characters. This expression would match "Add", "AAA",
"dAred", or any other word made up of the characters 'A', 'd', 'r', 'e', and 's'.
To match an exact literal string, use L{Literal} or L{Keyword}.

pyparsing includes helper strings for building Words:
 - L{alphas}
 - L{nums}
 - L{alphanums}
 - L{hexnums}
 - L{alphas8bit} (alphabetic characters in ASCII range 128-255 - accented, tilded, umlauted, etc.)
 - L{punc8bit} (non-alphabetic characters in ASCII range 128-255 - currency, symbols, superscripts, diacriticals, etc.)
 - L{printables} (any non-whitespace character)

Example::
    # a word composed of digits
    integer = Word(nums) # equivalent to Word("0123456789") or Word(srange("0-9"))
    
    # a word with a leading capital, and zero or more lowercase
    capital_word = Word(alphas.upper(), alphas.lower())

    # hostnames are alphanumeric, with leading alpha, and '-'
    hostname = Word(alphas, alphanums+'-')
    
    # roman numeral (not a strict parser, accepts invalid mix of characters)
    roman = Word("IVXLCDM")
    
    # any string of non-whitespace characters, except for ','
    csv_value = Word(printables, excludeChars=",")

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ __str__()

def __str__ (   self)

Reimplemented from ParserElement.

◆ parseImpl()

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

Reimplemented from ParserElement.

Field Documentation

◆ asKeyword

asKeyword

◆ bodyChars

bodyChars

◆ bodyCharsOrig

bodyCharsOrig

◆ errmsg

errmsg

◆ initChars

initChars

◆ initCharsOrig

initCharsOrig

◆ maxLen

maxLen

◆ maxSpecified

maxSpecified

◆ mayIndexError

mayIndexError

◆ minLen

minLen

◆ name

name

◆ re

re

◆ reString

reString

◆ strRepr

strRepr

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