← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: John Arbash Meinel
  • Date: 2010-08-13 19:08:57 UTC
  • mto: (5050.17.7 2.2)
  • mto: This revision was merged to the branch mainline in revision 5379.
  • Revision ID: john@arbash-meinel.com-20100813190857-mvzwnimrxvm0zimp
Lots of documentation updates.

We had a lot of http links pointing to the old domain. They should
all now be properly updated to the new domain. (only bazaar-vcs.org
entry left is for pqm, which seems to still reside at the old url.)

Also removed one 'TODO' doc entry about switching to binary xdelta, since
we basically did just that with groupcompress.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from cStringIO import StringIO
18
 
 
19
17
from bzrlib.lazy_import import lazy_import
20
18
lazy_import(globals(), """
21
19
import codecs
32
30
""")
33
31
 
34
32
from bzrlib.decorators import (
35
 
    needs_read_lock,
36
 
    needs_write_lock,
37
 
    )
38
 
from bzrlib.symbol_versioning import (
39
 
    deprecated_in,
40
 
    deprecated_method,
 
33
    only_raises,
41
34
    )
42
35
 
43
36
 
65
58
class LockableFiles(object):
66
59
    """Object representing a set of related files locked within the same scope.
67
60
 
68
 
    These files are used by a WorkingTree, Repository or Branch, and should
69
 
    generally only be touched by that object.
70
 
 
71
 
    LockableFiles also provides some policy on top of Transport for encoding
72
 
    control files as utf-8.
 
61
    This coordinates access to the lock along with providing a transaction.
73
62
 
74
63
    LockableFiles manage a lock count and can be locked repeatedly by
75
64
    a single caller.  (The underlying lock implementation generally does not
77
66
 
78
67
    Instances of this class are often called control_files.
79
68
 
80
 
    This object builds on top of a Transport, which is used to actually write
81
 
    the files to disk, and an OSLock or LockDir, which controls how access to
82
 
    the files is controlled.  The particular type of locking used is set when
83
 
    the object is constructed.  In older formats OSLocks are used everywhere.
84
 
    in newer formats a LockDir is used for Repositories and Branches, and
85
 
    OSLocks for the local filesystem.
86
 
 
87
69
    This class is now deprecated; code should move to using the Transport
88
70
    directly for file operations and using the lock or CountedLock for
89
71
    locking.
151
133
    def _find_modes(self):
152
134
        """Determine the appropriate modes for files and directories.
153
135
 
154
 
        :deprecated: Replaced by BzrDir._find_modes.
 
136
        :deprecated: Replaced by BzrDir._find_creation_modes.
155
137
        """
156
138
        # XXX: The properties created by this can be removed or deprecated
157
139
        # once all the _get_text_store methods etc no longer use them.
170
152
            # Remove the sticky and execute bits for files
171
153
            self._file_mode = self._dir_mode & ~07111
172
154
 
173
 
    @deprecated_method(deprecated_in((1, 6, 0)))
174
 
    def controlfilename(self, file_or_path):
175
 
        """Return location relative to branch.
176
 
 
177
 
        :deprecated: Use Transport methods instead.
178
 
        """
179
 
        return self._transport.abspath(self._escape(file_or_path))
180
 
 
181
 
    @needs_read_lock
182
 
    @deprecated_method(deprecated_in((1, 5, 0)))
183
 
    def get(self, relpath):
184
 
        """Get a file as a bytestream.
185
 
 
186
 
        :deprecated: Use a Transport instead of LockableFiles.
187
 
        """
188
 
        relpath = self._escape(relpath)
189
 
        return self._transport.get(relpath)
190
 
 
191
 
    @needs_read_lock
192
 
    @deprecated_method(deprecated_in((1, 5, 0)))
193
 
    def get_utf8(self, relpath):
194
 
        """Get a file as a unicode stream.
195
 
 
196
 
        :deprecated: Use a Transport instead of LockableFiles.
197
 
        """
198
 
        relpath = self._escape(relpath)
199
 
        # DO NOT introduce an errors=replace here.
200
 
        return codecs.getreader('utf-8')(self._transport.get(relpath))
201
 
 
202
 
    @needs_write_lock
203
 
    @deprecated_method(deprecated_in((1, 6, 0)))
204
 
    def put(self, path, file):
205
 
        """Write a file.
206
 
 
207
 
        :param path: The path to put the file, relative to the .bzr control
208
 
                     directory
209
 
        :param file: A file-like or string object whose contents should be copied.
210
 
 
211
 
        :deprecated: Use Transport methods instead.
212
 
        """
213
 
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
214
 
 
215
 
    @needs_write_lock
216
 
    @deprecated_method(deprecated_in((1, 6, 0)))
217
 
    def put_bytes(self, path, a_string):
218
 
        """Write a string of bytes.
219
 
 
220
 
        :param path: The path to put the bytes, relative to the transport root.
221
 
        :param a_string: A string object, whose exact bytes are to be copied.
222
 
 
223
 
        :deprecated: Use Transport methods instead.
224
 
        """
225
 
        self._transport.put_bytes(self._escape(path), a_string,
226
 
                                  mode=self._file_mode)
227
 
 
228
 
    @needs_write_lock
229
 
    @deprecated_method(deprecated_in((1, 6, 0)))
230
 
    def put_utf8(self, path, a_string):
231
 
        """Write a string, encoding as utf-8.
232
 
 
233
 
        :param path: The path to put the string, relative to the transport root.
234
 
        :param string: A string or unicode object whose contents should be copied.
235
 
 
236
 
        :deprecated: Use Transport methods instead.
237
 
        """
238
 
        # IterableFile would not be needed if Transport.put took iterables
239
 
        # instead of files.  ADHB 2005-12-25
240
 
        # RBC 20060103 surely its not needed anyway, with codecs transcode
241
 
        # file support ?
242
 
        # JAM 20060103 We definitely don't want encode(..., 'replace')
243
 
        # these are valuable files which should have exact contents.
244
 
        if not isinstance(a_string, basestring):
245
 
            raise errors.BzrBadParameterNotString(a_string)
246
 
        self.put_bytes(path, a_string.encode('utf-8'))
247
 
 
248
155
    def leave_in_place(self):
249
156
        """Set this LockableFiles to not clear the physical lock on unlock."""
250
157
        self._lock.leave_in_place()
307
214
        """Setup a write transaction."""
308
215
        self._set_transaction(transactions.WriteTransaction())
309
216
 
 
217
    @only_raises(errors.LockNotHeld, errors.LockBroken)
310
218
    def unlock(self):
311
219
        if not self._lock_mode:
312
220
            return lock.cant_unlock_not_held(self)