Class QuotedString

source code

   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']]