1
# Copyright (C) 2004, 2005 by Canonical Ltd
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.
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.
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
20
"""A file that does an atomic-rename to move into place.
22
This also causes hardlinks to break when it's written out.
24
Open this as for a regular file, then use commit() to move into
25
place or abort() to cancel.
27
An encoding can be specified; otherwise the default is ascii.
30
def __init__(self, filename, mode='wb', encoding=None):
31
if mode != 'wb' and mode != 'wt':
32
raise ValueError("invalid AtomicFile mode %r" % mode)
35
self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
37
self.realfilename = filename
39
self.f = open(self.tmpfilename, mode)
43
self.f = codecs.EncodedFile(self.f, encoding)
45
self.write = self.f.write
46
self.closed = property(self.f.closed)
49
"""Close the file and move to final name."""
53
if sys.platform == 'win32':
54
os.remove(self.realfilename)
55
os.rename(self.tmpfilename, self.realfilename)
58
"""Discard temporary file without committing changes."""
61
os.remove(self.tmpfilename)
64
"""Discard the file unless already committed."""