-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathtest_concrete_annotations.py
1247 lines (1007 loc) · 47.3 KB
/
test_concrete_annotations.py
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
import textwrap
import pytest
from extended_mypy_django_plugin_test_driver import Scenario, ScenarioBuilder, ScenarioRunner
from pytest_typing_runner import expectations, notices, runners
class TestConcreteAnnotations:
def test_cast_as_concrete(self, builder: ScenarioBuilder) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_and_copy_installed_apps("leader", "simple")
builder.on("main.py").set(
"""
from simple.models import Follow1, Follow2
from leader.models import Leader
from extended_mypy_django_plugin import Concrete
from typing import Any, TypeVar
from typing_extensions import Self
model: type[Leader] = Follow1
# ^ REVEAL ^ type[leader.models.Leader]
class Thing:
def __init__(self, model: type[Leader]) -> None:
self.model = model
found = Concrete.cast_as_concrete(Thing(model=model).model)
# ^ REVEAL ^ Union[type[simple.models.Follow1], type[simple.models.Follow2]]
thing = Thing(model=model)
found = Concrete.cast_as_concrete(thing.model)
# ^ REVEAL ^ Union[type[simple.models.Follow1], type[simple.models.Follow2]]
model = Concrete.cast_as_concrete(model)
# ^ REVEAL ^ Union[type[simple.models.Follow1], type[simple.models.Follow2]]
model2: type[Leader] = Follow1
# ^ REVEAL ^ type[leader.models.Leader]
model3 = Concrete.cast_as_concrete(model2)
# ^ REVEAL ^ Union[type[simple.models.Follow1], type[simple.models.Follow2]]
model2
# ^ REVEAL ^ type[leader.models.Leader]
instance: Leader = Follow1.objects.create()
# ^ REVEAL ^ leader.models.Leader
instance = Concrete.cast_as_concrete(instance)
# ^ REVEAL ^ Union[simple.models.Follow1, simple.models.Follow2]
instance2: Leader = Follow1.objects.create()
# ^ REVEAL ^ leader.models.Leader
instance3 = Concrete.cast_as_concrete(instance2)
# ^ REVEAL ^ Union[simple.models.Follow1, simple.models.Follow2]
instance2
# ^ REVEAL ^ leader.models.Leader
thing = Concrete.cast_as_concrete(nup)
# ^ ERROR(misc) ^ Failed to determine the type of the first argument
# ^ ERROR(name-defined) ^ Name "nup" is not defined
a: Any = None
thing = Concrete.cast_as_concrete(a)
# ^ ERROR(misc) ^ Failed to determine the type of the first argument
T_LeaderNormal = TypeVar("T_LeaderNormal", bound=Leader)
def myfunc(model: type[T_LeaderNormal]) -> T_LeaderNormal:
concrete = Concrete.cast_as_concrete(model)
# ^ REVEAL ^ Union[type[simple.models.Follow1], type[simple.models.Follow2]]
created = concrete.objects.create()
assert isinstance(created, model)
return created
T_Choices = TypeVar("T_Choices", Follow1, Follow2)
def myfunc2(model: type[T_Choices]) -> T_Choices:
concrete = Concrete.cast_as_concrete(model)
# ^ REVEAL ^ type[simple.models.Follow1]
# ^ REVEAL ^ type[simple.models.Follow2]
created = concrete.objects.create()
assert isinstance(created, model)
return created
def myfunc3(model: type[Self]) -> Self:
# ^ ERROR(misc) ^ Self type is only allowed in annotations within class definition
model = Concrete.cast_as_concrete(model)
# ^ ERROR(misc) ^ cast_as_concrete must take a variable with a clear type, got Any: (<class 'mypy.types.AnyType'>)
return model.objects.create()
""",
)
def test_simple_annotation(self, builder: ScenarioBuilder) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_and_copy_installed_apps("myapp", "myapp2")
builder.on("main.py").set(
"""
from extended_mypy_django_plugin import Concrete, DefaultQuerySet
from typing import cast, TypeGuard
from myapp.models import Parent, Child1, Child2
def check_cls_with_type_guard(cls: type[Parent]) -> TypeGuard[type[Concrete[Parent]]]:
return True
def check_instance_with_type_guard(cls: Parent) -> TypeGuard[Concrete[Parent]]:
return True
models: Concrete[Parent]
# ^ REVEAL ^ Union[myapp.models.Child1, myapp.models.Child2, myapp.models.Child3, myapp2.models.ChildOther]
qs: DefaultQuerySet[Parent]
# ^ REVEAL ^ Union[django.db.models.query.QuerySet[myapp.models.Child1, myapp.models.Child1], myapp.models.Child2QuerySet, django.db.models.query.QuerySet[myapp.models.Child3, myapp.models.Child3], django.db.models.query.QuerySet[myapp2.models.ChildOther, myapp2.models.ChildOther]]
cls: type[Parent] = Child1
assert check_cls_with_type_guard(cls)
cls
# ^ REVEAL ^ Union[type[myapp.models.Child1], type[myapp.models.Child2], type[myapp.models.Child3], type[myapp2.models.ChildOther]]
instance: Parent = cast(Child1, None)
assert check_instance_with_type_guard(instance)
instance
# ^ REVEAL ^ Union[myapp.models.Child1, myapp.models.Child2, myapp.models.Child3, myapp2.models.ChildOther]
children: Concrete[Parent]
# ^ REVEAL ^ Union[myapp.models.Child1, myapp.models.Child2, myapp.models.Child3, myapp2.models.ChildOther]
children_qs: DefaultQuerySet[Parent]
# ^ REVEAL ^ Union[django.db.models.query.QuerySet[myapp.models.Child1, myapp.models.Child1], myapp.models.Child2QuerySet, django.db.models.query.QuerySet[myapp.models.Child3, myapp.models.Child3], django.db.models.query.QuerySet[myapp2.models.ChildOther, myapp2.models.ChildOther]]
child: Concrete[Child1]
# ^ REVEAL ^ myapp.models.Child1
child1_qs: DefaultQuerySet[Child1]
# ^ REVEAL ^ django.db.models.query.QuerySet[myapp.models.Child1, myapp.models.Child1]
child2_qs: DefaultQuerySet[Child2]
# ^ REVEAL ^ myapp.models.Child2QuerySet
t1_children: type[Concrete[Parent]]
# ^ REVEAL ^ Union[type[myapp.models.Child1], type[myapp.models.Child2], type[myapp.models.Child3], type[myapp2.models.ChildOther]]
t1_children_qs: type[DefaultQuerySet[Parent]]
# ^ REVEAL ^ Union[type[django.db.models.query.QuerySet[myapp.models.Child1, myapp.models.Child1]], type[myapp.models.Child2QuerySet], type[django.db.models.query.QuerySet[myapp.models.Child3, myapp.models.Child3]], type[django.db.models.query.QuerySet[myapp2.models.ChildOther, myapp2.models.ChildOther]]]
t1_child: type[Concrete[Child1]]
# ^ REVEAL ^ type[myapp.models.Child1]
t1_child1_qs: type[DefaultQuerySet[Child1]]
# ^ REVEAL ^ type[django.db.models.query.QuerySet[myapp.models.Child1, myapp.models.Child1]]
t1_child2_qs: type[DefaultQuerySet[Child2]]
# ^ REVEAL ^ type[myapp.models.Child2QuerySet]
t2_children: Concrete[type[Parent]]
# ^ REVEAL ^ Union[type[myapp.models.Child1], type[myapp.models.Child2], type[myapp.models.Child3], type[myapp2.models.ChildOther]]
t2_children_qs: DefaultQuerySet[type[Parent]]
# ^ REVEAL ^ Union[type[django.db.models.query.QuerySet[myapp.models.Child1, myapp.models.Child1]], type[myapp.models.Child2QuerySet], type[django.db.models.query.QuerySet[myapp.models.Child3, myapp.models.Child3]], type[django.db.models.query.QuerySet[myapp2.models.ChildOther, myapp2.models.ChildOther]]]
t2_child: Concrete[type[Child1]]
# ^ REVEAL ^ type[myapp.models.Child1]
t2_child1_qs: DefaultQuerySet[type[Child1]]
# ^ REVEAL ^ type[django.db.models.query.QuerySet[myapp.models.Child1, myapp.models.Child1]]
t2_child2_qs: DefaultQuerySet[type[Child2]]
# ^ REVEAL ^ type[myapp.models.Child2QuerySet]
""",
)
def test_can_reference_concrete_model_across_apps(self, builder: ScenarioBuilder) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_installed_apps("example", "example2")
for app in ("example", "example2"):
builder.on(f"{app}/__init__.py").set("")
builder.on(f"{app}/apps.py").set(
f"""
from django.apps import AppConfig
class Config(AppConfig):
name = "{app}"
""",
)
builder.on("example/models/__init__.py").set(
"""
from .parent import Parent
"""
)
builder.on("example2/models/__init__.py").set(
"""
from .children import Child, DTO
"""
)
builder.on("example/models/parent.py").set(
"""
from django.db import models
class Parent(models.Model):
class Meta:
abstract = True
""",
)
builder.on("example2/models/children.py").set(
"""
from extended_mypy_django_plugin import Concrete
from example import models as common_models
import dataclasses
from django.db import models
class Child(common_models.Parent):
...
@dataclasses.dataclass
class DTO:
models_cls: type[Concrete[common_models.Parent]]
""",
)
builder.on("main.py").set(
"""
from extended_mypy_django_plugin import Concrete
from typing import cast
from example import models as common_models
from example2 import models as models2
cls: Concrete[common_models.Parent]
# ^ REVEAL ^ example2.models.children.Child
cast(models2.DTO, None).models_cls
# ^ REVEAL ^ type[example2.models.children.Child]
""",
)
def test_can_use_type_var_before_class_is_defined(self, builder: ScenarioBuilder) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_installed_apps("example")
builder.on("example/__init__.py").set("")
builder.on("example/apps.py").set(
"""
from django.apps import AppConfig
class Config(AppConfig):
name = "example"
""",
)
builder.on("example/models.py").set(
"""
from __future__ import annotations
from django.db import models
from typing import Any, TypeVar
from typing_extensions import Self
from extended_mypy_django_plugin import Concrete
T_Leader = TypeVar("T_Leader", bound=Concrete["Leader"])
class Leader(models.Model):
@classmethod
def new(cls) -> Self:
concrete = Concrete.cast_as_concrete(cls)
# ^ REVEAL ^ Union[type[example.models.Follower1], type[example.models.Follower2]]
created = concrete.objects.create()
assert isinstance(created, cls)
return created
@classmethod
def new_with_kwargs(cls, **kwargs: Any) -> Self:
concrete = Concrete.cast_as_concrete(cls)
# ^ REVEAL ^ Union[type[example.models.Follower1], type[example.models.Follower2]]
created = concrete.objects.create(**kwargs)
assert isinstance(created, cls)
return created
class Meta:
abstract = True
class Follower1(Leader):
...
class Follower2(Leader):
...
def make_instance(cls: type[T_Leader]) -> T_Leader:
created = cls.new()
# ^ REVEAL ^ Union[example.models.Follower1, example.models.Follower2]
assert isinstance(created, cls)
return created
""",
)
builder.on("main.py").set(
"""
from example.models import Leader, Follower1, Follower2, make_instance
from extended_mypy_django_plugin import Concrete
instance1 = make_instance(Follower1)
# ^ REVEAL ^ example.models.Follower1
instance2 = make_instance(Follower2)
# ^ REVEAL ^ example.models.Follower2
from_new_with_kwargs = Follower1.new_with_kwargs()
# ^ REVEAL ^ example.models.Follower1
model: type[Concrete[Leader]] = Follower1
# ^ REVEAL ^ Union[type[example.models.Follower1], type[example.models.Follower2]]
""",
# TODO: Make this possible
# would require generating overload variants on make_instance
# instance3 = make_instance(model)
# # ^ REVEAL ^ Union[example.models.Follower1, example.models.Follower2]
# """,
)
def test_using_concrete_annotation_on_class_used_in_annotation(
self, builder: ScenarioBuilder
) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_installed_apps("example")
builder.on("example/__init__.py").set("")
builder.on("example/apps.py").set(
"""
from django.apps import AppConfig
class Config(AppConfig):
name = "example"
""",
)
builder.on("example/models.py").set(
"""
from __future__ import annotations
from django.db import models
from collections.abc import Callable
from typing_extensions import Self
from typing import Protocol, TYPE_CHECKING
from extended_mypy_django_plugin import Concrete, DefaultQuerySet
class Leader(models.Model):
@classmethod
def new(cls) -> Self:
concrete = Concrete.cast_as_concrete(cls)
# ^ REVEAL[cls-all] ^ Union[type[example.models.Follower1], type[example.models.Follower2]]
created = concrete.objects.create()
assert isinstance(created, cls)
return created
def qs(self) -> DefaultQuerySet[Leader]:
concrete = Concrete.cast_as_concrete(self)
# ^ REVEAL[self-all] ^ Union[example.models.Follower1, example.models.Follower2]
return concrete.__class__.objects.filter(pk=self.pk)
class Meta:
abstract = True
class Follower1QuerySet(models.QuerySet["Follower1"]):
...
Follower1Manager = models.Manager.from_queryset(Follower1QuerySet)
class Follower1(Leader):
objects = Follower1Manager()
class Follower2(Leader):
...
if TYPE_CHECKING:
_CL: Concrete[Leader]
# ^ REVEAL[base-all] ^ Union[example.models.Follower1, example.models.Follower2]
""",
)
builder.on("main.py").set(
"""
from example.models import Leader, Follower1, Follower2
from extended_mypy_django_plugin import Concrete
model: type[Concrete[Leader]]
# ^ REVEAL[model] ^ Union[type[example.models.Follower1], type[example.models.Follower2]]
leader = model.new()
# ^ REVEAL[leader-new] ^ Union[example.models.Follower1, example.models.Follower2]
qs = leader.qs()
# ^ REVEAL[all-qs] ^ Union[example.models.Follower1QuerySet, django.db.models.query.QuerySet[example.models.Follower2, example.models.Follower2]]
follower1 = Follower1.new()
# ^ REVEAL ^ example.models.Follower1
qs3 = Follower2.new().qs()
# TODO: Make this work
# we want just Follower2, but we get everything
# django.db.models.query.QuerySet[example.models.Follower2, example.models.Follower2]
other: Leader = Follower1.new()
# ^ REVEAL ^ example.models.Leader
narrowed = Concrete.cast_as_concrete(other)
# ^ REVEAL[narrowed] ^ Union[example.models.Follower1, example.models.Follower2]
other
# ^ REVEAL ^ example.models.Leader
""",
)
@builder.run_and_check_after
def _() -> None:
builder.set_installed_apps("example", "example2")
builder.on("example2/__init__.py").set("")
builder.on("example2/apps.py").set(
"""
from django.apps import AppConfig
class Config(AppConfig):
name = "example2"
""",
)
builder.on("example2/models.py").set(
"""
from example.models import Leader
class Follower3(Leader):
pass
""",
)
builder.daemon_should_restart()
builder.on("example/models.py").expect(
notices.AddRevealedTypes(
name="cls-all",
revealed=[
"Union[type[example.models.Follower1], type[example.models.Follower2], type[example2.models.Follower3]]"
],
replace=True,
),
notices.AddRevealedTypes(
name="self-all",
revealed=[
"Union[example.models.Follower1, example.models.Follower2, example2.models.Follower3]"
],
replace=True,
),
notices.AddRevealedTypes(
name="base-all",
revealed=[
"Union[example.models.Follower1, example.models.Follower2, example2.models.Follower3]"
],
replace=True,
),
)
builder.on("main.py").expect(
notices.AddRevealedTypes(
name="model",
revealed=[
"Union[type[example.models.Follower1], type[example.models.Follower2], type[example2.models.Follower3]]"
],
replace=True,
),
notices.AddRevealedTypes(
name="leader-new",
revealed=[
"Union[example.models.Follower1, example.models.Follower2, example2.models.Follower3]"
],
replace=True,
),
notices.AddRevealedTypes(
name="all-qs",
revealed=[
"Union[example.models.Follower1QuerySet, django.db.models.query.QuerySet[example.models.Follower2, example.models.Follower2], django.db.models.query.QuerySet[example2.models.Follower3, example2.models.Follower3]]"
],
replace=True,
),
notices.AddRevealedTypes(
name="narrowed",
revealed=[
"Union[example.models.Follower1, example.models.Follower2, example2.models.Follower3]"
],
replace=True,
),
)
def test_resolving_concrete_type_vars(self, builder: ScenarioBuilder) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_installed_apps("example")
builder.on("example/__init__.py").set("")
builder.on("example/apps.py").set(
"""
from django.apps import AppConfig
class Config(AppConfig):
name = "example"
""",
)
builder.on("example/models.py").set(
"""
from __future__ import annotations
from django.db import models
from collections.abc import Callable
from typing_extensions import Self
from typing import Protocol, TypeVar
from extended_mypy_django_plugin import Concrete, DefaultQuerySet
T_Leader = TypeVar("T_Leader", bound=Concrete["Leader"])
class Leader(models.Model):
class Meta:
abstract = True
def thing() -> None:
all_concrete: Concrete[Leader]
# ^ REVEAL[leader-concrete-where-leader-defined] ^ Union[example.models.Follower1, example.models.Follower2]
class Follower1QuerySet(models.QuerySet["Follower1"]):
...
Follower1Manager = models.Manager.from_queryset(Follower1QuerySet)
class Follower1(Leader):
objects = Follower1Manager()
class Follower2(Leader):
...
def make_queryset(instance: T_Leader, /) -> DefaultQuerySet[Leader]:
return instance.__class__.objects.filter(pk=instance.pk)
class MakeQueryset(Protocol):
def __call__(self, instance: T_Leader, /) -> DefaultQuerySet[Leader]:
...
functions: list[MakeQueryset] = [make_queryset]
functions2: list[Callable[[T_Leader], DefaultQuerySet[Leader]]] = [make_queryset]
""",
)
builder.on("main.py").set(
"""
from example.models import Leader, Follower1, Follower2, functions, functions2, make_queryset
from extended_mypy_django_plugin import Concrete
from typing import TypeVar
from example import models
# Test can be made with "models.Leader" (as in with a MemberExpr)
T_Leader = TypeVar("T_Leader", bound=Concrete[models.Leader])
def get_leader(cls: type[T_Leader]) -> T_Leader:
created = cls.objects.create()
assert isinstance(created, cls)
return created
made = get_leader(Follower1)
# ^ REVEAL ^ example.models.Follower1
all_concrete: Concrete[Leader]
# ^ REVEAL[all-concrete] ^ Union[example.models.Follower1, example.models.Follower2]
follower1 = Follower1.objects.create()
# ^ REVEAL ^ example.models.Follower1
func = functions[0]
# ^ REVEAL ^ example.models.MakeQueryset
func2 = functions2[0]
# TODO: Figure out how to make the queryset line up
qs1 = func(follower1)
# ^ REVEAL[all-qs1] ^ Union[example.models.Follower1QuerySet, django.db.models.query.QuerySet[example.models.Follower2, example.models.Follower2]]
qs2 = func2(follower1)
# ^ REVEAL[all-qs2] ^ Union[example.models.Follower1QuerySet, django.db.models.query.QuerySet[example.models.Follower2, example.models.Follower2]]
qs5 = make_queryset(follower1)
# ^ REVEAL[all-qs3] ^ Union[example.models.Follower1QuerySet, django.db.models.query.QuerySet[example.models.Follower2, example.models.Follower2]]
""",
)
@builder.run_and_check_after
def _() -> None:
builder.set_installed_apps("example", "example2")
builder.on("example2/__init__.py").set("")
builder.on("example2/apps.py").set(
"""
from django.apps import AppConfig
class Config(AppConfig):
name = "example2"
""",
)
builder.on("example2/models.py").set(
"""
from __future__ import annotations
from example.models import Leader
from django.db import models
class Follower3QuerySet(models.QuerySet["Follower3"]):
...
Follower3Manager = models.Manager.from_queryset(Follower3QuerySet)
class Follower3(Leader):
objects = Follower3Manager()
""",
)
builder.daemon_should_restart()
builder.on("example/models.py").expect(
notices.AddRevealedTypes(
name="leader-concrete-where-leader-defined",
revealed=[
"Union[example.models.Follower1, example.models.Follower2, example2.models.Follower3]"
],
replace=True,
)
)
builder.on("main.py").expect(
notices.AddRevealedTypes(
name="all-concrete",
revealed=[
"Union[example.models.Follower1, example.models.Follower2, example2.models.Follower3]"
],
replace=True,
),
# TODO: Make these specific to follower1
notices.AddRevealedTypes(
name="all-qs1",
revealed=[
"Union[example.models.Follower1QuerySet, django.db.models.query.QuerySet[example.models.Follower2, example.models.Follower2], example2.models.Follower3QuerySet]"
],
replace=True,
),
notices.AddRevealedTypes(
name="all-qs2",
revealed=[
"Union[example.models.Follower1QuerySet, django.db.models.query.QuerySet[example.models.Follower2, example.models.Follower2], example2.models.Follower3QuerySet]"
],
replace=True,
),
notices.AddRevealedTypes(
name="all-qs3",
revealed=[
"Union[example.models.Follower1QuerySet, django.db.models.query.QuerySet[example.models.Follower2, example.models.Follower2], example2.models.Follower3QuerySet]"
],
replace=True,
),
)
def test_restarts_dmypy_if_names_of_known_settings_change(
self, scenario: Scenario, scenario_runner: ScenarioRunner
) -> None:
options = runners.RunOptions.create(scenario_runner)
if not options.program_runner_maker.is_daemon:
pytest.skip("Test only relevant for the daemon")
scenario_runner.run_and_check(
setup_expectations=expectations.Expectations.setup_for_success, options=options
)
settings_path = f"{scenario.info.django_settings_module}.py"
original_settings = (scenario.root_dir / settings_path).read_text()
scenario_runner.file_modification(
settings_path,
(
original_settings
+ textwrap.dedent(
"""
ONE: int = 1
TWO: str = "2"
"""
)
),
)
scenario.expects.daemon_restarted = True
scenario_runner.run_and_check(
setup_expectations=expectations.Expectations.setup_for_success, options=options
)
scenario.expects.daemon_restarted = False
scenario_runner.run_and_check(
setup_expectations=expectations.Expectations.setup_for_success, options=options
)
# Same names, different types should restart
scenario_runner.file_modification(
settings_path,
(
original_settings
+ textwrap.dedent(
"""
ONE: str = "1"
TWO: str = "2"
"""
)
),
)
scenario.expects.daemon_restarted = True
scenario_runner.run_and_check(
setup_expectations=expectations.Expectations.setup_for_success, options=options
)
scenario.expects.daemon_restarted = False
scenario_runner.run_and_check(
setup_expectations=expectations.Expectations.setup_for_success, options=options
)
# Same names, same types, different values should not restart
scenario_runner.file_modification(
settings_path,
(
original_settings
+ textwrap.dedent(
"""
ONE: str = "3"
TWO: str = "4"
"""
)
),
)
scenario.expects.daemon_restarted = False
scenario_runner.run_and_check(
setup_expectations=expectations.Expectations.setup_for_success, options=options
)
scenario.expects.daemon_restarted = False
scenario_runner.run_and_check(
setup_expectations=expectations.Expectations.setup_for_success, options=options
)
# removed names should restart
scenario_runner.file_modification(
settings_path,
(
original_settings
+ textwrap.dedent(
"""
TWO: str = "5"
"""
)
),
)
scenario.expects.daemon_restarted = True
scenario_runner.run_and_check(
setup_expectations=expectations.Expectations.setup_for_success, options=options
)
scenario.expects.daemon_restarted = False
scenario_runner.run_and_check(
setup_expectations=expectations.Expectations.setup_for_success, options=options
)
def test_sees_apps_removed_when_they_still_exist_but_no_longer_installed(
self, builder: ScenarioBuilder
) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_and_copy_installed_apps("myapp", "myapp2")
builder.on("main.py").set(
"""
from extended_mypy_django_plugin import Concrete, DefaultQuerySet
from myapp.models import Parent
models: Concrete[Parent]
# ^ REVEAL[concrete-parent] ^ Union[myapp.models.Child1, myapp.models.Child2, myapp.models.Child3, myapp2.models.ChildOther]
qs: DefaultQuerySet[Parent]
# ^ REVEAL[qs-parent] ^ Union[django.db.models.query.QuerySet[myapp.models.Child1, myapp.models.Child1], myapp.models.Child2QuerySet, django.db.models.query.QuerySet[myapp.models.Child3, myapp.models.Child3], django.db.models.query.QuerySet[myapp2.models.ChildOther, myapp2.models.ChildOther]]
""",
)
# Now let's remove myapp2 from the installed_apps and see that the daemon restarts and myapp2 is removed from the revealed types
@builder.run_and_check_after
def _() -> None:
builder.set_installed_apps("myapp")
builder.daemon_should_restart()
builder.on("main.py").expect(
notices.RemoveFromRevealedType(
name="concrete-parent",
remove=", myapp2.models.ChildOther",
),
notices.RemoveFromRevealedType(
name="qs-parent",
remove=", django.db.models.query.QuerySet[myapp2.models.ChildOther, myapp2.models.ChildOther]",
),
)
def test_does_not_see_apps_that_exist_but_are_not_installed(
self, builder: ScenarioBuilder
) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_installed_apps("myapp")
builder.copy_django_apps("myapp", "myapp2")
builder.on("main.py").set(
"""
from extended_mypy_django_plugin import Concrete, DefaultQuerySet
from myapp.models import Parent
model: Concrete[Parent]
model.concrete_from_myapp
# ^ NAME[access1] ^
qs: DefaultQuerySet[Parent]
qs.values("concrete_from_myapp")
# ^ NAME[access2] ^
""",
)
# And after installing the app means the types expand
@builder.run_and_check_after
def _() -> None:
builder.set_installed_apps("myapp", "myapp2")
builder.daemon_should_restart()
builder.on("main.py").expect(
notices.AddErrors(
name="access1",
errors=[
(
"union-attr",
'Item "ChildOther" of "Child1 | Child2 | Child3 | ChildOther" has no attribute "concrete_from_myapp"',
)
],
replace=False,
),
notices.AddErrors(
name="access2",
errors=[
(
"misc",
"Cannot resolve keyword 'concrete_from_myapp' into field. Choices are: concrete_from_myapp2, id, one, two",
)
],
replace=False,
),
)
def test_sees_models_when_they_are_added_and_installed(self, builder: ScenarioBuilder) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_and_copy_installed_apps("myapp")
builder.on("main.py").set(
"""
from extended_mypy_django_plugin import Concrete, DefaultQuerySet
from myapp.models import Parent
models: Concrete[Parent]
# ^ REVEAL[concrete-parent] ^ Union[myapp.models.Child1, myapp.models.Child2, myapp.models.Child3]
qs: DefaultQuerySet[Parent]
qs.values("concrete_from_myapp")
# ^ NAME[concrete-qs] ^
""",
)
# and the models become available after being installed
@builder.run_and_check_after
def _() -> None:
builder.set_and_copy_installed_apps("myapp", "myapp2")
builder.daemon_should_restart()
builder.on("main.py").expect(
notices.AddRevealedTypes(
name="concrete-parent",
revealed=[
"Union[myapp.models.Child1, myapp.models.Child2, myapp.models.Child3, myapp2.models.ChildOther]"
],
replace=True,
),
notices.AddErrors(
name="concrete-qs",
errors=[
(
"misc",
"Cannot resolve keyword 'concrete_from_myapp' into field. Choices are: concrete_from_myapp2, id, one, two",
)
],
replace=False,
),
)
# And same output if nothing changes
@builder.run_and_check_after
def _() -> None:
builder.daemon_should_not_restart()
def test_sees_new_models(self, builder: ScenarioBuilder) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_and_copy_installed_apps("myapp", "myapp2")
builder.on("main.py").set(
"""
from extended_mypy_django_plugin import Concrete, DefaultQuerySet
from myapp.models import Parent
models: Concrete[Parent]
models.two
# ^ NAME[access1] ^
qs: DefaultQuerySet[Parent]
qs.values("two")
# ^ NAME[access2] ^
""",
)
# And if we add some more models
@builder.run_and_check_after
def _() -> None:
builder.on("myapp2/models.py").append(
"""
class Another(Parent):
pass
""",
)
builder.daemon_should_restart()
builder.on("main.py").expect(
notices.AddErrors(
name="access1",
errors=[
(
"union-attr",
'Item "Another" of "Child1 | Child2 | Child3 | ChildOther | Another" has no attribute "two"',
)
],
replace=False,
),
notices.AddErrors(
name="access2",
errors=[
("misc", "Cannot resolve keyword 'two' into field. Choices are: id, one")
],
replace=False,
),
)
# And the new model remains after a rerun
@builder.run_and_check_after
def _() -> None:
builder.daemon_should_not_restart()
def test_sees_changes_in_custom_querysets_within_app(self, builder: ScenarioBuilder) -> None:
@builder.run_and_check_after
def _() -> None:
builder.set_and_copy_installed_apps("leader", "follower1")
builder.on("main.py").set(
"""
from extended_mypy_django_plugin import Concrete, DefaultQuerySet
from leader.models import Leader
models: Concrete[Leader]
# ^ REVEAL[concrete-leader] ^ follower1.models.follower1.Follower1