← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/atomicfile.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

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