/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: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

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
 
from .pyutils import get_named_object
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.
49
 
 
50
 
    When looking for an inter, the most recently registered types are tested
51
 
    first.  So typically the most generic and slowest InterObjects should be
52
 
    registered first.
53
 
    """
54
 
 
55
 
    # _optimisers = list()
56
 
    # Each concrete InterObject type should have its own optimisers list.
57
 
 
58
 
    def __init__(self, source, target):
59
 
        """Construct a default InterObject instance. Please use 'get'.
60
 
 
61
 
        Only subclasses of InterObject should call
62
 
        InterObject.__init__ - clients should call InterFOO.get where FOO
63
 
        is the base type of the objects they are interacting between. I.e.
64
 
        InterVersionedFile or InterRepository.
65
 
        get() is a convenience class method which will create an optimised
66
 
        InterFOO if possible.
67
 
        """
68
 
        self.source = source
69
 
        self.target = target
70
 
 
71
 
    def _double_lock(self, lock_source, lock_target):
72
 
        """Take out two locks, rolling back the first if the second throws."""
73
 
        lock_source()
74
 
        try:
75
 
            lock_target()
76
 
        except Exception:
77
 
            # we want to ensure that we don't leave source locked by mistake.
78
 
            # and any error on target should not confuse source.
79
 
            self.source.unlock()
80
 
            raise
81
 
 
82
 
    @classmethod
83
 
    def get(klass, source, target):
84
 
        """Retrieve a Inter worker object for these objects.
85
 
 
86
 
        :param source: the object to be the 'source' member of
87
 
                       the InterObject instance.
88
 
        :param target: the object to be the 'target' member of
89
 
                       the InterObject instance.
90
 
 
91
 
        If an optimised worker exists it will be used otherwise
92
 
        a default Inter worker instance will be created.
93
 
        """
94
 
        for i, provider in enumerate(reversed(klass._optimisers)):
95
 
            if isinstance(provider, tuple):
96
 
                provider = get_named_object(provider[0], provider[1])
97
 
                klass._optimisers[-i] = provider
98
 
            if provider.is_compatible(source, target):
99
 
                return provider(source, target)
100
 
        raise NoCompatibleInter(source, target)
101
 
 
102
 
    @classmethod
103
 
    def iter_optimisers(klass):
104
 
        for provider in klass._optimisers:
105
 
            if isinstance(provider, tuple):
106
 
                yield get_named_object(provider[0], provider[1])
107
 
            else:
108
 
                yield provider
109
 
 
110
 
    def lock_read(self):
111
 
        """Take out a logical read lock.
112
 
 
113
 
        This will lock the source branch and the target branch. The source gets
114
 
        a read lock and the target a read lock.
115
 
        """
116
 
        self._double_lock(self.source.lock_read, self.target.lock_read)
117
 
        return LogicalLockResult(self.unlock)
118
 
 
119
 
    def lock_write(self):
120
 
        """Take out a logical write lock.
121
 
 
122
 
        This will lock the source branch and the target branch. The source gets
123
 
        a read lock and the target a write lock.
124
 
        """
125
 
        self._double_lock(self.source.lock_read, self.target.lock_write)
126
 
        return LogicalLockResult(self.unlock)
127
 
 
128
 
    @classmethod
129
 
    def register_optimiser(klass, optimiser):
130
 
        """Register an InterObject optimiser."""
131
 
        klass._optimisers.append(optimiser)
132
 
 
133
 
    @classmethod
134
 
    def register_lazy_optimiser(klass, module_name, member_name):
135
 
        # TODO(jelmer): Allow passing in a custom .is_compatible
136
 
        klass._optimisers.append((module_name, member_name))
137
 
 
138
 
    def unlock(self):
139
 
        """Release the locks on source and target."""
140
 
        try:
141
 
            self.target.unlock()
142
 
        finally:
143
 
            self.source.unlock()
144
 
 
145
 
    @classmethod
146
 
    def unregister_optimiser(klass, optimiser):
147
 
        """Unregister an InterObject optimiser."""
148
 
        klass._optimisers.remove(optimiser)