Class Regex

source code

   object --+        
            |        
ParserElement --+    
                |    
            Token --+
                    |
                   Regex

Token for matching strings that match a given regular expression. Defined with string specifying the regular expression in a form recognized by the stdlib Python `re module <https://docs.python.org/3/library/re.html>`_. If the given regex contains named groups (defined using ``(?P<name>...)``), these will be preserved as named parse results.

If instead of the Python stdlib re module you wish to use a different RE module (such as the `regex` module), you can replace it by either building your Regex object with a compiled RE that was compiled using regex:

Example:

   realnum = Regex(r"[+-]?\d+\.\d*")
   date = Regex(r'(?P<year>\d{4})-(?P<month>\d\d?)-(?P<day>\d\d?)')
   # ref: https://stackoverflow.com/questions/267399/how-do-you-match-only-valid-roman-numerals-with-a-regular-expression
   roman = Regex(r"M{0,4}(CM|CD|D?{0,3})(XC|XL|L?X{0,3})(IX|IV|V?I{0,3})")

   # use regex module instead of stdlib re module to construct a Regex using
   # a compiled regular expression
   import regex
   parser = pp.Regex(regex.compile(r'[0-9]'))

   make_html = Regex(r"(\w+):(.*?):").sub(r"<\1>\2</\1>")
   print(make_html.transformString("h1:main title:"))
   # prints "<h1>main title</h1>"