Title: Preparation for advanced set syntax in regular expressions
Type: enhancement Stage: resolved
Components: Library (Lib), Regular Expressions Versions: Python 3.7
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: serhiy.storchaka Nosy List: Tim.Graham, ezio.melotti, mrabarnett, r.david.murray, rhettinger, serhiy.storchaka
Priority: normal Keywords:

Created on 2017-05-12 08:14 by serhiy.storchaka, last changed 2018-02-05 20:08 by Tim.Graham. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 1553 merged serhiy.storchaka, 2017-05-12 08:20
Messages (6)
msg293532 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2017-05-12 08:14
Currently the re module supports only simple sets. They can include literal characters, character ranges, some simple character classes and support the negation. The Unicode standard [1] defines set operations (union, intersection, difference and symmetric difference) and nested sets. Some regular expression engines implemented these features, for example the regex module supports all TR18 features except not-nested POSIX character classes.

If replace the re module with the regex module or add support of these features in the re module and make this syntax enabled by default, this will break some code. It is very unlikely the the regular expression contains duplicated characters ('--', '||', '&&' or '~~'), but nested sets uses just '[', and non-escaped '[' is occurred in character sets in regular expressions (even the stdlib contains several occurrences).

Proposed patch adds FutureWarnings emitted when possible breaking set construct ('--', '||', '&&', '~~' or '[') is occurred in a regular expression. We need one or two releases with a warning before changing syntax. The patch also makes re.escape() escaping '&' and '~' and fixes several regular expression in the stdlib.

Alternatively the support of new set syntax could be enabled by special flag.

I'm not sure that the support of set operations and nested sets is necessary. This complicates the syntax of regular expressions (which already is not simple). Currently set operations can be emulated with lookarounds:

[set1||set2] -- (?:[set1]|[set2])
[set1&&set2] -- [set1](?<=[set2]) or (?=[set1])[set2]
[set1--set2] -- [set1](?<![set2]) or [set1](?<=[^set2]) or (?=[set1])[^set2]
[set1~~set2] -- recursively expand [[set1||set2]--[set1&&set2]]

msg303757 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2017-10-05 10:26
Made a warning for '[' be emitted only at the start of a set. This significantly decrease the breakage of other code. I think we can get around without implicit union of nested sets, like in [_[0-9][:Latin:]]. This can be written as [_||[0-9]||[:Latin:]].
msg306349 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2017-11-16 10:38
New changeset 05cb728d68a278d11466f9a6c8258d914135c96c by Serhiy Storchaka in branch 'master':
bpo-30349: Raise FutureWarning for nested sets and set operations (#1553)
msg311682 - (view) Author: Tim Graham (Tim.Graham) * Date: 2018-02-05 19:23
It might be worth adding part of the problematic regex to the warning message. For Django's tests, I see an error like "FutureWarning: Possible nested set at position 17 return re.compile(res).match". It took some effort to track down the source.

A partial traceback is:
  File "/home/tim/code/django/django/core/management/commands/", line 247, in find_fixtures
    for candidate in glob.iglob(glob.escape(path) + '*'):
  File "/home/tim/code/cpython/Lib/", line 72, in _iglob
    for name in glob_in_dir(dirname, basename, dironly):
  File "/home/tim/code/cpython/Lib/", line 83, in _glob1
    return fnmatch.filter(names, pattern)
  File "/home/tim/code/cpython/Lib/", line 52, in filter
    match = _compile_pattern(pat)
  File "/home/tim/code/cpython/Lib/", line 46, in _compile_pattern
    return re.compile(res).match
  File "/home/tim/code/cpython/Lib/", line 240, in compile
    return _compile(pattern, flags)
  File "/home/tim/code/cpython/Lib/", line 292, in _compile
    p = sre_compile.compile(pattern, flags)
  File "/home/tim/code/cpython/Lib/", line 764, in compile
    p = sre_parse.parse(p, flags)
  File "/home/tim/code/cpython/Lib/", line 930, in parse
    p = _parse_sub(source, pattern, flags & SRE_FLAG_VERBOSE, 0)
  File "/home/tim/code/cpython/Lib/", line 426, in _parse_sub
    not nested and not items))
  File "/home/tim/code/cpython/Lib/", line 816, in _parse
    p = _parse_sub(source, state, sub_verbose, nested + 1)
  File "/home/tim/code/cpython/Lib/", line 426, in _parse_sub
    not nested and not items))
  File "/home/tim/code/cpython/Lib/", line 524, in _parse
    FutureWarning, stacklevel=nested + 6
FutureWarning: Possible nested set at position 17

As an aside, I'm not sure how to fix the warning in Django. It comes from the test added in where a path like 'tests/fixtures/fixtures/fixture_with[special]chars' is run through glob.escape() which creates 'tests/fixtures/fixtures/fixture_with[[]special]chars'.
msg311684 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2018-02-05 19:43
Good catch! fnmatch.translate() can produce a pattern which emits a warning when compiled. Could you please open a separate issue for this?
msg311688 - (view) Author: Tim Graham (Tim.Graham) * Date: 2018-02-05 20:08
Okay, I created #32775.
Date User Action Args
2018-02-05 20:08:17Tim.Grahamsetmessages: + msg311688
2018-02-05 19:43:06serhiy.storchakasetmessages: + msg311684
2018-02-05 19:23:15Tim.Grahamsetnosy: + Tim.Graham
messages: + msg311682
2017-11-16 10:39:01serhiy.storchakasetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2017-11-16 10:38:33serhiy.storchakasetmessages: + msg306349
2017-10-05 10:26:52serhiy.storchakasetmessages: + msg303757
2017-05-12 08:20:39serhiy.storchakasetpull_requests: + pull_request1650
2017-05-12 08:14:13serhiy.storchakacreate