/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-12-03 15:14:22 UTC
  • mfrom: (6829.1.1 no-branch-nick)
  • Revision ID: jelmer@jelmer.uk-20171203151422-54pwtld2ae5cx11l
Merge lp:~jelmer/brz/no-branch-nick.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/inter.py
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
16
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
16
 
18
17
"""Inter-object utility class."""
19
18
 
 
19
from __future__ import absolute_import
 
20
 
 
21
from .errors import BzrError
 
22
from .lock import LogicalLockResult
 
23
 
 
24
 
 
25
class NoCompatibleInter(BzrError):
 
26
 
 
27
    _fmt = ('No compatible object available for operations from %(source)r '
 
28
            'to %(target)r.')
 
29
 
 
30
    def __init__(self, source, target):
 
31
        self.source = source
 
32
        self.target = target
 
33
 
20
34
 
21
35
class InterObject(object):
22
36
    """This class represents operations taking place between two objects.
23
37
 
24
38
    Its instances have methods like join or copy_content or fetch, and contain
25
 
    references to the source and target objects these operations can be 
 
39
    references to the source and target objects these operations can be
26
40
    carried out between.
27
41
 
28
42
    Often we will provide convenience methods on the objects which carry out
29
43
    operations with another of similar type - they will always forward to
30
 
    a subclass of InterObject - i.e. 
 
44
    a subclass of InterObject - i.e.
31
45
    InterVersionedFile.get(other).method_name(parameters).
 
46
 
 
47
    If the source and target objects implement the locking protocol -
 
48
    lock_read, lock_write, unlock, then the InterObject's lock_read,
 
49
    lock_write and unlock methods may be used.
 
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.
32
54
    """
33
55
 
34
 
    # _optimisers = set()
35
 
    # Each concrete InterObject type should have its own optimisers set.
 
56
    # _optimisers = list()
 
57
    # Each concrete InterObject type should have its own optimisers list.
36
58
 
37
59
    def __init__(self, source, target):
38
60
        """Construct a default InterObject instance. Please use 'get'.
39
 
        
40
 
        Only subclasses of InterObject should call 
 
61
 
 
62
        Only subclasses of InterObject should call
41
63
        InterObject.__init__ - clients should call InterFOO.get where FOO
42
64
        is the base type of the objects they are interacting between. I.e.
43
65
        InterVersionedFile or InterRepository.
47
69
        self.source = source
48
70
        self.target = target
49
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
 
50
83
    @classmethod
51
84
    def get(klass, source, target):
52
85
        """Retrieve a Inter worker object for these objects.
55
88
                       the InterObject instance.
56
89
        :param target: the object to be the 'target' member of
57
90
                       the InterObject instance.
 
91
 
58
92
        If an optimised worker exists it will be used otherwise
59
93
        a default Inter worker instance will be created.
60
94
        """
61
 
        for provider in klass._optimisers:
 
95
        for provider in reversed(klass._optimisers):
62
96
            if provider.is_compatible(source, target):
63
97
                return provider(source, target)
64
 
        return klass(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
        return LogicalLockResult(self.unlock)
 
108
 
 
109
    def lock_write(self):
 
110
        """Take out a logical write lock.
 
111
 
 
112
        This will lock the source branch and the target branch. The source gets
 
113
        a read lock and the target a write lock.
 
114
        """
 
115
        self._double_lock(self.source.lock_read, self.target.lock_write)
 
116
        return LogicalLockResult(self.unlock)
65
117
 
66
118
    @classmethod
67
119
    def register_optimiser(klass, optimiser):
68
120
        """Register an InterObject optimiser."""
69
 
        klass._optimisers.add(optimiser)
 
121
        klass._optimisers.append(optimiser)
 
122
 
 
123
    def unlock(self):
 
124
        """Release the locks on source and target."""
 
125
        try:
 
126
            self.target.unlock()
 
127
        finally:
 
128
            self.source.unlock()
70
129
 
71
130
    @classmethod
72
131
    def unregister_optimiser(klass, optimiser):