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

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-04-24 10:31:28 UTC
  • mfrom: (1684.1.2 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060424103128-a637f56a7c529bad
(mbp) tutorial improvements

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
16
17
 
17
18
"""Inter-object utility class."""
18
19
 
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
 
 
34
20
 
35
21
class InterObject(object):
36
22
    """This class represents operations taking place between two objects.
37
23
 
38
24
    Its instances have methods like join or copy_content or fetch, and contain
39
 
    references to the source and target objects these operations can be
 
25
    references to the source and target objects these operations can be 
40
26
    carried out between.
41
27
 
42
28
    Often we will provide convenience methods on the objects which carry out
43
29
    operations with another of similar type - they will always forward to
44
 
    a subclass of InterObject - i.e.
 
30
    a subclass of InterObject - i.e. 
45
31
    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.
54
32
    """
55
33
 
56
 
    # _optimisers = list()
57
 
    # Each concrete InterObject type should have its own optimisers list.
 
34
    # _optimisers = set()
 
35
    # Each concrete InterObject type should have its own optimisers set.
58
36
 
59
37
    def __init__(self, source, target):
60
38
        """Construct a default InterObject instance. Please use 'get'.
61
 
 
62
 
        Only subclasses of InterObject should call
 
39
        
 
40
        Only subclasses of InterObject should call 
63
41
        InterObject.__init__ - clients should call InterFOO.get where FOO
64
42
        is the base type of the objects they are interacting between. I.e.
65
43
        InterVersionedFile or InterRepository.
69
47
        self.source = source
70
48
        self.target = target
71
49
 
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
50
    @classmethod
84
51
    def get(klass, source, target):
85
52
        """Retrieve a Inter worker object for these objects.
88
55
                       the InterObject instance.
89
56
        :param target: the object to be the 'target' member of
90
57
                       the InterObject instance.
91
 
 
92
58
        If an optimised worker exists it will be used otherwise
93
59
        a default Inter worker instance will be created.
94
60
        """
95
 
        for provider in reversed(klass._optimisers):
 
61
        for provider in klass._optimisers:
96
62
            if provider.is_compatible(source, target):
97
63
                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
 
        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)
 
64
        return klass(source, target)
117
65
 
118
66
    @classmethod
119
67
    def register_optimiser(klass, optimiser):
120
68
        """Register an InterObject 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()
 
69
        klass._optimisers.add(optimiser)
129
70
 
130
71
    @classmethod
131
72
    def unregister_optimiser(klass, optimiser):