blob: b9106061c85a67c8eb543aa808bbbef55bb4fa55 [file] [log] [blame]
Guido van Rossum7627c0d2000-03-31 14:58:541#
2# Secret Labs' Regular Expression Engine
Guido van Rossum7627c0d2000-03-31 14:58:543#
4# re-compatible interface for the sre matching engine
5#
Fredrik Lundh770617b2001-01-14 15:06:116# Copyright (c) 1998-2001 by Secret Labs AB. All rights reserved.
Guido van Rossum7627c0d2000-03-31 14:58:547#
Fredrik Lundh29c4ba92000-08-01 18:20:078# This version of the SRE library can be redistributed under CNRI's
9# Python 1.6 license. For any other use, please contact Secret Labs
10# AB (info@pythonware.com).
11#
Guido van Rossum7627c0d2000-03-31 14:58:5412# Portions of this engine have been developed in cooperation with
Fredrik Lundh29c4ba92000-08-01 18:20:0713# CNRI. Hewlett-Packard provided funding for 1.6 integration and
Guido van Rossum7627c0d2000-03-31 14:58:5414# other compatibility work.
15#
16
Fred Drake9f5b8222001-09-04 19:20:0617r"""Support for regular expressions (RE).
Fred Drakeb8f22742001-09-04 19:10:2018
19This module provides regular expression matching operations similar to
Fredrik Lundhdac58492001-10-21 21:48:3020those found in Perl. It supports both 8-bit and Unicode strings; both
21the pattern and the strings being processed can contain null bytes and
22characters outside the US ASCII range.
Fred Drakeb8f22742001-09-04 19:10:2023
Fredrik Lundhdac58492001-10-21 21:48:3024Regular expressions can contain both special and ordinary characters.
25Most ordinary characters, like "A", "a", or "0", are the simplest
26regular expressions; they simply match themselves. You can
Fred Drakeb8f22742001-09-04 19:10:2027concatenate ordinary characters, so last matches the string 'last'.
28
29The special characters are:
30 "." Matches any character except a newline.
31 "^" Matches the start of the string.
Georg Brandl86def6c2008-01-21 20:36:1032 "$" Matches the end of the string or just before the newline at
33 the end of the string.
Fred Drakeb8f22742001-09-04 19:10:2034 "*" Matches 0 or more (greedy) repetitions of the preceding RE.
35 Greedy means that it will match as many repetitions as possible.
36 "+" Matches 1 or more (greedy) repetitions of the preceding RE.
37 "?" Matches 0 or 1 (greedy) of the preceding RE.
38 *?,+?,?? Non-greedy versions of the previous three special characters.
39 {m,n} Matches from m to n repetitions of the preceding RE.
40 {m,n}? Non-greedy version of the above.
Christian Heimesaf98da12008-01-27 15:18:1841 "\\" Either escapes special characters or signals a special sequence.
Fred Drakeb8f22742001-09-04 19:10:2042 [] Indicates a set of characters.
43 A "^" as the first character indicates a complementing set.
44 "|" A|B, creates an RE that will match either A or B.
45 (...) Matches the RE inside the parentheses.
46 The contents can be retrieved or matched later in the string.
Antoine Pitroufd036452008-08-19 17:56:3347 (?aiLmsux) Set the A, I, L, M, S, U, or X flag for the RE (see below).
Fred Drakeb8f22742001-09-04 19:10:2048 (?:...) Non-grouping version of regular parentheses.
49 (?P<name>...) The substring matched by the group is accessible by name.
50 (?P=name) Matches the text matched earlier by the group named name.
51 (?#...) A comment; ignored.
52 (?=...) Matches if ... matches next, but doesn't consume the string.
53 (?!...) Matches if ... doesn't match next.
Christian Heimesaf98da12008-01-27 15:18:1854 (?<=...) Matches if preceded by ... (must be fixed length).
55 (?<!...) Matches if not preceded by ... (must be fixed length).
56 (?(id/name)yes|no) Matches yes pattern if the group with id/name matched,
57 the (optional) no pattern otherwise.
Fred Drakeb8f22742001-09-04 19:10:2058
59The special sequences consist of "\\" and a character from the list
Fredrik Lundhdac58492001-10-21 21:48:3060below. If the ordinary character is not on the list, then the
Fred Drakeb8f22742001-09-04 19:10:2061resulting RE will match the second character.
Fred Drake9f5b8222001-09-04 19:20:0662 \number Matches the contents of the group of the same number.
63 \A Matches only at the start of the string.
64 \Z Matches only at the end of the string.
65 \b Matches the empty string, but only at the start or end of a word.
66 \B Matches the empty string, but not at the start or end of a word.
Antoine Pitroufd036452008-08-19 17:56:3367 \d Matches any decimal digit; equivalent to the set [0-9] in
68 bytes patterns or string patterns with the ASCII flag.
69 In string patterns without the ASCII flag, it will match the whole
70 range of Unicode digits.
71 \D Matches any non-digit character; equivalent to [^\d].
Ezio Melottie9900922012-04-29 05:23:2572 \s Matches any whitespace character; equivalent to [ \t\n\r\f\v] in
73 bytes patterns or string patterns with the ASCII flag.
74 In string patterns without the ASCII flag, it will match the whole
75 range of Unicode whitespace characters.
Ezio Melotti38992832012-04-29 10:35:5576 \S Matches any non-whitespace character; equivalent to [^\s].
Antoine Pitroufd036452008-08-19 17:56:3377 \w Matches any alphanumeric character; equivalent to [a-zA-Z0-9_]
78 in bytes patterns or string patterns with the ASCII flag.
79 In string patterns without the ASCII flag, it will match the
80 range of Unicode alphanumeric characters (letters plus digits
81 plus underscore).
Fred Drakeb8f22742001-09-04 19:10:2082 With LOCALE, it will match the set [0-9_] plus characters defined
83 as letters for the current locale.
Fred Drake9f5b8222001-09-04 19:20:0684 \W Matches the complement of \w.
85 \\ Matches a literal backslash.
Fred Drakeb8f22742001-09-04 19:10:2086
87This module exports the following functions:
88 match Match a regular expression pattern to the beginning of a string.
89 search Search a string for the presence of a pattern.
90 sub Substitute occurrences of a pattern found in a string.
91 subn Same as sub, but also return the number of substitutions made.
92 split Split a string by the occurrences of a pattern.
93 findall Find all occurrences of a pattern in a string.
Christian Heimesaf98da12008-01-27 15:18:1894 finditer Return an iterator yielding a match object for each match.
Fred Drakeb8f22742001-09-04 19:10:2095 compile Compile a pattern into a RegexObject.
96 purge Clear the regular expression cache.
Fred Drakeb8f22742001-09-04 19:10:2097 escape Backslash all non-alphanumerics in a string.
98
99Some of the functions in this module takes flags as optional parameters:
Antoine Pitroufd036452008-08-19 17:56:33100 A ASCII For string patterns, make \w, \W, \b, \B, \d, \D
101 match the corresponding ASCII character categories
102 (rather than the whole Unicode categories, which is the
103 default).
104 For bytes patterns, this flag is the only available
105 behaviour and needn't be specified.
Fred Drakeb8f22742001-09-04 19:10:20106 I IGNORECASE Perform case-insensitive matching.
107 L LOCALE Make \w, \W, \b, \B, dependent on the current locale.
Georg Brandl86def6c2008-01-21 20:36:10108 M MULTILINE "^" matches the beginning of lines (after a newline)
109 as well as the string.
110 "$" matches the end of lines (before a newline) as well
111 as the end of the string.
Fred Drakeb8f22742001-09-04 19:10:20112 S DOTALL "." matches any character at all, including the newline.
113 X VERBOSE Ignore whitespace and comments for nicer looking RE's.
Antoine Pitroufd036452008-08-19 17:56:33114 U UNICODE For compatibility only. Ignored for string patterns (it
115 is the default), and forbidden for bytes patterns.
Fred Drakeb8f22742001-09-04 19:10:20116
117This module also defines an exception 'error'.
118
119"""
Fredrik Lundh21009b92001-09-18 18:47:09120
Fredrik Lundh703ce812001-10-24 22:16:30121import sys
Guido van Rossum7627c0d2000-03-31 14:58:54122import sre_compile
Fredrik Lundh436c3d582000-06-29 08:58:44123import sre_parse
Antoine Pitrou3060c452010-08-13 16:27:38124import functools
Guido van Rossum7627c0d2000-03-31 14:58:54125
Fredrik Lundhf2989b22001-02-18 12:05:16126# public symbols
127__all__ = [ "match", "search", "sub", "subn", "split", "findall",
Antoine Pitroufd036452008-08-19 17:56:33128 "compile", "purge", "template", "escape", "A", "I", "L", "M", "S", "X",
129 "U", "ASCII", "IGNORECASE", "LOCALE", "MULTILINE", "DOTALL", "VERBOSE",
Fredrik Lundhf2989b22001-02-18 12:05:16130 "UNICODE", "error" ]
131
Fredrik Lundhbec95b92001-10-21 16:47:57132__version__ = "2.2.1"
Fredrik Lundhb25e1ad2001-03-22 15:50:10133
Jeremy Hyltonb1aa1952000-06-01 17:39:12134# flags
Antoine Pitroufd036452008-08-19 17:56:33135A = ASCII = sre_compile.SRE_FLAG_ASCII # assume ascii "locale"
Fredrik Lundh770617b2001-01-14 15:06:11136I = IGNORECASE = sre_compile.SRE_FLAG_IGNORECASE # ignore case
137L = LOCALE = sre_compile.SRE_FLAG_LOCALE # assume current 8-bit locale
Antoine Pitroufd036452008-08-19 17:56:33138U = UNICODE = sre_compile.SRE_FLAG_UNICODE # assume unicode "locale"
Fredrik Lundh770617b2001-01-14 15:06:11139M = MULTILINE = sre_compile.SRE_FLAG_MULTILINE # make anchors look for newline
140S = DOTALL = sre_compile.SRE_FLAG_DOTALL # make dot match newline
141X = VERBOSE = sre_compile.SRE_FLAG_VERBOSE # ignore whitespace and comments
Jeremy Hyltonb1aa1952000-06-01 17:39:12142
Fredrik Lundh770617b2001-01-14 15:06:11143# sre extensions (experimental, don't rely on these)
144T = TEMPLATE = sre_compile.SRE_FLAG_TEMPLATE # disable backtracking
145DEBUG = sre_compile.SRE_FLAG_DEBUG # dump pattern after compilation
Fredrik Lundh436c3d582000-06-29 08:58:44146
147# sre exception
Fredrik Lundhbe2211e2000-06-29 16:57:40148error = sre_compile.error
Fredrik Lundh436c3d582000-06-29 08:58:44149
Guido van Rossum7627c0d2000-03-31 14:58:54150# --------------------------------------------------------------------
151# public interface
152
Guido van Rossum7627c0d2000-03-31 14:58:54153def match(pattern, string, flags=0):
Fredrik Lundh770617b2001-01-14 15:06:11154 """Try to apply the pattern at the start of the string, returning
155 a match object, or None if no match was found."""
Jeremy Hyltonb1aa1952000-06-01 17:39:12156 return _compile(pattern, flags).match(string)
Guido van Rossum7627c0d2000-03-31 14:58:54157
158def search(pattern, string, flags=0):
Fredrik Lundh770617b2001-01-14 15:06:11159 """Scan through string looking for a match to the pattern, returning
160 a match object, or None if no match was found."""
Jeremy Hyltonb1aa1952000-06-01 17:39:12161 return _compile(pattern, flags).search(string)
Guido van Rossum7627c0d2000-03-31 14:58:54162
Gregory P. Smithccc5ae72009-03-02 05:21:55163def sub(pattern, repl, string, count=0, flags=0):
Fredrik Lundh770617b2001-01-14 15:06:11164 """Return the string obtained by replacing the leftmost
165 non-overlapping occurrences of the pattern in string by the
Andrew M. Kuchling43ab0cd2004-08-07 17:41:54166 replacement repl. repl can be either a string or a callable;
Benjamin Peterson75edad02009-01-01 15:05:06167 if a string, backslash escapes in it are processed. If it is
168 a callable, it's passed the match object and must return
Andrew M. Kuchling43ab0cd2004-08-07 17:41:54169 a replacement string to be used."""
Gregory P. Smithccc5ae72009-03-02 05:21:55170 return _compile(pattern, flags).sub(repl, string, count)
Jeremy Hyltonb1aa1952000-06-01 17:39:12171
Gregory P. Smithccc5ae72009-03-02 05:21:55172def subn(pattern, repl, string, count=0, flags=0):
Fredrik Lundh770617b2001-01-14 15:06:11173 """Return a 2-tuple containing (new_string, number).
174 new_string is the string obtained by replacing the leftmost
175 non-overlapping occurrences of the pattern in the source
176 string by the replacement repl. number is the number of
Andrew M. Kuchling43ab0cd2004-08-07 17:41:54177 substitutions that were made. repl can be either a string or a
Benjamin Peterson75edad02009-01-01 15:05:06178 callable; if a string, backslash escapes in it are processed.
179 If it is a callable, it's passed the match object and must
Andrew M. Kuchling43ab0cd2004-08-07 17:41:54180 return a replacement string to be used."""
Gregory P. Smithccc5ae72009-03-02 05:21:55181 return _compile(pattern, flags).subn(repl, string, count)
Jeremy Hyltonb1aa1952000-06-01 17:39:12182
Gregory P. Smithccc5ae72009-03-02 05:21:55183def split(pattern, string, maxsplit=0, flags=0):
Fredrik Lundh770617b2001-01-14 15:06:11184 """Split the source string by the occurrences of the pattern,
Georg Brandle144c742012-03-10 08:26:53185 returning a list containing the resulting substrings. If
186 capturing parentheses are used in pattern, then the text of all
187 groups in the pattern are also returned as part of the resulting
188 list. If maxsplit is nonzero, at most maxsplit splits occur,
189 and the remainder of the string is returned as the final element
190 of the list."""
Gregory P. Smithccc5ae72009-03-02 05:21:55191 return _compile(pattern, flags).split(string, maxsplit)
Jeremy Hyltonb1aa1952000-06-01 17:39:12192
Raymond Hettinger596ba4d2004-09-24 03:41:05193def findall(pattern, string, flags=0):
Fredrik Lundh770617b2001-01-14 15:06:11194 """Return a list of all non-overlapping matches in the string.
195
Georg Brandle144c742012-03-10 08:26:53196 If one or more capturing groups are present in the pattern, return
197 a list of groups; this will be a list of tuples if the pattern
Fredrik Lundh770617b2001-01-14 15:06:11198 has more than one group.
199
200 Empty matches are included in the result."""
Raymond Hettinger596ba4d2004-09-24 03:41:05201 return _compile(pattern, flags).findall(string)
Jeremy Hyltonb1aa1952000-06-01 17:39:12202
Fredrik Lundh703ce812001-10-24 22:16:30203if sys.hexversion >= 0x02020000:
Guido van Rossum0d976552002-10-14 12:22:17204 __all__.append("finditer")
Raymond Hettinger596ba4d2004-09-24 03:41:05205 def finditer(pattern, string, flags=0):
Fredrik Lundhb7747e22001-10-28 20:15:40206 """Return an iterator over all non-overlapping matches in the
207 string. For each match, the iterator returns a match object.
Fredrik Lundh703ce812001-10-24 22:16:30208
209 Empty matches are included in the result."""
Raymond Hettinger596ba4d2004-09-24 03:41:05210 return _compile(pattern, flags).finditer(string)
Fredrik Lundh703ce812001-10-24 22:16:30211
Jeremy Hyltonb1aa1952000-06-01 17:39:12212def compile(pattern, flags=0):
Fredrik Lundh770617b2001-01-14 15:06:11213 "Compile a regular expression pattern, returning a pattern object."
Jeremy Hyltonb1aa1952000-06-01 17:39:12214 return _compile(pattern, flags)
215
Fredrik Lundh8a3ebf82000-07-23 21:46:17216def purge():
Antoine Pitrou3060c452010-08-13 16:27:38217 "Clear the regular expression caches"
Serhiy Storchaka0f606a62013-03-16 20:52:09218 _cache.clear()
219 _cache_repl.clear()
Fredrik Lundh8a3ebf82000-07-23 21:46:17220
Fredrik Lundh436c3d582000-06-29 08:58:44221def template(pattern, flags=0):
Fredrik Lundh770617b2001-01-14 15:06:11222 "Compile a template pattern, returning a pattern object"
Fredrik Lundh436c3d582000-06-29 08:58:44223 return _compile(pattern, flags|T)
224
Guido van Rossum698280d2008-09-10 17:44:35225_alphanum_str = frozenset(
226 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890")
227_alphanum_bytes = frozenset(
228 b"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890")
Raymond Hettingerebb7f302005-09-12 22:50:37229
Jeremy Hyltonb1aa1952000-06-01 17:39:12230def escape(pattern):
Fredrik Lundh770617b2001-01-14 15:06:11231 "Escape all non-alphanumeric characters in pattern."
Guido van Rossum698280d2008-09-10 17:44:35232 if isinstance(pattern, str):
233 alphanum = _alphanum_str
234 s = list(pattern)
Ezio Melottiebbf1e62011-03-25 12:19:30235 for i, c in enumerate(pattern):
Guido van Rossum698280d2008-09-10 17:44:35236 if c not in alphanum:
237 if c == "\000":
238 s[i] = "\\000"
239 else:
240 s[i] = "\\" + c
241 return "".join(s)
242 else:
243 alphanum = _alphanum_bytes
244 s = []
245 esc = ord(b"\\")
246 for c in pattern:
247 if c in alphanum:
248 s.append(c)
Jeremy Hyltonb1aa1952000-06-01 17:39:12249 else:
Guido van Rossum698280d2008-09-10 17:44:35250 if c == 0:
251 s.extend(b"\\000")
252 else:
253 s.append(esc)
254 s.append(c)
255 return bytes(s)
Guido van Rossum7627c0d2000-03-31 14:58:54256
257# --------------------------------------------------------------------
Jeremy Hyltonb1aa1952000-06-01 17:39:12258# internals
Guido van Rossum7627c0d2000-03-31 14:58:54259
Serhiy Storchaka0f606a62013-03-16 20:52:09260_cache = {}
261_cache_repl = {}
262
Fredrik Lundh397a6542001-10-18 19:30:16263_pattern_type = type(sre_compile.compile("", 0))
264
Serhiy Storchaka0f606a62013-03-16 20:52:09265_MAXCACHE = 512
Gregory P. Smith5a631832010-07-27 05:31:29266
Serhiy Storchaka0f606a62013-03-16 20:52:09267def _compile(pattern, flags):
Jeremy Hyltonb1aa1952000-06-01 17:39:12268 # internal: compile pattern
Serhiy Storchaka0f606a62013-03-16 20:52:09269 try:
270 return _cache[type(pattern), pattern, flags]
271 except KeyError:
272 pass
Just van Rossum12723ba2003-07-02 20:03:04273 if isinstance(pattern, _pattern_type):
Christian Heimes5fb7c2a2007-12-24 08:52:31274 if flags:
Guido van Rossum698280d2008-09-10 17:44:35275 raise ValueError(
276 "Cannot process flags argument with a compiled pattern")
Jeremy Hyltonb1aa1952000-06-01 17:39:12277 return pattern
Just van Rossum74902502003-07-02 21:37:16278 if not sre_compile.isstring(pattern):
Collin Winterce36ad82007-08-30 01:19:48279 raise TypeError("first argument must be string or compiled pattern")
Serhiy Storchaka0f606a62013-03-16 20:52:09280 p = sre_compile.compile(pattern, flags)
281 if len(_cache) >= _MAXCACHE:
282 _cache.clear()
283 _cache[type(pattern), pattern, flags] = p
284 return p
Jeremy Hyltonb1aa1952000-06-01 17:39:12285
Raymond Hettingerd9e8cc62010-08-14 21:17:48286def _compile_repl(repl, pattern):
Fredrik Lundhb25e1ad2001-03-22 15:50:10287 # internal: compile replacement pattern
Serhiy Storchaka0f606a62013-03-16 20:52:09288 try:
289 return _cache_repl[repl, pattern]
290 except KeyError:
291 pass
292 p = sre_parse.parse_template(repl, pattern)
293 if len(_cache_repl) >= _MAXCACHE:
294 _cache_repl.clear()
295 _cache_repl[repl, pattern] = p
296 return p
Fredrik Lundhb25e1ad2001-03-22 15:50:10297
Fredrik Lundh5644b7f2000-09-21 17:03:25298def _expand(pattern, match, template):
299 # internal: match.expand implementation hook
300 template = sre_parse.parse_template(template, pattern)
301 return sre_parse.expand_template(template, match)
302
Fredrik Lundhbec95b92001-10-21 16:47:57303def _subx(pattern, template):
304 # internal: pattern.sub/subn implementation helper
Fredrik Lundhdac58492001-10-21 21:48:30305 template = _compile_repl(template, pattern)
306 if not template[0] and len(template[1]) == 1:
Fredrik Lundhbec95b92001-10-21 16:47:57307 # literal replacement
Fredrik Lundhdac58492001-10-21 21:48:30308 return template[1][0]
309 def filter(match, template=template):
310 return sre_parse.expand_template(template, match)
311 return filter
Fredrik Lundh0640e112000-06-30 13:55:15312
313# register myself for pickling
314
Alexandre Vassalottif7fa63d2008-05-11 08:55:36315import copyreg
Fredrik Lundh0640e112000-06-30 13:55:15316
317def _pickle(p):
318 return _compile, (p.pattern, p.flags)
319
Alexandre Vassalottif7fa63d2008-05-11 08:55:36320copyreg.pickle(_pattern_type, _pickle, _compile)
Fredrik Lundh7cafe4d2000-07-02 17:33:27321
322# --------------------------------------------------------------------
323# experimental stuff (see python-dev discussions for details)
324
325class Scanner:
Fredrik Lundh1296a8d2001-10-21 18:04:11326 def __init__(self, lexicon, flags=0):
Fredrik Lundh29c4ba92000-08-01 18:20:07327 from sre_constants import BRANCH, SUBPATTERN
Fredrik Lundh7cafe4d2000-07-02 17:33:27328 self.lexicon = lexicon
Fredrik Lundh8a3ebf82000-07-23 21:46:17329 # combine phrases into a compound pattern
Fredrik Lundh7cafe4d2000-07-02 17:33:27330 p = []
Fredrik Lundh8a3ebf82000-07-23 21:46:17331 s = sre_parse.Pattern()
Fredrik Lundh1296a8d2001-10-21 18:04:11332 s.flags = flags
Fredrik Lundh7cafe4d2000-07-02 17:33:27333 for phrase, action in lexicon:
Fredrik Lundh8a3ebf82000-07-23 21:46:17334 p.append(sre_parse.SubPattern(s, [
Fredrik Lundh1296a8d2001-10-21 18:04:11335 (SUBPATTERN, (len(p)+1, sre_parse.parse(phrase, flags))),
Fredrik Lundh8a3ebf82000-07-23 21:46:17336 ]))
Christian Heimes2202f872008-02-06 14:31:34337 s.groups = len(p)+1
Fredrik Lundh8a3ebf82000-07-23 21:46:17338 p = sre_parse.SubPattern(s, [(BRANCH, (None, p))])
Fredrik Lundh8a3ebf82000-07-23 21:46:17339 self.scanner = sre_compile.compile(p)
Fredrik Lundh7cafe4d2000-07-02 17:33:27340 def scan(self, string):
341 result = []
342 append = result.append
Fredrik Lundh1296a8d2001-10-21 18:04:11343 match = self.scanner.scanner(string).match
Fredrik Lundh7cafe4d2000-07-02 17:33:27344 i = 0
345 while 1:
Fredrik Lundh1296a8d2001-10-21 18:04:11346 m = match()
Fredrik Lundh7cafe4d2000-07-02 17:33:27347 if not m:
348 break
349 j = m.end()
350 if i == j:
351 break
Fredrik Lundh1296a8d2001-10-21 18:04:11352 action = self.lexicon[m.lastindex-1][1]
Florent Xicluna5d1155c2011-10-28 12:45:05353 if callable(action):
Fredrik Lundh770617b2001-01-14 15:06:11354 self.match = m
Fredrik Lundh7cafe4d2000-07-02 17:33:27355 action = action(self, m.group())
356 if action is not None:
357 append(action)
358 i = j
359 return result, string[i:]