← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inter.py

  • Committer: Martin Pool
  • Date: 2005-09-12 09:50:44 UTC
  • Revision ID: mbp@sourcefrog.net-20050912095044-6acfdb5611729987
- no tests in bzrlib.fetch anymore

Show diffs side-by-side

added added

removed removed

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