← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/atomicfile.py

  • Committer: Ian Clatworthy
  • Date: 2009-01-19 02:24:15 UTC
  • mto: This revision was merged to the branch mainline in revision 3944.
  • Revision ID: ian.clatworthy@canonical.com-20090119022415-mo0mcfeiexfktgwt
apply jam's log --short fix (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/atomicfile.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2004, 2005 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
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
17
 
18
 
 
19
 
from warnings import warn
20
 
from bzrlib.osutils import rename
21
 
import errno
 
18
import os
 
19
import sys
 
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
 
23
import stat
 
24
import socket
 
25
import warnings
 
26
 
 
27
from bzrlib import (
 
28
    errors,
 
29
    osutils,
 
30
    symbol_versioning,
 
31
    )
 
32
""")
 
33
 
 
34
# not forksafe - but we dont fork.
 
35
_pid = os.getpid()
 
36
_hostname = None
 
37
 
22
38
 
23
39
class AtomicFile(object):
24
40
    """A file that does an atomic-rename to move into place.
27
43
 
28
44
    Open this as for a regular file, then use commit() to move into
29
45
    place or abort() to cancel.
30
 
 
31
 
    An encoding can be specified; otherwise the default is ascii.
32
46
    """
33
47
 
34
 
    def __init__(self, filename, mode='wb', encoding=None, new_mode=None):
35
 
        if mode != 'wb' and mode != 'wt':
 
48
    __slots__ = ['tmpfilename', 'realfilename', '_fd']
 
49
 
 
50
    def __init__(self, filename, mode='wb', new_mode=None):
 
51
        global _hostname
 
52
 
 
53
        self._fd = None
 
54
 
 
55
        if _hostname is None:
 
56
            _hostname = osutils.get_host_name()
 
57
 
 
58
        self.tmpfilename = '%s.%d.%s.%s.tmp' % (filename, _pid, _hostname,
 
59
                                                osutils.rand_chars(10))
 
60
 
 
61
        self.realfilename = filename
 
62
        
 
63
        flags = os.O_EXCL | os.O_CREAT | os.O_WRONLY
 
64
        if mode == 'wb':
 
65
            flags |= osutils.O_BINARY
 
66
        elif mode != 'wt':
36
67
            raise ValueError("invalid AtomicFile mode %r" % mode)
37
68
 
38
 
        import os, socket
39
 
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
40
 
                                             socket.gethostname())
41
 
        self.realfilename = filename
 
69
        if new_mode is not None:
 
70
            local_mode = new_mode
 
71
        else:
 
72
            local_mode = 0666
42
73
        
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
 
 
49
 
        self.write = self.f.write
50
 
        self.closed = False
51
 
        self._new_mode = new_mode
52
 
 
 
74
        # Use a low level fd operation to avoid chmodding later.
 
75
        # This may not succeed, but it should help most of the time
 
76
        self._fd = os.open(self.tmpfilename, flags, local_mode)
 
77
 
 
78
        if new_mode is not None:
 
79
            # Because of umask issues, we may need to chmod anyway
 
80
            # the common case is that we won't, though.
 
81
            st = os.fstat(self._fd)
 
82
            if stat.S_IMODE(st.st_mode) != new_mode:
 
83
                os.chmod(self.tmpfilename, new_mode)
 
84
 
 
85
    def _get_closed(self):
 
86
        symbol_versioning.warn('AtomicFile.closed deprecated in bzr 0.10',
 
87
                               DeprecationWarning, stacklevel=2)
 
88
        return self._fd is None
 
89
 
 
90
    closed = property(_get_closed)
53
91
 
54
92
    def __repr__(self):
55
93
        return '%s(%r)' % (self.__class__.__name__,
56
94
                           self.realfilename)
57
 
    
 
95
 
 
96
    def write(self, data):
 
97
        """Write some data to the file. Like file.write()"""
 
98
        os.write(self._fd, data)
 
99
 
 
100
    def _close_tmpfile(self, func_name):
 
101
        """Close the local temp file in preparation for commit or abort"""
 
102
        if self._fd is None:
 
103
            raise errors.AtomicFileAlreadyClosed(path=self.realfilename,
 
104
                                                 function=func_name)
 
105
        fd = self._fd
 
106
        self._fd = None
 
107
        os.close(fd)
58
108
 
59
109
    def commit(self):
60
110
        """Close the file and move to final name."""
61
 
        import sys, os
62
 
        
63
 
        if self.closed:
64
 
            raise Exception('%r is already closed' % self)
65
 
 
66
 
        self.closed = True
67
 
        self.f.close()
68
 
        self.f = None
69
 
        
70
 
        try:
71
 
            if self._new_mode is None:
72
 
                self._new_mode = os.lstat(self.realfilename).st_mode
73
 
        except OSError, e:
74
 
            if e.errno != errno.ENOENT:
75
 
                raise
76
 
        else:
77
 
            os.chmod(self.tmpfilename, self._new_mode)
78
 
 
79
 
        rename(self.tmpfilename, self.realfilename)
80
 
 
 
111
        self._close_tmpfile('commit')
 
112
        osutils.rename(self.tmpfilename, self.realfilename)
81
113
 
82
114
    def abort(self):
83
115
        """Discard temporary file without committing changes."""
84
 
        import os
85
 
 
86
 
        if self.closed:
87
 
            raise Exception('%r is already closed' % self)
88
 
 
89
 
        self.closed = True
90
 
        self.f.close()
91
 
        self.f = None
 
116
        self._close_tmpfile('abort')
92
117
        os.remove(self.tmpfilename)
93
118
 
94
 
 
95
119
    def close(self):
96
120
        """Discard the file unless already committed."""
97
 
        if not self.closed:
 
121
        if self._fd is not None:
98
122
            self.abort()
99
123
 
100
 
 
101
124
    def __del__(self):
102
 
        if hasattr(self, 'closed') and not self.closed:
103
 
            warn("%r leaked" % self)
104
 
        
 
125
        if self._fd is not None:
 
126
            warnings.warn("%r leaked" % self)