Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`re` --- Regular expression operations |
| 2 | =========================================== |
| 3 | |
| 4 | .. module:: re |
| 5 | :synopsis: Regular expression operations. |
| 6 | .. moduleauthor:: Fredrik Lundh <fredrik@pythonware.com> |
| 7 | .. sectionauthor:: Andrew M. Kuchling <amk@amk.ca> |
| 8 | |
| 9 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 10 | This module provides regular expression matching operations similar to |
Georg Brandl | ed2a1db | 2009-06-08 07:48:27 +0000 | [diff] [blame] | 11 | those found in Perl. |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 12 | |
| 13 | Both patterns and strings to be searched can be Unicode strings as well as |
| 14 | 8-bit strings. However, Unicode strings and 8-bit strings cannot be mixed: |
| 15 | that is, you cannot match an Unicode string with a byte pattern or |
Georg Brandl | ae2dbe2 | 2009-03-13 19:04:40 +0000 | [diff] [blame] | 16 | vice-versa; similarly, when asking for a substitution, the replacement |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 17 | string must be of the same type as both the pattern and the search string. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 18 | |
| 19 | Regular expressions use the backslash character (``'\'``) to indicate |
| 20 | special forms or to allow special characters to be used without invoking |
| 21 | their special meaning. This collides with Python's usage of the same |
| 22 | character for the same purpose in string literals; for example, to match |
| 23 | a literal backslash, one might have to write ``'\\\\'`` as the pattern |
| 24 | string, because the regular expression must be ``\\``, and each |
| 25 | backslash must be expressed as ``\\`` inside a regular Python string |
| 26 | literal. |
| 27 | |
| 28 | The solution is to use Python's raw string notation for regular expression |
| 29 | patterns; backslashes are not handled in any special way in a string literal |
| 30 | prefixed with ``'r'``. So ``r"\n"`` is a two-character string containing |
| 31 | ``'\'`` and ``'n'``, while ``"\n"`` is a one-character string containing a |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 32 | newline. Usually patterns will be expressed in Python code using this raw |
| 33 | string notation. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 34 | |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 35 | It is important to note that most regular expression operations are available as |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 36 | module-level functions and methods on |
| 37 | :ref:`compiled regular expressions <re-objects>`. The functions are shortcuts |
| 38 | that don't require you to compile a regex object first, but miss some |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 39 | fine-tuning parameters. |
| 40 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 41 | .. seealso:: |
| 42 | |
| 43 | Mastering Regular Expressions |
| 44 | Book on regular expressions by Jeffrey Friedl, published by O'Reilly. The |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 45 | second edition of the book no longer covers Python at all, but the first |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 46 | edition covered writing good regular expression patterns in great detail. |
| 47 | |
| 48 | |
| 49 | .. _re-syntax: |
| 50 | |
| 51 | Regular Expression Syntax |
| 52 | ------------------------- |
| 53 | |
| 54 | A regular expression (or RE) specifies a set of strings that matches it; the |
| 55 | functions in this module let you check if a particular string matches a given |
| 56 | regular expression (or if a given regular expression matches a particular |
| 57 | string, which comes down to the same thing). |
| 58 | |
| 59 | Regular expressions can be concatenated to form new regular expressions; if *A* |
| 60 | and *B* are both regular expressions, then *AB* is also a regular expression. |
| 61 | In general, if a string *p* matches *A* and another string *q* matches *B*, the |
| 62 | string *pq* will match AB. This holds unless *A* or *B* contain low precedence |
| 63 | operations; boundary conditions between *A* and *B*; or have numbered group |
| 64 | references. Thus, complex expressions can easily be constructed from simpler |
| 65 | primitive expressions like the ones described here. For details of the theory |
| 66 | and implementation of regular expressions, consult the Friedl book referenced |
| 67 | above, or almost any textbook about compiler construction. |
| 68 | |
| 69 | A brief explanation of the format of regular expressions follows. For further |
Christian Heimes | 2202f87 | 2008-02-06 14:31:34 +0000 | [diff] [blame] | 70 | information and a gentler presentation, consult the :ref:`regex-howto`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 71 | |
| 72 | Regular expressions can contain both special and ordinary characters. Most |
| 73 | ordinary characters, like ``'A'``, ``'a'``, or ``'0'``, are the simplest regular |
| 74 | expressions; they simply match themselves. You can concatenate ordinary |
| 75 | characters, so ``last`` matches the string ``'last'``. (In the rest of this |
| 76 | section, we'll write RE's in ``this special style``, usually without quotes, and |
| 77 | strings to be matched ``'in single quotes'``.) |
| 78 | |
| 79 | Some characters, like ``'|'`` or ``'('``, are special. Special |
| 80 | characters either stand for classes of ordinary characters, or affect |
| 81 | how the regular expressions around them are interpreted. Regular |
| 82 | expression pattern strings may not contain null bytes, but can specify |
Raymond Hettinger | 5768e0c | 2011-10-19 14:10:07 -0700 | [diff] [blame] | 83 | the null byte using a ``\number`` notation such as ``'\x00'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 84 | |
| 85 | |
| 86 | The special characters are: |
| 87 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 88 | ``'.'`` |
| 89 | (Dot.) In the default mode, this matches any character except a newline. If |
| 90 | the :const:`DOTALL` flag has been specified, this matches any character |
| 91 | including a newline. |
| 92 | |
| 93 | ``'^'`` |
| 94 | (Caret.) Matches the start of the string, and in :const:`MULTILINE` mode also |
| 95 | matches immediately after each newline. |
| 96 | |
| 97 | ``'$'`` |
| 98 | Matches the end of the string or just before the newline at the end of the |
| 99 | string, and in :const:`MULTILINE` mode also matches before a newline. ``foo`` |
| 100 | matches both 'foo' and 'foobar', while the regular expression ``foo$`` matches |
| 101 | only 'foo'. More interestingly, searching for ``foo.$`` in ``'foo1\nfoo2\n'`` |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 102 | matches 'foo2' normally, but 'foo1' in :const:`MULTILINE` mode; searching for |
| 103 | a single ``$`` in ``'foo\n'`` will find two (empty) matches: one just before |
| 104 | the newline, and one at the end of the string. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 105 | |
| 106 | ``'*'`` |
| 107 | Causes the resulting RE to match 0 or more repetitions of the preceding RE, as |
| 108 | many repetitions as are possible. ``ab*`` will match 'a', 'ab', or 'a' followed |
| 109 | by any number of 'b's. |
| 110 | |
| 111 | ``'+'`` |
| 112 | Causes the resulting RE to match 1 or more repetitions of the preceding RE. |
| 113 | ``ab+`` will match 'a' followed by any non-zero number of 'b's; it will not |
| 114 | match just 'a'. |
| 115 | |
| 116 | ``'?'`` |
| 117 | Causes the resulting RE to match 0 or 1 repetitions of the preceding RE. |
| 118 | ``ab?`` will match either 'a' or 'ab'. |
| 119 | |
| 120 | ``*?``, ``+?``, ``??`` |
| 121 | The ``'*'``, ``'+'``, and ``'?'`` qualifiers are all :dfn:`greedy`; they match |
| 122 | as much text as possible. Sometimes this behaviour isn't desired; if the RE |
| 123 | ``<.*>`` is matched against ``'<H1>title</H1>'``, it will match the entire |
| 124 | string, and not just ``'<H1>'``. Adding ``'?'`` after the qualifier makes it |
| 125 | perform the match in :dfn:`non-greedy` or :dfn:`minimal` fashion; as *few* |
| 126 | characters as possible will be matched. Using ``.*?`` in the previous |
| 127 | expression will match only ``'<H1>'``. |
| 128 | |
| 129 | ``{m}`` |
| 130 | Specifies that exactly *m* copies of the previous RE should be matched; fewer |
| 131 | matches cause the entire RE not to match. For example, ``a{6}`` will match |
| 132 | exactly six ``'a'`` characters, but not five. |
| 133 | |
| 134 | ``{m,n}`` |
| 135 | Causes the resulting RE to match from *m* to *n* repetitions of the preceding |
| 136 | RE, attempting to match as many repetitions as possible. For example, |
| 137 | ``a{3,5}`` will match from 3 to 5 ``'a'`` characters. Omitting *m* specifies a |
| 138 | lower bound of zero, and omitting *n* specifies an infinite upper bound. As an |
| 139 | example, ``a{4,}b`` will match ``aaaab`` or a thousand ``'a'`` characters |
| 140 | followed by a ``b``, but not ``aaab``. The comma may not be omitted or the |
| 141 | modifier would be confused with the previously described form. |
| 142 | |
| 143 | ``{m,n}?`` |
| 144 | Causes the resulting RE to match from *m* to *n* repetitions of the preceding |
| 145 | RE, attempting to match as *few* repetitions as possible. This is the |
| 146 | non-greedy version of the previous qualifier. For example, on the |
| 147 | 6-character string ``'aaaaaa'``, ``a{3,5}`` will match 5 ``'a'`` characters, |
| 148 | while ``a{3,5}?`` will only match 3 characters. |
| 149 | |
| 150 | ``'\'`` |
| 151 | Either escapes special characters (permitting you to match characters like |
| 152 | ``'*'``, ``'?'``, and so forth), or signals a special sequence; special |
| 153 | sequences are discussed below. |
| 154 | |
| 155 | If you're not using a raw string to express the pattern, remember that Python |
| 156 | also uses the backslash as an escape sequence in string literals; if the escape |
| 157 | sequence isn't recognized by Python's parser, the backslash and subsequent |
| 158 | character are included in the resulting string. However, if Python would |
| 159 | recognize the resulting sequence, the backslash should be repeated twice. This |
| 160 | is complicated and hard to understand, so it's highly recommended that you use |
| 161 | raw strings for all but the simplest expressions. |
| 162 | |
| 163 | ``[]`` |
Ezio Melotti | 81231d9 | 2011-10-20 19:38:04 +0300 | [diff] [blame] | 164 | Used to indicate a set of characters. In a set: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 165 | |
Ezio Melotti | 81231d9 | 2011-10-20 19:38:04 +0300 | [diff] [blame] | 166 | * Characters can be listed individually, e.g. ``[amk]`` will match ``'a'``, |
| 167 | ``'m'``, or ``'k'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 168 | |
Ezio Melotti | 81231d9 | 2011-10-20 19:38:04 +0300 | [diff] [blame] | 169 | * Ranges of characters can be indicated by giving two characters and separating |
| 170 | them by a ``'-'``, for example ``[a-z]`` will match any lowercase ASCII letter, |
| 171 | ``[0-5][0-9]`` will match all the two-digits numbers from ``00`` to ``59``, and |
| 172 | ``[0-9A-Fa-f]`` will match any hexadecimal digit. If ``-`` is escaped (e.g. |
| 173 | ``[a\-z]``) or if it's placed as the first or last character (e.g. ``[a-]``), |
| 174 | it will match a literal ``'-'``. |
| 175 | |
| 176 | * Special characters lose their special meaning inside sets. For example, |
| 177 | ``[(+*)]`` will match any of the literal characters ``'('``, ``'+'``, |
| 178 | ``'*'``, or ``')'``. |
| 179 | |
| 180 | * Character classes such as ``\w`` or ``\S`` (defined below) are also accepted |
| 181 | inside a set, although the characters they match depends on whether |
| 182 | :const:`ASCII` or :const:`LOCALE` mode is in force. |
| 183 | |
| 184 | * Characters that are not within a range can be matched by :dfn:`complementing` |
| 185 | the set. If the first character of the set is ``'^'``, all the characters |
| 186 | that are *not* in the set will be matched. For example, ``[^5]`` will match |
| 187 | any character except ``'5'``, and ``[^^]`` will match any character except |
| 188 | ``'^'``. ``^`` has no special meaning if it's not the first character in |
| 189 | the set. |
| 190 | |
| 191 | * To match a literal ``']'`` inside a set, precede it with a backslash, or |
| 192 | place it at the beginning of the set. For example, both ``[()[\]{}]`` and |
| 193 | ``[]()[{}]`` will both match a parenthesis. |
Mark Summerfield | 9e670c2 | 2008-05-31 13:05:34 +0000 | [diff] [blame] | 194 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 195 | ``'|'`` |
| 196 | ``A|B``, where A and B can be arbitrary REs, creates a regular expression that |
| 197 | will match either A or B. An arbitrary number of REs can be separated by the |
| 198 | ``'|'`` in this way. This can be used inside groups (see below) as well. As |
| 199 | the target string is scanned, REs separated by ``'|'`` are tried from left to |
| 200 | right. When one pattern completely matches, that branch is accepted. This means |
| 201 | that once ``A`` matches, ``B`` will not be tested further, even if it would |
| 202 | produce a longer overall match. In other words, the ``'|'`` operator is never |
| 203 | greedy. To match a literal ``'|'``, use ``\|``, or enclose it inside a |
| 204 | character class, as in ``[|]``. |
| 205 | |
| 206 | ``(...)`` |
| 207 | Matches whatever regular expression is inside the parentheses, and indicates the |
| 208 | start and end of a group; the contents of a group can be retrieved after a match |
| 209 | has been performed, and can be matched later in the string with the ``\number`` |
| 210 | special sequence, described below. To match the literals ``'('`` or ``')'``, |
| 211 | use ``\(`` or ``\)``, or enclose them inside a character class: ``[(] [)]``. |
| 212 | |
| 213 | ``(?...)`` |
| 214 | This is an extension notation (a ``'?'`` following a ``'('`` is not meaningful |
| 215 | otherwise). The first character after the ``'?'`` determines what the meaning |
| 216 | and further syntax of the construct is. Extensions usually do not create a new |
| 217 | group; ``(?P<name>...)`` is the only exception to this rule. Following are the |
| 218 | currently supported extensions. |
| 219 | |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 220 | ``(?aiLmsux)`` |
| 221 | (One or more letters from the set ``'a'``, ``'i'``, ``'L'``, ``'m'``, |
| 222 | ``'s'``, ``'u'``, ``'x'``.) The group matches the empty string; the |
Andrew M. Kuchling | 1c50e86 | 2009-06-01 00:11:36 +0000 | [diff] [blame] | 223 | letters set the corresponding flags: :const:`re.A` (ASCII-only matching), |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 224 | :const:`re.I` (ignore case), :const:`re.L` (locale dependent), |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 225 | :const:`re.M` (multi-line), :const:`re.S` (dot matches all), |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 226 | and :const:`re.X` (verbose), for the entire regular expression. (The |
| 227 | flags are described in :ref:`contents-of-module-re`.) This |
| 228 | is useful if you wish to include the flags as part of the regular |
| 229 | expression, instead of passing a *flag* argument to the |
Georg Brandl | f346ac0 | 2009-07-26 15:03:49 +0000 | [diff] [blame] | 230 | :func:`re.compile` function. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 231 | |
| 232 | Note that the ``(?x)`` flag changes how the expression is parsed. It should be |
| 233 | used first in the expression string, or after one or more whitespace characters. |
| 234 | If there are non-whitespace characters before the flag, the results are |
| 235 | undefined. |
| 236 | |
| 237 | ``(?:...)`` |
Georg Brandl | 3122ce3 | 2010-10-29 06:17:38 +0000 | [diff] [blame] | 238 | A non-capturing version of regular parentheses. Matches whatever regular |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 239 | expression is inside the parentheses, but the substring matched by the group |
| 240 | *cannot* be retrieved after performing a match or referenced later in the |
| 241 | pattern. |
| 242 | |
| 243 | ``(?P<name>...)`` |
| 244 | Similar to regular parentheses, but the substring matched by the group is |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 245 | accessible within the rest of the regular expression via the symbolic group |
| 246 | name *name*. Group names must be valid Python identifiers, and each group |
| 247 | name must be defined only once within a regular expression. A symbolic group |
| 248 | is also a numbered group, just as if the group were not named. So the group |
| 249 | named ``id`` in the example below can also be referenced as the numbered group |
| 250 | ``1``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 251 | |
| 252 | For example, if the pattern is ``(?P<id>[a-zA-Z_]\w*)``, the group can be |
| 253 | referenced by its name in arguments to methods of match objects, such as |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 254 | ``m.group('id')`` or ``m.end('id')``, and also by name in the regular |
| 255 | expression itself (using ``(?P=id)``) and replacement text given to |
| 256 | ``.sub()`` (using ``\g<id>``). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 257 | |
| 258 | ``(?P=name)`` |
| 259 | Matches whatever text was matched by the earlier group named *name*. |
| 260 | |
| 261 | ``(?#...)`` |
| 262 | A comment; the contents of the parentheses are simply ignored. |
| 263 | |
| 264 | ``(?=...)`` |
| 265 | Matches if ``...`` matches next, but doesn't consume any of the string. This is |
| 266 | called a lookahead assertion. For example, ``Isaac (?=Asimov)`` will match |
| 267 | ``'Isaac '`` only if it's followed by ``'Asimov'``. |
| 268 | |
| 269 | ``(?!...)`` |
| 270 | Matches if ``...`` doesn't match next. This is a negative lookahead assertion. |
| 271 | For example, ``Isaac (?!Asimov)`` will match ``'Isaac '`` only if it's *not* |
| 272 | followed by ``'Asimov'``. |
| 273 | |
| 274 | ``(?<=...)`` |
| 275 | Matches if the current position in the string is preceded by a match for ``...`` |
| 276 | that ends at the current position. This is called a :dfn:`positive lookbehind |
| 277 | assertion`. ``(?<=abc)def`` will find a match in ``abcdef``, since the |
| 278 | lookbehind will back up 3 characters and check if the contained pattern matches. |
| 279 | The contained pattern must only match strings of some fixed length, meaning that |
| 280 | ``abc`` or ``a|b`` are allowed, but ``a*`` and ``a{3,4}`` are not. Note that |
| 281 | patterns which start with positive lookbehind assertions will never match at the |
| 282 | beginning of the string being searched; you will most likely want to use the |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 283 | :func:`search` function rather than the :func:`match` function: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 284 | |
| 285 | >>> import re |
| 286 | >>> m = re.search('(?<=abc)def', 'abcdef') |
| 287 | >>> m.group(0) |
| 288 | 'def' |
| 289 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 290 | This example looks for a word following a hyphen: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 291 | |
| 292 | >>> m = re.search('(?<=-)\w+', 'spam-egg') |
| 293 | >>> m.group(0) |
| 294 | 'egg' |
| 295 | |
| 296 | ``(?<!...)`` |
| 297 | Matches if the current position in the string is not preceded by a match for |
| 298 | ``...``. This is called a :dfn:`negative lookbehind assertion`. Similar to |
| 299 | positive lookbehind assertions, the contained pattern must only match strings of |
| 300 | some fixed length. Patterns which start with negative lookbehind assertions may |
| 301 | match at the beginning of the string being searched. |
| 302 | |
| 303 | ``(?(id/name)yes-pattern|no-pattern)`` |
orsenthil@gmail.com | 476021b | 2011-03-12 10:46:25 +0800 | [diff] [blame] | 304 | Will try to match with ``yes-pattern`` if the group with given *id* or |
| 305 | *name* exists, and with ``no-pattern`` if it doesn't. ``no-pattern`` is |
| 306 | optional and can be omitted. For example, |
| 307 | ``(<)?(\w+@\w+(?:\.\w+)+)(?(1)>|$)`` is a poor email matching pattern, which |
| 308 | will match with ``'<user@host.com>'`` as well as ``'user@host.com'``, but |
| 309 | not with ``'<user@host.com'`` nor ``'user@host.com>'`` . |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 310 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 311 | |
| 312 | The special sequences consist of ``'\'`` and a character from the list below. |
| 313 | If the ordinary character is not on the list, then the resulting RE will match |
| 314 | the second character. For example, ``\$`` matches the character ``'$'``. |
| 315 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 316 | ``\number`` |
| 317 | Matches the contents of the group of the same number. Groups are numbered |
| 318 | starting from 1. For example, ``(.+) \1`` matches ``'the the'`` or ``'55 55'``, |
| 319 | but not ``'the end'`` (note the space after the group). This special sequence |
| 320 | can only be used to match one of the first 99 groups. If the first digit of |
| 321 | *number* is 0, or *number* is 3 octal digits long, it will not be interpreted as |
| 322 | a group match, but as the character with octal value *number*. Inside the |
| 323 | ``'['`` and ``']'`` of a character class, all numeric escapes are treated as |
| 324 | characters. |
| 325 | |
| 326 | ``\A`` |
| 327 | Matches only at the start of the string. |
| 328 | |
| 329 | ``\b`` |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 330 | Matches the empty string, but only at the beginning or end of a word. |
| 331 | A word is defined as a sequence of Unicode alphanumeric or underscore |
| 332 | characters, so the end of a word is indicated by whitespace or a |
Ezio Melotti | 5a045b9 | 2012-02-29 11:48:44 +0200 | [diff] [blame] | 333 | non-alphanumeric, non-underscore Unicode character. Note that formally, |
| 334 | ``\b`` is defined as the boundary between a ``\w`` and a ``\W`` character |
| 335 | (or vice versa), or between ``\w`` and the beginning/end of the string. |
| 336 | This means that ``r'\bfoo\b'`` matches ``'foo'``, ``'foo.'``, ``'(foo)'``, |
| 337 | ``'bar foo baz'`` but not ``'foobar'`` or ``'foo3'``. |
| 338 | |
| 339 | By default Unicode alphanumerics are the ones used, but this can be changed |
| 340 | by using the :const:`ASCII` flag. Inside a character range, ``\b`` |
| 341 | represents the backspace character, for compatibility with Python's string |
| 342 | literals. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 343 | |
| 344 | ``\B`` |
Ezio Melotti | 5a045b9 | 2012-02-29 11:48:44 +0200 | [diff] [blame] | 345 | Matches the empty string, but only when it is *not* at the beginning or end |
| 346 | of a word. This means that ``r'py\B'`` matches ``'python'``, ``'py3'``, |
| 347 | ``'py2'``, but not ``'py'``, ``'py.'``, or ``'py!'``. |
| 348 | ``\B`` is just the opposite of ``\b``, so word characters are |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 349 | Unicode alphanumerics or the underscore, although this can be changed |
| 350 | by using the :const:`ASCII` flag. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 351 | |
| 352 | ``\d`` |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 353 | For Unicode (str) patterns: |
Mark Dickinson | 1f26828 | 2009-07-28 17:22:36 +0000 | [diff] [blame] | 354 | Matches any Unicode decimal digit (that is, any character in |
| 355 | Unicode character category [Nd]). This includes ``[0-9]``, and |
| 356 | also many other digit characters. If the :const:`ASCII` flag is |
| 357 | used only ``[0-9]`` is matched (but the flag affects the entire |
| 358 | regular expression, so in such cases using an explicit ``[0-9]`` |
| 359 | may be a better choice). |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 360 | For 8-bit (bytes) patterns: |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 361 | Matches any decimal digit; this is equivalent to ``[0-9]``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 362 | |
| 363 | ``\D`` |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 364 | Matches any character which is not a Unicode decimal digit. This is |
| 365 | the opposite of ``\d``. If the :const:`ASCII` flag is used this |
| 366 | becomes the equivalent of ``[^0-9]`` (but the flag affects the entire |
| 367 | regular expression, so in such cases using an explicit ``[^0-9]`` may |
| 368 | be a better choice). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 369 | |
| 370 | ``\s`` |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 371 | For Unicode (str) patterns: |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 372 | Matches Unicode whitespace characters (which includes |
| 373 | ``[ \t\n\r\f\v]``, and also many other characters, for example the |
| 374 | non-breaking spaces mandated by typography rules in many |
| 375 | languages). If the :const:`ASCII` flag is used, only |
| 376 | ``[ \t\n\r\f\v]`` is matched (but the flag affects the entire |
| 377 | regular expression, so in such cases using an explicit |
| 378 | ``[ \t\n\r\f\v]`` may be a better choice). |
| 379 | |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 380 | For 8-bit (bytes) patterns: |
| 381 | Matches characters considered whitespace in the ASCII character set; |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 382 | this is equivalent to ``[ \t\n\r\f\v]``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 383 | |
| 384 | ``\S`` |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 385 | Matches any character which is not a Unicode whitespace character. This is |
| 386 | the opposite of ``\s``. If the :const:`ASCII` flag is used this |
| 387 | becomes the equivalent of ``[^ \t\n\r\f\v]`` (but the flag affects the entire |
| 388 | regular expression, so in such cases using an explicit ``[^ \t\n\r\f\v]`` may |
| 389 | be a better choice). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 390 | |
| 391 | ``\w`` |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 392 | For Unicode (str) patterns: |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 393 | Matches Unicode word characters; this includes most characters |
| 394 | that can be part of a word in any language, as well as numbers and |
| 395 | the underscore. If the :const:`ASCII` flag is used, only |
| 396 | ``[a-zA-Z0-9_]`` is matched (but the flag affects the entire |
| 397 | regular expression, so in such cases using an explicit |
| 398 | ``[a-zA-Z0-9_]`` may be a better choice). |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 399 | For 8-bit (bytes) patterns: |
| 400 | Matches characters considered alphanumeric in the ASCII character set; |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 401 | this is equivalent to ``[a-zA-Z0-9_]``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 402 | |
| 403 | ``\W`` |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 404 | Matches any character which is not a Unicode word character. This is |
| 405 | the opposite of ``\w``. If the :const:`ASCII` flag is used this |
| 406 | becomes the equivalent of ``[^a-zA-Z0-9_]`` (but the flag affects the |
| 407 | entire regular expression, so in such cases using an explicit |
| 408 | ``[^a-zA-Z0-9_]`` may be a better choice). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 409 | |
| 410 | ``\Z`` |
| 411 | Matches only at the end of the string. |
| 412 | |
| 413 | Most of the standard escapes supported by Python string literals are also |
| 414 | accepted by the regular expression parser:: |
| 415 | |
| 416 | \a \b \f \n |
| 417 | \r \t \v \x |
| 418 | \\ |
| 419 | |
Raymond Hettinger | 5768e0c | 2011-10-19 14:10:07 -0700 | [diff] [blame] | 420 | Octal escapes are included in a limited form. If the first digit is a 0, or if |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 421 | there are three octal digits, it is considered an octal escape. Otherwise, it is |
| 422 | a group reference. As for string literals, octal escapes are always at most |
| 423 | three digits in length. |
| 424 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 425 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 426 | .. _contents-of-module-re: |
| 427 | |
| 428 | Module Contents |
| 429 | --------------- |
| 430 | |
| 431 | The module defines several functions, constants, and an exception. Some of the |
| 432 | functions are simplified versions of the full featured methods for compiled |
| 433 | regular expressions. Most non-trivial applications always use the compiled |
| 434 | form. |
| 435 | |
| 436 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 437 | .. function:: compile(pattern, flags=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 438 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 439 | Compile a regular expression pattern into a regular expression object, which |
| 440 | can be used for matching using its :func:`match` and :func:`search` methods, |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 441 | described below. |
| 442 | |
| 443 | The expression's behaviour can be modified by specifying a *flags* value. |
| 444 | Values can be any of the following variables, combined using bitwise OR (the |
| 445 | ``|`` operator). |
| 446 | |
| 447 | The sequence :: |
| 448 | |
Gregory P. Smith | 4221c74 | 2009-03-02 05:04:04 +0000 | [diff] [blame] | 449 | prog = re.compile(pattern) |
| 450 | result = prog.match(string) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 451 | |
| 452 | is equivalent to :: |
| 453 | |
Gregory P. Smith | 4221c74 | 2009-03-02 05:04:04 +0000 | [diff] [blame] | 454 | result = re.match(pattern, string) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 455 | |
Georg Brandl | f346ac0 | 2009-07-26 15:03:49 +0000 | [diff] [blame] | 456 | but using :func:`re.compile` and saving the resulting regular expression |
| 457 | object for reuse is more efficient when the expression will be used several |
| 458 | times in a single program. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 459 | |
Gregory P. Smith | 4221c74 | 2009-03-02 05:04:04 +0000 | [diff] [blame] | 460 | .. note:: |
| 461 | |
| 462 | The compiled versions of the most recent patterns passed to |
| 463 | :func:`re.match`, :func:`re.search` or :func:`re.compile` are cached, so |
| 464 | programs that use only a few regular expressions at a time needn't worry |
| 465 | about compiling regular expressions. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 466 | |
| 467 | |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 468 | .. data:: A |
| 469 | ASCII |
| 470 | |
Georg Brandl | 4049ce0 | 2009-06-08 07:49:54 +0000 | [diff] [blame] | 471 | Make ``\w``, ``\W``, ``\b``, ``\B``, ``\d``, ``\D``, ``\s`` and ``\S`` |
| 472 | perform ASCII-only matching instead of full Unicode matching. This is only |
| 473 | meaningful for Unicode patterns, and is ignored for byte patterns. |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 474 | |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 475 | Note that for backward compatibility, the :const:`re.U` flag still |
| 476 | exists (as well as its synonym :const:`re.UNICODE` and its embedded |
Georg Brandl | ebeb44d | 2010-07-29 11:15:36 +0000 | [diff] [blame] | 477 | counterpart ``(?u)``), but these are redundant in Python 3 since |
Mark Summerfield | 6c4f617 | 2008-08-20 07:34:41 +0000 | [diff] [blame] | 478 | matches are Unicode by default for strings (and Unicode matching |
| 479 | isn't allowed for bytes). |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 480 | |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 481 | |
Sandro Tosi | da785fd | 2012-01-01 12:55:20 +0100 | [diff] [blame] | 482 | .. data:: DEBUG |
| 483 | |
| 484 | Display debug information about compiled expression. |
| 485 | |
| 486 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 487 | .. data:: I |
| 488 | IGNORECASE |
| 489 | |
| 490 | Perform case-insensitive matching; expressions like ``[A-Z]`` will match |
Mark Summerfield | 8676534 | 2008-08-20 07:40:18 +0000 | [diff] [blame] | 491 | lowercase letters, too. This is not affected by the current locale |
| 492 | and works for Unicode characters as expected. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 493 | |
| 494 | |
| 495 | .. data:: L |
| 496 | LOCALE |
| 497 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 498 | Make ``\w``, ``\W``, ``\b``, ``\B``, ``\s`` and ``\S`` dependent on the |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 499 | current locale. The use of this flag is discouraged as the locale mechanism |
| 500 | is very unreliable, and it only handles one "culture" at a time anyway; |
Georg Brandl | ebeb44d | 2010-07-29 11:15:36 +0000 | [diff] [blame] | 501 | you should use Unicode matching instead, which is the default in Python 3 |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 502 | for Unicode (str) patterns. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 503 | |
| 504 | |
| 505 | .. data:: M |
| 506 | MULTILINE |
| 507 | |
| 508 | When specified, the pattern character ``'^'`` matches at the beginning of the |
| 509 | string and at the beginning of each line (immediately following each newline); |
| 510 | and the pattern character ``'$'`` matches at the end of the string and at the |
| 511 | end of each line (immediately preceding each newline). By default, ``'^'`` |
| 512 | matches only at the beginning of the string, and ``'$'`` only at the end of the |
| 513 | string and immediately before the newline (if any) at the end of the string. |
| 514 | |
| 515 | |
| 516 | .. data:: S |
| 517 | DOTALL |
| 518 | |
| 519 | Make the ``'.'`` special character match any character at all, including a |
| 520 | newline; without this flag, ``'.'`` will match anything *except* a newline. |
| 521 | |
| 522 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 523 | .. data:: X |
| 524 | VERBOSE |
| 525 | |
| 526 | This flag allows you to write regular expressions that look nicer. Whitespace |
| 527 | within the pattern is ignored, except when in a character class or preceded by |
| 528 | an unescaped backslash, and, when a line contains a ``'#'`` neither in a |
| 529 | character class or preceded by an unescaped backslash, all characters from the |
| 530 | leftmost such ``'#'`` through the end of the line are ignored. |
| 531 | |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 532 | That means that the two following regular expression objects that match a |
| 533 | decimal number are functionally equal:: |
Georg Brandl | 81ac1ce | 2007-08-31 17:17:17 +0000 | [diff] [blame] | 534 | |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 535 | a = re.compile(r"""\d + # the integral part |
| 536 | \. # the decimal point |
| 537 | \d * # some fractional digits""", re.X) |
| 538 | b = re.compile(r"\d+\.\d*") |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 539 | |
| 540 | |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 541 | |
| 542 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 543 | .. function:: search(pattern, string, flags=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 544 | |
| 545 | Scan through *string* looking for a location where the regular expression |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 546 | *pattern* produces a match, and return a corresponding :ref:`match object |
| 547 | <match-objects>`. Return ``None`` if no position in the string matches the |
| 548 | pattern; note that this is different from finding a zero-length match at some |
| 549 | point in the string. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 550 | |
| 551 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 552 | .. function:: match(pattern, string, flags=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 553 | |
| 554 | If zero or more characters at the beginning of *string* match the regular |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 555 | expression *pattern*, return a corresponding :ref:`match object |
| 556 | <match-objects>`. Return ``None`` if the string does not match the pattern; |
| 557 | note that this is different from a zero-length match. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 558 | |
Ezio Melotti | 443f000 | 2012-02-29 13:39:05 +0200 | [diff] [blame] | 559 | Note that even in :const:`MULTILINE` mode, :func:`re.match` will only match |
| 560 | at the beginning of the string and not at the beginning of each line. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 561 | |
Ezio Melotti | 443f000 | 2012-02-29 13:39:05 +0200 | [diff] [blame] | 562 | If you want to locate a match anywhere in *string*, use :func:`search` |
| 563 | instead (see also :ref:`search-vs-match`). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 564 | |
| 565 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 566 | .. function:: split(pattern, string, maxsplit=0, flags=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 567 | |
| 568 | Split *string* by the occurrences of *pattern*. If capturing parentheses are |
| 569 | used in *pattern*, then the text of all groups in the pattern are also returned |
| 570 | as part of the resulting list. If *maxsplit* is nonzero, at most *maxsplit* |
| 571 | splits occur, and the remainder of the string is returned as the final element |
Georg Brandl | 9647389 | 2008-03-06 07:09:43 +0000 | [diff] [blame] | 572 | of the list. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 573 | |
| 574 | >>> re.split('\W+', 'Words, words, words.') |
| 575 | ['Words', 'words', 'words', ''] |
| 576 | >>> re.split('(\W+)', 'Words, words, words.') |
| 577 | ['Words', ', ', 'words', ', ', 'words', '.', ''] |
| 578 | >>> re.split('\W+', 'Words, words, words.', 1) |
| 579 | ['Words', 'words, words.'] |
Gregory P. Smith | ccc5ae7 | 2009-03-02 05:21:55 +0000 | [diff] [blame] | 580 | >>> re.split('[a-f]+', '0a3B9', flags=re.IGNORECASE) |
| 581 | ['0', '3', '9'] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 582 | |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 583 | If there are capturing groups in the separator and it matches at the start of |
| 584 | the string, the result will start with an empty string. The same holds for |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 585 | the end of the string: |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 586 | |
| 587 | >>> re.split('(\W+)', '...words, words...') |
| 588 | ['', '...', 'words', ', ', 'words', '...', ''] |
| 589 | |
| 590 | That way, separator components are always found at the same relative |
Raymond Hettinger | 5768e0c | 2011-10-19 14:10:07 -0700 | [diff] [blame] | 591 | indices within the result list. |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 592 | |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 593 | Note that *split* will never split a string on an empty pattern match. |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 594 | For example: |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 595 | |
| 596 | >>> re.split('x*', 'foo') |
| 597 | ['foo'] |
| 598 | >>> re.split("(?m)^$", "foo\n\nbar\n") |
| 599 | ['foo\n\nbar\n'] |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 600 | |
Jeroen Ruigrok van der Werven | b70ccc3 | 2009-04-27 08:07:12 +0000 | [diff] [blame] | 601 | .. versionchanged:: 3.1 |
Gregory P. Smith | ccc5ae7 | 2009-03-02 05:21:55 +0000 | [diff] [blame] | 602 | Added the optional flags argument. |
| 603 | |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 604 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 605 | .. function:: findall(pattern, string, flags=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 606 | |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 607 | Return all non-overlapping matches of *pattern* in *string*, as a list of |
Georg Brandl | 3dbca81 | 2008-07-23 16:10:53 +0000 | [diff] [blame] | 608 | strings. The *string* is scanned left-to-right, and matches are returned in |
| 609 | the order found. If one or more groups are present in the pattern, return a |
| 610 | list of groups; this will be a list of tuples if the pattern has more than |
| 611 | one group. Empty matches are included in the result unless they touch the |
| 612 | beginning of another match. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 613 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 614 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 615 | .. function:: finditer(pattern, string, flags=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 616 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 617 | Return an :term:`iterator` yielding :ref:`match objects <match-objects>` over |
| 618 | all non-overlapping matches for the RE *pattern* in *string*. The *string* |
| 619 | is scanned left-to-right, and matches are returned in the order found. Empty |
Georg Brandl | 3dbca81 | 2008-07-23 16:10:53 +0000 | [diff] [blame] | 620 | matches are included in the result unless they touch the beginning of another |
| 621 | match. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 622 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 623 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 624 | .. function:: sub(pattern, repl, string, count=0, flags=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 625 | |
| 626 | Return the string obtained by replacing the leftmost non-overlapping occurrences |
| 627 | of *pattern* in *string* by the replacement *repl*. If the pattern isn't found, |
| 628 | *string* is returned unchanged. *repl* can be a string or a function; if it is |
| 629 | a string, any backslash escapes in it are processed. That is, ``\n`` is |
Sandro Tosi | 6a633bb | 2011-08-19 22:54:50 +0200 | [diff] [blame] | 630 | converted to a single newline character, ``\r`` is converted to a carriage return, and |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 631 | so forth. Unknown escapes such as ``\j`` are left alone. Backreferences, such |
| 632 | as ``\6``, are replaced with the substring matched by group 6 in the pattern. |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 633 | For example: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 634 | |
| 635 | >>> re.sub(r'def\s+([a-zA-Z_][a-zA-Z_0-9]*)\s*\(\s*\):', |
| 636 | ... r'static PyObject*\npy_\1(void)\n{', |
| 637 | ... 'def myfunc():') |
| 638 | 'static PyObject*\npy_myfunc(void)\n{' |
| 639 | |
| 640 | If *repl* is a function, it is called for every non-overlapping occurrence of |
| 641 | *pattern*. The function takes a single match object argument, and returns the |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 642 | replacement string. For example: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 643 | |
| 644 | >>> def dashrepl(matchobj): |
| 645 | ... if matchobj.group(0) == '-': return ' ' |
| 646 | ... else: return '-' |
| 647 | >>> re.sub('-{1,2}', dashrepl, 'pro----gram-files') |
| 648 | 'pro--gram files' |
Gregory P. Smith | ccc5ae7 | 2009-03-02 05:21:55 +0000 | [diff] [blame] | 649 | >>> re.sub(r'\sAND\s', ' & ', 'Baked Beans And Spam', flags=re.IGNORECASE) |
| 650 | 'Baked Beans & Spam' |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 651 | |
Georg Brandl | 1b5ab45 | 2009-08-13 07:56:35 +0000 | [diff] [blame] | 652 | The pattern may be a string or an RE object. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 653 | |
| 654 | The optional argument *count* is the maximum number of pattern occurrences to be |
| 655 | replaced; *count* must be a non-negative integer. If omitted or zero, all |
| 656 | occurrences will be replaced. Empty matches for the pattern are replaced only |
| 657 | when not adjacent to a previous match, so ``sub('x*', '-', 'abc')`` returns |
| 658 | ``'-a-b-c-'``. |
| 659 | |
| 660 | In addition to character escapes and backreferences as described above, |
| 661 | ``\g<name>`` will use the substring matched by the group named ``name``, as |
| 662 | defined by the ``(?P<name>...)`` syntax. ``\g<number>`` uses the corresponding |
| 663 | group number; ``\g<2>`` is therefore equivalent to ``\2``, but isn't ambiguous |
| 664 | in a replacement such as ``\g<2>0``. ``\20`` would be interpreted as a |
| 665 | reference to group 20, not a reference to group 2 followed by the literal |
| 666 | character ``'0'``. The backreference ``\g<0>`` substitutes in the entire |
| 667 | substring matched by the RE. |
| 668 | |
Jeroen Ruigrok van der Werven | b70ccc3 | 2009-04-27 08:07:12 +0000 | [diff] [blame] | 669 | .. versionchanged:: 3.1 |
Gregory P. Smith | ccc5ae7 | 2009-03-02 05:21:55 +0000 | [diff] [blame] | 670 | Added the optional flags argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 671 | |
Gregory P. Smith | ccc5ae7 | 2009-03-02 05:21:55 +0000 | [diff] [blame] | 672 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 673 | .. function:: subn(pattern, repl, string, count=0, flags=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 674 | |
| 675 | Perform the same operation as :func:`sub`, but return a tuple ``(new_string, |
| 676 | number_of_subs_made)``. |
| 677 | |
Jeroen Ruigrok van der Werven | b70ccc3 | 2009-04-27 08:07:12 +0000 | [diff] [blame] | 678 | .. versionchanged:: 3.1 |
Gregory P. Smith | ccc5ae7 | 2009-03-02 05:21:55 +0000 | [diff] [blame] | 679 | Added the optional flags argument. |
| 680 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 681 | |
| 682 | .. function:: escape(string) |
| 683 | |
Ezio Melotti | 88fdeb4 | 2011-04-10 12:59:16 +0300 | [diff] [blame] | 684 | Escape all the characters in pattern except ASCII letters, numbers and ``'_'``. |
| 685 | This is useful if you want to match an arbitrary literal string that may |
| 686 | have regular expression metacharacters in it. |
| 687 | |
| 688 | .. versionchanged:: 3.3 |
| 689 | The ``'_'`` character is no longer escaped. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 690 | |
| 691 | |
R. David Murray | 522c32a | 2010-07-10 14:23:36 +0000 | [diff] [blame] | 692 | .. function:: purge() |
| 693 | |
| 694 | Clear the regular expression cache. |
| 695 | |
| 696 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 697 | .. exception:: error |
| 698 | |
| 699 | Exception raised when a string passed to one of the functions here is not a |
| 700 | valid regular expression (for example, it might contain unmatched parentheses) |
| 701 | or when some other error occurs during compilation or matching. It is never an |
| 702 | error if a string contains no match for a pattern. |
| 703 | |
| 704 | |
| 705 | .. _re-objects: |
| 706 | |
| 707 | Regular Expression Objects |
| 708 | -------------------------- |
| 709 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 710 | Compiled regular expression objects support the following methods and |
Raymond Hettinger | 5768e0c | 2011-10-19 14:10:07 -0700 | [diff] [blame] | 711 | attributes: |
Brian Curtin | 027e478 | 2010-03-26 00:39:56 +0000 | [diff] [blame] | 712 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 713 | .. method:: regex.search(string[, pos[, endpos]]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 714 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 715 | Scan through *string* looking for a location where this regular expression |
| 716 | produces a match, and return a corresponding :ref:`match object |
| 717 | <match-objects>`. Return ``None`` if no position in the string matches the |
| 718 | pattern; note that this is different from finding a zero-length match at some |
| 719 | point in the string. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 720 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 721 | The optional second parameter *pos* gives an index in the string where the |
| 722 | search is to start; it defaults to ``0``. This is not completely equivalent to |
| 723 | slicing the string; the ``'^'`` pattern character matches at the real beginning |
| 724 | of the string and at positions just after a newline, but not necessarily at the |
| 725 | index where the search is to start. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 726 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 727 | The optional parameter *endpos* limits how far the string will be searched; it |
| 728 | will be as if the string is *endpos* characters long, so only the characters |
| 729 | from *pos* to ``endpos - 1`` will be searched for a match. If *endpos* is less |
Raymond Hettinger | 5768e0c | 2011-10-19 14:10:07 -0700 | [diff] [blame] | 730 | than *pos*, no match will be found; otherwise, if *rx* is a compiled regular |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 731 | expression object, ``rx.search(string, 0, 50)`` is equivalent to |
| 732 | ``rx.search(string[:50], 0)``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 733 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 734 | >>> pattern = re.compile("d") |
| 735 | >>> pattern.search("dog") # Match at index 0 |
| 736 | <_sre.SRE_Match object at ...> |
| 737 | >>> pattern.search("dog", 1) # No match; search doesn't include the "d" |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 738 | |
| 739 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 740 | .. method:: regex.match(string[, pos[, endpos]]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 741 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 742 | If zero or more characters at the *beginning* of *string* match this regular |
| 743 | expression, return a corresponding :ref:`match object <match-objects>`. |
| 744 | Return ``None`` if the string does not match the pattern; note that this is |
| 745 | different from a zero-length match. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 746 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 747 | The optional *pos* and *endpos* parameters have the same meaning as for the |
| 748 | :meth:`~regex.search` method. |
Benjamin Peterson | d7c3ed5 | 2010-06-27 22:32:30 +0000 | [diff] [blame] | 749 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 750 | >>> pattern = re.compile("o") |
| 751 | >>> pattern.match("dog") # No match as "o" is not at the start of "dog". |
| 752 | >>> pattern.match("dog", 1) # Match as "o" is the 2nd character of "dog". |
| 753 | <_sre.SRE_Match object at ...> |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 754 | |
Ezio Melotti | 443f000 | 2012-02-29 13:39:05 +0200 | [diff] [blame] | 755 | If you want to locate a match anywhere in *string*, use |
| 756 | :meth:`~regex.search` instead (see also :ref:`search-vs-match`). |
| 757 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 758 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 759 | .. method:: regex.split(string, maxsplit=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 760 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 761 | Identical to the :func:`split` function, using the compiled pattern. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 762 | |
| 763 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 764 | .. method:: regex.findall(string[, pos[, endpos]]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 765 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 766 | Similar to the :func:`findall` function, using the compiled pattern, but |
| 767 | also accepts optional *pos* and *endpos* parameters that limit the search |
| 768 | region like for :meth:`match`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 769 | |
| 770 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 771 | .. method:: regex.finditer(string[, pos[, endpos]]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 772 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 773 | Similar to the :func:`finditer` function, using the compiled pattern, but |
| 774 | also accepts optional *pos* and *endpos* parameters that limit the search |
| 775 | region like for :meth:`match`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 776 | |
| 777 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 778 | .. method:: regex.sub(repl, string, count=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 779 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 780 | Identical to the :func:`sub` function, using the compiled pattern. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 781 | |
| 782 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 783 | .. method:: regex.subn(repl, string, count=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 784 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 785 | Identical to the :func:`subn` function, using the compiled pattern. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 786 | |
| 787 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 788 | .. attribute:: regex.flags |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 789 | |
Georg Brandl | 3a19e54 | 2012-03-17 17:29:27 +0100 | [diff] [blame] | 790 | The regex matching flags. This is a combination of the flags given to |
| 791 | :func:`.compile`, any ``(?...)`` inline flags in the pattern, and implicit |
| 792 | flags such as :data:`UNICODE` if the pattern is a Unicode string. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 793 | |
| 794 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 795 | .. attribute:: regex.groups |
Georg Brandl | af265f4 | 2008-12-07 15:06:20 +0000 | [diff] [blame] | 796 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 797 | The number of capturing groups in the pattern. |
Georg Brandl | af265f4 | 2008-12-07 15:06:20 +0000 | [diff] [blame] | 798 | |
| 799 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 800 | .. attribute:: regex.groupindex |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 801 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 802 | A dictionary mapping any symbolic group names defined by ``(?P<id>)`` to group |
| 803 | numbers. The dictionary is empty if no symbolic groups were used in the |
| 804 | pattern. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 805 | |
| 806 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 807 | .. attribute:: regex.pattern |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 808 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 809 | The pattern string from which the RE object was compiled. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 810 | |
| 811 | |
| 812 | .. _match-objects: |
| 813 | |
| 814 | Match Objects |
| 815 | ------------- |
| 816 | |
Raymond Hettinger | 5768e0c | 2011-10-19 14:10:07 -0700 | [diff] [blame] | 817 | Match objects always have a boolean value of :const:`True`. This lets you |
| 818 | use a simple if-statement to test whether a match was found. Match objects |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 819 | support the following methods and attributes: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 820 | |
| 821 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 822 | .. method:: match.expand(template) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 823 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 824 | Return the string obtained by doing backslash substitution on the template |
| 825 | string *template*, as done by the :meth:`~regex.sub` method. |
| 826 | Escapes such as ``\n`` are converted to the appropriate characters, |
| 827 | and numeric backreferences (``\1``, ``\2``) and named backreferences |
| 828 | (``\g<1>``, ``\g<name>``) are replaced by the contents of the |
| 829 | corresponding group. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 830 | |
| 831 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 832 | .. method:: match.group([group1, ...]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 833 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 834 | Returns one or more subgroups of the match. If there is a single argument, the |
| 835 | result is a single string; if there are multiple arguments, the result is a |
| 836 | tuple with one item per argument. Without arguments, *group1* defaults to zero |
| 837 | (the whole match is returned). If a *groupN* argument is zero, the corresponding |
| 838 | return value is the entire matching string; if it is in the inclusive range |
| 839 | [1..99], it is the string matching the corresponding parenthesized group. If a |
| 840 | group number is negative or larger than the number of groups defined in the |
| 841 | pattern, an :exc:`IndexError` exception is raised. If a group is contained in a |
| 842 | part of the pattern that did not match, the corresponding result is ``None``. |
| 843 | If a group is contained in a part of the pattern that matched multiple times, |
| 844 | the last match is returned. |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 845 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 846 | >>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist") |
| 847 | >>> m.group(0) # The entire match |
| 848 | 'Isaac Newton' |
| 849 | >>> m.group(1) # The first parenthesized subgroup. |
| 850 | 'Isaac' |
| 851 | >>> m.group(2) # The second parenthesized subgroup. |
| 852 | 'Newton' |
| 853 | >>> m.group(1, 2) # Multiple arguments give us a tuple. |
| 854 | ('Isaac', 'Newton') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 855 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 856 | If the regular expression uses the ``(?P<name>...)`` syntax, the *groupN* |
| 857 | arguments may also be strings identifying groups by their group name. If a |
| 858 | string argument is not used as a group name in the pattern, an :exc:`IndexError` |
| 859 | exception is raised. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 860 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 861 | A moderately complicated example: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 862 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 863 | >>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds") |
| 864 | >>> m.group('first_name') |
| 865 | 'Malcolm' |
| 866 | >>> m.group('last_name') |
| 867 | 'Reynolds' |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 868 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 869 | Named groups can also be referred to by their index: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 870 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 871 | >>> m.group(1) |
| 872 | 'Malcolm' |
| 873 | >>> m.group(2) |
| 874 | 'Reynolds' |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 875 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 876 | If a group matches multiple times, only the last match is accessible: |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 877 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 878 | >>> m = re.match(r"(..)+", "a1b2c3") # Matches 3 times. |
| 879 | >>> m.group(1) # Returns only the last match. |
| 880 | 'c3' |
Brian Curtin | 027e478 | 2010-03-26 00:39:56 +0000 | [diff] [blame] | 881 | |
Brian Curtin | 48f16f9 | 2010-04-08 13:55:29 +0000 | [diff] [blame] | 882 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 883 | .. method:: match.groups(default=None) |
Brian Curtin | 48f16f9 | 2010-04-08 13:55:29 +0000 | [diff] [blame] | 884 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 885 | Return a tuple containing all the subgroups of the match, from 1 up to however |
| 886 | many groups are in the pattern. The *default* argument is used for groups that |
| 887 | did not participate in the match; it defaults to ``None``. |
Brian Curtin | 027e478 | 2010-03-26 00:39:56 +0000 | [diff] [blame] | 888 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 889 | For example: |
Brian Curtin | 027e478 | 2010-03-26 00:39:56 +0000 | [diff] [blame] | 890 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 891 | >>> m = re.match(r"(\d+)\.(\d+)", "24.1632") |
| 892 | >>> m.groups() |
| 893 | ('24', '1632') |
Brian Curtin | 027e478 | 2010-03-26 00:39:56 +0000 | [diff] [blame] | 894 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 895 | If we make the decimal place and everything after it optional, not all groups |
| 896 | might participate in the match. These groups will default to ``None`` unless |
| 897 | the *default* argument is given: |
Brian Curtin | 027e478 | 2010-03-26 00:39:56 +0000 | [diff] [blame] | 898 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 899 | >>> m = re.match(r"(\d+)\.?(\d+)?", "24") |
| 900 | >>> m.groups() # Second group defaults to None. |
| 901 | ('24', None) |
| 902 | >>> m.groups('0') # Now, the second group defaults to '0'. |
| 903 | ('24', '0') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 904 | |
| 905 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 906 | .. method:: match.groupdict(default=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 907 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 908 | Return a dictionary containing all the *named* subgroups of the match, keyed by |
| 909 | the subgroup name. The *default* argument is used for groups that did not |
| 910 | participate in the match; it defaults to ``None``. For example: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 911 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 912 | >>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds") |
| 913 | >>> m.groupdict() |
| 914 | {'first_name': 'Malcolm', 'last_name': 'Reynolds'} |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 915 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 916 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 917 | .. method:: match.start([group]) |
| 918 | match.end([group]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 919 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 920 | Return the indices of the start and end of the substring matched by *group*; |
| 921 | *group* defaults to zero (meaning the whole matched substring). Return ``-1`` if |
| 922 | *group* exists but did not contribute to the match. For a match object *m*, and |
| 923 | a group *g* that did contribute to the match, the substring matched by group *g* |
| 924 | (equivalent to ``m.group(g)``) is :: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 925 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 926 | m.string[m.start(g):m.end(g)] |
Brian Curtin | 027e478 | 2010-03-26 00:39:56 +0000 | [diff] [blame] | 927 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 928 | Note that ``m.start(group)`` will equal ``m.end(group)`` if *group* matched a |
| 929 | null string. For example, after ``m = re.search('b(c?)', 'cba')``, |
| 930 | ``m.start(0)`` is 1, ``m.end(0)`` is 2, ``m.start(1)`` and ``m.end(1)`` are both |
| 931 | 2, and ``m.start(2)`` raises an :exc:`IndexError` exception. |
Brian Curtin | 027e478 | 2010-03-26 00:39:56 +0000 | [diff] [blame] | 932 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 933 | An example that will remove *remove_this* from email addresses: |
Brian Curtin | 027e478 | 2010-03-26 00:39:56 +0000 | [diff] [blame] | 934 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 935 | >>> email = "tony@tiremove_thisger.net" |
| 936 | >>> m = re.search("remove_this", email) |
| 937 | >>> email[:m.start()] + email[m.end():] |
| 938 | 'tony@tiger.net' |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 939 | |
| 940 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 941 | .. method:: match.span([group]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 942 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 943 | For a match *m*, return the 2-tuple ``(m.start(group), m.end(group))``. Note |
| 944 | that if *group* did not contribute to the match, this is ``(-1, -1)``. |
| 945 | *group* defaults to zero, the entire match. |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 946 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 947 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 948 | .. attribute:: match.pos |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 949 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 950 | The value of *pos* which was passed to the :meth:`~regex.search` or |
Georg Brandl | 69c7a69 | 2012-03-14 08:02:43 +0100 | [diff] [blame] | 951 | :meth:`~regex.match` method of a :ref:`regex object <re-objects>`. This is |
| 952 | the index into the string at which the RE engine started looking for a match. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 953 | |
| 954 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 955 | .. attribute:: match.endpos |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 956 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 957 | The value of *endpos* which was passed to the :meth:`~regex.search` or |
Georg Brandl | 69c7a69 | 2012-03-14 08:02:43 +0100 | [diff] [blame] | 958 | :meth:`~regex.match` method of a :ref:`regex object <re-objects>`. This is |
| 959 | the index into the string beyond which the RE engine will not go. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 960 | |
| 961 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 962 | .. attribute:: match.lastindex |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 963 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 964 | The integer index of the last matched capturing group, or ``None`` if no group |
| 965 | was matched at all. For example, the expressions ``(a)b``, ``((a)(b))``, and |
| 966 | ``((ab))`` will have ``lastindex == 1`` if applied to the string ``'ab'``, while |
| 967 | the expression ``(a)(b)`` will have ``lastindex == 2``, if applied to the same |
| 968 | string. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 969 | |
| 970 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 971 | .. attribute:: match.lastgroup |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 972 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 973 | The name of the last matched capturing group, or ``None`` if the group didn't |
| 974 | have a name, or if no group was matched at all. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 975 | |
| 976 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 977 | .. attribute:: match.re |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 978 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 979 | The regular expression object whose :meth:`~regex.match` or |
| 980 | :meth:`~regex.search` method produced this match instance. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 981 | |
| 982 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 983 | .. attribute:: match.string |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 984 | |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 985 | The string passed to :meth:`~regex.match` or :meth:`~regex.search`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 986 | |
| 987 | |
Raymond Hettinger | 1fa7682 | 2010-12-06 23:31:36 +0000 | [diff] [blame] | 988 | .. _re-examples: |
| 989 | |
| 990 | Regular Expression Examples |
| 991 | --------------------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 992 | |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 993 | |
Raymond Hettinger | 5768e0c | 2011-10-19 14:10:07 -0700 | [diff] [blame] | 994 | Checking for a Pair |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 995 | ^^^^^^^^^^^^^^^^^^^ |
| 996 | |
| 997 | In this example, we'll use the following helper function to display match |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 998 | objects a little more gracefully: |
| 999 | |
| 1000 | .. testcode:: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1001 | |
| 1002 | def displaymatch(match): |
| 1003 | if match is None: |
| 1004 | return None |
| 1005 | return '<Match: %r, groups=%r>' % (match.group(), match.groups()) |
| 1006 | |
| 1007 | Suppose you are writing a poker program where a player's hand is represented as |
| 1008 | a 5-character string with each character representing a card, "a" for ace, "k" |
Ezio Melotti | e5b2ac8 | 2011-12-17 01:17:17 +0200 | [diff] [blame] | 1009 | for king, "q" for queen, "j" for jack, "t" for 10, and "2" through "9" |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1010 | representing the card with that value. |
| 1011 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1012 | To see if a given string is a valid hand, one could do the following: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1013 | |
Ezio Melotti | e5b2ac8 | 2011-12-17 01:17:17 +0200 | [diff] [blame] | 1014 | >>> valid = re.compile(r"^[a2-9tjqk]{5}$") |
| 1015 | >>> displaymatch(valid.match("akt5q")) # Valid. |
| 1016 | "<Match: 'akt5q', groups=()>" |
| 1017 | >>> displaymatch(valid.match("akt5e")) # Invalid. |
| 1018 | >>> displaymatch(valid.match("akt")) # Invalid. |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1019 | >>> displaymatch(valid.match("727ak")) # Valid. |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1020 | "<Match: '727ak', groups=()>" |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1021 | |
| 1022 | That last hand, ``"727ak"``, contained a pair, or two of the same valued cards. |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1023 | To match this with a regular expression, one could use backreferences as such: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1024 | |
| 1025 | >>> pair = re.compile(r".*(.).*\1") |
| 1026 | >>> displaymatch(pair.match("717ak")) # Pair of 7s. |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1027 | "<Match: '717', groups=('7',)>" |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1028 | >>> displaymatch(pair.match("718ak")) # No pairs. |
| 1029 | >>> displaymatch(pair.match("354aa")) # Pair of aces. |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1030 | "<Match: '354aa', groups=('a',)>" |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1031 | |
Georg Brandl | f346ac0 | 2009-07-26 15:03:49 +0000 | [diff] [blame] | 1032 | To find out what card the pair consists of, one could use the |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 1033 | :meth:`~match.group` method of the match object in the following manner: |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1034 | |
| 1035 | .. doctest:: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1036 | |
| 1037 | >>> pair.match("717ak").group(1) |
| 1038 | '7' |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1039 | |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1040 | # Error because re.match() returns None, which doesn't have a group() method: |
| 1041 | >>> pair.match("718ak").group(1) |
| 1042 | Traceback (most recent call last): |
| 1043 | File "<pyshell#23>", line 1, in <module> |
| 1044 | re.match(r".*(.).*\1", "718ak").group(1) |
| 1045 | AttributeError: 'NoneType' object has no attribute 'group' |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1046 | |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1047 | >>> pair.match("354aa").group(1) |
| 1048 | 'a' |
| 1049 | |
| 1050 | |
| 1051 | Simulating scanf() |
| 1052 | ^^^^^^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1053 | |
| 1054 | .. index:: single: scanf() |
| 1055 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1056 | Python does not currently have an equivalent to :c:func:`scanf`. Regular |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1057 | expressions are generally more powerful, though also more verbose, than |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1058 | :c:func:`scanf` format strings. The table below offers some more-or-less |
| 1059 | equivalent mappings between :c:func:`scanf` format tokens and regular |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1060 | expressions. |
| 1061 | |
| 1062 | +--------------------------------+---------------------------------------------+ |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1063 | | :c:func:`scanf` Token | Regular Expression | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1064 | +================================+=============================================+ |
| 1065 | | ``%c`` | ``.`` | |
| 1066 | +--------------------------------+---------------------------------------------+ |
| 1067 | | ``%5c`` | ``.{5}`` | |
| 1068 | +--------------------------------+---------------------------------------------+ |
| 1069 | | ``%d`` | ``[-+]?\d+`` | |
| 1070 | +--------------------------------+---------------------------------------------+ |
| 1071 | | ``%e``, ``%E``, ``%f``, ``%g`` | ``[-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?`` | |
| 1072 | +--------------------------------+---------------------------------------------+ |
| 1073 | | ``%i`` | ``[-+]?(0[xX][\dA-Fa-f]+|0[0-7]*|\d+)`` | |
| 1074 | +--------------------------------+---------------------------------------------+ |
| 1075 | | ``%o`` | ``0[0-7]*`` | |
| 1076 | +--------------------------------+---------------------------------------------+ |
| 1077 | | ``%s`` | ``\S+`` | |
| 1078 | +--------------------------------+---------------------------------------------+ |
| 1079 | | ``%u`` | ``\d+`` | |
| 1080 | +--------------------------------+---------------------------------------------+ |
| 1081 | | ``%x``, ``%X`` | ``0[xX][\dA-Fa-f]+`` | |
| 1082 | +--------------------------------+---------------------------------------------+ |
| 1083 | |
| 1084 | To extract the filename and numbers from a string like :: |
| 1085 | |
| 1086 | /usr/sbin/sendmail - 0 errors, 4 warnings |
| 1087 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1088 | you would use a :c:func:`scanf` format like :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1089 | |
| 1090 | %s - %d errors, %d warnings |
| 1091 | |
| 1092 | The equivalent regular expression would be :: |
| 1093 | |
| 1094 | (\S+) - (\d+) errors, (\d+) warnings |
| 1095 | |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1096 | |
Ezio Melotti | 443f000 | 2012-02-29 13:39:05 +0200 | [diff] [blame] | 1097 | .. _search-vs-match: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1098 | |
| 1099 | search() vs. match() |
| 1100 | ^^^^^^^^^^^^^^^^^^^^ |
| 1101 | |
Ezio Melotti | 443f000 | 2012-02-29 13:39:05 +0200 | [diff] [blame] | 1102 | .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1103 | |
Ezio Melotti | 443f000 | 2012-02-29 13:39:05 +0200 | [diff] [blame] | 1104 | Python offers two different primitive operations based on regular expressions: |
| 1105 | :func:`re.match` checks for a match only at the beginning of the string, while |
| 1106 | :func:`re.search` checks for a match anywhere in the string (this is what Perl |
| 1107 | does by default). |
| 1108 | |
| 1109 | For example:: |
| 1110 | |
| 1111 | >>> re.match("c", "abcdef") # No match |
| 1112 | >>> re.search("c", "abcdef") # Match |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1113 | <_sre.SRE_Match object at ...> |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1114 | |
Ezio Melotti | 443f000 | 2012-02-29 13:39:05 +0200 | [diff] [blame] | 1115 | Regular expressions beginning with ``'^'`` can be used with :func:`search` to |
| 1116 | restrict the match at the beginning of the string:: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1117 | |
Ezio Melotti | 443f000 | 2012-02-29 13:39:05 +0200 | [diff] [blame] | 1118 | >>> re.match("c", "abcdef") # No match |
| 1119 | >>> re.search("^c", "abcdef") # No match |
| 1120 | >>> re.search("^a", "abcdef") # Match |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1121 | <_sre.SRE_Match object at ...> |
Ezio Melotti | 443f000 | 2012-02-29 13:39:05 +0200 | [diff] [blame] | 1122 | |
| 1123 | Note however that in :const:`MULTILINE` mode :func:`match` only matches at the |
| 1124 | beginning of the string, whereas using :func:`search` with a regular expression |
| 1125 | beginning with ``'^'`` will match at the beginning of each line. |
| 1126 | |
| 1127 | >>> re.match('X', 'A\nB\nX', re.MULTILINE) # No match |
| 1128 | >>> re.search('^X', 'A\nB\nX', re.MULTILINE) # Match |
| 1129 | <_sre.SRE_Match object at ...> |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1130 | |
| 1131 | |
| 1132 | Making a Phonebook |
| 1133 | ^^^^^^^^^^^^^^^^^^ |
| 1134 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1135 | :func:`split` splits a string into a list delimited by the passed pattern. The |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1136 | method is invaluable for converting textual data into data structures that can be |
| 1137 | easily read and modified by Python as demonstrated in the following example that |
| 1138 | creates a phonebook. |
| 1139 | |
Christian Heimes | 255f53b | 2007-12-08 15:33:56 +0000 | [diff] [blame] | 1140 | First, here is the input. Normally it may come from a file, here we are using |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1141 | triple-quoted string syntax: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1142 | |
Georg Brandl | 557a3ec | 2012-03-17 17:26:27 +0100 | [diff] [blame] | 1143 | >>> text = """Ross McFluff: 834.345.1254 155 Elm Street |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1144 | ... |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1145 | ... Ronald Heathmore: 892.345.3428 436 Finley Avenue |
| 1146 | ... Frank Burger: 925.541.7625 662 South Dogwood Way |
| 1147 | ... |
| 1148 | ... |
| 1149 | ... Heather Albrecht: 548.326.4584 919 Park Place""" |
Christian Heimes | 255f53b | 2007-12-08 15:33:56 +0000 | [diff] [blame] | 1150 | |
| 1151 | The entries are separated by one or more newlines. Now we convert the string |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1152 | into a list with each nonempty line having its own entry: |
| 1153 | |
| 1154 | .. doctest:: |
| 1155 | :options: +NORMALIZE_WHITESPACE |
Christian Heimes | 255f53b | 2007-12-08 15:33:56 +0000 | [diff] [blame] | 1156 | |
Georg Brandl | 557a3ec | 2012-03-17 17:26:27 +0100 | [diff] [blame] | 1157 | >>> entries = re.split("\n+", text) |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1158 | >>> entries |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1159 | ['Ross McFluff: 834.345.1254 155 Elm Street', |
| 1160 | 'Ronald Heathmore: 892.345.3428 436 Finley Avenue', |
| 1161 | 'Frank Burger: 925.541.7625 662 South Dogwood Way', |
| 1162 | 'Heather Albrecht: 548.326.4584 919 Park Place'] |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1163 | |
| 1164 | Finally, split each entry into a list with first name, last name, telephone |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 1165 | number, and address. We use the ``maxsplit`` parameter of :func:`split` |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1166 | because the address has spaces, our splitting pattern, in it: |
| 1167 | |
| 1168 | .. doctest:: |
| 1169 | :options: +NORMALIZE_WHITESPACE |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1170 | |
Christian Heimes | 255f53b | 2007-12-08 15:33:56 +0000 | [diff] [blame] | 1171 | >>> [re.split(":? ", entry, 3) for entry in entries] |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1172 | [['Ross', 'McFluff', '834.345.1254', '155 Elm Street'], |
| 1173 | ['Ronald', 'Heathmore', '892.345.3428', '436 Finley Avenue'], |
| 1174 | ['Frank', 'Burger', '925.541.7625', '662 South Dogwood Way'], |
| 1175 | ['Heather', 'Albrecht', '548.326.4584', '919 Park Place']] |
| 1176 | |
Christian Heimes | 255f53b | 2007-12-08 15:33:56 +0000 | [diff] [blame] | 1177 | The ``:?`` pattern matches the colon after the last name, so that it does not |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 1178 | occur in the result list. With a ``maxsplit`` of ``4``, we could separate the |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1179 | house number from the street name: |
| 1180 | |
| 1181 | .. doctest:: |
| 1182 | :options: +NORMALIZE_WHITESPACE |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1183 | |
Christian Heimes | 255f53b | 2007-12-08 15:33:56 +0000 | [diff] [blame] | 1184 | >>> [re.split(":? ", entry, 4) for entry in entries] |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1185 | [['Ross', 'McFluff', '834.345.1254', '155', 'Elm Street'], |
| 1186 | ['Ronald', 'Heathmore', '892.345.3428', '436', 'Finley Avenue'], |
| 1187 | ['Frank', 'Burger', '925.541.7625', '662', 'South Dogwood Way'], |
| 1188 | ['Heather', 'Albrecht', '548.326.4584', '919', 'Park Place']] |
| 1189 | |
| 1190 | |
| 1191 | Text Munging |
| 1192 | ^^^^^^^^^^^^ |
| 1193 | |
| 1194 | :func:`sub` replaces every occurrence of a pattern with a string or the |
| 1195 | result of a function. This example demonstrates using :func:`sub` with |
| 1196 | a function to "munge" text, or randomize the order of all the characters |
| 1197 | in each word of a sentence except for the first and last characters:: |
| 1198 | |
| 1199 | >>> def repl(m): |
| 1200 | ... inner_word = list(m.group(2)) |
| 1201 | ... random.shuffle(inner_word) |
| 1202 | ... return m.group(1) + "".join(inner_word) + m.group(3) |
| 1203 | >>> text = "Professor Abdolmalek, please report your absences promptly." |
Georg Brandl | db4e939 | 2010-07-12 09:06:13 +0000 | [diff] [blame] | 1204 | >>> re.sub(r"(\w)(\w+)(\w)", repl, text) |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1205 | 'Poefsrosr Aealmlobdk, pslaee reorpt your abnseces plmrptoy.' |
Georg Brandl | db4e939 | 2010-07-12 09:06:13 +0000 | [diff] [blame] | 1206 | >>> re.sub(r"(\w)(\w+)(\w)", repl, text) |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1207 | 'Pofsroser Aodlambelk, plasee reoprt yuor asnebces potlmrpy.' |
| 1208 | |
| 1209 | |
| 1210 | Finding all Adverbs |
| 1211 | ^^^^^^^^^^^^^^^^^^^ |
| 1212 | |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 1213 | :func:`findall` matches *all* occurrences of a pattern, not just the first |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1214 | one as :func:`search` does. For example, if one was a writer and wanted to |
| 1215 | find all of the adverbs in some text, he or she might use :func:`findall` in |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1216 | the following manner: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1217 | |
| 1218 | >>> text = "He was carefully disguised but captured quickly by police." |
| 1219 | >>> re.findall(r"\w+ly", text) |
| 1220 | ['carefully', 'quickly'] |
| 1221 | |
| 1222 | |
| 1223 | Finding all Adverbs and their Positions |
| 1224 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 1225 | |
| 1226 | If one wants more information about all matches of a pattern than the matched |
Georg Brandl | c62a704 | 2010-07-29 11:49:05 +0000 | [diff] [blame] | 1227 | text, :func:`finditer` is useful as it provides :ref:`match objects |
| 1228 | <match-objects>` instead of strings. Continuing with the previous example, if |
| 1229 | one was a writer who wanted to find all of the adverbs *and their positions* in |
| 1230 | some text, he or she would use :func:`finditer` in the following manner: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1231 | |
| 1232 | >>> text = "He was carefully disguised but captured quickly by police." |
| 1233 | >>> for m in re.finditer(r"\w+ly", text): |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1234 | ... print('%02d-%02d: %s' % (m.start(), m.end(), m.group(0))) |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1235 | 07-16: carefully |
| 1236 | 40-47: quickly |
| 1237 | |
| 1238 | |
| 1239 | Raw String Notation |
| 1240 | ^^^^^^^^^^^^^^^^^^^ |
| 1241 | |
| 1242 | Raw string notation (``r"text"``) keeps regular expressions sane. Without it, |
| 1243 | every backslash (``'\'``) in a regular expression would have to be prefixed with |
| 1244 | another one to escape it. For example, the two following lines of code are |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1245 | functionally identical: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1246 | |
| 1247 | >>> re.match(r"\W(.)\1\W", " ff ") |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1248 | <_sre.SRE_Match object at ...> |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1249 | >>> re.match("\\W(.)\\1\\W", " ff ") |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1250 | <_sre.SRE_Match object at ...> |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1251 | |
| 1252 | When one wants to match a literal backslash, it must be escaped in the regular |
| 1253 | expression. With raw string notation, this means ``r"\\"``. Without raw string |
| 1254 | notation, one must use ``"\\\\"``, making the following lines of code |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1255 | functionally identical: |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1256 | |
| 1257 | >>> re.match(r"\\", r"\\") |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1258 | <_sre.SRE_Match object at ...> |
Christian Heimes | b9eccbf | 2007-12-05 20:18:38 +0000 | [diff] [blame] | 1259 | >>> re.match("\\\\", r"\\") |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 1260 | <_sre.SRE_Match object at ...> |
Raymond Hettinger | 37ade9c | 2010-09-16 12:02:17 +0000 | [diff] [blame] | 1261 | |
| 1262 | |
| 1263 | Writing a Tokenizer |
| 1264 | ^^^^^^^^^^^^^^^^^^^ |
| 1265 | |
| 1266 | A `tokenizer or scanner <http://en.wikipedia.org/wiki/Lexical_analysis>`_ |
| 1267 | analyzes a string to categorize groups of characters. This is a useful first |
| 1268 | step in writing a compiler or interpreter. |
| 1269 | |
| 1270 | The text categories are specified with regular expressions. The technique is |
| 1271 | to combine those into a single master regular expression and to loop over |
| 1272 | successive matches:: |
| 1273 | |
Raymond Hettinger | 4b244ef | 2011-05-23 12:45:34 -0700 | [diff] [blame] | 1274 | import collections |
| 1275 | import re |
| 1276 | |
| 1277 | Token = collections.namedtuple('Token', ['typ', 'value', 'line', 'column']) |
Raymond Hettinger | 37ade9c | 2010-09-16 12:02:17 +0000 | [diff] [blame] | 1278 | |
| 1279 | def tokenize(s): |
Raymond Hettinger | 4b244ef | 2011-05-23 12:45:34 -0700 | [diff] [blame] | 1280 | keywords = {'IF', 'THEN', 'ENDIF', 'FOR', 'NEXT', 'GOSUB', 'RETURN'} |
| 1281 | token_specification = [ |
| 1282 | ('NUMBER', r'\d+(\.\d*)?'), # Integer or decimal number |
| 1283 | ('ASSIGN', r':='), # Assignment operator |
| 1284 | ('END', r';'), # Statement terminator |
| 1285 | ('ID', r'[A-Za-z]+'), # Identifiers |
| 1286 | ('OP', r'[+*\/\-]'), # Arithmetic operators |
| 1287 | ('NEWLINE', r'\n'), # Line endings |
| 1288 | ('SKIP', r'[ \t]'), # Skip over spaces and tabs |
Raymond Hettinger | 37ade9c | 2010-09-16 12:02:17 +0000 | [diff] [blame] | 1289 | ] |
Raymond Hettinger | 4b244ef | 2011-05-23 12:45:34 -0700 | [diff] [blame] | 1290 | tok_regex = '|'.join('(?P<%s>%s)' % pair for pair in token_specification) |
| 1291 | get_token = re.compile(tok_regex).match |
Raymond Hettinger | 37ade9c | 2010-09-16 12:02:17 +0000 | [diff] [blame] | 1292 | line = 1 |
| 1293 | pos = line_start = 0 |
Raymond Hettinger | 4b244ef | 2011-05-23 12:45:34 -0700 | [diff] [blame] | 1294 | mo = get_token(s) |
Raymond Hettinger | 37ade9c | 2010-09-16 12:02:17 +0000 | [diff] [blame] | 1295 | while mo is not None: |
| 1296 | typ = mo.lastgroup |
| 1297 | if typ == 'NEWLINE': |
| 1298 | line_start = pos |
| 1299 | line += 1 |
| 1300 | elif typ != 'SKIP': |
Georg Brandl | 325477e | 2011-05-13 06:54:23 +0200 | [diff] [blame] | 1301 | val = mo.group(typ) |
Raymond Hettinger | c2c7c37 | 2010-12-07 09:44:21 +0000 | [diff] [blame] | 1302 | if typ == 'ID' and val in keywords: |
| 1303 | typ = val |
Georg Brandl | 325477e | 2011-05-13 06:54:23 +0200 | [diff] [blame] | 1304 | yield Token(typ, val, line, mo.start()-line_start) |
Raymond Hettinger | 37ade9c | 2010-09-16 12:02:17 +0000 | [diff] [blame] | 1305 | pos = mo.end() |
Raymond Hettinger | 4b244ef | 2011-05-23 12:45:34 -0700 | [diff] [blame] | 1306 | mo = get_token(s, pos) |
Raymond Hettinger | 37ade9c | 2010-09-16 12:02:17 +0000 | [diff] [blame] | 1307 | if pos != len(s): |
| 1308 | raise RuntimeError('Unexpected character %r on line %d' %(s[pos], line)) |
| 1309 | |
Raymond Hettinger | 4b244ef | 2011-05-23 12:45:34 -0700 | [diff] [blame] | 1310 | statements = ''' |
| 1311 | IF quantity THEN |
| 1312 | total := total + price * quantity; |
| 1313 | tax := price * 0.05; |
| 1314 | ENDIF; |
Raymond Hettinger | 37ade9c | 2010-09-16 12:02:17 +0000 | [diff] [blame] | 1315 | ''' |
Raymond Hettinger | 23157e5 | 2011-05-13 01:38:31 -0700 | [diff] [blame] | 1316 | |
| 1317 | for token in tokenize(statements): |
| 1318 | print(token) |
| 1319 | |
| 1320 | The tokenizer produces the following output:: |
Raymond Hettinger | 9c47d77 | 2011-05-13 01:03:50 -0700 | [diff] [blame] | 1321 | |
Raymond Hettinger | 4b244ef | 2011-05-23 12:45:34 -0700 | [diff] [blame] | 1322 | Token(typ='IF', value='IF', line=2, column=5) |
| 1323 | Token(typ='ID', value='quantity', line=2, column=8) |
| 1324 | Token(typ='THEN', value='THEN', line=2, column=17) |
| 1325 | Token(typ='ID', value='total', line=3, column=9) |
| 1326 | Token(typ='ASSIGN', value=':=', line=3, column=15) |
| 1327 | Token(typ='ID', value='total', line=3, column=18) |
| 1328 | Token(typ='OP', value='+', line=3, column=24) |
| 1329 | Token(typ='ID', value='price', line=3, column=26) |
| 1330 | Token(typ='OP', value='*', line=3, column=32) |
| 1331 | Token(typ='ID', value='quantity', line=3, column=34) |
| 1332 | Token(typ='END', value=';', line=3, column=42) |
| 1333 | Token(typ='ID', value='tax', line=4, column=9) |
| 1334 | Token(typ='ASSIGN', value=':=', line=4, column=13) |
| 1335 | Token(typ='ID', value='price', line=4, column=16) |
| 1336 | Token(typ='OP', value='*', line=4, column=22) |
| 1337 | Token(typ='NUMBER', value='0.05', line=4, column=24) |
| 1338 | Token(typ='END', value=';', line=4, column=28) |
| 1339 | Token(typ='ENDIF', value='ENDIF', line=5, column=5) |
| 1340 | Token(typ='END', value=';', line=5, column=10) |