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
|
import asyncio
import logging
import time
import warnings
from concurrent.futures import Future
from queue import Queue
from threading import Event, Thread
from typing import (
Any,
AsyncGenerator,
Callable,
Dict,
Generator,
List,
Literal,
Optional,
Tuple,
TypeVar,
Union,
cast,
overload,
)
import backoff
from anyio import fail_after
from graphql import (
ExecutionResult,
GraphQLSchema,
IntrospectionQuery,
build_ast_schema,
parse,
validate,
)
from .graphql_request import GraphQLRequest, support_deprecated_request
from .transport.async_transport import AsyncTransport
from .transport.exceptions import TransportConnectionFailed, TransportQueryError
from .transport.local_schema import LocalSchemaTransport
from .transport.transport import Transport
from .utilities import build_client_schema, get_introspection_query_ast
from .utilities import parse_result as parse_result_fn
from .utils import str_first_element
log = logging.getLogger(__name__)
class Client:
"""The Client class is the main entrypoint to execute GraphQL requests
on a GQL transport.
It can take sync or async transports as argument and can either execute
and subscribe to requests itself with the
:func:`execute <gql.client.Client.execute>` and
:func:`subscribe <gql.client.Client.subscribe>` methods
OR can be used to get a sync or async session depending on the
transport type.
To connect to an :ref:`async transport <async_transports>` and get an
:class:`async session <gql.client.AsyncClientSession>`,
use :code:`async with client as session:`
To connect to a :ref:`sync transport <sync_transports>` and get a
:class:`sync session <gql.client.SyncClientSession>`,
use :code:`with client as session:`
"""
def __init__(
self,
*,
schema: Optional[Union[str, GraphQLSchema]] = None,
introspection: Optional[IntrospectionQuery] = None,
transport: Optional[Union[Transport, AsyncTransport]] = None,
fetch_schema_from_transport: bool = False,
introspection_args: Optional[Dict] = None,
execute_timeout: Optional[Union[int, float]] = 10,
serialize_variables: bool = False,
parse_results: bool = False,
batch_interval: float = 0,
batch_max: int = 10,
):
"""Initialize the client with the given parameters.
:param schema: an optional GraphQL Schema for local validation
See :ref:`schema_validation`
:param transport: The provided :ref:`transport <Transports>`.
:param fetch_schema_from_transport: Boolean to indicate that if we want to fetch
the schema from the transport using an introspection query.
:param introspection_args: arguments passed to the
:meth:`gql.utilities.get_introspection_query_ast` method.
:param execute_timeout: The maximum time in seconds for the execution of a
request before a TimeoutError is raised. Only used for async transports.
Passing None results in waiting forever for a response.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums. Default: False.
:param parse_results: Whether gql will try to parse the serialized output
sent by the backend. Can be used to deserialize custom scalars or enums.
:param batch_interval: Time to wait in seconds for batching requests together.
Batching is disabled (by default) if 0.
:param batch_max: Maximum number of requests in a single batch.
"""
if introspection:
assert (
not schema
), "Cannot provide introspection and schema at the same time."
schema = build_client_schema(introspection)
if isinstance(schema, str):
type_def_ast = parse(schema)
schema = build_ast_schema(type_def_ast)
if transport and fetch_schema_from_transport:
assert (
not schema
), "Cannot fetch the schema from transport if is already provided."
assert not type(transport).__name__ == "AppSyncWebsocketsTransport", (
"fetch_schema_from_transport=True is not allowed "
"for AppSyncWebsocketsTransport "
"because only subscriptions are allowed on the realtime endpoint."
)
if schema and not transport:
transport = LocalSchemaTransport(schema)
# GraphQL schema
self.schema: Optional[GraphQLSchema] = schema
# Answer of the introspection query
self.introspection: Optional[IntrospectionQuery] = introspection
# GraphQL transport chosen
assert (
transport is not None
), "You need to provide either a transport or a schema to the Client."
self.transport: Union[Transport, AsyncTransport] = transport
# Flag to indicate that we need to fetch the schema from the transport
# On async transports, we fetch the schema before executing the first query
self.fetch_schema_from_transport: bool = fetch_schema_from_transport
self.introspection_args = (
{} if introspection_args is None else introspection_args
)
# Enforced timeout of the execute function (only for async transports)
self.execute_timeout = execute_timeout
self.serialize_variables = serialize_variables
self.parse_results = parse_results
self.batch_interval = batch_interval
self.batch_max = batch_max
@property
def batching_enabled(self) -> bool:
return self.batch_interval != 0
def validate(self, request: GraphQLRequest) -> None:
""":meta private:"""
assert (
self.schema
), "Cannot validate the document locally, you need to pass a schema."
validation_errors = validate(self.schema, request.document)
if validation_errors:
raise validation_errors[0]
def _build_schema_from_introspection(
self, execution_result: ExecutionResult
) -> None:
if execution_result.errors:
raise TransportQueryError(
(
"Error while fetching schema: "
f"{str_first_element(execution_result.errors)}\n"
"If you don't need the schema, you can try with: "
'"fetch_schema_from_transport=False"'
),
errors=execution_result.errors,
data=execution_result.data,
extensions=execution_result.extensions,
)
self.introspection = cast(IntrospectionQuery, execution_result.data)
self.schema = build_client_schema(self.introspection)
@staticmethod
def _get_event_loop() -> asyncio.AbstractEventLoop:
"""Get the current asyncio event loop.
Or create a new event loop if there isn't one (in a new Thread).
"""
try:
with warnings.catch_warnings():
warnings.filterwarnings(
"ignore", message="There is no current event loop"
)
loop = asyncio.get_event_loop()
except RuntimeError:
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
return loop
@overload
def execute_sync(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> Dict[str, Any]: ... # pragma: no cover
@overload
def execute_sync(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[True],
**kwargs: Any,
) -> ExecutionResult: ... # pragma: no cover
@overload
def execute_sync(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: bool,
**kwargs: Any,
) -> Union[Dict[str, Any], ExecutionResult]: ... # pragma: no cover
def execute_sync(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], ExecutionResult]:
""":meta private:"""
with self as session:
return session.execute(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
def execute_batch_sync(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> List[Dict[str, Any]]: ... # pragma: no cover
@overload
def execute_batch_sync(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[True],
**kwargs: Any,
) -> List[ExecutionResult]: ... # pragma: no cover
@overload
def execute_batch_sync(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool,
**kwargs: Any,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]: ... # pragma: no cover
def execute_batch_sync(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]:
""":meta private:"""
with self as session:
return session.execute_batch(
requests,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
async def execute_async(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> Dict[str, Any]: ... # pragma: no cover
@overload
async def execute_async(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[True],
**kwargs: Any,
) -> ExecutionResult: ... # pragma: no cover
@overload
async def execute_async(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: bool,
**kwargs: Any,
) -> Union[Dict[str, Any], ExecutionResult]: ... # pragma: no cover
async def execute_async(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], ExecutionResult]:
""":meta private:"""
async with self as session:
return await session.execute(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
async def execute_batch_async(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> List[Dict[str, Any]]: ... # pragma: no cover
@overload
async def execute_batch_async(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[True],
**kwargs: Any,
) -> List[ExecutionResult]: ... # pragma: no cover
@overload
async def execute_batch_async(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool,
**kwargs: Any,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]: ... # pragma: no cover
async def execute_batch_async(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]:
""":meta private:"""
async with self as session:
return await session.execute_batch(
requests,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> Dict[str, Any]: ... # pragma: no cover
@overload
def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[True],
**kwargs: Any,
) -> ExecutionResult: ... # pragma: no cover
@overload
def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: bool,
**kwargs: Any,
) -> Union[Dict[str, Any], ExecutionResult]: ... # pragma: no cover
def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], ExecutionResult]:
"""Execute the provided request against the remote server using
the transport provided during init.
This function **WILL BLOCK** until the result is received from the server.
Either the transport is sync and we execute the query synchronously directly
OR the transport is async and we execute the query in the asyncio loop
(blocking here until answer).
This method will:
- connect using the transport to get a session
- execute the GraphQL request on the transport session
- close the session and close the connection to the server
If you have multiple requests to send, it is better to get your own session
and execute the requests in your session.
The extra arguments passed in the method will be passed to the transport
execute method.
"""
if isinstance(self.transport, AsyncTransport):
loop = self._get_event_loop()
assert not loop.is_running(), (
"Cannot run client.execute(query) if an asyncio loop is running."
" Use 'await client.execute_async(query)' instead."
)
data = loop.run_until_complete(
self.execute_async(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
)
return data
else: # Sync transports
return self.execute_sync(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> List[Dict[str, Any]]: ... # pragma: no cover
@overload
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[True],
**kwargs: Any,
) -> List[ExecutionResult]: ... # pragma: no cover
@overload
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool,
**kwargs: Any,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]: ... # pragma: no cover
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]:
"""Execute multiple GraphQL requests in a batch against the remote server using
the transport provided during init.
This function **WILL BLOCK** until the result is received from the server.
Either the transport is sync and we execute the query synchronously directly
OR the transport is async and we execute the query in the asyncio loop
(blocking here until answer).
This method will:
- connect using the transport to get a session
- execute the GraphQL requests on the transport session
- close the session and close the connection to the server
If you want to perform multiple executions, it is better to use
the context manager to keep a session active.
The extra arguments passed in the method will be passed to the transport
execute method.
"""
if isinstance(self.transport, AsyncTransport):
loop = self._get_event_loop()
assert not loop.is_running(), (
"Cannot run client.execute_batch(query) if an asyncio loop is running."
" Use 'await client.execute_batch(query)' instead."
)
data = loop.run_until_complete(
self.execute_batch_async(
requests,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
)
return data
else: # Sync transports
return self.execute_batch_sync(
requests,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
def subscribe_async(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> AsyncGenerator[Dict[str, Any], None]: ... # pragma: no cover
@overload
def subscribe_async(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[True],
**kwargs: Any,
) -> AsyncGenerator[ExecutionResult, None]: ... # pragma: no cover
@overload
def subscribe_async(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: bool,
**kwargs: Any,
) -> Union[
AsyncGenerator[Dict[str, Any], None], AsyncGenerator[ExecutionResult, None]
]: ... # pragma: no cover
async def subscribe_async(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[
AsyncGenerator[Dict[str, Any], None], AsyncGenerator[ExecutionResult, None]
]:
""":meta private:"""
async with self as session:
generator = session.subscribe(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
async for result in generator:
yield result
@overload
def subscribe(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> Generator[Dict[str, Any], None, None]: ... # pragma: no cover
@overload
def subscribe(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[True],
**kwargs: Any,
) -> Generator[ExecutionResult, None, None]: ... # pragma: no cover
@overload
def subscribe(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: bool,
**kwargs: Any,
) -> Union[
Generator[Dict[str, Any], None, None], Generator[ExecutionResult, None, None]
]: ... # pragma: no cover
def subscribe(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[
Generator[Dict[str, Any], None, None], Generator[ExecutionResult, None, None]
]:
"""Execute a GraphQL subscription with a python generator.
We need an async transport for this functionality.
"""
loop = self._get_event_loop()
assert not loop.is_running(), (
"Cannot run client.subscribe(query) if an asyncio loop is running."
" Use 'await client.subscribe_async(query)' instead."
)
async_generator: Union[
AsyncGenerator[Dict[str, Any], None], AsyncGenerator[ExecutionResult, None]
] = self.subscribe_async(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
try:
while True:
# Note: we need to create a task here in order to be able to close
# the async generator properly on python 3.8
# See https://bugs.python.org/issue38559
generator_task = asyncio.ensure_future(
async_generator.__anext__(), loop=loop
)
result: Union[
Dict[str, Any], ExecutionResult
] = loop.run_until_complete(
generator_task
) # type: ignore
yield result
except StopAsyncIteration:
pass
except (KeyboardInterrupt, Exception, GeneratorExit):
# Graceful shutdown
asyncio.ensure_future(async_generator.aclose(), loop=loop)
generator_task.cancel()
loop.run_until_complete(loop.shutdown_asyncgens())
# Then reraise the exception
raise
async def connect_async(self, reconnecting=False, **kwargs):
r"""Connect asynchronously with the underlying async transport to
produce a session.
That session will be a permanent auto-reconnecting session
if :code:`reconnecting=True`.
If you call this method, you should call the
:meth:`close_async <gql.client.Client.close_async>` method
for cleanup.
:param reconnecting: if True, create a permanent reconnecting session
:param \**kwargs: additional arguments for the
:meth:`ReconnectingAsyncClientSession init method
<gql.client.ReconnectingAsyncClientSession.__init__>`.
"""
assert isinstance(
self.transport, AsyncTransport
), "Only a transport of type AsyncTransport can be used asynchronously"
self.session: Union[AsyncClientSession, SyncClientSession]
if reconnecting:
self.session = ReconnectingAsyncClientSession(client=self, **kwargs)
else:
self.session = AsyncClientSession(client=self)
await self.session.connect()
# Get schema from transport if needed
try:
if self.fetch_schema_from_transport and not self.schema:
await self.session.fetch_schema()
except Exception:
# we don't know what type of exception is thrown here because it
# depends on the underlying transport; we just make sure that the
# transport is closed and re-raise the exception
await self.session.close()
raise
return self.session
async def close_async(self):
"""Close the async transport and stop the optional reconnecting task."""
await self.session.close()
async def __aenter__(self):
return await self.connect_async()
async def __aexit__(self, exc_type, exc, tb):
await self.close_async()
def connect_sync(self):
r"""Connect synchronously with the underlying sync transport to
produce a session.
If you call this method, you should call the
:meth:`close_sync <gql.client.Client.close_sync>` method
for cleanup.
"""
assert not isinstance(self.transport, AsyncTransport), (
"Only a sync transport can be used."
" Use 'async with Client(...) as session:' instead"
)
if not hasattr(self, "session"):
self.session = SyncClientSession(client=self)
assert isinstance(self.session, SyncClientSession)
self.session.connect()
# Get schema from transport if needed
try:
if self.fetch_schema_from_transport and not self.schema:
self.session.fetch_schema()
except Exception:
# we don't know what type of exception is thrown here because it
# depends on the underlying transport; we just make sure that the
# transport is closed and re-raise the exception
self.session.close()
raise
return self.session
def close_sync(self):
"""Close the sync session and the sync transport.
If batching is enabled, this will block until the remaining queries in the
batching queue have been processed.
"""
assert isinstance(self.session, SyncClientSession)
self.session.close()
def __enter__(self):
return self.connect_sync()
def __exit__(self, *args):
self.close_sync()
class SyncClientSession:
"""An instance of this class is created when using :code:`with` on the client.
It contains the sync method execute to send queries
on a sync transport using the same session.
"""
def __init__(self, client: Client):
""":param client: the :class:`client <gql.client.Client>` used"""
self.client = client
def _execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
**kwargs: Any,
) -> ExecutionResult:
"""Execute the provided request synchronously using
the sync transport, returning an ExecutionResult object.
:param request: GraphQL request as a
:class:`GraphQLRequest <gql.GraphQLRequest>` object.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
The extra arguments are passed to the transport execute method."""
# Still supporting for now old method of providing
# variable_values and operation_name
request = support_deprecated_request(request, kwargs)
# Validate document
if self.client.schema:
self.client.validate(request)
# Parse variable values for custom scalars if requested
if request.variable_values is not None:
if serialize_variables or (
serialize_variables is None and self.client.serialize_variables
):
request = request.serialize_variable_values(self.client.schema)
if self.client.batching_enabled:
future_result = self._execute_future(request)
result = future_result.result()
else:
result = self.transport.execute(
request,
**kwargs,
)
# Unserialize the result if requested
if self.client.schema:
if parse_result or (parse_result is None and self.client.parse_results):
result.data = parse_result_fn(
self.client.schema,
request.document,
result.data,
operation_name=request.operation_name,
)
return result
@overload
def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> Dict[str, Any]: ... # pragma: no cover
@overload
def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[True],
**kwargs: Any,
) -> ExecutionResult: ... # pragma: no cover
@overload
def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: bool,
**kwargs: Any,
) -> Union[Dict[str, Any], ExecutionResult]: ... # pragma: no cover
def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], ExecutionResult]:
"""Execute the provided request synchronously using
the sync transport.
Raises a TransportQueryError if an error has been returned in
the ExecutionResult.
:param request: GraphQL query as :class:`GraphQLRequest <gql.GraphQLRequest>`.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
:param get_execution_result: return the full ExecutionResult instance instead of
only the "data" field. Necessary if you want to get the "extensions" field.
The extra arguments are passed to the transport execute method."""
# Validate and execute on the transport
result = self._execute(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
**kwargs,
)
# Raise an error if an error is returned in the ExecutionResult object
if result.errors:
raise TransportQueryError(
str_first_element(result.errors),
errors=result.errors,
data=result.data,
extensions=result.extensions,
)
assert (
result.data is not None
), "Transport returned an ExecutionResult without data or errors"
if get_execution_result:
return result
return result.data
def _execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
validate_document: Optional[bool] = True,
**kwargs: Any,
) -> List[ExecutionResult]:
"""Execute multiple GraphQL requests in a batch, using
the sync transport, returning a list of ExecutionResult objects.
:param requests: List of requests that will be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
:param validate_document: Whether we still need to validate the document.
The extra arguments are passed to the transport execute method."""
# Validate document
if self.client.schema:
if validate_document:
for req in requests:
self.client.validate(req)
# Parse variable values for custom scalars if requested
if serialize_variables or (
serialize_variables is None and self.client.serialize_variables
):
requests = [
(
req.serialize_variable_values(self.client.schema)
if req.variable_values is not None
else req
)
for req in requests
]
results = self.transport.execute_batch(requests, **kwargs)
# Unserialize the result if requested
if self.client.schema:
if parse_result or (parse_result is None and self.client.parse_results):
for result in results:
result.data = parse_result_fn(
self.client.schema,
req.document,
result.data,
operation_name=req.operation_name,
)
return results
@overload
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> List[Dict[str, Any]]: ... # pragma: no cover
@overload
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[True],
**kwargs: Any,
) -> List[ExecutionResult]: ... # pragma: no cover
@overload
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool,
**kwargs: Any,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]: ... # pragma: no cover
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]:
"""Execute multiple GraphQL requests in a batch, using
the sync transport. This method sends the requests to the server all at once.
Raises a TransportQueryError if an error has been returned in any
ExecutionResult.
:param requests: List of requests that will be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
:param get_execution_result: return the full ExecutionResult instance instead of
only the "data" field. Necessary if you want to get the "extensions" field.
The extra arguments are passed to the transport execute method."""
# Validate and execute on the transport
results = self._execute_batch(
requests,
serialize_variables=serialize_variables,
parse_result=parse_result,
**kwargs,
)
for result in results:
# Raise an error if an error is returned in the ExecutionResult object
if result.errors:
raise TransportQueryError(
str_first_element(result.errors),
errors=result.errors,
data=result.data,
extensions=result.extensions,
)
assert (
result.data is not None
), "Transport returned an ExecutionResult without data or errors"
if get_execution_result:
return results
return cast(List[Dict[str, Any]], [result.data for result in results])
def _batch_loop(self) -> None:
"""main loop of the thread used to wait for requests
to execute them in a batch"""
stop_loop = False
while not stop_loop:
# First wait for a first request in from the batch queue
requests_and_futures: List[Tuple[GraphQLRequest, Future]] = []
request_and_future: Tuple[GraphQLRequest, Future] = self.batch_queue.get()
if request_and_future is None:
break
requests_and_futures.append(request_and_future)
# Then wait the requested batch interval except if we already
# have the maximum number of requests in the queue
if self.batch_queue.qsize() < self.client.batch_max - 1:
time.sleep(self.client.batch_interval)
# Then get the requests which had been made during that wait interval
for _ in range(self.client.batch_max - 1):
if self.batch_queue.empty():
break
request_and_future = self.batch_queue.get()
if request_and_future is None:
stop_loop = True
break
requests_and_futures.append(request_and_future)
requests = [request for request, _ in requests_and_futures]
futures = [future for _, future in requests_and_futures]
# Manually execute the requests in a batch
try:
results: List[ExecutionResult] = self._execute_batch(
requests,
serialize_variables=False, # already done
parse_result=False,
validate_document=False,
)
except Exception as exc:
for future in futures:
future.set_exception(exc)
continue
# Fill in the future results
for result, future in zip(results, futures):
future.set_result(result)
# Indicate that the Thread has stopped
self._batch_thread_stopped_event.set()
def _execute_future(
self,
request: GraphQLRequest,
) -> Future:
"""If batching is enabled, this method will put a request in the batching queue
instead of executing it directly so that the requests could be put in a batch.
"""
assert hasattr(self, "batch_queue"), "Batching is not enabled"
assert not self._batch_thread_stop_requested, "Batching thread has been stopped"
future: Future = Future()
self.batch_queue.put((request, future))
return future
def connect(self):
"""Connect the transport and initialize the batch threading loop if batching
is enabled."""
if self.client.batching_enabled:
self.batch_queue: Queue = Queue()
self._batch_thread_stop_requested = False
self._batch_thread_stopped_event = Event()
self._batch_thread = Thread(target=self._batch_loop, daemon=True)
self._batch_thread.start()
self.transport.connect()
def close(self):
"""Close the transport and cleanup the batching thread if batching is enabled.
Will wait until all the remaining requests in the batch processing queue
have been executed.
"""
if hasattr(self, "_batch_thread_stopped_event"):
# Send a None in the queue to indicate that the batching Thread must stop
# after having processed the remaining requests in the queue
self._batch_thread_stop_requested = True
self.batch_queue.put(None)
# Wait for the Thread to stop
self._batch_thread_stopped_event.wait()
self.transport.close()
def fetch_schema(self) -> None:
"""Fetch the GraphQL schema explicitly using introspection.
Don't use this function and instead set the fetch_schema_from_transport
attribute to True"""
introspection_query = get_introspection_query_ast(
**self.client.introspection_args
)
execution_result = self.transport.execute(GraphQLRequest(introspection_query))
self.client._build_schema_from_introspection(execution_result)
@property
def transport(self):
return self.client.transport
class AsyncClientSession:
"""An instance of this class is created when using :code:`async with` on a
:class:`client <gql.client.Client>`.
It contains the async methods (execute, subscribe) to send queries
on an async transport using the same session.
"""
def __init__(self, client: Client):
""":param client: the :class:`client <gql.client.Client>` used"""
self.client = client
async def _subscribe(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
**kwargs: Any,
) -> AsyncGenerator[ExecutionResult, None]:
"""Coroutine to subscribe asynchronously to the provided request
asynchronously using the async transport,
returning an async generator producing ExecutionResult objects.
* Validate the query with the schema if provided.
* Serialize the variable_values if requested.
:param request: GraphQL request as a
:class:`GraphQLRequest <gql.GraphQLRequest>` object.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
The extra arguments are passed to the transport subscribe method."""
# Still supporting for now old method of providing
# variable_values and operation_name
request = support_deprecated_request(request, kwargs)
# Validate document
if self.client.schema:
self.client.validate(request)
# Parse variable values for custom scalars if requested
if request.variable_values is not None:
if serialize_variables or (
serialize_variables is None and self.client.serialize_variables
):
request = request.serialize_variable_values(self.client.schema)
# Subscribe to the transport
inner_generator: AsyncGenerator[ExecutionResult, None] = (
self.transport.subscribe(
request,
**kwargs,
)
)
# Keep a reference to the inner generator
# This is only used for the tests to simulate a KeyboardInterrupt event
self._generator = inner_generator
try:
async for result in inner_generator:
if self.client.schema:
if parse_result or (
parse_result is None and self.client.parse_results
):
result.data = parse_result_fn(
self.client.schema,
request.document,
result.data,
operation_name=request.operation_name,
)
yield result
finally:
await inner_generator.aclose()
@overload
def subscribe(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> AsyncGenerator[Dict[str, Any], None]: ... # pragma: no cover
@overload
def subscribe(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[True],
**kwargs: Any,
) -> AsyncGenerator[ExecutionResult, None]: ... # pragma: no cover
@overload
def subscribe(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: bool,
**kwargs: Any,
) -> Union[
AsyncGenerator[Dict[str, Any], None], AsyncGenerator[ExecutionResult, None]
]: ... # pragma: no cover
async def subscribe(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[
AsyncGenerator[Dict[str, Any], None], AsyncGenerator[ExecutionResult, None]
]:
"""Coroutine to subscribe asynchronously to the provided request
asynchronously using the async transport.
Raises a TransportQueryError if an error has been returned in
the ExecutionResult.
:param request: GraphQL query as :class:`GraphQLRequest <gql.GraphQLRequest>`.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
:param get_execution_result: yield the full ExecutionResult instance instead of
only the "data" field. Necessary if you want to get the "extensions" field.
The extra arguments are passed to the transport subscribe method."""
inner_generator: AsyncGenerator[ExecutionResult, None] = self._subscribe(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
**kwargs,
)
try:
# Validate and subscribe on the transport
async for result in inner_generator:
# Raise an error if an error is returned in the ExecutionResult object
if result.errors:
raise TransportQueryError(
str_first_element(result.errors),
errors=result.errors,
data=result.data,
extensions=result.extensions,
)
elif result.data is not None:
if get_execution_result:
yield result
else:
yield result.data
finally:
await inner_generator.aclose()
async def _execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
**kwargs: Any,
) -> ExecutionResult:
"""Coroutine to execute the provided request asynchronously using
the async transport, returning an ExecutionResult object.
* Validate the query with the schema if provided.
* Serialize the variable_values if requested.
:param request: GraphQL request as a
:class:`GraphQLRequest <gql.GraphQLRequest>` object.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
The extra arguments are passed to the transport execute method."""
# Still supporting for now old method of providing
# variable_values and operation_name
request = support_deprecated_request(request, kwargs)
# Validate document
if self.client.schema:
self.client.validate(request)
# Parse variable values for custom scalars if requested
if request.variable_values is not None:
if serialize_variables or (
serialize_variables is None and self.client.serialize_variables
):
request = request.serialize_variable_values(self.client.schema)
# Check if batching is enabled
if self.client.batching_enabled:
future_result = await self._execute_future(request)
result = await future_result
else:
# Execute the query with the transport with a timeout
with fail_after(self.client.execute_timeout):
result = await self.transport.execute(
request,
**kwargs,
)
# Unserialize the result if requested
if self.client.schema:
if parse_result or (parse_result is None and self.client.parse_results):
result.data = parse_result_fn(
self.client.schema,
request.document,
result.data,
operation_name=request.operation_name,
)
return result
@overload
async def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> Dict[str, Any]: ... # pragma: no cover
@overload
async def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: Literal[True],
**kwargs: Any,
) -> ExecutionResult: ... # pragma: no cover
@overload
async def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
get_execution_result: bool,
**kwargs: Any,
) -> Union[Dict[str, Any], ExecutionResult]: ... # pragma: no cover
async def execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[Dict[str, Any], ExecutionResult]:
"""Coroutine to execute the provided request asynchronously using
the async transport.
Raises a TransportQueryError if an error has been returned in
the ExecutionResult.
:param request: GraphQL query as :class:`GraphQLRequest <gql.GraphQLRequest>`.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
:param get_execution_result: return the full ExecutionResult instance instead of
only the "data" field. Necessary if you want to get the "extensions" field.
The extra arguments are passed to the transport execute method."""
# Validate and execute on the transport
result = await self._execute(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
**kwargs,
)
# Raise an error if an error is returned in the ExecutionResult object
if result.errors:
raise TransportQueryError(
str_first_element(result.errors),
errors=result.errors,
data=result.data,
extensions=result.extensions,
)
assert (
result.data is not None
), "Transport returned an ExecutionResult without data or errors"
if get_execution_result:
return result
return result.data
async def _execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
validate_document: Optional[bool] = True,
**kwargs: Any,
) -> List[ExecutionResult]:
"""Execute multiple GraphQL requests in a batch, using
the async transport, returning a list of ExecutionResult objects.
:param requests: List of requests that will be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
:param validate_document: Whether we still need to validate the document.
The extra arguments are passed to the transport execute_batch method."""
# Validate document
if self.client.schema:
if validate_document:
for req in requests:
self.client.validate(req)
# Parse variable values for custom scalars if requested
if serialize_variables or (
serialize_variables is None and self.client.serialize_variables
):
requests = [
(
req.serialize_variable_values(self.client.schema)
if req.variable_values is not None
else req
)
for req in requests
]
results = await self.transport.execute_batch(requests, **kwargs)
# Unserialize the result if requested
if self.client.schema:
if parse_result or (parse_result is None and self.client.parse_results):
for result in results:
result.data = parse_result_fn(
self.client.schema,
req.document,
result.data,
operation_name=req.operation_name,
)
return results
@overload
async def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[False] = ...,
**kwargs: Any,
) -> List[Dict[str, Any]]: ... # pragma: no cover
@overload
async def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[True],
**kwargs: Any,
) -> List[ExecutionResult]: ... # pragma: no cover
@overload
async def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool,
**kwargs: Any,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]: ... # pragma: no cover
async def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs: Any,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]:
"""Execute multiple GraphQL requests in a batch, using
the async transport. This method sends the requests to the server all at once.
Raises a TransportQueryError if an error has been returned in any
ExecutionResult.
:param requests: List of requests that will be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
:param get_execution_result: return the full ExecutionResult instance instead of
only the "data" field. Necessary if you want to get the "extensions" field.
The extra arguments are passed to the transport execute method."""
# Validate and execute on the transport
results = await self._execute_batch(
requests,
serialize_variables=serialize_variables,
parse_result=parse_result,
**kwargs,
)
for result in results:
# Raise an error if an error is returned in the ExecutionResult object
if result.errors:
raise TransportQueryError(
str_first_element(result.errors),
errors=result.errors,
data=result.data,
extensions=result.extensions,
)
assert (
result.data is not None
), "Transport returned an ExecutionResult without data or errors"
if get_execution_result:
return results
return cast(List[Dict[str, Any]], [result.data for result in results])
async def _batch_loop(self) -> None:
"""Main loop of the task used to wait for requests
to execute them in a batch"""
stop_loop = False
while not stop_loop:
# First wait for a first request in from the batch queue
requests_and_futures: List[Tuple[GraphQLRequest, asyncio.Future]] = []
# Wait for the first request
request_and_future: Optional[Tuple[GraphQLRequest, asyncio.Future]] = (
await self.batch_queue.get()
)
if request_and_future is None:
# None is our sentinel value to stop the loop
break
requests_and_futures.append(request_and_future)
# Then wait the requested batch interval except if we already
# have the maximum number of requests in the queue
if self.batch_queue.qsize() < self.client.batch_max - 1:
# Wait for the batch interval
await asyncio.sleep(self.client.batch_interval)
# Then get the requests which had been made during that wait interval
for _ in range(self.client.batch_max - 1):
try:
# Use get_nowait since we don't want to wait here
request_and_future = self.batch_queue.get_nowait()
if request_and_future is None:
# Sentinel value - stop after processing current batch
stop_loop = True
break
requests_and_futures.append(request_and_future)
except asyncio.QueueEmpty:
# No more requests in queue, that's fine
break
# Extract requests and futures
requests = [request for request, _ in requests_and_futures]
futures = [future for _, future in requests_and_futures]
# Execute the batch
try:
results: List[ExecutionResult] = await self._execute_batch(
requests,
serialize_variables=False, # already done
parse_result=False, # will be done later
validate_document=False, # already validated
)
# Set the result for each future
for result, future in zip(results, futures):
if not future.cancelled():
future.set_result(result)
except Exception as exc:
# If batch execution fails, propagate the error to all futures
for future in futures:
if not future.cancelled():
future.set_exception(exc)
# Signal that the task has stopped
self._batch_task_stopped_event.set()
async def _execute_future(
self,
request: GraphQLRequest,
) -> asyncio.Future:
"""If batching is enabled, this method will put a request in the batching queue
instead of executing it directly so that the requests could be put in a batch.
"""
assert hasattr(self, "batch_queue"), "Batching is not enabled"
assert not self._batch_task_stop_requested, "Batching task has been stopped"
future: asyncio.Future = asyncio.Future()
await self.batch_queue.put((request, future))
return future
async def _batch_init(self):
"""Initialize the batch task loop if batching is enabled."""
if self.client.batching_enabled:
self.batch_queue: asyncio.Queue = asyncio.Queue()
self._batch_task_stop_requested = False
self._batch_task_stopped_event = asyncio.Event()
self._batch_task = asyncio.create_task(self._batch_loop())
async def _batch_cleanup(self):
"""Cleanup the batching task if batching is enabled."""
if hasattr(self, "_batch_task_stopped_event"):
# Send a None in the queue to indicate that the batching task must stop
# after having processed the remaining requests in the queue
self._batch_task_stop_requested = True
await self.batch_queue.put(None)
# Wait for the task to process remaining requests and stop
await self._batch_task_stopped_event.wait()
async def connect(self):
"""Connect the transport and initialize the batch task loop if batching
is enabled."""
await self._batch_init()
try:
await self.transport.connect()
except Exception as e:
await self.transport.close()
raise e
async def close(self):
"""Close the transport and cleanup the batching task if batching is enabled.
Will wait until all the remaining requests in the batch processing queue
have been executed.
"""
await self._batch_cleanup()
await self.transport.close()
async def fetch_schema(self) -> None:
"""Fetch the GraphQL schema explicitly using introspection.
Don't use this function and instead set the fetch_schema_from_transport
attribute to True"""
introspection_query = get_introspection_query_ast(
**self.client.introspection_args
)
execution_result = await self.transport.execute(
GraphQLRequest(introspection_query)
)
self.client._build_schema_from_introspection(execution_result)
@property
def transport(self):
return self.client.transport
_CallableT = TypeVar("_CallableT", bound=Callable[..., Any])
_Decorator = Callable[[_CallableT], _CallableT]
class ReconnectingAsyncClientSession(AsyncClientSession):
"""An instance of this class is created when using the
:meth:`connect_async <gql.client.Client.connect_async>` method of the
:class:`Client <gql.client.Client>` class with :code:`reconnecting=True`.
It is used to provide a single session which will reconnect automatically if
the connection fails.
"""
def __init__(
self,
client: Client,
*,
retry_connect: Union[bool, _Decorator] = True,
retry_execute: Union[bool, _Decorator] = True,
):
"""
:param client: the :class:`client <gql.client.Client>` used.
:param retry_connect: Either a Boolean to activate/deactivate the retries
for the connection to the transport OR a backoff decorator to
provide specific retries parameters for the connections.
:param retry_execute: Either a Boolean to activate/deactivate the retries
for the execute method OR a backoff decorator to
provide specific retries parameters for this method.
"""
self.client = client
self._connect_task = None
self._reconnect_request_event = asyncio.Event()
self._connected_event = asyncio.Event()
if retry_connect is True:
# By default, retry again and again, with maximum 60 seconds
# between retries
self.retry_connect = backoff.on_exception(
backoff.expo,
Exception,
max_value=60,
)
elif retry_connect is False:
self.retry_connect = lambda e: e
else:
assert callable(retry_connect)
self.retry_connect = retry_connect
if retry_execute is True:
# By default, retry 5 times, except if we receive a TransportQueryError
self.retry_execute = backoff.on_exception(
backoff.expo,
Exception,
max_tries=5,
giveup=lambda e: isinstance(e, TransportQueryError),
)
elif retry_execute is False:
self.retry_execute = lambda e: e
else:
assert callable(retry_execute)
self.retry_execute = retry_execute
# Creating the _execute_with_retries and _connect_with_retries methods
# using the provided backoff decorators
self._execute_with_retries = self.retry_execute(self._execute_once)
self._connect_with_retries = self.retry_connect(self.transport.connect)
async def _connection_loop(self):
"""Coroutine used for the connection task.
- try to connect to the transport with retries
- send a connected event when the connection has been made
- then wait for a reconnect request to try to connect again
"""
while True:
# Connect to the transport with the retry decorator
# By default it should keep retrying until it connect
await self._connect_with_retries()
# Once connected, set the connected event
self._connected_event.set()
self._connected_event.clear()
# Then wait for the reconnect event
self._reconnect_request_event.clear()
await self._reconnect_request_event.wait()
await self.transport.close()
async def start_connecting_task(self):
"""Start the task responsible to restart the connection
of the transport when requested by an event.
"""
if self._connect_task:
log.warning("connect task already started!")
else:
self._connect_task = asyncio.ensure_future(self._connection_loop())
await self._connected_event.wait()
async def stop_connecting_task(self):
"""Stop the connecting task."""
if self._connect_task is not None:
self._connect_task.cancel()
self._connect_task = None
async def connect(self):
"""Start the connect task and initialize the batch task loop if batching
is enabled."""
await self._batch_init()
await self.start_connecting_task()
async def close(self):
"""Stop the connect task and cleanup the batching task
if batching is enabled."""
await self._batch_cleanup()
await self.stop_connecting_task()
await self.transport.close()
async def _execute_once(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
**kwargs: Any,
) -> ExecutionResult:
"""Same Coroutine as parent method _execute but requesting a
reconnection if we receive a TransportConnectionFailed exception.
"""
try:
answer = await super()._execute(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
**kwargs,
)
except TransportConnectionFailed:
self._reconnect_request_event.set()
raise
return answer
async def _execute(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
**kwargs: Any,
) -> ExecutionResult:
"""Same Coroutine as parent, but with optional retries
and requesting a reconnection if we receive a
TransportConnectionFailed exception.
"""
return await self._execute_with_retries(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
**kwargs,
)
async def _subscribe(
self,
request: GraphQLRequest,
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
**kwargs: Any,
) -> AsyncGenerator[ExecutionResult, None]:
"""Same Async generator as parent method _subscribe but requesting a
reconnection if we receive a TransportConnectionFailed exception.
"""
inner_generator: AsyncGenerator[ExecutionResult, None] = super()._subscribe(
request,
serialize_variables=serialize_variables,
parse_result=parse_result,
**kwargs,
)
try:
async for result in inner_generator:
yield result
except TransportConnectionFailed:
self._reconnect_request_event.set()
raise
finally:
await inner_generator.aclose()
|