/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) 2004, 2005 by 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
import errno
 
18
import os
 
19
 
 
20
from warnings import warn
 
21
from bzrlib.osutils import rename
 
22
 
 
23
class AtomicFile(object):
 
24
    """A file that does an atomic-rename to move into place.
 
25
 
 
26
    This also causes hardlinks to break when it's written out.
 
27
 
 
28
    Open this as for a regular file, then use commit() to move into
 
29
    place or abort() to cancel.
 
30
 
 
31
    An encoding can be specified; otherwise the default is ascii.
 
32
    """
 
33
 
 
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())
 
41
        self.realfilename = filename
 
42
        
 
43
        if encoding:
 
44
            import codecs
 
45
            self.f = codecs.open(self.tmpfilename, mode, encoding)
 
46
        else:
 
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
 
 
53
 
 
54
    def __repr__(self):
 
55
        return '%s(%r)' % (self.__class__.__name__,
 
56
                           self.realfilename)
 
57
    
 
58
 
 
59
    def commit(self):
 
60
        """Close the file and move to final name."""
 
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
 
 
80
 
 
81
    def abort(self):
 
82
        """Discard temporary file without committing changes."""
 
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
 
90
        os.remove(self.tmpfilename)
 
91
 
 
92
 
 
93
    def close(self):
 
94
        """Discard the file unless already committed."""
 
95
        if not self.closed:
 
96
            self.abort()
 
97
 
 
98
 
 
99
    def __del__(self):
 
100
        if hasattr(self, 'closed') and not self.closed:
 
101
            warn("%r leaked" % self)
 
102