← 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-04-15 01:31:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050415013121-b18f1be12a735066
- Doc cleanups from Magnus Therning

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
 
from warnings import warn
20
 
 
21
 
 
22
 
class AtomicFile(object):
23
 
    """A file that does an atomic-rename to move into place.
24
 
 
25
 
    This also causes hardlinks to break when it's written out.
26
 
 
27
 
    Open this as for a regular file, then use commit() to move into
28
 
    place or abort() to cancel.
29
 
 
30
 
    An encoding can be specified; otherwise the default is ascii.
31
 
    """
32
 
 
33
 
    def __init__(self, filename, mode='wb', encoding=None):
34
 
        if mode != 'wb' and mode != 'wt':
35
 
            raise ValueError("invalid AtomicFile mode %r" % mode)
36
 
 
37
 
        import os, socket
38
 
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
39
 
                                             socket.gethostname())
40
 
        self.realfilename = filename
41
 
        
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
 
 
48
 
        self.write = self.f.write
49
 
        self.closed = False
50
 
 
51
 
 
52
 
    def __repr__(self):
53
 
        return '%s(%r)' % (self.__class__.__name__,
54
 
                           self.realfilename)
55
 
    
56
 
 
57
 
    def commit(self):
58
 
        """Close the file and move to final name."""
59
 
        import sys, os
60
 
        
61
 
        if self.closed:
62
 
            raise Exception('%r is already closed' % self)
63
 
 
64
 
        self.closed = True
65
 
        self.f.close()
66
 
        self.f = None
67
 
        
68
 
        if sys.platform == 'win32':
69
 
            # windows cannot rename over an existing file
70
 
            try:
71
 
                os.remove(self.realfilename)
72
 
            except OSError, e:
73
 
                import errno
74
 
                if e.errno != errno.ENOENT:
75
 
                    raise
76
 
                
77
 
        os.rename(self.tmpfilename, self.realfilename)
78
 
 
79
 
 
80
 
    def abort(self):
81
 
        """Discard temporary file without committing changes."""
82
 
        import os
83
 
 
84
 
        if self.closed:
85
 
            raise Exception('%r is already closed' % self)
86
 
 
87
 
        self.closed = True
88
 
        self.f.close()
89
 
        self.f = None
90
 
        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 not self.closed:
101
 
            warn("%r leaked" % self)
102