/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/atomicfile.py

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/atomicfile.py
1
 
# Copyright (C) 2005, 2006, 2008, 2009, 2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2004, 2005 by 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
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
import os
18
 
 
19
 
import stat
20
 
 
21
 
from breezy import (
22
 
    errors,
23
 
    osutils,
24
 
    )
25
 
 
26
 
# not forksafe - but we dont fork.
27
 
_pid = os.getpid()
28
 
_hostname = None
29
 
 
30
 
 
31
 
class AtomicFileAlreadyClosed(errors.PathError):
32
 
 
33
 
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
34
 
            ' "%(path)s"')
35
 
 
36
 
    def __init__(self, path, function):
37
 
        errors.PathError.__init__(self, path=path, extra=None)
38
 
        self.function = function
39
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
 
 
19
from warnings import warn
 
20
from osutils import rename
 
21
import errno
40
22
 
41
23
class AtomicFile(object):
42
24
    """A file that does an atomic-rename to move into place.
45
27
 
46
28
    Open this as for a regular file, then use commit() to move into
47
29
    place or abort() to cancel.
 
30
 
 
31
    An encoding can be specified; otherwise the default is ascii.
48
32
    """
49
33
 
50
 
    __slots__ = ['tmpfilename', 'realfilename', '_fd']
51
 
 
52
 
    def __init__(self, filename, mode='wb', new_mode=None):
53
 
        global _hostname
54
 
 
55
 
        self._fd = None
56
 
 
57
 
        if _hostname is None:
58
 
            _hostname = osutils.get_host_name()
59
 
 
60
 
        self.tmpfilename = '%s.%d.%s.%s.tmp' % (filename, _pid, _hostname,
61
 
                                                osutils.rand_chars(10))
62
 
 
 
34
    def __init__(self, filename, mode='wb', encoding=None):
 
35
        if mode != 'wb' and mode != 'wt':
 
36
            raise ValueError("invalid AtomicFile mode %r" % mode)
 
37
 
 
38
        import os, socket
 
39
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
 
40
                                             socket.gethostname())
63
41
        self.realfilename = filename
64
 
 
65
 
        flags = os.O_EXCL | os.O_CREAT | os.O_WRONLY | osutils.O_NOINHERIT
66
 
        if mode == 'wb':
67
 
            flags |= osutils.O_BINARY
68
 
        elif mode != 'wt':
69
 
            raise ValueError("invalid AtomicFile mode %r" % mode)
70
 
 
71
 
        if new_mode is not None:
72
 
            local_mode = new_mode
 
42
        
 
43
        if encoding:
 
44
            import codecs
 
45
            self.f = codecs.open(self.tmpfilename, mode, encoding)
73
46
        else:
74
 
            local_mode = 0o666
75
 
 
76
 
        # Use a low level fd operation to avoid chmodding later.
77
 
        # This may not succeed, but it should help most of the time
78
 
        self._fd = os.open(self.tmpfilename, flags, local_mode)
79
 
 
80
 
        if new_mode is not None:
81
 
            # Because of umask issues, we may need to chmod anyway
82
 
            # the common case is that we won't, though.
83
 
            st = os.fstat(self._fd)
84
 
            if stat.S_IMODE(st.st_mode) != new_mode:
85
 
                osutils.chmod_if_possible(self.tmpfilename, new_mode)
 
47
            self.f = open(self.tmpfilename, mode)
 
48
 
 
49
        self.write = self.f.write
 
50
        self.closed = False
 
51
 
86
52
 
87
53
    def __repr__(self):
88
54
        return '%s(%r)' % (self.__class__.__name__,
89
55
                           self.realfilename)
90
 
 
91
 
    def write(self, data):
92
 
        """Write some data to the file. Like file.write()"""
93
 
        os.write(self._fd, data)
94
 
 
95
 
    def _close_tmpfile(self, func_name):
96
 
        """Close the local temp file in preparation for commit or abort"""
97
 
        if self._fd is None:
98
 
            raise AtomicFileAlreadyClosed(path=self.realfilename,
99
 
                                          function=func_name)
100
 
        fd = self._fd
101
 
        self._fd = None
102
 
        os.close(fd)
 
56
    
103
57
 
104
58
    def commit(self):
105
59
        """Close the file and move to final name."""
106
 
        self._close_tmpfile('commit')
107
 
        osutils.rename(self.tmpfilename, self.realfilename)
 
60
        import sys, os
 
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
            stat = os.lstat(self.realfilename)
 
71
            os.chmod(self.tmpfilename, stat.st_mode)
 
72
        except OSError, e:
 
73
            if e.errno != errno.ENOENT:
 
74
                raise
 
75
        rename(self.tmpfilename, self.realfilename)
 
76
 
108
77
 
109
78
    def abort(self):
110
79
        """Discard temporary file without committing changes."""
111
 
        self._close_tmpfile('abort')
 
80
        import os
 
81
 
 
82
        if self.closed:
 
83
            raise Exception('%r is already closed' % self)
 
84
 
 
85
        self.closed = True
 
86
        self.f.close()
 
87
        self.f = None
112
88
        os.remove(self.tmpfilename)
113
89
 
 
90
 
114
91
    def close(self):
115
92
        """Discard the file unless already committed."""
116
 
        if self._fd is not None:
117
 
            self.abort()
118
 
 
119
 
    def __enter__(self):
120
 
        return self
121
 
 
122
 
    def __exit__(self, exc_type, exc_val, exc_tb):
123
 
        if exc_type:
124
 
            self.abort()
125
 
            return False
126
 
        self.commit()
 
93
        if not self.closed:
 
94
            self.abort()
 
95
 
 
96
 
 
97
    def __del__(self):
 
98
        if hasattr(self, 'closed') and not self.closed:
 
99
            warn("%r leaked" % self)
 
100