Class Keyword

source code

   object --+        
            |        
ParserElement --+    
                |    
            Token --+
                    |
                   Keyword

Known Subclasses:

• CaselessKeyword

Token to exactly match a specified string as a keyword, that is, it must be immediately followed by a non-keyword character. Compare with :class:`Literal`:

• ``Literal("if")`` will match the leading ``'if'`` in ``'ifAndOnlyIf'``.
• ``Keyword("if")`` will not; it will only match the leading ``'if'`` in ``'if x=1'``, or ``'if(y==2)'``

Accepts two optional constructor arguments in addition to the keyword string:

• ``identChars`` is a string of characters that would be valid identifier characters, defaulting to all alphanumerics + "_" and "$"
• ``caseless`` allows case-insensitive matching, default is ``False``.

Example:

   Keyword("start").parseString("start")  # -> ['start']
   Keyword("start").parseString("starting")  # -> Exception

For case-insensitive matching, use :class:`CaselessKeyword`.

   integer = Word(nums).setParseAction(lambda toks: int(toks[0]))
   integerK = integer.copy().addParseAction(lambda toks: toks[0] * 1024) + Suppress("K")
   integerM = integer.copy().addParseAction(lambda toks: toks[0] * 1024 * 1024) + Suppress("M")

   print(OneOrMore(integerK | integerM | integer).parseString("5K 100 640K 256M"))

   [5120, 100, 655360, 268435456]

   integerM = integer().addParseAction(lambda toks: toks[0] * 1024 * 1024) + Suppress("M")