/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: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

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
 
23
27
import re
24
28
 
 
29
from . import errors
 
30
 
 
31
 
 
32
class InvalidPattern(errors.BzrError):
 
33
 
 
34
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
35
 
 
36
    def __init__(self, msg):
 
37
        self.msg = msg
 
38
 
25
39
 
26
40
class LazyRegex(object):
27
41
    """A proxy around a real regex, which won't be compiled until accessed."""
28
42
 
29
 
 
30
43
    # These are the parameters on a real _sre.SRE_Pattern object, which we
31
44
    # will map to local members so that we don't have the proxy overhead.
32
45
    _regex_attributes_to_copy = [
33
 
                 '__copy__', '__deepcopy__', 'findall', 'finditer', 'match',
34
 
                 'scanner', 'search', 'split', 'sub', 'subn'
35
 
                 ]
 
46
        '__copy__', '__deepcopy__', 'findall', 'finditer', 'match',
 
47
        'scanner', 'search', 'split', 'sub', 'subn'
 
48
        ]
36
49
 
37
50
    # We use slots to keep the overhead low. But we need a slot entry for
38
51
    # all of the attributes we will copy
39
52
    __slots__ = ['_real_regex', '_regex_args', '_regex_kwargs',
40
 
                ] + _regex_attributes_to_copy
 
53
                 ] + _regex_attributes_to_copy
41
54
 
42
 
    def __init__(self, args=(), kwargs={}):
 
55
    def __init__(self, args, kwargs):
43
56
        """Create a new proxy object, passing in the args to pass to re.compile
44
57
 
45
 
        :param args: The *args to pass to re.compile
46
 
        :param kwargs: The **kwargs to pass to re.compile
 
58
        :param args: The `*args` to pass to re.compile
 
59
        :param kwargs: The `**kwargs` to pass to re.compile
47
60
        """
48
61
        self._real_regex = None
49
62
        self._regex_args = args
58
71
 
59
72
    def _real_re_compile(self, *args, **kwargs):
60
73
        """Thunk over to the original re.compile"""
61
 
        return _real_re_compile(*args, **kwargs)
 
74
        try:
 
75
            return re.compile(*args, **kwargs)
 
76
        except re.error as e:
 
77
            # raise InvalidPattern instead of re.error as this gives a
 
78
            # cleaner message to the user.
 
79
            raise InvalidPattern('"' + args[0] + '" ' + str(e))
 
80
 
 
81
    def __getstate__(self):
 
82
        """Return the state to use when pickling."""
 
83
        return {
 
84
            "args": self._regex_args,
 
85
            "kwargs": self._regex_kwargs,
 
86
            }
 
87
 
 
88
    def __setstate__(self, dict):
 
89
        """Restore from a pickled state."""
 
90
        self._real_regex = None
 
91
        setattr(self, "_regex_args", dict["args"])
 
92
        setattr(self, "_regex_kwargs", dict["kwargs"])
62
93
 
63
94
    def __getattr__(self, attr):
64
95
        """Return a member from the proxied regex object.
78
109
    :return: a LazyRegex proxy object.
79
110
    """
80
111
    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")