/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: 2020-04-05 19:11:34 UTC
  • mto: (7490.7.16 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200405191134-0aebh8ikiwygxma5
Populate the .gitignore file.

Show diffs side-by-side

added added

removed removed

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