/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: 2017-07-30 18:38:48 UTC
  • mfrom: (6740.1.1 breezy-conf-1)
  • Revision ID: jelmer@jelmer.uk-20170730183848-195b9ch7sclkxmqs
Merge lp:~jelmer/brz/breezy-conf

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