1
# Copyright (C) 2006 Canonical Ltd
1
# Copyright (C) 2006, 2008-2011, 2017 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
19
19
This module defines a class which creates proxy objects for regex
20
20
compilation. This allows overriding re.compile() to return lazily compiled
23
23
We do this rather than just providing a new interface so that it will also
24
24
be used by existing Python modules that create regexs.
27
from __future__ import absolute_import
31
from bzrlib import errors
32
class InvalidPattern(errors.BzrError):
34
_fmt = ('Invalid pattern(s) found. %(msg)s')
36
def __init__(self, msg):
34
40
class LazyRegex(object):
35
41
"""A proxy around a real regex, which won't be compiled until accessed."""
38
43
# These are the parameters on a real _sre.SRE_Pattern object, which we
39
44
# will map to local members so that we don't have the proxy overhead.
40
45
_regex_attributes_to_copy = [
41
'__copy__', '__deepcopy__', 'findall', 'finditer', 'match',
42
'scanner', 'search', 'split', 'sub', 'subn'
46
'__copy__', '__deepcopy__', 'findall', 'finditer', 'match',
47
'scanner', 'search', 'split', 'sub', 'subn'
45
50
# We use slots to keep the overhead low. But we need a slot entry for
46
51
# all of the attributes we will copy
47
52
__slots__ = ['_real_regex', '_regex_args', '_regex_kwargs',
48
] + _regex_attributes_to_copy
53
] + _regex_attributes_to_copy
50
def __init__(self, args=(), kwargs={}):
55
def __init__(self, args, kwargs):
51
56
"""Create a new proxy object, passing in the args to pass to re.compile
53
58
:param args: The `*args` to pass to re.compile
67
72
def _real_re_compile(self, *args, **kwargs):
68
73
"""Thunk over to the original re.compile"""
70
return _real_re_compile(*args, **kwargs)
75
return re.compile(*args, **kwargs)
72
77
# raise InvalidPattern instead of re.error as this gives a
73
78
# cleaner message to the user.
74
raise errors.InvalidPattern('"' + args[0] + '" ' +str(e))
79
raise InvalidPattern('"' + args[0] + '" ' + str(e))
76
81
def __getstate__(self):
77
82
"""Return the state to use when pickling."""
104
109
:return: a LazyRegex proxy object.
106
111
return LazyRegex(args, kwargs)
109
def install_lazy_compile():
110
"""Make lazy_compile the default compile mode for regex compilation.
112
This overrides re.compile with lazy_compile. To restore the original
113
functionality, call reset_compile().
115
re.compile = lazy_compile
119
"""Restore the original function to re.compile().
121
It is safe to call reset_compile() multiple times, it will always
122
restore re.compile() to the value that existed at import time.
123
Though the first call will reset back to the original (it doesn't
126
re.compile = _real_re_compile
129
_real_re_compile = re.compile
130
if _real_re_compile is lazy_compile:
131
raise AssertionError(
132
"re.compile has already been overridden as lazy_compile, but this would" \
133
" cause infinite recursion")