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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
//! Given a set of requirements, find a set of compatible packages.
use std::borrow::Cow;
use std::cmp::Ordering;
use std::collections::{BTreeMap, BTreeSet, VecDeque};
use std::fmt::{Display, Formatter, Write};
use std::ops::Bound;
use std::sync::Arc;
use std::time::Instant;
use std::{iter, slice, thread};
use dashmap::DashMap;
use either::Either;
use futures::{FutureExt, StreamExt};
use itertools::Itertools;
use pubgrub::{Id, IncompId, Incompatibility, Kind, Range, Ranges, State};
use rustc_hash::{FxHashMap, FxHashSet};
use tokio::sync::mpsc::{self, Receiver, Sender};
use tokio::sync::oneshot;
use tokio_stream::wrappers::ReceiverStream;
use tracing::{Level, debug, info, instrument, trace, warn};
use uv_configuration::{Constraints, Excludes, Overrides};
use uv_distribution::{ArchiveMetadata, DistributionDatabase};
use uv_distribution_types::{
BuiltDist, CompatibleDist, DerivationChain, Dist, DistErrorKind, ExcludeNewerValue, Identifier,
IncompatibleDist, IncompatibleSource, IncompatibleWheel, IndexCapabilities, IndexLocations,
IndexMetadata, IndexUrl, InstalledDist, Name, PythonRequirementKind, RemoteSource, Requirement,
ResolvedDist, ResolvedDistRef, SourceDist, VersionOrUrlRef, implied_markers,
};
use uv_git::GitResolver;
use uv_normalize::{ExtraName, GroupName, PackageName};
use uv_pep440::{MIN_VERSION, Version, VersionSpecifiers, release_specifiers_to_ranges};
use uv_pep508::{
MarkerEnvironment, MarkerExpression, MarkerOperator, MarkerTree, MarkerValueString,
};
use uv_platform_tags::{IncompatibleTag, Tags};
use uv_pypi_types::{ConflictItem, ConflictItemRef, ConflictKindRef, Conflicts, VerbatimParsedUrl};
use uv_static::EnvVars;
use uv_torch::TorchStrategy;
use uv_types::{BuildContext, HashStrategy, InstalledPackagesProvider};
use uv_warnings::warn_user_once;
use crate::candidate_selector::{Candidate, CandidateDist, CandidateSelector};
use crate::dependency_provider::UvDependencyProvider;
use crate::error::{NoSolutionError, ResolveError};
use crate::fork_indexes::ForkIndexes;
use crate::fork_strategy::ForkStrategy;
use crate::fork_urls::ForkUrls;
use crate::manifest::Manifest;
use crate::pins::FilePins;
use crate::preferences::{PreferenceSource, Preferences};
use crate::pubgrub::{
DependencySource, PubGrubDependency, PubGrubPackage, PubGrubPackageInner, PubGrubPriorities,
PubGrubPython,
};
use crate::python_requirement::PythonRequirement;
use crate::resolution::ResolverOutput;
use crate::resolution_mode::ResolutionStrategy;
pub(crate) use crate::resolver::availability::{
ResolverVersion, UnavailableErrorChain, UnavailablePackage, UnavailableReason,
UnavailableVersion,
};
use crate::resolver::batch_prefetch::BatchPrefetcher;
pub use crate::resolver::derivation::DerivationChainBuilder;
pub use crate::resolver::environment::ResolverEnvironment;
use crate::resolver::environment::{
ForkingPossibility, fork_version_by_marker, fork_version_by_python_requirement,
};
pub(crate) use crate::resolver::fork_map::{ForkMap, ForkSet};
pub use crate::resolver::index::InMemoryIndex;
use crate::resolver::indexes::Indexes;
pub use crate::resolver::provider::{
DefaultResolverProvider, MetadataResponse, PackageVersionsResult, ResolverProvider,
VersionsResponse, WheelMetadataResult,
};
pub use crate::resolver::reporter::{BuildId, Reporter};
use crate::resolver::system::SystemDependency;
pub(crate) use crate::resolver::urls::Urls;
use crate::universal_marker::{ConflictMarker, UniversalMarker};
use crate::yanks::AllowedYanks;
use crate::{DependencyMode, Exclusions, FlatIndex, Options, ResolutionMode, VersionMap, marker};
pub(crate) use provider::MetadataUnavailable;
mod availability;
mod batch_prefetch;
mod derivation;
mod environment;
mod fork_map;
mod index;
mod indexes;
mod provider;
mod reporter;
mod system;
mod urls;
/// The number of conflicts a package may accumulate before we re-prioritize and backtrack.
const CONFLICT_THRESHOLD: usize = 5;
pub struct Resolver<Provider: ResolverProvider, InstalledPackages: InstalledPackagesProvider> {
state: ResolverState<InstalledPackages>,
provider: Provider,
}
/// State that is shared between the prefetcher and the PubGrub solver during
/// resolution, across all forks.
struct ResolverState<InstalledPackages: InstalledPackagesProvider> {
project: Option<PackageName>,
requirements: Vec<Requirement>,
constraints: Constraints,
overrides: Overrides,
excludes: Excludes,
preferences: Preferences,
git: GitResolver,
capabilities: IndexCapabilities,
locations: IndexLocations,
exclusions: Exclusions,
urls: Urls,
indexes: Indexes,
dependency_mode: DependencyMode,
hasher: HashStrategy,
env: ResolverEnvironment,
// The environment of the current Python interpreter.
current_environment: MarkerEnvironment,
tags: Option<Tags>,
python_requirement: PythonRequirement,
conflicts: Conflicts,
workspace_members: BTreeSet<PackageName>,
selector: CandidateSelector,
index: InMemoryIndex,
installed_packages: InstalledPackages,
/// Incompatibilities for packages that are entirely unavailable.
unavailable_packages: DashMap<PackageName, UnavailablePackage>,
/// Incompatibilities for packages that are unavailable at specific versions.
incomplete_packages: DashMap<PackageName, DashMap<Version, MetadataUnavailable>>,
/// The options that were used to configure this resolver.
options: Options,
/// The reporter to use for this resolver.
reporter: Option<Arc<dyn Reporter>>,
}
impl<'a, Context: BuildContext, InstalledPackages: InstalledPackagesProvider>
Resolver<DefaultResolverProvider<'a, Context>, InstalledPackages>
{
/// Initialize a new resolver using the default backend doing real requests.
///
/// Reads the flat index entries.
///
/// # Marker environment
///
/// The marker environment is optional.
///
/// When a marker environment is not provided, the resolver is said to be
/// in "universal" mode. When in universal mode, the resolution produced
/// may contain multiple versions of the same package. And thus, in order
/// to use the resulting resolution, there must be a "universal"-aware
/// reader of the resolution that knows to exclude distributions that can't
/// be used in the current environment.
///
/// When a marker environment is provided, the resolver is in
/// "non-universal" mode, which corresponds to standard `pip` behavior that
/// works only for a specific marker environment.
pub fn new(
manifest: Manifest,
options: Options,
python_requirement: &'a PythonRequirement,
env: ResolverEnvironment,
current_environment: &MarkerEnvironment,
conflicts: Conflicts,
tags: Option<&'a Tags>,
flat_index: &'a FlatIndex,
index: &'a InMemoryIndex,
hasher: &'a HashStrategy,
build_context: &'a Context,
installed_packages: InstalledPackages,
database: DistributionDatabase<'a, Context>,
) -> Result<Self, ResolveError> {
let provider = DefaultResolverProvider::new(
database,
flat_index,
tags,
python_requirement.target(),
AllowedYanks::from_manifest(&manifest, &env, options.dependency_mode),
hasher,
options.exclude_newer.clone(),
build_context.locations(),
build_context.build_options(),
build_context.capabilities(),
);
Self::new_custom_io(
manifest,
options,
hasher,
env,
current_environment,
tags.cloned(),
python_requirement,
conflicts,
index,
build_context.git(),
build_context.capabilities(),
build_context.locations(),
provider,
installed_packages,
)
}
}
impl<Provider: ResolverProvider, InstalledPackages: InstalledPackagesProvider>
Resolver<Provider, InstalledPackages>
{
/// Initialize a new resolver using a user provided backend.
pub fn new_custom_io(
manifest: Manifest,
options: Options,
hasher: &HashStrategy,
env: ResolverEnvironment,
current_environment: &MarkerEnvironment,
tags: Option<Tags>,
python_requirement: &PythonRequirement,
conflicts: Conflicts,
index: &InMemoryIndex,
git: &GitResolver,
capabilities: &IndexCapabilities,
locations: &IndexLocations,
provider: Provider,
installed_packages: InstalledPackages,
) -> Result<Self, ResolveError> {
let state = ResolverState {
index: index.clone(),
git: git.clone(),
capabilities: capabilities.clone(),
selector: CandidateSelector::for_resolution(&options, &manifest, &env),
dependency_mode: options.dependency_mode,
urls: Urls::from_manifest(&manifest, &env, git, options.dependency_mode),
indexes: Indexes::from_manifest(&manifest, &env, options.dependency_mode),
project: manifest.project,
workspace_members: manifest.workspace_members,
requirements: manifest.requirements,
constraints: manifest.constraints,
overrides: manifest.overrides,
excludes: manifest.excludes,
preferences: manifest.preferences,
exclusions: manifest.exclusions,
hasher: hasher.clone(),
locations: locations.clone(),
env,
current_environment: current_environment.clone(),
tags,
python_requirement: python_requirement.clone(),
conflicts,
installed_packages,
unavailable_packages: DashMap::default(),
incomplete_packages: DashMap::default(),
options,
reporter: None,
};
Ok(Self { state, provider })
}
/// Set the [`Reporter`] to use for this installer.
#[must_use]
pub fn with_reporter(self, reporter: Arc<dyn Reporter>) -> Self {
Self {
state: ResolverState {
reporter: Some(reporter.clone()),
..self.state
},
provider: self
.provider
.with_reporter(reporter.into_distribution_reporter()),
}
}
/// Resolve a set of requirements into a set of pinned versions.
pub async fn resolve(self) -> Result<ResolverOutput, ResolveError> {
let state = Arc::new(self.state);
let provider = Arc::new(self.provider);
// A channel to fetch package metadata (e.g., given `flask`, fetch all versions) and version
// metadata (e.g., given `flask==1.0.0`, fetch the metadata for that version).
// Channel size is set large to accommodate batch prefetching.
let (request_sink, request_stream) = mpsc::channel(300);
// Run the fetcher.
let requests_fut = state.clone().fetch(provider.clone(), request_stream).fuse();
// Spawn the PubGrub solver on a dedicated thread.
let solver = state.clone();
let (tx, rx) = oneshot::channel();
thread::Builder::new()
.name("uv-resolver".into())
.spawn(move || {
let result = solver.solve(&request_sink);
// This may fail if the main thread returned early due to an error.
let _ = tx.send(result);
})
.unwrap();
let resolve_fut = async move { rx.await.map_err(|_| ResolveError::ChannelClosed) };
// Wait for both to complete.
let ((), resolution) = tokio::try_join!(requests_fut, resolve_fut)?;
state.on_complete();
resolution
}
}
impl<InstalledPackages: InstalledPackagesProvider> ResolverState<InstalledPackages> {
#[instrument(skip_all)]
fn solve(
self: Arc<Self>,
request_sink: &Sender<Request>,
) -> Result<ResolverOutput, ResolveError> {
debug!(
"Solving with installed Python version: {}",
self.python_requirement.exact()
);
debug!(
"Solving with target Python version: {}",
self.python_requirement.target()
);
if !self.options.exclude_newer.is_empty() {
debug!("Solving with exclude-newer: {}", self.options.exclude_newer);
}
let mut visited = FxHashSet::default();
let root = PubGrubPackage::from(PubGrubPackageInner::Root(self.project.clone()));
let pubgrub = State::init(root.clone(), MIN_VERSION.clone());
let prefetcher = BatchPrefetcher::new(
self.capabilities.clone(),
self.index.clone(),
request_sink.clone(),
);
let state = ForkState::new(
pubgrub,
self.env.clone(),
self.python_requirement.clone(),
prefetcher,
);
let mut preferences = self.preferences.clone();
let mut forked_states = self.env.initial_forked_states(state)?;
let mut resolutions = vec![];
'FORK: while let Some(mut state) = forked_states.pop() {
if let Some(split) = state.env.end_user_fork_display() {
let requires_python = state.python_requirement.target();
debug!("Solving {split} (requires-python: {requires_python:?})");
}
let start = Instant::now();
loop {
let highest_priority_pkg =
if let Some(initial) = state.initial_id.take() {
// If we just forked based on `requires-python`, we can skip unit
// propagation, since we already propagated the package that initiated
// the fork.
initial
} else {
// Run unit propagation.
let result = state.pubgrub.unit_propagation(state.next);
match result {
Err(err) => {
// If unit propagation failed, there is no solution.
return Err(self.convert_no_solution_err(
err,
state.fork_urls,
state.fork_indexes,
state.env,
self.current_environment.clone(),
&visited,
));
}
Ok(conflicts) => {
for (affected, incompatibility) in conflicts {
// Conflict tracking: If there was a conflict, track affected and
// culprit for all root cause incompatibilities
state.record_conflict(affected, None, incompatibility);
}
}
}
// Pre-visit all candidate packages, to allow metadata to be fetched in parallel.
if self.dependency_mode.is_transitive() {
Self::pre_visit(
state
.pubgrub
.partial_solution
.prioritized_packages()
.map(|(id, range)| (&state.pubgrub.package_store[id], range)),
&self.urls,
&self.indexes,
&state.python_requirement,
request_sink,
)?;
}
Self::reprioritize_conflicts(&mut state);
trace!(
"Assigned packages: {}",
state
.pubgrub
.partial_solution
.extract_solution()
.filter(|(p, _)| !state.pubgrub.package_store[*p].is_proxy())
.map(|(p, v)| format!("{}=={}", state.pubgrub.package_store[p], v))
.join(", ")
);
// Choose a package.
// We aren't allowed to use the term intersection as it would extend the
// mutable borrow of `state`.
let Some((highest_priority_pkg, _)) =
state.pubgrub.partial_solution.pick_highest_priority_pkg(
|id, _range| state.priorities.get(&state.pubgrub.package_store[id]),
)
else {
// All packages have been assigned, the fork has been successfully resolved
if tracing::enabled!(Level::DEBUG) {
state.prefetcher.log_tried_versions();
}
debug!(
"{} resolution took {:.3}s",
state.env,
start.elapsed().as_secs_f32()
);
let resolution = state.into_resolution();
// Walk over the selected versions, and mark them as preferences. We have to
// add forks back as to not override the preferences from the lockfile for
// the next fork
//
// If we're using a resolution mode that varies based on whether a dependency is
// direct or transitive, skip preferences, as we risk adding a preference from
// one fork (in which it's a transitive dependency) to another fork (in which
// it's direct).
if matches!(
self.options.resolution_mode,
ResolutionMode::Lowest | ResolutionMode::Highest
) {
for (package, version) in &resolution.nodes {
preferences.insert(
package.name.clone(),
package.index.clone(),
resolution
.env
.try_universal_markers()
.unwrap_or(UniversalMarker::TRUE),
version.clone(),
PreferenceSource::Resolver,
);
}
}
resolutions.push(resolution);
continue 'FORK;
};
trace!(
"Chose package for decision: {}. remaining choices: {}",
state.pubgrub.package_store[highest_priority_pkg],
state
.pubgrub
.partial_solution
.undecided_packages()
.filter(|(p, _)| !state.pubgrub.package_store[**p].is_proxy())
.map(|(p, _)| state.pubgrub.package_store[*p].to_string())
.join(", ")
);
highest_priority_pkg
};
state.next = highest_priority_pkg;
// TODO(charlie): Remove as many usages of `next_package` as we can.
let next_id = state.next;
let next_package = &state.pubgrub.package_store[state.next];
let url = next_package
.name()
.and_then(|name| state.fork_urls.get(name));
let index = next_package
.name()
.and_then(|name| state.fork_indexes.get(name));
// Consider:
// ```toml
// dependencies = [
// "iniconfig == 1.1.1 ; python_version < '3.12'",
// "iniconfig @ https://files.pythonhosted.org/packages/ef/a6/62565a6e1cf69e10f5727360368e451d4b7f58beeac6173dc9db836a5b46/iniconfig-2.0.0-py3-none-any.whl ; python_version >= '3.12'",
// ]
// ```
// In the `python_version < '3.12'` case, we haven't pre-visited `iniconfig` yet,
// since we weren't sure whether it might also be a URL requirement when
// transforming the requirements. For that case, we do another request here
// (idempotent due to caching).
self.request_package(next_package, url, index, request_sink)?;
let version = if let Some(version) = state.initial_version.take() {
// If we just forked based on platform support, we can skip version selection,
// since the fork operation itself already selected the appropriate version for
// the platform.
version
} else {
let term_intersection = state
.pubgrub
.partial_solution
.term_intersection_for_package(next_id)
.expect("a package was chosen but we don't have a term");
let decision = self.choose_version(
next_package,
next_id,
index.map(IndexMetadata::url),
term_intersection.unwrap_positive(),
&mut state.pins,
&preferences,
&state.fork_urls,
&state.env,
&state.python_requirement,
&state.pubgrub,
&mut visited,
request_sink,
)?;
// Pick the next compatible version.
let Some(version) = decision else {
debug!("No compatible version found for: {next_package}");
let term_intersection = state
.pubgrub
.partial_solution
.term_intersection_for_package(next_id)
.expect("a package was chosen but we don't have a term");
if let PubGrubPackageInner::Package { name, .. } = &**next_package {
// Check if the decision was due to the package being unavailable
if let Some(entry) = self.unavailable_packages.get(name) {
state
.pubgrub
.add_incompatibility(Incompatibility::custom_term(
next_id,
term_intersection.clone(),
UnavailableReason::Package(entry.clone()),
));
continue;
}
}
state
.pubgrub
.add_incompatibility(Incompatibility::no_versions(
next_id,
term_intersection.clone(),
));
continue;
};
let version = match version {
ResolverVersion::Unforked(version) => version,
ResolverVersion::Forked(forks) => {
forked_states.extend(self.version_forks_to_fork_states(state, forks));
continue 'FORK;
}
ResolverVersion::Unavailable(version, reason) => {
state.add_unavailable_version(version, reason);
continue;
}
};
// Only consider registry packages for prefetch.
if url.is_none() {
state.prefetcher.prefetch_batches(
next_package,
index,
&version,
term_intersection.unwrap_positive(),
state
.pubgrub
.partial_solution
.unchanging_term_for_package(next_id),
&state.python_requirement,
&self.selector,
&state.env,
)?;
}
version
};
state.prefetcher.version_tried(next_package, &version);
self.on_progress(next_package, &version);
if !state
.added_dependencies
.entry(next_id)
.or_default()
.insert(version.clone())
{
// `dep_incompats` are already in `incompatibilities` so we know there are not satisfied
// terms and can add the decision directly.
state
.pubgrub
.partial_solution
.add_decision(next_id, version);
continue;
}
// Retrieve that package dependencies.
let forked_deps = self.get_dependencies_forking(
next_id,
next_package,
&version,
&state.pins,
&state.fork_urls,
&state.env,
&state.python_requirement,
&state.pubgrub,
)?;
match forked_deps {
ForkedDependencies::Unavailable(reason) => {
// Then here, if we get a reason that we consider unrecoverable, we should
// show the derivation chain.
state
.pubgrub
.add_incompatibility(Incompatibility::custom_version(
next_id,
version.clone(),
UnavailableReason::Version(reason),
));
}
ForkedDependencies::Unforked(dependencies) => {
// Enrich the state with any URLs, etc.
state
.visit_package_version_dependencies(
next_id,
&version,
&self.urls,
&self.indexes,
&dependencies,
&self.git,
&self.workspace_members,
self.selector.resolution_strategy(),
)
.map_err(|err| {
enrich_dependency_error(err, next_id, &version, &state.pubgrub)
})?;
// Emit a request to fetch the metadata for each registry package.
self.visit_dependencies(&dependencies, &state, request_sink)
.map_err(|err| {
enrich_dependency_error(err, next_id, &version, &state.pubgrub)
})?;
// Add the dependencies to the state.
state.add_package_version_dependencies(next_id, &version, dependencies);
}
ForkedDependencies::Forked {
mut forks,
diverging_packages,
} => {
debug!(
"Pre-fork {} took {:.3}s",
state.env,
start.elapsed().as_secs_f32()
);
// Prioritize the forks.
match (self.options.fork_strategy, self.options.resolution_mode) {
(ForkStrategy::Fewest, _) | (_, ResolutionMode::Lowest) => {
// Prefer solving forks with lower Python bounds, since they're more
// likely to produce solutions that work for forks with higher
// Python bounds (whereas the inverse is not true).
forks.sort_by(|a, b| {
a.cmp_requires_python(b)
.reverse()
.then_with(|| a.cmp_upper_bounds(b))
});
}
(ForkStrategy::RequiresPython, _) => {
// Otherwise, prefer solving forks with higher Python bounds, since
// we want to prioritize choosing the latest-compatible package
// version for each Python version.
forks.sort_by(|a, b| {
a.cmp_requires_python(b).then_with(|| a.cmp_upper_bounds(b))
});
}
}
for new_fork_state in self.forks_to_fork_states(
state,
&version,
forks,
request_sink,
&diverging_packages,
) {
forked_states.push(new_fork_state?);
}
continue 'FORK;
}
}
}
}
if resolutions.len() > 1 {
info!(
"Solved your requirements for {} environments",
resolutions.len()
);
}
if tracing::enabled!(Level::DEBUG) {
for resolution in &resolutions {
if let Some(env) = resolution.env.end_user_fork_display() {
let packages: FxHashSet<_> = resolution
.nodes
.keys()
.map(|package| &package.name)
.collect();
debug!(
"Distinct solution for {env} with {} package(s)",
packages.len()
);
}
}
}
for resolution in &resolutions {
Self::trace_resolution(resolution);
}
ResolverOutput::from_state(
&resolutions,
&self.requirements,
&self.constraints,
&self.overrides,
&self.preferences,
&self.index,
&self.git,
&self.python_requirement,
&self.conflicts,
self.selector.resolution_strategy(),
self.options.clone(),
)
}
/// Change the priority of often conflicting packages and backtrack.
///
/// To be called after unit propagation.
fn reprioritize_conflicts(state: &mut ForkState) {
for package in state.conflict_tracker.prioritize.drain(..) {
let changed = state
.priorities
.mark_conflict_early(&state.pubgrub.package_store[package]);
if changed {
debug!(
"Package {} has too many conflicts (affected), prioritizing",
&state.pubgrub.package_store[package]
);
} else {
debug!(
"Package {} has too many conflicts (affected), already {:?}",
state.pubgrub.package_store[package],
state.priorities.get(&state.pubgrub.package_store[package])
);
}
}
for package in state.conflict_tracker.deprioritize.drain(..) {
let changed = state
.priorities
.mark_conflict_late(&state.pubgrub.package_store[package]);
if changed {
debug!(
"Package {} has too many conflicts (culprit), deprioritizing and backtracking",
state.pubgrub.package_store[package],
);
let backtrack_level = state.pubgrub.backtrack_package(package);
if let Some(backtrack_level) = backtrack_level {
debug!("Backtracked {backtrack_level} decisions");
} else {
debug!(
"Package {} is not decided, cannot backtrack",
state.pubgrub.package_store[package]
);
}
} else {
debug!(
"Package {} has too many conflicts (culprit), already {:?}",
state.pubgrub.package_store[package],
state.priorities.get(&state.pubgrub.package_store[package])
);
}
}
}
/// When trace level logging is enabled, we dump the final
/// set of resolutions, including markers, to help with
/// debugging. Namely, this tells use precisely the state
/// emitted by the resolver before going off to construct a
/// resolution graph.
fn trace_resolution(combined: &Resolution) {
if !tracing::enabled!(Level::TRACE) {
return;
}
trace!("Resolution: {:?}", combined.env);
for edge in &combined.edges {
trace!(
"Resolution edge: {} -> {}",
edge.from
.as_ref()
.map(PackageName::as_str)
.unwrap_or("ROOT"),
edge.to,
);
// The unwraps below are OK because `write`ing to
// a String can never fail (except for OOM).
let mut msg = String::new();
write!(msg, "{}", edge.from_version).unwrap();
if let Some(ref extra) = edge.from_extra {
write!(msg, " (extra: {extra})").unwrap();
}
if let Some(ref dev) = edge.from_group {
write!(msg, " (group: {dev})").unwrap();
}
write!(msg, " -> ").unwrap();
write!(msg, "{}", edge.to_version).unwrap();
if let Some(ref extra) = edge.to_extra {
write!(msg, " (extra: {extra})").unwrap();
}
if let Some(ref dev) = edge.to_group {
write!(msg, " (group: {dev})").unwrap();
}
if let Some(marker) = edge.marker.contents() {
write!(msg, " ; {marker}").unwrap();
}
trace!("Resolution edge: {msg}");
}
}
/// Convert the dependency [`Fork`]s into [`ForkState`]s.
fn forks_to_fork_states<'a>(
&'a self,
current_state: ForkState,
version: &'a Version,
forks: Vec<Fork>,
request_sink: &'a Sender<Request>,
diverging_packages: &'a [PackageName],
) -> impl Iterator<Item = Result<ForkState, ResolveError>> + 'a {
debug!(
"Splitting resolution on {}=={} over {} into {} resolution{} with separate markers",
current_state.pubgrub.package_store[current_state.next],
version,
diverging_packages
.iter()
.map(ToString::to_string)
.join(", "),
forks.len(),
if forks.len() == 1 { "" } else { "s" }
);
assert!(forks.len() >= 2);
// This is a somewhat tortured technique to ensure
// that our resolver state is only cloned as much
// as it needs to be. We basically move the state
// into `forked_states`, and then only clone it if
// there is at least one more fork to visit.
let package = current_state.next;
let mut cur_state = Some(current_state);
let forks_len = forks.len();
forks
.into_iter()
.enumerate()
.map(move |(i, fork)| {
let is_last = i == forks_len - 1;
let forked_state = cur_state.take().unwrap();
if !is_last {
cur_state = Some(forked_state.clone());
}
let env = fork.env.clone();
(fork, forked_state.with_env(env))
})
.map(move |(fork, mut forked_state)| {
// Enrich the state with any URLs, etc.
forked_state
.visit_package_version_dependencies(
package,
version,
&self.urls,
&self.indexes,
&fork.dependencies,
&self.git,
&self.workspace_members,
self.selector.resolution_strategy(),
)
.map_err(|err| {
enrich_dependency_error(err, package, version, &forked_state.pubgrub)
})?;
// Emit a request to fetch the metadata for each registry package.
self.visit_dependencies(&fork.dependencies, &forked_state, request_sink)
.map_err(|err| {
enrich_dependency_error(err, package, version, &forked_state.pubgrub)
})?;
// Add the dependencies to the state.
forked_state.add_package_version_dependencies(package, version, fork.dependencies);
Ok(forked_state)
})
}
/// Convert the dependency [`Fork`]s into [`ForkState`]s.
#[expect(clippy::unused_self)]
fn version_forks_to_fork_states(
&self,
current_state: ForkState,
forks: Vec<VersionFork>,
) -> impl Iterator<Item = ForkState> + '_ {
// This is a somewhat tortured technique to ensure
// that our resolver state is only cloned as much
// as it needs to be. We basically move the state
// into `forked_states`, and then only clone it if
// there is at least one more fork to visit.
let mut cur_state = Some(current_state);
let forks_len = forks.len();
forks.into_iter().enumerate().map(move |(i, fork)| {
let is_last = i == forks_len - 1;
let mut forked_state = cur_state.take().unwrap();
if !is_last {
cur_state = Some(forked_state.clone());
}
forked_state.initial_id = Some(fork.id);
forked_state.initial_version = fork.version;
forked_state.with_env(fork.env)
})
}
/// Visit a set of [`PubGrubDependency`] entities prior to selection.
fn visit_dependencies(
&self,
dependencies: &[PubGrubDependency],
state: &ForkState,
request_sink: &Sender<Request>,
) -> Result<(), ResolveError> {
for dependency in dependencies {
let PubGrubDependency {
package,
version: _,
parent: _,
source: _,
} = dependency;
let url = package.name().and_then(|name| state.fork_urls.get(name));
let index = package.name().and_then(|name| state.fork_indexes.get(name));
self.visit_package(package, url, index, request_sink)?;
}
Ok(())
}
/// Visit a [`PubGrubPackage`] prior to selection. This should be called on a [`PubGrubPackage`]
/// before it is selected, to allow metadata to be fetched in parallel.
fn visit_package(
&self,
package: &PubGrubPackage,
url: Option<&VerbatimParsedUrl>,
index: Option<&IndexMetadata>,
request_sink: &Sender<Request>,
) -> Result<(), ResolveError> {
// Ignore unresolved URL packages, i.e., packages that use a direct URL in some forks.
if url.is_none()
&& package
.name()
.map(|name| self.urls.any_url(name))
.unwrap_or(true)
{
return Ok(());
}
self.request_package(package, url, index, request_sink)
}
fn request_package(
&self,
package: &PubGrubPackage,
url: Option<&VerbatimParsedUrl>,
index: Option<&IndexMetadata>,
request_sink: &Sender<Request>,
) -> Result<(), ResolveError> {
// Only request real packages.
let Some(name) = package.name_no_root() else {
return Ok(());
};
if let Some(url) = url {
// Verify that the package is allowed under the hash-checking policy.
if !self.hasher.allows_url(&url.verbatim) {
return Err(ResolveError::UnhashedPackage(name.clone()));
}
// Emit a request to fetch the metadata for this distribution.
let dist = Dist::from_url(name.clone(), url.clone())?;
if self.index.distributions().register(dist.distribution_id()) {
request_sink.blocking_send(Request::Dist(dist))?;
}
} else if let Some(index) = index {
// Emit a request to fetch the metadata for this package on the index.
if self
.index
.explicit()
.register((name.clone(), index.url().clone()))
{
request_sink.blocking_send(Request::Package(name.clone(), Some(index.clone())))?;
}
} else {
// Emit a request to fetch the metadata for this package.
if self.index.implicit().register(name.clone()) {
request_sink.blocking_send(Request::Package(name.clone(), None))?;
}
}
Ok(())
}
/// Visit the set of [`PubGrubPackage`] candidates prior to selection. This allows us to fetch
/// metadata for all packages in parallel.
fn pre_visit<'data>(
packages: impl Iterator<Item = (&'data PubGrubPackage, &'data Range<Version>)>,
urls: &Urls,
indexes: &Indexes,
python_requirement: &PythonRequirement,
request_sink: &Sender<Request>,
) -> Result<(), ResolveError> {
// Iterate over the potential packages, and fetch file metadata for any of them. These
// represent our current best guesses for the versions that we _might_ select.
for (package, range) in packages {
let PubGrubPackageInner::Package {
name,
extra: None,
group: None,
marker: MarkerTree::TRUE,
} = &**package
else {
continue;
};
// Avoid pre-visiting packages that have any URLs in any fork. At this point we can't
// tell whether they are registry distributions or which url they use.
if urls.any_url(name) {
continue;
}
// Avoid visiting packages that may use an explicit index.
if indexes.contains_key(name) {
continue;
}
request_sink.blocking_send(Request::Prefetch(
name.clone(),
range.clone(),
python_requirement.clone(),
))?;
}
Ok(())
}
/// Given a candidate package, choose the next version in range to try.
///
/// Returns `None` when there are no versions in the given range, rejecting the current partial
/// solution.
// TODO(konsti): re-enable tracing. This trace is crucial to understanding the
// tracing-durations-export diagrams, but it took ~5% resolver thread runtime for apache-airflow
// when I last measured.
#[cfg_attr(feature = "tracing-durations-export", instrument(skip_all, fields(%package)))]
fn choose_version(
&self,
package: &PubGrubPackage,
id: Id<PubGrubPackage>,
index: Option<&IndexUrl>,
range: &Range<Version>,
pins: &mut FilePins,
preferences: &Preferences,
fork_urls: &ForkUrls,
env: &ResolverEnvironment,
python_requirement: &PythonRequirement,
pubgrub: &State<UvDependencyProvider>,
visited: &mut FxHashSet<PackageName>,
request_sink: &Sender<Request>,
) -> Result<Option<ResolverVersion>, ResolveError> {
match &**package {
PubGrubPackageInner::Root(_) => {
Ok(Some(ResolverVersion::Unforked(MIN_VERSION.clone())))
}
PubGrubPackageInner::Python(_) => {
// Dependencies on Python are only added when a package is incompatible; as such,
// we don't need to do anything here.
Ok(None)
}
PubGrubPackageInner::System(_) => {
// We don't care what the actual version is here, just that it's consistent across
// the dependency graph.
let Some(version) = range.as_singleton() else {
return Ok(None);
};
Ok(Some(ResolverVersion::Unforked(version.clone())))
}
PubGrubPackageInner::Marker { name, .. }
| PubGrubPackageInner::Extra { name, .. }
| PubGrubPackageInner::Group { name, .. }
| PubGrubPackageInner::Package { name, .. } => {
if let Some(url) = package.name().and_then(|name| fork_urls.get(name)) {
self.choose_version_url(id, name, range, url, env, python_requirement, pubgrub)
} else {
self.choose_version_registry(
package,
id,
name,
index,
range,
preferences,
env,
python_requirement,
pubgrub,
pins,
visited,
request_sink,
)
}
}
}
}
/// Select a version for a URL requirement. Since there is only one version per URL, we return
/// that version if it is in range and `None` otherwise.
fn choose_version_url(
&self,
id: Id<PubGrubPackage>,
name: &PackageName,
range: &Range<Version>,
url: &VerbatimParsedUrl,
env: &ResolverEnvironment,
python_requirement: &PythonRequirement,
pubgrub: &State<UvDependencyProvider>,
) -> Result<Option<ResolverVersion>, ResolveError> {
debug!(
"Searching for a compatible version of {name} @ {} ({range})",
url.verbatim
);
let dist = Dist::from_url(name.clone(), url.clone())?;
let distribution_id = dist.distribution_id();
let response = self
.index
.distributions()
.wait_blocking(&distribution_id)
.ok_or_else(|| ResolveError::UnregisteredTask(dist.to_string()))?;
// If we failed to fetch the metadata for a URL, we can't proceed.
let metadata = match &*response {
MetadataResponse::Found(archive) => &archive.metadata,
MetadataResponse::Unavailable(reason) => {
self.unavailable_packages
.insert(name.clone(), reason.into());
return Ok(None);
}
// TODO(charlie): Add derivation chain for URL dependencies. In practice, this isn't
// critical since we fetch URL dependencies _prior_ to invoking the resolver.
MetadataResponse::Error(dist, err) => {
return Err(ResolveError::Dist(
DistErrorKind::from_requested_dist(dist, &**err),
dist.clone(),
DerivationChain::default(),
err.clone(),
));
}
};
let version = &metadata.version;
// The version is incompatible with the requirement.
if !range.contains(version) {
return Ok(None);
}
// If the URL points to a pre-built wheel, and the wheel's supported Python versions don't
// match our `Requires-Python`, mark it as incompatible.
if let Dist::Built(dist) = &dist {
let filename = match &dist {
BuiltDist::Registry(dist) => &dist.best_wheel().filename,
BuiltDist::DirectUrl(dist) => &dist.filename,
BuiltDist::Path(dist) => &dist.filename,
};
// If the wheel does _not_ cover an environment that requires artifact coverage, it's
// incompatible.
if env.marker_environment().is_none() && !self.options.artifact_environments.is_empty()
{
let wheel_marker = implied_markers(filename);
// If the caller marked an environment as requiring artifact coverage, ensure it
// has coverage.
for environment_marker in self.options.artifact_environments.iter().copied() {
// If the platform is part of the current environment...
if env.included_by_marker(environment_marker)
&& !find_environments(id, pubgrub).is_disjoint(environment_marker)
{
// ...but the wheel doesn't support it, it's incompatible.
if wheel_marker.is_disjoint(environment_marker) {
return Ok(Some(ResolverVersion::Unavailable(
version.clone(),
UnavailableVersion::IncompatibleDist(IncompatibleDist::Wheel(
IncompatibleWheel::MissingPlatform(environment_marker),
)),
)));
}
}
}
}
// If the wheel's Python tag doesn't match the target Python, it's incompatible.
if !python_requirement.target().matches_wheel_tag(filename) {
return Ok(Some(ResolverVersion::Unavailable(
filename.version.clone(),
UnavailableVersion::IncompatibleDist(IncompatibleDist::Wheel(
IncompatibleWheel::Tag(IncompatibleTag::AbiPythonVersion),
)),
)));
}
}
// The version is incompatible due to its `Requires-Python` requirement.
if let Some(requires_python) = metadata.requires_python.as_ref() {
if !python_requirement.target().is_contained_by(requires_python) {
let kind = if python_requirement.installed() == python_requirement.target() {
PythonRequirementKind::Installed
} else {
PythonRequirementKind::Target
};
return Ok(Some(ResolverVersion::Unavailable(
version.clone(),
UnavailableVersion::IncompatibleDist(IncompatibleDist::Source(
IncompatibleSource::RequiresPython(requires_python.clone(), kind),
)),
)));
}
}
Ok(Some(ResolverVersion::Unforked(version.clone())))
}
/// Given a candidate registry requirement, choose the next version in range to try, or `None`
/// if there is no version in this range.
fn choose_version_registry(
&self,
package: &PubGrubPackage,
id: Id<PubGrubPackage>,
name: &PackageName,
index: Option<&IndexUrl>,
range: &Range<Version>,
preferences: &Preferences,
env: &ResolverEnvironment,
python_requirement: &PythonRequirement,
pubgrub: &State<UvDependencyProvider>,
pins: &mut FilePins,
visited: &mut FxHashSet<PackageName>,
request_sink: &Sender<Request>,
) -> Result<Option<ResolverVersion>, ResolveError> {
// Wait for the metadata to be available.
let versions_response = if let Some(index) = index {
self.index
.explicit()
.wait_blocking(&(name.clone(), index.clone()))
.ok_or_else(|| ResolveError::UnregisteredTask(name.to_string()))?
} else {
self.index
.implicit()
.wait_blocking(name)
.ok_or_else(|| ResolveError::UnregisteredTask(name.to_string()))?
};
visited.insert(name.clone());
let version_maps = match *versions_response {
VersionsResponse::Found(ref version_maps) => version_maps.as_slice(),
VersionsResponse::NoIndex => {
self.unavailable_packages
.insert(name.clone(), UnavailablePackage::NoIndex);
&[]
}
VersionsResponse::Offline => {
self.unavailable_packages
.insert(name.clone(), UnavailablePackage::Offline);
&[]
}
VersionsResponse::NotFound => {
self.unavailable_packages
.insert(name.clone(), UnavailablePackage::NotFound);
&[]
}
};
debug!("Searching for a compatible version of {package} ({range})");
// Find a version.
let Some(candidate) = self.selector.select(
name,
range,
version_maps,
preferences,
&self.installed_packages,
&self.exclusions,
index,
env,
self.tags.as_ref(),
) else {
// Short circuit: we couldn't find _any_ versions for a package.
return Ok(None);
};
let dist = match candidate.dist() {
CandidateDist::Compatible(dist) => dist,
CandidateDist::Incompatible {
incompatible_dist: incompatibility,
prioritized_dist: _,
} => {
// If the version is incompatible because no distributions are compatible, exit early.
return Ok(Some(ResolverVersion::Unavailable(
candidate.version().clone(),
// TODO(charlie): We can avoid this clone; the candidate is dropped here and
// owns the incompatibility.
UnavailableVersion::IncompatibleDist(incompatibility.clone()),
)));
}
};
// Check whether the version is incompatible due to its Python requirement.
if let Some((requires_python, incompatibility)) =
Self::check_requires_python(dist, python_requirement)
{
if matches!(self.options.fork_strategy, ForkStrategy::RequiresPython) {
if env.marker_environment().is_none() {
let forks = fork_version_by_python_requirement(
requires_python,
python_requirement,
env,
);
if !forks.is_empty() {
debug!(
"Forking Python requirement `{}` on `{}` for {}=={} ({})",
python_requirement.target(),
requires_python,
name,
candidate.version(),
forks
.iter()
.map(ToString::to_string)
.collect::<Vec<_>>()
.join(", ")
);
let forks = forks
.into_iter()
.map(|env| VersionFork {
env,
id,
version: None,
})
.collect();
return Ok(Some(ResolverVersion::Forked(forks)));
}
}
}
return Ok(Some(ResolverVersion::Unavailable(
candidate.version().clone(),
UnavailableVersion::IncompatibleDist(incompatibility),
)));
}
// Check whether this version covers all supported platforms; and, if not, generate a fork.
if let Some(forked) = self.fork_version_registry(
&candidate,
dist,
version_maps,
package,
id,
name,
index,
range,
preferences,
env,
pubgrub,
pins,
request_sink,
)? {
return Ok(Some(forked));
}
let filename = match dist.for_installation() {
ResolvedDistRef::InstallableRegistrySourceDist { sdist, .. } => sdist
.filename()
.unwrap_or(Cow::Borrowed("unknown filename")),
ResolvedDistRef::InstallableRegistryBuiltDist { wheel, .. } => wheel
.filename()
.unwrap_or(Cow::Borrowed("unknown filename")),
ResolvedDistRef::Installed { .. } => Cow::Borrowed("installed"),
};
debug!(
"Selecting: {}=={} [{}] ({})",
name,
candidate.version(),
candidate.choice_kind(),
filename,
);
self.visit_candidate(&candidate, dist, package, name, pins, request_sink)?;
let version = candidate.version().clone();
Ok(Some(ResolverVersion::Unforked(version)))
}
/// Determine whether a candidate covers all supported platforms; and, if not, generate a fork.
///
/// This only ever applies to versions that lack source distributions And, for now, we only
/// apply it in two cases:
///
/// 1. Local versions, where the non-local version has greater platform coverage. The intent is
/// such that, if we're resolving PyTorch, and we choose `torch==2.5.2+cpu`, we want to
/// fork so that we can select `torch==2.5.2` on macOS (since the `+cpu` variant doesn't
/// include any macOS wheels).
/// 2. Platforms that the user explicitly marks as "required" (opt-in). For example, the user
/// might require that the generated resolution always includes wheels for x86 macOS, and
/// fails entirely if the platform is unsupported.
fn fork_version_registry(
&self,
candidate: &Candidate,
dist: &CompatibleDist,
version_maps: &[VersionMap],
package: &PubGrubPackage,
id: Id<PubGrubPackage>,
name: &PackageName,
index: Option<&IndexUrl>,
range: &Range<Version>,
preferences: &Preferences,
env: &ResolverEnvironment,
pubgrub: &State<UvDependencyProvider>,
pins: &mut FilePins,
request_sink: &Sender<Request>,
) -> Result<Option<ResolverVersion>, ResolveError> {
// This only applies to universal resolutions.
if env.marker_environment().is_some() {
return Ok(None);
}
// If the package is already compatible with all environments (as is the case for
// packages that include a source distribution), we don't need to fork.
if dist.implied_markers().is_true() {
return Ok(None);
}
// If the caller marked an environment as requiring artifact coverage, ensure it has
// coverage.
for marker in self.options.artifact_environments.iter().copied() {
// If the platform is part of the current environment...
if env.included_by_marker(marker) {
// But isn't supported by the distribution...
if dist.implied_markers().is_disjoint(marker)
&& !find_environments(id, pubgrub).is_disjoint(marker)
{
// Then we need to fork.
let Some((left, right)) = fork_version_by_marker(env, marker) else {
return Ok(Some(ResolverVersion::Unavailable(
candidate.version().clone(),
UnavailableVersion::IncompatibleDist(IncompatibleDist::Wheel(
IncompatibleWheel::MissingPlatform(marker),
)),
)));
};
debug!(
"Forking on required platform `{}` for {}=={} ({})",
marker.try_to_string().unwrap_or_else(|| "true".to_string()),
name,
candidate.version(),
[&left, &right]
.iter()
.map(ToString::to_string)
.collect::<Vec<_>>()
.join(", ")
);
let forks = vec![
VersionFork {
env: left,
id,
version: None,
},
VersionFork {
env: right,
id,
version: None,
},
];
return Ok(Some(ResolverVersion::Forked(forks)));
}
}
}
// For now, we only apply this to local versions.
if !candidate.version().is_local() {
return Ok(None);
}
debug!(
"Looking at local version: {}=={}",
name,
candidate.version()
);
// If there's a non-local version...
let range = range.clone().intersection(&Range::singleton(
candidate.version().clone().without_local(),
));
let Some(base_candidate) = self.selector.select(
name,
&range,
version_maps,
preferences,
&self.installed_packages,
&self.exclusions,
index,
env,
self.tags.as_ref(),
) else {
return Ok(None);
};
let CandidateDist::Compatible(base_dist) = base_candidate.dist() else {
return Ok(None);
};
// ...and the non-local version has greater platform support...
let mut remainder = {
let mut remainder = base_dist.implied_markers();
remainder.and(dist.implied_markers().negate());
remainder
};
if remainder.is_false() {
return Ok(None);
}
// If the remainder isn't relevant to the current environment, there's no need to fork.
// For example, if we're solving for `sys_platform == 'darwin'` but the remainder is
// `sys_platform == 'linux'`, we don't need to fork.
if !env.included_by_marker(remainder) {
return Ok(None);
}
// Similarly, if the local distribution is incompatible with the current environment, then
// use the base distribution instead (but don't fork).
if !env.included_by_marker(dist.implied_markers()) {
let filename = match dist.for_installation() {
ResolvedDistRef::InstallableRegistrySourceDist { sdist, .. } => sdist
.filename()
.unwrap_or(Cow::Borrowed("unknown filename")),
ResolvedDistRef::InstallableRegistryBuiltDist { wheel, .. } => wheel
.filename()
.unwrap_or(Cow::Borrowed("unknown filename")),
ResolvedDistRef::Installed { .. } => Cow::Borrowed("installed"),
};
debug!(
"Preferring non-local candidate: {}=={} [{}] ({})",
name,
base_candidate.version(),
base_candidate.choice_kind(),
filename,
);
self.visit_candidate(
&base_candidate,
base_dist,
package,
name,
pins,
request_sink,
)?;
return Ok(Some(ResolverVersion::Unforked(
base_candidate.version().clone(),
)));
}
// If the implied markers includes _some_ macOS environments, but the remainder doesn't,
// then we can extend the implied markers to include _all_ macOS environments. Same goes for
// Linux and Windows.
//
// The idea here is that the base version could support (e.g.) ARM macOS, but not Intel
// macOS. But if _neither_ version supports Intel macOS, we'd rather use `sys_platform == 'darwin'`
// instead of `sys_platform == 'darwin' and platform_machine == 'arm64'`, since it's much
// simpler, and _neither_ version will succeed with Intel macOS anyway.
for value in [
arcstr::literal!("darwin"),
arcstr::literal!("linux"),
arcstr::literal!("win32"),
] {
let sys_platform = MarkerTree::expression(MarkerExpression::String {
key: MarkerValueString::SysPlatform,
operator: MarkerOperator::Equal,
value,
});
if dist.implied_markers().is_disjoint(sys_platform)
&& !remainder.is_disjoint(sys_platform)
{
remainder.or(sys_platform);
}
}
// Otherwise, we need to fork.
let Some((base_env, local_env)) = fork_version_by_marker(env, remainder) else {
return Ok(None);
};
debug!(
"Forking platform for {}=={} ({})",
name,
candidate.version(),
[&base_env, &local_env]
.iter()
.map(ToString::to_string)
.collect::<Vec<_>>()
.join(", ")
);
self.visit_candidate(candidate, dist, package, name, pins, request_sink)?;
self.visit_candidate(
&base_candidate,
base_dist,
package,
name,
pins,
request_sink,
)?;
let forks = vec![
VersionFork {
env: base_env.clone(),
id,
version: Some(base_candidate.version().clone()),
},
VersionFork {
env: local_env.clone(),
id,
version: Some(candidate.version().clone()),
},
];
Ok(Some(ResolverVersion::Forked(forks)))
}
/// Visit a selected candidate.
fn visit_candidate(
&self,
candidate: &Candidate,
dist: &CompatibleDist,
package: &PubGrubPackage,
name: &PackageName,
pins: &mut FilePins,
request_sink: &Sender<Request>,
) -> Result<(), ResolveError> {
// We want to return a package pinned to a specific version; but we _also_ want to
// store the exact file that we selected to satisfy that version.
pins.insert(candidate, dist);
// Emit a request to fetch the metadata for this version.
if matches!(&**package, PubGrubPackageInner::Package { .. }) {
if self.dependency_mode.is_transitive() {
let dist = dist.for_resolution();
if self.index.distributions().register(dist.distribution_id()) {
if name != dist.name() {
return Err(ResolveError::MismatchedPackageName {
request: "distribution",
expected: name.clone(),
actual: dist.name().clone(),
});
}
// Verify that the package is allowed under the hash-checking policy.
if !self
.hasher
.allows_package(candidate.name(), candidate.version())
{
return Err(ResolveError::UnhashedPackage(candidate.name().clone()));
}
let request = Request::from(dist);
request_sink.blocking_send(request)?;
}
}
}
Ok(())
}
/// Check if the distribution is incompatible with the Python requirement, and if so, return
/// the incompatibility.
fn check_requires_python<'dist>(
dist: &'dist CompatibleDist,
python_requirement: &PythonRequirement,
) -> Option<(&'dist VersionSpecifiers, IncompatibleDist)> {
let requires_python = dist.requires_python()?;
if python_requirement.target().is_contained_by(requires_python) {
None
} else {
let incompatibility = if matches!(dist, CompatibleDist::CompatibleWheel { .. }) {
IncompatibleDist::Wheel(IncompatibleWheel::RequiresPython(
requires_python.clone(),
if python_requirement.installed() == python_requirement.target() {
PythonRequirementKind::Installed
} else {
PythonRequirementKind::Target
},
))
} else {
IncompatibleDist::Source(IncompatibleSource::RequiresPython(
requires_python.clone(),
if python_requirement.installed() == python_requirement.target() {
PythonRequirementKind::Installed
} else {
PythonRequirementKind::Target
},
))
};
Some((requires_python, incompatibility))
}
}
/// Given a candidate package and version, return its dependencies.
#[instrument(skip_all, fields(%package, %version))]
fn get_dependencies_forking(
&self,
id: Id<PubGrubPackage>,
package: &PubGrubPackage,
version: &Version,
pins: &FilePins,
fork_urls: &ForkUrls,
env: &ResolverEnvironment,
python_requirement: &PythonRequirement,
pubgrub: &State<UvDependencyProvider>,
) -> Result<ForkedDependencies, ResolveError> {
let result = self.get_dependencies(
id,
package,
version,
pins,
fork_urls,
env,
python_requirement,
pubgrub,
);
if env.marker_environment().is_some() {
result.map(|deps| match deps {
Dependencies::Available(deps) | Dependencies::Unforkable(deps) => {
ForkedDependencies::Unforked(deps)
}
Dependencies::Unavailable(err) => ForkedDependencies::Unavailable(err),
})
} else {
Ok(result?.fork(env, python_requirement, &self.conflicts))
}
}
/// Given a candidate package and version, return its dependencies.
#[instrument(skip_all, fields(%package, %version))]
fn get_dependencies(
&self,
id: Id<PubGrubPackage>,
package: &PubGrubPackage,
version: &Version,
pins: &FilePins,
fork_urls: &ForkUrls,
env: &ResolverEnvironment,
python_requirement: &PythonRequirement,
pubgrub: &State<UvDependencyProvider>,
) -> Result<Dependencies, ResolveError> {
let dependencies = match &**package {
PubGrubPackageInner::Root(_) => {
let no_dev_deps = BTreeMap::default();
let requirements = self.flatten_requirements(
&self.requirements,
&no_dev_deps,
None,
None,
None,
env,
python_requirement,
);
requirements
.flat_map(move |requirement| {
PubGrubDependency::from_requirement(
&self.conflicts,
requirement,
None,
Some(package),
)
})
.collect()
}
PubGrubPackageInner::Package {
name,
extra,
group,
marker: _,
} => {
// If we're excluding transitive dependencies, short-circuit.
if self.dependency_mode.is_direct() {
return Ok(Dependencies::Unforkable(Vec::default()));
}
// Look up the distribution ID from the pins (common case) or fork URLs.
let owned_id;
let distribution_id = if let Some((_, metadata_id)) =
pins.dist_and_id(name, version)
{
metadata_id
} else if let Some(url) = fork_urls.get(name) {
let dist = Dist::from_url(name.clone(), url.clone())?;
owned_id = dist.distribution_id();
&owned_id
} else {
debug_assert!(
false,
"Dependencies were requested for a package without a pinned distribution"
);
return Err(ResolveError::UnregisteredTask(format!("{name}=={version}")));
};
// If the package does not exist in the registry or locally, we cannot fetch its dependencies
if self.dependency_mode.is_transitive()
&& self.unavailable_packages.get(name).is_some()
&& self.installed_packages.get_packages(name).is_empty()
{
debug_assert!(
false,
"Dependencies were requested for a package that is not available"
);
return Err(ResolveError::PackageUnavailable(name.clone()));
}
// Wait for the metadata to be available.
let response = self
.index
.distributions()
.wait_blocking(distribution_id)
.ok_or_else(|| ResolveError::UnregisteredTask(format!("{name}=={version}")))?;
let metadata = match &*response {
MetadataResponse::Found(archive) => &archive.metadata,
MetadataResponse::Unavailable(reason) => {
let unavailable_version = UnavailableVersion::from(reason);
let message = unavailable_version.singular_message();
if let Some(err) = reason.source() {
// Show the detailed error for metadata parse errors.
warn!("{name} {message}: {err}");
} else {
warn!("{name} {message}");
}
self.incomplete_packages
.entry(name.clone())
.or_default()
.insert(version.clone(), reason.clone());
return Ok(Dependencies::Unavailable(unavailable_version));
}
MetadataResponse::Error(dist, err) => {
let chain = DerivationChainBuilder::from_state(id, version, pubgrub)
.unwrap_or_default();
return Err(ResolveError::Dist(
DistErrorKind::from_requested_dist(dist, &**err),
dist.clone(),
chain,
err.clone(),
));
}
};
// If there was no requires-python on the index page, we may have an incompatible
// distribution.
if let Some(requires_python) = &metadata.requires_python {
if !python_requirement.target().is_contained_by(requires_python) {
return Ok(Dependencies::Unavailable(
UnavailableVersion::RequiresPython(requires_python.clone()),
));
}
}
// Identify any system dependencies based on the index URL.
let system_dependencies = self
.options
.torch_backend
.as_ref()
.filter(|torch_backend| matches!(torch_backend, TorchStrategy::Cuda { .. }))
.filter(|torch_backend| torch_backend.has_system_dependency(name))
.and_then(|_| pins.get(name, version).and_then(ResolvedDist::index))
.map(IndexUrl::url)
.and_then(SystemDependency::from_index)
.into_iter()
.inspect(|system_dependency| {
debug!(
"Adding system dependency `{}` for `{package}@{version}`",
system_dependency
);
})
.map(PubGrubDependency::from);
let requirements = self.flatten_requirements(
&metadata.requires_dist,
&metadata.dependency_groups,
extra.as_ref(),
group.as_ref(),
Some(name),
env,
python_requirement,
);
requirements
.filter(|requirement| !self.excludes.contains(&requirement.name))
.flat_map(|requirement| {
PubGrubDependency::from_requirement(
&self.conflicts,
requirement,
group.as_ref(),
Some(package),
)
})
.chain(system_dependencies)
.collect()
}
PubGrubPackageInner::Python(_) => return Ok(Dependencies::Unforkable(Vec::default())),
PubGrubPackageInner::System(_) => return Ok(Dependencies::Unforkable(Vec::default())),
// Add a dependency on both the marker and base package.
PubGrubPackageInner::Marker { name, marker } => {
return Ok(Dependencies::Unforkable(
[MarkerTree::TRUE, *marker]
.into_iter()
.map(move |marker| PubGrubDependency {
package: PubGrubPackage::from(PubGrubPackageInner::Package {
name: name.clone(),
extra: None,
group: None,
marker,
}),
version: Range::singleton(version.clone()),
parent: None,
source: DependencySource::Unspecified,
})
.collect(),
));
}
// Add a dependency on both the extra and base package, with and without the marker.
PubGrubPackageInner::Extra {
name,
extra,
marker,
} => {
return Ok(Dependencies::Unforkable(
[MarkerTree::TRUE, *marker]
.into_iter()
.dedup()
.flat_map(move |marker| {
[None, Some(extra)]
.into_iter()
.map(move |extra| PubGrubDependency {
package: PubGrubPackage::from(PubGrubPackageInner::Package {
name: name.clone(),
extra: extra.cloned(),
group: None,
marker,
}),
version: Range::singleton(version.clone()),
parent: None,
source: DependencySource::Unspecified,
})
})
.collect(),
));
}
// Add a dependency on the dependency group, with and without the marker.
PubGrubPackageInner::Group {
name,
group,
marker,
} => {
return Ok(Dependencies::Unforkable(
[MarkerTree::TRUE, *marker]
.into_iter()
.dedup()
.map(|marker| PubGrubDependency {
package: PubGrubPackage::from(PubGrubPackageInner::Package {
name: name.clone(),
extra: None,
group: Some(group.clone()),
marker,
}),
version: Range::singleton(version.clone()),
parent: None,
source: DependencySource::Unspecified,
})
.collect(),
));
}
};
Ok(Dependencies::Available(dependencies))
}
/// The regular and dev dependencies filtered by Python version and the markers of this fork,
/// plus the extras dependencies of the current package (e.g., `black` depending on
/// `black[colorama]`).
fn flatten_requirements<'a>(
&'a self,
dependencies: &'a [Requirement],
dev_dependencies: &'a BTreeMap<GroupName, Box<[Requirement]>>,
extra: Option<&'a ExtraName>,
dev: Option<&'a GroupName>,
name: Option<&PackageName>,
env: &'a ResolverEnvironment,
python_requirement: &'a PythonRequirement,
) -> impl Iterator<Item = Cow<'a, Requirement>> {
let python_marker = python_requirement.to_marker_tree();
if let Some(dev) = dev {
// Dependency groups can include the project itself, so no need to flatten recursive
// dependencies.
Either::Left(Either::Left(self.requirements_for_extra(
dev_dependencies.get(dev).into_iter().flatten(),
extra,
env,
python_marker,
python_requirement,
)))
} else if !dependencies
.iter()
.any(|req| name == Some(&req.name) && !req.extras.is_empty())
{
// If the project doesn't define any recursive dependencies, take the fast path.
Either::Left(Either::Right(self.requirements_for_extra(
dependencies.iter(),
extra,
env,
python_marker,
python_requirement,
)))
} else {
let mut requirements = self
.requirements_for_extra(
dependencies.iter(),
extra,
env,
python_marker,
python_requirement,
)
.collect::<Vec<_>>();
// Transitively process all extras that are recursively included, starting with the current
// extra.
let mut seen = FxHashSet::<(ExtraName, MarkerTree)>::default();
let mut queue: VecDeque<_> = requirements
.iter()
.filter(|req| name == Some(&req.name))
.flat_map(|req| req.extras.iter().cloned().map(|extra| (extra, req.marker)))
.collect();
while let Some((extra, marker)) = queue.pop_front() {
if !seen.insert((extra.clone(), marker)) {
continue;
}
for requirement in self.requirements_for_extra(
dependencies,
Some(&extra),
env,
python_marker,
python_requirement,
) {
let requirement = match requirement {
Cow::Owned(mut requirement) => {
requirement.marker.and(marker);
requirement
}
Cow::Borrowed(requirement) => {
let mut marker = marker;
marker.and(requirement.marker);
Requirement {
name: requirement.name.clone(),
extras: requirement.extras.clone(),
groups: requirement.groups.clone(),
source: requirement.source.clone(),
origin: requirement.origin.clone(),
marker: marker.simplify_extras(slice::from_ref(&extra)),
}
}
};
if name == Some(&requirement.name) {
// Add each transitively included extra.
queue.extend(
requirement
.extras
.iter()
.cloned()
.map(|extra| (extra, requirement.marker)),
);
} else {
// Add the requirements for that extra.
requirements.push(Cow::Owned(requirement));
}
}
}
// Retain any self-constraints for that extra, e.g., if `project[foo]` includes
// `project[bar]>1.0`, as a dependency, we need to propagate `project>1.0`, in addition to
// transitively expanding `project[bar]`.
let mut self_constraints = vec![];
for req in &requirements {
if name == Some(&req.name) && !req.source.is_empty() {
self_constraints.push(Requirement {
name: req.name.clone(),
extras: Box::new([]),
groups: req.groups.clone(),
source: req.source.clone(),
origin: req.origin.clone(),
marker: req.marker,
});
}
}
// Drop all the self-requirements now that we flattened them out.
requirements.retain(|req| name != Some(&req.name) || req.extras.is_empty());
requirements.extend(self_constraints.into_iter().map(Cow::Owned));
Either::Right(requirements.into_iter())
}
}
/// The set of the regular and dev dependencies, filtered by Python version,
/// the markers of this fork and the requested extra.
fn requirements_for_extra<'data, 'parameters>(
&'data self,
dependencies: impl IntoIterator<Item = &'data Requirement> + 'parameters,
extra: Option<&'parameters ExtraName>,
env: &'parameters ResolverEnvironment,
python_marker: MarkerTree,
python_requirement: &'parameters PythonRequirement,
) -> impl Iterator<Item = Cow<'data, Requirement>> + 'parameters
where
'data: 'parameters,
{
self.overrides
.apply(dependencies)
.filter(move |requirement| {
Self::is_requirement_applicable(
requirement,
extra,
env,
python_marker,
python_requirement,
)
})
.flat_map(move |requirement| {
iter::once(requirement.clone()).chain(self.constraints_for_requirement(
requirement,
extra,
env,
python_marker,
python_requirement,
))
})
}
/// Whether a requirement is applicable for the Python version, the markers of this fork and the
/// requested extra.
fn is_requirement_applicable(
requirement: &Requirement,
extra: Option<&ExtraName>,
env: &ResolverEnvironment,
python_marker: MarkerTree,
python_requirement: &PythonRequirement,
) -> bool {
// If the requirement isn't relevant for the current platform, skip it.
match extra {
Some(source_extra) => {
// Only include requirements that are relevant for the current extra.
if requirement.evaluate_markers(env.marker_environment(), &[]) {
return false;
}
if !requirement
.evaluate_markers(env.marker_environment(), slice::from_ref(source_extra))
{
return false;
}
if !env.included_by_group(ConflictItemRef::from((&requirement.name, source_extra)))
{
return false;
}
}
None => {
if !requirement.evaluate_markers(env.marker_environment(), &[]) {
return false;
}
}
}
// If the requirement would not be selected with any Python version
// supported by the root, skip it.
if python_marker.is_disjoint(requirement.marker) {
trace!(
"Skipping {requirement} because of Requires-Python: {requires_python}",
requires_python = python_requirement.target(),
);
return false;
}
// If we're in a fork in universal mode, ignore any dependency that isn't part of
// this fork (but will be part of another fork).
if !env.included_by_marker(requirement.marker) {
trace!("Skipping {requirement} because of {env}");
return false;
}
true
}
/// The constraints applicable to the requirement, filtered by Python version, the markers of
/// this fork and the requested extra.
fn constraints_for_requirement<'data, 'parameters>(
&'data self,
requirement: Cow<'data, Requirement>,
extra: Option<&'parameters ExtraName>,
env: &'parameters ResolverEnvironment,
python_marker: MarkerTree,
python_requirement: &'parameters PythonRequirement,
) -> impl Iterator<Item = Cow<'data, Requirement>> + 'parameters
where
'data: 'parameters,
{
self.constraints
.get(&requirement.name)
.into_iter()
.flatten()
.filter_map(move |constraint| {
// If the requirement would not be selected with any Python version
// supported by the root, skip it.
let constraint = if constraint.marker.is_true() {
// Additionally, if the requirement is `requests ; sys_platform == 'darwin'`
// and the constraint is `requests ; python_version == '3.6'`, the
// constraint should only apply when _both_ markers are true.
if requirement.marker.is_true() {
Cow::Borrowed(constraint)
} else {
let mut marker = constraint.marker;
marker.and(requirement.marker);
if marker.is_false() {
trace!(
"Skipping {constraint} because of disjoint markers: `{}` vs. `{}`",
constraint.marker.try_to_string().unwrap(),
requirement.marker.try_to_string().unwrap(),
);
return None;
}
Cow::Owned(Requirement {
name: constraint.name.clone(),
extras: constraint.extras.clone(),
groups: constraint.groups.clone(),
source: constraint.source.clone(),
origin: constraint.origin.clone(),
marker,
})
}
} else {
let requires_python = python_requirement.target();
let mut marker = constraint.marker;
marker.and(requirement.marker);
if marker.is_false() {
trace!(
"Skipping {constraint} because of disjoint markers: `{}` vs. `{}`",
constraint.marker.try_to_string().unwrap(),
requirement.marker.try_to_string().unwrap(),
);
return None;
}
// Additionally, if the requirement is `requests ; sys_platform == 'darwin'`
// and the constraint is `requests ; python_version == '3.6'`, the
// constraint should only apply when _both_ markers are true.
if python_marker.is_disjoint(marker) {
trace!(
"Skipping constraint {requirement} because of Requires-Python: {requires_python}"
);
return None;
}
if marker == constraint.marker {
Cow::Borrowed(constraint)
} else {
Cow::Owned(Requirement {
name: constraint.name.clone(),
extras: constraint.extras.clone(),
groups: constraint.groups.clone(),
source: constraint.source.clone(),
origin: constraint.origin.clone(),
marker,
})
}
};
// If we're in a fork in universal mode, ignore any dependency that isn't part of
// this fork (but will be part of another fork).
if !env.included_by_marker(constraint.marker) {
trace!("Skipping {constraint} because of {env}");
return None;
}
// If the constraint isn't relevant for the current platform, skip it.
match extra {
Some(source_extra) => {
if !constraint
.evaluate_markers(env.marker_environment(), slice::from_ref(source_extra))
{
return None;
}
if !env.included_by_group(ConflictItemRef::from((&requirement.name, source_extra)))
{
return None;
}
}
None => {
if !constraint.evaluate_markers(env.marker_environment(), &[]) {
return None;
}
}
}
Some(constraint)
})
}
/// Fetch the metadata for a stream of packages and versions.
async fn fetch<Provider: ResolverProvider>(
self: Arc<Self>,
provider: Arc<Provider>,
request_stream: Receiver<Request>,
) -> Result<(), ResolveError> {
let mut response_stream = ReceiverStream::new(request_stream)
.map(|request| self.process_request(request, &*provider).boxed_local())
// Allow as many futures as possible to start in the background.
// Backpressure is provided by at a more granular level by `DistributionDatabase`
// and `SourceDispatch`, as well as the bounded request channel.
.buffer_unordered(usize::MAX);
while let Some(response) = response_stream.next().await {
match response? {
Some(Response::Package(name, index, version_map)) => {
trace!("Received package metadata for: {name}");
if let Some(index) = index {
self.index
.explicit()
.done((name, index), Arc::new(version_map));
} else {
self.index.implicit().done(name, Arc::new(version_map));
}
}
Some(Response::Installed { dist, metadata }) => {
trace!("Received installed distribution metadata for: {dist}");
self.index
.distributions()
.done(dist.distribution_id(), Arc::new(metadata));
}
Some(Response::Dist { dist, metadata }) => {
let dist_kind = match dist {
Dist::Built(_) => "built",
Dist::Source(_) => "source",
};
trace!("Received {dist_kind} distribution metadata for: {dist}");
if let MetadataResponse::Unavailable(reason) = &metadata {
let message = UnavailableVersion::from(reason).singular_message();
if let Some(err) = reason.source() {
// Show the detailed error for metadata parse errors.
warn!("{dist} {message}: {err}");
} else {
warn!("{dist} {message}");
}
}
self.index
.distributions()
.done(dist.distribution_id(), Arc::new(metadata));
}
None => {}
}
}
Ok::<(), ResolveError>(())
}
#[instrument(skip_all, fields(%request))]
async fn process_request<Provider: ResolverProvider>(
&self,
request: Request,
provider: &Provider,
) -> Result<Option<Response>, ResolveError> {
match request {
// Fetch package metadata from the registry.
Request::Package(package_name, index) => {
let package_versions = provider
.get_package_versions(&package_name, index.as_ref())
.boxed_local()
.await
.map_err(ResolveError::Client)?;
Ok(Some(Response::Package(
package_name,
index.map(IndexMetadata::into_url),
package_versions,
)))
}
// Fetch distribution metadata from the distribution database.
Request::Dist(dist) => {
if let Some(version) = dist.version() {
if let Some(index) = dist.index() {
// Check the implicit indexes for pre-provided metadata.
let versions_response = self.index.implicit().get(dist.name());
if let Some(VersionsResponse::Found(version_maps)) =
versions_response.as_deref()
{
for version_map in version_maps {
if version_map.index() == Some(index) {
let Some(metadata) = version_map.get_metadata(version) else {
continue;
};
debug!("Found registry-provided metadata for: {dist}");
return Ok(Some(Response::Dist {
dist,
metadata: MetadataResponse::Found(
ArchiveMetadata::from_metadata23(metadata.clone()),
),
}));
}
}
}
// Check the explicit indexes for pre-provided metadata.
let versions_response = self
.index
.explicit()
.get(&(dist.name().clone(), index.clone()));
if let Some(VersionsResponse::Found(version_maps)) =
versions_response.as_deref()
{
for version_map in version_maps {
let Some(metadata) = version_map.get_metadata(version) else {
continue;
};
debug!("Found registry-provided metadata for: {dist}");
return Ok(Some(Response::Dist {
dist,
metadata: MetadataResponse::Found(
ArchiveMetadata::from_metadata23(metadata.clone()),
),
}));
}
}
}
}
let metadata = provider
.get_or_build_wheel_metadata(&dist)
.boxed_local()
.await?;
if let MetadataResponse::Found(metadata) = &metadata {
if &metadata.metadata.name != dist.name() {
return Err(ResolveError::MismatchedPackageName {
request: "distribution metadata",
expected: dist.name().clone(),
actual: metadata.metadata.name.clone(),
});
}
}
Ok(Some(Response::Dist { dist, metadata }))
}
Request::Installed(dist) => {
let metadata = provider.get_installed_metadata(&dist).boxed_local().await?;
if let MetadataResponse::Found(metadata) = &metadata {
if &metadata.metadata.name != dist.name() {
return Err(ResolveError::MismatchedPackageName {
request: "installed metadata",
expected: dist.name().clone(),
actual: metadata.metadata.name.clone(),
});
}
}
Ok(Some(Response::Installed { dist, metadata }))
}
// Pre-fetch the package and distribution metadata.
Request::Prefetch(package_name, range, python_requirement) => {
// Wait for the package metadata to become available.
let versions_response = self
.index
.implicit()
.wait(&package_name)
.await
.ok_or_else(|| ResolveError::UnregisteredTask(package_name.to_string()))?;
let version_map = match *versions_response {
VersionsResponse::Found(ref version_map) => version_map,
// Short-circuit if we did not find any versions for the package
VersionsResponse::NoIndex => {
self.unavailable_packages
.insert(package_name.clone(), UnavailablePackage::NoIndex);
return Ok(None);
}
VersionsResponse::Offline => {
self.unavailable_packages
.insert(package_name.clone(), UnavailablePackage::Offline);
return Ok(None);
}
VersionsResponse::NotFound => {
self.unavailable_packages
.insert(package_name.clone(), UnavailablePackage::NotFound);
return Ok(None);
}
};
// We don't have access to the fork state when prefetching, so assume that
// pre-release versions are allowed.
let env = ResolverEnvironment::universal(vec![]);
// Try to find a compatible version. If there aren't any compatible versions,
// short-circuit.
let Some(candidate) = self.selector.select(
&package_name,
&range,
version_map,
&self.preferences,
&self.installed_packages,
&self.exclusions,
None,
&env,
self.tags.as_ref(),
) else {
return Ok(None);
};
// If there is not a compatible distribution, short-circuit.
let Some(dist) = candidate.compatible() else {
return Ok(None);
};
// If the registry provided metadata for this distribution, use it.
for version_map in version_map {
if let Some(metadata) = version_map.get_metadata(candidate.version()) {
let dist = dist.for_resolution();
if version_map.index() == dist.index() {
debug!("Found registry-provided metadata for: {dist}");
let metadata = MetadataResponse::Found(
ArchiveMetadata::from_metadata23(metadata.clone()),
);
let dist = dist.to_owned();
if &package_name != dist.name() {
return Err(ResolveError::MismatchedPackageName {
request: "distribution",
expected: package_name,
actual: dist.name().clone(),
});
}
let response = match dist {
ResolvedDist::Installable { dist, .. } => Response::Dist {
dist: (*dist).clone(),
metadata,
},
ResolvedDist::Installed { dist } => Response::Installed {
dist: (*dist).clone(),
metadata,
},
};
return Ok(Some(response));
}
}
}
// Avoid prefetching source distributions with unbounded lower-bound ranges. This
// often leads to failed attempts to build legacy versions of packages that are
// incompatible with modern build tools.
if dist.wheel().is_none() {
if !self.selector.use_highest_version(&package_name, &env) {
if let Some((lower, _)) = range.iter().next() {
if lower == &Bound::Unbounded {
debug!(
"Skipping prefetch for unbounded minimum-version range: {package_name} ({range})"
);
return Ok(None);
}
}
}
}
// Validate the Python requirement.
let requires_python = match dist {
CompatibleDist::InstalledDist(_) => None,
CompatibleDist::SourceDist { sdist, .. }
| CompatibleDist::IncompatibleWheel { sdist, .. } => {
sdist.file.requires_python.as_ref()
}
CompatibleDist::CompatibleWheel { wheel, .. } => {
wheel.file.requires_python.as_ref()
}
};
if let Some(requires_python) = requires_python.as_ref() {
if !python_requirement.target().is_contained_by(requires_python) {
return Ok(None);
}
}
// Verify that the package is allowed under the hash-checking policy.
if !self
.hasher
.allows_package(candidate.name(), candidate.version())
{
return Ok(None);
}
// Emit a request to fetch the metadata for this version.
let dist = dist.for_resolution();
if self.index.distributions().register(dist.distribution_id()) {
let dist = dist.to_owned();
if &package_name != dist.name() {
return Err(ResolveError::MismatchedPackageName {
request: "distribution",
expected: package_name,
actual: dist.name().clone(),
});
}
let response = match dist {
ResolvedDist::Installable { dist, .. } => {
let metadata = provider
.get_or_build_wheel_metadata(&dist)
.boxed_local()
.await?;
Response::Dist {
dist: (*dist).clone(),
metadata,
}
}
ResolvedDist::Installed { dist } => {
let metadata =
provider.get_installed_metadata(&dist).boxed_local().await?;
Response::Installed {
dist: (*dist).clone(),
metadata,
}
}
};
Ok(Some(response))
} else {
Ok(None)
}
}
}
}
fn convert_no_solution_err(
&self,
mut err: pubgrub::NoSolutionError<UvDependencyProvider>,
fork_urls: ForkUrls,
fork_indexes: ForkIndexes,
env: ResolverEnvironment,
current_environment: MarkerEnvironment,
visited: &FxHashSet<PackageName>,
) -> ResolveError {
err = NoSolutionError::collapse_local_version_segments(NoSolutionError::collapse_proxies(
err,
));
let mut unavailable_packages = FxHashMap::default();
for package in err.packages() {
if let PubGrubPackageInner::Package { name, .. } = &**package {
if let Some(reason) = self.unavailable_packages.get(name) {
unavailable_packages.insert(name.clone(), reason.clone());
}
}
}
let mut incomplete_packages = FxHashMap::default();
for package in err.packages() {
if let PubGrubPackageInner::Package { name, .. } = &**package {
if let Some(versions) = self.incomplete_packages.get(name) {
for entry in versions.iter() {
let (version, reason) = entry.pair();
incomplete_packages
.entry(name.clone())
.or_insert_with(BTreeMap::default)
.insert(version.clone(), reason.clone());
}
}
}
}
let mut available_indexes = FxHashMap::default();
let mut included_versions = FxHashMap::default();
let mut available_versions = FxHashMap::default();
let available_version_cutoff: Option<ExcludeNewerValue> =
std::env::var(EnvVars::UV_TEST_AVAILABLE_VERSION_CUTOFF)
.ok()
.and_then(|s| s.parse().ok());
for package in err.packages() {
let Some(name) = package.name() else { continue };
if !visited.contains(name) {
// Avoid including version data for packages that exist in the derivation
// tree, but were never visited during resolution. We _may_ have metadata for
// these packages, but it's non-deterministic, and omitting them ensures that
// we represent the state of the resolver at the time of failure.
continue;
}
let versions_response = if let Some(index) = fork_indexes.get(name) {
self.index
.explicit()
.get(&(name.clone(), index.url().clone()))
} else {
self.index.implicit().get(name)
};
if let Some(response) = versions_response {
if let VersionsResponse::Found(ref version_maps) = *response {
// Track included and available versions, across all indexes.
for version_map in version_maps {
let package_included_versions = included_versions
.entry(name.clone())
.or_insert_with(BTreeSet::new);
let package_available_versions = available_versions
.entry(name.clone())
.or_insert_with(BTreeSet::new);
for (version, dists) in version_map.iter(&Ranges::full()) {
// Included versions are those that survive the effective
// `exclude-newer` filter used during resolution. Files with
// missing upload times are treated as excluded (matching
// the resolution behavior in `version_map.rs`).
let excluded_from_included = || {
let Some(exclude_newer) = version_map.exclude_newer() else {
return false;
};
let Some(prioritized_dist) = dists.prioritized_dist() else {
return true;
};
prioritized_dist.files().all(|file| {
file.upload_time_utc_ms.is_none_or(|upload_time| {
upload_time >= exclude_newer.timestamp_millis()
})
})
};
if !excluded_from_included() {
package_included_versions.insert(version.clone());
}
// Available versions are used in resolver error reporting,
// and can be bounded by a test-only cutoff for deterministic
// snapshots. Files with missing upload times are *not*
// excluded, since we only filter versions we can confirm
// were published after the cutoff.
let excluded_from_available = || {
let Some(ref exclude_newer) = available_version_cutoff else {
return false;
};
let Some(prioritized_dist) = dists.prioritized_dist() else {
return false;
};
prioritized_dist.files().all(|file| {
file.upload_time_utc_ms.is_some_and(|upload_time| {
upload_time >= exclude_newer.timestamp_millis()
})
})
};
if !excluded_from_available() {
package_available_versions.insert(version.clone());
}
}
}
// Track the indexes in which the package is available.
available_indexes
.entry(name.clone())
.or_insert(BTreeSet::new())
.extend(
version_maps
.iter()
.filter_map(|version_map| version_map.index().cloned()),
);
}
}
}
ResolveError::NoSolution(Box::new(NoSolutionError::new(
err,
self.index.clone(),
included_versions,
available_versions,
available_indexes,
self.selector.clone(),
self.python_requirement.clone(),
self.locations.clone(),
self.capabilities.clone(),
unavailable_packages,
incomplete_packages,
fork_urls,
fork_indexes,
env,
current_environment,
self.tags.clone(),
self.workspace_members.clone(),
self.options.clone(),
)))
}
fn on_progress(&self, package: &PubGrubPackage, version: &Version) {
if let Some(reporter) = self.reporter.as_ref() {
match &**package {
PubGrubPackageInner::Root(_) => {}
PubGrubPackageInner::Python(_) => {}
PubGrubPackageInner::System(_) => {}
PubGrubPackageInner::Marker { .. } => {}
PubGrubPackageInner::Extra { .. } => {}
PubGrubPackageInner::Group { .. } => {}
PubGrubPackageInner::Package { name, .. } => {
reporter.on_progress(name, &VersionOrUrlRef::Version(version));
}
}
}
}
fn on_complete(&self) {
if let Some(reporter) = self.reporter.as_ref() {
reporter.on_complete();
}
}
}
/// State that is used during unit propagation in the resolver, one instance per fork.
#[derive(Clone)]
pub(crate) struct ForkState {
/// The internal state used by the resolver.
///
/// Note that not all parts of this state are strictly internal. For
/// example, the edges in the dependency graph generated as part of the
/// output of resolution are derived from the "incompatibilities" tracked
/// in this state. We also ultimately retrieve the final set of version
/// assignments (to packages) from this state's "partial solution."
pubgrub: State<UvDependencyProvider>,
/// The initial package to select. If set, the first iteration over this state will avoid
/// asking PubGrub for the highest-priority package, and will instead use the provided package.
initial_id: Option<Id<PubGrubPackage>>,
/// The initial version to select. If set, the first iteration over this state will avoid
/// asking PubGrub for the highest-priority version, and will instead use the provided version.
initial_version: Option<Version>,
/// The next package on which to run unit propagation.
next: Id<PubGrubPackage>,
/// The set of pinned versions we accrue throughout resolution.
///
/// The key of this map is a package name, and each package name maps to
/// a set of versions for that package. Each version in turn is mapped
/// to the concrete distribution selected for installation, along with the
/// concrete distribution whose metadata was used during resolution.
/// After resolution is finished, this map is consulted to recover both the
/// locked artifact and the metadata backing the resolved dependency edges.
pins: FilePins,
/// Ensure we don't have duplicate URLs in any branch.
///
/// Unlike [`Urls`], we add only the URLs we have seen in this branch, and there can be only
/// one URL per package. By prioritizing direct URL dependencies over registry dependencies,
/// this map is populated for all direct URL packages before we look at any registry packages.
fork_urls: ForkUrls,
/// Ensure we don't have duplicate indexes in any branch.
///
/// Unlike [`Indexes`], we add only the indexes we have seen in this branch, and there can be
/// only one index per package.
fork_indexes: ForkIndexes,
/// When dependencies for a package are retrieved, this map of priorities
/// is updated based on how each dependency was specified. Certain types
/// of dependencies have more "priority" than others (like direct URL
/// dependencies). These priorities help determine which package to
/// consider next during resolution.
priorities: PubGrubPriorities,
/// This keeps track of the set of versions for each package that we've
/// already visited during resolution. This avoids doing redundant work.
added_dependencies: FxHashMap<Id<PubGrubPackage>, FxHashSet<Version>>,
/// The marker expression that created this state.
///
/// The root state always corresponds to a marker expression that is always
/// `true` for every `MarkerEnvironment`.
///
/// In non-universal mode, forking never occurs and so this marker
/// expression is always `true`.
///
/// Whenever dependencies are fetched, all requirement specifications
/// are checked for disjointness with the marker expression of the fork
/// in which those dependencies were fetched. If a requirement has a
/// completely disjoint marker expression (i.e., it can never be true given
/// that the marker expression that provoked the fork is true), then that
/// dependency is completely ignored.
env: ResolverEnvironment,
/// The Python requirement for this fork. Defaults to the Python requirement for
/// the resolution, but may be narrowed if a `python_version` marker is present
/// in a given fork.
///
/// For example, in:
/// ```text
/// numpy >=1.26 ; python_version >= "3.9"
/// numpy <1.26 ; python_version < "3.9"
/// ```
///
/// The top fork has a narrower Python compatibility range, and thus can find a
/// solution that omits Python 3.8 support.
python_requirement: PythonRequirement,
conflict_tracker: ConflictTracker,
/// Prefetch package versions for packages with many rejected versions.
///
/// Tracked on the fork state to avoid counting each identical version between forks as new try.
prefetcher: BatchPrefetcher,
}
impl ForkState {
fn new(
pubgrub: State<UvDependencyProvider>,
env: ResolverEnvironment,
python_requirement: PythonRequirement,
prefetcher: BatchPrefetcher,
) -> Self {
Self {
initial_id: None,
initial_version: None,
next: pubgrub.root_package,
pubgrub,
pins: FilePins::default(),
fork_urls: ForkUrls::default(),
fork_indexes: ForkIndexes::default(),
priorities: PubGrubPriorities::default(),
added_dependencies: FxHashMap::default(),
env,
python_requirement,
conflict_tracker: ConflictTracker::default(),
prefetcher,
}
}
/// Visit the dependencies for the selected version of the current package, incorporating any
/// relevant URLs and pinned indexes into the [`ForkState`].
fn visit_package_version_dependencies(
&mut self,
for_package: Id<PubGrubPackage>,
for_version: &Version,
urls: &Urls,
indexes: &Indexes,
dependencies: &[PubGrubDependency],
git: &GitResolver,
workspace_members: &BTreeSet<PackageName>,
resolution_strategy: &ResolutionStrategy,
) -> Result<(), ResolveError> {
for dependency in dependencies {
let PubGrubDependency {
package,
version,
parent: _,
source,
} = dependency;
let mut has_url = false;
if let Some(name) = package.name() {
// From the [`Requirement`] to [`PubGrubDependency`] conversion, we get a URL if the
// requirement was a URL requirement. `Urls` applies canonicalization to this and
// override URLs to both URL and registry requirements, which we then check for
// conflicts using [`ForkUrl`].
for url in urls.get_url(&self.env, name, source.verbatim_url(), git)? {
self.fork_urls.insert(name, url, &self.env)?;
has_url = true;
}
if let Some(index) = source.explicit_index() {
self.fork_indexes.insert(name, index, &self.env)?;
}
// If the package is pinned to an exact index, add it to the fork.
for index in indexes.get(name, &self.env) {
self.fork_indexes.insert(name, index, &self.env)?;
}
}
if let Some(name) = self.pubgrub.package_store[for_package]
.name_no_root()
.filter(|name| !workspace_members.contains(name))
{
debug!(
"Adding transitive dependency for {name}=={for_version}: {package}{version}"
);
} else {
// A dependency from the root package or `requirements.txt`.
debug!("Adding direct dependency: {package}{version}");
// Warn the user if a direct dependency lacks a lower bound in `--lowest` resolution.
let missing_lower_bound = version
.bounding_range()
.map(|(lowest, _highest)| lowest == Bound::Unbounded)
.unwrap_or(true);
let strategy_lowest = matches!(
resolution_strategy,
ResolutionStrategy::Lowest | ResolutionStrategy::LowestDirect(..)
);
if !has_url && missing_lower_bound && strategy_lowest {
let name = package.name_no_root().unwrap();
// Handle cases where a package is listed both without and with a lower bound.
// Example:
// ```
// "coverage[toml] ; python_version < '3.11'",
// "coverage >= 7.10.0",
// ```
let bound_on_other_package = dependencies.iter().any(|other| {
Some(name) == other.package.name()
&& !other
.version
.bounding_range()
.map(|(lowest, _highest)| lowest == Bound::Unbounded)
.unwrap_or(true)
});
if !bound_on_other_package {
warn_user_once!(
"The direct dependency `{name}` is unpinned. \
Consider setting a lower bound when using `--resolution lowest` \
or `--resolution lowest-direct` to avoid using outdated versions.",
);
}
}
}
// Update the package priorities.
self.priorities.insert(package, version, &self.fork_urls);
// As we're adding an incompatibility from the proxy package to the base package,
// we need to register the base package.
if let Some(base_package) = package.base_package() {
self.priorities
.insert(&base_package, version, &self.fork_urls);
}
}
Ok(())
}
/// Add the dependencies for the selected version of the current package.
fn add_package_version_dependencies(
&mut self,
for_package: Id<PubGrubPackage>,
for_version: &Version,
dependencies: Vec<PubGrubDependency>,
) {
for dependency in &dependencies {
let PubGrubDependency {
package,
version,
parent: _,
source: _,
} = dependency;
let Some(base_package) = package.base_package() else {
continue;
};
let proxy_package = self.pubgrub.package_store.alloc(package.clone());
let base_package_id = self.pubgrub.package_store.alloc(base_package.clone());
self.pubgrub
.add_proxy_package(proxy_package, base_package_id, version.clone());
}
let conflict = self.pubgrub.add_package_version_dependencies(
self.next,
for_version.clone(),
dependencies.into_iter().map(|dependency| {
let PubGrubDependency {
package,
version,
parent: _,
source: _,
} = dependency;
(package, version)
}),
);
// Conflict tracking: If the version was rejected due to its dependencies, record culprit
// and affected.
if let Some(incompatibility) = conflict {
self.record_conflict(for_package, Some(for_version), incompatibility);
}
}
fn record_conflict(
&mut self,
affected: Id<PubGrubPackage>,
version: Option<&Version>,
incompatibility: IncompId<PubGrubPackage, Ranges<Version>, UnavailableReason>,
) {
let mut culprit_is_real = false;
for (incompatible, _term) in self.pubgrub.incompatibility_store[incompatibility].iter() {
if incompatible == affected {
continue;
}
if self.pubgrub.package_store[affected].name()
== self.pubgrub.package_store[incompatible].name()
{
// Don't track conflicts between a marker package and the main package, when the
// marker is "copying" the obligations from the main package through conflicts.
continue;
}
culprit_is_real = true;
let culprit_count = self
.conflict_tracker
.culprit
.entry(incompatible)
.or_default();
*culprit_count += 1;
if *culprit_count == CONFLICT_THRESHOLD {
self.conflict_tracker.deprioritize.push(incompatible);
}
}
// Don't track conflicts between a marker package and the main package, when the
// marker is "copying" the obligations from the main package through conflicts.
if culprit_is_real {
if tracing::enabled!(Level::DEBUG) {
let incompatibility = self.pubgrub.incompatibility_store[incompatibility]
.iter()
.map(|(package, _term)| &self.pubgrub.package_store[package])
.join(", ");
if let Some(version) = version {
debug!(
"Recording dependency conflict of {}=={} from incompatibility of ({})",
self.pubgrub.package_store[affected], version, incompatibility
);
} else {
debug!(
"Recording unit propagation conflict of {} from incompatibility of ({})",
self.pubgrub.package_store[affected], incompatibility
);
}
}
let affected_count = self.conflict_tracker.affected.entry(self.next).or_default();
*affected_count += 1;
if *affected_count == CONFLICT_THRESHOLD {
self.conflict_tracker.prioritize.push(self.next);
}
}
}
fn add_unavailable_version(&mut self, version: Version, reason: UnavailableVersion) {
// Incompatible requires-python versions are special in that we track
// them as incompatible dependencies instead of marking the package version
// as unavailable directly.
if let UnavailableVersion::IncompatibleDist(
IncompatibleDist::Source(IncompatibleSource::RequiresPython(requires_python, kind))
| IncompatibleDist::Wheel(IncompatibleWheel::RequiresPython(requires_python, kind)),
) = reason
{
let package = &self.next;
let python = self.pubgrub.package_store.alloc(PubGrubPackage::from(
PubGrubPackageInner::Python(match kind {
PythonRequirementKind::Installed => PubGrubPython::Installed,
PythonRequirementKind::Target => PubGrubPython::Target,
}),
));
self.pubgrub
.add_incompatibility(Incompatibility::from_dependency(
*package,
Range::singleton(version.clone()),
(python, release_specifiers_to_ranges(requires_python)),
));
self.pubgrub
.partial_solution
.add_decision(self.next, version);
return;
}
self.pubgrub
.add_incompatibility(Incompatibility::custom_version(
self.next,
version.clone(),
UnavailableReason::Version(reason),
));
}
/// Subset the current markers with the new markers and update the python requirements fields
/// accordingly.
///
/// If the fork should be dropped (e.g., because its markers can never be true for its
/// Python requirement), then this returns `None`.
fn with_env(mut self, env: ResolverEnvironment) -> Self {
self.env = env;
// If the fork contains a narrowed Python requirement, apply it.
if let Some(req) = self.env.narrow_python_requirement(&self.python_requirement) {
debug!("Narrowed `requires-python` bound to: {}", req.target());
self.python_requirement = req;
}
self
}
/// Returns the URL or index for a package and version.
///
/// In practice, exactly one of the returned values will be `Some`.
fn source(
&self,
name: &PackageName,
version: &Version,
) -> (Option<&VerbatimParsedUrl>, Option<&IndexUrl>) {
let url = self.fork_urls.get(name);
let index = url
.is_none()
.then(|| {
self.pins
.get(name, version)
.expect("Every package should be pinned")
.index()
})
.flatten();
(url, index)
}
fn into_resolution(self) -> Resolution {
let solution: FxHashMap<_, _> = self.pubgrub.partial_solution.extract_solution().collect();
let edge_count: usize = solution
.keys()
.map(|package| self.pubgrub.incompatibilities[package].len())
.sum();
let mut edges: Vec<ResolutionDependencyEdge> = Vec::with_capacity(edge_count);
for (package, self_version) in &solution {
for id in &self.pubgrub.incompatibilities[package] {
let pubgrub::Kind::FromDependencyOf(
self_package,
ref self_range,
dependency_package,
ref dependency_range,
) = self.pubgrub.incompatibility_store[*id].kind
else {
continue;
};
if *package != self_package {
continue;
}
if !self_range.contains(self_version) {
continue;
}
let Some(dependency_version) = solution.get(&dependency_package) else {
continue;
};
if !dependency_range.contains(dependency_version) {
continue;
}
let self_package = &self.pubgrub.package_store[self_package];
let dependency_package = &self.pubgrub.package_store[dependency_package];
let (self_name, self_extra, self_group) = match &**self_package {
PubGrubPackageInner::Package {
name: self_name,
extra: self_extra,
group: self_group,
marker: _,
} => (Some(self_name), self_extra.as_ref(), self_group.as_ref()),
PubGrubPackageInner::Root(_) => (None, None, None),
_ => continue,
};
let (self_url, self_index) = self_name
.map(|self_name| self.source(self_name, self_version))
.unwrap_or((None, None));
match **dependency_package {
PubGrubPackageInner::Package {
name: ref dependency_name,
extra: ref dependency_extra,
group: ref dependency_dev,
marker: ref dependency_marker,
} => {
debug_assert!(
dependency_extra.is_none(),
"Packages should depend on an extra proxy"
);
debug_assert!(
dependency_dev.is_none(),
"Packages should depend on a group proxy"
);
// Ignore self-dependencies (e.g., `tensorflow-macos` depends on `tensorflow-macos`),
// but allow groups to depend on other groups, or on the package itself.
if self_group.is_none() {
if self_name == Some(dependency_name) {
continue;
}
}
let (to_url, to_index) = self.source(dependency_name, dependency_version);
let edge = ResolutionDependencyEdge {
from: self_name.cloned(),
from_version: self_version.clone(),
from_url: self_url.cloned(),
from_index: self_index.cloned(),
from_extra: self_extra.cloned(),
from_group: self_group.cloned(),
to: dependency_name.clone(),
to_version: dependency_version.clone(),
to_url: to_url.cloned(),
to_index: to_index.cloned(),
to_extra: dependency_extra.clone(),
to_group: dependency_dev.clone(),
marker: *dependency_marker,
};
edges.push(edge);
}
PubGrubPackageInner::Marker {
name: ref dependency_name,
marker: ref dependency_marker,
} => {
// Ignore self-dependencies (e.g., `tensorflow-macos` depends on `tensorflow-macos`),
// but allow groups to depend on other groups, or on the package itself.
if self_group.is_none() {
if self_name == Some(dependency_name) {
continue;
}
}
let (to_url, to_index) = self.source(dependency_name, dependency_version);
let edge = ResolutionDependencyEdge {
from: self_name.cloned(),
from_version: self_version.clone(),
from_url: self_url.cloned(),
from_index: self_index.cloned(),
from_extra: self_extra.cloned(),
from_group: self_group.cloned(),
to: dependency_name.clone(),
to_version: dependency_version.clone(),
to_url: to_url.cloned(),
to_index: to_index.cloned(),
to_extra: None,
to_group: None,
marker: *dependency_marker,
};
edges.push(edge);
}
PubGrubPackageInner::Extra {
name: ref dependency_name,
extra: ref dependency_extra,
marker: ref dependency_marker,
} => {
if self_group.is_none() {
debug_assert!(
self_name != Some(dependency_name),
"Extras should be flattened"
);
}
let (to_url, to_index) = self.source(dependency_name, dependency_version);
// Insert an edge from the dependent package to the extra package.
let edge = ResolutionDependencyEdge {
from: self_name.cloned(),
from_version: self_version.clone(),
from_url: self_url.cloned(),
from_index: self_index.cloned(),
from_extra: self_extra.cloned(),
from_group: self_group.cloned(),
to: dependency_name.clone(),
to_version: dependency_version.clone(),
to_url: to_url.cloned(),
to_index: to_index.cloned(),
to_extra: Some(dependency_extra.clone()),
to_group: None,
marker: *dependency_marker,
};
edges.push(edge);
// Insert an edge from the dependent package to the base package.
let edge = ResolutionDependencyEdge {
from: self_name.cloned(),
from_version: self_version.clone(),
from_url: self_url.cloned(),
from_index: self_index.cloned(),
from_extra: self_extra.cloned(),
from_group: self_group.cloned(),
to: dependency_name.clone(),
to_version: dependency_version.clone(),
to_url: to_url.cloned(),
to_index: to_index.cloned(),
to_extra: None,
to_group: None,
marker: *dependency_marker,
};
edges.push(edge);
}
PubGrubPackageInner::Group {
name: ref dependency_name,
group: ref dependency_group,
marker: ref dependency_marker,
} => {
debug_assert!(
self_name != Some(dependency_name),
"Groups should be flattened"
);
let (to_url, to_index) = self.source(dependency_name, dependency_version);
// Add an edge from the dependent package to the dev package, but _not_ the
// base package.
let edge = ResolutionDependencyEdge {
from: self_name.cloned(),
from_version: self_version.clone(),
from_url: self_url.cloned(),
from_index: self_index.cloned(),
from_extra: self_extra.cloned(),
from_group: self_group.cloned(),
to: dependency_name.clone(),
to_version: dependency_version.clone(),
to_url: to_url.cloned(),
to_index: to_index.cloned(),
to_extra: None,
to_group: Some(dependency_group.clone()),
marker: *dependency_marker,
};
edges.push(edge);
}
_ => {}
}
}
}
let nodes = solution
.into_iter()
.filter_map(|(package, version)| {
if let PubGrubPackageInner::Package {
name,
extra,
group,
marker: MarkerTree::TRUE,
} = &*self.pubgrub.package_store[package]
{
let (url, index) = self.source(name, &version);
Some((
ResolutionPackage {
name: name.clone(),
extra: extra.clone(),
dev: group.clone(),
url: url.cloned(),
index: index.cloned(),
},
version,
))
} else {
None
}
})
.collect();
Resolution {
nodes,
edges,
pins: self.pins,
env: self.env,
}
}
}
/// The resolution from a single fork including the virtual packages and the edges between them.
#[derive(Debug)]
pub(crate) struct Resolution {
pub(crate) nodes: FxHashMap<ResolutionPackage, Version>,
/// The directed connections between the nodes, where the marker is the node weight. We don't
/// store the requirement itself, but it can be retrieved from the package metadata.
pub(crate) edges: Vec<ResolutionDependencyEdge>,
/// Map each package name, version tuple from `packages` to a distribution.
pub(crate) pins: FilePins,
/// The environment setting this resolution was found under.
pub(crate) env: ResolverEnvironment,
}
/// Package representation we used during resolution where each extra and also the dev-dependencies
/// group are their own package.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub(crate) struct ResolutionPackage {
pub(crate) name: PackageName,
pub(crate) extra: Option<ExtraName>,
pub(crate) dev: Option<GroupName>,
/// For registry packages, this is `None`; otherwise, the direct URL of the distribution.
pub(crate) url: Option<VerbatimParsedUrl>,
/// For URL packages, this is `None`; otherwise, the index URL of the distribution.
pub(crate) index: Option<IndexUrl>,
}
/// The `from_` fields and the `to_` fields allow mapping to the originating and target
/// [`ResolutionPackage`] respectively. The `marker` is the edge weight.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub(crate) struct ResolutionDependencyEdge {
/// This value is `None` if the dependency comes from the root package.
pub(crate) from: Option<PackageName>,
pub(crate) from_version: Version,
pub(crate) from_url: Option<VerbatimParsedUrl>,
pub(crate) from_index: Option<IndexUrl>,
pub(crate) from_extra: Option<ExtraName>,
pub(crate) from_group: Option<GroupName>,
pub(crate) to: PackageName,
pub(crate) to_version: Version,
pub(crate) to_url: Option<VerbatimParsedUrl>,
pub(crate) to_index: Option<IndexUrl>,
pub(crate) to_extra: Option<ExtraName>,
pub(crate) to_group: Option<GroupName>,
pub(crate) marker: MarkerTree,
}
impl ResolutionDependencyEdge {
pub(crate) fn universal_marker(&self) -> UniversalMarker {
// We specifically do not account for conflict
// markers here. Instead, those are computed via
// a traversal on the resolution graph.
UniversalMarker::new(self.marker, ConflictMarker::TRUE)
}
}
/// Fetch the metadata for an item
#[derive(Debug)]
#[expect(clippy::large_enum_variant)]
pub(crate) enum Request {
/// A request to fetch the metadata for a package.
Package(PackageName, Option<IndexMetadata>),
/// A request to fetch the metadata for a built or source distribution.
Dist(Dist),
/// A request to fetch the metadata from an already-installed distribution.
Installed(InstalledDist),
/// A request to pre-fetch the metadata for a package and the best-guess distribution.
Prefetch(PackageName, Range<Version>, PythonRequirement),
}
impl<'a> From<ResolvedDistRef<'a>> for Request {
fn from(dist: ResolvedDistRef<'a>) -> Self {
// N.B. This is almost identical to `ResolvedDistRef::to_owned`, but
// creates a `Request` instead of a `ResolvedDist`. There's probably
// some room for DRYing this up a bit. The obvious way would be to
// add a method to create a `Dist`, but a `Dist` cannot be represented
// as an installed dist.
match dist {
ResolvedDistRef::InstallableRegistrySourceDist { sdist, prioritized } => {
// This is okay because we're only here if the prioritized dist
// has an sdist, so this always succeeds.
let source = prioritized.source_dist().expect("a source distribution");
assert_eq!(
(&sdist.name, &sdist.version),
(&source.name, &source.version),
"expected chosen sdist to match prioritized sdist"
);
Self::Dist(Dist::Source(SourceDist::Registry(source)))
}
ResolvedDistRef::InstallableRegistryBuiltDist {
wheel, prioritized, ..
} => {
assert_eq!(
Some(&wheel.filename),
prioritized.best_wheel().map(|(wheel, _)| &wheel.filename),
"expected chosen wheel to match best wheel"
);
// This is okay because we're only here if the prioritized dist
// has at least one wheel, so this always succeeds.
let built = prioritized.built_dist().expect("at least one wheel");
Self::Dist(Dist::Built(BuiltDist::Registry(built)))
}
ResolvedDistRef::Installed { dist } => Self::Installed(dist.clone()),
}
}
}
impl Display for Request {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
match self {
Self::Package(package_name, _) => {
write!(f, "Versions {package_name}")
}
Self::Dist(dist) => {
write!(f, "Metadata {dist}")
}
Self::Installed(dist) => {
write!(f, "Installed metadata {dist}")
}
Self::Prefetch(package_name, range, _) => {
write!(f, "Prefetch {package_name} {range}")
}
}
}
}
#[derive(Debug)]
#[expect(clippy::large_enum_variant)]
enum Response {
/// The returned metadata for a package hosted on a registry.
Package(PackageName, Option<IndexUrl>, VersionsResponse),
/// The returned metadata for a distribution.
Dist {
dist: Dist,
metadata: MetadataResponse,
},
/// The returned metadata for an already-installed distribution.
Installed {
dist: InstalledDist,
metadata: MetadataResponse,
},
}
/// Information about the dependencies for a particular package.
///
/// This effectively distills the dependency metadata of a package down into
/// its pubgrub specific constituent parts: each dependency package has a range
/// of possible versions.
enum Dependencies {
/// Package dependencies are not available.
Unavailable(UnavailableVersion),
/// Container for all available package versions.
///
/// Note that in universal mode, it is possible and allowed for multiple
/// `PubGrubPackage` values in this list to have the same package name.
/// These conflicts are resolved via `Dependencies::fork`.
Available(Vec<PubGrubDependency>),
/// Dependencies that should never result in a fork.
///
/// For example, the dependencies of a `Marker` package will have the
/// same name and version, but differ according to marker expressions.
/// But we never want this to result in a fork.
Unforkable(Vec<PubGrubDependency>),
}
impl Dependencies {
/// Turn this flat list of dependencies into a potential set of forked
/// groups of dependencies.
///
/// A fork *only* occurs when there are multiple dependencies with the same
/// name *and* those dependency specifications have corresponding marker
/// expressions that are completely disjoint with one another.
fn fork(
self,
env: &ResolverEnvironment,
python_requirement: &PythonRequirement,
conflicts: &Conflicts,
) -> ForkedDependencies {
let deps = match self {
Self::Available(deps) => deps,
Self::Unforkable(deps) => return ForkedDependencies::Unforked(deps),
Self::Unavailable(err) => return ForkedDependencies::Unavailable(err),
};
let mut name_to_deps: BTreeMap<PackageName, Vec<PubGrubDependency>> = BTreeMap::new();
for dep in deps {
let name = dep
.package
.name()
.expect("dependency always has a name")
.clone();
name_to_deps.entry(name).or_default().push(dep);
}
let Forks {
mut forks,
diverging_packages,
} = Forks::new(name_to_deps, env, python_requirement, conflicts);
if forks.is_empty() {
ForkedDependencies::Unforked(vec![])
} else if forks.len() == 1 {
ForkedDependencies::Unforked(forks.pop().unwrap().dependencies)
} else {
ForkedDependencies::Forked {
forks,
diverging_packages: diverging_packages.into_iter().collect(),
}
}
}
}
/// Information about the (possibly forked) dependencies for a particular
/// package.
///
/// This is like `Dependencies` but with an extra variant that only occurs when
/// a `Dependencies` list has multiple dependency specifications with the same
/// name and non-overlapping marker expressions (i.e., a fork occurs).
#[derive(Debug)]
enum ForkedDependencies {
/// Package dependencies are not available.
Unavailable(UnavailableVersion),
/// No forking occurred.
///
/// This is the same as `Dependencies::Available`.
Unforked(Vec<PubGrubDependency>),
/// Forked containers for all available package versions.
///
/// Note that there is always at least two forks. If there would
/// be fewer than 2 forks, then there is no fork at all and the
/// `Unforked` variant is used instead.
Forked {
forks: Vec<Fork>,
/// The package(s) with different requirements for disjoint markers.
diverging_packages: Vec<PackageName>,
},
}
/// A list of forks determined from the dependencies of a single package.
///
/// Any time a marker expression is seen that is not true for all possible
/// marker environments, it is possible for it to introduce a new fork.
#[derive(Debug, Default)]
struct Forks {
/// The forks discovered among the dependencies.
forks: Vec<Fork>,
/// The package(s) that provoked at least one additional fork.
diverging_packages: BTreeSet<PackageName>,
}
impl Forks {
fn new(
name_to_deps: BTreeMap<PackageName, Vec<PubGrubDependency>>,
env: &ResolverEnvironment,
python_requirement: &PythonRequirement,
conflicts: &Conflicts,
) -> Self {
let python_marker = python_requirement.to_marker_tree();
let mut forks = vec![Fork::new(env.clone())];
let mut diverging_packages = BTreeSet::new();
for (name, mut deps) in name_to_deps {
assert!(!deps.is_empty(), "every name has at least one dependency");
// We never fork if there's only one dependency
// specification for a given package name. This particular
// strategy results in a "conservative" approach to forking
// that gives up correctness in some cases in exchange for
// more limited forking. More limited forking results in
// simpler-and-easier-to-understand lock files and faster
// resolving. The correctness we give up manifests when
// two transitive non-sibling dependencies conflict. In
// that case, we don't detect the fork ahead of time (at
// present).
if let [dep] = deps.as_slice() {
// There's one exception: if the requirement increases the minimum-supported Python
// version, we also fork in order to respect that minimum in the subsequent
// resolution.
//
// For example, given `requires-python = ">=3.7"` and `uv ; python_version >= "3.8"`,
// where uv itself only supports Python 3.8 and later, we need to fork to ensure
// that the resolution can find a solution.
if marker::requires_python(dep.package.marker())
.is_none_or(|bound| !python_requirement.raises(&bound))
{
let dep = deps.pop().unwrap();
let marker = dep.package.marker();
for fork in &mut forks {
if fork.env.included_by_marker(marker) {
fork.add_dependency(dep.clone());
}
}
continue;
}
} else {
// If all dependencies have the same markers, we should also avoid forking.
if let Some(dep) = deps.first() {
let marker = dep.package.marker();
if deps.iter().all(|dep| marker == dep.package.marker()) {
// Unless that "same marker" is a Python requirement that is stricter than
// the current Python requirement. In that case, we need to fork to respect
// the stricter requirement.
if marker::requires_python(marker)
.is_none_or(|bound| !python_requirement.raises(&bound))
{
for dep in deps {
for fork in &mut forks {
if fork.env.included_by_marker(marker) {
fork.add_dependency(dep.clone());
}
}
}
continue;
}
}
}
}
for dep in deps {
let mut forker = match ForkingPossibility::new(env, &dep) {
ForkingPossibility::Possible(forker) => forker,
ForkingPossibility::DependencyAlwaysExcluded => {
// If the markers can never be satisfied by the parent
// fork, then we can drop this dependency unceremoniously.
continue;
}
ForkingPossibility::NoForkingPossible => {
// Or, if the markers are always true, then we just
// add the dependency to every fork unconditionally.
for fork in &mut forks {
fork.add_dependency(dep.clone());
}
continue;
}
};
// Otherwise, we *should* need to add a new fork...
diverging_packages.insert(name.clone());
let mut new = vec![];
for fork in std::mem::take(&mut forks) {
let Some((remaining_forker, envs)) = forker.fork(&fork.env) else {
new.push(fork);
continue;
};
forker = remaining_forker;
for fork_env in envs {
let mut new_fork = fork.clone();
new_fork.set_env(fork_env);
// We only add the dependency to this fork if it
// satisfies the fork's markers. Some forks are
// specifically created to exclude this dependency,
// so this isn't always true!
if forker.included(&new_fork.env) {
new_fork.add_dependency(dep.clone());
}
// Filter out any forks we created that are disjoint with our
// Python requirement.
if new_fork.env.included_by_marker(python_marker) {
new.push(new_fork);
}
}
}
forks = new;
}
}
// When there is a conflicting group configuration, we need
// to potentially add more forks. Each fork added contains an
// exclusion list of conflicting groups where dependencies with
// the corresponding package and extra name are forcefully
// excluded from that group.
//
// We specifically iterate on conflicting groups and
// potentially re-generate all forks for each one. We do it
// this way in case there are multiple sets of conflicting
// groups that impact the forks here.
//
// For example, if we have conflicting groups {x1, x2} and {x3,
// x4}, we need to make sure the forks generated from one set
// also account for the other set.
for set in conflicts.iter() {
let mut new = vec![];
for fork in std::mem::take(&mut forks) {
// Check if this conflict set is relevant to this fork. We need two conditions:
//
// 1. At least one item has dependencies in this fork (otherwise there's nothing to
// fork on).
// 2. At least two items are not already excluded in this fork's environment
// (otherwise the conflict constraint is already satisfied and no fork is
// needed).
let mut has_conflicting_dependency = false;
for item in set.iter() {
if fork.contains_conflicting_item(item.as_ref()) {
has_conflicting_dependency = true;
diverging_packages.insert(item.package().clone());
break;
}
}
if !has_conflicting_dependency {
new.push(fork);
continue;
}
// If fewer than two items in this conflict set are still possible (not already
// excluded) in this fork, the conflict constraint is already satisfied by prior
// forking. We can skip the full N+1 fork split if the single remaining non-excluded
// item doesn't appear in any other conflict set (since it would never need its own
// "excluded" variant).
let non_excluded: Vec<_> = set
.iter()
.filter(|item| fork.env.included_by_group(item.as_ref()))
.collect();
if non_excluded.len() < 2 {
// Check if any non-excluded item still has a live conflict in another set —
// i.e., another set where this item AND at least one other non-excluded item
// both appear. If so, we still need to fork to create the "excluded" variant
// for that item.
let dominated = non_excluded.iter().all(|item| {
!conflicts.iter().any(|other_set| {
!std::ptr::eq(set, other_set)
&& other_set.contains(item.package(), item.kind().as_ref())
&& other_set
.iter()
.filter(|other_item| {
other_item.package() != item.package()
|| other_item.kind() != item.kind()
})
.any(|other_item| {
fork.env.included_by_group(other_item.as_ref())
})
})
});
if dominated {
// When dependencies are added to forks, we check `included_by_marker` but
// not on whether the dependency's conflict item is included by the fork's
// environment so there may be extraneous dependencies and we need to filter
// the fork to clean up dependencies gated on already-excluded extras.
let rules: Vec<_> = set
.iter()
.filter(|item| !fork.env.included_by_group(item.as_ref()))
.cloned()
.map(Err)
.collect();
if let Some(filtered) = fork.filter(rules) {
new.push(filtered);
}
continue;
}
}
// Create a fork that excludes ALL conflicts.
if let Some(fork_none) = fork.clone().filter(set.iter().cloned().map(Err)) {
new.push(fork_none);
}
// Now create a fork for each conflicting group, where
// that fork excludes every *other* conflicting group.
//
// So if we have conflicting extras foo, bar and baz,
// then this creates three forks: one that excludes
// {foo, bar}, one that excludes {foo, baz} and one
// that excludes {bar, baz}.
for (i, _) in set.iter().enumerate() {
let fork_allows_group = fork.clone().filter(
set.iter()
.cloned()
.enumerate()
.map(|(j, group)| if i == j { Ok(group) } else { Err(group) }),
);
if let Some(fork_allows_group) = fork_allows_group {
new.push(fork_allows_group);
}
}
}
forks = new;
}
Self {
forks,
diverging_packages,
}
}
}
/// A single fork in a list of dependencies.
///
/// A fork corresponds to the full list of dependencies for a package,
/// but with any conflicting dependency specifications omitted. For
/// example, if we have `a<2 ; sys_platform == 'foo'` and `a>=2 ;
/// sys_platform == 'bar'`, then because the dependency specifications
/// have the same name and because the marker expressions are disjoint,
/// a fork occurs. One fork will contain `a<2` but not `a>=2`, while
/// the other fork will contain `a>=2` but not `a<2`.
#[derive(Clone, Debug)]
struct Fork {
/// The list of dependencies for this fork, guaranteed to be conflict
/// free. (i.e., There are no two packages with the same name with
/// non-overlapping marker expressions.)
///
/// Note that callers shouldn't mutate this sequence directly. Instead,
/// they should use `add_forked_package` or `add_nonfork_package`. Namely,
/// it should be impossible for a package with a marker expression that is
/// disjoint from the marker expression on this fork to be added.
dependencies: Vec<PubGrubDependency>,
/// The conflicting groups in this fork.
///
/// This exists to make some access patterns more efficient. Namely,
/// it makes it easy to check whether there's a dependency with a
/// particular conflicting group in this fork.
conflicts: crate::FxHashbrownSet<ConflictItem>,
/// The resolver environment for this fork.
///
/// Principally, this corresponds to the markers in this for. So in the
/// example above, the `a<2` fork would have `sys_platform == 'foo'`, while
/// the `a>=2` fork would have `sys_platform == 'bar'`.
///
/// If this fork was generated from another fork, then this *includes*
/// the criteria from its parent. i.e., Its marker expression represents
/// the intersection of the marker expression from its parent and any
/// additional marker expression generated by addition forking based on
/// conflicting dependency specifications.
env: ResolverEnvironment,
}
impl Fork {
/// Create a new fork with no dependencies with the given resolver
/// environment.
fn new(env: ResolverEnvironment) -> Self {
Self {
dependencies: vec![],
conflicts: crate::FxHashbrownSet::default(),
env,
}
}
/// Add a dependency to this fork.
fn add_dependency(&mut self, dep: PubGrubDependency) {
if let Some(conflicting_item) = dep.conflicting_item() {
self.conflicts.insert(conflicting_item.to_owned());
}
self.dependencies.push(dep);
}
/// Sets the resolver environment to the one given.
///
/// Any dependency in this fork that does not satisfy the given environment
/// is removed.
fn set_env(&mut self, env: ResolverEnvironment) {
self.env = env;
self.dependencies.retain(|dep| {
let marker = dep.package.marker();
if self.env.included_by_marker(marker) {
return true;
}
if let Some(conflicting_item) = dep.conflicting_item() {
self.conflicts.remove(&conflicting_item);
}
false
});
}
/// Returns true if any of the dependencies in this fork contain a
/// dependency with the given package and extra values.
fn contains_conflicting_item(&self, item: ConflictItemRef<'_>) -> bool {
self.conflicts.contains(&item)
}
/// Include or Exclude the given groups from this fork.
///
/// This removes all dependencies matching the given conflicting groups.
///
/// If the exclusion rules would result in a fork with an unsatisfiable
/// resolver environment, then this returns `None`.
fn filter(
mut self,
rules: impl IntoIterator<Item = Result<ConflictItem, ConflictItem>>,
) -> Option<Self> {
self.env = self.env.filter_by_group(rules)?;
self.dependencies.retain(|dep| {
let Some(conflicting_item) = dep.conflicting_item() else {
return true;
};
if self.env.included_by_group(conflicting_item) {
return true;
}
match conflicting_item.kind() {
// We should not filter entire projects unless they're a top-level dependency
// Otherwise, we'll fail to solve for children of the project, like extras
ConflictKindRef::Project => {
if dep.parent.is_some() {
return true;
}
}
ConflictKindRef::Group(_) => {}
ConflictKindRef::Extra(_) => {}
}
self.conflicts.remove(&conflicting_item);
false
});
Some(self)
}
/// Compare forks, preferring forks with g `requires-python` requirements.
fn cmp_requires_python(&self, other: &Self) -> Ordering {
// A higher `requires-python` requirement indicates a _higher-priority_ fork.
//
// This ordering ensures that we prefer choosing the highest version for each fork based on
// its `requires-python` requirement.
//
// The reverse would prefer choosing fewer versions, at the cost of using older package
// versions on newer Python versions. For example, if reversed, we'd prefer to solve `<3.7
// before solving `>=3.7`, since the resolution produced by the former might work for the
// latter, but the inverse is unlikely to be true.
let self_bound = self.env.requires_python().unwrap_or_default();
let other_bound = other.env.requires_python().unwrap_or_default();
self_bound.lower().cmp(other_bound.lower())
}
/// Compare forks, preferring forks with upper bounds.
fn cmp_upper_bounds(&self, other: &Self) -> Ordering {
// We'd prefer to solve `numpy <= 2` before solving `numpy >= 1`, since the resolution
// produced by the former might work for the latter, but the inverse is unlikely to be true
// due to maximum version selection. (Selecting `numpy==2.0.0` would satisfy both forks, but
// selecting the latest `numpy` would not.)
let self_upper_bounds = self
.dependencies
.iter()
.filter(|dep| {
dep.version
.bounding_range()
.is_some_and(|(_, upper)| !matches!(upper, Bound::Unbounded))
})
.count();
let other_upper_bounds = other
.dependencies
.iter()
.filter(|dep| {
dep.version
.bounding_range()
.is_some_and(|(_, upper)| !matches!(upper, Bound::Unbounded))
})
.count();
self_upper_bounds.cmp(&other_upper_bounds)
}
}
impl Eq for Fork {}
impl PartialEq for Fork {
fn eq(&self, other: &Self) -> bool {
self.dependencies == other.dependencies && self.env == other.env
}
}
#[derive(Debug, Clone)]
pub(crate) struct VersionFork {
/// The environment to use in the fork.
env: ResolverEnvironment,
/// The initial package to select in the fork.
id: Id<PubGrubPackage>,
/// The initial version to set for the selected package in the fork.
version: Option<Version>,
}
/// Enrich a [`ResolveError`] with additional information about why a given package was included.
fn enrich_dependency_error(
error: ResolveError,
id: Id<PubGrubPackage>,
version: &Version,
pubgrub: &State<UvDependencyProvider>,
) -> ResolveError {
let Some(name) = pubgrub.package_store[id].name_no_root() else {
return error;
};
let chain = DerivationChainBuilder::from_state(id, version, pubgrub).unwrap_or_default();
ResolveError::Dependencies(Box::new(error), name.clone(), version.clone(), chain)
}
/// Compute the set of markers for which a package is known to be relevant.
fn find_environments(id: Id<PubGrubPackage>, state: &State<UvDependencyProvider>) -> MarkerTree {
let package = &state.package_store[id];
if package.is_root() {
return MarkerTree::TRUE;
}
// First, collect the reverse-dependency closure for the package. We limit the propagation
// below to this subgraph so cycles in unrelated packages don't matter here.
let mut ancestors = FxHashSet::default();
let mut stack = vec![id];
let mut root = None;
ancestors.insert(id);
while let Some(current) = stack.pop() {
let Some(incompatibilities) = state.incompatibilities.get(¤t) else {
continue;
};
for index in incompatibilities {
let incompat = &state.incompatibility_store[*index];
if let Kind::FromDependencyOf(parent, _, child, _) = &incompat.kind {
if current != *child {
continue;
}
if ancestors.insert(*parent) {
if state.package_store[*parent].is_root() {
root = Some(*parent);
}
stack.push(*parent);
}
}
}
}
let Some(root) = root else {
return MarkerTree::FALSE;
};
// Propagate markers forward from the root through the collected subgraph. This reaches a
// fixpoint even in the presence of cycles, unlike the recursive reverse walk above.
let mut environments = FxHashMap::default();
let mut queue = VecDeque::from([root]);
environments.insert(root, MarkerTree::TRUE);
while let Some(current) = queue.pop_front() {
let Some(current_environment) = environments.get(¤t).copied() else {
continue;
};
let Some(incompatibilities) = state.incompatibilities.get(¤t) else {
continue;
};
for index in incompatibilities {
let incompat = &state.incompatibility_store[*index];
let Kind::FromDependencyOf(parent, _, child, _) = &incompat.kind else {
continue;
};
if current != *parent || !ancestors.contains(child) {
continue;
}
let mut next_environment = state.package_store[*child].marker();
next_environment.and(current_environment);
let entry = environments.entry(*child).or_insert(MarkerTree::FALSE);
let mut combined = *entry;
combined.or(next_environment);
if combined != *entry {
*entry = combined;
queue.push_back(*child);
}
}
}
environments.remove(&id).unwrap_or(MarkerTree::FALSE)
}
#[derive(Debug, Default, Clone)]
struct ConflictTracker {
/// How often a decision on the package was discarded due to another package decided earlier.
affected: FxHashMap<Id<PubGrubPackage>, usize>,
/// Package(s) to be prioritized after the next unit propagation
///
/// Distilled from `affected` for fast checking in the hot loop.
prioritize: Vec<Id<PubGrubPackage>>,
/// How often a package was decided earlier and caused another package to be discarded.
culprit: FxHashMap<Id<PubGrubPackage>, usize>,
/// Package(s) to be de-prioritized after the next unit propagation
///
/// Distilled from `culprit` for fast checking in the hot loop.
deprioritize: Vec<Id<PubGrubPackage>>,
}