19
from warnings import warn
20
from bzrlib.osutils import rename
23
class AtomicFile(object):
20
24
"""A file that does an atomic-rename to move into place.
22
26
This also causes hardlinks to break when it's written out.
27
31
An encoding can be specified; otherwise the default is ascii.
30
def __init__(self, filename, mode='wb', encoding=None):
34
def __init__(self, filename, mode='wb', encoding=None, new_mode=None):
31
35
if mode != 'wb' and mode != 'wt':
32
36
raise ValueError("invalid AtomicFile mode %r" % mode)
36
40
socket.gethostname())
37
41
self.realfilename = filename
39
self.f = open(self.tmpfilename, mode)
43
self.f = codecs.EncodedFile(self.f, encoding)
45
self.f = codecs.open(self.tmpfilename, mode, encoding)
47
self.f = open(self.tmpfilename, mode)
45
49
self.write = self.f.write
46
self.closed = property(self.f.closed)
51
self._new_mode = new_mode
55
return '%s(%r)' % (self.__class__.__name__,
49
60
"""Close the file and move to final name."""
64
raise Exception('%r is already closed' % self)
53
if sys.platform == 'win32':
54
os.remove(self.realfilename)
55
os.rename(self.tmpfilename, self.realfilename)
71
if self._new_mode is None:
72
self._new_mode = os.lstat(self.realfilename).st_mode
74
if e.errno != errno.ENOENT:
77
os.chmod(self.tmpfilename, self._new_mode)
79
rename(self.tmpfilename, self.realfilename)
58
83
"""Discard temporary file without committing changes."""
87
raise Exception('%r is already closed' % self)
61
92
os.remove(self.tmpfilename)
64
96
"""Discard the file unless already committed."""
65
97
if not self.closed:
102
if hasattr(self, 'closed') and not self.closed:
103
warn("%r leaked" % self)