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 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185
|
"""Tests for JSON Schema input file code generation."""
from __future__ import annotations
import json
import os
import tempfile
from collections import defaultdict
from pathlib import Path
from typing import TYPE_CHECKING
from unittest.mock import call
import black
import pytest
from packaging import version
from datamodel_code_generator import (
MIN_VERSION,
DataModelType,
InputFileType,
PythonVersion,
PythonVersionMin,
TargetPydanticVersion,
chdir,
generate,
)
from datamodel_code_generator.__main__ import Exit, main
from datamodel_code_generator.format import is_supported_in_black
from datamodel_code_generator.model import base as model_base
from tests.conftest import assert_directory_content, freeze_time, validate_generated_code
from tests.main.conftest import (
ALIASES_DATA_PATH,
BLACK_PY313_SKIP,
DATA_PATH,
DEFAULT_VALUES_DATA_PATH,
EXPECTED_MAIN_PATH,
JSON_SCHEMA_DATA_PATH,
LEGACY_BLACK_SKIP,
MSGSPEC_LEGACY_BLACK_SKIP,
TIMESTAMP,
run_generate_file_and_assert,
run_main_and_assert,
run_main_url_and_assert,
run_main_with_args,
)
from tests.main.jsonschema.conftest import EXPECTED_JSON_SCHEMA_PATH, assert_file_content
if TYPE_CHECKING:
from pytest_mock import MockerFixture
FixtureRequest = pytest.FixtureRequest
def _install_test_my_app(base_dir: Path, monkeypatch: pytest.MonkeyPatch) -> None:
package_dir = base_dir / "my_app"
package_dir.mkdir()
(package_dir / "__init__.py").write_text(
"""from typing import Literal
from pydantic import BaseModel
class AliasA(BaseModel):
type: Literal["a"] = "a"
class B(BaseModel):
type: Literal["b"] = "b"
""",
encoding="utf-8",
)
monkeypatch.syspath_prepend(str(base_dir))
@pytest.mark.benchmark
def test_main_inheritance_forward_ref(output_file: Path, tmp_path: Path) -> None:
"""Test inheritance with forward references."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "inheritance_forward_ref.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
copy_files=[(DATA_PATH / "pyproject.toml", tmp_path / "pyproject.toml")],
)
@pytest.mark.benchmark
@pytest.mark.cli_doc(
options=["--keep-model-order"],
option_description="""Keep model definition order as specified in schema.
The `--keep-model-order` flag preserves the original definition order from the schema
instead of reordering models based on dependencies. This is useful when the order
of model definitions matters for documentation or readability.""",
input_schema="jsonschema/inheritance_forward_ref.json",
cli_args=["--keep-model-order"],
golden_output="jsonschema/inheritance_forward_ref_keep_model_order.py",
related_options=["--collapse-root-models"],
)
def test_main_inheritance_forward_ref_keep_model_order(output_file: Path, tmp_path: Path) -> None:
"""Keep model definition order as specified in schema.
The `--keep-model-order` flag preserves the original definition order from the schema
instead of reordering models based on dependencies. This is useful when the order
of model definitions matters for documentation or readability.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "inheritance_forward_ref.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--keep-model-order"],
copy_files=[(DATA_PATH / "pyproject.toml", tmp_path / "pyproject.toml")],
)
@pytest.mark.benchmark
def test_main_type_alias_forward_ref_keep_model_order(output_file: Path) -> None:
"""Test TypeAliasType with forward references keeping model order."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_forward_ref.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=[
"--keep-model-order",
"--output-model-type",
"typing.TypedDict",
"--use-standard-collections",
"--use-union-operator",
"--use-type-alias",
"--target-python-version",
"3.10",
],
)
@pytest.mark.benchmark
def test_main_type_alias_cycle_keep_model_order(output_file: Path) -> None:
"""Test TypeAlias cycle ordering with keep_model_order."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_cycle.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=[
"--keep-model-order",
"--output-model-type",
"typing.TypedDict",
"--use-standard-collections",
"--use-union-operator",
"--use-type-alias",
"--target-python-version",
"3.10",
],
)
@pytest.mark.cli_doc(
options=["--disable-future-imports"],
option_description="""Prevent automatic addition of __future__ imports in generated code.
The --disable-future-imports option stops the generator from adding
'from __future__ import annotations' to the output. This is useful when
you need compatibility with tools or environments that don't support
postponed evaluation of annotations (PEP 563).""",
input_schema="jsonschema/keep_model_order_field_references.json",
cli_args=["--disable-future-imports", "--target-python-version", "3.10"],
golden_output="main/jsonschema/keep_model_order_field_references.py",
)
@pytest.mark.benchmark
def test_main_keep_model_order_field_references(output_file: Path) -> None:
"""Prevent automatic addition of __future__ imports in generated code.
The --disable-future-imports option stops the generator from adding
'from __future__ import annotations' to the output. This is useful when
you need compatibility with tools or environments that don't support
postponed evaluation of annotations (PEP 563).
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "keep_model_order_field_references.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=[
"--keep-model-order",
"--disable-future-imports",
"--target-python-version",
"3.10",
],
)
@pytest.mark.parametrize(
("target_python_version", "keep_model_order", "disable_future_imports"),
[
("3.10", False, False),
("3.10", False, True),
("3.10", True, False),
("3.10", True, True),
("3.11", True, False),
("3.11", True, True),
("3.12", True, False),
("3.12", True, True),
("3.13", True, False),
("3.13", True, True),
("3.14", True, False),
("3.14", True, True),
],
)
def test_main_keep_model_order_matrix_keep_model_order_field_references(
output_file: Path,
target_python_version: str,
keep_model_order: bool,
disable_future_imports: bool,
) -> None:
"""E2E matrix for keep_model_order vs deferred annotations.
When deferred annotations are enabled (default), field references should not
force reordering (to avoid meaningless churn). When disabled, ordering must
satisfy runtime dependency requirements.
"""
target_version = PythonVersion(target_python_version)
if not is_supported_in_black(target_version):
pytest.skip(f"Installed black ({black.__version__}) doesn't support Python {target_python_version}")
args = [
"--input",
str(JSON_SCHEMA_DATA_PATH / "keep_model_order_field_references.json"),
"--output",
str(output_file),
"--input-file-type",
"jsonschema",
"--target-python-version",
target_python_version,
"--formatters",
"isort",
]
if keep_model_order:
args.append("--keep-model-order")
if disable_future_imports:
args.append("--disable-future-imports")
run_main_with_args(args)
code = output_file.read_text(encoding="utf-8")
compile(code, str(output_file), "exec")
if not keep_model_order:
return
metadata_index = code.index("class Metadata")
description_type_index = code.index("class DescriptionType")
use_deferred_annotations_for_target = target_version.has_native_deferred_annotations or not disable_future_imports
if use_deferred_annotations_for_target:
assert description_type_index < metadata_index
else:
assert metadata_index < description_type_index
# For targets without native deferred annotations, validate runtime safety
# under the current interpreter by executing the generated module.
if not target_version.has_native_deferred_annotations:
exec(compile(code, str(output_file), "exec"), {})
@pytest.mark.cli_doc(
options=["--target-python-version"],
option_description="""Target Python version for generated code syntax and imports.
The `--target-python-version` flag configures the code generation behavior.""",
input_schema="jsonschema/pydantic_v2_model_rebuild_inheritance.json",
cli_args=["--output-model-type", "pydantic_v2.BaseModel", "--keep-model-order", "--target-python-version", "3.10"],
golden_output="jsonschema/pydantic_v2_model_rebuild_inheritance.py",
)
@pytest.mark.benchmark
def test_main_pydantic_v2_model_rebuild_inheritance(output_file: Path) -> None:
"""Target Python version for generated code syntax and imports.
The `--target-python-version` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pydantic_v2_model_rebuild_inheritance.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--keep-model-order",
"--target-python-version",
"3.10",
],
)
@pytest.mark.benchmark
def test_main_autodetect(output_file: Path) -> None:
"""Test automatic input file type detection."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "person.json",
output_path=output_file,
input_file_type="auto",
assert_func=assert_file_content,
)
def test_main_autodetect_failed(tmp_path: Path) -> None:
"""Test autodetect failure with invalid input."""
input_file: Path = tmp_path / "input.yaml"
output_file: Path = tmp_path / "output.py"
input_file.write_text(":", encoding="utf-8")
run_main_and_assert(
input_path=input_file,
output_path=output_file,
input_file_type="auto",
expected_exit=Exit.ERROR,
)
def test_main_jsonschema(output_file: Path) -> None:
"""Test JSON Schema file code generation."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "person.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="general.py",
)
@pytest.mark.cli_doc(
options=["--keyword-only"],
option_description="""Generate dataclass fields as keyword-only arguments.
The `--keyword-only` flag generates all dataclass fields as keyword-only,
requiring explicit parameter names when instantiating models. Combined with
`--frozen-dataclasses`, creates immutable models with keyword-only constructors.""",
input_schema="jsonschema/person.json",
cli_args=["--output-model-type", "dataclasses.dataclass", "--frozen-dataclasses", "--keyword-only"],
golden_output="main/jsonschema/general_dataclass_frozen_kw_only.py",
related_options=["--frozen-dataclasses", "--output-model-type"],
)
def test_main_jsonschema_dataclass_frozen_keyword_only(output_file: Path) -> None:
"""Generate dataclass fields as keyword-only arguments.
The `--keyword-only` flag generates all dataclass fields as keyword-only,
requiring explicit parameter names when instantiating models. Combined with
`--frozen-dataclasses`, creates immutable models with keyword-only constructors.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "person.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="general_dataclass_frozen_kw_only.py",
extra_args=[
"--output-model-type",
"dataclasses.dataclass",
"--frozen-dataclasses",
"--keyword-only",
"--target-python-version",
"3.10",
],
)
@pytest.mark.benchmark
def test_main_jsonschema_nested_deep(tmp_path: Path) -> None:
"""Test deeply nested JSON Schema generation."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nested_person.json",
output_path=tmp_path,
output_to_expected=[
("__init__.py", EXPECTED_JSON_SCHEMA_PATH / "nested_deep" / "__init__.py"),
("nested/deep.py", EXPECTED_JSON_SCHEMA_PATH / "nested_deep" / "nested" / "deep.py"),
(
"empty_parent/nested/deep.py",
EXPECTED_JSON_SCHEMA_PATH / "nested_deep" / "empty_parent" / "nested" / "deep.py",
),
],
assert_func=assert_file_content,
input_file_type="jsonschema",
)
def test_main_jsonschema_nested_skip(output_dir: Path) -> None:
"""Test nested JSON Schema with skipped items."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nested_skip.json",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "nested_skip",
input_file_type="jsonschema",
)
@pytest.mark.benchmark
def test_main_jsonschema_external_files(output_file: Path) -> None:
"""Test JSON Schema with external file references."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "external_parent_root.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="external_files.py",
)
@pytest.mark.benchmark
def test_main_jsonschema_collapsed_external_references(tmp_path: Path) -> None:
"""Test collapsed external references in JSON Schema."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "external_reference",
output_path=tmp_path,
output_to_expected=[
("ref0.py", "external_ref0.py"),
("other/ref2.py", EXPECTED_JSON_SCHEMA_PATH / "external_other_ref2.py"),
],
assert_func=assert_file_content,
input_file_type="jsonschema",
extra_args=["--collapse-root-models"],
)
@pytest.mark.benchmark
def test_main_jsonschema_multiple_files(output_dir: Path) -> None:
"""Test JSON Schema generation from multiple files."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "multiple_files",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "multiple_files",
input_file_type="jsonschema",
)
@pytest.mark.benchmark
def test_main_jsonschema_no_empty_collapsed_external_model(tmp_path: Path) -> None:
"""Test no empty files with collapsed external models."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "external_collapse",
output_path=tmp_path,
file_should_not_exist=tmp_path / "child.py",
input_file_type="jsonschema",
extra_args=["--collapse-root-models"],
)
assert (tmp_path / "__init__.py").exists()
@pytest.mark.cli_doc(
options=["--output-model-type"],
option_description="""Select the output model type (Pydantic v2, Pydantic v2 dataclass,
dataclasses, TypedDict, msgspec).
The `--output-model-type` flag specifies which Python data model framework to use
for the generated code. Supported values include `pydantic_v2.BaseModel`,
`pydantic_v2.dataclass`, `dataclasses.dataclass`, `typing.TypedDict`, and `msgspec.Struct`.""",
input_schema="jsonschema/null_and_array.json",
cli_args=["--output-model-type", "pydantic_v2.BaseModel"],
model_outputs={
"pydantic_v2": "main/jsonschema/null_and_array_v2.py",
},
primary=True,
)
def test_main_null_and_array(output_file: Path) -> None:
"""Select the output model type.
The `--output-model-type` flag specifies which Python data model framework to use
for the generated code. Supported values include `pydantic_v2.BaseModel`,
`pydantic_v2.dataclass`, `dataclasses.dataclass`, `typing.TypedDict`, and `msgspec.Struct`.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "null_and_array.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="null_and_array_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
@pytest.mark.cli_doc(
options=["--use-default"],
option_description="""Use default values from schema in generated models.
The `--use-default` flag allows required fields with default values to be generated
with their defaults, making them optional to provide when instantiating the model.
!!! warning "Fields with defaults become nullable"
When using `--use-default`, fields with default values are generated as nullable
types (e.g., `str | None` instead of `str`), even if the schema does not allow
null values.
If you want fields to strictly follow the schema's type definition (non-nullable),
use `--strict-nullable` together with `--use-default`.
!!! note "Future behavior change"
In a future major version, the default behavior of `--use-default` may change to
generate non-nullable types that match the schema definition (equivalent to using
`--strict-nullable`). If you rely on the current nullable behavior, consider
explicitly handling this in your code.""",
input_schema="jsonschema/use_default_with_const.json",
cli_args=["--output-model-type", "pydantic_v2.BaseModel", "--use-default"],
golden_output="jsonschema/use_default_with_const.py",
related_options=["--strict-nullable"],
)
def test_use_default_pydantic_v2_with_json_schema_const(output_file: Path) -> None:
"""Use default values from schema in generated models.
The `--use-default` flag allows required fields with default values to be generated
with their defaults, making them optional to provide when instantiating the model.
!!! warning "Fields with defaults become nullable"
When using `--use-default`, fields with default values are generated as nullable
types (e.g., `str | None` instead of `str`), even if the schema does not allow
null values.
If you want fields to strictly follow the schema's type definition (non-nullable),
use `--strict-nullable` together with `--use-default`.
!!! note "Future behavior change"
In a future major version, the default behavior of `--use-default` may change to
generate non-nullable types that match the schema definition (equivalent to using
`--strict-nullable`). If you rely on the current nullable behavior, consider
explicitly handling this in your code.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_default_with_const.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="use_default_with_const.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--use-default"],
)
@pytest.mark.parametrize(
("output_model", "expected_output", "option"),
[
(
"dataclasses.dataclass",
"complicated_enum_default_member_dataclass.py",
"--set-default-enum-member",
),
(
"dataclasses.dataclass",
"complicated_enum_default_member_dataclass.py",
None,
),
],
)
def test_main_complicated_enum_default_member(
output_model: str, expected_output: str, option: str | None, output_file: Path
) -> None:
"""Test complicated enum with default member."""
extra_args = [a for a in [option, "--output-model-type", output_model] if a]
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "complicated_enum.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=extra_args,
)
@pytest.mark.cli_doc(
options=["--set-default-enum-member"],
option_description="""Set the first enum member as the default value for enum fields.
The `--set-default-enum-member` flag configures the code generation behavior.""",
input_schema="jsonschema/duplicate_enum.json",
cli_args=["--reuse-model", "--set-default-enum-member"],
golden_output="jsonschema/json_reuse_enum_default_member.py",
)
@pytest.mark.benchmark
def test_main_json_reuse_enum_default_member(output_file: Path) -> None:
"""Set the first enum member as the default value for enum fields.
The `--set-default-enum-member` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "duplicate_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--reuse-model", "--set-default-enum-member"],
)
def test_main_invalid_model_name_failed(capsys: pytest.CaptureFixture[str], output_file: Path) -> None:
"""Test invalid model name error handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "invalid_model_name.json",
output_path=output_file,
input_file_type="jsonschema",
extra_args=["--class-name", "with"],
expected_exit=Exit.ERROR,
capsys=capsys,
expected_stderr_contains="title='with' is invalid class name. You have to set `--class-name` option",
)
def test_main_invalid_model_name_converted(capsys: pytest.CaptureFixture[str], output_file: Path) -> None:
"""Test invalid model name conversion error."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "invalid_model_name.json",
output_path=output_file,
input_file_type="jsonschema",
expected_exit=Exit.ERROR,
capsys=capsys,
expected_stderr_contains="title='1Xyz' is invalid class name. You have to set `--class-name` option",
)
@pytest.mark.cli_doc(
options=["--class-name"],
option_description="""Override the auto-generated class name with a custom name.
The --class-name option allows you to specify a custom class name for the
generated model. This is useful when the schema title is invalid as a Python
class name (e.g., starts with a number) or when you want to use a different
naming convention than what's in the schema.""",
input_schema="jsonschema/invalid_model_name.json",
cli_args=["--class-name", "ValidModelName"],
golden_output="main/jsonschema/invalid_model_name.py",
)
def test_main_invalid_model_name(output_file: Path) -> None:
"""Override the auto-generated class name with a custom name.
The --class-name option allows you to specify a custom class name for the
generated model. This is useful when the schema title is invalid as a Python
class name (e.g., starts with a number) or when you want to use a different
naming convention than what's in the schema.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "invalid_model_name.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--class-name", "ValidModelName"],
)
@pytest.mark.cli_doc(
options=["--class-name-prefix"],
option_description="""Add a prefix to all generated class names.
The --class-name-prefix option allows you to add a prefix to all generated class
names, including both models and enums. This is useful for namespacing generated
code or avoiding conflicts with existing classes.""",
input_schema="jsonschema/class_name_affix.json",
cli_args=["--class-name-prefix", "Api"],
golden_output="main/jsonschema/class_name_prefix/output.py",
related_options=["--class-name-suffix", "--class-name-affix-scope"],
)
@freeze_time("2019-07-26")
def test_main_class_name_prefix(output_file: Path) -> None:
"""Add a prefix to all generated class names.
The --class-name-prefix option allows you to add a prefix to all generated class
names, including both models and enums. This is useful for namespacing generated
code or avoiding conflicts with existing classes.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "class_name_affix.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="class_name_prefix/output.py",
extra_args=["--class-name-prefix", "Api"],
)
@pytest.mark.cli_doc(
options=["--class-name-suffix"],
option_description="""Add a suffix to all generated class names.
The --class-name-suffix option allows you to add a suffix to all generated class
names, including both models and enums. This is useful for distinguishing generated
classes (e.g., adding 'Schema' or 'Model' suffix).""",
input_schema="jsonschema/class_name_affix.json",
cli_args=["--class-name-suffix", "Schema"],
golden_output="main/jsonschema/class_name_suffix/output.py",
related_options=["--class-name-prefix", "--class-name-affix-scope"],
)
@freeze_time("2019-07-26")
def test_main_class_name_suffix(output_file: Path) -> None:
"""Add a suffix to all generated class names.
The --class-name-suffix option allows you to add a suffix to all generated class
names, including both models and enums. This is useful for distinguishing generated
classes (e.g., adding 'Schema' or 'Model' suffix).
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "class_name_affix.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="class_name_suffix/output.py",
extra_args=["--class-name-suffix", "Schema"],
)
@pytest.mark.cli_doc(
options=["--class-name-affix-scope"],
option_description="""Control which classes receive the prefix/suffix.
The --class-name-affix-scope option controls which types of classes receive the
prefix or suffix specified by --class-name-prefix or --class-name-suffix:
- 'all': Apply to all classes (models and enums) - this is the default
- 'models': Apply only to model classes (BaseModel, dataclass, TypedDict, etc.)
- 'enums': Apply only to enum classes""",
input_schema="jsonschema/class_name_affix.json",
cli_args=["--class-name-suffix", "Schema", "--class-name-affix-scope", "models"],
golden_output="main/jsonschema/class_name_affix_scope_models/output.py",
related_options=["--class-name-prefix", "--class-name-suffix"],
)
@freeze_time("2019-07-26")
def test_main_class_name_affix_scope_models(output_file: Path) -> None:
"""Control which classes receive the prefix/suffix.
The --class-name-affix-scope option controls which types of classes receive the
prefix or suffix specified by --class-name-prefix or --class-name-suffix:
- 'all': Apply to all classes (models and enums) - this is the default
- 'models': Apply only to model classes (BaseModel, dataclass, TypedDict, etc.)
- 'enums': Apply only to enum classes
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "class_name_affix.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="class_name_affix_scope_models/output.py",
extra_args=["--class-name-suffix", "Schema", "--class-name-affix-scope", "models"],
)
@freeze_time("2019-07-26")
def test_main_class_name_suffix_with_class_name(output_file: Path) -> None:
"""Test that --class-name-suffix does not apply to root when --class-name is specified.
When --class-name is explicitly set, the suffix should not be applied to the root model
because the user has explicitly chosen the root model name.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "class_name_affix.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="class_name_suffix_with_class_name/output.py",
extra_args=["--class-name-suffix", "Schema", "--class-name", "MyRootModel"],
)
def test_main_class_name_prefix_invalid(output_file: Path) -> None:
"""Test that invalid --class-name-prefix is rejected."""
return_code: Exit = main([
"--input",
str(JSON_SCHEMA_DATA_PATH / "class_name_affix.json"),
"--output",
str(output_file),
"--class-name-prefix",
"123Invalid",
])
assert return_code == Exit.ERROR
def test_main_class_name_suffix_invalid(output_file: Path) -> None:
"""Test that invalid --class-name-suffix is rejected."""
return_code: Exit = main([
"--input",
str(JSON_SCHEMA_DATA_PATH / "class_name_affix.json"),
"--output",
str(output_file),
"--class-name-suffix",
"Schema!",
])
assert return_code == Exit.ERROR
def test_main_jsonschema_reserved_field_names(output_file: Path) -> None:
"""Test reserved names are safely suffixed and aliased."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reserved_property.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="reserved_property.py",
)
def test_main_jsonschema_with_local_anchor(output_file: Path) -> None:
"""Test $id anchor lookup resolves without error and reuses definitions."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "with_anchor.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="with_anchor.py",
)
def test_main_jsonschema_missing_anchor_reports_error(capsys: pytest.CaptureFixture[str], output_file: Path) -> None:
"""Test missing $id anchor produces a clear error instead of KeyError trace."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "missing_anchor.json",
output_path=output_file,
input_file_type="jsonschema",
expected_exit=Exit.ERROR,
capsys=capsys,
expected_stderr_contains="Unresolved $id reference '#address'",
)
def test_main_root_id_jsonschema_with_local_file(mocker: MockerFixture, output_file: Path) -> None:
"""Test root ID JSON Schema with local file reference."""
root_id_response = mocker.Mock()
root_id_response.text = "dummy"
person_response = mocker.Mock()
person_response.text = (JSON_SCHEMA_DATA_PATH / "person.json").read_text()
httpx_get_mock = mocker.patch("httpx.get", side_effect=[person_response])
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_id.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_id.py",
)
httpx_get_mock.assert_not_called()
def test_main_root_id_jsonschema_with_remote_file(mocker: MockerFixture, tmp_path: Path) -> None:
"""Test root ID JSON Schema with remote file reference."""
root_id_response = mocker.Mock()
root_id_response.text = "dummy"
person_response = mocker.Mock()
person_response.text = (JSON_SCHEMA_DATA_PATH / "person.json").read_text()
httpx_get_mock = mocker.patch("httpx.get", side_effect=[person_response])
input_file = tmp_path / "root_id.json"
output_file: Path = tmp_path / "output.py"
run_main_and_assert(
input_path=input_file,
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_id.py",
copy_files=[(JSON_SCHEMA_DATA_PATH / "root_id.json", input_file)],
)
httpx_get_mock.assert_has_calls([
call(
"https://example.com/person.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
])
@pytest.mark.benchmark
def test_main_root_id_jsonschema_self_refs_with_local_file(mocker: MockerFixture, output_file: Path) -> None:
"""Test root ID JSON Schema self-references with local file."""
person_response = mocker.Mock()
person_response.text = (JSON_SCHEMA_DATA_PATH / "person.json").read_text()
httpx_get_mock = mocker.patch("httpx.get", side_effect=[person_response])
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_id_self_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_id.py",
transform=lambda s: s.replace("filename: root_id_self_ref.json", "filename: root_id.json"),
)
httpx_get_mock.assert_not_called()
@pytest.mark.benchmark
def test_main_root_id_jsonschema_self_refs_with_remote_file(mocker: MockerFixture, tmp_path: Path) -> None:
"""Test root ID JSON Schema self-references with remote file."""
person_response = mocker.Mock()
person_response.text = (JSON_SCHEMA_DATA_PATH / "person.json").read_text()
httpx_get_mock = mocker.patch("httpx.get", side_effect=[person_response])
input_file = tmp_path / "root_id_self_ref.json"
output_file: Path = tmp_path / "output.py"
run_main_and_assert(
input_path=input_file,
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_id.py",
transform=lambda s: s.replace("filename: root_id_self_ref.json", "filename: root_id.json"),
copy_files=[(JSON_SCHEMA_DATA_PATH / "root_id_self_ref.json", input_file)],
)
httpx_get_mock.assert_has_calls([
call(
"https://example.com/person.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
])
def test_main_root_id_jsonschema_with_absolute_remote_file(mocker: MockerFixture, tmp_path: Path) -> None:
"""Test root ID JSON Schema with absolute remote file URL."""
root_id_response = mocker.Mock()
root_id_response.text = "dummy"
person_response = mocker.Mock()
person_response.text = (JSON_SCHEMA_DATA_PATH / "person.json").read_text()
httpx_get_mock = mocker.patch("httpx.get", side_effect=[person_response])
input_file = tmp_path / "root_id_absolute_url.json"
output_file: Path = tmp_path / "output.py"
run_main_and_assert(
input_path=input_file,
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_id_absolute_url.py",
copy_files=[(JSON_SCHEMA_DATA_PATH / "root_id_absolute_url.json", input_file)],
)
httpx_get_mock.assert_has_calls([
call(
"https://example.com/person.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
])
def test_main_root_id_jsonschema_with_absolute_local_file(output_file: Path) -> None:
"""Test root ID JSON Schema with absolute local file path."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_id_absolute_url.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_id_absolute_url.py",
)
@pytest.mark.benchmark
def test_main_jsonschema_id(output_file: Path) -> None:
"""Test JSON Schema with ID field."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "id.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="id.py",
)
def test_main_jsonschema_id_as_stdin(monkeypatch: pytest.MonkeyPatch, output_file: Path) -> None:
"""Test JSON Schema ID handling from stdin."""
run_main_and_assert(
stdin_path=JSON_SCHEMA_DATA_PATH / "id.json",
output_path=output_file,
monkeypatch=monkeypatch,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="id_stdin.py",
)
def test_main_jsonschema_stdin_oneof_ref(monkeypatch: pytest.MonkeyPatch, output_file: Path) -> None:
"""Test JSON Schema with oneOf $ref from stdin."""
run_main_and_assert(
stdin_path=JSON_SCHEMA_DATA_PATH / "stdin_oneof_ref.json",
output_path=output_file,
monkeypatch=monkeypatch,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="stdin_oneof_ref.py",
)
def test_main_jsonschema_ids(output_dir: Path) -> None:
"""Test JSON Schema with multiple IDs."""
with freeze_time(TIMESTAMP):
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ids" / "Organization.schema.json",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "ids",
input_file_type="jsonschema",
)
@pytest.mark.benchmark
def test_main_external_definitions(output_file: Path) -> None:
"""Test external definitions in JSON Schema."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "external_definitions_root.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
def test_main_external_files_in_directory(output_file: Path) -> None:
"""Test external files in directory structure."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "external_files_in_directory" / "person.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
def test_main_nested_directory(output_dir: Path) -> None:
"""Test nested directory structure generation."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "external_files_in_directory",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "nested_directory",
input_file_type="jsonschema",
)
def test_main_circular_reference(output_file: Path) -> None:
"""Test circular reference handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "circular_reference.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
def test_main_invalid_enum_name(output_file: Path) -> None:
"""Test invalid enum name handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "invalid_enum_name.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.cli_doc(
options=["--snake-case-field"],
option_description="""Convert field names to snake_case format.
The `--snake-case-field` flag converts camelCase or PascalCase field names
to snake_case format in the generated Python code, following Python naming
conventions (PEP 8).""",
input_schema="jsonschema/invalid_enum_name.json",
cli_args=["--snake-case-field"],
golden_output="jsonschema/invalid_enum_name_snake_case_field.py",
related_options=["--capitalize-enum-members"],
)
def test_main_invalid_enum_name_snake_case_field(output_file: Path) -> None:
"""Convert field names to snake_case format.
The `--snake-case-field` flag converts camelCase or PascalCase field names
to snake_case format in the generated Python code, following Python naming
conventions (PEP 8).
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "invalid_enum_name.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--snake-case-field"],
)
@pytest.mark.cli_doc(
options=["--reuse-model"],
option_description="""Reuse identical model definitions instead of generating duplicates.
The `--reuse-model` flag detects identical enum or model definitions
across the schema and generates a single shared definition, reducing
code duplication in the output.""",
input_schema="jsonschema/duplicate_enum.json",
cli_args=["--reuse-model"],
golden_output="jsonschema/json_reuse_enum.py",
related_options=["--collapse-root-models"],
)
def test_main_json_reuse_enum(output_file: Path) -> None:
"""Reuse identical model definitions instead of generating duplicates.
The `--reuse-model` flag detects identical enum or model definitions
across the schema and generates a single shared definition, reducing
code duplication in the output.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "duplicate_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--reuse-model"],
)
def test_main_reuse_model_collapse_inline_definitions(output_file: Path) -> None:
"""Test --reuse-model --collapse-reuse-models deduplicates identical inline definitions."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_model_inline_definitions.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--reuse-model",
"--collapse-reuse-models",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_reuse_model_collapse_with_root(output_file: Path) -> None:
"""Test --reuse-model --collapse-reuse-models skips RootModel deduplication."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_model_collapse_with_root.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--reuse-model",
"--collapse-reuse-models",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_reuse_model_collapse_nested(output_file: Path) -> None:
"""Test --reuse-model --collapse-reuse-models with deeply nested identical structures."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_model_collapse_nested.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--reuse-model",
"--collapse-reuse-models",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.cli_doc(
options=["--capitalize-enum-members"],
option_description="""Capitalize enum member names to UPPER_CASE format.
The `--capitalize-enum-members` flag converts enum member names to
UPPER_CASE format (e.g., `active` becomes `ACTIVE`), following Python
naming conventions for constants.""",
input_schema="jsonschema/many_case_enum.json",
cli_args=["--capitalize-enum-members"],
golden_output="jsonschema/json_capitalise_enum_members.py",
related_options=["--snake-case-field"],
aliases=["--capitalise-enum-members"],
)
def test_main_json_capitalise_enum_members(output_file: Path) -> None:
"""Capitalize enum member names to UPPER_CASE format.
The `--capitalize-enum-members` flag converts enum member names to
UPPER_CASE format (e.g., `active` becomes `ACTIVE`), following Python
naming conventions for constants.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "many_case_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--capitalise-enum-members"],
)
def test_main_json_capitalise_enum_members_without_enum(output_file: Path) -> None:
"""Test enum member capitalization without enum flag."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "person.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="autodetect.py",
)
def test_main_similar_nested_array(output_file: Path) -> None:
"""Test similar nested array structures."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "similar_nested_array.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
def test_main_require_referenced_field(tmp_path: Path) -> None:
"""Test required referenced fields."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "require_referenced_field/",
output_path=tmp_path,
output_to_expected=[
("referenced.py", "require_referenced_field_pydantic_v2/referenced.py"),
("required.py", "require_referenced_field_pydantic_v2/required.py"),
],
assert_func=assert_file_content,
input_file_type="jsonschema",
extra_args=["--output-datetime-class", "AwareDatetime", "--output-model-type", "pydantic_v2.BaseModel"],
)
def test_main_require_referenced_field_naive_datetime(tmp_path: Path) -> None:
"""Test required referenced field with naive datetime."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "require_referenced_field/",
output_path=tmp_path,
output_to_expected=[
("referenced.py", "require_referenced_field_naivedatetime/referenced.py"),
("required.py", "require_referenced_field_naivedatetime/required.py"),
],
assert_func=assert_file_content,
input_file_type="jsonschema",
extra_args=["--output-datetime-class", "NaiveDatetime", "--output-model-type", "pydantic_v2.BaseModel"],
)
@pytest.mark.parametrize(
("output_model", "expected_output"),
[
(
"pydantic_v2.BaseModel",
"require_referenced_field_pydantic_v2",
),
(
"msgspec.Struct",
"require_referenced_field_msgspec",
),
],
)
def test_main_require_referenced_field_datetime(output_model: str, expected_output: str, tmp_path: Path) -> None:
"""Test required referenced field with datetime."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "require_referenced_field/",
output_path=tmp_path,
output_to_expected=[
("referenced.py", f"{expected_output}/referenced.py"),
("required.py", f"{expected_output}/required.py"),
],
assert_func=assert_file_content,
input_file_type="jsonschema",
extra_args=["--output-model-type", output_model],
)
def test_main_json_pointer(output_file: Path) -> None:
"""Test JSON pointer references."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "json_pointer.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
def test_main_nested_json_pointer(output_file: Path) -> None:
"""Test nested JSON pointer references."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nested_json_pointer.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
def test_main_jsonschema_multiple_files_json_pointer(output_dir: Path) -> None:
"""Test JSON pointer with multiple files."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "multiple_files_json_pointer",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "multiple_files_json_pointer",
input_file_type="jsonschema",
)
def test_main_root_model_with_additional_properties(output_file: Path) -> None:
"""Test root model with additional properties."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_with_additional_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.cli_doc(
options=["--use-generic-container-types"],
option_description="""Use generic container types (Sequence, Mapping) for type hinting.
The `--use-generic-container-types` flag generates abstract container types
(Sequence, Mapping, FrozenSet) instead of concrete types (list, dict, set).
If `--use-standard-collections` is set, imports from `collections.abc`;
otherwise imports from `typing`.""",
input_schema="jsonschema/root_model_with_additional_properties.json",
cli_args=["--use-generic-container-types"],
golden_output="jsonschema/root_model_with_additional_properties_use_generic_container_types.py",
related_options=["--use-standard-collections"],
)
def test_main_root_model_with_additional_properties_use_generic_container_types(output_file: Path) -> None:
"""Use generic container types (Sequence, Mapping) for type hinting.
The `--use-generic-container-types` flag generates abstract container types
(Sequence, Mapping, FrozenSet) instead of concrete types (list, dict, set).
If `--use-standard-collections` is set, imports from `collections.abc`;
otherwise imports from `typing`.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_with_additional_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--use-generic-container-types"],
)
@pytest.mark.cli_doc(
options=["--use-standard-collections"],
option_description="""Use built-in dict/list instead of typing.Dict/List.
The `--use-standard-collections` flag generates built-in container types
(dict, list) instead of typing module equivalents. This produces cleaner
code for Python 3.10+ where built-in types support subscripting.""",
input_schema="jsonschema/root_model_with_additional_properties.json",
cli_args=["--use-standard-collections"],
golden_output="jsonschema/root_model_with_additional_properties_use_standard_collections.py",
related_options=["--use-generic-container-types"],
)
def test_main_root_model_with_additional_properties_use_standard_collections(output_file: Path) -> None:
"""Use built-in dict/list instead of typing.Dict/List.
The `--use-standard-collections` flag generates built-in container types
(dict, list) instead of typing module equivalents. This produces cleaner
code for Python 3.10+ where built-in types support subscripting.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_with_additional_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--use-standard-collections"],
)
@pytest.mark.cli_doc(
options=["--no-use-standard-collections"],
option_description="""Use typing.Dict/List instead of built-in dict/list for container types.
The `--no-use-standard-collections` flag generates typing module containers
(Dict, List) instead of built-in types. This is useful for older Python
versions or when explicit typing imports are preferred.""",
input_schema="jsonschema/root_model_with_additional_properties.json",
cli_args=["--no-use-standard-collections"],
golden_output="jsonschema/root_model_with_additional_properties_no_use_standard_collections.py",
related_options=["--use-standard-collections"],
)
def test_main_root_model_with_additional_properties_no_use_standard_collections(output_file: Path) -> None:
"""Use typing.Dict/List instead of built-in dict/list for container types.
The `--no-use-standard-collections` flag generates typing module containers
(Dict, List) instead of built-in types. This is useful for older Python
versions or when explicit typing imports are preferred.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_with_additional_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--no-use-standard-collections"],
)
@pytest.mark.cli_doc(
options=["--no-use-union-operator"],
option_description="""Use Union[X, Y] / Optional[X] instead of X | Y union operator.
The `--no-use-union-operator` flag generates union types using typing.Union
and typing.Optional instead of the | operator (PEP 604). This is useful
for older Python versions or when explicit typing imports are preferred.""",
input_schema="jsonschema/root_model_with_additional_properties.json",
cli_args=["--no-use-union-operator"],
golden_output="jsonschema/root_model_with_additional_properties_no_use_union_operator.py",
related_options=["--use-union-operator"],
)
def test_main_root_model_with_additional_properties_no_use_union_operator(output_file: Path) -> None:
"""Use Union[X, Y] / Optional[X] instead of X | Y union operator.
The `--no-use-union-operator` flag generates union types using typing.Union
and typing.Optional instead of the | operator (PEP 604). This is useful
for older Python versions or when explicit typing imports are preferred.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_with_additional_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--no-use-union-operator"],
)
def test_main_root_model_with_additional_properties_literal(min_version: str, output_file: Path) -> None:
"""Test root model additional properties with literal types."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_with_additional_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--enum-field-as-literal", "all", "--target-python-version", min_version],
)
def test_main_jsonschema_multiple_files_ref(output_dir: Path) -> None:
"""Test multiple files with references."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "multiple_files_self_ref",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "multiple_files_self_ref",
input_file_type="jsonschema",
)
def test_main_jsonschema_multiple_files_ref_test_json(output_file: Path) -> None:
"""Test main jsonschema multiple files ref json."""
with chdir(JSON_SCHEMA_DATA_PATH / "multiple_files_self_ref"):
run_main_and_assert(
input_path=Path("test.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="multiple_files_self_ref_single.py",
)
@pytest.mark.cli_doc(
options=["--original-field-name-delimiter"],
option_description="""Specify delimiter for original field names when using snake-case conversion.
The `--original-field-name-delimiter` option works with `--snake-case-field` to specify
the delimiter used in original field names. This is useful when field names contain
delimiters like spaces or hyphens that should be treated as word boundaries during
snake_case conversion.""",
input_schema="jsonschema/space_field_enum.json",
cli_args=["--snake-case-field", "--original-field-name-delimiter", " "],
golden_output="main/jsonschema/space_field_enum_snake_case_field.py",
)
def test_main_space_field_enum_snake_case_field(output_file: Path) -> None:
"""Specify delimiter for original field names when using snake-case conversion.
The `--original-field-name-delimiter` option works with `--snake-case-field` to specify
the delimiter used in original field names. This is useful when field names contain
delimiters like spaces or hyphens that should be treated as word boundaries during
snake_case conversion.
"""
with chdir(JSON_SCHEMA_DATA_PATH / "space_field_enum.json"):
run_main_and_assert(
input_path=Path("space_field_enum.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--snake-case-field", "--original-field-name-delimiter", " "],
)
@pytest.mark.benchmark
def test_main_all_of_ref(output_file: Path) -> None:
"""Test allOf with references."""
with chdir(JSON_SCHEMA_DATA_PATH / "all_of_ref"):
run_main_and_assert(
input_path=Path("test.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--class-name", "Test"],
)
def test_main_all_of_with_object(output_file: Path) -> None:
"""Test allOf with object types."""
with chdir(JSON_SCHEMA_DATA_PATH):
run_main_and_assert(
input_path=Path("all_of_with_object.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
def test_main_all_of_merge_same_property(output_file: Path) -> None:
"""Test allOf merging when duplicate property names exist across refs."""
with chdir(JSON_SCHEMA_DATA_PATH):
run_main_and_assert(
input_path=Path("all_of_merge_same_property.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="all_of_merge_same_property.py",
extra_args=["--class-name", "Model"],
)
def test_main_all_of_merge_boolean_property(output_file: Path) -> None:
"""Test allOf merging when a property has a boolean schema (false)."""
with chdir(JSON_SCHEMA_DATA_PATH):
run_main_and_assert(
input_path=Path("all_of_merge_boolean_property.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="all_of_merge_boolean_property.py",
extra_args=["--class-name", "Model"],
)
def test_main_all_of_ref_with_property_override(output_file: Path) -> None:
"""Test allOf with $ref preserves inheritance when properties are overridden."""
with chdir(JSON_SCHEMA_DATA_PATH):
run_main_and_assert(
input_path=Path("all_of_ref_with_property_override.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="all_of_ref_with_property_override.py",
)
def test_main_all_of_multi_ref_with_property_override(output_file: Path) -> None:
"""Test allOf with multiple $refs preserves multi-inheritance when properties are overridden."""
with chdir(JSON_SCHEMA_DATA_PATH):
run_main_and_assert(
input_path=Path("all_of_multi_ref_with_property_override.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="all_of_multi_ref_with_property_override.py",
)
def test_main_all_of_deep_hierarchy_property_override(output_file: Path) -> None:
"""Test allOf with deep hierarchy inherits types from grandparent when parent has partial override."""
with chdir(JSON_SCHEMA_DATA_PATH):
run_main_and_assert(
input_path=Path("all_of_deep_hierarchy_property_override.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="all_of_deep_hierarchy_property_override.py",
)
def test_main_all_of_very_deep_hierarchy_property_override(output_file: Path) -> None:
"""Test allOf with 4+ levels of hierarchy inherits types from great-grandparent."""
with chdir(JSON_SCHEMA_DATA_PATH):
run_main_and_assert(
input_path=Path("all_of_very_deep_hierarchy_property_override.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="all_of_very_deep_hierarchy_property_override.py",
)
def test_main_all_of_hierarchy_property_not_in_ancestor(output_file: Path) -> None:
"""Test allOf hierarchy when property override is not found in any ancestor."""
with chdir(JSON_SCHEMA_DATA_PATH):
run_main_and_assert(
input_path=Path("all_of_hierarchy_property_not_in_ancestor.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="all_of_hierarchy_property_not_in_ancestor.py",
)
def test_main_all_of_hierarchy_inline_allof(output_file: Path) -> None:
"""Test allOf hierarchy when parent has inline allOf without $ref."""
with chdir(JSON_SCHEMA_DATA_PATH):
run_main_and_assert(
input_path=Path("all_of_hierarchy_inline_allof.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="all_of_hierarchy_inline_allof.py",
)
@pytest.mark.skipif(
black.__version__.split(".")[0] >= "24",
reason="Installed black doesn't support the old style",
)
def test_main_combined_array(output_file: Path) -> None:
"""Test combined array types."""
with chdir(JSON_SCHEMA_DATA_PATH):
run_main_and_assert(
input_path=Path("combined_array.json"),
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@LEGACY_BLACK_SKIP
@pytest.mark.cli_doc(
options=["--disable-timestamp"],
option_description="""Disable timestamp in generated file header for reproducible output.
The `--disable-timestamp` flag configures the code generation behavior.""",
input_schema="jsonschema/pattern.json",
cli_args=["--disable-timestamp"],
golden_output="jsonschema/pattern.py",
)
def test_main_jsonschema_pattern(output_file: Path) -> None:
"""Disable timestamp in generated file header for reproducible output.
The `--disable-timestamp` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pattern.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="pattern.py",
extra_args=["--disable-timestamp"],
)
def test_main_generate(output_file: Path) -> None:
"""Test code generation function."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "person.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="general.py",
)
def test_main_generate_non_pydantic_output(output_file: Path) -> None:
"""Test generation with non-Pydantic output models (see issue #1452)."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "simple_string.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
output_model_type=DataModelType.DataclassesDataclass,
)
def test_main_generate_without_input_file_type(output_file: Path) -> None:
"""Test helper preserves generate() input_file_type default behavior."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "person.json",
output_path=output_file,
assert_func=assert_file_content,
expected_file="general.py",
)
def test_main_generate_relative_input_path(output_file: Path) -> None:
"""Test helper with a relative input path."""
run_generate_file_and_assert(
input_path=Path(os.path.relpath(JSON_SCHEMA_DATA_PATH / "person.json", Path.cwd())),
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="general.py",
)
def test_main_generate_external_absolute_input_path(tmp_path: Path) -> None:
"""Test helper keeps absolute input paths that are outside the repository root."""
with tempfile.TemporaryDirectory() as temp_dir:
input_path = Path(temp_dir) / "person.json"
assert Path.cwd() not in input_path.resolve().parents
input_path.write_text((JSON_SCHEMA_DATA_PATH / "person.json").read_text(encoding="utf-8"), encoding="utf-8")
run_generate_file_and_assert(
input_path=input_path,
output_path=tmp_path / "output.py",
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="general.py",
)
def test_main_generate_pydantic_v2_dataclass(output_file: Path) -> None:
"""Test generation with pydantic_v2.dataclass output model."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "simple_string.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="generate_pydantic_v2_dataclass.py",
output_model_type=DataModelType.PydanticV2Dataclass,
)
def test_main_generate_pydantic_v2_dataclass_with_config(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with ConfigDict from additionalProperties."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pydantic_v2_dataclass_config.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_config.py",
output_model_type=DataModelType.PydanticV2Dataclass,
)
def test_main_generate_pydantic_v2_dataclass_additional_props_true(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with additionalProperties: true."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pydantic_v2_dataclass_additional_props_true.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_additional_props_true.py",
output_model_type=DataModelType.PydanticV2Dataclass,
)
def test_main_generate_pydantic_v2_dataclass_unevaluated_props_true(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with unevaluatedProperties: true."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "unevaluated_properties_true.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="unevaluated_properties_true_dataclass.py",
output_model_type=DataModelType.PydanticV2Dataclass,
)
def test_main_generate_pydantic_v2_base_model_unevaluated_props(output_file: Path) -> None:
"""Test pydantic_v2.BaseModel with unevaluatedProperties: false."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "unevaluated_properties.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="unevaluated_properties_pydantic_v2.py",
output_model_type=DataModelType.PydanticV2BaseModel,
)
def test_main_generate_pydantic_v2_base_model_unevaluated_props_true(output_file: Path) -> None:
"""Test pydantic_v2.BaseModel with unevaluatedProperties: true."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "unevaluated_properties_true.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="unevaluated_properties_true_pydantic_v2.py",
output_model_type=DataModelType.PydanticV2BaseModel,
)
def test_main_generate_pydantic_v2_dataclass_unevaluated_props_false(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with unevaluatedProperties: false."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "unevaluated_properties.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="unevaluated_properties_dataclass.py",
output_model_type=DataModelType.PydanticV2Dataclass,
)
def test_main_generate_pydantic_v2_dataclass_use_attribute_docstrings(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with use_attribute_docstrings."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "simple_string.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_use_attribute_docstrings.py",
output_model_type=DataModelType.PydanticV2Dataclass,
use_attribute_docstrings=True,
)
def test_main_generate_pydantic_v2_dataclass_allow_population_by_field_name(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with allow_population_by_field_name."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "simple_string.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_populate_by_name.py",
output_model_type=DataModelType.PydanticV2Dataclass,
allow_population_by_field_name=True,
)
def test_main_generate_pydantic_v2_dataclass_allow_population_by_field_name_v2_11(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with allow_population_by_field_name and target v2.11."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "simple_string.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_validate_by_name.py",
output_model_type=DataModelType.PydanticV2Dataclass,
allow_population_by_field_name=True,
target_pydantic_version=TargetPydanticVersion.V2_11,
)
def test_main_generate_pydantic_v2_dataclass_extra_allow(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with extra='allow'."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "simple_string.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_extra_allow.py",
output_model_type=DataModelType.PydanticV2Dataclass,
extra_fields="allow",
)
def test_main_generate_pydantic_v2_dataclass_extra_forbid(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with extra='forbid'."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "simple_string.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_extra_forbid.py",
output_model_type=DataModelType.PydanticV2Dataclass,
extra_fields="forbid",
)
def test_main_generate_pydantic_v2_dataclass_extra_ignore(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with extra='ignore'."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "simple_string.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_extra_ignore.py",
output_model_type=DataModelType.PydanticV2Dataclass,
extra_fields="ignore",
)
def test_main_generate_pydantic_v2_dataclass_nested(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with nested models."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pydantic_v2_dataclass_nested.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_nested.py",
output_model_type=DataModelType.PydanticV2Dataclass,
)
def test_main_generate_pydantic_v2_dataclass_constraints(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with field constraints."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pydantic_v2_dataclass_constraints.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_constraints.py",
output_model_type=DataModelType.PydanticV2Dataclass,
)
def test_main_generate_pydantic_v2_dataclass_nested_frozen(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with nested models and frozen=True."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pydantic_v2_dataclass_nested.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_nested_frozen.py",
output_model_type=DataModelType.PydanticV2Dataclass,
frozen_dataclasses=True,
)
def test_main_generate_pydantic_v2_dataclass_field(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with Field constraints and defaults."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pydantic_v2_dataclass_field.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_field.py",
output_model_type=DataModelType.PydanticV2Dataclass,
)
def test_main_generate_pydantic_v2_dataclass_enum(output_file: Path) -> None:
"""Test pydantic_v2.dataclass with enum types."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pydantic_v2_dataclass_enum.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="pydantic_v2_dataclass_enum.py",
output_model_type=DataModelType.PydanticV2Dataclass,
)
@pytest.mark.parametrize(
("input_file", "expected_file"),
[
("pydantic_v2_model_default_dict_empty.json", "pydantic_v2_model_default_dict_empty.py"),
("pydantic_v2_model_default_dict_non_empty.json", "pydantic_v2_model_default_dict_non_empty.py"),
("pydantic_v2_model_default_nullable_dict_empty.json", "pydantic_v2_model_default_nullable_dict_empty.py"),
(
"pydantic_v2_model_default_nullable_dict_non_empty.json",
"pydantic_v2_model_default_nullable_dict_non_empty.py",
),
],
)
def test_main_generate_pydantic_v2_model_default_dict(input_file: str, expected_file: str, output_file: Path) -> None:
"""Test pydantic_v2.BaseModel with dict defaults."""
input_ = (JSON_SCHEMA_DATA_PATH / input_file).relative_to(Path.cwd())
assert not input_.is_absolute()
generate(
input_=input_,
input_file_type=InputFileType.JsonSchema,
output=output_file,
output_model_type=DataModelType.PydanticV2BaseModel,
)
assert_file_content(output_file, expected_file)
def test_main_generate_from_directory(tmp_path: Path) -> None:
"""Test generation from directory input."""
input_ = (JSON_SCHEMA_DATA_PATH / "external_files_in_directory").relative_to(Path.cwd())
assert not input_.is_absolute()
assert input_.is_dir()
generate(
input_=input_,
input_file_type=InputFileType.JsonSchema,
output=tmp_path,
)
main_nested_directory = EXPECTED_JSON_SCHEMA_PATH / "nested_directory"
assert_directory_content(tmp_path, main_nested_directory)
def test_main_generate_custom_class_name_generator(tmp_path: Path) -> None:
"""Test custom class name generator."""
def custom_class_name_generator(title: str) -> str:
return f"Custom{title}"
output_file: Path = tmp_path / "output.py"
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "person.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="general.py",
transform=lambda s: s.replace("CustomPerson", "Person"),
custom_class_name_generator=custom_class_name_generator,
)
def test_main_generate_custom_class_name_generator_additional_properties(tmp_path: Path) -> None:
"""Test custom class name generator with additional properties."""
output_file = tmp_path / "models.py"
def custom_class_name_generator(name: str) -> str:
return f"Custom{name[0].upper() + name[1:]}"
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_with_additional_properties.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="root_model_with_additional_properties_custom_class_name.py",
custom_class_name_generator=custom_class_name_generator,
)
def test_main_generate_custom_class_name_generator_keep_underscores(output_file: Path) -> None:
"""Test custom_class_name_generator preserves underscores in class names (Issue #1315)."""
def keep_underscores(name: str) -> str:
return name
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "underscore_title.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="underscore_title.py",
custom_class_name_generator=keep_underscores,
)
def test_main_http_jsonschema(mocker: MockerFixture, output_file: Path) -> None:
"""Test HTTP JSON Schema fetching."""
external_directory = JSON_SCHEMA_DATA_PATH / "external_files_in_directory"
base_url = "https://example.com/external_files_in_directory/"
url_to_path = {
f"{base_url}person.json": "person.json",
f"{base_url}definitions/relative/animal/pet/pet.json": "definitions/relative/animal/pet/pet.json",
f"{base_url}definitions/relative/animal/fur.json": "definitions/relative/animal/fur.json",
f"{base_url}definitions/friends.json": "definitions/friends.json",
f"{base_url}definitions/food.json": "definitions/food.json",
f"{base_url}definitions/machine/robot.json": "definitions/machine/robot.json",
f"{base_url}definitions/drink/coffee.json": "definitions/drink/coffee.json",
f"{base_url}definitions/drink/tea.json": "definitions/drink/tea.json",
}
def get_mock_response(url: str, **_: object) -> mocker.Mock:
path = url_to_path.get(url)
mock = mocker.Mock()
mock.text = (external_directory / path).read_text()
return mock
httpx_get_mock = mocker.patch(
"httpx.get",
side_effect=get_mock_response,
)
run_main_url_and_assert(
url="https://example.com/external_files_in_directory/person.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="external_files_in_directory.py",
transform=lambda s: s.replace(
"# filename: https://example.com/external_files_in_directory/person.json",
"# filename: person.json",
),
)
httpx_get_mock.assert_has_calls(
[
call(
"https://example.com/external_files_in_directory/person.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/relative/animal/pet/pet.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/relative/animal/fur.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/friends.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/food.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/machine/robot.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/drink/coffee.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/drink/tea.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
],
any_order=True,
)
assert httpx_get_mock.call_count == 8
@pytest.mark.parametrize(
(
"headers_arguments",
"headers_requests",
"query_parameters_arguments",
"query_parameters_requests",
"http_ignore_tls",
),
[
(
("Authorization: Basic dXNlcjpwYXNz",),
[("Authorization", "Basic dXNlcjpwYXNz")],
("key=value",),
[("key", "value")],
False,
),
(
("Authorization: Basic dXNlcjpwYXNz", "X-API-key: abcefg"),
[("Authorization", "Basic dXNlcjpwYXNz"), ("X-API-key", "abcefg")],
("key=value", "newkey=newvalue"),
[("key", "value"), ("newkey", "newvalue")],
True,
),
],
)
def test_main_http_jsonschema_with_http_headers_and_http_query_parameters_and_ignore_tls(
mocker: MockerFixture,
headers_arguments: tuple[str, str],
headers_requests: list[tuple[str, str]],
query_parameters_arguments: tuple[str, ...],
query_parameters_requests: list[tuple[str, str]],
http_ignore_tls: bool,
tmp_path: Path,
) -> None:
"""Test HTTP JSON Schema with headers, query params, and TLS ignore."""
external_directory = JSON_SCHEMA_DATA_PATH / "external_files_in_directory"
base_url = "https://example.com/external_files_in_directory/"
url_to_path = {
f"{base_url}person.json": "person.json",
f"{base_url}definitions/relative/animal/pet/pet.json": "definitions/relative/animal/pet/pet.json",
f"{base_url}definitions/relative/animal/fur.json": "definitions/relative/animal/fur.json",
f"{base_url}definitions/friends.json": "definitions/friends.json",
f"{base_url}definitions/food.json": "definitions/food.json",
f"{base_url}definitions/machine/robot.json": "definitions/machine/robot.json",
f"{base_url}definitions/drink/coffee.json": "definitions/drink/coffee.json",
f"{base_url}definitions/drink/tea.json": "definitions/drink/tea.json",
}
def get_mock_response(url: str, **_: object) -> mocker.Mock:
path = url_to_path.get(url)
mock = mocker.Mock()
mock.text = (external_directory / path).read_text()
return mock
httpx_get_mock = mocker.patch(
"httpx.get",
side_effect=get_mock_response,
)
output_file: Path = tmp_path / "output.py"
extra_args = [
"--http-headers",
*headers_arguments,
"--http-query-parameters",
*query_parameters_arguments,
]
if http_ignore_tls:
extra_args.append("--http-ignore-tls")
run_main_url_and_assert(
url="https://example.com/external_files_in_directory/person.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="external_files_in_directory.py",
extra_args=extra_args,
transform=lambda s: s.replace(
"# filename: https://example.com/external_files_in_directory/person.json",
"# filename: person.json",
),
)
httpx_get_mock.assert_has_calls(
[
call(
"https://example.com/external_files_in_directory/person.json",
headers=headers_requests,
verify=bool(not http_ignore_tls),
follow_redirects=True,
params=query_parameters_requests,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/relative/animal/pet/pet.json",
headers=headers_requests,
verify=bool(not http_ignore_tls),
follow_redirects=True,
params=query_parameters_requests,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/relative/animal/fur.json",
headers=headers_requests,
verify=bool(not http_ignore_tls),
follow_redirects=True,
params=query_parameters_requests,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/friends.json",
headers=headers_requests,
verify=bool(not http_ignore_tls),
follow_redirects=True,
params=query_parameters_requests,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/food.json",
headers=headers_requests,
verify=bool(not http_ignore_tls),
follow_redirects=True,
params=query_parameters_requests,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/machine/robot.json",
headers=headers_requests,
verify=bool(not http_ignore_tls),
follow_redirects=True,
params=query_parameters_requests,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/drink/coffee.json",
headers=headers_requests,
verify=bool(not http_ignore_tls),
follow_redirects=True,
params=query_parameters_requests,
timeout=30.0,
),
call(
"https://example.com/external_files_in_directory/definitions/drink/tea.json",
headers=headers_requests,
verify=bool(not http_ignore_tls),
follow_redirects=True,
params=query_parameters_requests,
timeout=30.0,
),
],
any_order=True,
)
assert httpx_get_mock.call_count == 8
def test_main_self_reference(output_file: Path) -> None:
"""Test self-referencing schemas."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "self_reference.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.benchmark
def test_main_strict_types(output_file: Path) -> None:
"""Test strict type generation."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "strict_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.cli_doc(
options=["--strict-types"],
option_description="""Enable strict type validation for specified Python types.
The --strict-types option enforces stricter type checking by preventing implicit
type coercion for the specified types (str, bytes, int, float, bool). This
generates StrictStr, StrictBytes, StrictInt, StrictFloat, and StrictBool types
in Pydantic models, ensuring values match exactly without automatic conversion.""",
input_schema="jsonschema/strict_types.json",
cli_args=["--strict-types", "str", "bytes", "int", "float", "bool"],
golden_output="main/jsonschema/strict_types_all.py",
)
@pytest.mark.skipif(
black.__version__.split(".")[0] >= "24",
reason="Installed black doesn't support the old style",
)
def test_main_strict_types_all(output_file: Path) -> None:
"""Enable strict type validation for specified Python types.
The --strict-types option enforces stricter type checking by preventing implicit
type coercion for the specified types (str, bytes, int, float, bool). This
generates StrictStr, StrictBytes, StrictInt, StrictFloat, and StrictBool types
in Pydantic models, ensuring values match exactly without automatic conversion.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "strict_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--strict-types", "str", "bytes", "int", "float", "bool"],
)
@pytest.mark.cli_doc(
options=["--field-constraints"],
option_description="""Generate Field() with validation constraints from schema.
The `--field-constraints` flag generates Pydantic Field() declarations with
validation constraints (min/max length, pattern, minimum/maximum values, etc.)
extracted from the JSON Schema, enabling runtime validation.""",
input_schema="jsonschema/strict_types.json",
cli_args=["--strict-types", "str", "bytes", "int", "float", "bool", "--field-constraints"],
golden_output="jsonschema/strict_types_all_field_constraints.py",
related_options=["--strict-types"],
)
def test_main_strict_types_all_with_field_constraints(output_file: Path) -> None:
"""Generate Field() with validation constraints from schema.
The `--field-constraints` flag generates Pydantic Field() declarations with
validation constraints (min/max length, pattern, minimum/maximum values, etc.)
extracted from the JSON Schema, enabling runtime validation.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "strict_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="strict_types_all_field_constraints.py",
extra_args=["--strict-types", "str", "bytes", "int", "float", "bool", "--field-constraints"],
)
@LEGACY_BLACK_SKIP
def test_main_strict_types_with_constraints(output_file: Path) -> None:
"""Test strict int/float with constraints generates conint/confloat with strict=True, and decimal format."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "strict_types_coverage.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="strict_types_with_constraints.py",
extra_args=["--strict-types", "int", "float", "str"],
)
@LEGACY_BLACK_SKIP
def test_main_hostname_strict_field_constraints(output_file: Path) -> None:
"""Test hostname with --strict-types str and --field-constraints returns StrictStr."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "strict_types_coverage.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="hostname_strict_field_constraints.py",
extra_args=["--strict-types", "str", "--field-constraints"],
)
def test_main_hostname_field_constraints_pydantic_v2(output_file: Path) -> None:
"""Test hostname format uses Field(pattern=) instead of constr with --field-constraints."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "hostname_field_constraints.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="hostname_field_constraints_pydantic_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--field-constraints"],
)
def test_main_hostname_root_type_pydantic_v2(output_file: Path) -> None:
"""Test hostname format in root type uses Field(pattern=) with --field-constraints."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "hostname_root_type.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="hostname_root_type_pydantic_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--field-constraints"],
)
def test_main_hostname_multiple_types_pydantic_v2(output_file: Path) -> None:
"""Test hostname format with multiple types uses Field(pattern=) with --field-constraints."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "hostname_multiple_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="hostname_multiple_types_pydantic_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--field-constraints"],
)
def test_main_jsonschema_special_enum(output_file: Path) -> None:
"""Test special enum handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "special_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="special_enum.py",
)
@pytest.mark.cli_doc(
options=["--special-field-name-prefix"],
option_description="""Prefix to add to special field names (like reserved keywords).
The `--special-field-name-prefix` flag configures the code generation behavior.""",
input_schema="jsonschema/special_enum.json",
cli_args=["--special-field-name-prefix", "special"],
golden_output="jsonschema/special_enum_special_field_name_prefix.py",
)
def test_main_jsonschema_special_enum_special_field_name_prefix(output_file: Path) -> None:
"""Prefix to add to special field names (like reserved keywords).
The `--special-field-name-prefix` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "special_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="special_enum_special_field_name_prefix.py",
extra_args=["--special-field-name-prefix", "special"],
)
def test_main_jsonschema_special_enum_special_field_name_prefix_keep_private(output_file: Path) -> None:
"""Test special enum with prefix keeping private fields."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "special_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="special_enum_special_field_name_prefix_keep_private.py",
extra_args=["--special-field-name-prefix", ""],
)
@pytest.mark.cli_doc(
options=["--remove-special-field-name-prefix"],
option_description="""Remove the special prefix from field names.
The `--remove-special-field-name-prefix` flag configures the code generation behavior.""",
input_schema="jsonschema/special_prefix_model.json",
cli_args=["--remove-special-field-name-prefix"],
golden_output="jsonschema/special_model_remove_special_field_name_prefix.py",
)
def test_main_jsonschema_special_model_remove_special_field_name_prefix(output_file: Path) -> None:
"""Remove the special prefix from field names.
The `--remove-special-field-name-prefix` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "special_prefix_model.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="special_model_remove_special_field_name_prefix.py",
extra_args=["--remove-special-field-name-prefix"],
)
def test_main_jsonschema_subclass_enum(output_file: Path) -> None:
"""Test enum subclassing."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "subclass_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="subclass_enum.py",
extra_args=["--use-subclass-enum"],
)
def test_main_jsonschema_allof_enum_ref(output_file: Path) -> None:
"""Test allOf referencing enum from another schema."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "allof_enum_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
def test_main_jsonschema_allof_enum_no_external_ref(output_file: Path) -> None:
"""Test allOf referencing enum without external $ref.
This covers the case where existing_ref is None in parse_all_of,
so the schema is optimized to directly return the enum reference.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "allof_enum_no_external_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "22",
reason="Installed black doesn't support the old style",
)
@pytest.mark.cli_doc(
options=["--use-specialized-enum"],
option_description="""Generate StrEnum/IntEnum for string/integer enums (Python 3.11+).
The `--use-specialized-enum` flag generates specialized enum types:
- `StrEnum` for string enums
- `IntEnum` for integer enums
This is the default behavior for Python 3.11+ targets.""",
input_schema="jsonschema/subclass_enum.json",
cli_args=["--target-python-version", "3.11", "--use-specialized-enum"],
golden_output="jsonschema/enum_specialized.py",
related_options=["--no-use-specialized-enum", "--use-subclass-enum"],
)
def test_main_jsonschema_specialized_enums(output_file: Path) -> None:
"""Generate StrEnum/IntEnum for string/integer enums (Python 3.11+).
The `--use-specialized-enum` flag generates specialized enum types:
- `StrEnum` for string enums
- `IntEnum` for integer enums
This is the default behavior for Python 3.11+ targets.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "subclass_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="enum_specialized.py",
extra_args=["--target-python-version", "3.11"],
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "22",
reason="Installed black doesn't support the old style",
)
@pytest.mark.cli_doc(
options=["--no-use-specialized-enum"],
option_description="""Disable specialized enum generation (StrEnum/IntEnum).
The `--no-use-specialized-enum` flag disables specialized enum types,
generating standard `Enum` classes instead of `StrEnum`/`IntEnum`.""",
input_schema="jsonschema/subclass_enum.json",
cli_args=["--target-python-version", "3.11", "--no-use-specialized-enum"],
golden_output="jsonschema/enum_specialized_disable.py",
related_options=["--use-specialized-enum", "--use-subclass-enum"],
)
def test_main_jsonschema_specialized_enums_disabled(output_file: Path) -> None:
"""Disable specialized enum generation (StrEnum/IntEnum).
The `--no-use-specialized-enum` flag disables specialized enum types,
generating standard `Enum` classes instead of `StrEnum`/`IntEnum`.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "subclass_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="enum_specialized_disable.py",
extra_args=["--target-python-version", "3.11", "--no-use-specialized-enum"],
)
@pytest.mark.cli_doc(
options=["--empty-enum-field-name"],
option_description="""Name for empty string enum field values.
The `--empty-enum-field-name` flag configures the code generation behavior.""",
input_schema="jsonschema/special_enum.json",
cli_args=["--empty-enum-field-name", "empty"],
golden_output="jsonschema/special_enum_empty_enum_field_name.py",
)
def test_main_jsonschema_special_enum_empty_enum_field_name(output_file: Path) -> None:
"""Name for empty string enum field values.
The `--empty-enum-field-name` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "special_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="special_enum_empty_enum_field_name.py",
extra_args=["--empty-enum-field-name", "empty"],
)
@pytest.mark.benchmark
def test_main_jsonschema_special_field_name(output_file: Path) -> None:
"""Test special field name handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "special_field_name.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="special_field_name.py",
)
def test_main_jsonschema_complex_one_of(output_file: Path) -> None:
"""Test complex oneOf schemas."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "complex_one_of.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="complex_one_of.py",
)
def test_main_jsonschema_complex_any_of(output_file: Path) -> None:
"""Test complex anyOf schemas."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "complex_any_of.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="complex_any_of.py",
)
def test_main_jsonschema_combine_one_of_object(output_file: Path) -> None:
"""Test combining oneOf with objects."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "combine_one_of_object.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="combine_one_of_object.py",
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "19",
reason="Installed black doesn't support the old style",
)
@pytest.mark.parametrize(
("union_mode", "output_model", "expected_output"),
[
(None, "pydantic_v2.BaseModel", "combine_any_of_object_v2.py"),
(
"left_to_right",
"pydantic_v2.BaseModel",
"combine_any_of_object_left_to_right.py",
),
],
)
@pytest.mark.cli_doc(
options=["--union-mode"],
option_description="""Union mode for combining anyOf/oneOf schemas (smart or left_to_right).
The `--union-mode` flag configures the code generation behavior.""",
input_schema="jsonschema/combine_any_of_object.json",
cli_args=["--union-mode", "left_to_right", "--output-model-type", "pydantic_v2.BaseModel"],
golden_output="jsonschema/combine_any_of_object_left_to_right.py",
)
def test_main_jsonschema_combine_any_of_object(
union_mode: str | None, output_model: str, expected_output: str, output_file: Path
) -> None:
"""Union mode for combining anyOf/oneOf schemas (smart or left_to_right).
The `--union-mode` flag configures the code generation behavior.
"""
extra_args = ["--output-model-type", output_model]
if union_mode is not None:
extra_args.extend(["--union-mode", union_mode])
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "combine_any_of_object.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=extra_args,
)
@pytest.mark.benchmark
@pytest.mark.parametrize(
("extra_args", "expected_file"),
[
(["--output-model-type", "pydantic_v2.BaseModel"], "jsonschema_root_model_ordering.py"),
(
["--output-model-type", "pydantic_v2.BaseModel", "--keep-model-order"],
"jsonschema_root_model_ordering_keep_model_order.py",
),
],
)
def test_main_jsonschema_root_model_ordering(output_file: Path, extra_args: list[str], expected_file: str) -> None:
"""Test RootModel is ordered after the types it references."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_ordering.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_file,
extra_args=extra_args,
)
@pytest.mark.cli_doc(
options=["--field-include-all-keys"],
option_description="""Include all schema keys in Field() json_schema_extra.
The `--field-include-all-keys` flag configures the code generation behavior.""",
input_schema="jsonschema/person.json",
cli_args=["--field-include-all-keys"],
golden_output="jsonschema/general.py",
)
@pytest.mark.benchmark
def test_main_jsonschema_field_include_all_keys(output_file: Path) -> None:
"""Include all schema keys in Field() json_schema_extra.
The `--field-include-all-keys` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "person.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="general.py",
extra_args=["--field-include-all-keys"],
)
@pytest.mark.cli_doc(
options=["--field-extra-keys-without-x-prefix"],
option_description="""Include schema extension keys in Field() without requiring 'x-' prefix.
The --field-extra-keys-without-x-prefix option allows you to specify custom
schema extension keys that should be included in Pydantic Field() extras without
the 'x-' prefix requirement. For example, 'x-repr' in the schema becomes 'repr'
in Field(). This is useful for custom schema extensions and vendor-specific metadata.""",
input_schema="jsonschema/extras.json",
cli_args=["--field-include-all-keys", "--field-extra-keys-without-x-prefix", "x-repr"],
model_outputs={
"pydantic_v2": "main/jsonschema/field_extras_field_include_all_keys_v2.py",
},
)
def test_main_jsonschema_field_extras_field_include_all_keys(output_file: Path) -> None:
"""Include schema extension keys in Field() without requiring 'x-' prefix.
The --field-extra-keys-without-x-prefix option allows you to specify custom
schema extension keys that should be included in Pydantic Field() extras without
the 'x-' prefix requirement. For example, 'x-repr' in the schema becomes 'repr'
in Field(). This is useful for custom schema extensions and vendor-specific metadata.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "extras.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_extras_field_include_all_keys_v2.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-include-all-keys",
"--field-extra-keys-without-x-prefix",
"x-repr",
],
)
@pytest.mark.cli_doc(
options=["--field-extra-keys"],
option_description="""Include specific extra keys in Field() definitions.
The `--field-extra-keys` flag configures the code generation behavior.""",
input_schema="jsonschema/extras.json",
cli_args=["--field-extra-keys", "key2", "--field-extra-keys-without-x-prefix", "x-repr"],
model_outputs={
"pydantic_v2": "main/jsonschema/field_extras_field_extra_keys_v2.py",
},
)
def test_main_jsonschema_field_extras_field_extra_keys(output_file: Path) -> None:
"""Include specific extra keys in Field() definitions.
The `--field-extra-keys` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "extras.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_extras_field_extra_keys_v2.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-extra-keys",
"key2",
"invalid-key-1",
"--field-extra-keys-without-x-prefix",
"x-repr",
],
)
def test_main_jsonschema_field_extras(output_file: Path) -> None:
"""Test field extras generation."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "extras.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_extras_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
def test_main_jsonschema_custom_base_path(output_file: Path) -> None:
"""Test custom base path configuration."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "custom_base_path.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="custom_base_path.py",
)
@pytest.mark.cli_doc(
options=["--base-class-map"],
option_description="""Specify different base classes for specific models via JSON mapping.
The `--base-class-map` option allows you to assign different base classes
to specific models. This is useful when you want selective base class inheritance,
for example, applying custom base classes only to specific models while leaving
others with the default `BaseModel`.
Priority: `--base-class-map` > `customBasePath` (schema extension) > `--base-class`
You can specify either a single base class as a string, or multiple base classes
(mixins) as a list:
- Single: `{"Person": "custom.bases.PersonBase"}`
- Multiple: `{"User": ["mixins.AuditMixin", "mixins.TimestampMixin"]}`
When using multiple base classes, the specified classes are used directly without
adding `BaseModel`. Ensure your mixins inherit from `BaseModel` if needed.""",
input_schema="jsonschema/base_class_map.json",
cli_args=[
"--base-class-map",
'{"Person": "custom.bases.PersonBase", "Animal": "custom.bases.AnimalBase"}',
],
golden_output="base_class_map.py",
related_options=["--base-class"],
)
def test_main_jsonschema_base_class_map(output_file: Path) -> None:
"""Specify different base classes for specific models via JSON mapping.
The `--base-class-map` option allows you to assign different base classes
to specific models. Priority: base-class-map > customBasePath > base-class.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "base_class_map.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="base_class_map.py",
extra_args=[
"--base-class-map",
'{"Person": "custom.bases.PersonBase", "Animal": "custom.bases.AnimalBase"}',
],
)
def test_main_jsonschema_custom_base_paths_list(output_file: Path) -> None:
"""Test customBasePath with list of base classes."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "custom_base_paths_list.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="custom_base_paths_list.py",
)
def test_main_jsonschema_base_class_map_list(output_file: Path) -> None:
"""Test base_class_map with list values for multiple inheritance."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "base_class_map_list.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="base_class_map_list.py",
extra_args=[
"--base-class-map",
'{"User": ["mixins.AuditMixin", "mixins.TimestampMixin"], "Admin": "admin.AdminBase"}',
],
)
def test_main_jsonschema_base_class_map_empty_list(output_file: Path) -> None:
"""Test base_class_map with empty strings list (falls back to default)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "base_class_map_empty_list.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="base_class_map_empty_list.py",
extra_args=[
"--base-class-map",
'{"User": ["", ""]}',
],
)
def test_long_description(output_file: Path) -> None:
"""Test long description handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "long_description.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.cli_doc(
options=["--wrap-string-literal"],
option_description="""Wrap long string literals across multiple lines.
The `--wrap-string-literal` flag breaks long string literals (like descriptions)
across multiple lines for better readability, instead of having very long
single-line strings in the generated code.""",
input_schema="jsonschema/long_description.json",
cli_args=["--wrap-string-literal"],
golden_output="jsonschema/long_description_wrap_string_literal.py",
)
def test_long_description_wrap_string_literal(output_file: Path) -> None:
"""Wrap long string literals across multiple lines.
The `--wrap-string-literal` flag breaks long string literals (like descriptions)
across multiple lines for better readability, instead of having very long
single-line strings in the generated code.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "long_description.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--wrap-string-literal"],
)
def test_version(capsys: pytest.CaptureFixture) -> None:
"""Test version output."""
with pytest.raises(SystemExit) as e:
run_main_with_args(["--version"])
assert e.value.code == Exit.OK
captured = capsys.readouterr()
assert captured.out != "0.0.0\n"
assert not captured.err
def test_jsonschema_pattern_properties(output_file: Path) -> None:
"""Test JSON Schema pattern properties."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pattern_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="pattern_properties.py",
)
def test_jsonschema_pattern_properties_field_constraints(output_file: Path) -> None:
"""Test pattern properties with field constraints."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pattern_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="pattern_properties_field_constraints.py",
extra_args=["--field-constraints"],
)
def test_jsonschema_pattern_properties_use_annotated(output_file: Path) -> None:
"""Test pattern properties with --use-annotated preserves pattern constraint on dict keys."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pattern_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="pattern_properties_use_annotated.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--use-annotated"],
)
@LEGACY_BLACK_SKIP
def test_jsonschema_titles(output_file: Path) -> None:
"""Test JSON Schema title handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "titles.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="titles.py",
)
@LEGACY_BLACK_SKIP
@pytest.mark.cli_doc(
options=["--use-title-as-name"],
option_description="""Use schema title as the generated class name.
The `--use-title-as-name` flag uses the `title` property from the schema
as the class name instead of deriving it from the property name or path.
This is useful when schemas have descriptive titles that should be preserved.""",
input_schema="jsonschema/titles.json",
cli_args=["--use-title-as-name"],
golden_output="jsonschema/titles_use_title_as_name.py",
related_options=["--class-name"],
)
def test_jsonschema_titles_use_title_as_name(output_file: Path) -> None:
"""Use schema title as the generated class name.
The `--use-title-as-name` flag uses the `title` property from the schema
as the class name instead of deriving it from the property name or path.
This is useful when schemas have descriptive titles that should be preserved.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "titles.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="titles_use_title_as_name.py",
extra_args=["--use-title-as-name"],
)
@LEGACY_BLACK_SKIP
def test_jsonschema_without_titles_use_title_as_name(output_file: Path) -> None:
"""Test title as name without titles present."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "without_titles.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="without_titles_use_title_as_name.py",
extra_args=["--use-title-as-name"],
)
def test_jsonschema_title_with_dots(output_file: Path) -> None:
"""Test using title as name when title contains dots (e.g., version numbers)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "title_with_dots.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="title_with_dots.py",
extra_args=["--use-title-as-name"],
)
@BLACK_PY313_SKIP
def test_jsonschema_use_title_as_name_inline_types(output_file: Path) -> None:
"""Test use-title-as-name creates type aliases for inline types.
When use_title_as_name is enabled and inline types (array, dict, oneOf, anyOf, enum)
have a title, type aliases should be created instead of using inline types directly.
Fixes: https://github.com/koxudaxi/datamodel-code-generator/issues/2887
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_title_as_name_inline_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_title_as_name_inline_types.py",
extra_args=[
"--use-title-as-name",
"--output-model-type",
"typing.TypedDict",
"--target-python-version",
"3.13",
"--use-union-operator",
"--use-standard-collections",
"--skip-root-model",
],
)
@BLACK_PY313_SKIP
def test_jsonschema_use_title_as_name_inline_types_pydantic(output_file: Path) -> None:
"""Test use-title-as-name with Pydantic v2 creates named types for inline types.
This test covers the case where should_parse_enum_as_literal returns False
(for oneOf with const values), exercising the False branch in
_should_create_type_alias_for_title.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_title_as_name_inline_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_title_as_name_inline_types_pydantic.py",
extra_args=[
"--use-title-as-name",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-python-version",
"3.13",
"--use-union-operator",
"--use-standard-collections",
],
)
@BLACK_PY313_SKIP
def test_jsonschema_use_title_as_name_nested_titles(output_file: Path) -> None:
"""Test use-title-as-name creates type aliases for nested elements with titles.
When use_title_as_name is enabled, nested elements like array items,
additionalProperties values, and oneOf/anyOf branches that have their own
titles should also create type aliases.
Fixes: https://github.com/koxudaxi/datamodel-code-generator/issues/2887
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_title_as_name_nested_titles.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_title_as_name_nested_titles.py",
extra_args=[
"--use-title-as-name",
"--output-model-type",
"typing.TypedDict",
"--target-python-version",
"3.13",
"--use-union-operator",
"--use-standard-collections",
"--skip-root-model",
],
)
@BLACK_PY313_SKIP
def test_jsonschema_use_title_as_name_nested_titles_pydantic(output_file: Path) -> None:
"""Test use-title-as-name with Pydantic v2 creates named types for nested elements."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_title_as_name_nested_titles.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_title_as_name_nested_titles_pydantic.py",
extra_args=[
"--use-title-as-name",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-python-version",
"3.13",
"--use-union-operator",
"--use-standard-collections",
],
)
def test_main_jsonschema_has_default_value(output_file: Path) -> None:
"""Test default value handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "has_default_value.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="has_default_value_pydantic_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
def test_main_jsonschema_boolean_property(output_file: Path) -> None:
"""Test boolean property generation."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "boolean_property.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="boolean_property.py",
)
def test_main_jsonschema_modular_default_enum_member(output_dir: Path) -> None:
"""Test modular enum with default member."""
with freeze_time(TIMESTAMP):
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "modular_default_enum_member",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "modular_default_enum_member",
extra_args=["--set-default-enum-member"],
)
def test_main_jsonschema_falsy_default_enum_member(output_file: Path) -> None:
"""Test enum member mapping for falsy default values."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "falsy_default_enum_member.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="falsy_default_enum_member.py",
extra_args=["--set-default-enum-member"],
)
@pytest.mark.skipif(
black.__version__.split(".")[0] < "22",
reason="Installed black doesn't support Python version 3.10",
)
def test_main_use_union_operator(output_dir: Path) -> None:
"""Test union operator usage."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "external_files_in_directory",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "use_union_operator",
input_file_type="jsonschema",
extra_args=["--use-union-operator"],
)
@pytest.mark.parametrize(
("extra_args", "expected_suffix"),
[
(["--treat-dot-as-module"], "treat_dot_as_module"),
(None, "treat_dot_not_as_module"),
(["--no-treat-dot-as-module"], "treat_dot_not_as_module"),
],
)
def test_treat_dot_as_module(extra_args: list[str] | None, expected_suffix: str, output_dir: Path) -> None:
"""Test dot notation as module separator."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "treat_dot_as_module",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / expected_suffix,
extra_args=extra_args,
)
@pytest.mark.cli_doc(
options=["--treat-dot-as-module"],
option_description="""Treat dots in schema names as module separators.
The `--treat-dot-as-module` flag configures the code generation behavior.""",
input_schema="jsonschema/treat_dot_as_module_single",
cli_args=["--treat-dot-as-module"],
golden_output="jsonschema/treat_dot_as_module_single/",
)
def test_treat_dot_as_module_single_file(output_dir: Path) -> None:
"""Treat dots in schema names as module separators.
The `--treat-dot-as-module` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "treat_dot_as_module_single",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "treat_dot_as_module_single",
extra_args=["--treat-dot-as-module"],
)
@pytest.mark.cli_doc(
options=["--no-treat-dot-as-module"],
option_description="""Keep dots in schema names as underscores for flat output.
The `--no-treat-dot-as-module` flag prevents splitting dotted schema names.""",
input_schema="jsonschema/treat_dot_as_module_single",
cli_args=["--no-treat-dot-as-module"],
golden_output="jsonschema/treat_dot_as_module_single_no_treat/",
primary=True,
)
def test_no_treat_dot_as_module_single_file(output_dir: Path) -> None:
"""Keep dots in schema names as underscores for flat output.
The `--no-treat-dot-as-module` flag prevents splitting dotted schema names.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "treat_dot_as_module_single",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "treat_dot_as_module_single_no_treat",
extra_args=["--no-treat-dot-as-module"],
)
@pytest.mark.parametrize(
("extra_args", "expected_suffix"),
[
(["--treat-dot-as-module"], "treat_dot_single"),
(None, "no_treat_dot_single"),
(["--no-treat-dot-as-module"], "no_treat_dot_single"),
],
)
def test_treat_dot_as_module_version_style(
extra_args: list[str] | None, expected_suffix: str, output_dir: Path
) -> None:
"""Test dotted version-style schema names (e.g., v0.0.39.job.json)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "no_treat_dot_single",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / expected_suffix,
extra_args=extra_args,
)
@pytest.mark.parametrize(
("extra_args", "expected_suffix"),
[
(["--treat-dot-as-module"], "treat_dot_complex_treat"),
(None, "treat_dot_complex_no_treat"),
(["--no-treat-dot-as-module"], "treat_dot_complex_no_treat"),
],
)
def test_treat_dot_as_module_complex_refs(extra_args: list[str] | None, expected_suffix: str, output_dir: Path) -> None:
"""Test dotted schema names with cross-file references."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "treat_dot_complex",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / expected_suffix,
extra_args=extra_args,
)
def test_main_jsonschema_duplicate_name(output_dir: Path) -> None:
"""Test duplicate name handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "duplicate_name",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "duplicate_name",
input_file_type="jsonschema",
)
def test_main_jsonschema_items_boolean(output_file: Path) -> None:
"""Test items with boolean values."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "items_boolean.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="items_boolean.py",
)
def test_main_jsonschema_array_in_additional_properites(output_file: Path) -> None:
"""Test array in additional properties."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "array_in_additional_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="array_in_additional_properties.py",
)
def test_main_jsonschema_object_with_only_additional_properties(output_file: Path) -> None:
"""Test object with only additional properties."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "string_dict.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="string_dict.py",
)
def test_main_jsonschema_unevaluated_properties(output_file: Path) -> None:
"""Test unevaluatedProperties: false generates extra='forbid'."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "unevaluated_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="unevaluated_properties.py",
)
def test_main_jsonschema_unevaluated_properties_true(output_file: Path) -> None:
"""Test unevaluatedProperties: true generates extra='allow'."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "unevaluated_properties_true.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="unevaluated_properties_true.py",
)
def test_main_jsonschema_unevaluated_properties_schema(output_file: Path) -> None:
"""Test unevaluatedProperties as JsonSchemaObject triggers traversal."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "unevaluated_properties_schema.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="unevaluated_properties_schema.py",
)
def test_main_jsonschema_unevaluated_properties_multiple_types(output_file: Path) -> None:
"""Test unevaluatedProperties with multiple types triggers _set_schema_metadata."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "unevaluated_properties_multiple_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="unevaluated_properties_multiple_types.py",
)
def test_main_jsonschema_nullable_object(output_file: Path) -> None:
"""Test nullable object handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nullable_object.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="nullable_object.py",
)
def test_main_jsonschema_ref_type_has_null(output_file: Path) -> None:
"""Test that type: [type, null] from $ref schema is propagated."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_type_has_null.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="ref_type_has_null.py",
extra_args=["--use-union-operator"],
)
def test_main_jsonschema_object_has_one_of(output_file: Path) -> None:
"""Test object with oneOf constraint."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "object_has_one_of.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="object_has_one_of.py",
)
def test_main_jsonschema_oneof_const_enum(output_file: Path) -> None:
"""Test oneOf with const values generates enum (issue #1925)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum.py",
)
def test_main_jsonschema_oneof_const_enum_nullable(output_file: Path) -> None:
"""Test nullable oneOf with const values generates optional enum."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum_nullable.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_nullable.py",
)
def test_main_jsonschema_oneof_const_enum_nested(output_file: Path) -> None:
"""Test nested oneOf with const values in properties and array items."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum_nested.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_nested.py",
)
@pytest.mark.cli_doc(
options=["--enum-field-as-literal"],
option_description="""Generate Literal types instead of Enums for fields with enumerated values.
The --enum-field-as-literal option replaces Enum classes with Literal types for
fields that have a fixed set of allowed values. Use 'all' to convert all enum
fields, or 'one' to only convert enums with a single value. This produces more
concise type hints and avoids creating Enum classes when not needed.""",
input_schema="jsonschema/oneof_const_enum_nested.yaml",
cli_args=["--enum-field-as-literal", "all"],
golden_output="main/jsonschema/oneof_const_enum_nested_literal.py",
)
def test_main_jsonschema_oneof_const_enum_nested_literal(output_file: Path) -> None:
"""Generate Literal types instead of Enums for fields with enumerated values.
The --enum-field-as-literal option replaces Enum classes with Literal types for
fields that have a fixed set of allowed values. Use 'all' to convert all enum
fields, or 'one' to only convert enums with a single value. This produces more
concise type hints and avoids creating Enum classes when not needed.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum_nested.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_nested_literal.py",
extra_args=["--enum-field-as-literal", "all"],
)
def test_main_jsonschema_oneof_const_enum_int(output_file: Path) -> None:
"""Test oneOf with integer const values generates IntEnum."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum_int.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_int.py",
)
def test_main_jsonschema_oneof_const_enum_type_list(output_file: Path) -> None:
"""Test oneOf with const values and type list (nullable)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum_type_list.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_type_list.py",
)
def test_main_jsonschema_oneof_const_enum_literal(output_file: Path) -> None:
"""Test oneOf with const values as Literal type."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_literal.py",
extra_args=["--enum-field-as-literal", "all"],
)
def test_main_jsonschema_oneof_const_enum_infer_type(output_file: Path) -> None:
"""Test oneOf with const values and inferred type."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum_infer_type.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_infer_type.py",
)
def test_main_jsonschema_oneof_const_enum_bool(output_file: Path) -> None:
"""Test oneOf with boolean const values."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum_bool.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_bool.py",
)
def test_main_jsonschema_oneof_const_enum_float(output_file: Path) -> None:
"""Test oneOf with float const values."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum_float.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_float.py",
)
def test_main_jsonschema_anyof_const_enum_nested(output_file: Path) -> None:
"""Test nested anyOf with const values in properties and array items."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "anyof_const_enum_nested.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="anyof_const_enum_nested.py",
)
def test_main_jsonschema_anyof_const_enum_nested_literal(output_file: Path) -> None:
"""Test nested anyOf const with --enum-field-as-literal all."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "anyof_const_enum_nested.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="anyof_const_enum_nested_literal.py",
extra_args=["--enum-field-as-literal", "all"],
)
def test_main_jsonschema_oneof_const_mixed_with_ref(output_file: Path) -> None:
"""Test oneOf with mixed const and $ref falls back to Union."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_mixed_with_ref.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_mixed_with_ref.py",
)
def test_main_jsonschema_oneof_const_with_properties(output_file: Path) -> None:
"""Test oneOf with const and properties falls back to Union."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_with_properties.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_with_properties.py",
)
def test_main_jsonschema_oneof_const_enum_type_list_no_null(output_file: Path) -> None:
"""Test oneOf const with type list without null."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum_type_list_no_null.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_type_list_no_null.py",
)
def test_main_jsonschema_oneof_const_enum_object(output_file: Path) -> None:
"""Test oneOf with object const values for type inference coverage."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "oneof_const_enum_object.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="oneof_const_enum_object.py",
)
def test_main_jsonschema_json_pointer_array(output_file: Path) -> None:
"""Test JSON pointer with arrays."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "json_pointer_array.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="json_pointer_array.py",
)
@pytest.mark.filterwarnings("error")
def test_main_disable_warnings_config(capsys: pytest.CaptureFixture[str], output_file: Path) -> None:
"""Test disable warnings configuration."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "person.json",
output_path=output_file,
capsys=capsys,
assert_no_stderr=True,
input_file_type="jsonschema",
extra_args=[
"--use-union-operator",
"--target-python-version",
f"3.{MIN_VERSION}",
"--disable-warnings",
],
)
@pytest.mark.cli_doc(
options=["--disable-warnings"],
option_description="""Suppress warning messages during code generation.
The --disable-warnings option silences all warning messages that the generator
might emit during processing (e.g., about unsupported features, ambiguous schemas,
or potential issues). Useful for clean output in CI/CD pipelines.""",
input_schema="jsonschema/all_of_with_object.json",
cli_args=["--disable-warnings"],
golden_output="main/jsonschema/all_of_with_object.py",
)
@pytest.mark.filterwarnings("error")
def test_main_disable_warnings(capsys: pytest.CaptureFixture[str], output_file: Path) -> None:
"""Suppress warning messages during code generation.
The --disable-warnings option silences all warning messages that the generator
might emit during processing (e.g., about unsupported features, ambiguous schemas,
or potential issues). Useful for clean output in CI/CD pipelines.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "all_of_with_object.json",
output_path=output_file,
capsys=capsys,
assert_no_stderr=True,
input_file_type="jsonschema",
extra_args=["--disable-warnings"],
)
@LEGACY_BLACK_SKIP
def test_main_jsonschema_pattern_properties_by_reference(output_file: Path) -> None:
"""Test pattern properties by reference."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pattern_properties_by_reference.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="pattern_properties_by_reference.py",
)
def test_main_jsonschema_copy_deep_pattern_properties(output_file: Path) -> None:
"""Test copy_deep properly preserves dict_key from patternProperties during allOf inheritance."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "copy_deep_pattern_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="copy_deep_pattern_properties.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--read-only-write-only-model-type",
"all",
],
)
def test_main_jsonschema_pattern_properties_boolean(output_file: Path) -> None:
"""Test patternProperties with boolean values (true/false) as allowed in JSON Schema 2020-12."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pattern_properties_boolean.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="pattern_properties_boolean.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_pattern_properties_merge(output_file: Path) -> None:
"""Test merging multiple patternProperties with same value type into single regex pattern."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pattern_properties_merge.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="pattern_properties_merge.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_pattern_properties_all_false(output_file: Path) -> None:
"""Test patternProperties with all false values are ignored."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "pattern_properties_all_false.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="pattern_properties_all_false.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_property_names_pattern(output_file: Path) -> None:
"""Test propertyNames with pattern constraint generates dict with constr key."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "property_names_pattern.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="property_names_pattern.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_property_names_pattern_field_constraints(output_file: Path) -> None:
"""Test propertyNames pattern with field_constraints preserves constr key."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "property_names_pattern.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="property_names_pattern_field_constraints.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-constraints",
],
)
def test_main_jsonschema_property_names_enum(output_file: Path) -> None:
"""Test propertyNames with enum constraint generates dict with Literal key."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "property_names_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="property_names_enum.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_property_names_min_max_length(output_file: Path) -> None:
"""Test propertyNames with minLength/maxLength constraints generates dict with constr key."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "property_names_min_max_length.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="property_names_min_max_length.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_property_names_no_additional(output_file: Path) -> None:
"""Test propertyNames without additionalProperties generates dict with Any value type."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "property_names_no_additional.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="property_names_no_additional.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_property_names_nested(output_file: Path) -> None:
"""Test propertyNames in nested object property."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "property_names_nested.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="property_names_nested.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_property_names_enum_integers(output_file: Path) -> None:
"""Test propertyNames with enum of integers only falls back to str key."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "property_names_enum_integers.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="property_names_enum_integers.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_property_names_allof_ref(output_file: Path) -> None:
"""Test propertyNames in allOf with $ref."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "property_names_allof_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="property_names_allof_ref.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_property_names_ref_enum(output_file: Path) -> None:
"""Test propertyNames with $ref to enum definition uses enum type as dict key."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "property_names_ref_enum.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="property_names_ref_enum.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_property_names_anyof_ref(output_file: Path) -> None:
"""Test propertyNames with anyOf containing $refs uses union of enum types as dict key."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "property_names_anyof_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="property_names_anyof_ref.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_dataclass_field(output_file: Path) -> None:
"""Test dataclass field generation."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "user.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--output-model-type", "dataclasses.dataclass"],
)
def test_main_dataclass_deprecated_model(output_file: Path) -> None:
"""Test dataclass generation with deprecated schema metadata."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "deprecated_dataclass.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="deprecated_dataclass.py",
extra_args=["--output-model-type", "dataclasses.dataclass"],
)
def test_main_dataclass_deprecated_model_preserves_existing_decorator(output_file: Path) -> None:
"""Test deprecated dataclass generation keeps the import with an existing decorator."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "deprecated_dataclass.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="deprecated_dataclass.py",
extra_args=[
"--output-model-type",
"dataclasses.dataclass",
"--class-decorators",
"@deprecated('LegacyUser is deprecated.')",
],
)
def test_main_dataclass_deprecated_model_with_other_decorator(output_file: Path) -> None:
"""Test deprecated dataclass generation adds deprecation alongside other decorators."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "deprecated_dataclass.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="deprecated_dataclass_with_other_decorator.py",
extra_args=[
"--output-model-type",
"dataclasses.dataclass",
"--class-decorators",
"@some_decorator",
"--additional-imports",
"some_module.some_decorator",
],
)
def test_main_pydantic_v2_dataclass_deprecated_model(output_file: Path) -> None:
"""Test pydantic v2 dataclass generation with deprecated schema metadata."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "deprecated_dataclass.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="deprecated_pydantic_v2_dataclass.py",
extra_args=["--output-model-type", "pydantic_v2.dataclass"],
)
def test_main_pydantic_v2_dataclass_deprecated_model_with_other_decorator(output_file: Path) -> None:
"""Test pydantic v2 dataclass generation adds deprecation alongside other decorators."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "deprecated_dataclass.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="deprecated_pydantic_v2_dataclass_with_other_decorator.py",
extra_args=[
"--output-model-type",
"pydantic_v2.dataclass",
"--class-decorators",
"@some_decorator",
"--additional-imports",
"some_module.some_decorator",
],
)
@pytest.mark.skipif(
not is_supported_in_black(PythonVersion.PY_312),
reason="Black does not support Python 3.12",
)
def test_main_dataclass_field_py312(output_file: Path) -> None:
"""Test dataclass field generation with Python 3.12 type statement."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "user.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--output-model-type",
"dataclasses.dataclass",
"--target-python-version",
"3.12",
],
)
def test_main_jsonschema_enum_root_literal(output_file: Path) -> None:
"""Test enum root with literal type."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "enum_in_root" / "enum_in_root.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_in_enum.py",
extra_args=[
"--use-schema-description",
"--use-title-as-name",
"--field-constraints",
"--target-python-version",
"3.10",
"--allow-population-by-field-name",
"--strip-default-none",
"--use-default",
"--enum-field-as-literal",
"all",
"--snake-case-field",
"--collapse-root-models",
],
)
def test_main_nullable_any_of(output_file: Path) -> None:
"""Test nullable anyOf schemas."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nullable_any_of.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--field-constraints"],
)
def test_main_nullable_any_of_use_union_operator(output_file: Path) -> None:
"""Test nullable anyOf with union operator."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nullable_any_of.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--field-constraints", "--use-union-operator"],
)
def test_main_nested_all_of(output_file: Path) -> None:
"""Test nested allOf schemas."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nested_all_of.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
def test_main_all_of_any_of(output_dir: Path) -> None:
"""Test combination of allOf and anyOf."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "all_of_any_of",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "all_of_any_of",
input_file_type="jsonschema",
)
@pytest.mark.cli_doc(
options=["--use-double-quotes"],
option_description="""Use double quotes for string literals in generated code.
The --use-double-quotes option formats all string literals in the generated
Python code with double quotes instead of the default single quotes. This
helps maintain consistency with codebases that prefer double-quote formatting.""",
input_schema="jsonschema/all_of_any_of_base_class_ref.json",
cli_args=["--use-double-quotes"],
golden_output="main/jsonschema/all_of_any_of_base_class_ref.py",
)
def test_main_all_of_any_of_base_class_ref(output_file: Path) -> None:
"""Use double quotes for string literals in generated code.
The --use-double-quotes option formats all string literals in the generated
Python code with double quotes instead of the default single quotes. This
helps maintain consistency with codebases that prefer double-quote formatting.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "all_of_any_of_base_class_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--snake-case-field", "--use-double-quotes", "--reuse-model"],
)
def test_main_all_of_one_of(output_dir: Path) -> None:
"""Test combination of allOf and oneOf."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "all_of_one_of",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "all_of_one_of",
input_file_type="jsonschema",
)
def test_main_null(output_file: Path) -> None:
"""Test null type handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "null.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.skipif(
version.parse(black.__version__) < version.parse("23.3.0"),
reason="Require Black version 23.3.0 or later ",
)
def test_main_typed_dict_special_field_name_with_inheritance_model(output_file: Path) -> None:
"""Test TypedDict special field names with inheritance."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "special_field_name_with_inheritance_model.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict", "--target-python-version", "3.11"],
)
@pytest.mark.skipif(
version.parse(black.__version__) < version.parse("23.3.0"),
reason="Require Black version 23.3.0 or later ",
)
def test_main_typed_dict_not_required_nullable(output_file: Path) -> None:
"""Test main function writing to TypedDict, with combos of Optional/NotRequired."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "not_required_nullable.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict", "--target-python-version", "3.11"],
)
def test_main_typed_dict_const(output_file: Path) -> None:
"""Test main function writing to TypedDict with const fields."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "const.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict", "--target-python-version", "3.10"],
)
@pytest.mark.skipif(
black.__version__.split(".")[0] < "24",
reason="Installed black doesn't support the new style",
)
def test_main_typed_dict_additional_properties(output_file: Path) -> None:
"""Test main function writing to TypedDict with additional properties, and no other fields."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "string_dict.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="typed_dict_with_only_additional_properties.py",
extra_args=["--output-model-type", "typing.TypedDict", "--target-python-version", "3.11"],
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "22",
reason="Installed black doesn't support Python version 3.11",
)
def test_main_typed_dict_enum_field_as_literal_none(output_file: Path) -> None:
"""Test TypedDict with enum_field_as_literal=none."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "enum_literal_typed_dict.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="typed_dict_enum_literal_none.py",
extra_args=[
"--output-model-type",
"typing.TypedDict",
"--enum-field-as-literal",
"none",
"--target-python-version",
"3.11",
],
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "22",
reason="Installed black doesn't support Python version 3.11",
)
def test_main_typed_dict_enum_field_as_literal_one(output_file: Path) -> None:
"""Test TypedDict with enum_field_as_literal=one."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "enum_literal_typed_dict.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="typed_dict_enum_literal_one.py",
extra_args=[
"--output-model-type",
"typing.TypedDict",
"--enum-field-as-literal",
"one",
"--target-python-version",
"3.11",
],
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "22",
reason="Installed black doesn't support Python version 3.11",
)
def test_main_typed_dict_enum_field_as_literal_all(output_file: Path) -> None:
"""Test TypedDict with enum_field_as_literal=all."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "enum_literal_typed_dict.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="typed_dict_enum_literal_all.py",
extra_args=[
"--output-model-type",
"typing.TypedDict",
"--enum-field-as-literal",
"all",
"--target-python-version",
"3.11",
],
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "22",
reason="Installed black doesn't support Python version 3.11",
)
def test_main_typed_dict_nullable_enum_literal(output_file: Path) -> None:
"""Test TypedDict with nullable enum literals generates | None correctly."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nullable_enum_literal_typed_dict.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="typed_dict_nullable_enum_literal.py",
extra_args=[
"--output-model-type",
"typing.TypedDict",
"--target-python-version",
"3.11",
],
)
@pytest.mark.cli_doc(
options=["--use-closed-typed-dict"],
option_description="""Generate TypedDict with PEP 728 closed/extra_items (default: enabled).
When enabled (default), generates TypedDict with PEP 728 `closed=True` or `extra_items`
parameters based on `additionalProperties` constraints in the schema.""",
input_schema="jsonschema/typed_dict_closed.json",
cli_args=["--output-model-type", "typing.TypedDict", "--use-closed-typed-dict"],
golden_output="jsonschema/typed_dict_closed.py",
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "22",
reason="Installed black doesn't support Python version 3.10",
)
def test_main_typed_dict_closed(output_file: Path) -> None:
"""Test TypedDict with additionalProperties: false generates closed=True (PEP 728)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "typed_dict_closed.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="typed_dict_closed.py",
extra_args=[
"--output-model-type",
"typing.TypedDict",
"--target-python-version",
"3.10",
],
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "22",
reason="Installed black doesn't support Python version 3.10",
)
def test_main_typed_dict_extra_items(output_file: Path) -> None:
"""Test TypedDict with additionalProperties type generates extra_items (PEP 728)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "typed_dict_extra_items.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="typed_dict_extra_items.py",
extra_args=[
"--output-model-type",
"typing.TypedDict",
"--target-python-version",
"3.10",
],
)
@pytest.mark.cli_doc(
options=["--no-use-closed-typed-dict"],
option_description="""Disable PEP 728 TypedDict closed/extra_items generation.
Use this option for compatibility with type checkers that don't yet support PEP 728
(e.g., mypy). TypedDict will be generated without `closed=True` or `extra_items`.""",
input_schema="jsonschema/typed_dict_closed.json",
cli_args=["--output-model-type", "typing.TypedDict", "--no-use-closed-typed-dict"],
golden_output="jsonschema/typed_dict_no_closed.py",
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "22",
reason="Installed black doesn't support Python version 3.10",
)
def test_main_typed_dict_no_closed(output_file: Path) -> None:
"""Test --no-use-closed-typed-dict disables PEP 728 closed/extra_items generation."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "typed_dict_closed.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="typed_dict_no_closed.py",
extra_args=[
"--output-model-type",
"typing.TypedDict",
"--target-python-version",
"3.10",
"--no-use-closed-typed-dict",
],
)
@pytest.mark.cli_doc(
options=["--enum-field-as-literal-map"],
option_description="""Override enum/literal generation per-field via JSON mapping.
The `--enum-field-as-literal-map` option allows per-field control over whether
to generate Literal types or Enum classes. Overrides `--enum-field-as-literal`.""",
input_schema="jsonschema/enum_field_as_literal_map.json",
cli_args=["--enum-field-as-literal-map", '{"status": "literal"}'],
golden_output="jsonschema/enum_field_as_literal_map.py",
)
def test_main_enum_field_as_literal_map(output_file: Path) -> None:
"""Override enum/literal generation per-field via JSON mapping.
The `--enum-field-as-literal-map` option allows per-field control over whether
to generate Literal types or Enum classes. Overrides `--enum-field-as-literal`.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "enum_field_as_literal_map.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="enum_field_as_literal_map.py",
extra_args=[
"--enum-field-as-literal-map",
'{"status": "literal"}',
],
)
def test_main_enum_field_as_literal_map_override_global(output_file: Path) -> None:
"""Test --enum-field-as-literal-map overrides global --enum-field-as-literal."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "enum_field_as_literal_map.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="enum_field_as_literal_map_override.py",
extra_args=[
"--enum-field-as-literal",
"all",
"--enum-field-as-literal-map",
'{"priority": "enum"}',
],
)
def test_main_x_enum_field_as_literal(output_file: Path) -> None:
"""Test x-enum-field-as-literal schema extension for per-field control."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_enum_field_as_literal.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="x_enum_field_as_literal.py",
)
def test_main_dataclass_const(output_file: Path) -> None:
"""Test main function writing to dataclass with const fields."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "const.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "dataclasses.dataclass", "--target-python-version", "3.10"],
)
@pytest.mark.parametrize(
("output_model", "expected_output"),
[
(
"pydantic_v2.BaseModel",
"discriminator_literals.py",
),
(
"msgspec.Struct",
"discriminator_literals_msgspec.py",
),
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 24,
reason="Installed black doesn't support the new style",
)
def test_main_jsonschema_discriminator_literals(
output_model: str, expected_output: str, min_version: str, output_file: Path
) -> None:
"""Test discriminator with literal types."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_literals.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=["--output-model-type", output_model, "--target-python-version", min_version],
)
@pytest.mark.parametrize(
("output_model", "expected_output"),
[
(
"pydantic_v2.BaseModel",
"prefix_items.py",
),
(
"msgspec.Struct",
"prefix_items_msgspec.py",
),
],
)
@freeze_time("2019-07-26")
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 24,
reason="Installed black doesn't support the new style",
)
def test_main_jsonschema_prefix_items(
output_model: str, expected_output: str, min_version: str, output_file: Path
) -> None:
"""Test prefix items handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "prefix_items.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=["--output-model-type", output_model, "--target-python-version", min_version],
)
@freeze_time("2019-07-26")
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 24,
reason="Installed black doesn't support the new style",
)
def test_main_jsonschema_prefix_items_no_tuple(min_version: str, output_file: Path) -> None:
"""Test prefix items with minItems != maxItems falls back to list."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "prefix_items_no_tuple.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="prefix_items_no_tuple.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--target-python-version", min_version],
)
@freeze_time("2019-07-26")
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 24,
reason="Installed black doesn't support the new style",
)
@pytest.mark.cli_doc(
options=["--use-tuple-for-fixed-items"],
option_description="""Generate tuple types for arrays with items array syntax.
When `--use-tuple-for-fixed-items` is enabled and an array has `items` as an array
with `minItems == maxItems == len(items)`, generate a tuple type instead of a list.""",
input_schema="jsonschema/items_array_tuple.json",
cli_args=["--use-tuple-for-fixed-items"],
golden_output="jsonschema/items_array_tuple.py",
)
def test_main_jsonschema_items_array_tuple(min_version: str, output_file: Path) -> None:
"""Generate tuple types for arrays with items array syntax.
When `--use-tuple-for-fixed-items` is enabled and an array has `items` as an array
with `minItems == maxItems == len(items)`, generate a tuple type instead of a list.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "items_array_tuple.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="items_array_tuple.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-python-version",
min_version,
"--use-tuple-for-fixed-items",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 24,
reason="Installed black doesn't support the new style",
)
def test_main_jsonschema_discriminator_literals_with_no_mapping(min_version: str, output_file: Path) -> None:
"""Test discriminator literals without mapping."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_no_mapping.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="discriminator_no_mapping.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--target-python-version", min_version],
)
@pytest.mark.parametrize(
("output_model", "expected_output"),
[
(
"pydantic_v2.BaseModel",
"discriminator_with_external_reference.py",
),
pytest.param(
"msgspec.Struct",
"discriminator_with_external_reference_msgspec.py",
marks=MSGSPEC_LEGACY_BLACK_SKIP,
),
],
)
def test_main_jsonschema_external_discriminator(
output_model: str, expected_output: str, min_version: str, output_file: Path
) -> None:
"""Test external discriminator references."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_with_external_reference" / "inner_folder" / "schema.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=["--output-model-type", output_model, "--target-python-version", min_version],
)
@pytest.mark.parametrize(
("output_model", "expected_output"),
[
pytest.param(
"msgspec.Struct",
"discriminator_with_external_references_folder_msgspec",
marks=MSGSPEC_LEGACY_BLACK_SKIP,
),
],
)
def test_main_jsonschema_external_discriminator_folder(
output_model: str, expected_output: str, min_version: str, output_dir: Path
) -> None:
"""Test external discriminator in folder structure."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_with_external_reference",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / expected_output,
extra_args=[
"--output-model-type",
output_model,
"--target-python-version",
min_version,
],
)
def test_main_duplicate_field_constraints(output_dir: Path) -> None:
"""Test duplicate field constraint handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "duplicate_field_constraints",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "duplicate_field_constraints",
input_file_type="jsonschema",
extra_args=[
"--collapse-root-models",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "19",
reason="Installed black doesn't support the old style",
)
def test_main_duplicate_field_constraints_msgspec(min_version: str, output_dir: Path) -> None:
"""Test duplicate field constraints with msgspec."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "duplicate_field_constraints",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "duplicate_field_constraints_msgspec",
input_file_type="jsonschema",
extra_args=[
"--output-model-type",
"msgspec.Struct",
"--target-python-version",
min_version,
],
)
def test_main_dataclass_field_defs(output_file: Path) -> None:
"""Test dataclass field definitions."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "user_defs.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="dataclass_field.py",
extra_args=["--output-model-type", "dataclasses.dataclass"],
transform=lambda s: s.replace("filename: user_defs.json", "filename: user.json"),
)
def test_main_dataclass_default(output_file: Path) -> None:
"""Test dataclass default values."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "user_default.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="dataclass_field_default.py",
extra_args=["--output-model-type", "dataclasses.dataclass"],
)
def test_main_all_of_ref_self(output_file: Path) -> None:
"""Test allOf with self-reference."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "all_of_ref_self.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.skipif(
black.__version__.split(".")[0] == "19",
reason="Installed black doesn't support the old style",
)
def test_main_array_field_constraints(output_file: Path) -> None:
"""Test array field constraints."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "array_field_constraints.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--field-constraints"],
)
def test_all_of_use_default(output_file: Path) -> None:
"""Test allOf with use-default option."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "all_of_default.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--use-default"],
)
def test_main_root_one_of(output_dir: Path) -> None:
"""Test root-level oneOf schemas."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_one_of",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "root_one_of",
input_file_type="jsonschema",
)
def test_one_of_with_sub_schema_array_item(output_file: Path) -> None:
"""Test oneOf with sub-schema array items."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "one_of_with_sub_schema_array_item.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
def test_main_jsonschema_with_custom_formatters(output_file: Path, tmp_path: Path) -> None:
"""Test custom formatter integration."""
formatter_config = {
"license_file": str(Path(__file__).parent.parent.parent / "data/python/custom_formatters/license_example.txt")
}
formatter_config_path = tmp_path / "formatter_config"
formatter_config_path.write_text(json.dumps(formatter_config))
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "person.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="custom_formatters.py",
extra_args=[
"--custom-formatters",
"tests.data.python.custom_formatters.add_license",
"--custom-formatters-kwargs",
str(formatter_config_path),
],
)
def test_main_imports_correct(output_dir: Path) -> None:
"""Test correct import generation."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "imports_correct",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "imports_correct",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.parametrize(
("output_model", "expected_output"),
[
(
"pydantic_v2.BaseModel",
"duration_pydantic_v2.py",
),
(
"msgspec.Struct",
"duration_msgspec.py",
),
],
)
def test_main_jsonschema_duration(output_model: str, expected_output: str, min_version: str, output_file: Path) -> None:
"""Test duration type handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "duration.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=["--output-model-type", output_model, "--target-python-version", min_version],
)
@pytest.mark.parametrize(
("output_model", "expected_output"),
[
(
"pydantic_v2.BaseModel",
"time_delta_pydantic_v2.py",
),
(
"msgspec.Struct",
"time_delta_msgspec.py",
),
],
)
def test_main_jsonschema_time_delta(
output_model: str, expected_output: str, min_version: str, output_file: Path
) -> None:
"""Test time-delta type handling for number format."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "time_delta.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=["--output-model-type", output_model, "--target-python-version", min_version],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 24,
reason="Installed black doesn't support the new style",
)
def test_main_jsonschema_keyword_only_msgspec(min_version: str, output_file: Path) -> None:
"""Test msgspec keyword-only arguments."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_literals.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="discriminator_literals_msgspec_keyword_only.py",
extra_args=[
"--output-model-type",
"msgspec.Struct",
"--keyword-only",
"--target-python-version",
min_version,
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 24,
reason="Installed black doesn't support the new style",
)
def test_main_jsonschema_keyword_only_msgspec_with_extra_data(min_version: str, output_file: Path) -> None:
"""Test msgspec keyword-only with extra data."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_literals.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="discriminator_literals_msgspec_keyword_only_omit_defaults.py",
extra_args=[
"--output-model-type",
"msgspec.Struct",
"--keyword-only",
"--target-python-version",
min_version,
"--extra-template-data",
str(JSON_SCHEMA_DATA_PATH / "extra_data_msgspec.json"),
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 24,
reason="Installed black doesn't support the new style",
)
def test_main_jsonschema_openapi_keyword_only_msgspec_with_extra_data(tmp_path: Path) -> None:
"""Test OpenAPI msgspec keyword-only with extra data."""
extra_data = json.loads((JSON_SCHEMA_DATA_PATH / "extra_data_msgspec.json").read_text())
output_file: Path = tmp_path / "output.py"
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_literals.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="discriminator_literals_msgspec_keyword_only_omit_defaults.py",
output_model_type=DataModelType.MsgspecStruct,
keyword_only=True,
target_python_version=PythonVersionMin,
extra_template_data=defaultdict(dict, extra_data),
# Following values are implied by `msgspec.Struct` in the CLI
use_annotated=True,
field_constraints=True,
)
@MSGSPEC_LEGACY_BLACK_SKIP
def test_main_msgspec_discriminator_with_type_string(output_file: Path) -> None:
"""Test msgspec Struct generation with discriminator using type: string + const."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_with_type_string.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="discriminator_with_type_string_msgspec.py",
extra_args=[
"--output-model-type",
"msgspec.Struct",
"--target-python-version",
"3.10",
],
)
@MSGSPEC_LEGACY_BLACK_SKIP
def test_main_msgspec_discriminator_with_meta(output_file: Path) -> None:
"""Test msgspec Struct generation with discriminator ClassVar having Meta constraints."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_with_meta_msgspec.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="discriminator_with_meta_msgspec.py",
extra_args=[
"--output-model-type",
"msgspec.Struct",
"--target-python-version",
"3.10",
],
)
@MSGSPEC_LEGACY_BLACK_SKIP
def test_main_msgspec_discriminator_without_annotated(output_file: Path) -> None:
"""Test msgspec Struct discriminator generates ClassVar even without use_annotated."""
run_generate_file_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_with_type_string.json",
output_path=output_file,
input_file_type=InputFileType.JsonSchema,
assert_func=assert_file_content,
expected_file="discriminator_with_type_string_msgspec_no_annotated.py",
output_model_type=DataModelType.MsgspecStruct,
target_python_version=PythonVersion.PY_310,
use_annotated=False,
)
@MSGSPEC_LEGACY_BLACK_SKIP
def test_main_msgspec_null_field(output_file: Path) -> None:
"""Test msgspec Struct generation with null type fields."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "msgspec_null_field.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--output-model-type",
"msgspec.Struct",
"--use-union-operator",
"--target-python-version",
"3.10",
],
)
@MSGSPEC_LEGACY_BLACK_SKIP
def test_main_msgspec_falsy_defaults(output_file: Path) -> None:
"""Test msgspec Struct generation preserves falsy default values (0, '', False)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "msgspec_falsy_defaults.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--output-model-type",
"msgspec.Struct",
"--use-union-operator",
"--target-python-version",
"3.10",
],
)
def test_main_invalid_import_name(output_dir: Path) -> None:
"""Test invalid import name handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "invalid_import_name",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "invalid_import_name",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_alias_import_alias(output_dir: Path) -> None:
"""Ensure imports with aliases are retained after cleanup."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "alias_import_alias",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "alias_import_alias",
)
def test_main_jsonschema_field_has_same_name(output_file: Path) -> None:
"""Test field with same name as parent."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_has_same_name.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_has_same_name_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
def test_main_jsonschema_field_has_same_name_rename_type(output_file: Path) -> None:
"""Test field type collision with rename-type strategy."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_has_same_name.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_has_same_name_rename_type.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-type-collision-strategy",
"rename-type",
],
)
@pytest.mark.cli_doc(
options=["--field-type-collision-strategy"],
option_description="""Rename type class instead of field when names collide (Pydantic v2 only).
The `--field-type-collision-strategy` flag controls how field name and type name
collisions are resolved. With `rename-type`, the type class is renamed with a suffix
to preserve the original field name, instead of renaming the field and adding an alias.""",
input_schema="jsonschema/field_has_same_name.json",
cli_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-type-collision-strategy",
"rename-type",
],
golden_output="jsonschema/field_has_same_name_rename_type.py",
)
def test_main_jsonschema_field_has_same_name_rename_type_cli_doc(output_file: Path) -> None:
"""Rename type class instead of field when names collide (Pydantic v2 only).
The `--field-type-collision-strategy` flag controls how field name and type name
collisions are resolved. With `rename-type`, the type class is renamed with a suffix
to preserve the original field name, instead of renaming the field and adding an alias.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_has_same_name.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_has_same_name_rename_type.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-type-collision-strategy",
"rename-type",
],
)
def test_main_jsonschema_field_type_collision_rename_type_double(output_file: Path) -> None:
"""Test field type collision with rename-type strategy when schema has existing _1 suffix."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_type_collision_rename_type_double.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_type_collision_rename_type_double.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-type-collision-strategy",
"rename-type",
],
)
@pytest.mark.benchmark
def test_main_jsonschema_required_and_any_of_required(output_file: Path) -> None:
"""Test required field with anyOf required."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "required_and_any_of_required.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="required_and_any_of_required.py",
)
def test_main_json_pointer_escaped_segments(tmp_path: Path) -> None:
"""Test JSON pointer with escaped segments."""
schema = {
"definitions": {
"foo/bar": {"type": "object", "properties": {"value": {"type": "string"}}},
"baz~qux": {"type": "object", "properties": {"value": {"type": "integer"}}},
},
"properties": {
"foo_bar": {"$ref": "#/definitions/foo~1bar"},
"baz_qux": {"$ref": "#/definitions/baz~0qux"},
},
"type": "object",
}
expected = (
"# generated by datamodel-codegen:\n"
"# filename: input.json\n"
"# timestamp: 2019-07-26T00:00:00+00:00\n\n"
"from __future__ import annotations\n\n"
"from pydantic import BaseModel\n\n"
"class FooBar(BaseModel):\n value: str | None = None\n\n"
"class BazQux(BaseModel):\n value: int | None = None\n\n"
"class Baz0qux(BaseModel):\n value: int | None = None\n\n"
"class Foo1bar(BaseModel):\n value: str | None = None\n\n"
"class Model(BaseModel):\n foo_bar: Foo1bar | None = None\n baz_qux: Baz0qux | None = None\n"
)
input_file = tmp_path / "input.json"
output_file = tmp_path / "output.py"
input_file.write_text(json.dumps(schema))
run_main_and_assert(
input_path=input_file,
output_path=output_file,
expected_output=expected,
input_file_type="jsonschema",
ignore_whitespace=True,
)
def test_main_json_pointer_percent_encoded_segments(tmp_path: Path) -> None:
"""Test JSON pointer with percent-encoded segments."""
schema = {
"definitions": {
"foo/bar": {"type": "object", "properties": {"value": {"type": "string"}}},
"baz~qux": {"type": "object", "properties": {"value": {"type": "integer"}}},
"space key": {"type": "object", "properties": {"value": {"type": "boolean"}}},
},
"properties": {
"foo_bar": {"$ref": "#/definitions/foo%2Fbar"},
"baz_qux": {"$ref": "#/definitions/baz%7Equx"},
"space_key": {"$ref": "#/definitions/space%20key"},
},
"type": "object",
}
expected = (
"# generated by datamodel-codegen:\n"
"# filename: input.json\n"
"# timestamp: 2019-07-26T00:00:00+00:00\n\n"
"from __future__ import annotations\n\n"
"from pydantic import BaseModel\n\n"
"class FooBar(BaseModel):\n value: str | None = None\n\n"
"class BazQux(BaseModel):\n value: int | None = None\n\n"
"class SpaceKey(BaseModel):\n value: bool | None = None\n\n"
"class Baz7Equx(BaseModel):\n value: int | None = None\n\n"
"class Foo2Fbar(BaseModel):\n value: str | None = None\n\n"
"class Space20key(BaseModel):\n value: bool | None = None\n\n"
"class Model(BaseModel):\n foo_bar: Foo2Fbar | None = None\n"
" baz_qux: Baz7Equx | None = None\n"
" space_key: Space20key | None = None\n"
)
input_file = tmp_path / "input.json"
output_file = tmp_path / "output.py"
input_file.write_text(json.dumps(schema))
run_main_and_assert(
input_path=input_file,
output_path=output_file,
expected_output=expected,
input_file_type="jsonschema",
ignore_whitespace=True,
)
@pytest.mark.parametrize(
("extra_fields", "output_model", "expected_output"),
[
(
"allow",
"pydantic_v2.BaseModel",
"extra_fields_v2_allow.py",
),
(
"forbid",
"pydantic_v2.BaseModel",
"extra_fields_v2_forbid.py",
),
(
"ignore",
"pydantic_v2.BaseModel",
"extra_fields_v2_ignore.py",
),
],
)
def test_main_extra_fields(extra_fields: str, output_model: str, expected_output: str, output_file: Path) -> None:
"""Test extra fields configuration."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "extra_fields.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=["--extra-fields", extra_fields, "--output-model-type", output_model],
)
@pytest.mark.cli_doc(
options=["--use-generic-base-class"],
option_description="""Generate a shared base class with model configuration to avoid repetition (DRY).""",
input_schema="jsonschema/extra_fields.json",
cli_args=["--extra-fields", "forbid", "--output-model-type", "pydantic_v2.BaseModel", "--use-generic-base-class"],
golden_output="jsonschema/use_generic_base_class.py",
)
def test_main_use_generic_base_class(output_file: Path) -> None:
"""Generate a shared base class with model configuration to avoid repetition (DRY)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "extra_fields.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class.py",
extra_args=[
"--extra-fields",
"forbid",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
],
)
def test_main_use_generic_base_class_populate_by_name(output_file: Path) -> None:
"""Test --use-generic-base-class with --allow-population-by-field-name."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_simple.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class_populate_by_name.py",
extra_args=[
"--allow-population-by-field-name",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
],
)
def test_main_use_generic_base_class_target_pydantic_v2_11(output_file: Path) -> None:
"""Test --use-generic-base-class with --target-pydantic-version 2.11."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_simple.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class_target_pydantic_v2_11.py",
extra_args=[
"--allow-population-by-field-name",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
"--target-pydantic-version",
"2.11",
],
)
def test_main_allof_list_any_inheritance(output_file: Path) -> None:
"""Test allOf with List[Any] type inheritance from parent."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "allof_list_any_inheritance.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="allof_list_any_inheritance.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_use_generic_base_class_allow_extra(output_file: Path) -> None:
"""Test --use-generic-base-class with --allow-extra-fields."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_simple.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class_allow_extra.py",
extra_args=[
"--allow-extra-fields",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
],
)
def test_main_use_generic_base_class_frozen(output_file: Path) -> None:
"""Test --use-generic-base-class with --enable-faux-immutability."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_simple.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class_frozen.py",
extra_args=[
"--enable-faux-immutability",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
],
)
def test_main_use_generic_base_class_attr_docstrings(output_file: Path) -> None:
"""Test --use-generic-base-class with --use-attribute-docstrings."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_simple.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class_attr_docstrings.py",
extra_args=[
"--use-attribute-docstrings",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
],
)
def test_main_use_generic_base_class_dataclass(output_file: Path) -> None:
"""Test --use-generic-base-class with dataclasses (no effect)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_simple.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class_dataclass.py",
extra_args=[
"--extra-fields",
"forbid",
"--output-model-type",
"dataclasses.dataclass",
"--use-generic-base-class",
],
)
def test_main_use_generic_base_class_enum_only(output_file: Path) -> None:
"""Test --use-generic-base-class with enum-only schema (no ProjectBaseModel)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_enum_only.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class_enum_only.py",
extra_args=[
"--extra-fields",
"forbid",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
],
)
def test_main_use_generic_base_class_with_inheritance(output_file: Path) -> None:
"""Test --use-generic-base-class preserves schema inheritance (allOf)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_with_inheritance.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class_with_inheritance.py",
extra_args=[
"--extra-fields",
"forbid",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
],
)
def test_main_use_generic_base_class_module_split(output_dir: Path) -> None:
"""Test --use-generic-base-class with module split mode (cross-module inheritance)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_with_inheritance.json",
output_path=output_dir,
input_file_type="jsonschema",
extra_args=[
"--extra-fields",
"forbid",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
"--module-split-mode",
"single",
],
expected_directory=EXPECTED_MAIN_PATH / "jsonschema" / "use_generic_base_class_module_split",
)
def test_main_use_generic_base_class_deep_inheritance(output_dir: Path) -> None:
"""Test --use-generic-base-class with deep inheritance chain across modules."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_deep_inheritance.json",
output_path=output_dir,
input_file_type="jsonschema",
extra_args=[
"--extra-fields",
"forbid",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
"--module-split-mode",
"single",
],
expected_directory=EXPECTED_MAIN_PATH / "jsonschema" / "use_generic_base_class_deep_inheritance",
)
def test_main_use_generic_base_class_multi_root(output_dir: Path) -> None:
"""Test --use-generic-base-class with multiple independent inheritance trees."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_multi_root.json",
output_path=output_dir,
input_file_type="jsonschema",
extra_args=[
"--extra-fields",
"forbid",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
"--module-split-mode",
"single",
],
expected_directory=EXPECTED_MAIN_PATH / "jsonschema" / "use_generic_base_class_multi_root",
)
def test_main_use_generic_base_class_circular(output_dir: Path) -> None:
"""Test --use-generic-base-class with circular references (uses _internal.py pattern)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_circular.json",
output_path=output_dir,
input_file_type="jsonschema",
extra_args=[
"--extra-fields",
"forbid",
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-base-class",
"--module-split-mode",
"single",
],
expected_directory=EXPECTED_MAIN_PATH / "jsonschema" / "use_generic_base_class_circular",
)
def test_main_use_generic_base_class_msgspec(output_file: Path) -> None:
"""Test --use-generic-base-class with msgspec.Struct."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_simple.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class_msgspec.py",
extra_args=[
"--allow-population-by-field-name",
"--enable-faux-immutability",
"--output-model-type",
"msgspec.Struct",
"--use-generic-base-class",
],
)
def test_main_use_generic_base_class_msgspec_forbid(output_file: Path) -> None:
"""Test --use-generic-base-class with msgspec.Struct and --extra-fields forbid."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_generic_base_class_simple.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_generic_base_class_msgspec_forbid.py",
extra_args=[
"--enable-faux-immutability",
"--extra-fields",
"forbid",
"--output-model-type",
"msgspec.Struct",
"--use-generic-base-class",
],
)
def test_main_jsonschema_same_name_objects(output_file: Path) -> None:
"""Test objects with same name (see issue #2460)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "same_name_objects.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="same_name_objects.py",
)
def test_main_jsonschema_forwarding_reference_collapse_root(output_dir: Path) -> None:
"""Test forwarding reference with collapsed root (see issue #1466)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "forwarding_reference",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "forwarding_reference",
input_file_type="jsonschema",
extra_args=["--collapse-root-models"],
)
@pytest.mark.cli_doc(
options=["--use-type-alias"],
option_description="""Generate TypeAlias for root models instead of wrapper classes.
The `--use-type-alias` flag configures the code generation behavior.""",
input_schema="jsonschema/type_alias.json",
cli_args=["--use-type-alias"],
golden_output="jsonschema/type_alias.py",
)
def test_main_jsonschema_type_alias(output_file: Path) -> None:
"""Generate TypeAlias for root models instead of wrapper classes.
The `--use-type-alias` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias.py",
extra_args=["--use-type-alias"],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_py312(output_file: Path) -> None:
"""Test that type statement syntax is generated for Python 3.12+ with Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_py312.py",
extra_args=[
"--use-type-alias",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.cli_doc(
options=["--use-field-description"],
option_description="""Include schema descriptions as Field docstrings.
The `--use-field-description` flag extracts the `description` property from
schema fields and includes them as docstrings or Field descriptions in the
generated models, preserving documentation from the original schema.""",
input_schema="jsonschema/type_alias.json",
cli_args=["--use-type-alias", "--use-field-description"],
golden_output="jsonschema/type_alias_with_field_description.py",
)
def test_main_jsonschema_type_alias_with_field_description(output_file: Path) -> None:
"""Include schema descriptions as Field docstrings.
The `--use-field-description` flag extracts the `description` property from
schema fields and includes them as docstrings or Field descriptions in the
generated models, preserving documentation from the original schema.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_with_field_description.py",
extra_args=["--use-type-alias", "--use-field-description"],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_with_field_description_py312(output_file: Path) -> None:
"""Test that type statement syntax is generated with field descriptions for Python 3.12+ and Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_with_field_description_py312.py",
extra_args=[
"--use-type-alias",
"--use-field-description",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_enum_literal_type_alias_default(output_file: Path) -> None:
"""Don't wrap type alias defaults in default_factory (TypeAliasType is not callable)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "enum_literal_type_alias_default.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="enum_literal_type_alias_default.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--enum-field-as-literal",
"all",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_union_default_object_ref(output_file: Path) -> None:
"""Validate $ref object-union defaults through the type alias."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_union_default_object_ref.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_union_default_object_ref.py",
extra_args=[
"--use-type-alias",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_model_default_object_ref(output_file: Path) -> None:
"""Validate model-backed type alias defaults through the alias."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_model_default_object_ref.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_model_default_object_ref.py",
extra_args=[
"--use-type-alias",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_chain_model_default_object_ref(output_file: Path) -> None:
"""Validate recursively chained model-backed aliases for structured defaults."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_chain_model_default_object_ref.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_chain_model_default_object_ref.py",
extra_args=[
"--use-type-alias",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_list_model_default_object_ref(output_file: Path) -> None:
"""Validate list-of-model type alias defaults through the alias."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_list_model_default_object_ref.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_list_model_default_object_ref.py",
extra_args=[
"--use-type-alias",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_nullable_model_default_object_ref(output_file: Path) -> None:
"""Validate nullable model-backed type alias defaults through the alias."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_nullable_model_default_object_ref.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_nullable_model_default_object_ref.py",
extra_args=[
"--use-type-alias",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_nullable_list_model_default_object_ref(output_file: Path) -> None:
"""Validate nullable list-of-model type alias defaults through the alias."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_nullable_list_model_default_object_ref.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_nullable_list_model_default_object_ref.py",
extra_args=[
"--use-type-alias",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_recursive_default_list(output_file: Path) -> None:
"""Avoid recursive alias traversal loops when checking structured defaults."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_recursive_default_list.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_recursive_default_list.py",
extra_args=[
"--use-type-alias",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_inline_union_default_object(output_file: Path) -> None:
"""Validate inline object-union defaults through the union type."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_inline_union_default_object.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
expected_file="type_alias_inline_union_default_object.py",
extra_args=[
"--use-type-alias",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_union_default_object_ref_any_of_relevant_flags(
output_file: Path,
) -> None:
"""Validate anyOf alias union defaults with the relevant type-alias flags."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_union_default_object_ref_any_of.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_union_default_object_ref_any_of.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_chain_union_default_object_ref_relevant_flags(
output_file: Path,
) -> None:
"""Validate chained alias union defaults with the relevant type-alias flags."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_chain_union_default_object_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_chain_union_default_object_ref.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_union_default_object_ref_one_of_relevant_flags(
output_file: Path,
) -> None:
"""Validate oneOf alias union defaults with the relevant type-alias flags."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_union_default_object_ref_one_of.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_union_default_object_ref_one_of.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_inline_union_default_object_one_of_relevant_flags(
output_file: Path,
) -> None:
"""Validate oneOf inline union defaults with the relevant type-alias flags."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_inline_union_default_object_one_of.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_inline_union_default_object_one_of.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_inline_union_default_object_import_collision_relevant_flags(
output_file: Path,
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""Keep TypeAdapter targets aligned after imported-name collision renames local models."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_inline_union_default_object_import_collision.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_inline_union_default_object_import_collision.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
"--type-overrides",
'{"Other.a": "my_app.B"}',
],
skip_code_validation=True,
)
_install_test_my_app(output_file.parent, monkeypatch)
validate_generated_code(output_file.read_text(encoding="utf-8"), str(output_file), do_exec=True)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_inline_union_default_object_type_override_relevant_flags(
output_file: Path,
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""Validate TypeAdapter targets after late type overrides change field types."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_inline_union_default_object_type_override.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_inline_union_default_object_type_override.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
"--type-overrides",
'{"A": "my_app.AliasA"}',
],
skip_code_validation=True,
)
_install_test_my_app(output_file.parent, monkeypatch)
validate_generated_code(output_file.read_text(encoding="utf-8"), str(output_file), do_exec=True)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_inline_union_default_object_silent_wrong_branch_relevant_flags(
output_file: Path,
) -> None:
"""Validate inline unions that would silently pick the wrong branch."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_inline_union_default_object_silent_wrong_branch.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_inline_union_default_object_silent_wrong_branch.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_inline_list_union_default_object_relevant_flags(
output_file: Path,
) -> None:
"""Validate list-of-union defaults with the relevant type-alias flags."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_inline_list_union_default_object.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_inline_list_union_default_object.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_list_union_default_object_ref_relevant_flags(
output_file: Path,
) -> None:
"""Validate aliased list-of-union defaults with the relevant type-alias flags."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_list_union_default_object_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_list_union_default_object_ref.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_inline_dict_union_default_object_relevant_flags(
output_file: Path,
) -> None:
"""Validate dict-of-union defaults with the relevant type-alias flags."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_inline_dict_union_default_object.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_inline_dict_union_default_object.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_dict_union_default_object_ref_relevant_flags(
output_file: Path,
) -> None:
"""Validate aliased dict-of-union defaults with the relevant type-alias flags."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_dict_union_default_object_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_dict_union_default_object_ref.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_union_default_object_ref_dict_alias_branch_relevant_flags(
output_file: Path,
) -> None:
"""Keep raw defaults when a plain dict union branch is hidden behind a type alias."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_union_default_object_ref_dict_alias_branch.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_union_default_object_ref_dict_alias_branch.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.skipif(
int(black.__version__.split(".")[0]) < 23,
reason="Installed black doesn't support the new 'type' statement",
)
def test_main_jsonschema_type_alias_union_default_object_ref_mixed_scalar_relevant_flags(
output_file: Path,
) -> None:
"""Validate aliased mixed scalar/model union defaults."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_union_default_object_ref_mixed_scalar.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_union_default_object_ref_mixed_scalar.py",
extra_args=[
"--use-type-alias",
"--use-annotated",
"--target-python-version",
"3.12",
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-pydantic-version",
"2.11",
],
)
@pytest.mark.cli_doc(
options=["--type-mappings"],
option_description="""Override default type mappings for schema formats.
The `--type-mappings` flag configures the code generation behavior.""",
input_schema="jsonschema/type_mappings.json",
cli_args=["--output-model-type", "pydantic_v2.BaseModel", "--type-mappings", "binary=string"],
golden_output="jsonschema/type_mappings.py",
)
def test_main_jsonschema_type_mappings(output_file: Path) -> None:
"""Override default type mappings for schema formats.
The `--type-mappings` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_mappings.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_mappings.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--type-mappings",
"binary=string",
],
)
def test_main_jsonschema_type_mappings_with_type_prefix(output_file: Path) -> None:
"""Test --type-mappings option with type+format syntax."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_mappings.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_mappings.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--type-mappings",
"string+binary=string",
],
)
def test_main_jsonschema_type_mappings_to_type_default(output_file: Path) -> None:
"""Test --type-mappings option mapping to a type's default (e.g., binary=integer)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_mappings.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_mappings_to_integer.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--type-mappings",
"binary=integer",
],
)
def test_main_jsonschema_type_mappings_to_boolean(output_file: Path) -> None:
"""Test --type-mappings option mapping to a top-level type (e.g., binary=boolean)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_mappings.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_mappings_to_boolean.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--type-mappings",
"binary=boolean",
],
)
def test_main_jsonschema_type_mappings_invalid_format(output_file: Path) -> None:
"""Test --type-mappings option with invalid format raises error."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_mappings.json",
output_path=output_file,
input_file_type="jsonschema",
expected_exit=Exit.ERROR,
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--type-mappings",
"invalid_without_equals",
],
expected_stderr_contains="Invalid type mapping format",
)
@pytest.mark.cli_doc(
options=["--reuse-scope"],
option_description="""Scope for model reuse detection (root or tree).
The `--reuse-scope` flag configures the code generation behavior.""",
input_schema="jsonschema/reuse_scope_tree",
cli_args=["--reuse-model", "--reuse-scope", "tree"],
golden_output="jsonschema/reuse_scope_tree",
)
def test_main_jsonschema_reuse_scope_tree(output_dir: Path) -> None:
"""Scope for model reuse detection (root or tree).
The `--reuse-scope` flag configures the code generation behavior.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree",
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree"],
)
def test_main_jsonschema_reuse_scope_tree_exact_imports(output_dir: Path) -> None:
"""Test --reuse-scope=tree with --use-exact-imports keeps local subclass references."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree_exact_imports",
input_file_type="jsonschema",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--reuse-model",
"--reuse-scope",
"tree",
"--use-exact-imports",
"--disable-timestamp",
],
)
def test_main_jsonschema_reuse_scope_tree_enum(output_dir: Path) -> None:
"""Test --reuse-scope=tree to deduplicate enum models across multiple files."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_enum",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree_enum",
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree"],
)
def test_main_jsonschema_reuse_scope_tree_warning(capsys: pytest.CaptureFixture[str], output_dir: Path) -> None:
"""Test warning when --reuse-scope=tree is used without --reuse-model."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree",
output_path=output_dir,
input_file_type="jsonschema",
extra_args=["--reuse-scope", "tree"],
capsys=capsys,
expected_stderr_contains="Warning: --reuse-scope=tree has no effect without --reuse-model",
)
def test_main_jsonschema_reuse_scope_tree_no_dup(output_dir: Path) -> None:
"""Test --reuse-scope=tree when there are no duplicate models."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_no_dup",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree_no_dup",
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree"],
)
def test_main_jsonschema_reuse_scope_tree_self_ref(output_dir: Path) -> None:
"""Test --reuse-scope=tree with self-referencing models."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_self_ref",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree_self_ref",
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree"],
)
def test_main_jsonschema_reuse_scope_tree_conflict(capsys: pytest.CaptureFixture[str], output_dir: Path) -> None:
"""Test --reuse-scope=tree error when schema file name conflicts with shared module."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_conflict",
output_path=output_dir,
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree"],
expected_exit=Exit.ERROR,
capsys=capsys,
expected_stderr_contains="Schema file or directory 'shared' conflicts with the shared module name",
)
def test_main_jsonschema_reuse_scope_tree_conflict_dir(capsys: pytest.CaptureFixture[str], output_dir: Path) -> None:
"""Test --reuse-scope=tree error when schema directory name conflicts with shared module."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_conflict_dir",
output_path=output_dir,
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree"],
expected_exit=Exit.ERROR,
capsys=capsys,
expected_stderr_contains="Schema file or directory 'shared' conflicts with the shared module name",
)
def test_main_jsonschema_reuse_scope_tree_no_conflict_dir(output_dir: Path) -> None:
"""Test --reuse-scope=tree does not error when shared/ dir exists but no duplicates."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_no_conflict_dir",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree_no_conflict_dir",
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree"],
)
def test_main_jsonschema_reuse_scope_tree_multi(output_dir: Path) -> None:
"""Test --reuse-scope=tree with multiple files where canonical is not in first module."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_multi",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree_multi",
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree"],
)
def test_main_jsonschema_reuse_scope_tree_branch(output_dir: Path) -> None:
"""Test --reuse-scope=tree branch coverage with duplicate in later modules."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_branch",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree_branch",
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree"],
)
def test_main_jsonschema_reuse_scope_tree_dataclass(output_dir: Path) -> None:
"""Test --reuse-scope=tree with dataclasses output type (supports inheritance)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_dataclass",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree_dataclass",
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree", "--output-model-type", "dataclasses.dataclass"],
)
def test_main_jsonschema_reuse_scope_tree_dataclass_frozen(output_dir: Path) -> None:
"""Test --reuse-scope=tree with frozen dataclasses preserves frozen in inherited models."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_dataclass",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree_dataclass_frozen",
input_file_type="jsonschema",
extra_args=[
"--reuse-model",
"--reuse-scope",
"tree",
"--output-model-type",
"dataclasses.dataclass",
"--frozen-dataclasses",
],
)
def test_main_jsonschema_reuse_scope_tree_typeddict(output_dir: Path) -> None:
"""Test --reuse-scope=tree with TypedDict output type (no inheritance, direct reference)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reuse_scope_tree_typeddict",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "reuse_scope_tree_typeddict",
input_file_type="jsonschema",
extra_args=["--reuse-model", "--reuse-scope", "tree", "--output-model-type", "typing.TypedDict"],
)
def test_main_jsonschema_empty_items_array(output_file: Path) -> None:
"""Test that arrays with empty items ({}) generate List[Any] instead of bare List."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "empty_items_array.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.cli_doc(
options=["--aliases"],
option_description="""Apply custom field and class name aliases from JSON file.
The `--aliases` option allows renaming fields and classes via a JSON mapping file,
providing fine-grained control over generated names independent of schema definitions.
Supports scoped format (ClassName.field) for hierarchical aliasing.""",
input_schema="jsonschema/hierarchical_aliases.json",
cli_args=["--aliases", "aliases/hierarchical_aliases_scoped.json"],
golden_output="jsonschema/jsonschema_hierarchical_aliases_scoped.py",
)
def test_main_jsonschema_hierarchical_aliases_scoped(output_file: Path) -> None:
"""Test hierarchical aliases with scoped format (ClassName.field)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "hierarchical_aliases.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--aliases",
str(ALIASES_DATA_PATH / "hierarchical_aliases_scoped.json"),
],
)
@pytest.mark.cli_doc(
options=["--aliases"],
option_description="""Test multiple aliases with AliasChoices for Pydantic v2.""",
input_schema="jsonschema/multiple_aliases.json",
cli_args=["--aliases", "aliases/multiple_aliases.json", "--output-model-type", "pydantic_v2.BaseModel"],
golden_output="jsonschema/multiple_aliases_pydantic_v2.py",
)
def test_main_jsonschema_multiple_aliases_pydantic_v2(output_file: Path) -> None:
"""Test multiple aliases with AliasChoices for Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "multiple_aliases.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--aliases",
str(ALIASES_DATA_PATH / "multiple_aliases.json"),
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_discriminator_multiple_aliases_pydantic_v2(output_file: Path) -> None:
"""Test discriminator with multiple aliases using AliasChoices for Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_multiple_aliases.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--aliases",
str(ALIASES_DATA_PATH / "discriminator_multiple_aliases.json"),
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_discriminator_no_literal_multiple_aliases_pydantic_v2(output_file: Path) -> None:
"""Test discriminator without literal in child models using multiple aliases for Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "discriminator_no_literal.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--aliases",
str(ALIASES_DATA_PATH / "discriminator_no_literal.json"),
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_multiple_types_with_object(output_file: Path) -> None:
"""Test multiple types in array including object with properties generates Union type."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "multiple_types_with_object.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@MSGSPEC_LEGACY_BLACK_SKIP
def test_main_jsonschema_type_alias_with_circular_ref_to_class_msgspec(min_version: str, output_file: Path) -> None:
"""Test TypeAlias with circular reference to class generates quoted forward refs."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "type_alias_with_circular_ref_to_class.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="type_alias_with_circular_ref_to_class_msgspec.py",
extra_args=[
"--output-model-type",
"msgspec.Struct",
"--target-python-version",
min_version,
],
)
def test_main_jsonschema_enum_object_values(output_file: Path) -> None:
"""Test that enum with object values uses title/name/const for member names (issue #1620)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "enum_object_values.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.cli_doc(
options=["--collapse-root-models"],
option_description="""Inline root model definitions instead of creating separate wrapper classes.
The --collapse-root-models option simplifies generated code by collapsing
root-level models (top-level type aliases) directly into their usage sites.
This eliminates unnecessary wrapper classes and produces more concise output,
especially useful when schemas define simple root types or type aliases.""",
input_schema="jsonschema/collapse_root_models_empty_union.json",
cli_args=["--collapse-root-models"],
golden_output="main/jsonschema/jsonschema_collapse_root_models_empty_union.py",
)
def test_main_jsonschema_collapse_root_models_empty_union(output_file: Path) -> None:
"""Inline root model definitions instead of creating separate wrapper classes.
The --collapse-root-models option simplifies generated code by collapsing
root-level models (top-level type aliases) directly into their usage sites.
This eliminates unnecessary wrapper classes and produces more concise output,
especially useful when schemas define simple root types or type aliases.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_empty_union.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--collapse-root-models"],
)
def test_main_jsonschema_collapse_root_models_with_optional(output_file: Path) -> None:
"""Test that collapse-root-models correctly preserves Optional import when needed."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_with_optional.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--collapse-root-models"],
)
def test_main_jsonschema_collapse_root_models_nested_reference(output_file: Path) -> None:
"""Ensure nested references inside root models still get imported when collapsing."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_nested_reference.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--collapse-root-models"],
)
@pytest.mark.cli_doc(
options=["--collapse-root-models-name-strategy"],
option_description="""Select which name to keep when collapsing root models with object references.
The --collapse-root-models-name-strategy option controls naming when collapsing
root models. 'child' keeps the inner model's name, 'parent' uses the wrapper's name.""",
input_schema="jsonschema/collapse_root_models_name_strategy_child.json",
cli_args=["--collapse-root-models", "--collapse-root-models-name-strategy", "child"],
golden_output="main/jsonschema/jsonschema_collapse_root_models_name_strategy_child.py",
related_options=["--collapse-root-models"],
)
def test_main_jsonschema_collapse_root_models_name_strategy_child(output_file: Path) -> None:
"""Select which name to keep when collapsing root models with object references.
The --collapse-root-models-name-strategy option controls naming when collapsing
root models. 'child' keeps the inner model's name, 'parent' uses the wrapper's name.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_name_strategy_child.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--collapse-root-models", "--collapse-root-models-name-strategy", "child"],
)
def test_main_jsonschema_collapse_root_models_name_strategy_parent(output_file: Path) -> None:
"""Test collapse-root-models with parent name strategy uses wrapper's name for inner model."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_name_strategy_parent.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--collapse-root-models", "--collapse-root-models-name-strategy", "parent"],
)
def test_main_jsonschema_collapse_root_models_name_strategy_requires_collapse_root_models(
output_file: Path, capsys: pytest.CaptureFixture[str]
) -> None:
"""Test that --collapse-root-models-name-strategy requires --collapse-root-models."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_name_strategy_parent.json",
output_path=output_file,
input_file_type="jsonschema",
extra_args=["--collapse-root-models-name-strategy", "parent"],
expected_exit=Exit.ERROR,
capsys=capsys,
expected_stderr_contains="--collapse-root-models-name-strategy requires --collapse-root-models",
)
def test_main_jsonschema_collapse_root_models_name_strategy_multiple_wrappers(output_file: Path) -> None:
"""Test that parent strategy warns and skips when inner model has multiple wrappers."""
with pytest.warns(UserWarning, match="Cannot apply 'parent' strategy.*multiple root models"):
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_name_strategy_multiple_wrappers.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--collapse-root-models", "--collapse-root-models-name-strategy", "parent"],
)
def test_main_jsonschema_collapse_root_models_name_strategy_direct_refs(output_file: Path) -> None:
"""Test that parent strategy warns and skips when inner model has direct references."""
with pytest.warns(UserWarning, match="Cannot apply 'parent' strategy.*directly referenced"):
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_name_strategy_direct_refs.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--collapse-root-models", "--collapse-root-models-name-strategy", "parent"],
)
def test_main_jsonschema_collapse_root_models_name_strategy_with_inheritance(output_file: Path) -> None:
"""Test collapse-root-models with parent strategy when inner model has derived classes."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_name_strategy_with_inheritance.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=["--collapse-root-models", "--collapse-root-models-name-strategy", "parent"],
)
def test_main_jsonschema_collapse_root_models_name_strategy_nested_wrappers_child(output_file: Path) -> None:
"""Test nested wrappers with child strategy - all wrappers collapsed."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_name_strategy_nested_wrappers.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="jsonschema_collapse_root_models_name_strategy_nested_wrappers_child.py",
extra_args=[
"--collapse-root-models",
"--collapse-root-models-name-strategy",
"child",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_collapse_root_models_name_strategy_nested_wrappers_parent(output_file: Path) -> None:
"""Test nested wrappers with parent strategy - partial collapse due to multiple refs."""
with pytest.warns(UserWarning, match="Cannot apply 'parent' strategy.*multiple root models"):
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_name_strategy_nested_wrappers.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="jsonschema_collapse_root_models_name_strategy_nested_wrappers_parent_v2.py",
extra_args=[
"--collapse-root-models",
"--collapse-root-models-name-strategy",
"parent",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_collapse_root_models_name_strategy_complex_child(output_file: Path) -> None:
"""Test complex schema with multiple wrappers and inheritance using child strategy."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_name_strategy_complex.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="jsonschema_collapse_root_models_name_strategy_complex_child.py",
extra_args=[
"--collapse-root-models",
"--collapse-root-models-name-strategy",
"child",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_collapse_root_models_name_strategy_complex_parent(output_file: Path) -> None:
"""Test complex schema with multiple wrappers and inheritance using parent strategy."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "collapse_root_models_name_strategy_complex.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="jsonschema_collapse_root_models_name_strategy_complex_parent.py",
extra_args=[
"--collapse-root-models",
"--collapse-root-models-name-strategy",
"parent",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_main_jsonschema_file_url_ref(tmp_path: Path) -> None:
"""Test that file:// URL $ref is resolved correctly."""
pet_schema = {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {"name": {"type": "string"}, "age": {"type": "integer"}},
"required": ["name"],
}
pet_file = tmp_path / "pet.json"
pet_file.write_text(json.dumps(pet_schema))
main_schema = {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {"pet": {"$ref": pet_file.as_uri()}},
}
main_file = tmp_path / "main.json"
main_file.write_text(json.dumps(main_schema))
expected = (
"# generated by datamodel-codegen:\n"
"# filename: main.json\n\n"
"from __future__ import annotations\n\n"
"from pydantic import BaseModel\n\n\n"
"class Pet(BaseModel):\n"
" name: str\n"
" age: int | None = None\n\n\n"
"class Model(BaseModel):\n"
" pet: Pet | None = None\n"
)
run_main_and_assert(
input_path=main_file,
output_path=tmp_path / "output.py",
input_file_type="jsonschema",
expected_output=expected,
ignore_whitespace=True,
extra_args=["--disable-timestamp"],
)
def test_main_jsonschema_file_url_ref_percent_encoded(tmp_path: Path) -> None:
"""Test that file:// URL with percent-encoded path is resolved correctly."""
dir_with_space = tmp_path / "my schemas"
dir_with_space.mkdir()
pet_schema = {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {"name": {"type": "string"}},
}
pet_file = dir_with_space / "pet.json"
pet_file.write_text(json.dumps(pet_schema))
main_schema = {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {"pet": {"$ref": pet_file.as_uri()}},
}
main_file = tmp_path / "main.json"
main_file.write_text(json.dumps(main_schema))
expected = (
"# generated by datamodel-codegen:\n"
"# filename: main.json\n\n"
"from __future__ import annotations\n\n"
"from pydantic import BaseModel\n\n\n"
"class Pet(BaseModel):\n"
" name: str | None = None\n\n\n"
"class Model(BaseModel):\n"
" pet: Pet | None = None\n"
)
run_main_and_assert(
input_path=main_file,
output_path=tmp_path / "output.py",
input_file_type="jsonschema",
expected_output=expected,
ignore_whitespace=True,
extra_args=["--disable-timestamp"],
)
@pytest.mark.benchmark
def test_main_jsonschema_root_model_default_value(output_file: Path) -> None:
"""Test RootModel default values are wrapped with type constructors."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_default_value.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_model_default_value.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-annotated",
"--set-default-enum-member",
],
)
@pytest.mark.benchmark
def test_main_jsonschema_root_model_default_value_no_annotated(output_file: Path) -> None:
"""Test RootModel default values without --use-annotated flag."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_default_value.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_model_default_value_no_annotated.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--set-default-enum-member",
],
)
@pytest.mark.benchmark
def test_main_jsonschema_root_model_default_value_branches(output_file: Path) -> None:
"""Test RootModel default value branches."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_default_value_branches.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_model_default_value_branches.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-annotated",
],
)
@pytest.mark.benchmark
def test_main_jsonschema_root_model_default_value_non_root(output_file: Path) -> None:
"""Test that non-RootModel references are not wrapped."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_default_value_non_root.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_model_default_value_non_root.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-annotated",
],
)
@pytest.mark.benchmark
def test_main_jsonschema_extras_in_oneof(output_file: Path) -> None:
"""Test that extras are preserved in oneOf/anyOf structures (Issue #2403)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "extras_in_oneof.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="extras_in_oneof.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-include-all-keys",
],
)
def test_main_jsonschema_ref_with_additional_keywords(output_dir: Path) -> None:
"""Test that $ref combined with additional keywords merges properties (Issue #2330)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_with_additional_keywords",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "ref_with_additional_keywords",
input_file_type="jsonschema",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.parametrize(
("output_model", "expected_file"),
[
("typing.TypedDict", "reserved_field_name_schema_typed_dict.py"),
("dataclasses.dataclass", "reserved_field_name_schema_dataclass.py"),
("pydantic_v2.BaseModel", "reserved_field_name_schema_pydantic.py"),
],
)
@pytest.mark.cli_doc(
options=["--output-model-type"],
option_description="""Select the output model type (Pydantic v2, Pydantic v2 dataclass,
dataclasses, TypedDict, msgspec).
The `--output-model-type` flag specifies which Python data model framework to use.
Each model type has different handling for reserved field names like 'schema':
TypedDict and dataclass preserve the name, while Pydantic renames with alias.""",
input_schema="jsonschema/reserved_field_name_schema.json",
cli_args=["--target-python-version", "3.11"],
model_outputs={
"typeddict": "main/jsonschema/reserved_field_name_schema_typed_dict.py",
"dataclass": "main/jsonschema/reserved_field_name_schema_dataclass.py",
"pydantic_v2": "main/jsonschema/reserved_field_name_schema_pydantic.py",
},
)
@pytest.mark.benchmark
@LEGACY_BLACK_SKIP
def test_main_jsonschema_reserved_field_name(output_model: str, expected_file: str, output_file: Path) -> None:
"""Test reserved field name handling across model types (Issue #1833).
This demonstrates how 'schema' field is handled:
- TypedDict: not renamed (schema is not reserved)
- dataclass: not renamed (schema is not reserved)
- Pydantic: renamed to 'schema_' with alias (BaseModel.schema conflicts)
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reserved_field_name_schema.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_file,
extra_args=[
"--output-model-type",
output_model,
"--target-python-version",
"3.11",
],
)
@pytest.mark.benchmark
@LEGACY_BLACK_SKIP
def test_main_bundled_schema_with_id_local_file(output_file: Path) -> None:
"""Test bundled schema with $id using local file input (Issue #1798)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "bundled_schema_with_id.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="bundled_schema_with_id.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.benchmark
@LEGACY_BLACK_SKIP
def test_main_bundled_schema_with_id_url(mocker: MockerFixture, output_file: Path) -> None:
"""Test bundled schema with $id using URL input produces same output as local file."""
schema_path = JSON_SCHEMA_DATA_PATH / "bundled_schema_with_id.json"
mock_response = mocker.Mock()
mock_response.text = schema_path.read_text()
httpx_get_mock = mocker.patch(
"httpx.get",
return_value=mock_response,
)
run_main_url_and_assert(
url="https://cdn.example.com/schemas/bundled_schema_with_id.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="bundled_schema_with_id.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
transform=lambda s: s.replace(
"# filename: https://cdn.example.com/schemas/bundled_schema_with_id.json",
"# filename: bundled_schema_with_id.json",
),
)
httpx_get_mock.assert_called_once_with(
"https://cdn.example.com/schemas/bundled_schema_with_id.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
)
@pytest.mark.parametrize(
("output_model", "expected_file"),
[
("pydantic_v2.BaseModel", "use_frozen_field_v2.py"),
("dataclasses.dataclass", "use_frozen_field_dataclass.py"),
],
)
@pytest.mark.cli_doc(
options=["--use-frozen-field"],
option_description="""Generate frozen (immutable) field definitions for readOnly properties.
The `--use-frozen-field` flag generates frozen field definitions:
- Pydantic v2: `Field(frozen=True)`
- Dataclasses: silently ignored (no frozen fields generated)""",
input_schema="jsonschema/use_frozen_field.json",
cli_args=["--use-frozen-field"],
model_outputs={
"pydantic_v2": "main/jsonschema/use_frozen_field_v2.py",
"dataclass": "main/jsonschema/use_frozen_field_dataclass.py",
},
)
@pytest.mark.benchmark
@LEGACY_BLACK_SKIP
def test_main_use_frozen_field(output_model: str, expected_file: str, output_file: Path) -> None:
"""Generate frozen (immutable) field definitions for readOnly properties.
The `--use-frozen-field` flag generates frozen field definitions:
- Pydantic v2: `Field(frozen=True)`
- Dataclasses: silently ignored (no frozen fields generated)
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_frozen_field.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_file,
extra_args=["--output-model-type", output_model, "--use-frozen-field"],
)
@pytest.mark.benchmark
@LEGACY_BLACK_SKIP
def test_main_use_frozen_field_no_readonly(output_file: Path) -> None:
"""Test --use-frozen-field with no readOnly fields produces no frozen fields."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "user.json", # Has no readOnly fields
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="use_frozen_field_no_readonly.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--use-frozen-field"],
)
@pytest.mark.parametrize(
("target_python_version", "expected_file"),
[
pytest.param("3.13", "use_frozen_field_typed_dict.py", marks=BLACK_PY313_SKIP),
("3.11", "use_frozen_field_typed_dict_py311.py"),
("3.10", "use_frozen_field_typed_dict_py310.py"),
],
)
@pytest.mark.cli_doc(
options=["--use-frozen-field"],
option_description="""Generate ReadOnly type hints for readOnly properties in TypedDict.
The `--use-frozen-field` flag generates ReadOnly type hints for TypedDict:
- Python 3.13+: uses `typing.ReadOnly`
- Python 3.11-3.12: uses `typing_extensions.ReadOnly`
- Python 3.10: uses `typing_extensions.ReadOnly` and `typing_extensions.NotRequired`""",
input_schema="jsonschema/use_frozen_field.json",
cli_args=["--output-model-type", "typing.TypedDict", "--use-frozen-field"],
model_outputs={
"typeddict": "main/jsonschema/use_frozen_field_typed_dict.py",
},
)
@pytest.mark.benchmark
@LEGACY_BLACK_SKIP
def test_main_use_frozen_field_typed_dict(target_python_version: str, expected_file: str, output_file: Path) -> None:
"""Generate ReadOnly type hints for readOnly properties in TypedDict.
The `--use-frozen-field` flag generates ReadOnly type hints for TypedDict:
- Python 3.13+: uses `typing.ReadOnly`
- Python 3.11-3.12: uses `typing_extensions.ReadOnly`
- Python 3.10: uses `typing_extensions.ReadOnly` and `typing_extensions.NotRequired`
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "use_frozen_field.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_file,
extra_args=[
"--output-model-type",
"typing.TypedDict",
"--use-frozen-field",
"--target-python-version",
target_python_version,
],
)
@pytest.mark.parametrize(
("output_model", "expected_file"),
[
("dataclasses.dataclass", "default_factory_nested_model_dataclass.py"),
("pydantic_v2.BaseModel", "default_factory_nested_model_pydantic_v2.py"),
("msgspec.Struct", "default_factory_nested_model_msgspec.py"),
],
)
@pytest.mark.cli_doc(
options=["--use-default-factory-for-optional-nested-models"],
option_description="""Generate default_factory for optional nested model fields.
The `--use-default-factory-for-optional-nested-models` flag generates default_factory
for optional nested model fields instead of None default:
- Dataclasses: `field: Model | None = field(default_factory=Model)`
- Pydantic: `field: Model | None = Field(default_factory=Model)`
- msgspec: `field: Model | UnsetType = field(default_factory=Model)`""",
input_schema="jsonschema/default_factory_nested_model.json",
cli_args=["--use-default-factory-for-optional-nested-models"],
model_outputs={
"dataclass": "main/jsonschema/default_factory_nested_model_dataclass.py",
"pydantic_v2": "main/jsonschema/default_factory_nested_model_pydantic_v2.py",
"msgspec": "main/jsonschema/default_factory_nested_model_msgspec.py",
},
)
@pytest.mark.benchmark
@LEGACY_BLACK_SKIP
def test_main_use_default_factory_for_optional_nested_models(
output_model: str, expected_file: str, output_file: Path
) -> None:
"""Generate default_factory for optional nested model fields.
The `--use-default-factory-for-optional-nested-models` flag generates default_factory
for optional nested model fields instead of None default:
- Dataclasses: `field: Model | None = field(default_factory=Model)`
- Pydantic: `field: Model | None = Field(default_factory=Model)`
- msgspec: `field: Model | UnsetType = field(default_factory=Model)`
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "default_factory_nested_model.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_file,
extra_args=[
"--output-model-type",
output_model,
"--use-default-factory-for-optional-nested-models",
],
)
@pytest.mark.parametrize(
("output_model", "expected_file"),
[
("dataclasses.dataclass", "default_factory_nested_model_with_dict_dataclass.py"),
("pydantic_v2.BaseModel", "default_factory_nested_model_with_dict_pydantic_v2.py"),
("msgspec.Struct", "default_factory_nested_model_with_dict_msgspec.py"),
],
)
@pytest.mark.benchmark
@LEGACY_BLACK_SKIP
def test_main_use_default_factory_for_optional_nested_models_with_dict(
output_model: str, expected_file: str, output_file: Path
) -> None:
"""Test --use-default-factory-for-optional-nested-models with dict union skips dict types."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "default_factory_nested_model_with_dict.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_file,
extra_args=[
"--output-model-type",
output_model,
"--use-default-factory-for-optional-nested-models",
],
)
@pytest.mark.benchmark
def test_main_field_name_shadows_class_name(output_file: Path) -> None:
"""Test field name shadowing class name is renamed with alias for Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_name_shadows_class_name.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.cli_doc(
options=["--allof-merge-mode"],
option_description="""Merge constraints from root model references in allOf schemas.
The `--allof-merge-mode constraints` merges only constraint properties
(minLength, maximum, etc.) from parent schemas referenced in allOf.
This ensures child schemas inherit validation constraints while keeping
other properties separate.""",
input_schema="jsonschema/allof_root_model_constraints.json",
cli_args=["--allof-merge-mode", "constraints"],
golden_output="main/jsonschema/allof_root_model_constraints_merge.py",
comparison_output="main/jsonschema/allof_root_model_constraints.py",
)
@pytest.mark.benchmark
def test_main_allof_root_model_constraints_merge(output_file: Path) -> None:
"""Merge constraints from root model references in allOf schemas.
The `--allof-merge-mode constraints` merges only constraint properties
(minLength, maximum, etc.) from parent schemas referenced in allOf.
This ensures child schemas inherit validation constraints while keeping
other properties separate.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "allof_root_model_constraints.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="allof_root_model_constraints_merge.py",
extra_args=["--allof-merge-mode", "constraints"],
)
@pytest.mark.cli_doc(
options=["--allof-class-hierarchy"],
option_description="""Controls how allOf schemas are represented in the generated class hierarchy.
`--allof-class-hierarchy if-no-conflict` (default) creates parent classes for allOf schemas
only when there are no property conflicts between parent schemas. Otherwise, properties are merged into the child class
which is then decoupled from the parent classes and no longer inherits from them.
`--allof-class-hierarchy always` keeps class hierarchy for allOf schemas,
even in multiple inheritance scenarios where two parent schemas define the same property.""",
input_schema="jsonschema/allof_root_model_constraints.json",
cli_args=["--allof-class-hierarchy", "always"],
golden_output="main/jsonschema/allof_class_hierarchy.py",
comparison_output="main/jsonschema/allof_class_hierarchy_ref.py",
)
@pytest.mark.benchmark
def test_main_allof_class_hierarchy(output_file: Path) -> None:
"""Control how allOf schemas are represented in the generated class hierarchy.
The `--allof-class-hierarchy` option configures whether the generator preserves
parent classes for allOf schemas (even when there are property conflicts) or
falls back to merging properties into a single class.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "allof_class_hierarchy.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="allof_class_hierarchy.py",
extra_args=["--allof-class-hierarchy", "always"],
)
@pytest.mark.benchmark
def test_main_allof_root_model_constraints_none(output_file: Path) -> None:
"""Test allOf with root model reference without merging (issue #1901)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "allof_root_model_constraints.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="allof_root_model_constraints.py",
extra_args=["--allof-merge-mode", "none"],
)
@pytest.mark.benchmark
def test_main_allof_root_model_constraints_merge_pydantic_v2(output_file: Path) -> None:
"""Test allOf with root model constraints in Pydantic v2 (issue #2232).
When merging pattern constraints that use lookaround assertions,
the generated RootModel should use the base type in the generic
(e.g., RootModel[str]) rather than the constrained type
(e.g., RootModel[constr(pattern=...)]) to avoid regex evaluation
before model_config with regex_engine='python-re' is processed.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "allof_root_model_constraints.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="allof_root_model_constraints_merge_pydantic_v2.py",
extra_args=[
"--allof-merge-mode",
"constraints",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.benchmark
def test_main_nested_lookaround_array_pydantic_v2(output_file: Path) -> None:
"""Test nested lookaround pattern detection in array items (issue #2232).
When array items have patterns with lookaround assertions, the lookaround
should be detected in nested types and regex_engine='python-re' should be
added. The RootModel generic should use the base type (list[str]) rather
than the constrained type (list[constr(pattern=...)]).
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nested_lookaround_array.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="nested_lookaround_array_pydantic_v2.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.benchmark
def test_main_lookaround_anyof_nullable_pydantic_v2(output_file: Path) -> None:
"""Test lookaround pattern with anyOf null for union/optional path."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "lookaround_anyof_nullable.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="lookaround_anyof_nullable_pydantic_v2.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@LEGACY_BLACK_SKIP
@pytest.mark.benchmark
def test_main_lookaround_mixed_constraints_pydantic_v2(output_file: Path) -> None:
"""Test lookaround pattern with union of constr and conint to test base_type_hint fallback for non-constr types."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "lookaround_mixed_constraints.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="lookaround_mixed_constraints_pydantic_v2.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.benchmark
def test_main_lookaround_dict_pydantic_v2(output_file: Path) -> None:
"""Test lookaround pattern in dict values for base_type_hint dict path."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "lookaround_dict.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="lookaround_dict_pydantic_v2.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.benchmark
def test_main_lookaround_union_types_pydantic_v2(output_file: Path) -> None:
"""Test lookaround pattern in union for base_type_hint union path."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "lookaround_union_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="lookaround_union_types_pydantic_v2.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.benchmark
def test_main_nested_lookaround_array_generic_container(output_file: Path) -> None:
"""Test lookaround pattern with --use-generic-container-types for Sequence path."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nested_lookaround_array.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="nested_lookaround_array_generic_container.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-container-types",
],
)
@pytest.mark.benchmark
def test_main_lookaround_dict_generic_container(output_file: Path) -> None:
"""Test lookaround dict pattern with --use-generic-container-types for Mapping path."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "lookaround_dict.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="lookaround_dict_generic_container.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-generic-container-types",
],
)
@pytest.mark.benchmark
def test_main_nested_lookaround_array_standard_collections(output_file: Path) -> None:
"""Test lookaround pattern with --use-standard-collections for list path."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nested_lookaround_array.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="nested_lookaround_array_standard_collections.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-standard-collections",
],
)
@pytest.mark.benchmark
def test_main_lookaround_dict_standard_collections(output_file: Path) -> None:
"""Test lookaround dict pattern with --use-standard-collections for dict path."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "lookaround_dict.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="lookaround_dict_standard_collections.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-standard-collections",
],
)
@pytest.mark.benchmark
def test_main_lookaround_dict_key_pydantic_v2(output_file: Path) -> None:
"""Test lookaround pattern on dict key for dict_key.all_data_types path."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "lookaround_dict_key.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="lookaround_dict_key_pydantic_v2.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.benchmark
def test_main_nullable_array_items_strict_nullable(output_file: Path) -> None:
"""Test nullable array items with strict-nullable flag (issue #1815)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "nullable_array_items.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="nullable_array_items_strict_nullable.py",
extra_args=[
"--strict-nullable",
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.benchmark
def test_main_builtin_field_names(output_file: Path) -> None:
"""Test that builtin type names as field names don't break code generation (issue #2431).
When a field has a name that matches a Python builtin (int, float, bool, str),
the generated code should still use the builtin type directly without aliasing,
since builtin types don't require imports.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "builtin_field_names.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="builtin_field_names.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.benchmark
def test_main_builtin_field_names_snake_case(output_file: Path) -> None:
"""Test builtin field rename keeps original alias after snake_case normalization."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "builtin_field_names_snake_case.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="builtin_field_names_snake_case.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--snake-case-field",
],
)
@pytest.mark.benchmark
def test_main_builtin_field_names_container_types(output_file: Path) -> None:
"""Test builtin container names are renamed for set/frozenset/tuple/list/dict collisions."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "builtin_field_names_container_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="builtin_field_names_container_types.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-constraints",
"--use-unique-items-as-set",
],
)
@pytest.mark.benchmark
def test_main_builtin_field_names_container_types_no_use_standard_collections(output_file: Path) -> None:
"""Test builtin container renaming when container types are imported from typing."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "builtin_field_names_container_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="builtin_field_names_container_types_no_use_standard_collections.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-constraints",
"--use-unique-items-as-set",
"--no-use-standard-collections",
],
)
@pytest.mark.benchmark
@pytest.mark.parametrize(
("target_python_version", "expected_file"),
[
("3.10", "builtin_field_names_target_python_version_310.py"),
pytest.param("3.13", "builtin_field_names_target_python_version_313.py", marks=BLACK_PY313_SKIP),
],
)
def test_main_builtin_field_names_target_python_version(
output_file: Path, target_python_version: str, expected_file: str
) -> None:
"""Test builtin field renaming follows target Python version instead of runtime builtins."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "builtin_field_names_target_python_version.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_file,
skip_code_validation=True,
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-python-version",
target_python_version,
],
)
@pytest.mark.benchmark
def test_main_root_model_config_populate_by_name(output_file: Path) -> None:
"""Test that RootModel subclasses don't get populate_by_name config (issue #2483).
The populate_by_name config is meaningless for RootModel because it only has
a single 'root' field. Only BaseModel subclasses should have this config.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_config.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_model_config_populate_by_name.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--allow-population-by-field-name",
],
)
@pytest.mark.benchmark
def test_main_root_model_config_frozen(output_file: Path) -> None:
"""Test that RootModel subclasses DO get frozen config (issue #2483).
Unlike populate_by_name, the frozen config is meaningful for RootModel
because it prevents mutation of the root value. Both BaseModel and RootModel
subclasses should have this config when --enable-faux-immutability is used.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_config.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_model_config_frozen.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--enable-faux-immutability",
],
)
@pytest.mark.cli_doc(
options=["--naming-strategy"],
option_description="""Use parent-prefixed naming strategy for duplicate model names.
The `--naming-strategy parent-prefixed` flag prefixes model names with their
parent model name when duplicates occur. For example, if both `Order` and
`Cart` have an inline `Item` definition, they become `OrderItem` and `CartItem`.""",
input_schema="jsonschema/naming_strategy/input.json",
cli_args=["--naming-strategy", "parent-prefixed"],
golden_output="main/jsonschema/naming_strategy/parent_prefixed/output.py",
related_options=["--duplicate-name-suffix", "--parent-scoped-naming"],
)
@freeze_time("2019-07-26")
def test_main_naming_strategy_parent_prefixed(output_file: Path) -> None:
"""Use parent-prefixed naming strategy for duplicate model names.
The `--naming-strategy parent-prefixed` flag prefixes model names with their
parent model name when duplicates occur. For example, if both `Order` and
`Cart` have an inline `Item` definition, they become `OrderItem` and `CartItem`.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "naming_strategy" / "input.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="naming_strategy/parent_prefixed/output.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--naming-strategy",
"parent-prefixed",
],
)
@freeze_time("2019-07-26")
def test_main_naming_strategy_full_path(output_file: Path) -> None:
"""Use full-path naming strategy for duplicate model names.
The `--naming-strategy full-path` flag uses the full schema path
to generate unique names by concatenating ancestor names.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "naming_strategy" / "input.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="naming_strategy/full_path/output.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--naming-strategy",
"full-path",
],
)
@pytest.mark.cli_doc(
options=["--duplicate-name-suffix"],
option_description="""Customize suffix for duplicate model names.
The `--duplicate-name-suffix` flag allows specifying custom suffixes for
resolving duplicate names by type. The value is a JSON mapping where keys
are type names ('model', 'enum', 'default') and values are suffix strings.
For example, `{"model": "Schema"}` changes `Item1` to `ItemSchema`.""",
input_schema="jsonschema/naming_strategy/input.json",
cli_args=["--duplicate-name-suffix", '{"model": "Schema"}'],
golden_output="main/jsonschema/naming_strategy/duplicate_name_suffix/output.py",
related_options=["--naming-strategy"],
)
@freeze_time("2019-07-26")
def test_main_duplicate_name_suffix(output_file: Path) -> None:
"""Customize suffix for duplicate model names.
The `--duplicate-name-suffix` flag allows specifying custom suffixes for
resolving duplicate names by type. The value is a JSON mapping where keys
are type names ('model', 'enum', 'default') and values are suffix strings.
For example, `{"model": "Schema"}` changes `Item1` to `ItemSchema`.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "naming_strategy" / "input.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="naming_strategy/duplicate_name_suffix/output.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--duplicate-name-suffix",
'{"model": "Schema"}',
],
)
@freeze_time("2019-07-26")
def test_main_naming_strategy_complex_numbered(output_file: Path) -> None:
"""Test numbered strategy with complex nested schema and multiple duplicates.
Tests deeply nested structures (Company > employees > employee > address)
and multiple models with same name (4 different Address definitions).
Expected: Address, Address1, Address2, Address3.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "naming_strategy" / "complex_input.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="naming_strategy/complex_numbered/output.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@freeze_time("2019-07-26")
def test_main_naming_strategy_complex_parent_prefixed(output_file: Path) -> None:
"""Test parent-prefixed strategy with complex nested schema.
Tests deeply nested structures where each Address gets a unique name
based on its parent hierarchy.
Expected: ModelCompanyAddress, ModelCompanyEmployeeAddress,
ModelCustomerAddress, ModelWarehouseAddress.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "naming_strategy" / "complex_input.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="naming_strategy/complex_parent_prefixed/output.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--naming-strategy",
"parent-prefixed",
],
)
@freeze_time("2019-07-26")
def test_main_naming_strategy_complex_duplicate_suffix(output_file: Path) -> None:
"""Test duplicate-name-suffix with complex schema having multiple duplicates.
Tests that custom suffix is applied consistently across multiple duplicates.
Expected: Address, AddressSchema, AddressSchema1, AddressSchema2.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "naming_strategy" / "complex_input.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="naming_strategy/complex_duplicate_suffix/output.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--duplicate-name-suffix",
'{"model": "Schema"}',
],
)
@freeze_time("2019-07-26")
@pytest.mark.cli_doc(
options=["--naming-strategy"],
option_description="""Use primary-first strategy to keep clean names for top-level definitions.
The `--naming-strategy primary-first` keeps clean names for primary definitions
(directly under #/definitions/, #/components/schemas/, #/$defs/).
Inline/nested definitions get numeric suffixes.""",
input_schema="jsonschema/naming_strategy/primary_first_input.json",
cli_args=["--naming-strategy", "primary-first"],
golden_output="jsonschema/naming_strategy/complex_primary_first/output.py",
)
def test_main_naming_strategy_primary_first(output_file: Path) -> None:
"""Use primary-first strategy to keep clean names for top-level definitions.
The `--naming-strategy primary-first` keeps clean names for primary definitions
(directly under #/definitions/, #/components/schemas/, #/$defs/).
Inline/nested definitions get numeric suffixes.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "naming_strategy" / "primary_first_input.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="naming_strategy/complex_primary_first/output.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--naming-strategy",
"primary-first",
],
)
@freeze_time("2019-07-26")
def test_main_naming_strategy_primary_first_multi_file(output_file: Path) -> None:
"""Test primary-first strategy with multiple files having same-named definitions.
When multiple JSON schema files have definitions with the same name,
the primary input file's definition should keep the clean name,
while external references get numeric suffixes.
This fixes GitHub issue #1300.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "naming_strategy" / "primary_first_multi_file" / "main.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="naming_strategy/primary_first_multi_file/output.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--naming-strategy",
"primary-first",
],
)
def test_main_duplicate_name_suffix_invalid_json(output_file: Path) -> None:
"""Test that invalid JSON in --duplicate-name-suffix raises an error."""
run_main_with_args(
[
"--input",
str(JSON_SCHEMA_DATA_PATH / "naming_strategy" / "input.json"),
"--output",
str(output_file),
"--duplicate-name-suffix",
"invalid json",
],
expected_exit=Exit.ERROR,
)
@freeze_time("2019-07-26")
def test_main_parent_scoped_naming_backward_compat(output_file: Path) -> None:
"""Test --parent-scoped-naming backward compatibility (deprecated flag)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "naming_strategy" / "input.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="naming_strategy/parent_prefixed/output.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--parent-scoped-naming",
],
)
@pytest.mark.cli_doc(
options=["--use-root-model-type-alias"],
option_description="""Generate RootModel as type alias format for better mypy support.
When enabled, root models with simple types are generated as type aliases
instead of class definitions, improving mypy type inference.""",
input_schema="jsonschema/root_model_type_alias.json",
cli_args=["--use-root-model-type-alias", "--output-model-type", "pydantic_v2.BaseModel"],
golden_output="jsonschema/root_model_type_alias.py",
)
def test_main_use_root_model_type_alias(output_file: Path) -> None:
"""Generate RootModel as type alias format for better mypy support (issue #1903)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "root_model_type_alias.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="root_model_type_alias.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-root-model-type-alias",
"--target-python-version",
"3.10",
],
)
def test_main_jsonschema_schema_id(
capsys: pytest.CaptureFixture, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
"""Test that $id is exposed as schema_id in custom templates (issue #2098)."""
model_base._get_environment.cache_clear()
model_base._get_template_with_custom_dir.cache_clear()
monkeypatch.chdir(tmp_path)
with freeze_time(TIMESTAMP):
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "schema_id.json",
output_path=None,
expected_stdout_path=EXPECTED_JSON_SCHEMA_PATH / "schema_id.py",
capsys=capsys,
input_file_type=None,
extra_args=[
"--custom-template-dir",
str(DATA_PATH / "templates_schema_id"),
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
@pytest.mark.parametrize(
("output_model", "expected_output"),
[
(
"pydantic_v2.BaseModel",
"model_extras_v2.py",
),
],
)
@pytest.mark.cli_doc(
options=["--model-extra-keys"],
option_description="""Add model-level schema extensions to ConfigDict json_schema_extra.
The `--model-extra-keys` flag adds specified x-* extensions from the schema
to the model's ConfigDict json_schema_extra.""",
input_schema="jsonschema/model_extras.json",
cli_args=["--model-extra-keys", "x-custom-metadata"],
model_outputs={
"pydantic_v2": "main/jsonschema/model_extras_v2.py",
},
)
def test_main_jsonschema_model_extras(output_model: str, expected_output: str, output_file: Path) -> None:
"""Add model-level schema extensions to ConfigDict json_schema_extra.
The `--model-extra-keys` flag adds specified x-* extensions from the schema
to the model's ConfigDict json_schema_extra.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "model_extras.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=[
"--output-model-type",
output_model,
"--model-extra-keys",
"x-custom-metadata",
],
)
@pytest.mark.parametrize(
("output_model", "expected_output"),
[
(
"pydantic_v2.BaseModel",
"model_extras_without_x_prefix_v2.py",
),
],
)
@pytest.mark.cli_doc(
options=["--model-extra-keys-without-x-prefix"],
option_description="""Strip x- prefix from model-level schema extensions and add to ConfigDict json_schema_extra.
The `--model-extra-keys-without-x-prefix` flag adds specified x-* extensions
from the schema to the model's ConfigDict json_schema_extra with the x- prefix stripped.""",
input_schema="jsonschema/model_extras.json",
cli_args=["--model-extra-keys-without-x-prefix", "x-custom-metadata", "x-version"],
model_outputs={
"pydantic_v2": "main/jsonschema/model_extras_without_x_prefix_v2.py",
},
)
def test_main_jsonschema_model_extras_without_x_prefix(
output_model: str, expected_output: str, output_file: Path
) -> None:
"""Strip x- prefix from model-level schema extensions and add to ConfigDict json_schema_extra.
The `--model-extra-keys-without-x-prefix` flag adds specified x-* extensions
from the schema to the model's ConfigDict json_schema_extra with the x- prefix stripped.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "model_extras.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=[
"--output-model-type",
output_model,
"--model-extra-keys-without-x-prefix",
"x-custom-metadata",
"x-version",
],
)
@pytest.mark.parametrize(
("output_model", "expected_output"),
[
(
"pydantic_v2.BaseModel",
"model_extras_no_match_v2.py",
),
],
)
def test_main_jsonschema_model_extras_no_match(output_model: str, expected_output: str, output_file: Path) -> None:
"""No json_schema_extra when specified model-extra-keys don't match schema extensions.
When the specified key doesn't exist in the schema's x-* extensions,
no json_schema_extra is added to ConfigDict.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "model_extras.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file=expected_output,
extra_args=[
"--output-model-type",
output_model,
"--model-extra-keys",
"x-nonexistent",
],
)
def test_main_jsonschema_non_dict_files_in_directory(output_dir: Path) -> None:
"""Test that non-dict files (lists, empty files) are skipped with warnings."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "non_dict_files",
output_path=output_dir,
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "non_dict_files",
input_file_type="jsonschema",
)
def test_main_jsonschema_ref_to_json_list_file() -> None:
"""Test that $ref to a JSON file containing a list raises TypeError."""
with pytest.raises(TypeError, match="Expected dict, got list"):
generate(
input_=JSON_SCHEMA_DATA_PATH / "ref_to_json_list" / "main.json",
input_file_type=InputFileType.JsonSchema,
)
def test_main_jsonschema_x_python_import_unused(output_file: Path) -> None:
"""Test x-python-import entries in $defs are handled without model generation."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_import_unused.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="x_python_import_unused.py",
)
def test_x_python_type_callable(output_file: Path) -> None:
"""Test x-python-type with Callable preserves the Callable type."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_callable.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict"],
)
def test_x_python_type_callable_anyof(output_file: Path) -> None:
"""Test x-python-type in anyOf preserves the Callable type."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_callable_anyof.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict"],
)
def test_x_python_type_compatible_set(output_file: Path) -> None:
"""Test x-python-type with compatible type (Set) uses existing flag logic."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_compatible_set.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict"],
)
def test_x_python_type_builtin_dict_collision(output_file: Path) -> None:
"""Test x-python-type Dict keeps builtin dict collision handling with typing containers."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_builtin_dict_collision.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-constraints",
"--no-use-standard-collections",
],
)
def test_x_python_type_fqpath(output_file: Path) -> None:
"""Test x-python-type with fully qualified path (e.g., collections.abc.Callable)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_fqpath.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict"],
)
def test_x_python_type_no_schema_type(output_file: Path) -> None:
"""Test x-python-type when schema type is not specified."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_no_schema_type.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict"],
)
def test_x_python_type_custom_fqpath(output_file: Path) -> None:
"""Test x-python-type with custom fully qualified path not in predefined imports."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_custom_fqpath.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict"],
)
def test_x_python_type_nested_imports(output_file: Path) -> None:
"""Test x-python-type with nested types that require imports (e.g., Callable[[Iterable[str]], str])."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_nested_imports.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict"],
)
def test_x_python_type_nested_unknown_type(output_file: Path) -> None:
"""Test x-python-type with nested types not in PYTHON_TYPE_IMPORTS (e.g., MyCustomType)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_nested_unknown_type.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict"],
)
def test_x_python_type_dynamic_resolve(output_file: Path) -> None:
"""Test x-python-type with types resolved dynamically (not in static PYTHON_TYPE_IMPORTS)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_dynamic_resolve.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
extra_args=["--output-model-type", "typing.TypedDict"],
)
def test_x_python_type_union_anyof(output_file: Path) -> None:
"""Test x-python-type with union type in anyOf schema."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "x_python_type_union_anyof.json",
output_path=output_file,
input_file_type=None,
assert_func=assert_file_content,
)
@pytest.mark.cli_doc(
options=["--default-values"],
option_description="""Override field default values from external JSON file.
The `--default-values` option allows specifying default values for fields via a JSON file.
Supports scoped format (ClassName.field) for hierarchical overrides.""",
input_schema="jsonschema/default_values_override.json",
cli_args=["--default-values", "default_values/scoped_defaults.json"],
golden_output="jsonschema/jsonschema_default_values_override.py",
)
def test_main_jsonschema_default_values_override(output_file: Path) -> None:
"""Test default value overrides from external JSON file."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "default_values_override.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="jsonschema_default_values_override.py",
extra_args=[
"--default-values",
str(DEFAULT_VALUES_DATA_PATH / "scoped_defaults.json"),
],
)
def test_main_jsonschema_default_values_allof(output_file: Path) -> None:
"""Test default value overrides with allOf inheritance."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "default_values_allof.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="jsonschema_default_values_allof.py",
extra_args=[
"--use-default",
"--default-values",
str(DEFAULT_VALUES_DATA_PATH / "allof_defaults.json"),
],
)
def test_ref_nullable_only_no_duplicate_model(output_file: Path) -> None:
"""Test that $ref + nullable: true does not create duplicate models.
When a property has $ref with nullable: true, it should use the referenced
type directly (e.g., User) with Optional type annotation, not create a new
model with a derived name (e.g., UserA, UserB).
See: https://github.com/koxudaxi/datamodel-code-generator/discussions/1792
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_nullable_only.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="ref_nullable_only.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
def test_ref_nullable_only_strict_nullable(output_file: Path) -> None:
"""Test $ref + nullable: true with --strict-nullable flag.
The output should be the same as without strict-nullable for this case,
using the referenced type directly with Optional annotation.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_nullable_only.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="ref_nullable_only_strict.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--strict-nullable"],
)
def test_ref_nullable_with_metadata_no_duplicate_model(output_file: Path) -> None:
"""Test $ref + nullable: true + metadata (title/description) does not merge.
When a property has $ref with nullable: true and metadata-only fields like
title or description, it should not create a new model. The metadata should
be applied to the field, and the reference should be used directly.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_nullable_with_metadata.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="ref_nullable_with_metadata.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--strict-nullable"],
)
def test_ref_nullable_with_constraint_creates_model(output_file: Path) -> None:
"""Test $ref + nullable: true + constraint DOES create a merged model.
When a property has $ref with nullable: true AND a schema constraint like
minLength, it should merge the schemas and create a new model because the
constraint affects the schema structure.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_nullable_with_constraint.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="ref_nullable_with_constraint.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--strict-nullable"],
)
def test_ref_nullable_with_extra_uses_reference_directly(output_file: Path) -> None:
"""Test $ref + nullable: true + non-schema-affecting extras uses reference directly.
When a property has $ref with nullable: true AND extras that the tool cannot
structurally process (like 'if'), it should use the reference directly
instead of creating a merged model.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_nullable_with_extra.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="ref_nullable_with_extra.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--strict-nullable"],
)
def test_reduce_duplicate_field_types(output_file: Path) -> None:
"""Test reducing duplicate field types using $ref and --use-type-alias.
When multiple classes share the same field type defined in $defs,
using --use-type-alias creates a single TypeAlias that's reused across classes.
This is the recommended pattern to avoid duplicate Annotated field definitions.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "reduce_duplicate_field_types.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="reduce_duplicate_field_types.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--use-type-alias"],
)
@pytest.mark.cli_doc(
options=["--validators"],
option_description="""Add custom field validators to generated Pydantic v2 models.
The `--validators` option takes a JSON file defining validators per model.
Each validator specifies the field(s) to validate, the validation function
to import, and optionally the mode (before/after/wrap/plain).
This allows injecting custom validation logic into generated models.""",
input_schema="jsonschema/field_validators.json",
cli_args=[
"--validators",
"tests/data/jsonschema/field_validators_config.json",
"--output-model-type",
"pydantic_v2.BaseModel",
"--disable-timestamp",
],
golden_output="jsonschema/field_validators.py",
)
def test_field_validators(output_file: Path) -> None:
"""Add custom field validators to generated Pydantic v2 models.
The `--validators` option takes a JSON file defining validators per model.
Each validator specifies the field(s) to validate, the validation function
to import, and optionally the mode (before/after/wrap/plain).
This allows injecting custom validation logic into generated models.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_validators.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_validators.py",
extra_args=[
"--validators",
str(JSON_SCHEMA_DATA_PATH / "field_validators_config.json"),
"--output-model-type",
"pydantic_v2.BaseModel",
"--disable-timestamp",
],
skip_code_validation=True,
)
def test_field_validators_multi_fields(output_file: Path) -> None:
"""Test validators with multiple fields."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_validators.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_validators_multi_fields.py",
extra_args=[
"--validators",
str(JSON_SCHEMA_DATA_PATH / "field_validators_multi_fields_config.json"),
"--output-model-type",
"pydantic_v2.BaseModel",
"--disable-timestamp",
],
skip_code_validation=True,
)
def test_field_validators_wrap_mode(output_file: Path, tmp_path: Path) -> None:
"""Test validators with wrap mode."""
config_file = tmp_path / "wrap_mode_config.json"
config_file.write_text(
"""{
"User": {
"validators": [
{"field": "name", "function": "myapp.validators.validate_name_wrap", "mode": "wrap"}
]
}
}"""
)
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_validators.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_validators_wrap_mode.py",
extra_args=[
"--validators",
str(config_file),
"--output-model-type",
"pydantic_v2.BaseModel",
"--disable-timestamp",
],
skip_code_validation=True,
)
def test_field_validators_with_no_field_skipped(output_file: Path, tmp_path: Path) -> None:
"""Test that validators without fields are skipped gracefully."""
config_file = tmp_path / "no_field_validators_config.json"
config_file.write_text(
"""{
"User": {
"validators": [
{"function": "myapp.validators.validate_something"},
{"field": "name", "function": "myapp.validators.validate_name"}
]
}
}"""
)
result = run_main_with_args([
"--input",
str(JSON_SCHEMA_DATA_PATH / "field_validators.json"),
"--output",
str(output_file),
"--input-file-type",
"jsonschema",
"--validators",
str(config_file),
"--output-model-type",
"pydantic_v2.BaseModel",
"--disable-timestamp",
])
assert result == Exit.OK
content = output_file.read_text(encoding="utf-8")
assert "validate_name_validator" in content
assert "validate_something" not in content
def test_field_validators_plain_mode(output_file: Path, tmp_path: Path) -> None:
"""Test validators with plain mode (no ValidationInfo import)."""
config_file = tmp_path / "plain_mode_config.json"
config_file.write_text(
"""{
"User": {
"validators": [
{"field": "name", "function": "myapp.validators.validate_name_plain", "mode": "plain"}
]
}
}"""
)
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_validators.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="field_validators_plain_mode.py",
extra_args=[
"--validators",
str(config_file),
"--output-model-type",
"pydantic_v2.BaseModel",
"--disable-timestamp",
],
skip_code_validation=True,
)
def test_field_validators_all_skipped(output_file: Path, tmp_path: Path) -> None:
"""Test that when all validators have no fields, output has no validators."""
config_file = tmp_path / "all_skipped_config.json"
config_file.write_text(
"""{
"User": {
"validators": [
{"function": "myapp.validators.validate_something"}
]
}
}"""
)
result = run_main_with_args([
"--input",
str(JSON_SCHEMA_DATA_PATH / "field_validators.json"),
"--output",
str(output_file),
"--input-file-type",
"jsonschema",
"--validators",
str(config_file),
"--output-model-type",
"pydantic_v2.BaseModel",
"--disable-timestamp",
])
assert result == Exit.OK
content = output_file.read_text(encoding="utf-8")
assert "@field_validator" not in content
assert "validate_something" not in content
def test_validators_invalid_json(output_file: Path, tmp_path: Path, capsys: pytest.CaptureFixture[str]) -> None:
"""Test error handling for invalid validators JSON file."""
invalid_json = tmp_path / "invalid.json"
invalid_json.write_text("not valid json{")
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_validators.json",
output_path=output_file,
input_file_type="jsonschema",
expected_exit=Exit.ERROR,
extra_args=[
"--validators",
str(invalid_json),
"--output-model-type",
"pydantic_v2.BaseModel",
],
capsys=capsys,
expected_stderr_contains="Unable to load validators configuration",
)
def test_validators_invalid_structure(output_file: Path, tmp_path: Path, capsys: pytest.CaptureFixture[str]) -> None:
"""Test error handling for validators JSON with invalid structure (not an object)."""
invalid_structure = tmp_path / "invalid_structure.json"
invalid_structure.write_text('["not", "an", "object"]')
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "field_validators.json",
output_path=output_file,
input_file_type="jsonschema",
expected_exit=Exit.ERROR,
extra_args=[
"--validators",
str(invalid_structure),
"--output-model-type",
"pydantic_v2.BaseModel",
],
capsys=capsys,
expected_stderr_contains="Invalid validators configuration",
)
def test_jsonschema_classvar_extra_pydantic_v2(output_file: Path) -> None:
"""Test default value handling."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "has_classvar_extra.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="has_classvar_extra.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--field-include-all-keys"],
)
def test_jsonschema_classvar_extra_set_pydantic_v2(output_file: Path) -> None:
"""Test ClassVar with set default value."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "has_classvar_extra_set.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="has_classvar_extra_set.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-include-all-keys",
"--use-unique-items-as-set",
],
)
def test_jsonschema_classvar_extra_annotated_pydantic_v2(output_file: Path) -> None:
"""Test ClassVar with use_annotated option."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "has_classvar_extra_annotated.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="has_classvar_extra_annotated.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-include-all-keys",
"--use-annotated",
],
)
def test_unique_items_enum_set(output_file: Path) -> None:
"""Test set with enum items does not add __hash__ to enum (already hashable)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "unique_items_enum_set.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="unique_items_enum_set.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-unique-items-as-set",
"--use-standard-collections",
],
)
@pytest.mark.benchmark
def test_main_allof_mro(output_file: Path) -> None:
"""Test allOf with diamond inheritance pattern produces valid Python MRO."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "allof_mro.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="allof_mro.py",
extra_args=[
"--use-schema-description",
],
)
@pytest.mark.benchmark
def test_main_circular_ref_with_schema_keywords(output_file: Path) -> None:
"""Test circular $ref with additional schema keywords does not cause RecursionError."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "circular_ref_with_schema_keywords.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.benchmark
def test_main_circular_ref_indirect(output_file: Path) -> None:
"""Test indirect circular $ref (A->B->A) does not cause RecursionError."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "circular_ref_indirect.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.benchmark
def test_main_circular_ref_root_with_type(output_file: Path) -> None:
"""Test circular $ref at root level with type does not cause RecursionError."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "circular_ref_root_with_type.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.benchmark
def test_main_circular_ref_external_relative_keywords(output_file: Path) -> None:
"""Test circular external refs with relative paths and schema keywords."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "circular_ref_external_relative_keywords" / "root.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
@pytest.mark.benchmark
def test_main_circular_ref_external_url_keywords(mocker: MockerFixture, output_file: Path) -> None:
"""Test circular external refs with relative paths and schema keywords via URL input."""
external_directory = JSON_SCHEMA_DATA_PATH / "circular_ref_external_relative_keywords"
base_url = "https://example.com/circular_ref_external_relative_keywords/"
url_to_path = {
f"{base_url}root.json": "root.json",
f"{base_url}defs/context.json": "defs/context.json",
f"{base_url}defs/nested/child.json": "defs/nested/child.json",
}
def get_mock_response(url: str, **_: object) -> mocker.Mock:
path = url_to_path.get(url)
mock = mocker.Mock()
mock.text = (external_directory / path).read_text()
return mock
httpx_get_mock = mocker.patch(
"httpx.get",
side_effect=get_mock_response,
)
run_main_url_and_assert(
url=f"{base_url}root.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="circular_ref_external_relative_keywords.py",
transform=lambda s: s.replace(
f"# filename: {base_url}root.json",
"# filename: root.json",
),
)
httpx_get_mock.assert_has_calls(
[
call(
f"{base_url}root.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
call(
f"{base_url}defs/context.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
call(
f"{base_url}defs/nested/child.json",
headers=None,
verify=True,
follow_redirects=True,
params=None,
timeout=30.0,
),
],
any_order=True,
)
assert httpx_get_mock.call_count == 3
@pytest.mark.benchmark
def test_main_circular_ref_ref_with_schema_keywords(output_file: Path) -> None:
"""Test named schema with circular $ref and schema keywords still generates alias model."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "circular_ref_ref_with_schema_keywords.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
)
def test_main_jsonschema_recursive_ref(output_file: Path) -> None:
"""Test JSON Schema 2019-09 $recursiveRef with $recursiveAnchor."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "recursive_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="recursive_ref.py",
)
def test_main_jsonschema_recursive_ref_pydantic_v2(output_file: Path) -> None:
"""Test JSON Schema 2019-09 $recursiveRef with Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "recursive_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="recursive_ref_pydantic_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
def test_main_jsonschema_dynamic_ref(output_file: Path) -> None:
"""Test JSON Schema 2020-12 $dynamicRef with $dynamicAnchor."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "dynamic_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="dynamic_ref.py",
)
def test_main_jsonschema_dynamic_ref_pydantic_v2(output_file: Path) -> None:
"""Test JSON Schema 2020-12 $dynamicRef with Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "dynamic_ref.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="dynamic_ref_pydantic_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
def test_main_jsonschema_recursive_ref_no_anchor(output_file: Path) -> None:
"""Test JSON Schema 2019-09 $recursiveRef without $recursiveAnchor."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "recursive_ref_no_anchor.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="recursive_ref_no_anchor.py",
)
def test_main_jsonschema_recursive_ref_no_anchor_pydantic_v2(output_file: Path) -> None:
"""Test JSON Schema 2019-09 $recursiveRef without $recursiveAnchor for Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "recursive_ref_no_anchor.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="recursive_ref_no_anchor_pydantic_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
def test_main_jsonschema_recursive_ref_in_defs(output_file: Path) -> None:
"""Test JSON Schema 2019-09 $recursiveRef with anchor in $defs."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "recursive_ref_in_defs.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="recursive_ref_in_defs.py",
)
def test_main_jsonschema_recursive_ref_in_defs_pydantic_v2(output_file: Path) -> None:
"""Test JSON Schema 2019-09 $recursiveRef with anchor in $defs for Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "recursive_ref_in_defs.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="recursive_ref_in_defs_pydantic_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
def test_main_jsonschema_dynamic_ref_in_defs(output_file: Path) -> None:
"""Test JSON Schema 2020-12 $dynamicRef with anchor in $defs."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "dynamic_ref_in_defs.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="dynamic_ref_in_defs.py",
)
def test_main_jsonschema_dynamic_ref_in_defs_pydantic_v2(output_file: Path) -> None:
"""Test JSON Schema 2020-12 $dynamicRef with anchor in $defs for Pydantic v2."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "dynamic_ref_in_defs.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="dynamic_ref_in_defs_pydantic_v2.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel"],
)
def test_main_jsonschema_multiple_aliases_required_pydantic_v2(output_file: Path) -> None:
"""Test multiple aliases with AliasChoices on required fields for Pydantic v2. (#2989)."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "multiple_aliases_required.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--aliases",
str(ALIASES_DATA_PATH / "multiple_aliases_required.json"),
"--output-model-type",
"pydantic_v2.BaseModel",
],
)
def test_ref_with_nonstandard_metadata(output_file: Path) -> None:
"""Test $ref with non-standard metadata fields preserves type information.
When $ref is combined with non-standard metadata like 'markdownDescription',
the reference type should be preserved instead of being replaced by the
underlying type. Non-standard fields are annotation-only and should not
trigger schema merging.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_with_nonstandard_metadata.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="ref_with_nonstandard_metadata.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--use-annotated"],
)
def test_ref_nullable_with_nonstandard_metadata(output_file: Path) -> None:
"""Test $ref + nullable: true with non-standard metadata uses reference directly.
When $ref is combined with nullable: true and non-standard metadata like
'markdownDescription', the reference should be used directly with Optional
type annotation instead of creating a merged model.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_nullable_with_nonstandard_metadata.yaml",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="ref_nullable_with_nonstandard_metadata.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--strict-nullable"],
)
def test_ref_with_const(output_file: Path) -> None:
"""Test $ref + const triggers schema merging as const is schema-affecting.
When $ref is combined with 'const', the const keyword structurally affects
the generated type (producing Literal), so schema merging should occur.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_with_const.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="ref_with_const.py",
extra_args=["--output-model-type", "pydantic_v2.BaseModel", "--strict-nullable"],
)
def test_ref_merge_field_metadata(output_file: Path) -> None:
"""Test $ref + const merges ref metadata."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_merge_field_metadata.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
expected_file="ref_merge_field_metadata.py",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--use-frozen-field",
"--field-constraints",
"--use-annotated",
"--strict-nullable",
],
)
def test_ref_merge_additional_properties(output_file: Path) -> None:
"""Test $ref + const merge in additionalProperties root model path."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "ref_merge_additional_properties.json",
output_path=output_file,
input_file_type="jsonschema",
assert_func=assert_file_content,
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--field-constraints",
"--use-annotated",
],
)
def test_main_exact_imports_collapse_root_models_module_class_collision(output_dir: Path) -> None:
"""Test --use-exact-imports with --collapse-root-models when module and class names collide."""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "exact_imports_collapse_root_models",
output_path=output_dir,
input_file_type="jsonschema",
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "exact_imports_collapse_root_models",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-python-version",
"3.10",
"--use-exact-imports",
"--collapse-root-models",
"--use-title-as-name",
"--snake-case-field",
"--disable-timestamp",
],
force_exec_validation=True,
)
def test_main_exact_imports_collapse_root_models_title_array(output_dir: Path) -> None:
"""Test --use-exact-imports with --collapse-root-models when array field has title.
Regression test for https://github.com/koxudaxi/datamodel-code-generator/issues/3001
When an allOf $ref and an array items $ref point to the same type, and the array
field has a title (causing a root model to be created and collapsed), both fields
should use the same import alias.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "exact_imports_collapse_root_models_title",
output_path=output_dir,
input_file_type="jsonschema",
expected_directory=EXPECTED_JSON_SCHEMA_PATH / "exact_imports_collapse_root_models_title",
extra_args=[
"--output-model-type",
"pydantic_v2.BaseModel",
"--target-python-version",
"3.10",
"--use-exact-imports",
"--collapse-root-models",
"--use-title-as-name",
"--snake-case-field",
"--disable-timestamp",
],
force_exec_validation=True,
)
|