← 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-16 02:19:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050516021913-3a933f871079e3fe
- patch from ddaa to create api/ directory 
  before building API docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/atomicfile.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
import errno
18
 
import os
19
 
 
20
 
from warnings import warn
21
 
from bzrlib.osutils import rename
22
 
 
23
 
class AtomicFile(object):
 
17
 
 
18
 
 
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.
31
27
    An encoding can be specified; otherwise the default is ascii.
32
28
    """
33
29
 
34
 
    def __init__(self, filename, mode='wb', encoding=None, new_mode=None):
 
30
    def __init__(self, filename, mode='wb', encoding=None):
35
31
        if mode != 'wb' and mode != 'wt':
36
32
            raise ValueError("invalid AtomicFile mode %r" % mode)
37
33
 
38
 
        import socket
 
34
        import os, socket
39
35
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
40
36
                                             socket.gethostname())
41
37
        self.realfilename = filename
42
38
        
 
39
        self.f = open(self.tmpfilename, mode)
 
40
 
43
41
        if encoding:
44
42
            import codecs
45
 
            self.f = codecs.open(self.tmpfilename, mode, encoding)
46
 
        else:
47
 
            self.f = open(self.tmpfilename, mode)
48
 
 
 
43
            self.f = codecs.EncodedFile(self.f, encoding)
 
44
        
49
45
        self.write = self.f.write
50
 
        self.closed = False
51
 
        self._new_mode = new_mode
52
 
 
53
 
 
54
 
    def __repr__(self):
55
 
        return '%s(%r)' % (self.__class__.__name__,
56
 
                           self.realfilename)
57
 
    
 
46
        self.closed = property(self.f.closed)
58
47
 
59
48
    def commit(self):
60
 
        """Close the file and move to final name."""
61
 
 
62
 
        if self.closed:
63
 
            raise Exception('%r is already closed' % self)
64
 
 
65
 
        self.closed = True
 
49
        import sys, os
 
50
        
66
51
        self.f.close()
67
 
        self.f = None
68
 
        
69
 
        try:
70
 
            if self._new_mode is None:
71
 
                self._new_mode = os.lstat(self.realfilename).st_mode
72
 
        except OSError, e:
73
 
            if e.errno != errno.ENOENT:
74
 
                raise
75
 
        else:
76
 
            os.chmod(self.tmpfilename, self._new_mode)
77
 
 
78
 
        rename(self.tmpfilename, self.realfilename)
79
 
 
 
52
        if sys.platform == 'win32':
 
53
            os.remove(self.realfilename)
 
54
        os.rename(self.tmpfilename, self.realfilename)
80
55
 
81
56
    def abort(self):
82
 
        """Discard temporary file without committing changes."""
83
 
 
84
 
        if self.closed:
85
 
            raise Exception('%r is already closed' % self)
86
 
 
87
 
        self.closed = True
 
57
        import os
88
58
        self.f.close()
89
 
        self.f = None
90
59
        os.remove(self.tmpfilename)
91
 
 
92
 
 
93
 
    def close(self):
94
 
        """Discard the file unless already committed."""
95
 
        if not self.closed:
96
 
            self.abort()
97
 
 
98
 
 
99
 
    def __del__(self):
100
 
        if hasattr(self, 'closed') and not self.closed:
101
 
            warn("%r leaked" % self)
 
60
        
102
61