← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transactions.py

tests.blackbox.test_pull now uses internals where appropriate.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transactions.py
1
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
19
19
 
20
20
Transactions provide hooks to allow data objects (i.e. inventory weaves or
21
21
the revision-history file) to be placed in a registry and retrieved later
22
 
during the same transaction.  This allows for repeated read isolation. At
23
 
the end of a transaction, a callback is issued to each registered changed
24
 
item informing it whether it should commit or not. We provide a two layer
25
 
facility - domain objects are notified first, then data objects.
 
22
during the same transaction. Transactions in bzr are not atomic - they
 
23
depend on data ordering of writes, so we do not have commit or rollback
 
24
facilities at the transaction level.
26
25
 
27
26
Read only transactions raise an assert when objects are listed as dirty
28
 
against them - preventing unintended writes. Once all the data storage is
29
 
hooked into this facility, it might be nice to have a readonly transaction
30
 
that just excepts on commit, for testing or simulating of things.
 
27
against them - preventing unintended writes.
31
28
 
32
 
Write transactions queue all changes in the transaction (which may in the 
33
 
future involve writing them to uncommitted atomic files in preparation 
34
 
for commit - i.e. on network connections where latency matters) and then
35
 
notify each object of commit or rollback.
 
29
Write transactions preserve dirty objects in the cache, though due to the
 
30
write ordering approach we use for consistency 'dirty' is a misleading term.
 
31
A dirty object is one we have modified.
36
32
 
37
33
Both read and write transactions *may* flush unchanged objects out of 
38
 
memory, unless they are marked as 'preserve' which indicates that 
39
 
repeated reads cannot be obtained if the object is ejected.
 
34
memory, unless they are marked as 'precious' which indicates that 
 
35
repeated reads cannot be obtained if the object is ejected, or that
 
36
the object is an expensive one for obtaining.
40
37
"""
41
38
 
42
39
import sys
49
46
class ReadOnlyTransaction(object):
50
47
    """A read only unit of work for data objects."""
51
48
 
52
 
    def commit(self):
53
 
        """ReadOnlyTransactions cannot commit."""
54
 
        raise errors.CommitNotPossible('In a read only transaction')
55
 
 
56
49
    def finish(self):
57
 
        """Clean up this transaction
58
 
 
59
 
        This will rollback on transactions that can if they have nto been
60
 
        committed.
61
 
        """
 
50
        """Clean up this transaction."""
62
51
 
63
52
    def __init__(self):
64
53
        super(ReadOnlyTransaction, self).__init__()
68
57
        self._limit = -1
69
58
        self._precious_objects = set()
70
59
 
 
60
    def is_clean(self, an_object):
 
61
        """Return True if an_object is clean."""
 
62
        return (an_object in self._clean_objects)
 
63
 
71
64
    def register_clean(self, an_object, precious=False):
72
65
        """Register an_object as being clean.
73
66
        
82
75
 
83
76
    def register_dirty(self, an_object):
84
77
        """Register an_object as being dirty."""
85
 
        raise errors.ReadOnlyError(
86
 
            "Cannot dirty objects in a read only transaction")
87
 
 
88
 
    def rollback(self):
89
 
        """Let people call this even though nothing has to happen."""
 
78
        raise errors.ReadOnlyObjectDirtiedError(an_object)
90
79
 
91
80
    def set_cache_size(self, size):
92
81
        """Set a new cache size."""
120
109
            else:
121
110
                offset += 1
122
111
 
 
112
    def writeable(self):
 
113
        """Read only transactions do not allow writes."""
 
114
 
 
115
 
 
116
class WriteTransaction(ReadOnlyTransaction):
 
117
    """A write transaction
 
118
 
 
119
    - caches domain objects
 
120
    - clean objects can be removed from the cache
 
121
    - dirty objects are retained.
 
122
    """
 
123
 
 
124
    def finish(self):
 
125
        """Clean up this transaction."""
 
126
        for thing in self._dirty_objects:
 
127
            callback = getattr(thing, 'transaction_finished', None)
 
128
            if callback is not None:
 
129
                callback()
 
130
 
 
131
    def __init__(self):
 
132
        super(WriteTransaction, self).__init__()
 
133
        self._dirty_objects = set()
 
134
 
 
135
    def is_dirty(self, an_object):
 
136
        """Return True if an_object is dirty."""
 
137
        return (an_object in self._dirty_objects)
 
138
 
 
139
    def register_dirty(self, an_object):
 
140
        """Register an_object as being dirty.
 
141
        
 
142
        Dirty objects are not ejected from the identity map
 
143
        until the transaction finishes and get informed
 
144
        when the transaction finishes.
 
145
        """
 
146
        self._dirty_objects.add(an_object)
 
147
        if self.is_clean(an_object):
 
148
            self._clean_objects.remove(an_object)
 
149
            del self._clean_queue[self._clean_queue.index(an_object)]
 
150
        self._trim()
 
151
 
 
152
    def writeable(self):
 
153
        """Write transactions allow writes."""
 
154
        return True
123
155
 
124
156
        
125
157
class PassThroughTransaction(object):
126
158
    """A pass through transaction
127
159
    
128
 
    - all actions are committed immediately.
129
 
    - rollback is not supported.
130
 
    - commit() is a no-op.
 
160
    - nothing is cached.
 
161
    - nothing ever gets into the identity map.
131
162
    """
132
163
 
133
 
    def commit(self):
134
 
        """PassThroughTransactions have nothing to do."""
135
 
 
136
164
    def finish(self):
137
 
        """Clean up this transaction
138
 
 
139
 
        This will rollback on transactions that can if they have nto been
140
 
        committed.
141
 
        """
 
165
        """Clean up this transaction."""
 
166
        for thing in self._dirty_objects:
 
167
            callback = getattr(thing, 'transaction_finished', None)
 
168
            if callback is not None:
 
169
                callback()
142
170
 
143
171
    def __init__(self):
144
172
        super(PassThroughTransaction, self).__init__()
145
173
        self.map = NullIdentityMap()
 
174
        self._dirty_objects = set()
146
175
 
147
176
    def register_clean(self, an_object, precious=False):
148
177
        """Register an_object as being clean.
152
181
        """
153
182
 
154
183
    def register_dirty(self, an_object):
155
 
        """Register an_object as being dirty."""
156
 
 
157
 
    def rollback(self):
158
 
        """Cannot rollback a pass through transaction."""
159
 
        raise errors.AlreadyCommitted
 
184
        """Register an_object as being dirty.
 
185
        
 
186
        Dirty objects get informed
 
187
        when the transaction finishes.
 
188
        """
 
189
        self._dirty_objects.add(an_object)
160
190
 
161
191
    def set_cache_size(self, ignored):
162
192
        """Do nothing, we are passing through."""
 
193
 
 
194
    def writeable(self):
 
195
        """Pass through transactions allow writes."""
 
196
        return True