swadhinbiswas 🔧 fix: app.run() defaults to 127.0.0.1:8000 (README quickstart) + SVG dot positions + stale docs (publish.yml→wheels.yml, 2.0.8→2.0.9) · 8/8/2026
5a3085e
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
import inspect
import functools
import json
import re
import typing
import warnings
from urllib.parse import quote
from ._justapi import _JustAPIApp, TokenStreamResponse, ValidatedStreamResponse, Database, Mailer as _Mailer
from .exceptions import WebSocketException
from .websockets import WebSocket
from .system import register_system_routes, build_help, build_openapi
from .responses import PlainTextResponse, HTMLResponse, JSONResponse
from .templating import Jinja2Templates
_PY_TYPE_TO_JSON = {
str: "string",
int: "integer",
float: "number",
bool: "boolean",
list: "array",
dict: "object",
type(None): "null",
}
# Built-in health/observability handlers. Registered on every JustAPIApp so the
# Python app exposes Kubernetes probe + metrics endpoints without relying on the
# Rust server's default-route registry (which is bypassed for Python apps, where
# routing happens in the Python handler). The Rust server emits richer Prometheus
# metrics via `with_health_registry` when used standalone.
def _builtin_health():
return {"status": "ok", "components": {}}
def _builtin_live():
return {"status": "alive"}
def _builtin_ready(self):
ready, report = self._app.health_ready()
try:
payload = json.loads(report)
except (ValueError, TypeError):
payload = {"status": "ready" if ready else "not_ready"}
if not ready:
return JSONResponse(payload, status_code=503)
return JSONResponse(payload)
def _builtin_metrics(self, request=None):
guard = _admin_guard(self, request)
if guard is not None:
return guard
body = self._app.metrics_prometheus()
return PlainTextResponse(body)
def _builtin_graphql(app, request=None):
if request is None:
request = {}
method = request.get("method", "GET")
body = request.get("body", b"")
if isinstance(body, str):
body = body.encode("utf-8")
status, content_type, res_body = app._app.graphql_handle(method, body)
if "text/html" in content_type:
return HTMLResponse(res_body, status_code=status)
try:
data = json.loads(res_body)
except Exception:
data = res_body
return JSONResponse(data, status_code=status)
def _builtin_openapi(app, request=None):
"""Serve the generated OpenAPI 3.1 document for the Python app."""
guard = _admin_guard(app, request)
if guard is not None:
return guard
return JSONResponse(build_openapi(app))
def _builtin_docs(app, request=None):
"""Serve Swagger UI (interactive API documentation) for the Python app."""
guard = _admin_guard(app, request)
if guard is not None:
return guard
html = (
"<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n"
" <meta charset=\"UTF-8\">\n <title>API Docs — Swagger UI</title>\n"
" <link rel=\"stylesheet\" href=\"https://unpkg.com/swagger-ui-dist/swagger-ui.css\">\n"
"</head>\n<body>\n <div id=\"swagger-ui\"></div>\n"
" <script src=\"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\"></script>\n"
" <script>\n"
" window.onload = () => {\n"
" window.ui = SwaggerUIBundle({ url: '/openapi.json', dom_id: '#swagger-ui' });\n"
" };\n"
" </script>\n</body>\n</html>\n"
)
return HTMLResponse(html)
def _builtin_redoc(app, request=None):
"""Serve ReDoc (alternative API documentation) for the Python app."""
guard = _admin_guard(app, request)
if guard is not None:
return guard
html = (
"<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n"
" <meta charset=\"UTF-8\">\n <title>API Docs — ReDoc</title>\n"
" <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n"
"</head>\n<body>\n <redoc spec-url='/openapi.json'></redoc>\n"
" <script src=\"https://unpkg.com/redoc/bundles/redoc.standalone.js\"></script>\n"
"</body>\n</html>\n"
)
return HTMLResponse(html)
def _builtin_scalar(app, request=None):
"""Serve Scalar API Reference (modern interactive docs) for the Python app.
Scalar reads the OpenAPI document from ``/openapi.json`` and renders a
clean, fast reference UI. Used for both ``/scalar`` and the home page ``/``.
"""
html = (
"<!doctype html>\n"
"<html lang=\"en\">\n"
" <head>\n"
" <meta charset=\"utf-8\" />\n"
" <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n"
" <title>API Reference — JustAPI</title>\n"
" <style>html, body { margin: 0; padding: 0; height: 100%; }</style>\n"
" </head>\n"
" <body>\n"
" <div id=\"app\"></div>\n"
" <script src=\"https://cdn.jsdelivr.net/npm/@scalar/api-reference\"></script>\n"
" <script>\n"
" Scalar.createApiReference('#app', {\n"
" url: '/openapi.json',\n"
" theme: 'default',\n"
" layout: 'modern',\n"
" });\n"
" </script>\n"
" </body>\n"
"</html>\n"
)
return HTMLResponse(html)
def _model_json_schema(ann):
"""Best-effort JSON schema from a Pydantic / dataclass / model annotation."""
try:
if hasattr(ann, "model_json_schema"):
return ann.model_json_schema()
except Exception:
pass
try:
if hasattr(ann, "__pydantic_model__"):
return ann.__pydantic_model__.schema()
except Exception:
pass
try:
import dataclasses
if dataclasses.is_dataclass(ann):
props, required = {}, []
for f in dataclasses.fields(ann):
props[f.name] = {"type": _PY_TYPE_TO_JSON.get(f.type, "string")}
if f.default is dataclasses.MISSING:
required.append(f.name)
return {"type": "object", "properties": props, "required": required}
except Exception:
pass
return None
def _infer_tool_schema(func):
"""Infer a JSON Schema from a callable's signature / type hints."""
sig = inspect.signature(func)
hints = typing.get_type_hints(func)
props, required = {}, []
for pname, p in sig.parameters.items():
if pname == "self":
continue
ann = hints.get(pname, p.annotation)
if ann is inspect.Parameter.empty:
ann = str
schema = _model_json_schema(ann)
if schema is None:
schema = {"type": _PY_TYPE_TO_JSON.get(ann, "string")}
props[pname] = schema
if p.default is inspect.Parameter.empty:
required.append(pname)
return {
"type": "object",
"properties": props,
"required": required,
}
class RequestValidationError(Exception):
def __init__(self, errors):
self.errors = errors
self.detail = errors
super().__init__(str(errors))
class Depends:
def __init__(self, dependency: typing.Callable, use_cache: bool = True):
self.dependency = dependency
self.use_cache = use_cache
def _is_async_callable(obj):
"""True if `obj` is an async function OR a callable instance whose
`__call__` is async. `inspect.iscoroutinefunction(obj)` returns False for
instances (e.g. `OAuth2PasswordBearer(...)`), which made the DI invoke
async dependencies without awaiting them.
"""
if inspect.iscoroutinefunction(obj):
return True
call = getattr(obj, "__call__", None)
return call is not None and inspect.iscoroutinefunction(call)
class Security(Depends):
"""`Security(dependency)` is `Depends(dependency)` with OAuth2 scope
support, mirroring FastAPI's `Security`. The `scopes` are recorded for
OpenAPI documentation; scope enforcement is the dependency's job.
from justapi import Security
from justapi.auth import OAuth2PasswordBearer
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
@app.get("/items")
def list_items(token: str = Security(oauth2_scheme, scopes=["read"])):
...
"""
def __init__(self, dependency: typing.Callable, use_cache: bool = True, scopes=None):
super().__init__(dependency, use_cache=use_cache)
self.scopes = list(scopes) if scopes else []
class Mailer:
"""SMTP email sender with optional template support.
Usage as a Depends injectable:
from justapi import Mailer
mailer = Mailer(host="smtp.example.com", port=587,
username="user", password="pass",
default_from="[email protected]")
def get_mailer():
return mailer
@app.get("/contact")
def contact(m: Mailer = Depends(get_mailer)):
m.send(to="[email protected]", subject="Hello", body="World")
With Jinja2 templates (requires ``jinja2``):
templates = Jinja2Templates("templates/email")
mailer = Mailer(..., templates=templates)
mailer.send_template("welcome.html", to="[email protected]",
subject="Welcome", name=user.name)
"""
def __init__(
self,
host: str,
port: int = 587,
username: str | None = None,
password: str | None = None,
use_tls: bool = True,
default_from: str | None = None,
default_from_name: str | None = None,
templates: "Jinja2Templates | None" = None,
):
self._mailer = _Mailer(
host=host, port=port,
username=username, password=password,
use_tls=use_tls,
default_from=default_from, default_from_name=default_from_name,
)
self.templates = templates
def send(
self,
to: str,
subject: str,
body: str | None = None,
html: str | None = None,
cc: list[str] | None = None,
bcc: list[str] | None = None,
reply_to: str | None = None,
attachments: list[dict] | None = None,
):
"""Send an email synchronously."""
self._mailer.send(
to=to, subject=subject,
body=body, html=html,
cc=cc, bcc=bcc,
reply_to=reply_to,
attachments=attachments,
)
async def send_async(
self,
to: str,
subject: str,
body: str | None = None,
html: str | None = None,
cc: list[str] | None = None,
bcc: list[str] | None = None,
reply_to: str | None = None,
attachments: list[dict] | None = None,
):
"""Send an email asynchronously."""
await self._mailer.send_async(
to=to, subject=subject,
body=body, html=html,
cc=cc, bcc=bcc,
reply_to=reply_to,
attachments=attachments,
)
def send_template(
self,
template_name: str,
to: str,
subject: str,
cc: list[str] | None = None,
bcc: list[str] | None = None,
reply_to: str | None = None,
attachments: list[dict] | None = None,
**context,
):
"""Render a Jinja2 template and send the result as the email body.
Requires ``jinja2`` and a ``templates`` directory configured on the Mailer.
"""
if self.templates is None:
raise RuntimeError(
"send_template() requires a Jinja2Templates instance. "
"Pass templates=Jinja2Templates('templates/email') to Mailer()."
)
template = self.templates.get_template(template_name)
html = template.render(context)
self.send(
to=to, subject=subject, html=html,
cc=cc, bcc=bcc,
reply_to=reply_to,
attachments=attachments,
)
def __repr__(self):
return f"Mailer(host={self._mailer!r})"
class Session:
"""Agent session state, backed by the Rust session store on the app.
Obtain one by declaring a ``session: Session`` parameter on a route handler
(the id is read from the ``justapi_session`` cookie or ``?session=`` query
param) or by calling ``app.create_session()`` directly.
"""
def __init__(self, app: "JustAPIApp", session_id: str):
self._app = app
self.id = session_id
def get(self):
return self._app.get_session(self.id)
def set(self, data: dict):
return self._app.set_session(self.id, data)
def update(self, **fields):
return self._app.update_session(self.id, **fields)
def delete(self):
return self._app.delete_session(self.id)
def adaptive_batch(max_size: int = 32, window_ms: int = 10):
"""
Decorator to enable adaptive batching for this route.
The wrapped handler must accept a `requests: list[T]` and return a `list[R]` of the same size.
"""
def wrapper(func):
func.__batch_size__ = max_size
func.__batch_window_ms__ = window_ms
return func
return wrapper
def native_async(func=None):
"""Mark a handler as **native-async** — its framework operations (DB
queries, SSE streaming, HTTP calls, serialization) run in Rust at native
speed, and the async dispatch uses the callback-driven resolution path
(no blocking wait, no thread hop). The user's own Python logic still runs
at Python speed (that is physics); everything the framework does for the
request is Rust (ADR-089).
from justapi import JustAPIApp, native_async
app = JustAPIApp()
@app.get("/users/{id}")
@native_async
async def get_user(request):
row = await app.db.fetch_one("SELECT * FROM users WHERE id = ?",
[request.path_params["id"]])
return row
Use it on any async route whose heavy lifting is DB / IO / streaming.
"""
def wrapper(f):
f.__native_async__ = True
return f
if func is None:
return wrapper
return wrapper(func)
class _AppState:
def __setattr__(self, name, value):
self.__dict__[name] = value
def _admin_guard(app, request):
"""Check admin token if configured.
Returns a 403 JSONResponse when the token is set and the request does
not carry ``Authorization: Bearer <token>``, or ``None`` when authorized.
"""
token = getattr(app, 'admin_token', None)
if token is None:
return None
auth_header = ""
if isinstance(request, dict):
hdrs = request.get("headers") or {}
if isinstance(hdrs, dict):
auth_header = hdrs.get("Authorization", "")
elif isinstance(hdrs, list):
for k, v in hdrs:
if k.lower() == b"authorization":
auth_header = v if isinstance(v, str) else v.decode("utf-8", errors="replace")
break
if not auth_header.startswith("Bearer ") or auth_header[7:] != token:
from .responses import JSONResponse
return JSONResponse({"detail": "Forbidden"}, status_code=403)
return None
class JustAPIApp:
def __init__(
self,
title: str = "JustAPIApp",
version: str = "1.0.0",
description: str = None,
openapi_tags: list = None,
dependencies: typing.List[Depends] = None,
servers: list = None,
contact: dict = None,
license_info: dict = None,
terms_of_service: str = None,
openapi_url: str = "/openapi.json",
docs_url: str = "/docs",
redoc_url: str = "/redoc",
scalar_url: str = "/scalar",
admin_token: str = None,
):
self._app = _JustAPIApp()
self.title = title
self.version = version
self.description = description
self.openapi_tags = openapi_tags or []
self.dependencies = dependencies or []
self.servers = servers
self.contact = contact
self.license_info = license_info
self.terms_of_service = terms_of_service
self.openapi_url = openapi_url
self.docs_url = docs_url
self.redoc_url = redoc_url
self.scalar_url = scalar_url
self.exception_handlers = {}
self.middlewares = []
self._named_routes = {}
self.routes = []
self._startup_handlers = []
self._shutdown_handlers = []
self.state = _AppState()
self.admin_token = admin_token
# Built-in probe/metrics endpoints for the Python app.
# Health/live/ready are deliberately unprotected (K8s probes).
self.get("/health", _builtin_health, include_in_schema=False, name="builtin_health")
self.get("/live", _builtin_live, include_in_schema=False, name="builtin_live")
self.get("/ready", lambda: _builtin_ready(self), include_in_schema=False, name="builtin_ready")
self.get("/metrics", lambda request=None: _builtin_metrics(self, request), include_in_schema=False, name="builtin_metrics")
# Interactive API documentation for the Python app. The core server's
# /docs, /redoc, /openapi.json live only in the default router, which the
# Python app replaces via with_handler(); these builtin routes restore
# that DX so the README's "automatic interactive API documentation"
# claim holds for Python apps too.
# Admin-protected: when `admin_token` is set, the request must carry
# `Authorization: Bearer <token>` to access these routes.
self.get("/openapi.json", lambda request=None: _builtin_openapi(self, request), include_in_schema=False, name="builtin_openapi")
self.get("/docs", lambda request=None: _builtin_docs(self, request), include_in_schema=False, name="builtin_docs")
self.get("/redoc", lambda request=None: _builtin_redoc(self, request), include_in_schema=False, name="builtin_redoc")
# The scalar docs page is also protected; the home page (/) is not.
self.get("/scalar", lambda request=None: _admin_guard(self, request) or _builtin_scalar(self, request), include_in_schema=False, name="builtin_scalar")
# The home page opens the interactive API reference (Scalar) so the
# docs are the first thing a visitor sees.
self.get("/", lambda: _builtin_scalar(self), include_in_schema=False, name="builtin_index")
# Built-in GraphQL & Federation Gateway routes.
self.get("/graphql", lambda request=None: _builtin_graphql(self, request), include_in_schema=False, name="builtin_graphql_get")
self.post("/graphql", lambda request=None: _builtin_graphql(self, request), include_in_schema=False, name="builtin_graphql_post")
def graphql(self, path: str = "/graphql"):
"""Register GraphQL & Federation Gateway routes on the specified path (default /graphql)."""
self.get(path, lambda request=None: _builtin_graphql(self, request), include_in_schema=False, name="graphql_get")
self.post(path, lambda request=None: _builtin_graphql(self, request), include_in_schema=False, name="graphql_post")
def _record(self, method, path, handler, *, body_schema=None, schema=None,
experimental=False, **kw):
"""Record a route's metadata on the Python side for introspection.
The Rust runtime owns actual dispatch; this list powers
``build_help`` / ``build_openapi`` and the ``/_system`` endpoints.
"""
name = kw.get("name")
if name is not None:
if name in self._named_routes and not name.startswith("builtin_"):
warnings.warn(f"Named route collision: '{name}' overwritten")
self._named_routes[name] = path
self.routes.append({
"method": method,
"path": path,
"handler": handler,
"body_schema": body_schema,
"schema": schema,
"experimental": experimental,
"dependencies": kw.get("dependencies") or [],
"middlewares": kw.get("middlewares") or [],
"tags": kw.get("tags") or [],
"summary": kw.get("summary"),
"description": kw.get("description"),
"deprecated": kw.get("deprecated"),
"status_code": kw.get("status_code"),
"responses": kw.get("responses"),
"operation_id": kw.get("operation_id"),
"openapi_extra": kw.get("openapi_extra"),
"include_in_schema": kw.get("include_in_schema", True),
"name": name,
})
def middleware(self, middleware_type: str = "http"):
def decorator(func):
if middleware_type == "http":
self.middlewares.append(func)
return func
return decorator
def add_middleware(self, middleware_class, **options):
"""Add a middleware class (compatible with Starlette / FastAPI middleware syntax)."""
name = getattr(middleware_class, "__name__", "")
if "CORS" in name or "cors" in name.lower():
allow_origins = options.get("allow_origins", ["*"])
allow_methods = options.get("allow_methods", ["*"])
allow_headers = options.get("allow_headers", ["*"])
allow_credentials = options.get("allow_credentials", False)
expose_headers = options.get("expose_headers")
max_age = options.get("max_age")
self.add_cors(
allow_origins=allow_origins,
allow_methods=allow_methods,
allow_headers=allow_headers,
allow_credentials=allow_credentials,
expose_headers=expose_headers,
max_age=max_age,
)
else:
try:
instance = middleware_class(app=self, **options)
self.middlewares.append(instance)
except Exception:
self.middlewares.append(middleware_class)
def add_cors(
self,
allow_origins=None,
allow_methods=None,
allow_headers=None,
allow_credentials=False,
expose_headers=None,
max_age=None,
):
"""Configure CORS via the Rust middleware chain.
Handles both OPTIONS preflight (returning 204) and per-response
``Access-Control-*`` header injection. This is a bridge to the
Rust ``Cors`` middleware (not a Python-level middleware), so it
covers ALL routes including Rust-native fast-path and 404s.
Args:
allow_origins: List of allowed origins, or ``["*"]`` for all.
allow_methods: List of allowed HTTP methods.
allow_headers: List of allowed request headers.
allow_credentials: When True, ``Access-Control-Allow-Credentials``
is set and a concrete origin is echoed instead of ``*``.
expose_headers: List of headers the browser is allowed to access.
max_age: ``Access-Control-Max-Age`` in seconds (int).
"""
self._app._set_cors(
allow_origins or ["*"],
allow_methods,
allow_headers,
allow_credentials,
expose_headers,
max_age,
)
def add_exception_handler(self, exc_class, handler):
self.exception_handlers[exc_class] = handler
def _handle_exception(self, request, exc):
for cls in type(exc).mro():
if cls in self.exception_handlers:
res = self.exception_handlers[cls](request, exc)
return res
raise exc
async def _resolve_dependencies_list(self, deps: typing.List[Depends], request: dict):
if "_dep_cache" not in request:
request["_dep_cache"] = {}
if "_dep_cleanup" not in request:
request["_dep_cleanup"] = []
for dep in deps:
dep_sig = inspect.signature(dep.dependency)
dep_kwargs = await self._resolve_kwargs(dep_sig, request)
if dep.use_cache and dep.dependency in request["_dep_cache"]:
continue
is_gen = inspect.isasyncgenfunction(dep.dependency)
is_sync_gen = inspect.isgeneratorfunction(dep.dependency)
if is_gen:
gen = dep.dependency(**dep_kwargs)
res = await gen.__anext__()
request["_dep_cleanup"].append(gen.aclose)
elif is_sync_gen:
gen = dep.dependency(**dep_kwargs)
res = next(gen)
request["_dep_cleanup"].append(gen.close)
elif _is_async_callable(dep.dependency):
res = await dep.dependency(**dep_kwargs)
else:
res = dep.dependency(**dep_kwargs)
if dep.use_cache:
request["_dep_cache"][dep.dependency] = res
async def _resolve_kwargs(self, sig, request):
if "query_params" not in request:
import urllib.parse
qs = request.get("query_string", b"").decode("utf-8")
parsed = urllib.parse.parse_qs(qs)
# parse_qs returns lists, we just take the first item for now
request["query_params"] = {k: v[0] for k, v in parsed.items()}
if "_dep_cache" not in request:
request["_dep_cache"] = {}
if "_dep_cleanup" not in request:
request["_dep_cleanup"] = []
kwargs = {}
for name, param in sig.parameters.items():
if isinstance(param.default, Depends):
if param.default.use_cache and param.default.dependency in request["_dep_cache"]:
kwargs[name] = request["_dep_cache"][param.default.dependency]
continue
dep_sig = inspect.signature(param.default.dependency)
dep_kwargs = await self._resolve_kwargs(dep_sig, request)
is_gen = inspect.isasyncgenfunction(param.default.dependency)
is_sync_gen = inspect.isgeneratorfunction(param.default.dependency)
if is_gen:
gen = param.default.dependency(**dep_kwargs)
res = await gen.__anext__()
request["_dep_cleanup"].append(gen.aclose)
elif is_sync_gen:
gen = param.default.dependency(**dep_kwargs)
res = next(gen)
request["_dep_cleanup"].append(gen.close)
elif _is_async_callable(param.default.dependency):
res = await param.default.dependency(**dep_kwargs)
else:
res = param.default.dependency(**dep_kwargs)
if param.default.use_cache:
request["_dep_cache"][param.default.dependency] = res
kwargs[name] = res
elif name in ("request", "req", "r", "_request") or (hasattr(param.annotation, "__name__") and param.annotation.__name__ == "Request"):
kwargs[name] = request
elif (hasattr(param.annotation, "__name__") and param.annotation.__name__ == "Session") or name == "session":
sid = (request.cookies).get(getattr(self, "_session_cookie", "justapi_session"))
if sid is None:
sid = request.query_params.get("session")
if sid is None:
if getattr(self, "_sessions_enabled", False):
sid = self.create_session()
request["_session_id"] = sid
elif getattr(self, "_sessions_enabled", False) and self.get_session(sid) is None:
self.create_session(id=sid)
request["_session_id"] = sid
kwargs[name] = Session(self, sid)
else:
from .params import Param, Path, Query, Header, Cookie, Body, File, Form
alias = name
param_type = None
default = inspect.Parameter.empty
if isinstance(param.default, Param):
alias = param.default.alias or name
param_type = type(param.default)
default = param.default.default
else:
default = param.default
val = None
found = False
if param_type is Path or (param_type is None and alias in request.path_params):
val = request.path_params.get(alias)
if val is not None: found = True
if not found and (param_type is Query or (param_type is None and alias in request.query_params)):
val = request.query_params.get(alias)
if val is not None: found = True
if not found and param_type is Header:
val = request.headers.get(alias)
if val is not None:
found = True
if not found and param_type is Cookie:
val = request.cookies.get(alias)
if val is not None: found = True
if not found and (param_type is File or param_type is Form or (hasattr(param.annotation, "__name__") and param.annotation.__name__ == "UploadFile")):
form_data = request.get("form")
if form_data:
val = form_data.get(alias)
if val is not None: found = True
if not found and (param_type is Body or name == "body" or name == "payload"):
val = request.get("body")
if val is not None: found = True
if not found and (name == "background_tasks" or (hasattr(param.annotation, "__name__") and param.annotation.__name__ == "BackgroundTasks")):
val = request.get("background_tasks")
found = True
if found:
try:
if val is not None and param.annotation is int and isinstance(val, str):
kwargs[name] = int(val)
elif val is not None and param.annotation is float and isinstance(val, str):
kwargs[name] = float(val)
else:
kwargs[name] = val
except (ValueError, TypeError) as e:
raise RequestValidationError([{"loc": [alias], "msg": str(e), "type": "type_error"}])
else:
if default is inspect.Parameter.empty:
raise RequestValidationError([{"loc": [alias], "msg": "field required", "type": "value_error.missing"}])
kwargs[name] = default
return kwargs
def _resolve_dependencies_list_sync(self, deps: typing.List[Depends], request: dict):
if "_dep_cache" not in request:
request["_dep_cache"] = {}
if "_dep_cleanup" not in request:
request["_dep_cleanup"] = []
for dep in deps:
dep_sig = inspect.signature(dep.dependency)
dep_kwargs = self._resolve_kwargs_sync(dep_sig, request)
if dep.use_cache and dep.dependency in request["_dep_cache"]:
continue
is_sync_gen = inspect.isgeneratorfunction(dep.dependency)
if is_sync_gen:
gen = dep.dependency(**dep_kwargs)
res = next(gen)
request["_dep_cleanup"].append(gen.close)
else:
res = dep.dependency(**dep_kwargs)
if dep.use_cache:
request["_dep_cache"][dep.dependency] = res
def _resolve_kwargs_sync(self, sig, request):
if "query_params" not in request:
import urllib.parse
qs = request.get("query_string", b"").decode("utf-8")
parsed = urllib.parse.parse_qs(qs)
request["query_params"] = {k: v[0] for k, v in parsed.items()}
if "_dep_cache" not in request:
request["_dep_cache"] = {}
if "_dep_cleanup" not in request:
request["_dep_cleanup"] = []
kwargs = {}
for name, param in sig.parameters.items():
if isinstance(param.default, Depends):
if param.default.use_cache and param.default.dependency in request["_dep_cache"]:
kwargs[name] = request["_dep_cache"][param.default.dependency]
continue
dep_sig = inspect.signature(param.default.dependency)
dep_kwargs = self._resolve_kwargs_sync(dep_sig, request)
is_sync_gen = inspect.isgeneratorfunction(param.default.dependency)
if is_sync_gen:
gen = param.default.dependency(**dep_kwargs)
res = next(gen)
request["_dep_cleanup"].append(gen.close)
else:
res = param.default.dependency(**dep_kwargs)
if param.default.use_cache:
request["_dep_cache"][param.default.dependency] = res
kwargs[name] = res
elif name in ("request", "req", "r", "_request") or (hasattr(param.annotation, "__name__") and param.annotation.__name__ == "Request"):
kwargs[name] = request
elif (hasattr(param.annotation, "__name__") and param.annotation.__name__ == "Session") or name == "session":
sid = (request.cookies).get(getattr(self, "_session_cookie", "justapi_session"))
if sid is None:
sid = request.query_params.get("session")
if sid is None:
if getattr(self, "_sessions_enabled", False):
sid = self.create_session()
request["_session_id"] = sid
elif getattr(self, "_sessions_enabled", False) and self.get_session(sid) is None:
self.create_session(id=sid)
request["_session_id"] = sid
kwargs[name] = Session(self, sid)
else:
from .params import Param, Path, Query, Header, Cookie, Body, File, Form
alias = name
param_type = None
default = inspect.Parameter.empty
if isinstance(param.default, Param):
alias = param.default.alias or name
param_type = type(param.default)
default = param.default.default
else:
default = param.default
val = None
found = False
if param_type is Path or (param_type is None and alias in request.path_params):
val = request.path_params.get(alias)
if val is not None: found = True
if not found and (param_type is Query or (param_type is None and alias in request.query_params)):
val = request.query_params.get(alias)
if val is not None: found = True
if not found and param_type is Header:
val = request.headers.get(alias)
if val is not None:
found = True
if not found and param_type is Cookie:
val = request.cookies.get(alias)
if val is not None: found = True
if not found and (param_type is File or param_type is Form or (hasattr(param.annotation, "__name__") and param.annotation.__name__ == "UploadFile")):
form_data = request.get("form")
if form_data:
val = form_data.get(alias)
if val is not None: found = True
if not found and (param_type is Body or name == "body" or name == "payload"):
val = request.get("body")
if val is not None: found = True
if not found and (name == "background_tasks" or (hasattr(param.annotation, "__name__") and param.annotation.__name__ == "BackgroundTasks")):
val = request.get("background_tasks")
found = True
if found:
try:
if val is not None and param.annotation is int and isinstance(val, str):
kwargs[name] = int(val)
elif val is not None and param.annotation is float and isinstance(val, str):
kwargs[name] = float(val)
else:
kwargs[name] = val
except (ValueError, TypeError) as e:
raise RequestValidationError([{"loc": [alias], "msg": str(e), "type": "type_error"}])
else:
if default is inspect.Parameter.empty:
raise RequestValidationError([{"loc": [alias], "msg": "field required", "type": "value_error.missing"}])
kwargs[name] = default
return kwargs
def _apply_middlewares(self, base_handler, route_middlewares=None):
if not self.middlewares and not route_middlewares:
return base_handler
all_middlewares = self.middlewares.copy()
if route_middlewares:
all_middlewares.extend(route_middlewares)
chain = base_handler
# apply in order: the first middleware added is the outermost
for mw in reversed(all_middlewares):
def make_wrapper(mw_func, next_func):
async def wrapped(request):
return await mw_func(request, next_func)
return wrapped
chain = make_wrapper(mw, chain)
return chain
def _wrap_handler(self, handler, route_dependencies=None, route_middlewares=None, native=False):
# The native Rust fast path validates + echoes the request and returns
# without ever calling the Python handler, so it would silently SKIP any
# route- or app-level `dependencies` (e.g. auth) and `middlewares`. That
# is a security hole, so refuse the combination outright. (App-level
# middleware is also bypassed by the native fast path by design — it is a
# validate-and-echo shortcut — so do not rely on auth running there.)
if native and (
self.dependencies
or route_dependencies
or self.middlewares
or route_middlewares
):
raise ValueError(
"native=True cannot be combined with dependencies or route "
"middlewares: the native fast path validates and echoes the "
"request without invoking the handler, so those would be "
"silently bypassed. Use a non-native route, or move the logic "
"into the native validation schema."
)
sig = inspect.signature(handler)
route_deps = route_dependencies or []
all_deps = self.dependencies + route_deps
is_async = inspect.iscoroutinefunction(handler)
for name, param in sig.parameters.items():
if isinstance(param.default, Depends):
if _is_async_callable(param.default.dependency):
is_async = True
for dep in all_deps:
if _is_async_callable(dep.dependency):
is_async = True
has_bg = "background_tasks" in sig.parameters or any(
p.annotation.__name__ == "BackgroundTasks" for p in sig.parameters.values() if hasattr(p.annotation, "__name__")
)
# A handler needs the Python `Request` object (and thus one must be
# built per request) if it takes any parameters, has any dependencies
# to resolve, or is wrapped by any (route- or app-level) middleware —
# middleware runs against the request and would break on an empty dict.
# 0-parameter, dependency-free, middleware-free handlers can skip it.
needs_request = (
bool(sig.parameters)
or bool(all_deps)
or bool(self.middlewares)
or bool(route_middlewares)
)
if is_async:
async def async_wrapper(request):
bg_tasks = None
if has_bg:
from .background import BackgroundTasks
bg_tasks = BackgroundTasks()
request["background_tasks"] = bg_tasks
try:
await self._resolve_dependencies_list(all_deps, request)
kwargs = await self._resolve_kwargs(sig, request)
if inspect.iscoroutinefunction(handler):
result = await handler(**kwargs)
else:
result = handler(**kwargs)
if bg_tasks: bg_tasks()
return result
except Exception as e:
return self._handle_exception(request, e)
finally:
for c in reversed(request.get("_dep_cleanup", [])):
try:
await c()
except Exception:
pass
wrapper = self._apply_middlewares(async_wrapper, route_middlewares)
else:
def sync_wrapper(request):
bg_tasks = None
if has_bg:
from .background import BackgroundTasks
bg_tasks = BackgroundTasks()
request["background_tasks"] = bg_tasks
try:
self._resolve_dependencies_list_sync(all_deps, request)
kwargs = self._resolve_kwargs_sync(sig, request)
result = handler(**kwargs)
if bg_tasks: bg_tasks()
return result
except Exception as e:
return self._handle_exception(request, e)
finally:
for c in reversed(request.get("_dep_cleanup", [])):
try:
c()
except Exception:
pass
if self.middlewares or route_middlewares:
import asyncio
import functools
import contextvars
async def async_base_handler(request):
loop = asyncio.get_running_loop()
ctx = contextvars.copy_context()
return await loop.run_in_executor(None, ctx.run, sync_wrapper, request)
wrapper = self._apply_middlewares(async_base_handler, route_middlewares)
else:
wrapper = sync_wrapper
wrapper._needs_request = needs_request
# Per-handler flag: async handler (or async deps). Rust routes async
# handlers to the parallel async pool (Granian model, ADR-087).
wrapper._is_async = is_async
# native_async marker: propagates `__native_async__` to the wrapper so
# Rust can route it to the fastest dispatch (ADR-089).
wrapper._is_native_async = bool(getattr(handler, "__native_async__", False))
return wrapper
def _resolve_batch_config(self, func):
batch_size = getattr(func, "__batch_size__", None)
batch_window_ms = getattr(func, "__batch_window_ms__", None)
return batch_size, batch_window_ms
def _wrap_batch_handler(self, handler, native=False):
if native and (self.dependencies or self.middlewares):
raise ValueError(
"native=True cannot be combined with dependencies or route "
"middlewares: the native fast path validates and echoes the "
"request without invoking the handler, so those would be "
"silently bypassed."
)
is_async = inspect.iscoroutinefunction(handler)
if is_async:
async def async_batch_wrapper(requests):
return await handler(requests)
return async_batch_wrapper
else:
def sync_batch_wrapper(requests):
return handler(requests)
return sync_batch_wrapper
def _meta(self, responses, openapi_extra):
"""Serialize the OpenAPI metadata dicts to JSON strings for the Rust layer."""
import json
responses_json = json.dumps(responses) if responses is not None else None
extra_json = json.dumps(openapi_extra) if openapi_extra is not None else None
return responses_json, extra_json
def _route_kw(self, tags=None, summary=None, description=None, deprecated=None,
status_code=None, responses=None, operation_id=None, openapi_extra=None,
include_in_schema=True, name=None):
responses_json, extra_json = self._meta(responses, openapi_extra)
return dict(
tags=tags,
summary=summary,
description=description,
deprecated=deprecated or False,
status_code=status_code,
responses=responses_json,
operation_id=operation_id,
openapi_extra=extra_json,
include_in_schema=include_in_schema,
name=name,
)
def get(self, path: str, handler=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True, query_schema=None, native: bool = False, crud_table: str = None, crud_columns: typing.List[str] = None):
if name is not None: self._named_routes[name] = path
kw = self._route_kw(tags, summary, description, deprecated, status_code, responses, operation_id, openapi_extra, include_in_schema, name=name)
kw["native"] = native
kw["crud_table"] = crud_table
kw["crud_columns"] = crud_columns
if handler is None and crud_table is not None:
def _crud_noop(request):
raise AssertionError("crud routes must not invoke the Python handler")
self._app.get(path, _crud_noop, query_schema=query_schema, **kw)
self._record("GET", path, _crud_noop, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return _crud_noop
if handler is None:
def decorator(func):
self._app.get(path, self._wrap_handler(func, route_dependencies=dependencies, route_middlewares=middlewares), query_schema=query_schema, **kw)
self._record("GET", path, func, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return func
return decorator
self._app.get(path, self._wrap_handler(handler, route_dependencies=dependencies, route_middlewares=middlewares), query_schema=query_schema, **kw)
self._record("GET", path, handler, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return handler
def post(self, path: str, handler=None, body_schema=None, schema=None, query_schema=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True, native: bool = False, crud_table: str = None, crud_columns: typing.List[str] = None):
if name is not None: self._named_routes[name] = path
kw = self._route_kw(tags, summary, description, deprecated, status_code, responses, operation_id, openapi_extra, include_in_schema, name=name)
kw["native"] = native
kw["crud_table"] = crud_table
kw["crud_columns"] = crud_columns
if handler is None and crud_table is not None:
# Rust-native CRUD route with no Python handler: register a no-op
# that is never invoked because the CRUD path short-circuits in Rust.
def _crud_noop(request):
raise AssertionError("crud routes must not invoke the Python handler")
self._app.post(path, _crud_noop, body_schema, schema, query_schema=query_schema, **kw)
self._record("POST", path, _crud_noop, body_schema=body_schema, schema=schema, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return _crud_noop
if handler is None:
def decorator(func):
batch_size, batch_window_ms = self._resolve_batch_config(func)
wrapped = self._wrap_batch_handler(func, native=native) if batch_size else self._wrap_handler(func, route_dependencies=dependencies, route_middlewares=middlewares, native=native)
self._app.post(path, wrapped, body_schema, schema, query_schema=query_schema, batch_size=batch_size, batch_window_ms=batch_window_ms, **kw)
self._record("POST", path, func, body_schema=body_schema, schema=schema, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return func
return decorator
batch_size, batch_window_ms = self._resolve_batch_config(handler)
wrapped = self._wrap_batch_handler(handler, native=native) if batch_size else self._wrap_handler(handler, route_dependencies=dependencies, route_middlewares=middlewares, native=native)
self._app.post(path, wrapped, body_schema, schema, query_schema=query_schema, batch_size=batch_size, batch_window_ms=batch_window_ms, **kw)
self._record("POST", path, handler, body_schema=body_schema, schema=schema, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return handler
def put(self, path: str, handler=None, body_schema=None, schema=None, query_schema=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True, native: bool = False, crud_table: str = None, crud_columns: typing.List[str] = None):
if name is not None: self._named_routes[name] = path
kw = self._route_kw(tags, summary, description, deprecated, status_code, responses, operation_id, openapi_extra, include_in_schema, name=name)
kw["native"] = native
kw["crud_table"] = crud_table
kw["crud_columns"] = crud_columns
if handler is None and crud_table is not None:
def _crud_noop(request):
raise AssertionError("crud routes must not invoke the Python handler")
self._app.put(path, _crud_noop, body_schema, schema, query_schema=query_schema, **kw)
self._record("PUT", path, _crud_noop, body_schema=body_schema, schema=schema, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return _crud_noop
if handler is None:
def decorator(func):
batch_size, batch_window_ms = self._resolve_batch_config(func)
wrapped = self._wrap_batch_handler(func, native=native) if batch_size else self._wrap_handler(func, route_dependencies=dependencies, route_middlewares=middlewares, native=native)
self._app.put(path, wrapped, body_schema, schema, query_schema=query_schema, batch_size=batch_size, batch_window_ms=batch_window_ms, **kw)
self._record("PUT", path, func, body_schema=body_schema, schema=schema, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return func
return decorator
batch_size, batch_window_ms = self._resolve_batch_config(handler)
wrapped = self._wrap_batch_handler(handler, native=native) if batch_size else self._wrap_handler(handler, route_dependencies=dependencies, route_middlewares=middlewares, native=native)
self._app.put(path, wrapped, body_schema, schema, query_schema=query_schema, batch_size=batch_size, batch_window_ms=batch_window_ms, **kw)
self._record("PUT", path, handler, body_schema=body_schema, schema=schema, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return handler
def delete(self, path: str, handler=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True, query_schema=None, native: bool = False, crud_table: str = None, crud_columns: typing.List[str] = None):
if name is not None: self._named_routes[name] = path
kw = self._route_kw(tags, summary, description, deprecated, status_code, responses, operation_id, openapi_extra, include_in_schema, name=name)
kw["native"] = native
kw["crud_table"] = crud_table
kw["crud_columns"] = crud_columns
if handler is None and crud_table is not None:
def _crud_noop(request):
raise AssertionError("crud routes must not invoke the Python handler")
self._app.delete(path, _crud_noop, query_schema=query_schema, **kw)
self._record("DELETE", path, _crud_noop, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return _crud_noop
if handler is None:
def decorator(func):
self._app.delete(path, self._wrap_handler(func, route_dependencies=dependencies, route_middlewares=middlewares), query_schema=query_schema, **kw)
self._record("DELETE", path, func, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return func
return decorator
self._app.delete(path, self._wrap_handler(handler, route_dependencies=dependencies, route_middlewares=middlewares), query_schema=query_schema, **kw)
self._record("DELETE", path, handler, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return handler
def patch(self, path: str, handler=None, body_schema=None, schema=None, query_schema=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True, native: bool = False, crud_table: str = None, crud_columns: typing.List[str] = None):
if name is not None: self._named_routes[name] = path
kw = self._route_kw(tags, summary, description, deprecated, status_code, responses, operation_id, openapi_extra, include_in_schema, name=name)
kw["native"] = native
kw["crud_table"] = crud_table
kw["crud_columns"] = crud_columns
if handler is None and crud_table is not None:
def _crud_noop(request):
raise AssertionError("crud routes must not invoke the Python handler")
self._app.patch(path, _crud_noop, body_schema, schema, query_schema=query_schema, **kw)
self._record("PATCH", path, _crud_noop, body_schema=body_schema, schema=schema, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return _crud_noop
if handler is None:
def decorator(func):
batch_size, batch_window_ms = self._resolve_batch_config(func)
wrapped = self._wrap_batch_handler(func, native=native) if batch_size else self._wrap_handler(func, route_dependencies=dependencies, route_middlewares=middlewares, native=native)
self._app.patch(path, wrapped, body_schema, schema, query_schema=query_schema, batch_size=batch_size, batch_window_ms=batch_window_ms, **kw)
self._record("PATCH", path, func, body_schema=body_schema, schema=schema, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return func
return decorator
batch_size, batch_window_ms = self._resolve_batch_config(handler)
wrapped = self._wrap_batch_handler(handler, native=native) if batch_size else self._wrap_handler(handler, route_dependencies=dependencies, route_middlewares=middlewares, native=native)
self._app.patch(path, wrapped, body_schema, schema, query_schema=query_schema, batch_size=batch_size, batch_window_ms=batch_window_ms, **kw)
self._record("PATCH", path, handler, body_schema=body_schema, schema=schema, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return handler
def query(self, path: str, handler=None, body_schema=None, schema=None, query_schema=None, experimental: bool = True, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True, native: bool = False):
"""Register a route for the HTTP QUERY method (RFC 10008).
QUERY is safe and idempotent like GET, but carries a request body
like POST — ideal for queries too large for the URI. By default the
generated OpenAPI operation is tagged ``experimental``.
"""
kw = self._route_kw(tags, summary, description, deprecated, status_code, responses, operation_id, openapi_extra, include_in_schema, name=name)
kw["native"] = native
if handler is None:
def decorator(func):
self._app.query(path, self._wrap_handler(func, route_dependencies=dependencies, route_middlewares=middlewares, native=native), body_schema, schema, query_schema=query_schema, experimental=experimental, **kw)
self._record("QUERY", path, func, body_schema=body_schema, schema=schema, query_schema=query_schema, experimental=experimental, dependencies=dependencies, middlewares=middlewares, **kw)
return func
return decorator
self._app.query(path, self._wrap_handler(handler, route_dependencies=dependencies, route_middlewares=middlewares, native=native), body_schema, schema, query_schema=query_schema, experimental=experimental, **kw)
self._record("QUERY", path, handler, body_schema=body_schema, schema=schema, query_schema=query_schema, experimental=experimental, dependencies=dependencies, middlewares=middlewares, **kw)
return handler
def head(self, path: str, handler=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True, query_schema=None, native: bool = False):
if name is not None: self._named_routes[name] = path
kw = self._route_kw(tags, summary, description, deprecated, status_code, responses, operation_id, openapi_extra, include_in_schema, name=name)
kw["native"] = native
if handler is None:
def decorator(func):
self._app.head(path, self._wrap_handler(func, route_dependencies=dependencies, route_middlewares=middlewares), query_schema=query_schema, **kw)
self._record("HEAD", path, func, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return func
return decorator
self._app.head(path, self._wrap_handler(handler, route_dependencies=dependencies, route_middlewares=middlewares), query_schema=query_schema, **kw)
self._record("HEAD", path, handler, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return handler
def options(self, path: str, handler=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True, query_schema=None, native: bool = False):
if name is not None: self._named_routes[name] = path
kw = self._route_kw(tags, summary, description, deprecated, status_code, responses, operation_id, openapi_extra, include_in_schema, name=name)
kw["native"] = native
if handler is None:
def decorator(func):
self._app.options(path, self._wrap_handler(func, route_dependencies=dependencies, route_middlewares=middlewares), query_schema=query_schema, **kw)
self._record("OPTIONS", path, func, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return func
return decorator
self._app.options(path, self._wrap_handler(handler, route_dependencies=dependencies, route_middlewares=middlewares), query_schema=query_schema, **kw)
self._record("OPTIONS", path, handler, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return handler
def trace(self, path: str, handler=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True, query_schema=None, native: bool = False):
kw = self._route_kw(tags, summary, description, deprecated, status_code, responses, operation_id, openapi_extra, include_in_schema, name=name)
kw["native"] = native
if handler is None:
def decorator(func):
self._app.trace(path, self._wrap_handler(func, route_dependencies=dependencies, route_middlewares=middlewares), query_schema=query_schema, **kw)
self._record("TRACE", path, func, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return func
return decorator
self._app.trace(path, self._wrap_handler(handler, route_dependencies=dependencies, route_middlewares=middlewares), query_schema=query_schema, **kw)
self._record("TRACE", path, handler, query_schema=query_schema, dependencies=dependencies, middlewares=middlewares, **kw)
return handler
def frontend(self, path: str, directory: str, html: bool = True, check_dir: bool = True):
"""Serve a static frontend (SPA) from ``directory`` under ``path``.
When ``html`` is true unknown routes fall back to ``index.html``
(SPA client-side routing), mirroring FastAPI's ``StaticFiles(html=True)``.
"""
fallback = "index.html" if html else None
self._app.frontend(path, directory, fallback, check_dir)
return directory
def add_plugin(self, plugin):
self._app.use(plugin)
def use(self, plugin):
self._app.use(plugin)
def set_database(
self,
db,
init_sql=None,
pragmas=None,
wal=False,
acquire_timeout=None,
idle_timeout=None,
max_lifetime=None,
health_check_interval=None,
isolation=None,
request_acquire_timeout=None,
):
def _build(existing):
return Database(
existing.url,
max_connections=existing.max_connections,
init_sql=init_sql if init_sql is not None else existing.init_sql,
pragmas=pragmas if pragmas is not None else existing.pragmas,
acquire_timeout=acquire_timeout
if acquire_timeout is not None
else existing.acquire_timeout,
idle_timeout=idle_timeout if idle_timeout is not None else existing.idle_timeout,
max_lifetime=max_lifetime if max_lifetime is not None else existing.max_lifetime,
health_check_interval=health_check_interval
if health_check_interval is not None
else existing.health_check_interval,
isolation=isolation if isolation is not None else existing.isolation,
request_acquire_timeout=request_acquire_timeout
if request_acquire_timeout is not None
else existing.request_acquire_timeout,
)
if isinstance(db, str):
db = Database(
db,
init_sql=init_sql,
pragmas=pragmas,
acquire_timeout=acquire_timeout,
idle_timeout=idle_timeout,
max_lifetime=max_lifetime,
health_check_interval=health_check_interval,
isolation=isolation,
request_acquire_timeout=3.0
if request_acquire_timeout is None
else request_acquire_timeout,
)
else:
db = _build(db)
if wal:
existing = list(db.pragmas or [])
if "journal_mode=WAL" not in existing:
existing.append("journal_mode=WAL")
db = Database(
db.url,
max_connections=db.max_connections,
init_sql=db.init_sql,
pragmas=existing,
acquire_timeout=db.acquire_timeout,
idle_timeout=db.idle_timeout,
max_lifetime=db.max_lifetime,
health_check_interval=db.health_check_interval,
isolation=db.isolation,
request_acquire_timeout=db.request_acquire_timeout,
)
# Hand the config to Rust as a plain `dict` (via the Python-side
# `config_dict()`, which reads the real `Database` fields). Reading
# `Option`/`f64` fields off a `Database` instance from Rust hits a
# pyo3 reconstruction quirk and returns defaults, so we never pass the
# object directly across the FFI.
self._app.set_database(db.config_dict())
def connect_database(self):
"""Connect the configured database pool eagerly, so `app.db` is usable
immediately after `app.set_database(...)` — from a REPL, a test, or a
migration step — not only once the server has started. Idempotent: calling
it again (or relying on `run()` to connect) is a no-op. Raises if no
database was configured or the connection fails.
app.set_database("postgres://localhost/app")
app.connect_database()
print(app.db.query("SELECT 1"))
"""
self._app.connect_database()
@property
def db(self):
"""Resolved DB pool handle (`DbPool`). Connects on first access if a
database was configured with `app.set_database(...)`, so it works both
before and after `app.run()`. Returns `None` if no database was configured.
Use it from handlers to run arbitrary, injection-safe SQL in Rust:
@app.get("/reports")
def reports(request):
return app.db.query("SELECT * FROM items WHERE qty > ?", [3])
"""
try:
self._app.connect_database()
except Exception as e:
warnings.warn(f"Database connection failed: {e}")
return self._app.db_pool()
def enable_gateway(self, config_path: str):
self._app.enable_gateway(config_path)
def enable_http3(self, cert_path: str, key_path: str):
"""Enable an HTTP/3 (QUIC) listener alongside the TCP server.
``run(addr)`` also binds the same address over UDP and serves the same
application handler with HTTP/3. QUIC requires TLS 1.3, so PEM
certificate and private-key files are required:
app.enable_http3(cert_path="certs/fullchain.pem",
key_path="certs/privkey.pem")
app.run("0.0.0.0:443")
Requires the ``http3`` build feature; without it this method raises.
"""
if not hasattr(self._app, "enable_http3"):
raise NotImplementedError(
"HTTP/3 support is not compiled into this build — rebuild with "
"the `http3` feature (justapi-core) or install a wheel built with it."
)
self._app.enable_http3(cert_path, key_path)
def enable_circuit_breaker(self, failure_threshold: int = 5, reset_timeout_ms: int = 10000):
"""
Enables a per-route circuit breaker.
If a handler fails `failure_threshold` times in a row, the circuit opens,
immediately rejecting requests with 503 Service Unavailable for `reset_timeout_ms`.
"""
self._app.enable_circuit_breaker(failure_threshold, reset_timeout_ms)
def enable_request_coalescing(self, headers: typing.List[str] = None):
"""
Enable request coalescing (singleflight).
When many concurrent, identical requests arrive for the same route, only
one is allowed to reach the handler; the rest share its response. This
collapses thundering-herd traffic on hot, read-only endpoints (e.g. a
leaderboard or a model lookup) into a single upstream call.
By default requests are keyed on ``(method, uri)``. Pass ``headers``
(e.g. ``["accept"]``) to also key on those request header values, so
distinct representations of the same resource are not collapsed together.
"""
self._app.enable_request_coalescing(headers)
def enable_secure_headers(self, with_hsts: bool = False):
"""
Apply safe HTTP security headers to every response:
``X-Content-Type-Options: nosniff``, ``X-Frame-Options: DENY``,
``Content-Security-Policy: default-src 'self'``, and
``X-XSS-Protection: 0``.
HSTS is omitted by default because the Python server terminates
connections in plaintext. Pass ``with_hsts=True`` only when you
terminate TLS in-process. Note that the default CSP (``'self'``) will
block third-party/CDN resources — relax it via the Rust
``SecurityHeaders`` builder if your frontend needs them.
"""
self._app.enable_secure_headers(with_hsts)
def set_jwt_auth(self, secret: str, algorithm: str = "HS256"):
"""
Enable Rust-native JWT authentication middleware.
Validates every incoming request using the Rust JwtAuth middleware.
Decoded claims are automatically injected into ``request["auth"]``.
Args:
secret: The HMAC shared secret.
algorithm: Signing algorithm (default ``"HS256"``).
"""
self._app._set_jwt_auth(secret, algorithm)
def register_health_check(self, name: str, check: typing.Callable[[], bool]):
"""
Register a dependency readiness probe used by the ``/ready`` endpoint.
``check`` is a zero-argument callable invoked synchronously under the
GIL. Returning truthy (or raising nothing) means the dependency is
healthy; returning falsy or raising marks it unhealthy and makes
``/ready`` return 503. The ``name`` identifies the component in the
readiness report.
"""
self._app.register_health_check(name, check)
def set_grpc_addr(self, addr: str):
self._app.set_grpc_addr(addr)
def add_grpc_service(self, servicer, add_func_to_server):
server = _JustAPIGrpcMockServer(self)
add_func_to_server(servicer, server)
def include_controller(self, controller_cls):
path_prefix = getattr(controller_cls, "__controller_path__", "")
controller_deps = getattr(controller_cls, "__controller_dependencies__", [])
# Instantiate controller
instance = controller_cls()
for name, method in inspect.getmembers(instance, predicate=inspect.ismethod):
# check if it has routing info
if hasattr(method, "__route_info__"):
route = method.__route_info__
path = path_prefix + route["path"]
combined_deps = controller_deps + route["dependencies"]
if route["method"] == "GET":
self.get(path, method, dependencies=combined_deps)
elif route["method"] == "POST":
self.post(path, method, body_schema=route["body_schema"], schema=route["schema"], dependencies=combined_deps)
elif route["method"] == "PUT":
self.put(path, method, body_schema=route["body_schema"], schema=route["schema"], dependencies=combined_deps)
elif route["method"] == "DELETE":
self.delete(path, method, dependencies=combined_deps)
elif route["method"] == "QUERY":
self.query(path, method, body_schema=route["body_schema"], schema=route["schema"], experimental=route.get("experimental", True), dependencies=combined_deps)
elif route["method"] == "SSE":
self._app.get(path, self._wrap_sse_handler(method))
elif route["method"] == "WS":
self._app.websocket(path, method)
def route(self, path: str, methods: typing.List[str] = None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None):
if methods is None:
methods = ["GET"]
def decorator(func):
for method in methods:
m = method.upper()
if m == "GET":
self.get(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "POST":
self.post(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "PUT":
self.put(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "DELETE":
self.delete(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "PATCH":
self.patch(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "QUERY":
self.query(path, func, dependencies=dependencies, middlewares=middlewares)
return func
return decorator
def add_api_route(self, path: str, endpoint: typing.Callable, methods: typing.List[str] = None, **kwargs):
"""Register a route non-decoratively (FastAPI/Starlette parity).
Usage::
def my_handler(request):
return {"ok": True}
app.add_api_route("/path", my_handler, methods=["GET", "POST"])
"""
for method in (methods or ["GET"]):
m = method.upper()
getattr(self, m.lower())(path, endpoint, **kwargs)
def add_api_websocket_route(self, path: str, endpoint: typing.Callable):
"""Register a WebSocket route non-decoratively (FastAPI/Starlette parity).
Usage::
async def my_ws(ws):
await ws.accept()
await ws.send_text("connected")
app.add_api_websocket_route("/ws", my_ws)
"""
self.websocket(path, endpoint)
def mount(self, path: str, app_or_directory, name: str = None):
"""Mount a sub-application or static directory at a path.
Mirrors FastAPI/Starlette ``app.mount()``.
Usage::
# Mount a static directory
app.mount("/static", "static", name="static")
# Mount an APIRouter as a sub-app
app.mount("/api/v1", users_router)
"""
if isinstance(app_or_directory, str):
return self.frontend(path, app_or_directory)
if hasattr(app_or_directory, "routes"):
return self.include_router(app_or_directory, prefix=path)
raise ValueError(
"mount() expects a directory path (str) or an APIRouter "
f"instance, got {type(app_or_directory).__name__}"
)
def on_event(self, event_type: str):
"""Register a startup/shutdown event handler (FastAPI parity).
Usage::
@app.on_event("startup")
def init_db():
...
@app.on_event("shutdown")
def close_pool():
...
"""
if event_type not in ("startup", "shutdown"):
raise ValueError(f"event_type must be 'startup' or 'shutdown', got {event_type!r}")
def decorator(func):
if event_type == "startup":
self._startup_handlers.append(func)
else:
self._shutdown_handlers.append(func)
return func
return decorator
def include_router(
self,
router,
prefix: str = "",
tags: typing.List[str] = None,
dependencies: typing.List[Depends] = None,
responses: dict = None,
deprecated: bool = None,
include_in_schema: bool = None,
):
"""Include routes from an APIRouter.
Mirrors FastAPI's ``app.include_router()`` exactly.
Merge order (FastAPI semantics)::
include deps + router deps + route deps
include tags + router tags + route tags
Args:
router: The APIRouter to include.
prefix: URL prefix prepended to every route (in addition to the router's own prefix).
tags: Tags prepended to every route's OpenAPI tags.
dependencies: Dependencies prepended to every route (include-level).
responses: Additional OpenAPI responses for every route.
deprecated: Force-deprecate all routes in this include.
include_in_schema: Override schema visibility for all routes.
"""
include_deps = dependencies or []
include_responses = responses or {}
for route in router.routes:
path = prefix + route["path"]
# Merge order: include-level -> router-level -> route-level (FastAPI parity).
combined_deps = include_deps + router.dependencies + route["dependencies"]
combined_mws = router.middlewares + route.get("middlewares", [])
route_tags = (tags or []) + (router.tags or []) + (route.get("tags") or [])
route_responses = {**include_responses, **(route.get("responses") or {})}
route_deprecated = deprecated if deprecated is not None else route.get("deprecated", False)
route_include = include_in_schema if include_in_schema is not None else route.get("include_in_schema", True)
kw = dict(
dependencies=combined_deps,
middlewares=combined_mws,
tags=route_tags or None,
summary=route.get("summary"),
description=route.get("description"),
deprecated=route_deprecated,
status_code=route.get("status_code"),
responses=route_responses or None,
operation_id=route.get("operation_id"),
openapi_extra=route.get("openapi_extra"),
include_in_schema=route_include,
name=route.get("name"),
)
if route["method"] == "GET":
self.get(path, route["handler"], **kw)
elif route["method"] == "POST":
self.post(path, route["handler"], body_schema=route.get("body_schema"), schema=route.get("schema"), **kw)
elif route["method"] == "PUT":
self.put(path, route["handler"], body_schema=route.get("body_schema"), schema=route.get("schema"), **kw)
elif route["method"] == "PATCH":
self.patch(path, route["handler"], body_schema=route.get("body_schema"), schema=route.get("schema"), **kw)
elif route["method"] == "DELETE":
self.delete(path, route["handler"], **kw)
elif route["method"] == "QUERY":
self.query(path, route["handler"], body_schema=route.get("body_schema"), schema=route.get("schema"), experimental=route.get("experimental", True), **kw)
elif route["method"] == "HEAD":
self.head(path, route["handler"], **kw)
elif route["method"] == "OPTIONS":
self.options(path, route["handler"], **kw)
elif route["method"] == "TRACE":
self.trace(path, route["handler"], **kw)
elif route["method"] == "FRONTEND":
self.frontend(path, route["directory"], html=route.get("html", True), check_dir=route.get("check_dir", True))
elif route["method"] == "SSE":
self._app.get(path, self._wrap_sse_handler(route["handler"]))
elif route["method"] == "WS":
self._app.websocket(path, route["handler"])
def url_for(self, name, **path_params):
"""Build a URL path for a named route, substituting path parameters.
Mirrors FastAPI/Starlette ``request.url_for(name, **params)``.
"""
try:
path = self._named_routes[name]
except KeyError:
raise KeyError(f"No route named {name!r} is registered")
def repl(m):
p = m.group(1)
if p not in path_params:
raise KeyError(f"Missing path parameter {p!r} for route {name!r}")
return quote(str(path_params[p]), safe="")
return re.sub(r"{([^}]+)}", repl, path)
# --- Native MCP tool surface (Rust registry; Python is thin glue) ---
def tool(self, func=None, *, name=None, description=None, input_schema=None, annotations=None):
"""Register a Python callable as a native MCP tool.
The tool is stored in the Rust registry and exposed over
``/_system/tools`` and the bundled MCP server. The input JSON schema is
inferred from the function signature / type hints unless ``input_schema``
is given. Schema inference is Python glue; the registry and serving live
in Rust.
Usable both bare (``@app.tool``) and with arguments
(``@app.tool(description="...")``).
Example::
@app.tool(description="Add two numbers")
def add(a: int, b: int) -> int:
return a + b
"""
def decorator(f):
tool_name = name or f.__name__
tool_desc = description or (inspect.getdoc(f) or f"Tool {tool_name}")
schema_json = input_schema
if schema_json is None:
schema_json = _infer_tool_schema(f)
if isinstance(schema_json, (dict, list)):
schema_json = json.dumps(schema_json)
self._app.register_tool(tool_name, tool_desc, schema_json, f)
return f
if func is not None and callable(func):
return decorator(func)
return decorator
def list_tools(self):
"""Return registered tools in MCP ``tools/list`` shape (list of dicts)."""
return self._app.list_tools()
def call_tool(self, name, arguments=None):
"""Invoke a registered tool; returns the handler result (or a coroutine
if the handler is async)."""
return self._app.call_tool(name, json.dumps(arguments or {}))
# --- Agent session state (Rust-backed store) ---
def create_session(self, data: dict = None, id: str = None):
"""Create a new session, optionally seeded with a JSON dict and/or a
caller-supplied id (used to materialize a known session id such as one
passed via ``?session=``)."""
raw = json.dumps(data) if data is not None else None
return self._app.create_session(id, raw)
def get_session(self, id: str):
"""Return a session's data as a dict, or None if unknown."""
raw = self._app.get_session(id)
return json.loads(raw) if raw else None
def set_session(self, id: str, data: dict):
return self._app.set_session(id, json.dumps(data))
def update_session(self, id: str, **fields):
return self._app.update_session(id, json.dumps(fields))
def delete_session(self, id: str):
return self._app.delete_session(id)
def enable_sessions(self, cookie_name: str = "justapi_session"):
"""Enable automatic session id resolution for injected ``Session`` params."""
self._sessions_enabled = True
self._session_cookie = cookie_name
return self
# --- Streaming validated structured output ---
def stream_json(self, path: str, schema=None, mode: str = "ndjson", handler=None, dependencies=None):
"""Register a route that streams JSON objects, validating each against
``schema`` (a JSON Schema dict/str) before it is sent to the client.
The handler must return a (sync or async) generator yielding
JSON-serialisable Python objects. ``mode`` is ``"ndjson"`` (one object
per line) or ``"array"`` (a single JSON array). Validation runs in Rust.
The handler's parameters participate in normal dependency injection, so
``session: Session`` and query-string params work exactly as on a regular
route.
"""
schema_json = schema if isinstance(schema, str) else json.dumps(schema or {})
def decorator(func):
@functools.wraps(func)
def adapted(*args, **kwargs):
gen = func(*args, **kwargs)
return ValidatedStreamResponse(gen, schema_json, mode)
self._app.get(path, self._wrap_handler(adapted, route_dependencies=dependencies))
self._record("GET", path, func)
return func
if handler is None:
return decorator
return decorator(handler)
def enable_system_routes(self):
"""Mount ``/_system/help``, ``/_system/help/{name}`` and ``/_system/openapi``.
These expose the app's full route metadata (signatures, parameters,
schemas, docstrings, examples) over HTTP for editors and AI agents.
"""
register_system_routes(self)
return self
def run(self, addr: str = "127.0.0.1:8000", max_body_size: int = 50 * 1024 * 1024):
# Execute startup handlers (FastAPI on_event parity).
for handler in self._startup_handlers:
if inspect.iscoroutinefunction(handler):
import asyncio
asyncio.run(handler())
else:
handler()
# Start the native Rust scheduler (if any jobs were registered) so cron
# and interval jobs run for the lifetime of the server.
from ._justapi import Scheduler
Scheduler().start()
try:
self._app.run(addr, max_body_size)
except KeyboardInterrupt:
pass
finally:
# Execute shutdown handlers (FastAPI on_event parity).
for handler in self._shutdown_handlers:
try:
if inspect.iscoroutinefunction(handler):
import asyncio
asyncio.run(handler())
else:
handler()
except Exception:
pass
def schedule(self, cron_expr, func, *args, **kwargs):
"""Register a cron job (native Rust scheduler).
``cron_expr`` is a standard 5-field cron expression evaluated in **UTC**.
The job ``func`` (plus ``*args`` / ``**kwargs``) is dispatched onto the
same Rust background-task worker pool as ``BackgroundTasks``, so it runs
with the GIL released. Jobs are in-memory (not persisted) in v1.
app.schedule("*/5 * * * *", cleanup_tmp)
app.schedule("0 0 * * *", daily_report, "[email protected]")
"""
from ._justapi import Scheduler
return Scheduler().schedule(cron_expr, func, *args, **kwargs)
def every(self, seconds, func, *args, **kwargs):
"""Register an interval job (native Rust scheduler).
Fires ``func`` every ``seconds`` (first fire is one interval after
registration). Dispatched onto the Rust background-task worker pool.
app.every(30, flush_cache)
app.every(3600, poll_upstream, url="https://...")
"""
from ._justapi import Scheduler
return Scheduler().every(seconds, func, *args, **kwargs)
def _wrap_sse_handler(self, func):
"""Wrap a generator/async-generator handler into a TokenStreamResponse."""
if inspect.isasyncgenfunction(func):
def wrapper(request):
return TokenStreamResponse(func(request))
return wrapper
def wrapper(request):
gen = func(request)
async def agen():
for item in gen:
yield item
return TokenStreamResponse(agen())
return wrapper
def sse(self, path: str, handler=None):
"""Register a Server-Sent Events route.
The handler may be a sync or async generator yielding strings/bytes.
Each yielded item is streamed to the client as an SSE event.
"""
if handler is None:
def decorator(func):
self._app.get(path, self._wrap_sse_handler(func))
return func
return decorator
self._app.get(path, self._wrap_sse_handler(handler))
return handler
def sse_native(self, path: str, count: int = 10, interval_ms: int = 100):
"""Register a **Rust-native** Server-Sent Events route (ADR-088).
The server streams ``count`` events at ``interval_ms`` spacing, generated
entirely in Rust (tokio + mpsc + streaming response). No Python handler,
no GIL, no generator pump — the stream runs at native speed.
app.sse_native("/events", count=1000, interval_ms=0) # 1000 events, no delay
"""
self._app.sse_native(path, count, interval_ms)
return self
def websocket(self, path: str, handler=None):
"""Register a WebSocket route.
The handler is an async function receiving a single `WebSocket` object:
async def handler(ws):
await ws.accept()
msg = await ws.receive_text()
await ws.send_text(msg)
await ws.close()
"""
if handler is None:
def decorator(func):
self._app.websocket(path, func)
return func
return decorator
self._app.websocket(path, handler)
return handler
@property
def _inner(self):
return self._app
class APIRouter:
def __init__(self, prefix: str = "", tags: typing.List[str] = None, responses: dict = None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, callbacks: typing.List[typing.Callable] = None, deprecated: bool = False, name: str = None, include_in_schema: bool = True):
self.prefix = prefix
self.tags = tags or []
self.responses = responses
self.dependencies = dependencies or []
self.middlewares = middlewares or []
self.callbacks = callbacks or []
self.deprecated = deprecated
self.include_in_schema = include_in_schema
self.routes = []
self._named_routes = {}
def _store(self, method, path, handler, body_schema=None, schema=None, experimental=False,
dependencies=None, middlewares=None, tags=None, summary=None, description=None,
deprecated=None, status_code=None, responses=None, operation_id=None,
openapi_extra=None, include_in_schema=None, name=None):
full_path = self.prefix + path
# Route-level tags override the router default; include-level merging
# happens in JustAPIApp.include_router.
if name is not None:
if name in self._named_routes and not name.startswith("builtin_"):
warnings.warn(f"Named route collision: '{name}' overwritten")
self._named_routes[name] = full_path
route_tags = tags if tags is not None else []
route_responses = responses if responses is not None else self.responses
route_deprecated = deprecated if deprecated else self.deprecated
route_include = include_in_schema if include_in_schema is not None else self.include_in_schema
self.routes.append({
"method": method,
"path": full_path,
"handler": handler,
"body_schema": body_schema,
"schema": schema,
"experimental": experimental,
"dependencies": dependencies or [],
"middlewares": middlewares or [],
"tags": route_tags or [],
"summary": summary,
"description": description,
"deprecated": route_deprecated,
"status_code": status_code,
"responses": route_responses,
"operation_id": operation_id,
"openapi_extra": openapi_extra,
"include_in_schema": route_include,
"name": name,
})
def get(self, path: str, handler=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True):
if handler is None:
def decorator(func):
self._store("GET", path, func, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return func
return decorator
self._store("GET", path, handler, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return handler
def post(self, path: str, handler=None, body_schema=None, schema=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True):
if handler is None:
def decorator(func):
self._store("POST", path, func, body_schema=body_schema, schema=schema, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return func
return decorator
self._store("POST", path, handler, body_schema=body_schema, schema=schema, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return handler
def put(self, path: str, handler=None, body_schema=None, schema=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True):
if handler is None:
def decorator(func):
self._store("PUT", path, func, body_schema=body_schema, schema=schema, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return func
return decorator
self._store("PUT", path, handler, body_schema=body_schema, schema=schema, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return handler
def patch(self, path: str, handler=None, body_schema=None, schema=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True):
if handler is None:
def decorator(func):
self._store("PATCH", path, func, body_schema=body_schema, schema=schema, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return func
return decorator
self._store("PATCH", path, handler, body_schema=body_schema, schema=schema, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return handler
def delete(self, path: str, handler=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True):
if handler is None:
def decorator(func):
self._store("DELETE", path, func, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return func
return decorator
self._store("DELETE", path, handler, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return handler
def query(self, path: str, handler=None, body_schema=None, schema=None, experimental: bool = True, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True):
if handler is None:
def decorator(func):
self._store("QUERY", path, func, body_schema=body_schema, schema=schema, experimental=experimental, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return func
return decorator
self._store("QUERY", path, handler, body_schema=body_schema, schema=schema, experimental=experimental, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return handler
def head(self, path: str, handler=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True):
if handler is None:
def decorator(func):
self._store("HEAD", path, func, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return func
return decorator
self._store("HEAD", path, handler, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return handler
def options(self, path: str, handler=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True):
if handler is None:
def decorator(func):
self._store("OPTIONS", path, func, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return func
return decorator
self._store("OPTIONS", path, handler, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return handler
def trace(self, path: str, handler=None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None, tags: typing.List[str] = None, summary: str = None, description: str = None, deprecated: bool = False, status_code: int = None, responses: dict = None, operation_id: str = None, openapi_extra: dict = None, name: str = None, include_in_schema: bool = True):
if handler is None:
def decorator(func):
self._store("TRACE", path, func, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return func
return decorator
self._store("TRACE", path, handler, dependencies=dependencies, middlewares=middlewares, tags=tags, summary=summary, description=description, deprecated=deprecated, status_code=status_code, responses=responses, operation_id=operation_id, openapi_extra=openapi_extra, include_in_schema=include_in_schema, name=name)
return handler
def frontend(self, path: str, directory: str, html: bool = True, check_dir: bool = True):
"""Register a static frontend (SPA) mount under ``path``."""
self.routes.append({"method": "FRONTEND", "path": path, "directory": directory, "html": html, "check_dir": check_dir})
def sse(self, path: str, handler=None, dependencies: typing.List[Depends] = None):
if handler is None:
def decorator(func):
self.routes.append({"method": "SSE", "path": self.prefix + path, "handler": func, "dependencies": dependencies or []})
return func
return decorator
self.routes.append({"method": "SSE", "path": self.prefix + path, "handler": handler, "dependencies": dependencies or []})
return handler
def websocket(self, path: str, handler=None, dependencies: typing.List[Depends] = None):
if handler is None:
def decorator(func):
self.routes.append({"method": "WS", "path": self.prefix + path, "handler": func, "dependencies": dependencies or []})
return func
return decorator
self.routes.append({"method": "WS", "path": self.prefix + path, "handler": handler, "dependencies": dependencies or []})
return handler
def route(self, path: str, methods: typing.List[str] = None, dependencies: typing.List[Depends] = None, middlewares: typing.List[typing.Callable] = None):
if methods is None:
methods = ["GET"]
def decorator(func):
for method in methods:
m = method.upper()
if m == "GET":
self.get(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "POST":
self.post(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "PUT":
self.put(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "DELETE":
self.delete(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "PATCH":
self.patch(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "QUERY":
self.query(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "HEAD":
self.head(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "OPTIONS":
self.options(path, func, dependencies=dependencies, middlewares=middlewares)
elif m == "TRACE":
self.trace(path, func, dependencies=dependencies, middlewares=middlewares)
return func
return decorator
def include_router(
self,
router,
prefix: str = "",
tags: typing.List[str] = None,
dependencies: typing.List[Depends] = None,
responses: dict = None,
deprecated: bool = None,
):
"""Include routes from another APIRouter (sub-router support / FastAPI parity).
Merge order (FastAPI semantics)::
parent router deps + include deps + sub router deps + route deps
include tags + parent tags + sub tags + route tags
"""
for name, path in router._named_routes.items():
if name in self._named_routes and not name.startswith("builtin_"):
warnings.warn(f"Named route collision: '{name}' overwritten by include_router")
self._named_routes.update(router._named_routes)
for route in router.routes:
new_route = route.copy()
new_route["path"] = self.prefix + prefix + route["path"]
new_route["dependencies"] = (dependencies or []) + self.dependencies + router.dependencies + route["dependencies"]
new_route["middlewares"] = self.middlewares + router.middlewares + route.get("middlewares", [])
new_route["tags"] = (tags or []) + (self.tags or []) + (router.tags or []) + route.get("tags", [])
route_responses = {**(responses or {}), **(route.get("responses") or {})}
if route_responses:
new_route["responses"] = route_responses
if deprecated is not None:
new_route["deprecated"] = deprecated
self.routes.append(new_route)
def url_for(self, name, **path_params):
"""Build a URL path for a named route, substituting path parameters."""
try:
path = self._named_routes[name]
except KeyError:
raise KeyError(f"No route named {name!r} is registered")
def repl(m):
p = m.group(1)
if p not in path_params:
raise KeyError(f"Missing path parameter {p!r} for route {name!r}")
return quote(str(path_params[p]), safe="")
return re.sub(r"{([^}]+)}", repl, path)
class Controller:
"""Base class for controller classes."""
pass
def controller(path: str, dependencies: typing.List[Depends] = None):
def decorator(cls):
cls.__controller_path__ = path
cls.__controller_dependencies__ = dependencies or []
return cls
return decorator
def route_get(path: str, dependencies: typing.List[Depends] = None):
def decorator(func):
func.__route_info__ = {"method": "GET", "path": path, "dependencies": dependencies or []}
return func
return decorator
def route_post(path: str, body_schema=None, schema=None, dependencies: typing.List[Depends] = None):
def decorator(func):
func.__route_info__ = {"method": "POST", "path": path, "body_schema": body_schema, "schema": schema, "dependencies": dependencies or []}
return func
return decorator
def route_put(path: str, body_schema=None, schema=None, dependencies: typing.List[Depends] = None):
def decorator(func):
func.__route_info__ = {"method": "PUT", "path": path, "body_schema": body_schema, "schema": schema, "dependencies": dependencies or []}
return func
return decorator
def route_patch(path: str, body_schema=None, schema=None, dependencies: typing.List[Depends] = None):
def decorator(func):
func.__route_info__ = {"method": "PATCH", "path": path, "body_schema": body_schema, "schema": schema, "dependencies": dependencies or []}
return func
return decorator
def route_delete(path: str, dependencies: typing.List[Depends] = None):
def decorator(func):
func.__route_info__ = {"method": "DELETE", "path": path, "dependencies": dependencies or []}
return func
return decorator
def route_query(path: str, body_schema=None, schema=None, experimental: bool = True, dependencies: typing.List[Depends] = None):
def decorator(func):
func.__route_info__ = {"method": "QUERY", "path": path, "body_schema": body_schema, "schema": schema, "experimental": experimental, "dependencies": dependencies or []}
return func
return decorator
def route_sse(path: str, dependencies: typing.List[Depends] = None):
def decorator(func):
func.__route_info__ = {"method": "SSE", "path": path, "dependencies": dependencies or []}
return func
return decorator
def route_websocket(path: str, dependencies: typing.List[Depends] = None):
def decorator(func):
@functools.wraps(func)
async def wrapper(websocket):
ws = WebSocket(websocket)
try:
return await func(ws)
except WebSocketException as exc:
# FastAPI/Starlette semantics: a raised WebSocketException
# closes the socket with the given close code and reason.
await ws.close(exc.code, exc.reason)
return
wrapper.__route_info__ = {"method": "WS", "path": path, "dependencies": dependencies or []}
return wrapper
return decorator
class _JustAPIGrpcContext:
def __init__(self):
self._code = None
self._details = None
def set_code(self, code):
self._code = code
def set_details(self, details):
self._details = details
def abort(self, code, details):
raise Exception(f"gRPC Abort: {code} - {details}")
class _JustAPIGrpcMockServer:
def __init__(self, app):
self.app = app
def add_generic_rpc_handlers(self, generic_rpc_handlers):
for handler in generic_rpc_handlers:
if hasattr(handler, "_method_handlers"):
self._register_handlers(handler._method_handlers)
def add_registered_method_handlers(self, service_name, method_handlers):
self._register_handlers(method_handlers)
def _register_handlers(self, method_handlers):
import inspect
for method_name, m_handler in method_handlers.items():
if not method_name.startswith("/"):
# If they pass raw names without the leading slash
pass
def make_wrapper(mh):
def wrapper(payload: bytes) -> bytes:
req = mh.request_deserializer(payload)
ctx = _JustAPIGrpcContext()
if mh.unary_unary is not None:
# Extract the actual method if it's bound
func = mh.unary_unary
if hasattr(func, "__func__"):
real_func = func.__func__
else:
real_func = func
if inspect.iscoroutinefunction(real_func):
import asyncio
res = asyncio.run(func(req, ctx))
else:
res = func(req, ctx)
return mh.response_serializer(res)
else:
raise NotImplementedError("Only unary-unary gRPC is supported currently")
return wrapper
self.app._app.add_grpc_service(method_name, make_wrapper(m_handler))
from ._justapi import JustAPITestClient as _JustAPITestClient
class JustAPITestClient:
def __new__(cls, app, database=None):
inner = getattr(app, "_inner", app)
return _JustAPITestClient(inner, database=database)
JustAPI = JustAPIApp
# Short alias: `JustAPP()` == `JustAPIApp()`.
JustAPP = JustAPIApp