~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/atomicfile.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-07 06:16:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050407061602-6b7da239ef883b0817b7fcd3
more XML performance tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 by 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
 
19
 
class AtomicFile:
20
 
    """A file that does an atomic-rename to move into place.
21
 
 
22
 
    This also causes hardlinks to break when it's written out.
23
 
 
24
 
    Open this as for a regular file, then use commit() to move into
25
 
    place or abort() to cancel.
26
 
 
27
 
    An encoding can be specified; otherwise the default is ascii.
28
 
    """
29
 
 
30
 
    def __init__(self, filename, mode='wb', encoding=None):
31
 
        if mode != 'wb' and mode != 'wt':
32
 
            raise ValueError("invalid AtomicFile mode %r" % mode)
33
 
 
34
 
        import os, socket
35
 
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
36
 
                                             socket.gethostname())
37
 
        self.realfilename = filename
38
 
        
39
 
        self.f = open(self.tmpfilename, mode)
40
 
 
41
 
        if encoding:
42
 
            import codecs
43
 
            self.f = codecs.EncodedFile(self.f, encoding)
44
 
        
45
 
        self.write = self.f.write
46
 
        self.closed = property(self.f.closed)
47
 
 
48
 
    def commit(self):
49
 
        """Close the file and move to final name."""
50
 
        import sys, os
51
 
        
52
 
        self.f.close()
53
 
        if sys.platform == 'win32':
54
 
            os.remove(self.realfilename)
55
 
        os.rename(self.tmpfilename, self.realfilename)
56
 
 
57
 
    def abort(self):
58
 
        """Discard temporary file without committing changes."""
59
 
        import os
60
 
        self.f.close()
61
 
        os.remove(self.tmpfilename)
62
 
 
63
 
    def close(self):
64
 
        """Discard the file unless already committed."""
65
 
        if not self.closed:
66
 
            self.abort()
67
 
        
68