← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inter.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-03-09 08:50:48 UTC
  • mfrom: (1553.5.83 bzr.mbp.locks)
  • Revision ID: pqm@pqm.ubuntu.com-20060309085048-37f21fd146dabe93
[merge] LockDir integration into new formats

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 bzrlib.errors import NoCompatibleInter
22
 
 
23
20
 
24
21
class InterObject(object):
25
22
    """This class represents operations taking place between two objects.
26
23
 
27
24
    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
 
25
    references to the source and target objects these operations can be 
29
26
    carried out between.
30
27
 
31
28
    Often we will provide convenience methods on the objects which carry out
32
29
    operations with another of similar type - they will always forward to
33
 
    a subclass of InterObject - i.e.
 
30
    a subclass of InterObject - i.e. 
34
31
    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
32
    """
45
33
 
46
 
    # _optimisers = list()
47
 
    # Each concrete InterObject type should have its own optimisers list.
 
34
    # _optimisers = set()
 
35
    # Each concrete InterObject type should have its own optimisers set.
48
36
 
49
37
    def __init__(self, source, target):
50
38
        """Construct a default InterObject instance. Please use 'get'.
51
 
 
52
 
        Only subclasses of InterObject should call
 
39
        
 
40
        Only subclasses of InterObject should call 
53
41
        InterObject.__init__ - clients should call InterFOO.get where FOO
54
42
        is the base type of the objects they are interacting between. I.e.
55
43
        InterVersionedFile or InterRepository.
59
47
        self.source = source
60
48
        self.target = target
61
49
 
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
50
    @classmethod
74
51
    def get(klass, source, target):
75
52
        """Retrieve a Inter worker object for these objects.
78
55
                       the InterObject instance.
79
56
        :param target: the object to be the 'target' member of
80
57
                       the InterObject instance.
81
 
 
82
58
        If an optimised worker exists it will be used otherwise
83
59
        a default Inter worker instance will be created.
84
60
        """
85
 
        for provider in reversed(klass._optimisers):
 
61
        for provider in klass._optimisers:
86
62
            if provider.is_compatible(source, target):
87
63
                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)
 
64
        return klass(source, target)
105
65
 
106
66
    @classmethod
107
67
    def register_optimiser(klass, optimiser):
108
68
        """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()
 
69
        klass._optimisers.add(optimiser)
117
70
 
118
71
    @classmethod
119
72
    def unregister_optimiser(klass, optimiser):