##// END OF EJS Templates
Implement `IPython.utils.io.Tee.isatty` (#14460)...
M Bussonnier -
r28796:c098f4c5 merge
parent child Browse files
Show More
@@ -1,151 +1,153 b''
1 1 # encoding: utf-8
2 2 """
3 3 IO related utilities.
4 4 """
5 5
6 6 # Copyright (c) IPython Development Team.
7 7 # Distributed under the terms of the Modified BSD License.
8 8
9 9
10 10
11 11 import atexit
12 12 import os
13 13 import sys
14 14 import tempfile
15 15 from pathlib import Path
16 16 from warnings import warn
17 17
18 18 from IPython.utils.decorators import undoc
19 19 from .capture import CapturedIO, capture_output
20 20
21 21 class Tee(object):
22 22 """A class to duplicate an output stream to stdout/err.
23 23
24 24 This works in a manner very similar to the Unix 'tee' command.
25 25
26 26 When the object is closed or deleted, it closes the original file given to
27 27 it for duplication.
28 28 """
29 29 # Inspired by:
30 30 # http://mail.python.org/pipermail/python-list/2007-May/442737.html
31 31
32 32 def __init__(self, file_or_name, mode="w", channel='stdout'):
33 33 """Construct a new Tee object.
34 34
35 35 Parameters
36 36 ----------
37 37 file_or_name : filename or open filehandle (writable)
38 38 File that will be duplicated
39 39 mode : optional, valid mode for open().
40 40 If a filename was give, open with this mode.
41 41 channel : str, one of ['stdout', 'stderr']
42 42 """
43 43 if channel not in ['stdout', 'stderr']:
44 44 raise ValueError('Invalid channel spec %s' % channel)
45 45
46 46 if hasattr(file_or_name, 'write') and hasattr(file_or_name, 'seek'):
47 47 self.file = file_or_name
48 48 else:
49 49 encoding = None if "b" in mode else "utf-8"
50 50 self.file = open(file_or_name, mode, encoding=encoding)
51 51 self.channel = channel
52 52 self.ostream = getattr(sys, channel)
53 53 setattr(sys, channel, self)
54 54 self._closed = False
55 55
56 56 def close(self):
57 57 """Close the file and restore the channel."""
58 58 self.flush()
59 59 setattr(sys, self.channel, self.ostream)
60 60 self.file.close()
61 61 self._closed = True
62 62
63 63 def write(self, data):
64 64 """Write data to both channels."""
65 65 self.file.write(data)
66 66 self.ostream.write(data)
67 67 self.ostream.flush()
68 68
69 69 def flush(self):
70 70 """Flush both channels."""
71 71 self.file.flush()
72 72 self.ostream.flush()
73 73
74 74 def __del__(self):
75 75 if not self._closed:
76 76 self.close()
77 77
78 def isatty(self):
79 return False
78 80
79 81 def ask_yes_no(prompt, default=None, interrupt=None):
80 82 """Asks a question and returns a boolean (y/n) answer.
81 83
82 84 If default is given (one of 'y','n'), it is used if the user input is
83 85 empty. If interrupt is given (one of 'y','n'), it is used if the user
84 86 presses Ctrl-C. Otherwise the question is repeated until an answer is
85 87 given.
86 88
87 89 An EOF is treated as the default answer. If there is no default, an
88 90 exception is raised to prevent infinite loops.
89 91
90 92 Valid answers are: y/yes/n/no (match is not case sensitive)."""
91 93
92 94 answers = {'y':True,'n':False,'yes':True,'no':False}
93 95 ans = None
94 96 while ans not in answers.keys():
95 97 try:
96 98 ans = input(prompt+' ').lower()
97 99 if not ans: # response was an empty string
98 100 ans = default
99 101 except KeyboardInterrupt:
100 102 if interrupt:
101 103 ans = interrupt
102 104 print("\r")
103 105 except EOFError:
104 106 if default in answers.keys():
105 107 ans = default
106 108 print()
107 109 else:
108 110 raise
109 111
110 112 return answers[ans]
111 113
112 114
113 115 def temp_pyfile(src, ext='.py'):
114 116 """Make a temporary python file, return filename and filehandle.
115 117
116 118 Parameters
117 119 ----------
118 120 src : string or list of strings (no need for ending newlines if list)
119 121 Source code to be written to the file.
120 122 ext : optional, string
121 123 Extension for the generated file.
122 124
123 125 Returns
124 126 -------
125 127 (filename, open filehandle)
126 128 It is the caller's responsibility to close the open file and unlink it.
127 129 """
128 130 fname = tempfile.mkstemp(ext)[1]
129 131 with open(Path(fname), "w", encoding="utf-8") as f:
130 132 f.write(src)
131 133 f.flush()
132 134 return fname
133 135
134 136
135 137 @undoc
136 138 def raw_print(*args, **kw):
137 139 """DEPRECATED: Raw print to sys.__stdout__, otherwise identical interface to print()."""
138 140 warn("IPython.utils.io.raw_print has been deprecated since IPython 7.0", DeprecationWarning, stacklevel=2)
139 141
140 142 print(*args, sep=kw.get('sep', ' '), end=kw.get('end', '\n'),
141 143 file=sys.__stdout__)
142 144 sys.__stdout__.flush()
143 145
144 146 @undoc
145 147 def raw_print_err(*args, **kw):
146 148 """DEPRECATED: Raw print to sys.__stderr__, otherwise identical interface to print()."""
147 149 warn("IPython.utils.io.raw_print_err has been deprecated since IPython 7.0", DeprecationWarning, stacklevel=2)
148 150
149 151 print(*args, sep=kw.get('sep', ' '), end=kw.get('end', '\n'),
150 152 file=sys.__stderr__)
151 153 sys.__stderr__.flush()
General Comments 0
You need to be logged in to leave comments. Login now