/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: John Arbash Meinel
  • Date: 2006-07-18 18:57:54 UTC
  • mto: This revision was merged to the branch mainline in revision 1868.
  • Revision ID: john@arbash-meinel.com-20060718185754-4007745748e28db9
Commit timestamp restricted to 1ms precision.

The old code would restrict to 1s resolution if the timestamp was
supplied, while it preserved full resolution if the timestamp was
auto generated. Now both paths preserve only 1ms resolution.

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
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
import errno
18
18
import os
19
19
 
20
 
from bzrlib.lazy_import import lazy_import
21
 
lazy_import(globals(), """
22
 
import stat
23
 
import socket
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
 
 
 
20
from warnings import warn
 
21
from bzrlib.osutils import rename
37
22
 
38
23
class AtomicFile(object):
39
24
    """A file that does an atomic-rename to move into place.
42
27
 
43
28
    Open this as for a regular file, then use commit() to move into
44
29
    place or abort() to cancel.
 
30
 
 
31
    An encoding can be specified; otherwise the default is ascii.
45
32
    """
46
33
 
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
 
 
 
34
    def __init__(self, filename, mode='wb', encoding=None, new_mode=None):
 
35
        if mode != 'wb' and mode != 'wt':
 
36
            raise ValueError("invalid AtomicFile mode %r" % mode)
 
37
 
 
38
        import socket
 
39
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
 
40
                                             socket.gethostname())
60
41
        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':
66
 
            raise ValueError("invalid AtomicFile mode %r" % mode)
67
 
 
68
 
        if new_mode is not None:
69
 
            local_mode = new_mode
 
42
        
 
43
        if encoding:
 
44
            import codecs
 
45
            self.f = codecs.open(self.tmpfilename, mode, encoding)
70
46
        else:
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
 
                os.chmod(self.tmpfilename, new_mode)
83
 
 
84
 
    def _get_closed(self):
85
 
        symbol_versioning.warn('AtomicFile.closed deprecated in bzr 0.10',
86
 
                               DeprecationWarning, stacklevel=2)
87
 
        return self._fd is None
88
 
 
89
 
    closed = property(_get_closed)
 
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
 
90
53
 
91
54
    def __repr__(self):
92
55
        return '%s(%r)' % (self.__class__.__name__,
93
56
                           self.realfilename)
94
 
 
95
 
    def write(self, data):
96
 
        """Write some data to the file. Like file.write()"""
97
 
        os.write(self._fd, data)
98
 
 
99
 
    def _close_tmpfile(self, func_name):
100
 
        """Close the local temp file in preparation for commit or abort"""
101
 
        if self._fd is None:
102
 
            raise errors.AtomicFileAlreadyClosed(path=self.realfilename,
103
 
                                                 function=func_name)
104
 
        fd = self._fd
105
 
        self._fd = None
106
 
        os.close(fd)
 
57
    
107
58
 
108
59
    def commit(self):
109
60
        """Close the file and move to final name."""
110
 
        self._close_tmpfile('commit')
111
 
        osutils.rename(self.tmpfilename, self.realfilename)
 
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
            if self._new_mode is None:
 
71
                self._new_mode = os.lstat(self.realfilename).st_mode
 
72
        except OSError, e:
 
73
            if e.errno != errno.ENOENT:
 
74
                raise
 
75
        else:
 
76
            os.chmod(self.tmpfilename, self._new_mode)
 
77
 
 
78
        rename(self.tmpfilename, self.realfilename)
 
79
 
112
80
 
113
81
    def abort(self):
114
82
        """Discard temporary file without committing changes."""
115
 
        self._close_tmpfile('abort')
 
83
 
 
84
        if self.closed:
 
85
            raise Exception('%r is already closed' % self)
 
86
 
 
87
        self.closed = True
 
88
        self.f.close()
 
89
        self.f = None
116
90
        os.remove(self.tmpfilename)
117
91
 
 
92
 
118
93
    def close(self):
119
94
        """Discard the file unless already committed."""
120
 
        if self._fd is not None:
 
95
        if not self.closed:
121
96
            self.abort()
122
97
 
 
98
 
123
99
    def __del__(self):
124
 
        if self._fd is not None:
125
 
            warnings.warn("%r leaked" % self)
 
100
        if hasattr(self, 'closed') and not self.closed:
 
101
            warn("%r leaked" % self)
 
102