← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lazy_regex.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/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 bzrlib import errors
 
32
 
 
33
 
 
34
class LazyRegex(object):
 
35
    """A proxy around a real regex, which won't be compiled until accessed."""
 
36
 
 
37
 
 
38
    # These are the parameters on a real _sre.SRE_Pattern object, which we
 
39
    # will map to local members so that we don't have the proxy overhead.
 
40
    _regex_attributes_to_copy = [
 
41
                 '__copy__', '__deepcopy__', 'findall', 'finditer', 'match',
 
42
                 'scanner', 'search', 'split', 'sub', 'subn'
 
43
                 ]
 
44
 
 
45
    # We use slots to keep the overhead low. But we need a slot entry for
 
46
    # all of the attributes we will copy
 
47
    __slots__ = ['_real_regex', '_regex_args', '_regex_kwargs',
 
48
                ] + _regex_attributes_to_copy
 
49
 
 
50
    def __init__(self, args=(), kwargs={}):
 
51
        """Create a new proxy object, passing in the args to pass to re.compile
 
52
 
 
53
        :param args: The `*args` to pass to re.compile
 
54
        :param kwargs: The `**kwargs` to pass to re.compile
 
55
        """
 
56
        self._real_regex = None
 
57
        self._regex_args = args
 
58
        self._regex_kwargs = kwargs
 
59
 
 
60
    def _compile_and_collapse(self):
 
61
        """Actually compile the requested regex"""
 
62
        self._real_regex = self._real_re_compile(*self._regex_args,
 
63
                                                 **self._regex_kwargs)
 
64
        for attr in self._regex_attributes_to_copy:
 
65
            setattr(self, attr, getattr(self._real_regex, attr))
 
66
 
 
67
    def _real_re_compile(self, *args, **kwargs):
 
68
        """Thunk over to the original re.compile"""
 
69
        try:
 
70
            return _real_re_compile(*args, **kwargs)
 
71
        except re.error, e:
 
72
            # raise InvalidPattern instead of re.error as this gives a
 
73
            # cleaner message to the user.
 
74
            raise errors.InvalidPattern('"' + args[0] + '" ' +str(e))
 
75
 
 
76
    def __getstate__(self):
 
77
        """Return the state to use when pickling."""
 
78
        return {
 
79
            "args": self._regex_args,
 
80
            "kwargs": self._regex_kwargs,
 
81
            }
 
82
 
 
83
    def __setstate__(self, dict):
 
84
        """Restore from a pickled state."""
 
85
        self._real_regex = None
 
86
        setattr(self, "_regex_args", dict["args"])
 
87
        setattr(self, "_regex_kwargs", dict["kwargs"])
 
88
 
 
89
    def __getattr__(self, attr):
 
90
        """Return a member from the proxied regex object.
 
91
 
 
92
        If the regex hasn't been compiled yet, compile it
 
93
        """
 
94
        if self._real_regex is None:
 
95
            self._compile_and_collapse()
 
96
        # Once we have compiled, the only time we should come here
 
97
        # is actually if the attribute is missing.
 
98
        return getattr(self._real_regex, attr)
 
99
 
 
100
 
 
101
def lazy_compile(*args, **kwargs):
 
102
    """Create a proxy object which will compile the regex on demand.
 
103
 
 
104
    :return: a LazyRegex proxy object.
 
105
    """
 
106
    return LazyRegex(args, kwargs)
 
107
 
 
108
 
 
109
def install_lazy_compile():
 
110
    """Make lazy_compile the default compile mode for regex compilation.
 
111
 
 
112
    This overrides re.compile with lazy_compile. To restore the original
 
113
    functionality, call reset_compile().
 
114
    """
 
115
    re.compile = lazy_compile
 
116
 
 
117
 
 
118
def reset_compile():
 
119
    """Restore the original function to re.compile().
 
120
 
 
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
 
124
    track nesting level)
 
125
    """
 
126
    re.compile = _real_re_compile
 
127
 
 
128
 
 
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")
 
134
 
 
135
 
 
136
# Some libraries calls re.finditer which fails it if receives a LazyRegex.
 
137
if getattr(re, 'finditer', False):
 
138
    def finditer_public(pattern, string, flags=0):
 
139
        if isinstance(pattern, LazyRegex):
 
140
            return pattern.finditer(string)
 
141
        else:
 
142
            return _real_re_compile(pattern, flags).finditer(string)
 
143
    re.finditer = finditer_public