← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« 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) 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
 
 
18
 
 
19
from warnings import warn
 
20
from osutils import rename
 
21
import errno
 
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):
 
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())
 
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
 
 
52
 
 
53
    def __repr__(self):
 
54
        return '%s(%r)' % (self.__class__.__name__,
 
55
                           self.realfilename)
 
56
    
 
57
 
 
58
    def commit(self):
 
59
        """Close the file and move to final name."""
 
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
 
 
77
 
 
78
    def abort(self):
 
79
        """Discard temporary file without committing changes."""
 
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
 
88
        os.remove(self.tmpfilename)
 
89
 
 
90
 
 
91
    def close(self):
 
92
        """Discard the file unless already committed."""
 
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