← 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-02 22:47:02 UTC
  • mto: This revision was merged to the branch mainline in revision 1397.
  • Revision ID: robertc@robertcollins.net-20051002224701-8a8b20b90de559a6
support ghosts in commits

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/atomicfile.py
1
1
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
#
 
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
 
import codecs
19
 
import errno
20
 
import os
21
 
import stat
22
 
import socket
23
 
import sys
24
 
import warnings
25
 
 
26
 
from bzrlib import (
27
 
    errors,
28
 
    osutils,
29
 
    symbol_versioning,
30
 
    )
31
 
from bzrlib.osutils import rename
32
 
 
33
 
# not forksafe - but we dont fork.
34
 
_pid = os.getpid()
35
 
_hostname = socket.gethostname()
36
 
 
 
18
 
 
19
from warnings import warn
 
20
from osutils import rename
37
21
 
38
22
class AtomicFile(object):
39
23
    """A file that does an atomic-rename to move into place.
42
26
 
43
27
    Open this as for a regular file, then use commit() to move into
44
28
    place or abort() to cancel.
 
29
 
 
30
    An encoding can be specified; otherwise the default is ascii.
45
31
    """
46
32
 
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
 
 
 
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())
56
40
        self.realfilename = filename
57
41
        
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
 
42
        if encoding:
 
43
            import codecs
 
44
            self.f = codecs.open(self.tmpfilename, mode, encoding)
64
45
        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)
 
46
            self.f = open(self.tmpfilename, mode)
 
47
 
 
48
        self.write = self.f.write
 
49
        self.closed = False
 
50
 
84
51
 
85
52
    def __repr__(self):
86
53
        return '%s(%r)' % (self.__class__.__name__,
87
54
                           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)
 
55
    
101
56
 
102
57
    def commit(self):
103
58
        """Close the file and move to final name."""
104
 
        self._close_tmpfile('commit')
 
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
        
105
68
        rename(self.tmpfilename, self.realfilename)
106
69
 
 
70
 
107
71
    def abort(self):
108
72
        """Discard temporary file without committing changes."""
109
 
        self._close_tmpfile('abort')
 
73
        import os
 
74
 
 
75
        if self.closed:
 
76
            raise Exception('%r is already closed' % self)
 
77
 
 
78
        self.closed = True
 
79
        self.f.close()
 
80
        self.f = None
110
81
        os.remove(self.tmpfilename)
111
82
 
 
83
 
112
84
    def close(self):
113
85
        """Discard the file unless already committed."""
114
 
        if self._fd is not None:
 
86
        if not self.closed:
115
87
            self.abort()
116
88
 
 
89
 
117
90
    def __del__(self):
118
 
        if self._fd is not None:
119
 
            warnings.warn("%r leaked" % self)
 
91
        if hasattr(self, 'closed') and not self.closed:
 
92
            warn("%r leaked" % self)
 
93