← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fifo_cache.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 16:43:12 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730164312-b025fd3ff0cee59e
rename  gpl.txt => COPYING.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/fifo_cache.py
1
 
# Copyright (C) 2008 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
 
"""A simple first-in-first-out (FIFO) cache."""
18
 
 
19
 
from collections import deque
20
 
 
21
 
 
22
 
class FIFOCache(dict):
23
 
    """A class which manages a cache of entries, removing old ones."""
24
 
 
25
 
    def __init__(self, max_cache=100, after_cleanup_count=None):
26
 
        dict.__init__(self)
27
 
        self._max_cache = max_cache
28
 
        if after_cleanup_count is None:
29
 
            self._after_cleanup_count = self._max_cache * 8 / 10
30
 
        else:
31
 
            self._after_cleanup_count = min(after_cleanup_count,
32
 
                                            self._max_cache)
33
 
        self._cleanup = {} # map to cleanup functions when items are removed
34
 
        self._queue = deque() # Track when things are accessed
35
 
 
36
 
    def __setitem__(self, key, value):
37
 
        """Add a value to the cache, there will be no cleanup function."""
38
 
        self.add(key, value, cleanup=None)
39
 
 
40
 
    def __delitem__(self, key):
41
 
        # Remove the key from an arbitrary location in the queue
42
 
        remove = getattr(self._queue, 'remove', None)
43
 
        # Python2.5's has deque.remove, but Python2.4 does not
44
 
        if remove is not None:
45
 
            remove(key)
46
 
        else:
47
 
            # TODO: It would probably be faster to pop()/popleft() until we get to the
48
 
            #       key, and then insert those back into the queue. We know
49
 
            #       the key should only be present in one position, and we
50
 
            #       wouldn't need to rebuild the whole queue.
51
 
            self._queue = deque([k for k in self._queue if k != key])
52
 
        self._remove(key)
53
 
 
54
 
    def add(self, key, value, cleanup=None):
55
 
        """Add a new value to the cache.
56
 
 
57
 
        Also, if the entry is ever removed from the queue, call cleanup.
58
 
        Passing it the key and value being removed.
59
 
 
60
 
        :param key: The key to store it under
61
 
        :param value: The object to store
62
 
        :param cleanup: None or a function taking (key, value) to indicate
63
 
                        'value' should be cleaned up
64
 
        """
65
 
        if key in self:
66
 
            # Remove the earlier reference to this key, adding it again bumps
67
 
            # it to the end of the queue
68
 
            del self[key]
69
 
        self._queue.append(key)
70
 
        dict.__setitem__(self, key, value)
71
 
        if cleanup is not None:
72
 
            self._cleanup[key] = cleanup
73
 
        if len(self) > self._max_cache:
74
 
            self.cleanup()
75
 
 
76
 
    def cache_size(self):
77
 
        """Get the number of entries we will cache."""
78
 
        return self._max_cache
79
 
 
80
 
    def cleanup(self):
81
 
        """Clear the cache until it shrinks to the requested size.
82
 
 
83
 
        This does not completely wipe the cache, just makes sure it is under
84
 
        the after_cleanup_count.
85
 
        """
86
 
        # Make sure the cache is shrunk to the correct size
87
 
        while len(self) > self._after_cleanup_count:
88
 
            self._remove_oldest()
89
 
        if len(self._queue) != len(self):
90
 
            raise AssertionError('The length of the queue should always equal'
91
 
                ' the length of the dict. %s != %s'
92
 
                % (len(self._queue), len(self)))
93
 
 
94
 
    def clear(self):
95
 
        """Clear out all of the cache."""
96
 
        # Clean up in FIFO order
97
 
        while self:
98
 
            self._remove_oldest()
99
 
 
100
 
    def _remove(self, key):
101
 
        """Remove an entry, making sure to call any cleanup function."""
102
 
        cleanup = self._cleanup.pop(key, None)
103
 
        # We override self.pop() because it doesn't play well with cleanup
104
 
        # functions.
105
 
        val = dict.pop(self, key)
106
 
        if cleanup is not None:
107
 
            cleanup(key, val)
108
 
        return val
109
 
 
110
 
    def _remove_oldest(self):
111
 
        """Remove the oldest entry."""
112
 
        key = self._queue.popleft()
113
 
        self._remove(key)
114
 
 
115
 
    def resize(self, max_cache, after_cleanup_count=None):
116
 
        """Increase/decrease the number of cached entries.
117
 
 
118
 
        :param max_cache: The maximum number of entries to cache.
119
 
        :param after_cleanup_count: After cleanup, we should have at most this
120
 
            many entries. This defaults to 80% of max_cache.
121
 
        """
122
 
        self._max_cache = max_cache
123
 
        if after_cleanup_count is None:
124
 
            self._after_cleanup_count = max_cache * 8 / 10
125
 
        else:
126
 
            self._after_cleanup_count = min(max_cache, after_cleanup_count)
127
 
        if len(self) > self._max_cache:
128
 
            self.cleanup()
129
 
 
130
 
    # raise NotImplementedError on dict functions that would mutate the cache
131
 
    # which have not been properly implemented yet.
132
 
    def copy(self):
133
 
        raise NotImplementedError(self.copy)
134
 
 
135
 
    def pop(self, key, default=None):
136
 
        # If there is a cleanup() function, than it is unclear what pop()
137
 
        # should do. Specifically, we would have to call the cleanup on the
138
 
        # value before we return it, which should cause whatever resources were
