← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lazy_regex.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-21 22:29:49 UTC
  • Revision ID: mbp@sourcefrog.net-20050321222949-232c2093a6eadd80
fixup doctest for new module structure

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lazy_regex.py
1
 
# Copyright (C) 2006 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 compilation.
20
 
This allows overriding re.compile() to return lazily compiled objects.
21
 
"""
22
 
 
23
 
import re
24
 
 
25
 
from bzrlib import errors
26
 
 
27
 
 
28
 
class LazyRegex(object):
29
 
    """A proxy around a real regex, which won't be compiled until accessed."""
30
 
 
31
 
 
32
 
    # These are the parameters on a real _sre.SRE_Pattern object, which we
33
 
    # will map to local members so that we don't have the proxy overhead.
34
 
    _regex_attributes_to_copy = [
35
 
                 '__copy__', '__deepcopy__', 'findall', 'finditer', 'match',
36
 
                 'scanner', 'search', 'split', 'sub', 'subn'
37
 
                 ]
38
 
 
39
 
    # We use slots to keep the overhead low. But we need a slot entry for
40
 
    # all of the attributes we will copy
41
 
    __slots__ = ['_real_regex', '_regex_args', '_regex_kwargs',
42
 
                ] + _regex_attributes_to_copy
43
 
 
44
 
    def __init__(self, args=(), kwargs={}):
45
 
        """Create a new proxy object, passing in the args to pass to re.compile
46
 
 
47
 
        :param args: The *args to pass to re.compile
48
 
        :param kwargs: The **kwargs to pass to re.compile
49
 
        """
50
 
        self._real_regex = None
51
 
        self._regex_args = args
52
 
        self._regex_kwargs = kwargs
53
 
 
54
 
    def _compile_and_collapse(self):
55
 
        """Actually compile the requested regex"""
56
 
        self._real_regex = self._real_re_compile(*self._regex_args,
57
 
                                                 **self._regex_kwargs)
58
 
        for attr in self._regex_attributes_to_copy:
59
 
            setattr(self, attr, getattr(self._real_regex, attr))
60
 
 
61
 
    def _real_re_compile(self, *args, **kwargs):
62
 
        """Thunk over to the original re.compile"""
63
 
        try:
64
 
            return _real_re_compile(*args, **kwargs)
65
 
        except re.error, e:
66
 
            # raise InvalidPattern instead of re.error as this gives a
67
 
            # cleaner message to the user.
68
 
            raise errors.InvalidPattern('"' + args[0] + '" ' +str(e))
69
 
 
70
 
    def __getattr__(self, attr):
71
 
        """Return a member from the proxied regex object.
72
 
 
73
 
        If the regex hasn't been compiled yet, compile it
74
 
        """
75
 
        if self._real_regex is None:
76
 
            self._compile_and_collapse()
77
 
        # Once we have compiled, the only time we should come here
78
 
        # is actually if the attribute is missing.
79
 
        return getattr(self._real_regex, attr)
80
 
 
81
 
 
82
 
def lazy_compile(*args, **kwargs):
83
 
    """Create a proxy object which will compile the regex on demand.
84
 
 
85
 
    :return: a LazyRegex proxy object.
86
 
    """
87
 
    return LazyRegex(args, kwargs)
88
 
 
89
 
 
90
 
def install_lazy_compile():
91
 
    """Make lazy_compile the default compile mode for regex compilation.
92
 
 
93
 
    This overrides re.compile with lazy_compile. To restore the original
94
 
    functionality, call reset_compile().
95
 
    """
96
 
    re.compile = lazy_compile
97
 
 
98
 
 
99
 
def reset_compile():
100
 
    """Restore the original function to re.compile().
101
 
 
102
 
    It is safe to call reset_compile() multiple times, it will always
103
 
    restore re.compile() to the value that existed at import time.
104
 
    Though the first call will reset back to the original (it doesn't
105
 
    track nesting level)
106
 
    """
107
 
    re.compile = _real_re_compile
108
 
 
109
 
 
110
 
_real_re_compile = re.compile
111
 
if _real_re_compile is lazy_compile:
112
 
    raise AssertionError(
113
 
        "re.compile has already been overridden as lazy_compile, but this would" \
114
 
        " cause infinite recursion")