Coverage for idle_test/mock_tk.py: 96%

1"""Classes that replace tkinter gui objects used by an object being tested. 

2 

3A gui object is anything with a master or parent parameter, which is 

4typically required in spite of what the doc strings say. 

5""" 

6import re (empty)

7from _tkinter import TclError (empty)

8 

9 

10class Event: (empty)

11 '''Minimal mock with attributes for testing event handlers. 

12 

13 This is not a gui object, but is used as an argument for callbacks 

14 that access attributes of the event passed. If a callback ignores 

15 the event, other than the fact that is happened, pass 'event'. 

16 

17 Keyboard, mouse, window, and other sources generate Event instances. 

18 Event instances have the following attributes: serial (number of 

19 event), time (of event), type (of event as number), widget (in which 

20 event occurred), and x,y (position of mouse). There are other 

21 attributes for specific events, such as keycode for key events. 

22 tkinter.Event.__doc__ has more but is still not complete. 

23 ''' 

24 def __init__(self, **kwds): (empty)

25 "Create event with attributes needed for test" 

26 self.__dict__.update(kwds) 

27 

28 

29class Var: (empty)

30 "Use for String/Int/BooleanVar: incomplete" 

31 def __init__(self, master=None, value=None, name=None): (empty)

32 self.master = master 21 ctx1aABCDExyFGHIRJKLMNOPQ

33 self.value = value 21 ctx1aABCDExyFGHIRJKLMNOPQ

34 self.name = name 21 ctx1aABCDExyFGHIRJKLMNOPQ

35 def set(self, value): (empty)

36 self.value = value 9 ctx1STxyUvVWw

37 def get(self): (empty)

38 return self.value 28 ctx1XYABCSTDExyFGHIJKLMNOPQUvVWw

39 

40 

41class Mbox_func: (empty)

42 """Generic mock for messagebox functions, which all have the same signature. 

43 

44 Instead of displaying a message box, the mock's call method saves the 

45 arguments as instance attributes, which test functions can then examine. 

46 The test can set the result returned to ask function 

47 """ 

48 def __init__(self, result=None): (empty)

49 self.result = result # Return None for all show funcs (empty)

50 def __call__(self, title, message, *args, **kwds): (empty)

51 # Save all args for possible examination by tester 

52 self.title = title 3 ctx1vzw

53 self.message = message 3 ctx1vzw

54 self.args = args 3 ctx1vzw

55 self.kwds = kwds 3 ctx1vzw

56 return self.result # Set by tester for ask functions 3 ctx1vzw

57 

58 

59class Mbox: (empty)

60 """Mock for tkinter.messagebox with an Mbox_func for each function. 

61 

62 Example usage in test_module.py for testing functions in module.py: 

63 --- 

64from idlelib.idle_test.mock_tk import Mbox 

65import module 

66 

67orig_mbox = module.messagebox 

68showerror = Mbox.showerror # example, for attribute access in test methods 

69 

70class Test(unittest.TestCase): 

71 

72 @classmethod 

73 def setUpClass(cls): 

74 module.messagebox = Mbox 

75 

76 @classmethod 

77 def tearDownClass(cls): 

78 module.messagebox = orig_mbox 

79 --- 

80 For 'ask' functions, set func.result return value before calling the method 

81 that uses the message function. When messagebox functions are the 

82 only GUI calls in a method, this replacement makes the method GUI-free, 

83 """ 

84 askokcancel = Mbox_func() # True or False (empty)

85 askquestion = Mbox_func() # 'yes' or 'no' (empty)

86 askretrycancel = Mbox_func() # True or False (empty)

87 askyesno = Mbox_func() # True or False (empty)

88 askyesnocancel = Mbox_func() # True, False, or None (empty)

89 showerror = Mbox_func() # None (empty)

90 showinfo = Mbox_func() # None (empty)

91 showwarning = Mbox_func() # None (empty)

92 

93 

94class Text: (empty)

95 """A semi-functional non-gui replacement for tkinter.Text text editors. 

96 

97 The mock's data model is that a text is a list of \n-terminated lines. 

98 The mock adds an empty string at the beginning of the list so that the 

99 index of actual lines start at 1, as with Tk. The methods never see this. 

100 Tk initializes files with a terminal \n that cannot be deleted. It is 

101 invisible in the sense that one cannot move the cursor beyond it. 

102 

103 This class is only tested (and valid) with strings of ascii chars. 

104 For testing, we are not concerned with Tk Text's treatment of, 

105 for instance, 0-width characters or character + accent. 

106 """ 

107 def __init__(self, master=None, cnf={}, **kw): (empty)

108 '''Initialize mock, non-gui, text-only Text widget. 

109 

110 At present, all args are ignored. Almost all affect visual behavior. 

111 There are just a few Text-only options that affect text behavior. 

112 ''' 

113 self.data = ['', '\n'] 2 ctx1at

114 

115 def index(self, index): (empty)

116 "Return string version of index decoded according to current text." 

117 return "%s.%s" % self._decode(index, endflag=1) 8 ctx1kmnobcls

118 

