← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transactions.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transactions.py
13
13
#
14
14
# You should have received a copy of the GNU General Public License
15
15
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
 
18
18
"""This module provides a transactional facility.
19
19
 
30
30
write ordering approach we use for consistency 'dirty' is a misleading term.
31
31
A dirty object is one we have modified.
32
32
 
33
 
Both read and write transactions *may* flush unchanged objects out of 
34
 
memory, unless they are marked as 'precious' which indicates that 
 
33
Both read and write transactions *may* flush unchanged objects out of
 
34
memory, unless they are marked as 'precious' which indicates that
35
35
repeated reads cannot be obtained if the object is ejected, or that
36
36
the object is an expensive one for obtaining.
37
37
"""
63
63
 
64
64
    def register_clean(self, an_object, precious=False):
65
65
        """Register an_object as being clean.
66
 
        
 
66
 
67
67
        If the precious hint is True, the object will not
68
68
        be ejected from the object identity map ever.
69
69
        """
79
79
 
80
80
    def set_cache_size(self, size):
81
81
        """Set a new cache size."""
82
 
        assert -1 <= size
 
82
        if size < -1:
 
83
            raise ValueError(size)
83
84
        self._limit = size
84
85
        self._trim()
85
86
 
138
139
 
139
140
    def register_dirty(self, an_object):
140
141
        """Register an_object as being dirty.
141
 
        
 
142
 
142
143
        Dirty objects are not ejected from the identity map
143
144
        until the transaction finishes and get informed
144
145
        when the transaction finishes.
153
154
        """Write transactions allow writes."""
154
155
        return True
155
156
 
156
 
        
 
157
 
157
158
class PassThroughTransaction(object):
158
159
    """A pass through transaction
159
 
    
 
160
 
160
161
    - nothing is cached.
161
162
    - nothing ever gets into the identity map.
162
163
    """
175
176
 
176
177
    def register_clean(self, an_object, precious=False):
177
178
        """Register an_object as being clean.
178
 
        
 
179
 
179
180
        Note that precious is only a hint, and PassThroughTransaction
180
181
        ignores it.
181
182
        """
182
183
 
183
184
    def register_dirty(self, an_object):
184
185
        """Register an_object as being dirty.
185
 
        
 
186
 
186
187
        Dirty objects get informed
187
188
        when the transaction finishes.
188
189
        """