annotate Lib/tempfile.py @ 79691:05c8928362ee

Merge __next__ method link fixes with 3.3.
author Ezio Melotti <ezio.melotti@gmail.com>
date Fri, 12 Oct 2012 13:46:37 +0300
parents 588087429809
children 15a391919deb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
1 """Temporary files.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
2
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
3 This module provides generic, low- and high-level interfaces for
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
4 creating temporary files and directories. The interfaces listed
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
5 as "safe" just below can be used without fear of race conditions.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
6 Those listed as "unsafe" cannot, and are provided for backward
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
7 compatibility only.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
8
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
9 This module also provides some data items to the user:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
10
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
11 TMP_MAX - maximum number of names that will be tried before
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
12 giving up.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
13 tempdir - If this is set to a string before the first use of
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
14 any routine from this module, it will be considered as
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
15 another candidate location to store temporary files.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
16 """
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
17
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
18 __all__ = [
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
19 "NamedTemporaryFile", "TemporaryFile", # high level safe interfaces
65618
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
20 "SpooledTemporaryFile", "TemporaryDirectory",
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
21 "mkstemp", "mkdtemp", # low level safe interfaces
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
22 "mktemp", # deprecated unsafe interface
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
23 "TMP_MAX", "gettempprefix", # constants
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
24 "tempdir", "gettempdir"
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
25 ]
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
26
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
27
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
28 # Imports.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
29
66843
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
30 import warnings as _warnings
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
31 import sys as _sys
42162
a62eccb53f30 Make test_tempfile.py work. Make SpooledTempFile work in text and binary mode.
Guido van Rossum <guido@python.org>
parents: 42084
diff changeset
32 import io as _io
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
33 import os as _os
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
34 from random import Random as _Random
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
35
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
36 try:
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
37 import fcntl as _fcntl
32750
5d9f72d0843e Record that FCNTL.py has gone away; remove FCNTL hack in tempfile.py;
Tim Peters <tim.peters@gmail.com>
parents: 30890
diff changeset
38 except ImportError:
29967
a4abe17a5feb Windows fix: When PYTHONCASEOK is set, or for any other reason imports
Tim Peters <tim.peters@gmail.com>
parents: 28361
diff changeset
39 def _set_cloexec(fd):
a4abe17a5feb Windows fix: When PYTHONCASEOK is set, or for any other reason imports
Tim Peters <tim.peters@gmail.com>
parents: 28361
diff changeset
40 pass
a4abe17a5feb Windows fix: When PYTHONCASEOK is set, or for any other reason imports
Tim Peters <tim.peters@gmail.com>
parents: 28361
diff changeset
41 else:
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
42 def _set_cloexec(fd):
32750
5d9f72d0843e Record that FCNTL.py has gone away; remove FCNTL hack in tempfile.py;
Tim Peters <tim.peters@gmail.com>
parents: 30890
diff changeset
43 try:
5d9f72d0843e Record that FCNTL.py has gone away; remove FCNTL hack in tempfile.py;
Tim Peters <tim.peters@gmail.com>
parents: 30890
diff changeset
44 flags = _fcntl.fcntl(fd, _fcntl.F_GETFD, 0)
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
45 except OSError:
32750
5d9f72d0843e Record that FCNTL.py has gone away; remove FCNTL hack in tempfile.py;
Tim Peters <tim.peters@gmail.com>
parents: 30890
diff changeset
46 pass
30889
ceec69d240f0 fixed wrong error checking on fcntl call as per SF bug # 821896
Alex Martelli <aleaxit@gmail.com>
parents: 30681
diff changeset
47 else:
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
48 # flags read successfully, modify
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
49 flags |= _fcntl.FD_CLOEXEC
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
50 _fcntl.fcntl(fd, _fcntl.F_SETFD, flags)
29967
a4abe17a5feb Windows fix: When PYTHONCASEOK is set, or for any other reason imports
Tim Peters <tim.peters@gmail.com>
parents: 28361
diff changeset
51
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
52
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
53 try:
47266
7fe3a8648ce2 Rename thread to _thread and dummy_thread to _dummy_thread. Issue #2875.
Georg Brandl <georg@python.org>
parents: 47080
diff changeset
54 import _thread
26892
95510f0a0624 Use the dummy_thread module in Queue.py and tempfile.py.
Guido van Rossum <guido@python.org>
parents: 26352
diff changeset
55 except ImportError:
47266
7fe3a8648ce2 Rename thread to _thread and dummy_thread to _dummy_thread. Issue #2875.
Georg Brandl <georg@python.org>
parents: 47080
diff changeset
56 import _dummy_thread as _thread
26892
95510f0a0624 Use the dummy_thread module in Queue.py and tempfile.py.
Guido van Rossum <guido@python.org>
parents: 26352
diff changeset
57 _allocate_lock = _thread.allocate_lock
11707
6f4146846337 The third and final doc-string sweep by Ka-Ping Yee.
Guido van Rossum <guido@python.org>
parents: 10901
diff changeset
58
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
59 _text_openflags = _os.O_RDWR | _os.O_CREAT | _os.O_EXCL
24715
4c746ba24de2 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 24708
diff changeset
60 if hasattr(_os, 'O_NOINHERIT'):
4c746ba24de2 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 24708
diff changeset
61 _text_openflags |= _os.O_NOINHERIT
4c746ba24de2 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 24708
diff changeset
62 if hasattr(_os, 'O_NOFOLLOW'):
4c746ba24de2 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 24708
diff changeset
63 _text_openflags |= _os.O_NOFOLLOW
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
64
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
65 _bin_openflags = _text_openflags
24715
4c746ba24de2 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 24708
diff changeset
66 if hasattr(_os, 'O_BINARY'):
4c746ba24de2 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 24708
diff changeset
67 _bin_openflags |= _os.O_BINARY
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
68
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
69 if hasattr(_os, 'TMP_MAX'):
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
70 TMP_MAX = _os.TMP_MAX
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
71 else:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
72 TMP_MAX = 10000
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
73
70932
eafe8c7f7049 #10354: remove last public mentions of 'template' and comment as private.
R David Murray <rdmurray@bitdance.com>
parents: 66843
diff changeset
74 # Although it does not have an underscore for historical reasons, this
eafe8c7f7049 #10354: remove last public mentions of 'template' and comment as private.
R David Murray <rdmurray@bitdance.com>
parents: 66843
diff changeset
75 # variable is an internal implementation detail (see issue 10354).
24799
d9ff97ce75bb template: removed special-casing for NT; there isn't an 8-character limit.
Tim Peters <tim.peters@gmail.com>
parents: 24798
diff changeset
76 template = "tmp"
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
77
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
78 # Internal routines.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
79
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
80 _once_lock = _allocate_lock()
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
81
30890
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
82 if hasattr(_os, "lstat"):
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
83 _stat = _os.lstat
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
84 elif hasattr(_os, "stat"):
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
85 _stat = _os.stat
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
86 else:
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
87 # Fallback. All we need is something that raises OSError if the
30890
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
88 # file doesn't exist.
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
89 def _stat(fn):
73170
5bd8a04206e8 Remove no-op code from previous commit.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 73169
diff changeset
90 f = open(fn)
30890
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
91 f.close()
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
92
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
93 def _exists(fn):
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
94 try:
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
95 _stat(fn)
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
96 except OSError:
30890
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
97 return False
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
98 else:
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
99 return True
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
100
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
101 class _RandomNameSequence:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
102 """An instance of _RandomNameSequence generates an endless
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
103 sequence of unpredictable strings which can safely be incorporated
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
104 into file names. Each string is six characters long. Multiple
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
105 threads can safely use the same instance at the same time.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
106
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
107 _RandomNameSequence is an iterator."""
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
108
66102
b6da97930f63 Simplify code
Raymond Hettinger <python@rcn.com>
parents: 65618
diff changeset
109 characters = "abcdefghijklmnopqrstuvwxyz0123456789_"
773
c721afab0efa Mostly rewritten to be more flexible and more portable
Guido van Rossum <guido@python.org>
parents: 586
diff changeset
110
73743
3c9ddd93c983 Issue #12856: Ensure child processes do not inherit the parent's random seed for filename generation in the tempfile module.
Antoine Pitrou <solipsis@pitrou.net>
parents: 71608
diff changeset
111 @property
3c9ddd93c983 Issue #12856: Ensure child processes do not inherit the parent's random seed for filename generation in the tempfile module.
Antoine Pitrou <solipsis@pitrou.net>
parents: 71608
diff changeset
112 def rng(self):
3c9ddd93c983 Issue #12856: Ensure child processes do not inherit the parent's random seed for filename generation in the tempfile module.
Antoine Pitrou <solipsis@pitrou.net>
parents: 71608
diff changeset
113 cur_pid = _os.getpid()
3c9ddd93c983 Issue #12856: Ensure child processes do not inherit the parent's random seed for filename generation in the tempfile module.
Antoine Pitrou <solipsis@pitrou.net>
parents: 71608
diff changeset
114 if cur_pid != getattr(self, '_rng_pid', None):
3c9ddd93c983 Issue #12856: Ensure child processes do not inherit the parent's random seed for filename generation in the tempfile module.
Antoine Pitrou <solipsis@pitrou.net>
parents: 71608
diff changeset
115 self._rng = _Random()
3c9ddd93c983 Issue #12856: Ensure child processes do not inherit the parent's random seed for filename generation in the tempfile module.
Antoine Pitrou <solipsis@pitrou.net>
parents: 71608
diff changeset
116 self._rng_pid = cur_pid
3c9ddd93c983 Issue #12856: Ensure child processes do not inherit the parent's random seed for filename generation in the tempfile module.
Antoine Pitrou <solipsis@pitrou.net>
parents: 71608
diff changeset
117 return self._rng
26315
3fd8c2aff305 _RandomNameSequence(): style guide changes, small speedup, don't
Tim Peters <tim.peters@gmail.com>
parents: 26314
diff changeset
118
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
119 def __iter__(self):
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
120 return self
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
121
41501
0c5019afc55b PEP 3114: rename .next() to .__next__() and add next() builtin.
Georg Brandl <georg@python.org>
parents: 40587
diff changeset
122 def __next__(self):
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
123 c = self.characters
26315
3fd8c2aff305 _RandomNameSequence(): style guide changes, small speedup, don't
Tim Peters <tim.peters@gmail.com>
parents: 26314
diff changeset
124 choose = self.rng.choice
66102
b6da97930f63 Simplify code
Raymond Hettinger <python@rcn.com>
parents: 65618
diff changeset
125 letters = [choose(c) for dummy in "123456"]
b6da97930f63 Simplify code
Raymond Hettinger <python@rcn.com>
parents: 65618
diff changeset
126 return ''.join(letters)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
127
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
128 def _candidate_tempdir_list():
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
129 """Generate a list of candidate temporary directories which
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
130 _get_default_tempdir will try."""
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
131
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
132 dirlist = []
773
c721afab0efa Mostly rewritten to be more flexible and more portable
Guido van Rossum <guido@python.org>
parents: 586
diff changeset
133
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
134 # First, try the environment.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
135 for envname in 'TMPDIR', 'TEMP', 'TMP':
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
136 dirname = _os.getenv(envname)
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
137 if dirname: dirlist.append(dirname)
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
138
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
139 # Failing that, try OS-specific locations.
47080
58a0d5524f9a Merged revisions 63119-63128,63130-63131,63133,63135-63144,63146-63148,63151-63152,63155-63165,63167-63176,63181-63186,63188-63189 via svnmerge from
Alexandre Vassalotti <alexandre@peadrop.com>
parents: 46664
diff changeset
140 if _os.name == 'nt':
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
141 dirlist.extend([ r'c:\temp', r'c:\tmp', r'\temp', r'\tmp' ])
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
142 else:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
143 dirlist.extend([ '/tmp', '/var/tmp', '/usr/tmp' ])
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
144
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
145 # As a last resort, the current directory.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
146 try:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
147 dirlist.append(_os.getcwd())
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
148 except (AttributeError, OSError):
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
149 dirlist.append(_os.curdir)
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
150
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
151 return dirlist
24715
4c746ba24de2 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 24708
diff changeset
152
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
153 def _get_default_tempdir():
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
154 """Calculate the default directory to use for temporary files.
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
155 This routine should be called exactly once.
16889
0feb63490093 final round of __all__ lists (I hope) - skipped urllib2 because Moshe may be
Skip Montanaro <skip@pobox.com>
parents: 16678
diff changeset
156
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
157 We determine whether or not a candidate temp dir is usable by
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
158 trying to create and write to a file in that directory. If this
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
159 is successful, the test file is deleted. To prevent denial of
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
160 service, the name of the test file must be randomized."""
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
161
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
162 namer = _RandomNameSequence()
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
163 dirlist = _candidate_tempdir_list()
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
164
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
165 for dir in dirlist:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
166 if dir != _os.curdir:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
167 dir = _os.path.normcase(_os.path.abspath(dir))
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
168 # Try only a few names per directory.
41642
a6eb6acfe04a Merged revisions 55007-55179 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41554
diff changeset
169 for seq in range(100):
41501
0c5019afc55b PEP 3114: rename .next() to .__next__() and add next() builtin.
Georg Brandl <georg@python.org>
parents: 40587
diff changeset
170 name = next(namer)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
171 filename = _os.path.join(dir, name)
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
172 try:
57514
9e51a14998a2 Merged revisions 76593 via svnmerge from
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 55598
diff changeset
173 fd = _os.open(filename, _bin_openflags, 0o600)
42580
5aeb261de0bd Patch suggested Paul Colomiets fixes test_threaded_import.py.
Guido van Rossum <guido@python.org>
parents: 42458
diff changeset
174 fp = _io.open(fd, 'wb')
5aeb261de0bd Patch suggested Paul Colomiets fixes test_threaded_import.py.
Guido van Rossum <guido@python.org>
parents: 42458
diff changeset
175 fp.write(b'blat')
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
176 fp.close()
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
177 _os.unlink(filename)
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
178 del fp, fd
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
179 return dir
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
180 except FileExistsError:
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
181 pass
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
182 except OSError:
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
183 break # no point trying more names in this directory
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
184 raise FileNotFoundError("No usable temporary directory found in %s" % dirlist)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
185
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
186 _name_sequence = None
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
187
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
188 def _get_candidate_names():
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
189 """Common setup sequence for all user-callable interfaces."""
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
190
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
191 global _name_sequence
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
192 if _name_sequence is None:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
193 _once_lock.acquire()
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
194 try:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
195 if _name_sequence is None:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
196 _name_sequence = _RandomNameSequence()
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
197 finally:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
198 _once_lock.release()
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
199 return _name_sequence
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
200
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
201
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
202 def _mkstemp_inner(dir, pre, suf, flags):
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
203 """Code common to mkstemp, TemporaryFile, and NamedTemporaryFile."""
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
204
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
205 names = _get_candidate_names()
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
206
41642
a6eb6acfe04a Merged revisions 55007-55179 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41554
diff changeset
207 for seq in range(TMP_MAX):
41501
0c5019afc55b PEP 3114: rename .next() to .__next__() and add next() builtin.
Georg Brandl <georg@python.org>
parents: 40587
diff changeset
208 name = next(names)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
209 file = _os.path.join(dir, pre + name + suf)
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
210 try:
42084
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41760
diff changeset
211 fd = _os.open(file, flags, 0o600)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
212 _set_cloexec(fd)
30681
9691cc644160 Patch #810914: Return absolute path for mkstemp. Fixes #810408.
Martin v. Löwis <martin@v.loewis.de>
parents: 29967
diff changeset
213 return (fd, _os.path.abspath(file))
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
214 except FileExistsError:
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
215 continue # try again
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
216
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
217 raise FileExistsError("No usable temporary file name found")
24715
4c746ba24de2 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 24708
diff changeset
218
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
219
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
220 # User visible interfaces.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
221
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
222 def gettempprefix():
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
223 """Accessor for tempdir.template."""
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
224 return template
430
0f9ebc63dcb5 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
225
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
226 tempdir = None
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
227
773
c721afab0efa Mostly rewritten to be more flexible and more portable
Guido van Rossum <guido@python.org>
parents: 586
diff changeset
228 def gettempdir():
46664
031dfe455585 Merged revisions 62425-62429,62434-62436,62441,62444,62446-62448,62450-62455,62463,62465-62466,62469,62474,62476-62478,62480,62485,62492,62497-62498,62500,62507,62513-62514,62516,62521,62531,62535,62545-62546,62548-62551,62553-62559,62569,62574,62577,62593,62595,62604-62606,62608,62616,62626-62627,62636,62638,62644-62645,62647-62648,62651-62653,62656,62661,62663,62680,62686-62687,62696,62699-62703,62711 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45561
diff changeset
229 """Accessor for tempfile.tempdir."""
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
230 global tempdir
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
231 if tempdir is None:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
232 _once_lock.acquire()
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
233 try:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
234 if tempdir is None:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
235 tempdir = _get_default_tempdir()
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
236 finally:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
237 _once_lock.release()
3647
16ca8f0f3f11 Be more careful about default temp dir
Guido van Rossum <guido@python.org>
parents: 773
diff changeset
238 return tempdir
586
dbf408918201 Use $TMPDIR if it is set in the environment.
Guido van Rossum <guido@python.org>
parents: 534
diff changeset
239
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
240 def mkstemp(suffix="", prefix=template, dir=None, text=False):
46664
031dfe455585 Merged revisions 62425-62429,62434-62436,62441,62444,62446-62448,62450-62455,62463,62465-62466,62469,62474,62476-62478,62480,62485,62492,62497-62498,62500,62507,62513-62514,62516,62521,62531,62535,62545-62546,62548-62551,62553-62559,62569,62574,62577,62593,62595,62604-62606,62608,62616,62626-62627,62636,62638,62644-62645,62647-62648,62651-62653,62656,62661,62663,62680,62686-62687,62696,62699-62703,62711 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45561
diff changeset
241 """User-callable function to create and return a unique temporary
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
242 file. The return value is a pair (fd, name) where fd is the
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
243 file descriptor returned by os.open, and name is the filename.
773
c721afab0efa Mostly rewritten to be more flexible and more portable
Guido van Rossum <guido@python.org>
parents: 586
diff changeset
244
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
245 If 'suffix' is specified, the file name will end with that suffix,
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
246 otherwise there will be no suffix.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
247
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
248 If 'prefix' is specified, the file name will begin with that prefix,
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
249 otherwise a default prefix is used.
15840
7d5025bba037 Guido found a brand new race in tempfile on Linux, due to Linux changing
Tim Peters <tim.peters@gmail.com>
parents: 15827
diff changeset
250
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
251 If 'dir' is specified, the file will be created in that directory,
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
252 otherwise a default directory is used.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
253
24816
c45642e1dca9 tempfile's mkstemp(): Changed last argument from
Tim Peters <tim.peters@gmail.com>
parents: 24813
diff changeset
254 If 'text' is specified and true, the file is opened in text
c45642e1dca9 tempfile's mkstemp(): Changed last argument from
Tim Peters <tim.peters@gmail.com>
parents: 24813
diff changeset
255 mode. Else (the default) the file is opened in binary mode. On
c45642e1dca9 tempfile's mkstemp(): Changed last argument from
Tim Peters <tim.peters@gmail.com>
parents: 24813
diff changeset
256 some operating systems, this makes no difference.
9364
9f135b3d9a78 Fix so that after a fork() -- on Unix only -- the template gets
Guido van Rossum <guido@python.org>
parents: 8176
diff changeset
257
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
258 The file is readable and writable only by the creating user ID.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
259 If the operating system uses permission bits to indicate whether a
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
260 file is executable, the file is executable by no one. The file
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
261 descriptor is not inherited by children of this process.
15840
7d5025bba037 Guido found a brand new race in tempfile on Linux, due to Linux changing
Tim Peters <tim.peters@gmail.com>
parents: 15827
diff changeset
262
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
263 Caller is responsible for deleting the file when done with it.
15840
7d5025bba037 Guido found a brand new race in tempfile on Linux, due to Linux changing
Tim Peters <tim.peters@gmail.com>
parents: 15827
diff changeset
264 """
7d5025bba037 Guido found a brand new race in tempfile on Linux, due to Linux changing
Tim Peters <tim.peters@gmail.com>
parents: 15827
diff changeset
265
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
266 if dir is None:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
267 dir = gettempdir()
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
268
24816
c45642e1dca9 tempfile's mkstemp(): Changed last argument from
Tim Peters <tim.peters@gmail.com>
parents: 24813
diff changeset
269 if text:
c45642e1dca9 tempfile's mkstemp(): Changed last argument from
Tim Peters <tim.peters@gmail.com>
parents: 24813
diff changeset
270 flags = _text_openflags
c45642e1dca9 tempfile's mkstemp(): Changed last argument from
Tim Peters <tim.peters@gmail.com>
parents: 24813
diff changeset
271 else:
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
272 flags = _bin_openflags
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
273
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
274 return _mkstemp_inner(dir, prefix, suffix, flags)
586
dbf408918201 Use $TMPDIR if it is set in the environment.
Guido van Rossum <guido@python.org>
parents: 534
diff changeset
275
430
0f9ebc63dcb5 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
276
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
277 def mkdtemp(suffix="", prefix=template, dir=None):
46664
031dfe455585 Merged revisions 62425-62429,62434-62436,62441,62444,62446-62448,62450-62455,62463,62465-62466,62469,62474,62476-62478,62480,62485,62492,62497-62498,62500,62507,62513-62514,62516,62521,62531,62535,62545-62546,62548-62551,62553-62559,62569,62574,62577,62593,62595,62604-62606,62608,62616,62626-62627,62636,62638,62644-62645,62647-62648,62651-62653,62656,62661,62663,62680,62686-62687,62696,62699-62703,62711 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45561
diff changeset
278 """User-callable function to create and return a unique temporary
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
279 directory. The return value is the pathname of the directory.
5987
0a2c331200f5 Added TemporaryFile and wrapper class by Jim Fulton.
Guido van Rossum <guido@python.org>
parents: 5305
diff changeset
280
24816
c45642e1dca9 tempfile's mkstemp(): Changed last argument from
Tim Peters <tim.peters@gmail.com>
parents: 24813
diff changeset
281 Arguments are as for mkstemp, except that the 'text' argument is
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
282 not accepted.
5987
0a2c331200f5 Added TemporaryFile and wrapper class by Jim Fulton.
Guido van Rossum <guido@python.org>
parents: 5305
diff changeset
283
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
284 The directory is readable, writable, and searchable only by the
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
285 creating user.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
286
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
287 Caller is responsible for deleting the directory when done with it.
5987
0a2c331200f5 Added TemporaryFile and wrapper class by Jim Fulton.
Guido van Rossum <guido@python.org>
parents: 5305
diff changeset
288 """
21474
a3b0673ba2ca TemporaryFileWrapper: cache the value of os.unlink for use by __del__,
Tim Peters <tim.peters@gmail.com>
parents: 20752
diff changeset
289
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
290 if dir is None:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
291 dir = gettempdir()
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
292
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
293 names = _get_candidate_names()
24715
4c746ba24de2 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 24708
diff changeset
294
41642
a6eb6acfe04a Merged revisions 55007-55179 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41554
diff changeset
295 for seq in range(TMP_MAX):
41501
0c5019afc55b PEP 3114: rename .next() to .__next__() and add next() builtin.
Georg Brandl <georg@python.org>
parents: 40587
diff changeset
296 name = next(names)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
297 file = _os.path.join(dir, prefix + name + suffix)
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
298 try:
42084
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41760
diff changeset
299 _os.mkdir(file, 0o700)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
300 return file
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
301 except FileExistsError:
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
302 continue # try again
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
303
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
304 raise FileExistsError("No usable temporary directory name found")
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
305
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
306 def mktemp(suffix="", prefix=template, dir=None):
46664
031dfe455585 Merged revisions 62425-62429,62434-62436,62441,62444,62446-62448,62450-62455,62463,62465-62466,62469,62474,62476-62478,62480,62485,62492,62497-62498,62500,62507,62513-62514,62516,62521,62531,62535,62545-62546,62548-62551,62553-62559,62569,62574,62577,62593,62595,62604-62606,62608,62616,62626-62627,62636,62638,62644-62645,62647-62648,62651-62653,62656,62661,62663,62680,62686-62687,62696,62699-62703,62711 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 45561
diff changeset
307 """User-callable function to return a unique temporary file name. The
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
308 file is not created.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
309
24816
c45642e1dca9 tempfile's mkstemp(): Changed last argument from
Tim Peters <tim.peters@gmail.com>
parents: 24813
diff changeset
310 Arguments are as for mkstemp, except that the 'text' argument is
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
311 not accepted.
21474
a3b0673ba2ca TemporaryFileWrapper: cache the value of os.unlink for use by __del__,
Tim Peters <tim.peters@gmail.com>
parents: 20752
diff changeset
312
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
313 This function is unsafe and should not be used. The file name
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
314 refers to a file that did not exist at some point, but by the time
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
315 you get around to creating it, someone else may have beaten you to
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
316 the punch.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
317 """
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
318
26352
dc399e9cab89 Comment out the warnings about mktemp(). These are too annoying, and
Guido van Rossum <guido@python.org>
parents: 26315
diff changeset
319 ## from warnings import warn as _warn
dc399e9cab89 Comment out the warnings about mktemp(). These are too annoying, and
Guido van Rossum <guido@python.org>
parents: 26315
diff changeset
320 ## _warn("mktemp is a potential security risk to your program",
dc399e9cab89 Comment out the warnings about mktemp(). These are too annoying, and
Guido van Rossum <guido@python.org>
parents: 26315
diff changeset
321 ## RuntimeWarning, stacklevel=2)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
322
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
323 if dir is None:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
324 dir = gettempdir()
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
325
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
326 names = _get_candidate_names()
41642
a6eb6acfe04a Merged revisions 55007-55179 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41554
diff changeset
327 for seq in range(TMP_MAX):
41501
0c5019afc55b PEP 3114: rename .next() to .__next__() and add next() builtin.
Georg Brandl <georg@python.org>
parents: 40587
diff changeset
328 name = next(names)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
329 file = _os.path.join(dir, prefix + name + suffix)
30890
1997a14f6b08 mktemp() shouldn't rely on os.path.exists(), which can return False if
Guido van Rossum <guido@python.org>
parents: 30889
diff changeset
330 if not _exists(file):
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
331 return file
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
332
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
333 raise FileExistsError("No usable temporary filename found")
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
334
45256
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
335
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
336 class _TemporaryFileWrapper:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
337 """Temporary file wrapper
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
338
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
339 This class provides a wrapper around files opened for
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
340 temporary use. In particular, it seeks to automatically
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
341 remove the file when it is no longer needed.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
342 """
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
343
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
344 def __init__(self, file, name, delete=True):
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6924
diff changeset
345 self.file = file
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
346 self.name = name
26314
8e6013bbe7a7 _TemporaryFileWrapper: changed self.close_called to a proper bool.
Tim Peters <tim.peters@gmail.com>
parents: 24874
diff changeset
347 self.close_called = False
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
348 self.delete = delete
5987
0a2c331200f5 Added TemporaryFile and wrapper class by Jim Fulton.
Guido van Rossum <guido@python.org>
parents: 5305
diff changeset
349
0a2c331200f5 Added TemporaryFile and wrapper class by Jim Fulton.
Guido van Rossum <guido@python.org>
parents: 5305
diff changeset
350 def __getattr__(self, name):
45256
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
351 # Attribute lookups are delegated to the underlying file
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
352 # and cached for non-numeric results
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
353 # (i.e. methods are cached, closed and friends are not)
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6924
diff changeset
354 file = self.__dict__['file']
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6924
diff changeset
355 a = getattr(file, name)
45256
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
356 if not isinstance(a, int):
10901
17ca2f64b6d6 In class TemporaryFileWrapper, don't cache attributes of tpye int --
Guido van Rossum <guido@python.org>
parents: 9447
diff changeset
357 setattr(self, name, a)
7755
fb4b4d069cc7 Mass check-in after untabifying all files that need it.
Guido van Rossum <guido@python.org>
parents: 6924
diff changeset
358 return a
5987
0a2c331200f5 Added TemporaryFile and wrapper class by Jim Fulton.
Guido van Rossum <guido@python.org>
parents: 5305
diff changeset
359
45256
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
360 # The underlying __enter__ method returns the wrong object
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
361 # (self.file) so override it to return the wrapper
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
362 def __enter__(self):
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
363 self.file.__enter__()
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
364 return self
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
365
45561
972fc7d7cb72 As Guido says
Christian Heimes <christian@cheimes.de>
parents: 45558
diff changeset
366 # iter() doesn't use __getattr__ to find the __iter__ method
45558
c38dcb7d94a6 iter() doesn't use __getattr__ to find an __iter__ method. I'm not sure if the behavior is deliberately but this workaround fixes the issue for the next alpha release tomorrow.
Christian Heimes <christian@cheimes.de>
parents: 45256
diff changeset
367 def __iter__(self):
45561
972fc7d7cb72 As Guido says
Christian Heimes <christian@cheimes.de>
parents: 45558
diff changeset
368 return iter(self.file)
45558
c38dcb7d94a6 iter() doesn't use __getattr__ to find an __iter__ method. I'm not sure if the behavior is deliberately but this workaround fixes the issue for the next alpha release tomorrow.
Christian Heimes <christian@cheimes.de>
parents: 45256
diff changeset
369
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
370 # NT provides delete-on-close as a primitive, so we don't need
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
371 # the wrapper to do anything special. We still use it so that
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
372 # file.name is useful (i.e. not "(fdopen)") with NamedTemporaryFile.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
373 if _os.name != 'nt':
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
374 # Cache the unlinker so we don't get spurious errors at
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
375 # shutdown when the module-level "os" is None'd out. Note
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
376 # that this must be referenced as self.unlink, because the
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
377 # name TemporaryFileWrapper may also get None'd out before
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
378 # __del__ is called.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
379 unlink = _os.unlink
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
380
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
381 def close(self):
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
382 if not self.close_called:
26314
8e6013bbe7a7 _TemporaryFileWrapper: changed self.close_called to a proper bool.
Tim Peters <tim.peters@gmail.com>
parents: 24874
diff changeset
383 self.close_called = True
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
384 self.file.close()
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
385 if self.delete:
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
386 self.unlink(self.name)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
387
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
388 def __del__(self):
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
389 self.close()
5987
0a2c331200f5 Added TemporaryFile and wrapper class by Jim Fulton.
Guido van Rossum <guido@python.org>
parents: 5305
diff changeset
390
45256
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
391 # Need to trap __exit__ as well to ensure the file gets
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
392 # deleted when used in a with statement
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
393 def __exit__(self, exc, value, tb):
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
394 result = self.file.__exit__(exc, value, tb)
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
395 self.close()
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
396 return result
55592
10940bcedc99 Merged revisions 73695,73711 via svnmerge from
Georg Brandl <georg@python.org>
parents: 47630
diff changeset
397 else:
10940bcedc99 Merged revisions 73695,73711 via svnmerge from
Georg Brandl <georg@python.org>
parents: 47630
diff changeset
398 def __exit__(self, exc, value, tb):
55598
743fa282d748 Merged revisions 73749 via svnmerge from
Georg Brandl <georg@python.org>
parents: 55592
diff changeset
399 self.file.__exit__(exc, value, tb)
45256
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
400
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
401
42931
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
402 def NamedTemporaryFile(mode='w+b', buffering=-1, encoding=None,
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
403 newline=None, suffix="", prefix=template,
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
404 dir=None, delete=True):
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
405 """Create and return a temporary file.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
406 Arguments:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
407 'prefix', 'suffix', 'dir' -- as for mkstemp.
42931
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
408 'mode' -- the mode argument to io.open (default "w+b").
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
409 'buffering' -- the buffer size argument to io.open (default -1).
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
410 'encoding' -- the encoding argument to io.open (default None)
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
411 'newline' -- the newline argument to io.open (default None)
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
412 'delete' -- whether the file is deleted on close (default True).
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
413 The file is created as mkstemp() would do it.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
414
34399
d7968621d28d SF bug #1099516: tempfile files not types.FileType
Raymond Hettinger <python@rcn.com>
parents: 32750
diff changeset
415 Returns an object with a file-like interface; the name of the file
d7968621d28d SF bug #1099516: tempfile files not types.FileType
Raymond Hettinger <python@rcn.com>
parents: 32750
diff changeset
416 is accessible as file.name. The file will be automatically deleted
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
417 when it is closed unless the 'delete' argument is set to False.
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
418 """
15827
81db92e80ea8 A variant of SF patch 103028 (Make tempfile.mktemp threadsafe).
Tim Peters <tim.peters@gmail.com>
parents: 14242
diff changeset
419
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
420 if dir is None:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
421 dir = gettempdir()
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
422
57514
9e51a14998a2 Merged revisions 76593 via svnmerge from
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 55598
diff changeset
423 flags = _bin_openflags
15827
81db92e80ea8 A variant of SF patch 103028 (Make tempfile.mktemp threadsafe).
Tim Peters <tim.peters@gmail.com>
parents: 14242
diff changeset
424
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
425 # Setting O_TEMPORARY in the flags causes the OS to delete
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
426 # the file when it is closed. This is only supported by Windows.
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
427 if _os.name == 'nt' and delete:
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
428 flags |= _os.O_TEMPORARY
15827
81db92e80ea8 A variant of SF patch 103028 (Make tempfile.mktemp threadsafe).
Tim Peters <tim.peters@gmail.com>
parents: 14242
diff changeset
429
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
430 (fd, name) = _mkstemp_inner(dir, prefix, suffix, flags)
42931
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
431 file = _io.open(fd, mode, buffering=buffering,
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
432 newline=newline, encoding=encoding)
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
433
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
434 return _TemporaryFileWrapper(file, name, delete)
15827
81db92e80ea8 A variant of SF patch 103028 (Make tempfile.mktemp threadsafe).
Tim Peters <tim.peters@gmail.com>
parents: 14242
diff changeset
435
24813
7b7d8820ae38 Patch #595014: Cygwin tempfile patch
Jason Tishler <jason@tishler.net>
parents: 24802
diff changeset
436 if _os.name != 'posix' or _os.sys.platform == 'cygwin':
7b7d8820ae38 Patch #595014: Cygwin tempfile patch
Jason Tishler <jason@tishler.net>
parents: 24802
diff changeset
437 # On non-POSIX and Cygwin systems, assume that we cannot unlink a file
7b7d8820ae38 Patch #595014: Cygwin tempfile patch
Jason Tishler <jason@tishler.net>
parents: 24802
diff changeset
438 # while it is open.
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
439 TemporaryFile = NamedTemporaryFile
15827
81db92e80ea8 A variant of SF patch 103028 (Make tempfile.mktemp threadsafe).
Tim Peters <tim.peters@gmail.com>
parents: 14242
diff changeset
440
81db92e80ea8 A variant of SF patch 103028 (Make tempfile.mktemp threadsafe).
Tim Peters <tim.peters@gmail.com>
parents: 14242
diff changeset
441 else:
42931
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
442 def TemporaryFile(mode='w+b', buffering=-1, encoding=None,
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
443 newline=None, suffix="", prefix=template,
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
444 dir=None):
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
445 """Create and return a temporary file.
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
446 Arguments:
39442
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 34399
diff changeset
447 'prefix', 'suffix', 'dir' -- as for mkstemp.
42931
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
448 'mode' -- the mode argument to io.open (default "w+b").
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
449 'buffering' -- the buffer size argument to io.open (default -1).
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
450 'encoding' -- the encoding argument to io.open (default None)
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
451 'newline' -- the newline argument to io.open (default None)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
452 The file is created as mkstemp() would do it.
15827
81db92e80ea8 A variant of SF patch 103028 (Make tempfile.mktemp threadsafe).
Tim Peters <tim.peters@gmail.com>
parents: 14242
diff changeset
453
34399
d7968621d28d SF bug #1099516: tempfile files not types.FileType
Raymond Hettinger <python@rcn.com>
parents: 32750
diff changeset
454 Returns an object with a file-like interface. The file has no
d7968621d28d SF bug #1099516: tempfile files not types.FileType
Raymond Hettinger <python@rcn.com>
parents: 32750
diff changeset
455 name, and will cease to exist when it is closed.
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
456 """
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
457
24874
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
458 if dir is None:
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
459 dir = gettempdir()
b517d9292ce7 Get rid of _once(); inlining it takes less code. :-)
Guido van Rossum <guido@python.org>
parents: 24816
diff changeset
460
57514
9e51a14998a2 Merged revisions 76593 via svnmerge from
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 55598
diff changeset
461 flags = _bin_openflags
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
462
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
463 (fd, name) = _mkstemp_inner(dir, prefix, suffix, flags)
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
464 try:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
465 _os.unlink(name)
42931
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
466 return _io.open(fd, mode, buffering=buffering,
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
467 newline=newline, encoding=encoding)
24708
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
468 except:
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
469 _os.close(fd)
aa8bd0dc4f8a Check-in of the most essential parts of SF 589982 (tempfile.py
Guido van Rossum <guido@python.org>
parents: 23620
diff changeset
470 raise
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
471
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
472 class SpooledTemporaryFile:
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
473 """Temporary file wrapper, specialized to switch from
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
474 StringIO to a real file when it exceeds a certain size or
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
475 when a fileno is needed.
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
476 """
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
477 _rolled = False
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
478
42931
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
479 def __init__(self, max_size=0, mode='w+b', buffering=-1,
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
480 encoding=None, newline=None,
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
481 suffix="", prefix=template, dir=None):
42162
a62eccb53f30 Make test_tempfile.py work. Make SpooledTempFile work in text and binary mode.
Guido van Rossum <guido@python.org>
parents: 42084
diff changeset
482 if 'b' in mode:
a62eccb53f30 Make test_tempfile.py work. Make SpooledTempFile work in text and binary mode.
Guido van Rossum <guido@python.org>
parents: 42084
diff changeset
483 self._file = _io.BytesIO()
a62eccb53f30 Make test_tempfile.py work. Make SpooledTempFile work in text and binary mode.
Guido van Rossum <guido@python.org>
parents: 42084
diff changeset
484 else:
43705
51a7374105ac Issue 1340 by Amaury Forgeot d'Arc (with help from Christian Heimes,
Guido van Rossum <guido@python.org>
parents: 43634
diff changeset
485 # Setting newline="\n" avoids newline translation;
51a7374105ac Issue 1340 by Amaury Forgeot d'Arc (with help from Christian Heimes,
Guido van Rossum <guido@python.org>
parents: 43634
diff changeset
486 # this is important because otherwise on Windows we'd
43777
0d462d789b18 Merging the py3k-pep3137 branch back into the py3k branch.
Guido van Rossum <guido@python.org>
parents: 43706
diff changeset
487 # hget double newline translation upon rollover().
47630
a021ff11718b Fixed test_tempfile.
Alexandre Vassalotti <alexandre@peadrop.com>
parents: 47266
diff changeset
488 self._file = _io.StringIO(newline="\n")
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
489 self._max_size = max_size
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
490 self._rolled = False
42931
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
491 self._TemporaryFileArgs = {'mode': mode, 'buffering': buffering,
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
492 'suffix': suffix, 'prefix': prefix,
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
493 'encoding': encoding, 'newline': newline,
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
494 'dir': dir}
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
495
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
496 def _check(self, file):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
497 if self._rolled: return
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
498 max_size = self._max_size
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
499 if max_size and file.tell() > max_size:
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
500 self.rollover()
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
501
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
502 def rollover(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
503 if self._rolled: return
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
504 file = self._file
42931
aee21e0c9a70 Patch # 1033 by Adam Hupp:
Guido van Rossum <guido@python.org>
parents: 42632
diff changeset
505 newfile = self._file = TemporaryFile(**self._TemporaryFileArgs)
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
506 del self._TemporaryFileArgs
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
507
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
508 newfile.write(file.getvalue())
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
509 newfile.seek(file.tell(), 0)
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
510
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
511 self._rolled = True
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
512
45256
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
513 # The method caching trick from NamedTemporaryFile
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
514 # won't work here, because _file may change from a
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
515 # _StringIO instance to a real file. So we list
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
516 # all the methods directly.
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
517
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
518 # Context management protocol
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
519 def __enter__(self):
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
520 if self._file.closed:
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
521 raise ValueError("Cannot enter context with closed file")
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
522 return self
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
523
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
524 def __exit__(self, exc, value, tb):
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
525 self._file.close()
bc62854ee9c2 Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552,60554,60556-60559,60561-60562,60569,60571-60572,60574,60576-60583,60585-60586,60589,60591,60594-60595,60597-60598,60600-60601,60606-60612,60615,60617,60619-60621,60623-60625,60627-60629,60631,60633,60635,60647,60650,60652,60654,60656,60658-60659,60664-60666,60668-60670,60672,60676,60678-60695 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
526
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
527 # file protocol
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
528 def __iter__(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
529 return self._file.__iter__()
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
530
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
531 def close(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
532 self._file.close()
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
533
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
534 @property
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
535 def closed(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
536 return self._file.closed
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
537
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
538 @property
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
539 def encoding(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
540 return self._file.encoding
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
541
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
542 def fileno(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
543 self.rollover()
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
544 return self._file.fileno()
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
545
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
546 def flush(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
547 self._file.flush()
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
548
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
549 def isatty(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
550 return self._file.isatty()
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
551
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
552 @property
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
553 def mode(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
554 return self._file.mode
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
555
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
556 @property
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
557 def name(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
558 return self._file.name
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
559
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
560 @property
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
561 def newlines(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
562 return self._file.newlines
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
563
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
564 def next(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
565 return self._file.next
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
566
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
567 def read(self, *args):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
568 return self._file.read(*args)
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
569
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
570 def readline(self, *args):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
571 return self._file.readline(*args)
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
572
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
573 def readlines(self, *args):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
574 return self._file.readlines(*args)
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
575
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
576 def seek(self, *args):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
577 self._file.seek(*args)
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
578
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
579 @property
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
580 def softspace(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
581 return self._file.softspace
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
582
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
583 def tell(self):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
584 return self._file.tell()
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
585
73737
5a6911930bad Issue #9957: SpooledTemporaryFile.truncate() now accepts an optional size parameter, as other file-like objects.
Antoine Pitrou <solipsis@pitrou.net>
parents: 73170
diff changeset
586 def truncate(self, size=None):
5a6911930bad Issue #9957: SpooledTemporaryFile.truncate() now accepts an optional size parameter, as other file-like objects.
Antoine Pitrou <solipsis@pitrou.net>
parents: 73170
diff changeset
587 if size is None:
5a6911930bad Issue #9957: SpooledTemporaryFile.truncate() now accepts an optional size parameter, as other file-like objects.
Antoine Pitrou <solipsis@pitrou.net>
parents: 73170
diff changeset
588 self._file.truncate()
5a6911930bad Issue #9957: SpooledTemporaryFile.truncate() now accepts an optional size parameter, as other file-like objects.
Antoine Pitrou <solipsis@pitrou.net>
parents: 73170
diff changeset
589 else:
5a6911930bad Issue #9957: SpooledTemporaryFile.truncate() now accepts an optional size parameter, as other file-like objects.
Antoine Pitrou <solipsis@pitrou.net>
parents: 73170
diff changeset
590 if size > self._max_size:
5a6911930bad Issue #9957: SpooledTemporaryFile.truncate() now accepts an optional size parameter, as other file-like objects.
Antoine Pitrou <solipsis@pitrou.net>
parents: 73170
diff changeset
591 self.rollover()
5a6911930bad Issue #9957: SpooledTemporaryFile.truncate() now accepts an optional size parameter, as other file-like objects.
Antoine Pitrou <solipsis@pitrou.net>
parents: 73170
diff changeset
592 self._file.truncate(size)
41554
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
593
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
594 def write(self, s):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
595 file = self._file
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
596 rv = file.write(s)
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
597 self._check(file)
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
598 return rv
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
599
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
600 def writelines(self, iterable):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
601 file = self._file
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
602 rv = file.writelines(iterable)
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
603 self._check(file)
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
604 return rv
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
605
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
606 def xreadlines(self, *args):
06145fbc7ab9 Merged revisions 53952-54987 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 41501
diff changeset
607 return self._file.xreadlines(*args)
65618
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
608
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
609
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
610 class TemporaryDirectory(object):
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
611 """Create and return a temporary directory. This has the same
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
612 behavior as mkdtemp but can be used as a context manager. For
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
613 example:
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
614
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
615 with TemporaryDirectory() as tmpdir:
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
616 ...
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
617
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
618 Upon exiting the context, the directory and everthing contained
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
619 in it are removed.
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
620 """
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
621
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
622 def __init__(self, suffix="", prefix=template, dir=None):
66843
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
623 self._closed = False
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
624 self.name = None # Handle mkdtemp throwing an exception
65618
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
625 self.name = mkdtemp(suffix, prefix, dir)
66843
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
626
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
627 def __repr__(self):
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
628 return "<{} {!r}>".format(self.__class__.__name__, self.name)
65618
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
629
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
630 def __enter__(self):
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
631 return self.name
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
632
66843
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
633 def cleanup(self, _warn=False):
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
634 if self.name and not self._closed:
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
635 try:
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
636 self._rmtree(self.name)
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
637 except (TypeError, AttributeError) as ex:
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
638 # Issue #10188: Emit a warning on stderr
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
639 # if the directory could not be cleaned
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
640 # up due to missing globals
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
641 if "None" not in str(ex):
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
642 raise
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
643 print("ERROR: {!r} while cleaning up {!r}".format(ex, self,),
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
644 file=_sys.stderr)
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
645 return
65618
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
646 self._closed = True
66843
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
647 if _warn:
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
648 self._warn("Implicitly cleaning up {!r}".format(self),
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
649 ResourceWarning)
65618
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
650
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
651 def __exit__(self, exc, value, tb):
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
652 self.cleanup()
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
653
66843
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
654 def __del__(self):
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
655 # Issue a ResourceWarning if implicit cleanup needed
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
656 self.cleanup(_warn=True)
65618
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
657
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
658 # XXX (ncoghlan): The following code attempts to make
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
659 # this class tolerant of the module nulling out process
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
660 # that happens during CPython interpreter shutdown
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
661 # Alas, it doesn't actually manage it. See issue #10188
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
662 _listdir = staticmethod(_os.listdir)
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
663 _path_join = staticmethod(_os.path.join)
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
664 _isdir = staticmethod(_os.path.isdir)
71608
5f7e71cfbcd6 Issue #12464: tempfile.TemporaryDirectory.cleanup() should not follow symlinks:
Charles-François Natali <neologix@free.fr>
parents: 66843
diff changeset
665 _islink = staticmethod(_os.path.islink)
65618
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
666 _remove = staticmethod(_os.remove)
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
667 _rmdir = staticmethod(_os.rmdir)
73169
e4d44c2e8e81 Simplify and remove few dependencies on 'errno', thanks to PEP 3151.
Florent Xicluna <florent.xicluna@gmail.com>
parents: 71609
diff changeset
668 _os_error = OSError
66843
612dd5f2aab3 Issue #10188 (partial resolution): tidy up some behaviour in the new tempfile.TemporaryDirectory context manager
Nick Coghlan <ncoghlan@gmail.com>
parents: 66833
diff changeset
669 _warn = _warnings.warn
65618
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
670
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
671 def _rmtree(self, path):
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
672 # Essentially a stripped down version of shutil.rmtree. We can't
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
673 # use globals because they may be None'ed out at shutdown.
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
674 for name in self._listdir(path):
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
675 fullname = self._path_join(path, name)
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
676 try:
71608
5f7e71cfbcd6 Issue #12464: tempfile.TemporaryDirectory.cleanup() should not follow symlinks:
Charles-François Natali <neologix@free.fr>
parents: 66843
diff changeset
677 isdir = self._isdir(fullname) and not self._islink(fullname)
65618
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
678 except self._os_error:
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
679 isdir = False
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
680 if isdir:
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
681 self._rmtree(fullname)
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
682 else:
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
683 try:
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
684 self._remove(fullname)
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
685 except self._os_error:
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
686 pass
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
687 try:
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
688 self._rmdir(path)
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
689 except self._os_error:
b172d7537b99 Issue 5178: Add tempfile.TemporaryDirectory (original patch by Neil Schemenauer)
Nick Coghlan <ncoghlan@gmail.com>
parents: 57514
diff changeset
690 pass