← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/atomicfile.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-31 16:12:57 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060731161257-91a231523255332c
new official bzr.ico

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
 
 
18
 
import codecs
19
17
import errno
20
18
import os
21
 
import stat
22
 
import socket
23
 
import sys
24
 
import warnings
25
19
 
26
 
from bzrlib import (
27
 
    errors,
28
 
    osutils,
29
 
    symbol_versioning,
30
 
    )
 
20
from warnings import warn
31
21
from bzrlib.osutils import rename
32
22
 
33
 
# not forksafe - but we dont fork.
34
 
_pid = os.getpid()
35
 
_hostname = socket.gethostname()
36
 
 
37
 
 
38
23
class AtomicFile(object):
39
24
    """A file that does an atomic-rename to move into place.
40
25
 
42
27
 
43
28
    Open this as for a regular file, then use commit() to move into
44
29
    place or abort() to cancel.
 
30
 
 
31
    An encoding can be specified; otherwise the default is ascii.
45
32
    """
46
33
 
47
 
    __slots__ = ['tmpfilename', 'realfilename', '_fd']
48
 
 
49
 
    def __init__(self, filename, mode='wb', new_mode=None):
50
 
        self._fd = None
51
 
        assert mode in ('wb', 'wt'), \
52
 
            "invalid AtomicFile mode %r" % mode
53
 
 
54
 
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, _pid, _hostname)
55
 
 
 
34
    def __init__(self, filename, mode='wb', encoding=None, new_mode=None):
 
35
        if mode != 'wb' and mode != 'wt':
 
36
            raise ValueError("invalid AtomicFile mode %r" % mode)
 
37
 
 
38
        import socket
 
39
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
 
40
                                             socket.gethostname())
56
41
        self.realfilename = filename
57
42
        
58
 
        flags = os.O_EXCL | os.O_CREAT | os.O_WRONLY
59
 
        if mode == 'wb':
60
 
            flags |= osutils.O_BINARY
61
 
 
62
 
        if new_mode is not None:
63
 
            local_mode = new_mode
 
43
        if encoding:
 
44
            import codecs
 
45
            self.f = codecs.open(self.tmpfilename, mode, encoding)
64
46
        else:
65
 
            local_mode = 0666
66
 
        
67
 
        # Use a low level fd operation to avoid chmodding later.
68
 
        # This may not succeed, but it should help most of the time
69
 
        self._fd = os.open(self.tmpfilename, flags, local_mode)
70
 
 
71
 
        if new_mode is not None:
72
 
            # Because of umask issues, we may need to chmod anyway
73
 
            # the common case is that we won't, though.
74
 
            st = os.fstat(self._fd)
75
 
            if stat.S_IMODE(st.st_mode) != new_mode:
76
 
                os.chmod(self.tmpfilename, new_mode)
77
 
 
78
 
    def _get_closed(self):
79
 
        symbol_versioning.warn('AtomicFile.closed deprecated in bzr 0.10',
80
 
                               DeprecationWarning, stacklevel=2)
81
 
        return self._fd is None
82
 
 
83
 
    closed = property(_get_closed)
 
47
            self.f = open(self.tmpfilename, mode)
 
48
 
 
49
        self.write = self.f.write
 
50
        self.closed = False
 
51
        self._new_mode = new_mode
 
52
 
84
53
 
85
54
    def __repr__(self):
86
55
        return '%s(%r)' % (self.__class__.__name__,
87
56
                           self.realfilename)
88
 
 
89
 
    def write(self, data):
90
 
        """Write some data to the file. Like file.write()"""
91
 
        os.write(self._fd, data)
92
 
 
93
 
    def _close_tmpfile(self, func_name):
94
 
        """Close the local temp file in preparation for commit or abort"""
95
 
        if self._fd is None:
96
 
            raise errors.AtomicFileAlreadyClosed(path=self.realfilename,
97
 
                                                 function=func_name)
98
 
        fd = self._fd
99
 
        self._fd = None
100
 
        os.close(fd)
 
57
    
101
58
 
102
59
    def commit(self):
103
60
        """Close the file and move to final name."""
104
 
        self._close_tmpfile('commit')
 
61
 
 
62
        if self.closed:
 
63
            raise Exception('%r is already closed' % self)
 
64
 
 
65
        self.closed = True
 
66
        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
 
105
78
        rename(self.tmpfilename, self.realfilename)
106
79
 
 
80
 
107
81
    def abort(self):
108
82
        """Discard temporary file without committing changes."""
109
 
        self._close_tmpfile('abort')
 
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
110
90
        os.remove(self.tmpfilename)
111
91
 
 
92
 
112
93
    def close(self):
113
94
        """Discard the file unless already committed."""
114
 
        if self._fd is not None:
 
95
        if not self.closed:
115
96
            self.abort()
116
97
 
 
98
 
117
99
    def __del__(self):
118
 
        if self._fd is not None:
119
 
            warnings.warn("%r leaked" % self)
 
100
        if hasattr(self, 'closed') and not self.closed:
 
101
            warn("%r leaked" % self)
 
102