← 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-09 06:09:42 UTC
  • Revision ID: mbp@sourcefrog.net-20050509060942-d9c9efd7feed0894
- more indicators at top of test output
- tidy up remotebranch stuff

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/atomicfile.py
 
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
    You may wish to wrap this in a codecs.EncodedFile to do unicode
 
28
    encoding.
 
29
    """
 
30
 
 
31
    def __init__(self, filename, mode='wb'):
 
32
        if mode != 'wb' and mode != 'wt':
 
33
            raise ValueError("invalid AtomicFile mode %r" % mode)
 
34
 
 
35
        import os, socket
 
36
        self.tmpfilename = '%s.tmp.%d.%s' % (filename, os.getpid(),
 
37
                                             socket.gethostname())
 
38
        self.realfilename = filename
 
39
        
 
40
        self.f = open(self.tmpfilename, mode)
 
41
        self.write = self.f.write
 
42
 
 
43
    def commit(self):
 
44
        import sys, os
 
45
        
 
46
        self.f.close()
 
47
        if sys.platform == 'win32':
 
48
            os.remove(self.realfilename)
 
49
        os.rename(self.tmpfilename, self.realfilename)
 
50
 
 
51
    def abort(self):
 
52
        import os
 
53
        self.f.close()
 
54
        os.remove(self.tmpfilename)
 
55