← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/atomicfile.py

  • Committer: Martin Pool
  • Date: 2005-05-17 06:56:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050517065616-6f23381d6184a8aa
- add space for un-merged patches

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/atomicfile.py
16
16
 
17
17
 
18
18
 
19
 
from warnings import warn
20
 
from bzrlib.osutils import rename
21
 
import errno
22
 
 
23
 
class AtomicFile(object):
 
19
class AtomicFile:
24
20
    """A file that does an atomic-rename to move into place.
25
21
 
26
22
    This also causes hardlinks to break when it's written out.
31
27
    An encoding can be specified; otherwise the default is ascii.
32
28
    """
33
29
 
34
 
    def __init__(self, filename, mode='wb', encoding=None, new_mode=None):
 
30
    def __init__(self, filename, mode='wb', encoding=None):
35
31
        if mode != 'wb' and mode != 'wt':
36
32
            raise ValueError("invalid AtomicFile mode %r" % mode)
37
33
 
40
36
                                             socket.gethostname())
41
37
        self.realfilename = filename
42
38
        
 
39
        self.f = open(self.tmpfilename, mode)
 
40
 
43
41
        if encoding:
44
42
            import codecs
45
 
            self.f = codecs.open(self.tmpfilename, mode, encoding)
46
 
        else:
47
 
            self.f = open(self.tmpfilename, mode)
48
 
 
 
43
            self.f = codecs.EncodedFile(self.f, encoding)
 
44
        
49
45
        self.write = self.f.write
50
 
        self.closed = False
51
 
        self._new_mode = new_mode
52
 
 
53
 
 
54
 
    def __repr__(self):
55
 
        return '%s(%r)' % (self.__class__.__name__,
56
 
                           self.realfilename)
57
 
    
 
46
        self.closed = property(self.f.closed)
58
47
 
59
48
    def commit(self):
60
49
        """Close the file and move to final name."""
61
50
        import sys, os
62
51
        
63
 
        if self.closed:
64
 
            raise Exception('%r is already closed' % self)
65
 
 
66
 
        self.closed = True
67
52
        self.f.close()
68
 
        self.f = None
69
 
        
70
 
        try:
71
 
            if self._new_mode is None:
72
 
                self._new_mode = os.lstat(self.realfilename).st_mode
73
 
        except OSError, e:
74
 
            if e.errno != errno.ENOENT:
75
 
                raise
76
 
        else:
77
 
            os.chmod(self.tmpfilename, self._new_mode)
78
 
 
79
 
        rename(self.tmpfilename, self.realfilename)
80
 
 
 
53
        if sys.platform == 'win32':
 
54
            os.remove(self.realfilename)
 
55
        os.rename(self.tmpfilename, self.realfilename)
81
56
 
82
57
    def abort(self):
83
58
        """Discard temporary file without committing changes."""
84
59
        import os
85
 
 
86
 
        if self.closed:
87
 
            raise Exception('%r is already closed' % self)
88
 
 
89
 
        self.closed = True
90
60
        self.f.close()
91
 
        self.f = None
92
61
        os.remove(self.tmpfilename)
93
62
 
94
 
 
95
63
    def close(self):
96
64
        """Discard the file unless already committed."""
97
65
        if not self.closed:
98
66
            self.abort()
99
 
 
100
 
 
101
 
    def __del__(self):
102
 
        if hasattr(self, 'closed') and not self.closed:
103
 
            warn("%r leaked" % self)
 
67
        
104
68