/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-11-16 18:15:40 UTC
  • mto: (7143.16.20 even-more-cleanups)
  • mto: This revision was merged to the branch mainline in revision 7175.
  • Revision ID: jelmer@jelmer.uk-20181116181540-7y2wbhqzjk067mqy
Fix repo acquisition.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/lazy_regex.py
 
1
# Copyright (C) 2006, 2008-2011, 2017 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Lazily compiled regex objects.
 
18
 
 
19
This module defines a class which creates proxy objects for regex
 
20
compilation.  This allows overriding re.compile() to return lazily compiled
 
21
objects.
 
22
 
 
23
We do this rather than just providing a new interface so that it will also
 
24
be used by existing Python modules that create regexs.
 
25
"""
 
26
 
 
27
from __future__ import absolute_import
 
28
 
 
29
import re
 
30
 
 
31
from . import errors
 
32
 
 
33
 
 
34
class InvalidPattern(errors.BzrError):
 
35
 
 
36
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
37
 
 
38
    def __init__(self, msg):
 
39
        self.msg = msg
 
40
 
 
41
 
 
42
class LazyRegex(object):
 
43
    """A proxy around a real regex, which won't be compiled until accessed."""
 
44
 
 
45
    # These are the parameters on a real _sre.SRE_Pattern object, which we
 
46
    # will map to local members so that we don't have the proxy overhead.
 
47
    _regex_attributes_to_copy = [
 
48
        '__copy__', '__deepcopy__', 'findall', 'finditer', 'match',
 
49
        'scanner', 'search', 'split', 'sub', 'subn'
 
50
        ]
 
51
 
 
52
    # We use slots to keep the overhead low. But we need a slot entry for
 
53
    # all of the attributes we will copy
 
54
    __slots__ = ['_real_regex', '_regex_args', '_regex_kwargs',
 
55
                 ] + _regex_attributes_to_copy
 
56
 
 
57
    def __init__(self, args=(), kwargs={}):
 
58
        """Create a new proxy object, passing in the args to pass to re.compile
 
59
 
 
60
        :param args: The `*args` to pass to re.compile
 
61
        :param kwargs: The `**kwargs` to pass to re.compile
 
62
        """
 
63
        self._real_regex = None
 
64
        self._regex_args = args
 
65
        self._regex_kwargs = kwargs
 
66
 
 
67
    def _compile_and_collapse(self):
 
68
        """Actually compile the requested regex"""
 
69
        self._real_regex = self._real_re_compile(*self._regex_args,
 
70
                                                 **self._regex_kwargs)
 
71
        for attr in self._regex_attributes_to_copy:
 
72
            setattr(self, attr, getattr(self._real_regex, attr))
 
73
 
 
74
    def _real_re_compile(self, *args, **kwargs):
 
75
        """Thunk over to the original re.compile"""
 
76
        try:
 
77
            return _real_re_compile(*args, **kwargs)
 
78
        except re.error as e:
 
79
            # raise InvalidPattern instead of re.error as this gives a
 
80
            # cleaner message to the user.
 
81
            raise InvalidPattern('"' + args[0] + '" ' + str(e))
 
82
 
 
83
    def __getstate__(self):
 
84
        """Return the state to use when pickling."""
 
85
        return {
 
86
            "args": self._regex_args,
 
87
            "kwargs": self._regex_kwargs,
 
88
            }
 
89
 
 
90
    def __setstate__(self, dict):
 
91
        """Restore from a pickled state."""
 
92
        self._real_regex = None
 
93
        setattr(self, "_regex_args", dict["args"])
 
94
        setattr(self, "_regex_kwargs", dict["kwargs"])
 
95
 
 
96
    def __getattr__(self, attr):
 
97
        """Return a member from the proxied regex object.
 
98
 
 
99
        If the regex hasn't been compiled yet, compile it
 
100
        """
 
101
        if self._real_regex is None:
 
102
            self._compile_and_collapse()
 
103
        # Once we have compiled, the only time we should come here
 
104
        # is actually if the attribute is missing.
 
105
        return getattr(self._real_regex, attr)
 
106
 
 
107
 
 
108
def lazy_compile(*args, **kwargs):
 
109
    """Create a proxy object which will compile the regex on demand.
 
110
 
 
111
    :return: a LazyRegex proxy object.
 
112
    """
 
113
    return LazyRegex(args, kwargs)
 
114
 
 
115
 
 
116
def install_lazy_compile():
 
117
    """Make lazy_compile the default compile mode for regex compilation.
 
118
 
 
119
    This overrides re.compile with lazy_compile. To restore the original
 
120
    functionality, call reset_compile().
 
121
    """
 
122
    re.compile = lazy_compile
 
123
 
 
124
 
 
125
def reset_compile():
 
126
    """Restore the original function to re.compile().
 
127
 
 
128
    It is safe to call reset_compile() multiple times, it will always
 
129
    restore re.compile() to the value that existed at import time.
 
130
    Though the first call will reset back to the original (it doesn't
 
131
    track nesting level)
 
132
    """
 
133
    re.compile = _real_re_compile
 
134
 
 
135
 
 
136
_real_re_compile = re.compile
 
137
if _real_re_compile is lazy_compile:
 
138
    raise AssertionError(
 
139
        "re.compile has already been overridden as lazy_compile, but this "
 
140
        "would cause infinite recursion")
 
141
 
 
142
 
 
143
# Some libraries calls re.finditer which fails it if receives a LazyRegex.
 
144
if getattr(re, 'finditer', False):
 
145
    def finditer_public(pattern, string, flags=0):
 
146
        if isinstance(pattern, LazyRegex):
 
147
            return pattern.finditer(string)
 
148
        else:
 
149
            return _real_re_compile(pattern, flags).finditer(string)
 
150
    re.finditer = finditer_public