← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/atomicfile.py

  • Committer: Robert Collins
  • Date: 2005-10-06 12:14:01 UTC
  • mfrom: (1393.1.67)
  • Revision ID: robertc@robertcollins.net-20051006121401-ce87bcb93909bbdf
merge martins latest

Show diffs side-by-side

added added

removed removed

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