Module pyparsing :: Class QuotedString

Class QuotedString

   object --+        
            |        
ParserElement --+    
                |    
            Token --+
                    |
                   QuotedString

Token for matching strings that are delimited by quoting characters.

Defined with the following parameters:

quoteChar - string of one or more characters defining the quote delimiting string
escChar - character to escape quotes, typically backslash (default= ``None``)
escQuote - special quote sequence to escape an embedded quote string (such as SQL's ``""`` to escape an embedded ``"``) (default= ``None``)
multiline - boolean indicating whether quotes can span multiple lines (default= ``False``)
unquoteResults - boolean indicating whether the matched text should be unquoted (default= ``True``)
endQuoteChar - string of one or more characters defining the end of the quote delimited string (default= ``None`` => same as quoteChar)
convertWhitespaceEscapes - convert escaped whitespace (``'\t'``, ``'\n'``, etc.) to actual whitespace (default= ``True``)

Example:

   qs = QuotedString('"')
   print(qs.searchString('lsjdf "This is the quote" sldjf'))
   complex_qs = QuotedString('{{', endQuoteChar='}}')
   print(complex_qs.searchString('lsjdf {{This is the "quote"}} sldjf'))
   sql_qs = QuotedString('"', escQuote='""')
   print(sql_qs.searchString('lsjdf "This is the quote with ""embedded"" quotes" sldjf'))

prints:

   [['This is the quote']]
   [['This is the "quote"']]
   [['This is the quote with "embedded" quotes']]

Nested Classes

[hide private]

Inherited from ParserElement (private): _FifoCache, _UnboundedCache, _literalStringClass

Instance Methods

[hide private]

__init__(self, quoteChar, escChar=None, escQuote=None, multiline=False, unquoteResults=True, endQuoteChar=None, convertWhitespaceEscapes=True)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

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

source code

__str__(self)
str(x)

source code

Inherited from ParserElement: __add__, __and__, __call__, __eq__, __getitem__, __hash__, __invert__, __iter__, __mul__, __ne__, __or__, __radd__, __rand__, __repr__, __req__, __rmul__, __rne__, __ror__, __rsub__, __rxor__, __sub__, __xor__, addCondition, addParseAction, canParseNext, checkRecursion, copy, ignore, leaveWhitespace, matches, parseFile, parseString, parseWithTabs, postParse, preParse, runTests, scanString, searchString, setBreak, setDebug, setDebugActions, setFailAction, setName, setParseAction, setResultsName, setWhitespaceChars, split, streamline, suppress, transformString, tryParse, validate

Inherited from ParserElement (private): _parse, _parseCache, _parseNoCache, _setResultsName, _skipIgnorables

Inherited from object: __delattr__, __format__, __getattribute__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__