1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
|
import sys
import friendly_traceback
# TODO: make sure that all these cases are captured in the documentation
# Need to add more cases, ensuring that correct object is always identified
# a = [1, 2, 3]
# b = 3, 4, 5
# b[0] > a.max --> max(a)
# b.min == a[0] --> min(b)
# a.length --> len(a)
# a.len --> len(a)
# a.b -> a, b ?
def test_Generic():
# Generic - no additional explanation
class A:
pass
try:
A.x # testing type
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "AttributeError: type object 'A' has no attribute 'x'" in result
if friendly_traceback.get_lang() == "en":
assert "The object `A` has no attribute" in result
if friendly_traceback._writing_docs:
return result, message
def test_Generic_different_frame():
class A:
attr = 1
def f():
class A:
attr2 = 1
return A()
a = f()
try:
a.attr
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "AttributeError: 'A' object has no attribute 'attr'" in result
if friendly_traceback.get_lang() == "en":
assert "The object `a` has no attribute" in result
assert "Did you mean `attr2`" in result
if friendly_traceback._writing_docs:
return result, message
def test_Generic_instance():
class A:
pass
a = A()
try:
a.x
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "AttributeError: 'A' object has no attribute 'x'" in result
if friendly_traceback.get_lang() == "en":
assert "The object `a` has no attribute" in result
if friendly_traceback._writing_docs:
return result, message
def test_Object_attribute_typo():
#
try:
a = [1, 2, 3]
a.appendh(4)
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "AttributeError: 'list' object has no attribute 'appendh'" in result
if friendly_traceback.get_lang() == "en":
assert "Did you mean `append`" in result
if friendly_traceback._writing_docs:
return result, message
def test_Use_builtin():
#
try:
a = [1, 2, 3]
a.length()
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "AttributeError: 'list' object has no attribute 'length'" in result
if friendly_traceback.get_lang() == "en":
assert "Did you mean `len(a)`" in result
if friendly_traceback._writing_docs:
return result, message
def test_Use_synonym():
#
try:
a = [1, 2, 3]
a.add(4)
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "AttributeError: 'list' object has no attribute 'add'" in result
if friendly_traceback.get_lang() == "en":
assert "Did you mean `append`" in result
if friendly_traceback._writing_docs:
return result, message
def test_Module_attribute_typo():
import string
try:
string.ascii_lowecase
except AttributeError as e:
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "AttributeError: module 'string' has no attribute 'ascii_lowecase'" in result
if friendly_traceback.get_lang() == "en":
assert "Did you mean `ascii_lowercase`" in result
import math
try:
math.cost
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "AttributeError: module 'math' has no attribute 'cost'" in result
if friendly_traceback.get_lang() == "en":
assert (
"Instead of writing `math.cost`, perhaps you meant to write one of"
in result
)
assert "cos, cosh" in result or "cosh, cos" in result
assert not "acosh" in result
if friendly_traceback._writing_docs:
return result, message
def test_Shadow_stdlib_module():
import turtle
try:
turtle.Pen
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "AttributeError: module 'turtle' has no attribute 'Pen'" in result
if friendly_traceback.get_lang() == "en":
assert (
"There is also a module named `turtle` in Python's standard library."
in result
)
if friendly_traceback._writing_docs:
return result, message
def test_Nonetype():
a = None
try:
a.b
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "'NoneType' object has no attribute 'b'" in result
if friendly_traceback.get_lang() == "en":
assert "for a variable whose value is `None`" in result
if friendly_traceback._writing_docs:
return result, message
def test_Perhaps_comma():
import sys
abcd = "hello"
defg = "world"
# fmt: off
try:
a = [abcd
.defg]
# fmt: on
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "'str' object has no attribute 'defg'" in result
if friendly_traceback.get_lang() == "en":
assert "Did you mean to separate object names by a comma" in result
if friendly_traceback._writing_docs:
return result, message
def test_Builtin_function():
text = 'Hello world!'
try:
len.text
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "'builtin_function_or_method'" in result
if friendly_traceback.get_lang() == "en":
assert "Did you mean `len(text)`" in result
if friendly_traceback._writing_docs:
return result, message
def test_Builtin_module_with_no_file():
"""Issue 116"""
import sys
try:
sys.foo
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "module 'sys' has no attribute 'foo'" in result
if friendly_traceback.get_lang() == "en":
assert "Python tells us" in result
if friendly_traceback._writing_docs:
return result, message
def test_Using_slots():
"""Issue 141"""
class F:
__slots__ = ["a"]
f = F()
try:
f.b = 1
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "'F' object has no attribute 'b'" in result
if friendly_traceback.get_lang() == "en":
assert "object `f` uses `__slots__`" in result
if friendly_traceback._writing_docs:
return result, message
def test_Read_only():
class F:
__slots__ = ["a"]
b = 2
f = F()
try:
f.b = 1
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "'F' object attribute 'b' is read-only" in result
if friendly_traceback.get_lang() == "en":
assert "The only attribute of `f` whose value can be changed is" in result
if friendly_traceback._writing_docs:
return result, message
def test_Tuple_by_accident():
something = "abc", # note trailing comma
try:
something.upper()
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "'tuple' object has no attribute 'upper'" in result
if friendly_traceback.get_lang() == "en":
assert "Did you write a comma" in result
if friendly_traceback._writing_docs:
return result, message
def test_Attribute_from_other_module():
import math
import keyword
try:
keyword.pi
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "module 'keyword' has no attribute 'pi'" in result
if friendly_traceback.get_lang() == "en":
assert "Did you mean `math`?" in result
import cmath
try:
keyword.pi
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
if friendly_traceback.get_lang() == "en":
assert "Did you mean one of the following modules:" in result
if friendly_traceback._writing_docs:
return result, message
def test_Use_join_with_str():
try:
a = ['a', '2'].join('abc') + ['b', '3'].join('\n')
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert "'list' object has no attribute 'join'" in result
if friendly_traceback.get_lang() == "en":
assert "something like `'abc'.join(['a', '2'])`" in result
if friendly_traceback._writing_docs:
return result, message
def test_Circular_import():
from friendly_traceback.runtime_errors import stdlib_modules
stdlib_modules.names.add("my_turtle1")
try:
import my_turtle1
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
# Different messages for python < 3.8
assert ( "partially initialized module 'my_turtle1'" in result or
"module 'my_turtle1' has no attribute 'something'" in result)
if friendly_traceback.get_lang() == "en":
assert "import" in result
assert "my_turtle1" in result
stdlib_modules.names.pop()
if friendly_traceback._writing_docs:
return result, message
def test_Circular_import_b():
try:
import circular_c
except AttributeError as e:
message = str(e)
friendly_traceback.explain_traceback(redirect="capture")
result = friendly_traceback.get_output()
assert (
"circular_c" in result and
("no attribute" in result or "has no attribute" in result or "partially initialized" in result)
)
if friendly_traceback.get_lang() == "en":
assert "have a circular import." in result
if friendly_traceback._writing_docs:
return result, message
if __name__ == "__main__":
print(test_Generic()[0])
|
