← 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-10 03:55:34 UTC
  • Revision ID: mbp@sourcefrog.net-20050510035534-643062e821052ac5
- Add fortune-cookie external plugin demonstration

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 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.
28
24
    Open this as for a regular file, then use commit() to move into
29
25
    place or abort() to cancel.
30
26
 
31
 
    An encoding can be specified; otherwise the default is ascii.
 
27
    You may wish to wrap this in a codecs.EncodedFile to do unicode
 
28
    encoding.
32
29
    """
33
30
 
34
 
    def __init__(self, filename, mode='wb', encoding=None):
 
31
    def __init__(self, filename, mode='wb'):
35
32
        if mode != 'wb' and mode != 'wt':
36
33
            raise ValueError("invalid AtomicFile mode %r" % mode)
37
34
 
38
35
        import os, socket
39
 
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
 
36
        self.tmpfilename = '%s.tmp.%d.%s' % (filename, os.getpid(),
40
37
                                             socket.gethostname())
41
38
        self.realfilename = filename
42
39
        
43
 
        if encoding:
44
 
            import codecs
45
 
            self.f = codecs.open(self.tmpfilename, mode, encoding)
46
 
        else:
47
 
            self.f = open(self.tmpfilename, mode)
48
 
 
 
40
        self.f = open(self.tmpfilename, mode)
49
41
        self.write = self.f.write
50
 
        self.closed = False
51
 
 
52
 
 
53
 
    def __repr__(self):
54
 
        return '%s(%r)' % (self.__class__.__name__,
55
 
                           self.realfilename)
56
 
    
57
42
 
58
43
    def commit(self):
59
 
        """Close the file and move to final name."""
60
44
        import sys, os
61
45
        
62
 
        if self.closed:
63
 
            raise Exception('%r is already closed' % self)
64
 
 
65
 
        self.closed = True
66
46
        self.f.close()
67
 
        self.f = None
68
 
        
69
 
        try:
70
 
            stat = os.lstat(self.realfilename)
71
 
            os.chmod(self.tmpfilename, stat.st_mode)
72
 
        except OSError, e:
73
 
            if e.errno != errno.ENOENT:
74
 
                raise
75
 
        rename(self.tmpfilename, self.realfilename)
76
 
 
 
47
        if sys.platform == 'win32':
 
48
            os.remove(self.realfilename)
 
49
        os.rename(self.tmpfilename, self.realfilename)
77
50
 
78
51
    def abort(self):
79
 
        """Discard temporary file without committing changes."""
80
52
        import os
81
 
 
82
 
        if self.closed:
83
 
            raise Exception('%r is already closed' % self)
84
 
 
85
 
        self.closed = True
86
53
        self.f.close()
87
 
        self.f = None
88
54
        os.remove(self.tmpfilename)
89
 
 
90
 
 
91
 
    def close(self):
92
 
        """Discard the file unless already committed."""
93
 
        if not self.closed:
94
 
            self.abort()
95
 
 
96
 
 
97
 
    def __del__(self):
98
 
        if hasattr(self, 'closed') and not self.closed:
99
 
            warn("%r leaked" % self)
100
55