/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 breezy/atomicfile.py

  • Committer: Jelmer Vernooij
  • Date: 2018-05-07 15:27:39 UTC
  • mto: This revision was merged to the branch mainline in revision 6958.
  • Revision ID: jelmer@jelmer.uk-20180507152739-fuv9z9r0yzi7ln3t
Specify source in .coveragerc.

Show diffs side-by-side

added added

removed removed

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