139
 
        # allocated to be removed, which makes the return value fairly useless.
140
 
        # So instead, we just don't implement it.
141
 
        raise NotImplementedError(self.pop)
142
 
 
143
 
    def popitem(self):
144
 
        # See pop()
145
 
        raise NotImplementedError(self.popitem)
146
 
 
147
 
    def setdefault(self, key, defaultval=None):
148
 
        """similar to dict.setdefault"""
149
 
        if key in self:
150
 
            return self[key]
151
 
        self[key] = defaultval
152
 
        return defaultval
153
 
 
154
 
    def update(self, *args, **kwargs):
155
 
        """Similar to dict.update()"""
156
 
        if len(args) == 1:
157
 
            arg = args[0]
158
 
            if isinstance(arg, dict):
159
 
                for key, val in arg.iteritems():
160
 
                    self.add(key, val)
161
 
            else:
162
 
                for key, val in args[0]:
163
 
                    self.add(key, val)
164
 
        elif len(args) > 1:
165
 
            raise TypeError('update expected at most 1 argument, got %d'
166
 
                            % len(args))
167
 
        if kwargs:
168
 
            for key, val in kwargs.iteritems():
169
 
                self.add(key, val)
170
 
 
171
 
 
172
 
class FIFOSizeCache(FIFOCache):
173
 
    """An FIFOCache that removes things based on the size of the values.
174
 
 
175
 
    This differs in that it doesn't care how many actual items there are,
176
 
    it restricts the cache to be cleaned based on the size of the data.
177
 
    """
178
 
 
179
 
    def __init__(self, max_size=1024*1024, after_cleanup_size=None,
180
 
                 compute_size=None):
181
 
        """Create a new FIFOSizeCache.
182
 
 
183
 
        :param max_size: The max number of bytes to store before we start
184
 
            clearing out entries.
185
 
        :param after_cleanup_size: After cleaning up, shrink everything to this
186
 
            size (defaults to 80% of max_size).
187
 
        :param compute_size: A function to compute the size of a value. If
188
 
            not supplied we default to 'len'.
189
 
        """
190
 
        # Arbitrary, we won't really be using the value anyway.
191
 
        FIFOCache.__init__(self, max_cache=max_size)
192
 
        self._max_size = max_size
193
 
        if after_cleanup_size is None:
194
 
            self._after_cleanup_size = self._max_size * 8 / 10
195
 
        else:
196
 
            self._after_cleanup_size = min(after_cleanup_size, self._max_size)
197
 
 
198
 
        self._value_size = 0
199
 
        self._compute_size = compute_size
200
 
        if compute_size is None:
201
 
            self._compute_size = len
202
 
 
203
 
    def add(self, key, value, cleanup=None):
204
 
        """Add a new value to the cache.
205
 
 
206
 
        Also, if the entry is ever removed from the queue, call cleanup.
207
 
        Passing it the key and value being removed.
208
 
 
209
 
        :param key: The key to store it under
210
 
        :param value: The object to store, this value by itself is >=
211
 
            after_cleanup_size, then we will not store it at all.
212
 
        :param cleanup: None or a function taking (key, value) to indicate
213
 
                        'value' sohuld be cleaned up.
214
 
        """
215
 
        # Even if the new value won't be stored, we need to remove the old
216
 
        # value
217
 
        if key in self:
218
 
            # Remove the earlier reference to this key, adding it again bumps
219
 
            # it to the end of the queue
220
 
            del self[key]
221
 
        value_len = self._compute_size(value)
222
 
        if value_len >= self._after_cleanup_size:
223
 
            return
224
 
        self._queue.append(key)
225
 
        dict.__setitem__(self, key, value)
226
 
        if cleanup is not None:
227
 
            self._cleanup[key] = cleanup
228
 
        self._value_size += value_len
229
 
        if self._value_size > self._max_size:
230
 
            # Time to cleanup
231
 
            self.cleanup()
232
 
 
233
 
    def cache_size(self):
234
 
        """Get the number of bytes we will cache."""
235
 
        return self._max_size
236
 
 
237
 
    def cleanup(self):
238
 
        """Clear the cache until it shrinks to the requested size.
239
 
 
240
 
        This does not completely wipe the cache, just makes sure it is under
241
 
        the after_cleanup_size.
242
 
        """
243
 
        # Make sure the cache is shrunk to the correct size
244
 
        while self._value_size > self._after_cleanup_size:
245
 
            self._remove_oldest()
246
 
 
247
 
    def _remove(self, key):
248
 
        """Remove an entry, making sure to maintain the invariants."""
249
 
        val = FIFOCache._remove(self, key)
250
 
        self._value_size -= self._compute_size(val)
251
 
        return val
252
 
 
253
 
    def resize(self, max_size, after_cleanup_size=None):
254
 
        """Increase/decrease the amount of cached data.
255
 
 
256
 
        :param max_size: The maximum number of bytes to cache.
257
 
        :param after_cleanup_size: After cleanup, we should have at most this
258
 
            many bytes cached. This defaults to 80% of max_size.
259
 
        """
260
 
        FIFOCache.resize(self, max_size)
261
 
        self._max_size = max_size
262
 
        if after_cleanup_size is None:
263
 
            self._after_cleanup_size = max_size * 8 / 10
264
 
        else:
265
 
            self._after_cleanup_size = min(max_size, after_cleanup_size)
266
 
        if self._value_size > self._max_size:
267
 
            self.cleanup()
268