/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/lazy_regex.py

  • Committer: Jelmer Vernooij
  • Date: 2018-02-18 21:42:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6859.
  • Revision ID: jelmer@jelmer.uk-20180218214257-jpevutp1wa30tz3v
Update TODO to reference Breezy, not Bazaar.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/lazy_regex.py
18
18
 
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
21
 
objects.
 
21
objects.  
22
22
 
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.
25
25
"""
26
26
 
 
27
from __future__ import absolute_import
 
28
 
27
29
import re
28
30
 
29
31
from . import errors
40
42
class LazyRegex(object):
41
43
    """A proxy around a real regex, which won't be compiled until accessed."""
42
44
 
 
45
 
43
46
    # These are the parameters on a real _sre.SRE_Pattern object, which we
44
47
    # will map to local members so that we don't have the proxy overhead.
45
48
    _regex_attributes_to_copy = [
46
 
        '__copy__', '__deepcopy__', 'findall', 'finditer', 'match',
47
 
        'scanner', 'search', 'split', 'sub', 'subn'
48
 
        ]
 
49
                 '__copy__', '__deepcopy__', 'findall', 'finditer', 'match',
 
50
                 'scanner', 'search', 'split', 'sub', 'subn'
 
51
                 ]
49
52
 
50
53
    # We use slots to keep the overhead low. But we need a slot entry for
51
54
    # all of the attributes we will copy
52
55
    __slots__ = ['_real_regex', '_regex_args', '_regex_kwargs',
53
 
                 ] + _regex_attributes_to_copy
 
56
                ] + _regex_attributes_to_copy
54
57
 
55
 
    def __init__(self, args, kwargs):
 
58
    def __init__(self, args=(), kwargs={}):
56
59
        """Create a new proxy object, passing in the args to pass to re.compile
57
60
 
58
61
        :param args: The `*args` to pass to re.compile
72
75
    def _real_re_compile(self, *args, **kwargs):
73
76
        """Thunk over to the original re.compile"""
74
77
        try:
75
 
            return re.compile(*args, **kwargs)
 
78
            return _real_re_compile(*args, **kwargs)
76
79
        except re.error as e:
77
80
            # raise InvalidPattern instead of re.error as this gives a
78
81
            # cleaner message to the user.
79
 
            raise InvalidPattern('"' + args[0] + '" ' + str(e))
 
82
            raise InvalidPattern('"' + args[0] + '" ' +str(e))
80
83
 
81
84
    def __getstate__(self):
82
85
        """Return the state to use when pickling."""
109
112
    :return: a LazyRegex proxy object.
110
113
    """
111
114
    return LazyRegex(args, kwargs)
 
115
 
 
116
 
 
117
def install_lazy_compile():
 
118
    """Make lazy_compile the default compile mode for regex compilation.
 
119
 
 
120
    This overrides re.compile with lazy_compile. To restore the original
 
121
    functionality, call reset_compile().
 
122
    """
 
123
    re.compile = lazy_compile
 
124
 
 
125
 
 
126
def reset_compile():
 
127
    """Restore the original function to re.compile().
 
128
 
 
129
    It is safe to call reset_compile() multiple times, it will always
 
130
    restore re.compile() to the value that existed at import time.
 
131
    Though the first call will reset back to the original (it doesn't
 
132
    track nesting level)
 
133
    """
 
134
    re.compile = _real_re_compile
 
135
 
 
136
 
 
137
_real_re_compile = re.compile
 
138
if _real_re_compile is lazy_compile:
 
139
    raise AssertionError(
 
140
        "re.compile has already been overridden as lazy_compile, but this would" \
 
141
        " cause infinite recursion")
 
142
 
 
143
 
 
144
# Some libraries calls re.finditer which fails it if receives a LazyRegex.
 
145
if getattr(re, 'finditer', False):
 
146
    def finditer_public(pattern, string, flags=0):
 
147
        if isinstance(pattern, LazyRegex):
 
148
            return pattern.finditer(string)
 
149
        else:
 
150
            return _real_re_compile(pattern, flags).finditer(string)
 
151
    re.finditer = finditer_public