← 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 Canonical Ltd
 
1
# Copyright (C) 2006, 2008-2011, 2017 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Lazily compiled regex objects.
18
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.
 
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.
21
25
"""
22
26
 
 
27
from __future__ import absolute_import
 
28
 
23
29
import re
24
30
 
 
31
from bzrlib import errors
 
32
 
25
33
 
26
34
class LazyRegex(object):
27
35
    """A proxy around a real regex, which won't be compiled until accessed."""
42
50
    def __init__(self, args=(), kwargs={}):
43
51
        """Create a new proxy object, passing in the args to pass to re.compile
44
52
 
45
 
        :param args: The *args to pass to re.compile
46
 
        :param kwargs: The **kwargs to pass to re.compile
 
53
        :param args: The `*args` to pass to re.compile
 
54
        :param kwargs: The `**kwargs` to pass to re.compile
47
55
        """
48
56
        self._real_regex = None
49
57
        self._regex_args = args
58
66
 
59
67
    def _real_re_compile(self, *args, **kwargs):
60
68
        """Thunk over to the original re.compile"""
61
 
        return _real_re_compile(*args, **kwargs)
 
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"])
62
88
 
63
89
    def __getattr__(self, attr):
64
90
        """Return a member from the proxied regex object.
91
117
 
92
118
def reset_compile():
93
119
    """Restore the original function to re.compile().
94
 
    
 
120
 
95
121
    It is safe to call reset_compile() multiple times, it will always
96
122
    restore re.compile() to the value that existed at import time.
97
123
    Though the first call will reset back to the original (it doesn't
105
131
    raise AssertionError(
106
132
        "re.compile has already been overridden as lazy_compile, but this would" \
107
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