-
-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Expand file tree
/
Copy pathtest_zzz_autoreload.py
More file actions
1155 lines (976 loc) · 38.8 KB
/
test_zzz_autoreload.py
File metadata and controls
1155 lines (976 loc) · 38.8 KB
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Tests for autoreload extension."""
# -----------------------------------------------------------------------------
# Copyright (c) 2012 IPython Development Team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file COPYING.txt, distributed with this software.
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# Imports
# -----------------------------------------------------------------------------
import os
import platform
import pytest
import sys
import tempfile
import textwrap
import shutil
import random
import time
import traceback
from io import StringIO
from dataclasses import dataclass
import IPython.testing.tools as tt
from unittest import TestCase
from IPython.extensions.autoreload import AutoreloadMagics
from IPython.core.events import EventManager, pre_run_cell
from IPython.testing.decorators import skipif_not_numpy
from IPython.core.interactiveshell import ExecutionInfo
from IPython.core import inputtransformer2 as ipt2
if platform.python_implementation() == "PyPy":
pytest.skip(
"Current autoreload implementation is extremely slow on PyPy",
allow_module_level=True,
)
# -----------------------------------------------------------------------------
# Test fixture
# -----------------------------------------------------------------------------
noop = lambda *a, **kw: None
class FakeShell:
def __init__(self):
self.ns = {}
self.user_ns = self.ns
self.user_ns["In"] = []
self.user_ns_hidden = {}
self.events = EventManager(self, {"pre_run_cell", pre_run_cell})
self.auto_magics = AutoreloadMagics(shell=self)
self.events.register("pre_run_cell", self.auto_magics.pre_run_cell)
self.input_transformer_manager = ipt2.TransformerManager()
register_magics = set_hook = noop
def showtraceback(
self,
exc_tuple=None,
filename=None,
tb_offset=None,
exception_only=False,
running_compiled_code=False,
):
traceback.print_exc()
def run_code(self, code):
transformed_cell = self.input_transformer_manager.transform_cell(code)
self.events.trigger(
"pre_run_cell",
ExecutionInfo(
raw_cell=code,
transformed_cell=code,
store_history=False,
silent=False,
shell_futures=False,
cell_id=None,
),
)
exec(code, self.user_ns)
self.auto_magics.post_execute_hook()
def push(self, items):
self.ns.update(items)
def magic_autoreload(self, parameter):
self.auto_magics.autoreload(parameter)
def magic_aimport(self, parameter, stream=None):
self.auto_magics.aimport(parameter, stream=stream)
self.auto_magics.post_execute_hook()
class Fixture(TestCase):
"""Fixture for creating test module files"""
test_dir = None
old_sys_path = None
filename_chars = "abcdefghijklmopqrstuvwxyz0123456789"
def setUp(self):
self.test_dir = tempfile.mkdtemp()
self.old_sys_path = list(sys.path)
sys.path.insert(0, self.test_dir)
self.shell = FakeShell()
def tearDown(self):
shutil.rmtree(self.test_dir)
sys.path = self.old_sys_path
self.test_dir = None
self.old_sys_path = None
self.shell = None
def get_module(self):
module_name = "tmpmod_" + "".join(random.sample(self.filename_chars, 20))
if module_name in sys.modules:
del sys.modules[module_name]
file_name = os.path.join(self.test_dir, module_name + ".py")
return module_name, file_name
def write_file(self, filename, content):
"""
Write a file, and force a timestamp difference of at least one second
Notes
-----
Python's .pyc files record the timestamp of their compilation
with a time resolution of one second.
Therefore, we need to force a timestamp difference between .py
and .pyc, without having the .py file be timestamped in the
future, and without changing the timestamp of the .pyc file
(because that is stored in the file). The only reliable way
to achieve this seems to be to sleep.
"""
content = textwrap.dedent(content)
# Sleep one second + eps
time.sleep(1.05)
# Write
with open(filename, "w", encoding="utf-8") as f:
f.write(content)
def new_module(self, code):
code = textwrap.dedent(code)
mod_name, mod_fn = self.get_module()
with open(mod_fn, "w", encoding="utf-8") as f:
f.write(code)
return mod_name, mod_fn
# -----------------------------------------------------------------------------
# Test automatic reloading
# -----------------------------------------------------------------------------
def pickle_get_current_class(obj):
"""
Original issue comes from pickle; hence the name.
"""
name = obj.__class__.__name__
module_name = getattr(obj, "__module__", None)
obj2 = sys.modules[module_name]
for subpath in name.split("."):
obj2 = getattr(obj2, subpath)
return obj2
class TestAutoreload(Fixture):
def test_reload_enums(self):
mod_name, mod_fn = self.new_module(
textwrap.dedent(
"""
from enum import Enum
class MyEnum(Enum):
A = 'A'
B = 'B'
"""
)
)
self.shell.magic_autoreload("2")
self.shell.magic_aimport(mod_name)
self.write_file(
mod_fn,
textwrap.dedent(
"""
from enum import Enum
class MyEnum(Enum):
A = 'A'
B = 'B'
C = 'C'
"""
),
)
with tt.AssertNotPrints(
("[autoreload of %s failed:" % mod_name), channel="stderr"
):
self.shell.run_code("pass") # trigger another reload
def test_reload_class_type(self):
self.shell.magic_autoreload("2")
mod_name, mod_fn = self.new_module(
"""
class Test():
def meth(self):
return "old"
"""
)
assert "test" not in self.shell.ns
assert "result" not in self.shell.ns
self.shell.run_code("from %s import Test" % mod_name)
self.shell.run_code("test = Test()")
self.write_file(
mod_fn,
"""
class Test():
def meth(self):
return "new"
""",
)
test_object = self.shell.ns["test"]
# important to trigger autoreload logic !
self.shell.run_code("pass")
test_class = pickle_get_current_class(test_object)
assert isinstance(test_object, test_class)
# extra check.
self.shell.run_code("import pickle")
self.shell.run_code("p = pickle.dumps(test)")
def test_reload_class_attributes(self):
self.shell.magic_autoreload("2")
mod_name, mod_fn = self.new_module(
textwrap.dedent(
"""
class MyClass:
def __init__(self, a=10):
self.a = a
self.b = 22
# self.toto = 33
def square(self):
print('compute square')
return self.a*self.a
"""
)
)
self.shell.run_code("from %s import MyClass" % mod_name)
self.shell.run_code("first = MyClass(5)")
self.shell.run_code("first.square()")
with self.assertRaises(AttributeError):
self.shell.run_code("first.cube()")
with self.assertRaises(AttributeError):
self.shell.run_code("first.power(5)")
self.shell.run_code("first.b")
with self.assertRaises(AttributeError):
self.shell.run_code("first.toto")
# remove square, add power
self.write_file(
mod_fn,
textwrap.dedent(
"""
class MyClass:
def __init__(self, a=10):
self.a = a
self.b = 11
def power(self, p):
print('compute power '+str(p))
return self.a**p
"""
),
)
self.shell.run_code("second = MyClass(5)")
for object_name in {"first", "second"}:
self.shell.run_code(f"{object_name}.power(5)")
with self.assertRaises(AttributeError):
self.shell.run_code(f"{object_name}.cube()")
with self.assertRaises(AttributeError):
self.shell.run_code(f"{object_name}.square()")
self.shell.run_code(f"{object_name}.b")
self.shell.run_code(f"{object_name}.a")
with self.assertRaises(AttributeError):
self.shell.run_code(f"{object_name}.toto")
@skipif_not_numpy
def test_comparing_numpy_structures(self):
self.shell.magic_autoreload("2")
self.shell.run_code("1+1")
mod_name, mod_fn = self.new_module(
textwrap.dedent(
"""
import numpy as np
class MyClass:
a = (np.array((.1, .2)),
np.array((.2, .3)))
"""
)
)
self.shell.run_code("from %s import MyClass" % mod_name)
self.shell.run_code("first = MyClass()")
# change property `a`
self.write_file(
mod_fn,
textwrap.dedent(
"""
import numpy as np
class MyClass:
a = (np.array((.3, .4)),
np.array((.5, .6)))
"""
),
)
with tt.AssertNotPrints(
("[autoreload of %s failed:" % mod_name), channel="stderr"
):
self.shell.run_code("pass") # trigger another reload
def test_autoload_newly_added_objects(self):
# All of these fail with %autoreload 2
self.shell.magic_autoreload("3")
mod_code = """
def func1(): pass
"""
mod_name, mod_fn = self.new_module(textwrap.dedent(mod_code))
self.shell.run_code(f"from {mod_name} import *")
self.shell.run_code("func1()")
with self.assertRaises(NameError):
self.shell.run_code("func2()")
with self.assertRaises(NameError):
self.shell.run_code("t = Test()")
with self.assertRaises(NameError):
self.shell.run_code("number")
# ----------- TEST NEW OBJ LOADED --------------------------
new_code = """
def func1(): pass
def func2(): pass
class Test: pass
number = 0
from enum import Enum
class TestEnum(Enum):
A = 'a'
"""
self.write_file(mod_fn, textwrap.dedent(new_code))
# test function now exists in shell's namespace namespace
self.shell.run_code("func2()")
# test function now exists in module's dict
self.shell.run_code(f"import sys; sys.modules['{mod_name}'].func2()")
# test class now exists
self.shell.run_code("t = Test()")
# test global built-in var now exists
self.shell.run_code("number")
# test the enumerations gets loaded successfully
self.shell.run_code("TestEnum.A")
# ----------- TEST NEW OBJ CAN BE CHANGED --------------------
new_code = """
def func1(): return 'changed'
def func2(): return 'changed'
class Test:
def new_func(self):
return 'changed'
number = 1
from enum import Enum
class TestEnum(Enum):
A = 'a'
B = 'added'
"""
self.write_file(mod_fn, textwrap.dedent(new_code))
self.shell.run_code("assert func1() == 'changed'")
self.shell.run_code("assert func2() == 'changed'")
self.shell.run_code("t = Test(); assert t.new_func() == 'changed'")
self.shell.run_code("assert number == 1")
if sys.version_info < (3, 12):
self.shell.run_code("assert TestEnum.B.value == 'added'")
# ----------- TEST IMPORT FROM MODULE --------------------------
new_mod_code = """
from enum import Enum
class Ext(Enum):
A = 'ext'
def ext_func():
return 'ext'
class ExtTest:
def meth(self):
return 'ext'
ext_int = 2
"""
new_mod_name, new_mod_fn = self.new_module(textwrap.dedent(new_mod_code))
current_mod_code = f"""
from {new_mod_name} import *
"""
self.write_file(mod_fn, textwrap.dedent(current_mod_code))
self.shell.run_code("assert Ext.A.value == 'ext'")
self.shell.run_code("assert ext_func() == 'ext'")
self.shell.run_code("t = ExtTest(); assert t.meth() == 'ext'")
self.shell.run_code("assert ext_int == 2")
def test_autoload3_import_Y_as_Z(self):
self.shell.magic_autoreload("3")
mod_code = """
def func1(): pass
n = 1
"""
mod_name, mod_fn = self.new_module(textwrap.dedent(mod_code))
self.shell.run_code(f"from {mod_name} import n as foo")
self.shell.run_code("foo")
with self.assertRaises(NameError):
self.shell.run_code("func1()")
new_code = """
n = 100
def func2(): pass
def func1(): pass
m = 5
"""
self.write_file(mod_fn, textwrap.dedent(new_code))
self.shell.run_code("foo")
with self.assertRaises(NameError):
self.shell.run_code("n")
def test_autoload3_import_Y_as_Z_overloading(self):
self.shell.magic_autoreload("3")
mod_code = """
def func1(): pass
n = 1
"""
mod_name, mod_fn = self.new_module(textwrap.dedent(mod_code))
self.shell.run_code(f"from {mod_name} import n as foo")
self.shell.run_code("foo")
with self.assertRaises(NameError):
self.shell.run_code("func1()")
new_code = """
n = 100
def func2(): pass
def func1(): pass
foo = 45
"""
self.write_file(mod_fn, textwrap.dedent(new_code))
self.shell.run_code(f"assert foo == 100")
self.shell.run_code(f"from {mod_name} import foo")
self.shell.run_code(f"assert foo == 45")
def test_autoload3_normalimport(self):
self.shell.magic_autoreload("3")
mod_code = """
def func1(): pass
n = 1
"""
mod_name, mod_fn = self.new_module(textwrap.dedent(mod_code))
self.shell.run_code(f"import {mod_name}")
self.shell.run_code(f"{mod_name}.func1()")
self.shell.run_code(f"{mod_name}.n")
new_code = """
n = 100
def func2(): pass
def func1(): pass
m = 5
"""
self.write_file(mod_fn, textwrap.dedent(new_code))
self.shell.run_code(f"{mod_name}.func1()")
self.shell.run_code(f"{mod_name}.n")
self.shell.run_code(f"{mod_name}.func2()")
self.shell.run_code(f"{mod_name}.m")
self.shell.run_code(f"from {mod_name} import n")
self.shell.run_code(f"{mod_name}.func1()")
self.shell.run_code(f"n")
def test_autoload3_normalimport_2(self):
self.shell.magic_autoreload("3")
mod_code = """
def func1(): pass
n = 1
"""
mod_name, mod_fn = self.new_module(textwrap.dedent(mod_code))
self.shell.run_code(f"from {mod_name} import n")
with self.assertRaises(NameError):
self.shell.run_code("func1()")
self.shell.run_code("n")
new_code = """
n = 100
def func2(): pass
def func1(): pass
m = 5
"""
self.shell.run_code(f"import {mod_name}")
self.write_file(mod_fn, textwrap.dedent(new_code))
self.shell.run_code(f"{mod_name}.func1()")
self.shell.run_code(f"{mod_name}.n")
self.shell.run_code(f"{mod_name}.func2()")
self.shell.run_code(f"{mod_name}.m")
self.shell.run_code(f"n")
def test_autoload_3_does_not_add_all(self):
# Tests that %autoreload 3 does not effectively run from X import *
self.shell.magic_autoreload("3")
mod_code = """
def func1(): pass
n = 1
"""
mod_name, mod_fn = self.new_module(textwrap.dedent(mod_code))
self.shell.run_code(f"from {mod_name} import n")
self.shell.run_code("n")
with self.assertRaises(NameError):
self.shell.run_code("func()")
new_code = """
n = 1
def func2(): pass
def func1(): pass
m = 5
"""
self.write_file(mod_fn, textwrap.dedent(new_code))
self.shell.run_code("n")
with self.assertRaises(NameError):
self.shell.run_code("func1()")
with self.assertRaises(NameError):
self.shell.run_code("func2()")
with self.assertRaises(NameError):
self.shell.run_code("m")
self.shell.run_code(f"from {mod_name} import m")
self.shell.run_code("n")
self.shell.run_code("m")
with self.assertRaises(NameError):
self.shell.run_code("func1()")
with self.assertRaises(NameError):
self.shell.run_code("func2()")
self.shell.run_code(f"from {mod_name} import func1,func2")
self.shell.run_code("n")
self.shell.run_code("m")
self.shell.run_code("func1()")
self.shell.run_code("func2()")
def test_verbose_names(self):
# Asserts correspondense between original mode names and their verbose equivalents.
@dataclass
class AutoreloadSettings:
check_all: bool
enabled: bool
autoload_obj: bool
def gather_settings(mode):
self.shell.magic_autoreload(mode)
module_reloader = self.shell.auto_magics._reloader
return AutoreloadSettings(
module_reloader.check_all,
module_reloader.enabled,
module_reloader.autoload_obj,
)
assert gather_settings("0") == gather_settings("off")
assert gather_settings("0") == gather_settings("OFF") # Case insensitive
assert gather_settings("1") == gather_settings("explicit")
assert gather_settings("2") == gather_settings("all")
assert gather_settings("3") == gather_settings("complete")
# And an invalid mode name raises an exception.
with self.assertRaises(ValueError):
self.shell.magic_autoreload("4")
def test_aimport_parsing(self):
# Modules can be included or excluded all in one line.
module_reloader = self.shell.auto_magics._reloader
self.shell.magic_aimport("os") # import and mark `os` for auto-reload.
assert module_reloader.modules["os"] is True
assert "os" not in module_reloader.skip_modules.keys()
self.shell.magic_aimport("-math") # forbid autoreloading of `math`
assert module_reloader.skip_modules["math"] is True
assert "math" not in module_reloader.modules.keys()
self.shell.magic_aimport(
"-os, math"
) # Can do this all in one line; wasn't possible before.
assert module_reloader.modules["math"] is True
assert "math" not in module_reloader.skip_modules.keys()
assert module_reloader.skip_modules["os"] is True
assert "os" not in module_reloader.modules.keys()
def test_autoreload_output(self):
self.shell.magic_autoreload("complete")
mod_code = """
def func1(): pass
"""
mod_name, mod_fn = self.new_module(mod_code)
self.shell.run_code(f"import {mod_name}")
with tt.AssertPrints("", channel="stdout"): # no output; this is default
self.shell.run_code("pass")
self.shell.magic_autoreload("complete --print")
self.write_file(mod_fn, mod_code) # "modify" the module
with tt.AssertPrints(
f"Reloading '{mod_name}'.", channel="stdout"
): # see something printed out
self.shell.run_code("pass")
self.shell.magic_autoreload("complete -p")
self.write_file(mod_fn, mod_code) # "modify" the module
with tt.AssertPrints(
f"Reloading '{mod_name}'.", channel="stdout"
): # see something printed out
self.shell.run_code("pass")
self.shell.magic_autoreload("complete --print --log")
self.write_file(mod_fn, mod_code) # "modify" the module
with tt.AssertPrints(
f"Reloading '{mod_name}'.", channel="stdout"
): # see something printed out
self.shell.run_code("pass")
self.shell.magic_autoreload("complete --print --log")
self.write_file(mod_fn, mod_code) # "modify" the module
with self.assertLogs(logger="autoreload") as lo: # see something printed out
self.shell.run_code("pass")
assert lo.output == [f"INFO:autoreload:Reloading '{mod_name}'."]
self.shell.magic_autoreload("complete -l")
self.write_file(mod_fn, mod_code) # "modify" the module
with self.assertLogs(logger="autoreload") as lo: # see something printed out
self.shell.run_code("pass")
assert lo.output == [f"INFO:autoreload:Reloading '{mod_name}'."]
def _check_smoketest(self, use_aimport=True):
"""
Functional test for the automatic reloader using either
'%autoreload 1' or '%autoreload 2'
"""
mod_name, mod_fn = self.new_module(
"""
x = 9
z = 123 # this item will be deleted
def foo(y):
return y + 3
class Baz(object):
def __init__(self, x):
self.x = x
def bar(self, y):
return self.x + y
@property
def quux(self):
return 42
def zzz(self):
'''This method will be deleted below'''
return 99
class Bar: # old-style class: weakref doesn't work for it on Python < 2.7
def foo(self):
return 1
"""
)
#
# Import module, and mark for reloading
#
if use_aimport:
self.shell.magic_autoreload("1")
self.shell.magic_aimport(mod_name)
stream = StringIO()
self.shell.magic_aimport("", stream=stream)
self.assertIn(("Modules to reload:\n%s" % mod_name), stream.getvalue())
with self.assertRaises(ImportError):
self.shell.magic_aimport("tmpmod_as318989e89ds")
else:
self.shell.magic_autoreload("2")
self.shell.run_code("import %s" % mod_name)
stream = StringIO()
self.shell.magic_aimport("", stream=stream)
self.assertTrue(
"Modules to reload:\nall-except-skipped" in stream.getvalue()
)
self.assertIn(mod_name, self.shell.ns)
mod = sys.modules[mod_name]
#
# Test module contents
#
old_foo = mod.foo
old_obj = mod.Baz(9)
old_obj2 = mod.Bar()
def check_module_contents():
self.assertEqual(mod.x, 9)
self.assertEqual(mod.z, 123)
self.assertEqual(old_foo(0), 3)
self.assertEqual(mod.foo(0), 3)
obj = mod.Baz(9)
self.assertEqual(old_obj.bar(1), 10)
self.assertEqual(obj.bar(1), 10)
self.assertEqual(obj.quux, 42)
self.assertEqual(obj.zzz(), 99)
obj2 = mod.Bar()
self.assertEqual(old_obj2.foo(), 1)
self.assertEqual(obj2.foo(), 1)
check_module_contents()
#
# Simulate a failed reload: no reload should occur and exactly
# one error message should be printed
#
self.write_file(
mod_fn,
"""
a syntax error
""",
)
with tt.AssertPrints(
("[autoreload of %s failed:" % mod_name), channel="stderr"
):
self.shell.run_code("pass") # trigger reload
with tt.AssertNotPrints(
("[autoreload of %s failed:" % mod_name), channel="stderr"
):
self.shell.run_code("pass") # trigger another reload
check_module_contents()
#
# Rewrite module (this time reload should succeed)
#
self.write_file(
mod_fn,
"""
x = 10
def foo(y):
return y + 4
class Baz(object):
def __init__(self, x):
self.x = x
def bar(self, y):
return self.x + y + 1
@property
def quux(self):
return 43
class Bar: # old-style class
def foo(self):
return 2
""",
)
def check_module_contents():
self.assertEqual(mod.x, 10)
self.assertFalse(hasattr(mod, "z"))
self.assertEqual(old_foo(0), 4) # superreload magic!
self.assertEqual(mod.foo(0), 4)
obj = mod.Baz(9)
self.assertEqual(old_obj.bar(1), 11) # superreload magic!
self.assertEqual(obj.bar(1), 11)
self.assertEqual(old_obj.quux, 43)
self.assertEqual(obj.quux, 43)
self.assertFalse(hasattr(old_obj, "zzz"))
self.assertFalse(hasattr(obj, "zzz"))
obj2 = mod.Bar()
self.assertEqual(old_obj2.foo(), 2)
self.assertEqual(obj2.foo(), 2)
self.shell.run_code("pass") # trigger reload
check_module_contents()
#
# Another failure case: deleted file (shouldn't reload)
#
os.unlink(mod_fn)
self.shell.run_code("pass") # trigger reload
check_module_contents()
#
# Disable autoreload and rewrite module: no reload should occur
#
if use_aimport:
self.shell.magic_aimport("-" + mod_name)
stream = StringIO()
self.shell.magic_aimport("", stream=stream)
self.assertTrue(("Modules to skip:\n%s" % mod_name) in stream.getvalue())
# This should succeed, although no such module exists
self.shell.magic_aimport("-tmpmod_as318989e89ds")
else:
self.shell.magic_autoreload("0")
self.write_file(
mod_fn,
"""
x = -99
""",
)
self.shell.run_code("pass") # trigger reload
self.shell.run_code("pass")
check_module_contents()
#
# Re-enable autoreload: reload should now occur
#
if use_aimport:
self.shell.magic_aimport(mod_name)
else:
self.shell.magic_autoreload("")
self.shell.run_code("pass") # trigger reload
self.assertEqual(mod.x, -99)
def test_smoketest_aimport(self):
self._check_smoketest(use_aimport=True)
def test_smoketest_autoreload(self):
self._check_smoketest(use_aimport=False)
def test_autoreload_with_user_defined_In_variable(self):
"""
Check that autoreload works when the user has defined an In variable.
"""
mod_name, mod_fn = self.new_module(
textwrap.dedent(
"""
def hello():
return "Hello"
"""
)
)
self.shell.magic_autoreload("2")
self.shell.run_code(f"import {mod_name}")
self.shell.run_code(f"res = {mod_name}.hello()")
assert self.shell.user_ns["res"] == "Hello"
self.shell.user_ns["In"] = "some_value"
self.write_file(
mod_fn,
textwrap.dedent(
"""
def hello():
return "Changed"
"""
),
)
self.shell.run_code(f"res = {mod_name}.hello()")
assert self.shell.user_ns["res"] == "Changed"
def test_import_from_tracker_conflict_resolution(self):
"""Test that ImportFromTracker properly handles import conflicts"""
from IPython.extensions.autoreload import ImportFromTracker
from unittest.mock import Mock
# Create a test module with both 'foo' and 'bar' attributes
mod_name, mod_fn = self.new_module(
textwrap.dedent(
"""
foo = "original_foo"
bar = "original_bar"
"""
)
)
# Mock the module in sys.modules instead of actually importing it
mock_module = Mock()
mock_module.foo = "original_foo"
mock_module.bar = "original_bar"
sys.modules[mod_name] = mock_module
try:
# Create a tracker
tracker = ImportFromTracker({}, {})
# Test case 1: "from x import y as z" then "from x import z"
# First import: from mod_name import foo as bar
tracker.add_import(mod_name, "foo", "bar")
# Verify initial state
assert mod_name in tracker.imports_froms
assert "foo" in tracker.imports_froms[mod_name]
assert tracker.symbol_map[mod_name]["foo"] == ["bar"]
# Second import: from mod_name import bar (conflicts with previous "bar")
tracker.add_import(mod_name, "bar", "bar")
# The second import should take precedence since "bar" is a valid import
assert "bar" in tracker.imports_froms[mod_name]
assert "foo" not in tracker.imports_froms[mod_name] # Should be removed
assert tracker.symbol_map[mod_name]["bar"] == ["bar"]
assert "foo" not in tracker.symbol_map[mod_name] # Should be removed
finally:
# Clean up sys.modules
if mod_name in sys.modules:
del sys.modules[mod_name]
def test_import_from_tracker_reverse_conflict(self):
"""Test the reverse case: 'from x import z' then 'from x import y as z'"""
from IPython.extensions.autoreload import ImportFromTracker
from unittest.mock import Mock
# Create a test module
mod_name, mod_fn = self.new_module(
textwrap.dedent(
"""
foo = "original_foo"
bar = "original_bar"
"""
)
)
# Mock the module in sys.modules instead of actually importing it
mock_module = Mock()
mock_module.foo = "original_foo"
mock_module.bar = "original_bar"
sys.modules[mod_name] = mock_module
try:
# Create a tracker
tracker = ImportFromTracker({}, {})
# First import: from mod_name import bar
tracker.add_import(mod_name, "bar", "bar")
# Verify initial state
assert "bar" in tracker.imports_froms[mod_name]
assert tracker.symbol_map[mod_name]["bar"] == ["bar"]
# Second import: from mod_name import foo as bar (conflicts with previous "bar")
tracker.add_import(mod_name, "foo", "bar")
# The second import should take precedence since "foo" is a valid import
assert "foo" in tracker.imports_froms[mod_name]
assert "bar" not in tracker.imports_froms[mod_name] # Should be removed
assert tracker.symbol_map[mod_name]["foo"] == ["bar"]
assert "bar" not in tracker.symbol_map[mod_name] # Should be removed
finally:
# Clean up sys.modules
if mod_name in sys.modules:
del sys.modules[mod_name]
def test_import_from_tracker_invalid_import(self):
"""Test that ImportFromTracker works correctly with the post-execution approach"""
from IPython.extensions.autoreload import ImportFromTracker
# Create a test module with only 'foo' attribute
mod_name, mod_fn = self.new_module(
textwrap.dedent(
"""
foo = "original_foo"
"""
)
)
# Create a tracker
tracker = ImportFromTracker({}, {})