119 def _decode(self, index, endflag=0): (empty)

120 """Return a (line, char) tuple of int indexes into self.data. 

121 

122 This implements .index without converting the result back to a string. 

123 The result is constrained by the number of lines and linelengths of 

124 self.data. For many indexes, the result is initially (1, 0). 

125 

126 The input index may have any of several possible forms: 

127 * line.char float: converted to 'line.char' string; 

128 * 'line.char' string, where line and char are decimal integers; 

129 * 'line.char lineend', where lineend='lineend' (and char is ignored); 

130 * 'line.end', where end='end' (same as above); 

131 * 'insert', the positions before terminal \n; 

132 * 'end', whose meaning depends on the endflag passed to ._endex. 

133 * 'sel.first' or 'sel.last', where sel is a tag -- not implemented. 

134 """ 

135 if isinstance(index, (float, bytes)): 21 ctx1akmnobcqrtpjgdhlsuief

136 index = str(index) 6 ctx1kmnols

137 try: 21 ctx1akmnobcqrtpjgdhlsuief

138 index=index.lower() 21 ctx1akmnobcqrtpjgdhlsuief

139 except AttributeError: 

140 raise TclError('bad text index "%s"' % index) from None 

141 

142 lastline = len(self.data) - 1 # same as number of text lines 21 ctx1akmnobcqrtpjgdhlsuief

143 if index == 'insert': 21 ctx1akmnobcqrtpjgdhlsuief

144 return lastline, len(self.data[lastline]) - 1 6 ctx1kmnosf

145 elif index == 'end': 21 ctx1akmnobcqrtpjgdhlsuief

146 return self._endex(endflag) 12 ctx1abcpdhlsuief

147 

148 line, char = index.split('.') 21 ctx1akmnobcqrtpjgdhlsuief

149 line = int(line) 21 ctx1akmnobcqrtpjgdhlsuief

150 

151 # Out of bounds line becomes first or last ('end') index 

152 if line < 1: 21 ctx1akmnobcqrtpjgdhlsuief

153 return 1, 0 5 ctx1bchls

154 elif line > lastline: 21 ctx1akmnobcqrtpjgdhlsuief

155 return self._endex(endflag) 7 ctx1qrphlsf

156 

157 linelength = len(self.data[line]) -1 # position before/at \n 21 ctx1akmnobcqrtpjgdhlsuief

158 if char.endswith(' lineend') or char == 'end': 21 ctx1akmnobcqrtpjgdhlsuief

159 return line, linelength 12 ctx1kmnobcgdhlsi

160 # Tk requires that ignored chars before ' lineend' be valid int 

161 if m := re.fullmatch(r'end-(\d*)c', char, re.A): # Used by hyperparser. 21 ctx1akmnobcqrtpjgdhlsuief

162 return line, linelength - int(m.group(1)) 4 ctx1kmno

163 

164 # Out of bounds char becomes first or last index of line 

165 char = int(char) 21 ctx1akmnobcqrtpjgdhlsuief

166 if char < 0: 21 ctx1akmnobcqrtpjgdhlsuief

167 char = 0 2 ctx1ls

168 elif char > linelength: 21 ctx1akmnobcqrtpjgdhlsuief

169 char = linelength 4 ctx1ghls

170 return line, char 21 ctx1akmnobcqrtpjgdhlsuief

171 

172 def _endex(self, endflag): (empty)

173 '''Return position for 'end' or line overflow corresponding to endflag. 

174 

175 -1: position before terminal \n; for .insert(), .delete 

176 0: position after terminal \n; for .get, .delete index 1 

177 1: same viewed as beginning of non-existent next line (for .index) 

178 ''' 

179 n = len(self.data) 14 ctx1abcqrpdhlsuief

180 if endflag == 1: 14 ctx1abcqrpdhlsuief

181 return n, 0 2 ctx1ls

182 else: 

183 n -= 1 12 ctx1abcqrpdhuief

184 return n, len(self.data[n]) + endflag 12 ctx1abcqrpdhuief

185 

186 def insert(self, index, chars): (empty)

187 "Insert chars before the character at index." 

188 

189 if not chars: # ''.splitlines() is [], not [''] 17 ctx1akmnobctpjgdhlief

190 return 1 ctx1i

191 chars = chars.splitlines(True) 17 ctx1akmnobctpjgdhlief

192 if chars[-1][-1] == '\n': 17 ctx1akmnobctpjgdhlief

193 chars.append('') 7 ctx1akbcjgi

194 line, char = self._decode(index, -1) 17 ctx1akmnobctpjgdhlief

195 before = self.data[line][:char] 17 ctx1akmnobctpjgdhlief

196 after = self.data[line][char:] 17 ctx1akmnobctpjgdhlief

197 self.data[line] = before + chars[0] 17 ctx1akmnobctpjgdhlief

198 self.data[line+1:line+1] = chars[1:] 17 ctx1akmnobctpjgdhlief

199 self.data[line+len(chars)-1] += after 17 ctx1akmnobctpjgdhlief

200 

201 def get(self, index1, index2=None): (empty)

202 "Return slice from index1 to index2 (default is 'index1+1')." 

