/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/inter.py

  • Committer: Jelmer Vernooij
  • Date: 2020-03-22 01:35:14 UTC
  • mfrom: (7490.7.6 work)
  • mto: This revision was merged to the branch mainline in revision 7499.
  • Revision ID: jelmer@jelmer.uk-20200322013514-7vw1ntwho04rcuj3
merge lp:brz/3.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/inter.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
"""Inter-object utility class."""
 
18
 
 
19
from .errors import BzrError
 
20
from .lock import LogicalLockResult
 
21
 
 
22
 
 
23
class NoCompatibleInter(BzrError):
 
24
 
 
25
    _fmt = ('No compatible object available for operations from %(source)r '
 
26
            'to %(target)r.')
 
27
 
 
28
    def __init__(self, source, target):
 
29
        self.source = source
 
30
        self.target = target
 
31
 
 
32
 
 
33
class InterObject(object):
 
34
    """This class represents operations taking place between two objects.
 
35
 
 
36
    Its instances have methods like join or copy_content or fetch, and contain
 
37
    references to the source and target objects these operations can be
 
38
    carried out between.
 
39
 
 
40
    Often we will provide convenience methods on the objects which carry out
 
41
    operations with another of similar type - they will always forward to
 
42
    a subclass of InterObject - i.e.
 
43
    InterVersionedFile.get(other).method_name(parameters).
 
44
 
 
45
    If the source and target objects implement the locking protocol -
 
46
    lock_read, lock_write, unlock, then the InterObject's lock_read,
 
47
    lock_write and unlock methods may be used.
 
48
 
 
49
    When looking for an inter, the most recently registered types are tested
 
50
    first.  So typically the most generic and slowest InterObjects should be
 
51
    registered first.
 
52
    """
 
53
 
 
54
    # _optimisers = list()
 
55
    # Each concrete InterObject type should have its own optimisers list.
 
56
 
 
57
    def __init__(self, source, target):
 
58
        """Construct a default InterObject instance. Please use 'get'.
 
59
 
 
60
        Only subclasses of InterObject should call
 
61
        InterObject.__init__ - clients should call InterFOO.get where FOO
 
62
        is the base type of the objects they are interacting between. I.e.
 
63
        InterVersionedFile or InterRepository.
 
64
        get() is a convenience class method which will create an optimised
 
65
        InterFOO if possible.
 
66
        """
 
67
        self.source = source
 
68
        self.target = target
 
69
 
 
70
    def _double_lock(self, lock_source, lock_target):
 
71
        """Take out two locks, rolling back the first if the second throws."""
 
72
        lock_source()
 
73
        try:
 
74
            lock_target()
 
75
        except Exception:
 
76
            # we want to ensure that we don't leave source locked by mistake.
 
77
            # and any error on target should not confuse source.
 
78
            self.source.unlock()
 
79
            raise
 
80
 
 
81
    @classmethod
 
82
    def get(klass, source, target):
 
83
        """Retrieve a Inter worker object for these objects.
 
84
 
 
85
        :param source: the object to be the 'source' member of
 
86
                       the InterObject instance.
 
87
        :param target: the object to be the 'target' member of
 
88
                       the InterObject instance.
 
89
 
 
90
        If an optimised worker exists it will be used otherwise
 
91
        a default Inter worker instance will be created.
 
92
        """
 
93
        for provider in reversed(klass._optimisers):
 
94
            if provider.is_compatible(source, target):
 
95
                return provider(source, target)
 
96
        raise NoCompatibleInter(source, target)
 
97
 
 
98
    def lock_read(self):
 
99
        """Take out a logical read lock.
 
100
 
 
101
        This will lock the source branch and the target branch. The source gets
 
102
        a read lock and the target a read lock.
 
103
        """
 
104
        self._double_lock(self.source.lock_read, self.target.lock_read)
 
105
        return LogicalLockResult(self.unlock)
 
106
 
 
107
    def lock_write(self):
 
108
        """Take out a logical write lock.
 
109
 
 
110
        This will lock the source branch and the target branch. The source gets
 
111
        a read lock and the target a write lock.
 
112
        """
 
113
        self._double_lock(self.source.lock_read, self.target.lock_write)
 
114
        return LogicalLockResult(self.unlock)
 
115
 
 
116
    @classmethod
 
117
    def register_optimiser(klass, optimiser):
 
118
        """Register an InterObject optimiser."""
 
119
        klass._optimisers.append(optimiser)
 
120
 
 
121
    def unlock(self):
 
122
        """Release the locks on source and target."""
 
123
        try:
 
124
            self.target.unlock()
 
125
        finally:
 
126
            self.source.unlock()
 
127
 
 
128
    @classmethod
 
129
    def unregister_optimiser(klass, optimiser):
 
130
        """Unregister an InterObject optimiser."""
 
131
        klass._optimisers.remove(optimiser)