/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-05-07 15:27:39 UTC
  • mto: This revision was merged to the branch mainline in revision 6958.
  • Revision ID: jelmer@jelmer.uk-20180507152739-fuv9z9r0yzi7ln3t
Specify source in .coveragerc.

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
 
 
46
    # These are the parameters on a real _sre.SRE_Pattern object, which we
 
47
    # will map to local members so that we don't have the proxy overhead.
 
48
    _regex_attributes_to_copy = [
 
49
                 '__copy__', '__deepcopy__', 'findall', 'finditer', 'match',
 
50
                 'scanner', 'search', 'split', 'sub', 'subn'
 
51
                 ]
 
52
 
 
53
    # We use slots to keep the overhead low. But we need a slot entry for
 
54
    # all of the attributes we will copy
 
55
    __slots__ = ['_real_regex', '_regex_args', '_regex_kwargs',
 
56
                ] + _regex_attributes_to_copy
 
57
 
 
58
    def __init__(self, args=(), kwargs={}):
 
59
        """Create a new proxy object, passing in the args to pass to re.compile
 
60
 
 
61
        :param args: The `*args` to pass to re.compile
 
62
        :param kwargs: The `**kwargs` to pass to re.compile
 
63
        """
 
64
        self._real_regex = None
 
65
        self._regex_args = args
 
66
        self._regex_kwargs = kwargs
 
67
 
 
68
    def _compile_and_collapse(self):
 
69
        """Actually compile the requested regex"""
 
70
        self._real_regex = self._real_re_compile(*self._regex_args,
 
71
                                                 **self._regex_kwargs)
 
72
        for attr in self._regex_attributes_to_copy:
 
73
            setattr(self, attr, getattr(self._real_regex, attr))
 
74
 
 
75
    def _real_re_compile(self, *args, **kwargs):
 
76
        """Thunk over to the original re.compile"""
 
77
        try:
 
78
            return _real_re_compile(*args, **kwargs)
 
79
        except re.error as e:
 
80
            # raise InvalidPattern instead of re.error as this gives a
 
81
            # cleaner message to the user.
 
82
            raise InvalidPattern('"' + args[0] + '" ' +str(e))
 
83
 
 
84
    def __getstate__(self):
 
85
        """Return the state to use when pickling."""
 
86
        return {
 
87
            "args": self._regex_args,
 
88
            "kwargs": self._regex_kwargs,
 
89
            }
 
90
 
 
91
    def __setstate__(self, dict):
 
92
        """Restore from a pickled state."""
 
93
        self._real_regex = None
 
94
        setattr(self, "_regex_args", dict["args"])
 
95
        setattr(self, "_regex_kwargs", dict["kwargs"])
 
96
 
 
97
    def __getattr__(self, attr):
 
98
        """Return a member from the proxied regex object.
 
99
 
 
100
        If the regex hasn't been compiled yet, compile it
 
101
        """
 
102
        if self._real_regex is None:
 
103
            self._compile_and_collapse()
 
104
        # Once we have compiled, the only time we should come here
 
105
        # is actually if the attribute is missing.
 
106
        return getattr(self._real_regex, attr)
 
107
 
 
108
 
 
109
def lazy_compile(*args, **kwargs):
 
110
    """Create a proxy object which will compile the regex on demand.
 
111
 
 
112
    :return: a LazyRegex proxy object.
 
113
    """
 
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