203 

204 startline, startchar = self._decode(index1) 15 ctx1kmnobcqrgdhuief

205 if index2 is None: 15 ctx1kmnobcqrgdhuief

206 endline, endchar = startline, startchar+1 2 ctx1hu

207 else: 

208 endline, endchar = self._decode(index2) 14 ctx1kmnobcqrgdhief

209 

210 if startline == endline: 15 ctx1kmnobcqrgdhuief

211 return self.data[startline][startchar:endchar] 13 ctx1kmnobcqrgdhue

212 else: 

213 lines = [self.data[startline][startchar:]] 10 ctx1kbcqrdhief

214 for i in range(startline+1, endline): 10 ctx1kbcqrdhief

215 lines.append(self.data[i]) 4 ctx1bcie

216 lines.append(self.data[endline][:endchar]) 10 ctx1kbcqrdhief

217 return ''.join(lines) 10 ctx1kbcqrdhief

218 

219 def delete(self, index1, index2=None): (empty)

220 '''Delete slice from index1 to index2 (default is 'index1+1'). 

221 

222 Adjust default index2 ('index+1) for line ends. 

223 Do not delete the terminal \n at the very end of self.data ([-1][-1]). 

224 ''' 

225 startline, startchar = self._decode(index1, -1) 7 ctx1abcgdef

226 if index2 is None: 7 ctx1abcgdef

227 if startchar < len(self.data[startline])-1: 2 ctx1gf

228 # not deleting \n 

229 endline, endchar = startline, startchar+1 1 ctx1g

230 elif startline < len(self.data) - 1: 2 ctx1gf

231 # deleting non-terminal \n, convert 'index1+1 to start of next line 

232 endline, endchar = startline+1, 0 1 ctx1g

233 else: 

234 # do not delete terminal \n if index1 == 'insert' 

235 return 1 ctx1f

236 else: 

237 endline, endchar = self._decode(index2, -1) 7 ctx1abcgdef

238 # restricting end position to insert position excludes terminal \n 

239 

240 if startline == endline and startchar < endchar: 7 ctx1abcgdef

241 self.data[startline] = self.data[startline][:startchar] + \ 3 ctx1agd

242 self.data[startline][endchar:] 

243 elif startline < endline: 7 ctx1abcgdef

244 self.data[startline] = self.data[startline][:startchar] + \ 6 ctx1abcgde

245 self.data[endline][endchar:] 

246 startline += 1 6 ctx1abcgde

247 for i in range(startline, endline+1): 6 ctx1abcgde

248 del self.data[startline] 6 ctx1abcgde

249 

250 def compare(self, index1, op, index2): (empty)

251 line1, char1 = self._decode(index1) 3 ctx1bcj

252 line2, char2 = self._decode(index2) 3 ctx1bcj

253 if op == '<': 3 ctx1bcj

254 return line1 < line2 or line1 == line2 and char1 < char2 3 ctx1bcj

255 elif op == '<=': 1 ctx1j

256 return line1 < line2 or line1 == line2 and char1 <= char2 1 ctx1j

257 elif op == '>': 1 ctx1j

258 return line1 > line2 or line1 == line2 and char1 > char2 1 ctx1j

259 elif op == '>=': 1 ctx1j

260 return line1 > line2 or line1 == line2 and char1 >= char2 1 ctx1j

261 elif op == '==': 1 ctx1j

262 return line1 == line2 and char1 == char2 1 ctx1j

263 elif op == '!=': 1 ctx1j

264 return line1 != line2 or char1 != char2 1 ctx1j

265 else: 

266 raise TclError('''bad comparison operator "%s": ''' 1 ctx1j

267 '''must be <, <=, ==, >=, >, or !=''' % op) 

268 

269 # The following Text methods normally do something and return None. 

270 # Whether doing nothing is sufficient for a test will depend on the test. 

271 

272 def mark_set(self, name, index): (empty)

273 "Set mark *name* before the character at index." 

274 pass 

275 

276 def mark_unset(self, *markNames): (empty)

277 "Delete all marks in markNames." 

278 

279 def tag_remove(self, tagName, index1, index2=None): (empty)

280 "Remove tag tagName from all characters between index1 and index2." 

281 pass 

282 

283 # The following Text methods affect the graphics screen and return None. 

284 # Doing nothing should always be sufficient for tests. 

285 

286 def scan_dragto(self, x, y): (empty)

287 "Adjust the view of the text according to scan_mark" 

288 

289 def scan_mark(self, x, y): (empty)

290 "Remember the current X, Y coordinates." 

291 

292 def see(self, index): (empty)

293 "Scroll screen to make the character at INDEX is visible." 

294 pass 

295 

296 # The following is a Misc method inherited by Text. 

297 # It should properly go in a Misc mock, but is included here for now. 

298 

299 def bind(sequence=None, func=None, add=None): (empty)

300 "Bind to this widget at event sequence a call to function func." 

301 pass (empty)

302 

303 

304class Entry: (empty)

305 "Mock for tkinter.Entry." 

306 def focus_set(self): (empty)

307 pass